Class: Hubspot::Crm::Contacts::GDPRApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GDPRApi 



21
22
23
 
# File 'lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb', line 21

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#purge_by_email(email, opts = {}) ⇒ nil

DELETE Permanently delete a contact by email address and all associated content to follow GDPR. If contact isn’t found, blacklists an email address from being used in the future.



29
30
31
32
 
# File 'lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb', line 29

def purge_by_email(email, opts = {})
  purge_by_email_with_http_info(email, opts)
  nil
end

#purge_by_email_with_http_info(email, opts = {}) ⇒ Array<(nil, Integer, Hash)>

DELETE Permanently delete a contact by email address and all associated content to follow GDPR. If contact isn&#39;t found, blacklists an email address from being used in the future.



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/hubspot/codegen/crm/contacts/api/gdpr_api.rb', line 39

def purge_by_email_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GDPRApi.purge_by_email ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling GDPRApi.purge_by_email"
  end
  # resource path
  local_var_path = '/crm/v3/objects/gdpr/contacts/email/{email}'.sub('{' + 'email' + '}', CGI.escape(email.to_s))

  # 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(['*/*'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GDPRApi#purge_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purge_by_id(contact_id, opts = {}) ⇒ nil

DELETE Permanently delete a contact by id and all associated content to follow GDPR



91
92
93
94
 
# File 'lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb', line 91

def purge_by_id(contact_id, opts = {})
  purge_by_id_with_http_info(contact_id, opts)
  nil
end

#purge_by_id_with_http_info(contact_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

DELETE Permanently delete a contact by id and all associated content to follow GDPR



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb', line 101

def purge_by_id_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GDPRApi.purge_by_id ...'
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling GDPRApi.purge_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/objects/gdpr/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))

  # 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(['*/*'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GDPRApi#purge_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end