Class: Hubspot::Crm::Objects::Communications::GDPRApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Objects::Communications::GDPRApi
- Defined in:
- lib/hubspot/codegen/crm/objects/communications/api/gdpr_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ GDPRApi
constructor
A new instance of GDPRApi.
-
#purge(public_gdpr_delete_input, opts = {}) ⇒ nil
GDPR DELETE Permanently delete a contact and all associated content to follow GDPR.
-
#purge_with_http_info(public_gdpr_delete_input, opts = {}) ⇒ Array<(nil, Integer, Hash)>
GDPR DELETE Permanently delete a contact and all associated content to follow GDPR.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
20 21 22 |
# File 'lib/hubspot/codegen/crm/objects/communications/api/gdpr_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#purge(public_gdpr_delete_input, opts = {}) ⇒ nil
GDPR DELETE Permanently delete a contact and all associated content to follow GDPR. Use optional property ‘idProperty’ set to ‘email’ to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
30 31 32 33 |
# File 'lib/hubspot/codegen/crm/objects/communications/api/gdpr_api.rb', line 30 def purge(public_gdpr_delete_input, opts = {}) purge_with_http_info(public_gdpr_delete_input, opts) nil end |
#purge_with_http_info(public_gdpr_delete_input, opts = {}) ⇒ Array<(nil, Integer, Hash)>
GDPR DELETE Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
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 |
# File 'lib/hubspot/codegen/crm/objects/communications/api/gdpr_api.rb', line 40 def purge_with_http_info(public_gdpr_delete_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GDPRApi.purge ...' end # verify the required parameter 'public_gdpr_delete_input' is set if @api_client.config.client_side_validation && public_gdpr_delete_input.nil? fail ArgumentError, "Missing the required parameter 'public_gdpr_delete_input' when calling GDPRApi.purge" end # resource path local_var_path = '/crm/v3/objects/communications/gdpr-delete' # 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(['*/*']) # 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[:debug_body] || @api_client.object_to_http_body(public_gdpr_delete_input) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"GDPRApi.purge", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: GDPRApi#purge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |