Class: Hubspot::Crm::Objects::Goals::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/objects/goals/api/batch_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchApi

Returns a new instance of BatchApi.



22
23
24
 
# File 'lib/hubspot/codegen/crm/objects/goals/api/batch_api.rb', line 22

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/crm/objects/goals/api/batch_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#read(batch_read_input_simple_public_object_id, opts = {}) ⇒ BatchResponseSimplePublicObject

Read a batch of goal targets by internal ID, or unique property values

Parameters:

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived. (default to false)

Returns:



30
31
32
33
 
# File 'lib/hubspot/codegen/crm/objects/goals/api/batch_api.rb', line 30

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 = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

Read a batch of goal targets by internal ID, or unique property values

Parameters:

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived. (default to false)

Returns:



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
92
 
# File 'lib/hubspot/codegen/crm/objects/goals/api/batch_api.rb', line 40

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/goal_targets/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'
  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(batch_read_input_simple_public_object_id)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"BatchApi.read",
    :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