class Hubspot::Crm::Products::BatchApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 21
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

archive(batch_input_simple_public_object_id, opts = {}) click to toggle source

Archive a batch of products by ID Archive a list of products 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]

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 29
def archive(batch_input_simple_public_object_id, opts = {})
  archive_with_http_info(batch_input_simple_public_object_id, opts)
  nil
end
archive_with_http_info(batch_input_simple_public_object_id, opts = {}) click to toggle source

Archive a batch of products by ID Archive a list of products given a collection of IDs. This method will return a &#x60;204 No Content&#x60; 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

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 39
def archive_with_http_info(batch_input_simple_public_object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
  end
  # verify the required parameter 'batch_input_simple_public_object_id' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/objects/products/batch/archive'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_id) 

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
create(batch_input_simple_public_object_input, opts = {}) click to toggle source

Create a batch of products Create a batch of products. 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]

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 93
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_with_http_info(batch_input_simple_public_object_input, opts = {}) click to toggle source

Create a batch of products Create a batch of products. 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

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 103
def create_with_http_info(batch_input_simple_public_object_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
  end
  # verify the required parameter 'batch_input_simple_public_object_input' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_input.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input' when calling BatchApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/objects/products/batch/create'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_input) 

  # return_type
  return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(batch_read_input_simple_public_object_id, opts = {}) click to toggle source

Read a batch of products by internal ID, or unique property values Read a list of products 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]

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 158
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_with_http_info(batch_read_input_simple_public_object_id, opts = {}) click to toggle source

Read a batch of products by internal ID, or unique property values Read a list of products given a collection of IDs. Use the &#x60;properties&#x60; 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

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 169
def read_with_http_info(batch_read_input_simple_public_object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
  end
  # verify the required parameter 'batch_read_input_simple_public_object_id' is set
  if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read"
  end
  # resource path
  local_var_path = '/crm/v3/objects/products/batch/read'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(batch_read_input_simple_public_object_id) 

  # return_type
  return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(batch_input_simple_public_object_batch_input, opts = {}) click to toggle source

Update a batch of products Perform a partial upate on a batch of products. 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]

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 224
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_with_http_info(batch_input_simple_public_object_batch_input, opts = {}) click to toggle source

Update a batch of products Perform a partial upate on a batch of products. 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

# File lib/hubspot/codegen/crm/products/api/batch_api.rb, line 234
def update_with_http_info(batch_input_simple_public_object_batch_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
  end
  # verify the required parameter 'batch_input_simple_public_object_batch_input' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/objects/products/batch/update'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input) 

  # return_type
  return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 

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