Class: Hubspot::Crm::Quotes::BasicApi

Inherits:
Object
  • Object
show all
Includes:
Helpers::GetAllHelper
Defined in:
lib/hubspot/codegen/crm/quotes/api/basic_api.rb

Constant Summary

Constants included from Helpers::GetAllHelper

Helpers::GetAllHelper::MAX_PAGE_SIZE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers::GetAllHelper

#get_all

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BasicApi

Returns a new instance of BasicApi.



23
24
25
 
# File 'lib/hubspot/codegen/crm/quotes/api/basic_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/hubspot/codegen/crm/quotes/api/basic_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_by_id(quote_id, opts = {}) ⇒ SimplePublicObject

Read Read an Object identified by ‘quoteId`. `quoteId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :properties (Array<String>) —

    A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

  • :associations (Array<String>) —

    A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

  • :paginate_associations (Boolean) — default: default to false
  • :archived (Boolean) —

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

  • :id_property (String) —

    The name of a property whose values are unique for this object type

Returns:



36
37
38
39
 
# File 'lib/hubspot/codegen/crm/quotes/api/basic_api.rb', line 36

def get_by_id(quote_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(quote_id, opts)
  data
end

#get_by_id_with_http_info(quote_id, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>

Read Read an Object identified by &#x60;quoteId&#x60;. &#x60;quoteId&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param. Control what is returned via the &#x60;properties&#x60; query param.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :properties (Array<String>) —

    A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

  • :associations (Array<String>) —

    A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

  • :paginate_associations (Boolean)
  • :archived (Boolean) —

    Whether to return only results that have been archived.

  • :id_property (String) —

    The name of a property whose values are unique for this object type

Returns:

  • (Array<(SimplePublicObject, Integer, Hash)>) —

    SimplePublicObject data, response status code and response headers



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
98
99
100
101
 
# File 'lib/hubspot/codegen/crm/quotes/api/basic_api.rb', line 51

def get_by_id_with_http_info(quote_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...'
  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 BasicApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/objects/quotes/{quoteId}'.sub('{' + 'quoteId' + '}', CGI.escape(quote_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
  query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
  query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
  query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].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] || 'SimplePublicObject' 

  # 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: BasicApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page(opts = {}) ⇒ CollectionResponseSimplePublicObject

List Read a page of quotes. Control what is returned via the ‘properties` query param.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

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

  • :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.

  • :properties (Array<String>) —

    A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

  • :associations (Array<String>) —

    A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

  • :paginate_associations (Boolean) — default: default to false
  • :archived (Boolean) —

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

Returns:



113
114
115
116
 
# File 'lib/hubspot/codegen/crm/quotes/api/basic_api.rb', line 113

def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponseSimplePublicObject, Integer, Hash)>

List Read a page of quotes. Control what is returned via the &#x60;properties&#x60; query param.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of results to display per page.

  • :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.

  • :properties (Array<String>) —

    A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

  • :associations (Array<String>) —

    A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

  • :paginate_associations (Boolean)
  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



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
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/hubspot/codegen/crm/quotes/api/basic_api.rb', line 128

def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.get_page ...'
  end
  # resource path
  local_var_path = '/crm/v3/objects/quotes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
  query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
  query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
  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', '*/*'])

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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: BasicApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end