Class: Klaviyo::DataPrivacyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo_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_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_sdk/api/data_privacy_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#request_deletion(opts = {}) ⇒ String

Request a Deletion Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier. **If multiple person records exist for the provided identifier, only one of them will be deleted.** The arguments should be sent as content type application/json. Note that only one identifier (email, phone_number, or person_id) can be specified. In addition to your API key, you need to set exactly one of the following parameters: ‘email`, `phone_number`, `or person_id`, along with the associated `string` value. Examples: Email: `Klaviyo::DataPrivacyApi."email":"abraham"email":"abraham.lincoln@klaviyo"email":"[email protected]"` Phone Number: `"phone_number":"+13239169023"` Person ID: `"person_id":"PERSON_ID"`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (String)

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/klaviyo_sdk/api/data_privacy_api.rb', line 27

def request_deletion(opts = {})
  data, _status_code, _headers = request_deletion_with_http_info(opts)
  data
end

#request_deletion_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Request a Deletion Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier. **If multiple person records exist for the provided identifier, only one of them will be deleted.** The arguments should be sent as content type application/json. Note that only one identifier (email, phone_number, or person_id) can be specified. In addition to your API key, you need to set exactly one of the following parameters: &#x60;email&#x60;, &#x60;phone_number&#x60;, &#x60;or person_id&#x60;, along with the associated &#x60;string&#x60; value. Examples: Email: &#x60;Klaviyo::DataPrivacyApi.&quot;email&quot;:&quot;abraham&quot;email&quot;:&quot;abraham.lincoln@klaviyo&quot;email&quot;:&quot;[email protected]&quot;&#x60; Phone Number: &#x60;&quot;phone_number&quot;:&quot;+13239169023&quot;&#x60; Person ID: &#x60;&quot;person_id&quot;:&quot;PERSON_ID&quot;&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (String)

Returns:

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

    String data, response status code and response headers



37
38
39
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
 
# File 'lib/klaviyo_sdk/api/data_privacy_api.rb', line 37

def request_deletion_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataPrivacyApi.request_deletion ...'
  end
  # resource path
  local_var_path = '/v2/data-privacy/deletion-request'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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[:body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"DataPrivacyApi.request_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_deletion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end