lib/hubspot/codegen/crm/contacts/api/batch_api.rb in hubspot-api-client-10.1.1 vs lib/hubspot/codegen/crm/contacts/api/batch_api.rb in hubspot-api-client-11.1.0
- old
+ new
@@ -20,21 +20,19 @@
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
# Archive a batch of contacts by ID
- # Archive a list of contacts given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
# @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId]
# @param [Hash] opts the optional parameters
# @return [nil]
def archive(batch_input_simple_public_object_id, opts = {})
archive_with_http_info(batch_input_simple_public_object_id, opts)
nil
end
# Archive a batch of contacts by ID
- # Archive a list of contacts given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
# @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId]
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def archive_with_http_info(batch_input_simple_public_object_id, opts = {})
if @api_client.config.debugging
@@ -84,21 +82,19 @@
end
return data, status_code, headers
end
# Create a batch of contacts
- # Create a batch of contacts. This follows the same rules as creating an individual object.
# @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput]
# @param [Hash] opts the optional parameters
# @return [BatchResponseSimplePublicObject]
def create(batch_input_simple_public_object_input, opts = {})
data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input, opts)
data
end
# Create a batch of contacts
- # Create a batch of contacts. This follows the same rules as creating an individual object.
# @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput]
# @param [Hash] opts the optional parameters
# @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
def create_with_http_info(batch_input_simple_public_object_input, opts = {})
if @api_client.config.debugging
@@ -148,22 +144,20 @@
end
return data, status_code, headers
end
# Read a batch of contacts by internal ID, or unique property values
- # Read a list of contacts given a collection of IDs. Use the `properties` request body property to control which properties are returned.
# @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId]
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
# @return [BatchResponseSimplePublicObject]
def read(batch_read_input_simple_public_object_id, opts = {})
data, _status_code, _headers = read_with_http_info(batch_read_input_simple_public_object_id, opts)
data
end
# Read a batch of contacts by internal ID, or unique property values
- # Read a list of contacts given a collection of IDs. Use the `properties` request body property to control which properties are returned.
# @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId]
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :archived Whether to return only results that have been archived.
# @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
def read_with_http_info(batch_read_input_simple_public_object_id, opts = {})
@@ -215,20 +209,18 @@
end
return data, status_code, headers
end
# Update a batch of contacts
- # Perform a partial upate on a batch of contacts. This follows the same rules as performing partial updates on an individual object.
# @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput]
# @param [Hash] opts the optional parameters
# @return [BatchResponseSimplePublicObject]
def update(batch_input_simple_public_object_batch_input, opts = {})
data, _status_code, _headers = update_with_http_info(batch_input_simple_public_object_batch_input, opts)
data
end
# Update a batch of contacts
- # Perform a partial upate on a batch of contacts. This follows the same rules as performing partial updates on an individual object.
# @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput]
# @param [Hash] opts the optional parameters
# @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
def update_with_http_info(batch_input_simple_public_object_batch_input, opts = {})
if @api_client.config.debugging