Class: Hubspot::Crm::Lists::MembershipsApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Lists::MembershipsApi
- Defined in:
- lib/hubspot/codegen/crm/lists/api/memberships_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add(list_id, request_body, opts = {}) ⇒ MembershipsUpdateResponse
Add Records to a List Add the records provided to the list.
-
#add_all_from_list(list_id, source_list_id, opts = {}) ⇒ nil
Add All Records from a Source List to a Destination List Add all of the records from a *source list* (specified by the ‘sourceListId`) to a *destination list* (specified by the `listId`).
-
#add_all_from_list_with_http_info(list_id, source_list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Add All Records from a Source List to a Destination List Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`).
-
#add_and_remove(list_id, membership_change_request, opts = {}) ⇒ MembershipsUpdateResponse
Add and/or Remove Records from a List Add and/or remove records that have already been created in the system to and/or from a list.
-
#add_and_remove_with_http_info(list_id, membership_change_request, opts = {}) ⇒ Array<(MembershipsUpdateResponse, Integer, Hash)>
Add and/or Remove Records from a List Add and/or remove records that have already been created in the system to and/or from a list.
-
#add_with_http_info(list_id, request_body, opts = {}) ⇒ Array<(MembershipsUpdateResponse, Integer, Hash)>
Add Records to a List Add the records provided to the list.
-
#get_page(list_id, opts = {}) ⇒ CollectionResponseLong
Fetch List Memberships Ordered by ID Fetch the memberships of a list in order sorted by the ‘recordId` of the records in the list.
-
#get_page_with_http_info(list_id, opts = {}) ⇒ Array<(CollectionResponseLong, Integer, Hash)>
Fetch List Memberships Ordered by ID Fetch the memberships of a list in order sorted by the `recordId` of the records in the list.
-
#initialize(api_client = ApiClient.default) ⇒ MembershipsApi
constructor
A new instance of MembershipsApi.
-
#remove(list_id, request_body, opts = {}) ⇒ MembershipsUpdateResponse
Remove Records from a List Remove the records provided from the list.
-
#remove_all(list_id, opts = {}) ⇒ nil
Delete All Records from a List Remove all of the records from a list.
-
#remove_all_with_http_info(list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete All Records from a List Remove all of the records from a list.
-
#remove_with_http_info(list_id, request_body, opts = {}) ⇒ Array<(MembershipsUpdateResponse, Integer, Hash)>
Remove Records from a List Remove the records provided from the list.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ MembershipsApi
Returns a new instance of MembershipsApi.
21 22 23 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_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/lists/api/memberships_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#add(list_id, request_body, opts = {}) ⇒ MembershipsUpdateResponse
Add Records to a List Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a ‘processingType` of `MANUAL` or `SNAPSHOT`.
30 31 32 33 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 30 def add(list_id, request_body, opts = {}) data, _status_code, _headers = add_with_http_info(list_id, request_body, opts) data end |
#add_all_from_list(list_id, source_list_id, opts = {}) ⇒ nil
Add All Records from a Source List to a Destination List Add all of the records from a *source list* (specified by the ‘sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The destination and *source list* IDs must be different. The destination and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`.
104 105 106 107 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 104 def add_all_from_list(list_id, source_list_id, opts = {}) add_all_from_list_with_http_info(list_id, source_list_id, opts) nil end |
#add_all_from_list_with_http_info(list_id, source_list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Add All Records from a Source List to a Destination List Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The destination and *source list* IDs must be different. The destination and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`.
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 159 160 161 162 163 164 165 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 115 def add_all_from_list_with_http_info(list_id, source_list_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MembershipsApi.add_all_from_list ...' end # verify the required parameter 'list_id' is set if @api_client.config.client_side_validation && list_id.nil? fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.add_all_from_list" end # verify the required parameter 'source_list_id' is set if @api_client.config.client_side_validation && source_list_id.nil? fail ArgumentError, "Missing the required parameter 'source_list_id' when calling MembershipsApi.add_all_from_list" end # resource path local_var_path = '/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s)).sub('{' + 'sourceListId' + '}', CGI.escape(source_list_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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"MembershipsApi.add_all_from_list", :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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MembershipsApi#add_all_from_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#add_and_remove(list_id, membership_change_request, opts = {}) ⇒ MembershipsUpdateResponse
Add and/or Remove Records from a List Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a ‘processingType` of `MANUAL` or `SNAPSHOT`.
173 174 175 176 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 173 def add_and_remove(list_id, membership_change_request, opts = {}) data, _status_code, _headers = add_and_remove_with_http_info(list_id, membership_change_request, opts) data end |
#add_and_remove_with_http_info(list_id, membership_change_request, opts = {}) ⇒ Array<(MembershipsUpdateResponse, Integer, Hash)>
Add and/or Remove Records from a List Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 184 def add_and_remove_with_http_info(list_id, membership_change_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MembershipsApi.add_and_remove ...' end # verify the required parameter 'list_id' is set if @api_client.config.client_side_validation && list_id.nil? fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.add_and_remove" end # verify the required parameter 'membership_change_request' is set if @api_client.config.client_side_validation && membership_change_request.nil? fail ArgumentError, "Missing the required parameter 'membership_change_request' when calling MembershipsApi.add_and_remove" end # resource path local_var_path = '/crm/v3/lists/{listId}/memberships/add-and-remove'.sub('{' + 'listId' + '}', CGI.escape(list_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(['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[:debug_body] || @api_client.object_to_http_body(membership_change_request) # return_type return_type = opts[:debug_return_type] || 'MembershipsUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"MembershipsApi.add_and_remove", :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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MembershipsApi#add_and_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#add_with_http_info(list_id, request_body, opts = {}) ⇒ Array<(MembershipsUpdateResponse, Integer, Hash)>
Add Records to a List Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
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 94 95 96 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 41 def add_with_http_info(list_id, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MembershipsApi.add ...' end # verify the required parameter 'list_id' is set if @api_client.config.client_side_validation && list_id.nil? fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.add" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling MembershipsApi.add" end # resource path local_var_path = '/crm/v3/lists/{listId}/memberships/add'.sub('{' + 'listId' + '}', CGI.escape(list_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(['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[:debug_body] || @api_client.object_to_http_body(request_body) # return_type return_type = opts[:debug_return_type] || 'MembershipsUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"MembershipsApi.add", :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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MembershipsApi#add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_page(list_id, opts = {}) ⇒ CollectionResponseLong
Fetch List Memberships Ordered by ID Fetch the memberships of a list in order sorted by the ‘recordId` of the records in the list. The `recordId`s are sorted in ascending order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in descending order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
249 250 251 252 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 249 def get_page(list_id, opts = {}) data, _status_code, _headers = get_page_with_http_info(list_id, opts) data end |
#get_page_with_http_info(list_id, opts = {}) ⇒ Array<(CollectionResponseLong, Integer, Hash)>
Fetch List Memberships Ordered by ID Fetch the memberships of a list in order sorted by the `recordId` of the records in the list. The `recordId`s are sorted in ascending order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in descending order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 262 def get_page_with_http_info(list_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MembershipsApi.get_page ...' end # verify the required parameter 'list_id' is set if @api_client.config.client_side_validation && list_id.nil? fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.get_page" end # resource path local_var_path = '/crm/v3/lists/{listId}/memberships'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CollectionResponseLong' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"MembershipsApi.get_page", :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(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MembershipsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove(list_id, request_body, opts = {}) ⇒ MembershipsUpdateResponse
Remove Records from a List Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a ‘processingType` of `MANUAL` or `SNAPSHOT`.
319 320 321 322 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 319 def remove(list_id, request_body, opts = {}) data, _status_code, _headers = remove_with_http_info(list_id, request_body, opts) data end |
#remove_all(list_id, opts = {}) ⇒ nil
Delete All Records from a List Remove all of the records from a list. ***Note:*** *The list is not deleted.* This endpoint only works for lists that have a ‘processingType` of `MANUAL` or `SNAPSHOT`.
392 393 394 395 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 392 def remove_all(list_id, opts = {}) remove_all_with_http_info(list_id, opts) nil end |
#remove_all_with_http_info(list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete All Records from a List Remove all of the records from a list. ***Note:*** *The list is not deleted.* This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 402 def remove_all_with_http_info(list_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MembershipsApi.remove_all ...' end # verify the required parameter 'list_id' is set if @api_client.config.client_side_validation && list_id.nil? fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.remove_all" end # resource path local_var_path = '/crm/v3/lists/{listId}/memberships'.sub('{' + 'listId' + '}', CGI.escape(list_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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"MembershipsApi.remove_all", :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: MembershipsApi#remove_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#remove_with_http_info(list_id, request_body, opts = {}) ⇒ Array<(MembershipsUpdateResponse, Integer, Hash)>
Remove Records from a List Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/hubspot/codegen/crm/lists/api/memberships_api.rb', line 330 def remove_with_http_info(list_id, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MembershipsApi.remove ...' end # verify the required parameter 'list_id' is set if @api_client.config.client_side_validation && list_id.nil? fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.remove" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling MembershipsApi.remove" end # resource path local_var_path = '/crm/v3/lists/{listId}/memberships/remove'.sub('{' + 'listId' + '}', CGI.escape(list_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(['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[:debug_body] || @api_client.object_to_http_body(request_body) # return_type return_type = opts[:debug_return_type] || 'MembershipsUpdateResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"MembershipsApi.remove", :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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: MembershipsApi#remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |