Class: Hubspot::Crm::Products::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/products/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.



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

def api_client
  @api_client
end

Instance Method Details

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

Archive a batch of products by ID

Parameters:

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 28

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

Archive a batch of products by ID

Parameters:

Returns:

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

    nil, response status code and response headers



37
38
39
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
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 37

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'
  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_input_simple_public_object_id)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"BatchApi.archive",
    :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_for_create, opts = {}) ⇒ BatchResponseSimplePublicObject

Create a batch of products

Parameters:

Returns:



94
95
96
97
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 94

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

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

Create a batch of products

Parameters:

Returns:



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
147
148
149
150
151
152
153
154
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 103

def create_with_http_info(batch_input_simple_public_object_input_for_create, 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_for_create' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_input_for_create.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input_for_create' 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'
  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_input_simple_public_object_input_for_create)

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

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

  new_options = opts.merge(
    :operation => :"BatchApi.create",
    :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 = {}) ⇒ BatchResponseSimplePublicObject

Read a batch of products 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:



161
162
163
164
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 161

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



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
221
222
223
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 171

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

#update(batch_input_simple_public_object_batch_input, opts = {}) ⇒ BatchResponseSimplePublicObject

Update a batch of products by internal ID, or unique property values

Parameters:

Returns:



229
230
231
232
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 229

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

Update a batch of products by internal ID, or unique property values

Parameters:

Returns:



238
239
240
241
242
243
244
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
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 238

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'
  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_input_simple_public_object_batch_input)

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

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

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

#upsert(batch_input_simple_public_object_batch_input_upsert, opts = {}) ⇒ BatchResponseSimplePublicUpsertObject

Create or update a batch of products by unique property values Create or update records identified by a unique property value as specified by the ‘idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.

Parameters:

Returns:



296
297
298
299
 
# File 'lib/hubspot/codegen/crm/products/api/batch_api.rb', line 296

def upsert(batch_input_simple_public_object_batch_input_upsert, opts = {})
  data, _status_code, _headers = upsert_with_http_info(batch_input_simple_public_object_batch_input_upsert, opts)
  data
end

#upsert_with_http_info(batch_input_simple_public_object_batch_input_upsert, opts = {}) ⇒ Array<(BatchResponseSimplePublicUpsertObject, Integer, Hash)>

Create or update a batch of products by unique property values Create or update records identified by a unique property value as specified by the &#x60;idProperty&#x60; query param. &#x60;idProperty&#x60; query param refers to a property whose values are unique for the object.

Parameters:

Returns:



306
307
308
309
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/products/api/batch_api.rb', line 306

def upsert_with_http_info(batch_input_simple_public_object_batch_input_upsert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.upsert ...'
  end
  # verify the required parameter 'batch_input_simple_public_object_batch_input_upsert' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input_upsert.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input_upsert' when calling BatchApi.upsert"
  end
  # resource path
  local_var_path = '/crm/v3/objects/products/batch/upsert'

  # 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'
  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_input_simple_public_object_batch_input_upsert)

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

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

  new_options = opts.merge(
    :operation => :"BatchApi.upsert",
    :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#upsert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end