Class: Hubspot::Crm::Objects::GDPRApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Objects::GDPRApi
- Defined in:
- lib/hubspot/codegen/crm/objects/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_by_email(object_type, email, opts = {}) ⇒ nil
DELETE Permanently delete a contact by email address and all associated content to follow GDPR.
-
#purge_by_email_with_http_info(object_type, email, opts = {}) ⇒ Array<(nil, Integer, Hash)>
DELETE Permanently delete a contact by email address and all associated content to follow GDPR.
-
#purge_by_id(object_type, object_id, opts = {}) ⇒ nil
DELETE Permanently delete a contact by id and all associated content to follow GDPR.
-
#purge_by_id_with_http_info(object_type, object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
DELETE Permanently delete a contact by id and all associated content to follow GDPR.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
19 20 21 |
# File 'lib/hubspot/codegen/crm/objects/api/gdpr_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#purge_by_email(object_type, 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.
30 31 32 33 |
# File 'lib/hubspot/codegen/crm/objects/api/gdpr_api.rb', line 30 def purge_by_email(object_type, email, opts = {}) purge_by_email_with_http_info(object_type, email, opts) nil end |
#purge_by_email_with_http_info(object_type, email, opts = {}) ⇒ Array<(nil, Integer, Hash)>
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.
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 |
# File 'lib/hubspot/codegen/crm/objects/api/gdpr_api.rb', line 41 def purge_by_email_with_http_info(object_type, email, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GDPRApi.purge_by_email ...' end # verify the required parameter 'object_type' is set if @api_client.config.client_side_validation && object_type.nil? fail ArgumentError, "Missing the required parameter 'object_type' when calling 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/{objectType}/email/{email}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).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'] = 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, ) 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(object_type, object_id, opts = {}) ⇒ nil
DELETE Permanently delete a contact by id and all associated content to follow GDPR
98 99 100 101 |
# File 'lib/hubspot/codegen/crm/objects/api/gdpr_api.rb', line 98 def purge_by_id(object_type, object_id, opts = {}) purge_by_id_with_http_info(object_type, object_id, opts) nil end |
#purge_by_id_with_http_info(object_type, object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
DELETE Permanently delete a contact by id and all associated content to follow GDPR
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 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/hubspot/codegen/crm/objects/api/gdpr_api.rb', line 109 def purge_by_id_with_http_info(object_type, object_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GDPRApi.purge_by_id ...' end # verify the required parameter 'object_type' is set if @api_client.config.client_side_validation && object_type.nil? fail ArgumentError, "Missing the required parameter 'object_type' when calling GDPRApi.purge_by_id" end # verify the required parameter 'object_id' is set if @api_client.config.client_side_validation && object_id.nil? fail ArgumentError, "Missing the required parameter 'object_id' when calling GDPRApi.purge_by_id" end # resource path local_var_path = '/crm/v3/objects/gdpr/{objectType}/{objectId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'objectId' + '}', CGI.escape(object_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'] = 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, ) 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 |