Class: Hubspot::Crm::Companies::BasicApi

Inherits:
Object
  • Object
show all
Includes:
Helpers::GetAllHelper
Defined in:
lib/hubspot/codegen/crm/companies/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/companies/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/companies/api/basic_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#archive(company_id, opts = {}) ⇒ nil

Archive Move an Object identified by ‘companyId` to the recycling bin.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


31
32
33
34
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 31

def archive(company_id, opts = {})
  archive_with_http_info(company_id, opts)
  nil
end

#archive_with_http_info(company_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Archive Move an Object identified by &#x60;companyId&#x60; to the recycling bin.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 41

def archive_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.archive ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling BasicApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/objects/companies/{companyId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s))

  # 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(['*/*'])

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

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

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

#create(opts = {}) ⇒ SimplePublicObject

Create Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native companies is provided.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



93
94
95
96
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 93

def create(opts = {})
  data, _status_code, _headers = create_with_http_info(opts)
  data
end

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

Create Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native companies is provided.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SimplePublicObject data, response status code and response headers



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 103

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

  # 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(opts[:'simple_public_object_input']) 

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

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

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

Read Read an Object identified by ‘companyId`. `companyId` 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:

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

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



157
158
159
160
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 157

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

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

Read Read an Object identified by &#x60;companyId&#x60;. &#x60;companyId&#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:

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

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 171

def get_by_id_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling BasicApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/objects/companies/{companyId}'.sub('{' + 'companyId' + '}', CGI.escape(company_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[:'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', '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(: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 companies. 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.

  • :archived (Boolean) —

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

Returns:



231
232
233
234
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 231

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 companies. 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.

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 245

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/companies'

  # 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[:'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', '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(: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

#update(company_id, opts = {}) ⇒ SimplePublicObject

Update Perform a partial update of an Object identified by ‘companyId`. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



299
300
301
302
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 299

def update(company_id, opts = {})
  data, _status_code, _headers = update_with_http_info(company_id, opts)
  data
end

#update_with_http_info(company_id, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>

Update Perform a partial update of an Object identified by &#x60;companyId&#x60;. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SimplePublicObject data, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/hubspot/codegen/crm/companies/api/basic_api.rb', line 310

def update_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BasicApi.update ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling BasicApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/objects/companies/{companyId}'.sub('{' + 'companyId' + '}', CGI.escape(company_id.to_s))

  # 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(opts[:'simple_public_object_input']) 

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

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