Class: Hubspot::Crm::Quotes::AssociationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/quotes/api/associations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssociationsApi

Returns a new instance of AssociationsApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/quotes/api/associations_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/quotes/api/associations_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_all(quote_id, to_object_type, opts = {}) ⇒ CollectionResponseAssociatedId

List associations of a quote by type

Parameters:

  • quote_id (String)
  • to_object_type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :paginate_associations (Boolean) — default: default to false
  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to display per page. (default to 500)

Returns:



32
33
34
35
 
# File 'lib/hubspot/codegen/crm/quotes/api/associations_api.rb', line 32

def get_all(quote_id, to_object_type, opts = {})
  data, _status_code, _headers = get_all_with_http_info(quote_id, to_object_type, opts)
  data
end

#get_all_with_http_info(quote_id, to_object_type, opts = {}) ⇒ Array<(CollectionResponseAssociatedId, Integer, Hash)>

List associations of a quote by type

Parameters:

  • quote_id (String)
  • to_object_type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :paginate_associations (Boolean)
  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to display per page.

Returns:



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
97
 
# File 'lib/hubspot/codegen/crm/quotes/api/associations_api.rb', line 45

def get_all_with_http_info(quote_id, to_object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AssociationsApi.get_all"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.get_all"
  end
  # resource path
  local_var_path = '/crm/v3/objects/quotes/{quoteId}/associations/{toObjectType}'.sub('{' + 'quoteId' + '}', CGI.escape(quote_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].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[:body] 

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey']

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