Class: KlaviyoAPI::DataPrivacyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/api/data_privacy_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataPrivacyApi

Returns a new instance of DataPrivacyApi.



19
20
21
 
# File 'lib/klaviyo-api-sdk/api/data_privacy_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/klaviyo-api-sdk/api/data_privacy_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#request_profile_deletion(data_privacy_create_deletion_job_query, opts = {}) ⇒ nil Also known as: create_data_privacy_deletion_job

Request Profile Deletion Request a deletion for the profiles corresponding to one of the following identifiers: email, phone_number, or id. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the Deleted Profiles page. For more information on the deletion process, please refer to our Help Center docs on how to handle GDPR and CCPA deletion requests.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: data-privacy:write

Parameters:

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/klaviyo-api-sdk/api/data_privacy_api.rb', line 27

def request_profile_deletion(data_privacy_create_deletion_job_query, opts = {})
  request_profile_deletion_with_http_info(data_privacy_create_deletion_job_query, opts)
  nil
end

#request_profile_deletion_with_http_info(data_privacy_create_deletion_job_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_data_privacy_deletion_job_with_http_info

Request Profile Deletion Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error. All profiles that match the provided identifier will be deleted. The deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the Deleted Profiles page. For more information on the deletion process, please refer to our Help Center docs on how to handle GDPR and CCPA deletion requests.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `data-privacy:write`

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/klaviyo-api-sdk/api/data_privacy_api.rb', line 40

def request_profile_deletion_with_http_info(data_privacy_create_deletion_job_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataPrivacyApi.request_profile_deletion ...'
  end
  # verify the required parameter 'data_privacy_create_deletion_job_query' is set
  if @api_client.config.client_side_validation && data_privacy_create_deletion_job_query.nil?
    fail ArgumentError, "Missing the required parameter 'data_privacy_create_deletion_job_query' when calling DataPrivacyApi.request_profile_deletion"
  end
  # resource path
  local_var_path = '/api/data-privacy-deletion-jobs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data_privacy_create_deletion_job_query)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"DataPrivacyApi.request_profile_deletion",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataPrivacyApi#request_profile_deletion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end