Class: UltracartClient::ItemApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/item_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ItemApi

Returns a new instance of ItemApi.



19
20
21
 
# File 'lib/ultracart_api/api/item_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ultracart_api/api/item_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/item_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::ItemApi.new(api_client)
end

Instance Method Details

#delete_digital_item(digital_item_oid, opts = {}) ⇒ nil

Delete a digital item, which is a file within the digital library, not an actual merchant item Delete a digital item on the UltraCart account.

Parameters:

  • digital_item_oid —

    The digital item oid to delete.

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

    the optional parameters

Returns:

  • (nil) 


40
41
42
43
 
# File 'lib/ultracart_api/api/item_api.rb', line 40

def delete_digital_item(digital_item_oid, opts = {})
  delete_digital_item_with_http_info(digital_item_oid, opts)
  nil
end

#delete_digital_item_with_http_info(digital_item_oid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a digital item, which is a file within the digital library, not an actual merchant item Delete a digital item on the UltraCart account.

Parameters:

  • digital_item_oid —

    The digital item oid to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/ultracart_api/api/item_api.rb', line 50

def delete_digital_item_with_http_info(digital_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.delete_digital_item ...'
  end
  # verify the required parameter 'digital_item_oid' is set
  if @api_client.config.client_side_validation && digital_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.delete_digital_item"
  end
  # resource path
  local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#delete_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_item(merchant_item_oid, opts = {}) ⇒ nil

Delete an item Delete an item on the UltraCart account.

Parameters:

  • merchant_item_oid —

    The item oid to delete.

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

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/ultracart_api/api/item_api.rb', line 94

def delete_item(merchant_item_oid, opts = {})
  delete_item_with_http_info(merchant_item_oid, opts)
  nil
end

#delete_item_with_http_info(merchant_item_oid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an item Delete an item on the UltraCart account.

Parameters:

  • merchant_item_oid —

    The item oid to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ultracart_api/api/item_api.rb', line 104

def delete_item_with_http_info(merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.delete_item ...'
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.delete_item"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#delete_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_review(review_oid, merchant_item_oid, opts = {}) ⇒ nil

Delete a review Delete an item review.

Parameters:

  • review_oid —

    The review oid to delete.

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:

  • (nil) 


149
150
151
152
 
# File 'lib/ultracart_api/api/item_api.rb', line 149

def delete_review(review_oid, merchant_item_oid, opts = {})
  delete_review_with_http_info(review_oid, merchant_item_oid, opts)
  nil
end

#delete_review_with_http_info(review_oid, merchant_item_oid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a review Delete an item review.

Parameters:

  • review_oid —

    The review oid to delete.

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



160
161
162
163
164
165
166
167
168
169
170
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
 
# File 'lib/ultracart_api/api/item_api.rb', line 160

def delete_review_with_http_info(review_oid, merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.delete_review ...'
  end
  # verify the required parameter 'review_oid' is set
  if @api_client.config.client_side_validation && review_oid.nil?
    fail ArgumentError, "Missing the required parameter 'review_oid' when calling ItemApi.delete_review"
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.delete_review"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}/reviews/{review_oid}'.sub('{' + 'review_oid' + '}', review_oid.to_s).sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#delete_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_digital_item(digital_item_oid, opts = {}) ⇒ ItemDigitalItemResponse

Retrieve a digital item from the digital library, which are digital files that may be attached to normal items Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.

Parameters:

  • digital_item_oid —

    The digital item oid to retrieve.

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

    the optional parameters

Returns:



208
209
210
211
 
# File 'lib/ultracart_api/api/item_api.rb', line 208

def get_digital_item(digital_item_oid, opts = {})
  data, _status_code, _headers = get_digital_item_with_http_info(digital_item_oid, opts)
  data
end

#get_digital_item_with_http_info(digital_item_oid, opts = {}) ⇒ Array<(ItemDigitalItemResponse, Fixnum, Hash)>

Retrieve a digital item from the digital library, which are digital files that may be attached to normal items Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.

Parameters:

  • digital_item_oid —

    The digital item oid to retrieve.

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

    the optional parameters

Returns:

  • (Array<(ItemDigitalItemResponse, Fixnum, Hash)>) —

    ItemDigitalItemResponse data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ultracart_api/api/item_api.rb', line 218

def get_digital_item_with_http_info(digital_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_item ...'
  end
  # verify the required parameter 'digital_item_oid' is set
  if @api_client.config.client_side_validation && digital_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.get_digital_item"
  end
  # resource path
  local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemDigitalItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_digital_items(opts = {}) ⇒ ItemDigitalItemsResponse

Retrieve digital items from the digital library which are digital files that may be attached to normal items Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_since (String) —

    Fetch items that have been created/modified since this date/time.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



268
269
270
271
 
# File 'lib/ultracart_api/api/item_api.rb', line 268

def get_digital_items(opts = {})
  data, _status_code, _headers = get_digital_items_with_http_info(opts)
  data
end

#get_digital_items_by_external_id(external_id, opts = {}) ⇒ ItemDigitalItemsResponse

Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.

Parameters:

  • external_id —

    The external id to match against.

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

    the optional parameters

Returns:



330
331
332
333
 
# File 'lib/ultracart_api/api/item_api.rb', line 330

def get_digital_items_by_external_id(external_id, opts = {})
  data, _status_code, _headers = get_digital_items_by_external_id_with_http_info(external_id, opts)
  data
end

#get_digital_items_by_external_id_with_http_info(external_id, opts = {}) ⇒ Array<(ItemDigitalItemsResponse, Fixnum, Hash)>

Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.

Parameters:

  • external_id —

    The external id to match against.

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

    the optional parameters

Returns:

  • (Array<(ItemDigitalItemsResponse, Fixnum, Hash)>) —

    ItemDigitalItemsResponse data, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/ultracart_api/api/item_api.rb', line 340

def get_digital_items_by_external_id_with_http_info(external_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items_by_external_id ...'
  end
  # verify the required parameter 'external_id' is set
  if @api_client.config.client_side_validation && external_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_id' when calling ItemApi.get_digital_items_by_external_id"
  end
  # resource path
  local_var_path = '/item/digital_library/by_external/{external_id}'.sub('{' + 'external_id' + '}', external_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemDigitalItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_digital_items_by_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_digital_items_with_http_info(opts = {}) ⇒ Array<(ItemDigitalItemsResponse, Fixnum, Hash)>

Retrieve digital items from the digital library which are digital files that may be attached to normal items Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 2000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_since (String) —

    Fetch items that have been created/modified since this date/time.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemDigitalItemsResponse, Fixnum, Hash)>) —

    ItemDigitalItemsResponse data, response status code and response headers



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ultracart_api/api/item_api.rb', line 283

def get_digital_items_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items ...'
  end
  # resource path
  local_var_path = '/item/digital_library'

  # query parameters
  query_params = {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemDigitalItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_item(merchant_item_oid, opts = {}) ⇒ ItemResponse

Retrieve an item Retrieves a single item using the specified item oid.

Parameters:

  • merchant_item_oid —

    The item oid to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



387
388
389
390
 
# File 'lib/ultracart_api/api/item_api.rb', line 387

def get_item(merchant_item_oid, opts = {})
  data, _status_code, _headers = get_item_with_http_info(merchant_item_oid, opts)
  data
end

#get_item_by_merchant_item_id(merchant_item_id, opts = {}) ⇒ ItemResponse

Retrieve an item by item id Retrieves a single item using the specified item id.

Parameters:

  • merchant_item_id —

    The item id to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



448
449
450
451
 
# File 'lib/ultracart_api/api/item_api.rb', line 448

def get_item_by_merchant_item_id(merchant_item_id, opts = {})
  data, _status_code, _headers = get_item_by_merchant_item_id_with_http_info(merchant_item_id, opts)
  data
end

#get_item_by_merchant_item_id_with_http_info(merchant_item_id, opts = {}) ⇒ Array<(ItemResponse, Fixnum, Hash)>

Retrieve an item by item id Retrieves a single item using the specified item id.

Parameters:

  • merchant_item_id —

    The item id to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemResponse, Fixnum, Hash)>) —

    ItemResponse data, response status code and response headers



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/ultracart_api/api/item_api.rb', line 460

def get_item_by_merchant_item_id_with_http_info(merchant_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_item_by_merchant_item_id ...'
  end
  # verify the required parameter 'merchant_item_id' is set
  if @api_client.config.client_side_validation && merchant_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_id' when calling ItemApi.get_item_by_merchant_item_id"
  end
  # resource path
  local_var_path = '/item/items/merchant_item_id/{merchant_item_id}'.sub('{' + 'merchant_item_id' + '}', merchant_item_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_item_by_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_item_with_http_info(merchant_item_oid, opts = {}) ⇒ Array<(ItemResponse, Fixnum, Hash)>

Retrieve an item Retrieves a single item using the specified item oid.

Parameters:

  • merchant_item_oid —

    The item oid to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemResponse, Fixnum, Hash)>) —

    ItemResponse data, response status code and response headers



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/ultracart_api/api/item_api.rb', line 399

def get_item_with_http_info(merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_item ...'
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_item"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_items(opts = {}) ⇒ ItemsResponse

Retrieve items Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :parent_category_id (Integer) —

    The parent category object id to retrieve items for. Unspecified means all items on the account. 0 &#x3D; root

  • :parent_category_path (String) —

    The parent category path to retrieve items for. Unspecified means all items on the account. / &#x3D; root

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_since (String) —

    Fetch items that have been created/modified since this date/time.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



514
515
516
517
 
# File 'lib/ultracart_api/api/item_api.rb', line 514

def get_items(opts = {})
  data, _status_code, _headers = get_items_with_http_info(opts)
  data
end

#get_items_with_http_info(opts = {}) ⇒ Array<(ItemsResponse, Fixnum, Hash)>

Retrieve items Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :parent_category_id (Integer) —

    The parent category object id to retrieve items for. Unspecified means all items on the account. 0 &#x3D; root

  • :parent_category_path (String) —

    The parent category path to retrieve items for. Unspecified means all items on the account. / &#x3D; root

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 2000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_since (String) —

    Fetch items that have been created/modified since this date/time.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemsResponse, Fixnum, Hash)>) —

    ItemsResponse data, response status code and response headers



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/ultracart_api/api/item_api.rb', line 531

def get_items_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_items ...'
  end
  # resource path
  local_var_path = '/item/items'

  # query parameters
  query_params = {}
  query_params[:'parent_category_id'] = opts[:'parent_category_id'] if !opts[:'parent_category_id'].nil?
  query_params[:'parent_category_path'] = opts[:'parent_category_path'] if !opts[:'parent_category_path'].nil?
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pricing_tiers(opts = {}) ⇒ PricingTiersResponse

Retrieve pricing tiers Retrieves the pricing tiers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

Returns:



580
581
582
583
 
# File 'lib/ultracart_api/api/item_api.rb', line 580

def get_pricing_tiers(opts = {})
  data, _status_code, _headers = get_pricing_tiers_with_http_info(opts)
  data
end

#get_pricing_tiers_with_http_info(opts = {}) ⇒ Array<(PricingTiersResponse, Fixnum, Hash)>

Retrieve pricing tiers Retrieves the pricing tiers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

Returns:

  • (Array<(PricingTiersResponse, Fixnum, Hash)>) —

    PricingTiersResponse data, response status code and response headers



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/ultracart_api/api/item_api.rb', line 590

def get_pricing_tiers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_pricing_tiers ...'
  end
  # resource path
  local_var_path = '/item/pricing_tiers'

  # query parameters
  query_params = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PricingTiersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_pricing_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_review(review_oid, merchant_item_oid, opts = {}) ⇒ ItemReviewResponse

Get a review Retrieve an item review.

Parameters:

  • review_oid —

    The review oid to retrieve.

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:



633
634
635
636
 
# File 'lib/ultracart_api/api/item_api.rb', line 633

def get_review(review_oid, merchant_item_oid, opts = {})
  data, _status_code, _headers = get_review_with_http_info(review_oid, merchant_item_oid, opts)
  data
end

#get_review_with_http_info(review_oid, merchant_item_oid, opts = {}) ⇒ Array<(ItemReviewResponse, Fixnum, Hash)>

Get a review Retrieve an item review.

Parameters:

  • review_oid —

    The review oid to retrieve.

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:

  • (Array<(ItemReviewResponse, Fixnum, Hash)>) —

    ItemReviewResponse data, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/ultracart_api/api/item_api.rb', line 644

def get_review_with_http_info(review_oid, merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_review ...'
  end
  # verify the required parameter 'review_oid' is set
  if @api_client.config.client_side_validation && review_oid.nil?
    fail ArgumentError, "Missing the required parameter 'review_oid' when calling ItemApi.get_review"
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_review"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}/reviews/{review_oid}'.sub('{' + 'review_oid' + '}', review_oid.to_s).sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemReviewResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reviews(merchant_item_oid, opts = {}) ⇒ ItemReviewsResponse

Get reviews for an item Retrieve item reviews.

Parameters:

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:



693
694
695
696
 
# File 'lib/ultracart_api/api/item_api.rb', line 693

def get_reviews(merchant_item_oid, opts = {})
  data, _status_code, _headers = get_reviews_with_http_info(merchant_item_oid, opts)
  data
end

#get_reviews_with_http_info(merchant_item_oid, opts = {}) ⇒ Array<(ItemReviewsResponse, Fixnum, Hash)>

Get reviews for an item Retrieve item reviews.

Parameters:

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:

  • (Array<(ItemReviewsResponse, Fixnum, Hash)>) —

    ItemReviewsResponse data, response status code and response headers



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/ultracart_api/api/item_api.rb', line 703

def get_reviews_with_http_info(merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_reviews ...'
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_reviews"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}/reviews'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemReviewsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_reviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unassociated_digital_items(opts = {}) ⇒ ItemDigitalItemsResponse

Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_since (String) —

    Fetch items that have been created/modified since this date/time.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



753
754
755
756
 
# File 'lib/ultracart_api/api/item_api.rb', line 753

def get_unassociated_digital_items(opts = {})
  data, _status_code, _headers = get_unassociated_digital_items_with_http_info(opts)
  data
end

#get_unassociated_digital_items_with_http_info(opts = {}) ⇒ Array<(ItemDigitalItemsResponse, Fixnum, Hash)>

Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 2000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_since (String) —

    Fetch items that have been created/modified since this date/time.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemDigitalItemsResponse, Fixnum, Hash)>) —

    ItemDigitalItemsResponse data, response status code and response headers



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/ultracart_api/api/item_api.rb', line 768

def get_unassociated_digital_items_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.get_unassociated_digital_items ...'
  end
  # resource path
  local_var_path = '/item/digital_library/unassociated'

  # query parameters
  query_params = {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemDigitalItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#get_unassociated_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_digital_item(digital_item, opts = {}) ⇒ ItemDigitalItemResponse

Create a file within the digital library Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.

Parameters:

  • digital_item —

    Digital item to create

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

    the optional parameters

Returns:



815
816
817
818
 
# File 'lib/ultracart_api/api/item_api.rb', line 815

def insert_digital_item(digital_item, opts = {})
  data, _status_code, _headers = insert_digital_item_with_http_info(digital_item, opts)
  data
end

#insert_digital_item_with_http_info(digital_item, opts = {}) ⇒ Array<(ItemDigitalItemResponse, Fixnum, Hash)>

Create a file within the digital library Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.

Parameters:

  • digital_item —

    Digital item to create

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

    the optional parameters

Returns:

  • (Array<(ItemDigitalItemResponse, Fixnum, Hash)>) —

    ItemDigitalItemResponse data, response status code and response headers



825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/ultracart_api/api/item_api.rb', line 825

def insert_digital_item_with_http_info(digital_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.insert_digital_item ...'
  end
  # verify the required parameter 'digital_item' is set
  if @api_client.config.client_side_validation && digital_item.nil?
    fail ArgumentError, "Missing the required parameter 'digital_item' when calling ItemApi.insert_digital_item"
  end
  # resource path
  local_var_path = '/item/digital_library'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(digital_item)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemDigitalItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#insert_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_item(item, opts = {}) ⇒ ItemResponse

Create an item Create a new item on the UltraCart account.

Parameters:

  • item —

    Item to create

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



872
873
874
875
 
# File 'lib/ultracart_api/api/item_api.rb', line 872

def insert_item(item, opts = {})
  data, _status_code, _headers = insert_item_with_http_info(item, opts)
  data
end

#insert_item_with_http_info(item, opts = {}) ⇒ Array<(ItemResponse, Fixnum, Hash)>

Create an item Create a new item on the UltraCart account.

Parameters:

  • item —

    Item to create

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemResponse, Fixnum, Hash)>) —

    ItemResponse data, response status code and response headers



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/ultracart_api/api/item_api.rb', line 884

def insert_item_with_http_info(item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.insert_item ...'
  end
  # verify the required parameter 'item' is set
  if @api_client.config.client_side_validation && item.nil?
    fail ArgumentError, "Missing the required parameter 'item' when calling ItemApi.insert_item"
  end
  # resource path
  local_var_path = '/item/items'

  # query parameters
  query_params = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#insert_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_review(review, merchant_item_oid, opts = {}) ⇒ ItemReviewResponse

Insert a review Insert a item review.

Parameters:

  • review —

    Review to insert

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:



932
933
934
935
 
# File 'lib/ultracart_api/api/item_api.rb', line 932

def insert_review(review, merchant_item_oid, opts = {})
  data, _status_code, _headers = insert_review_with_http_info(review, merchant_item_oid, opts)
  data
end

#insert_review_with_http_info(review, merchant_item_oid, opts = {}) ⇒ Array<(ItemReviewResponse, Fixnum, Hash)>

Insert a review Insert a item review.

Parameters:

  • review —

    Review to insert

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:

  • (Array<(ItemReviewResponse, Fixnum, Hash)>) —

    ItemReviewResponse data, response status code and response headers



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/ultracart_api/api/item_api.rb', line 943

def insert_review_with_http_info(review, merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.insert_review ...'
  end
  # verify the required parameter 'review' is set
  if @api_client.config.client_side_validation && review.nil?
    fail ArgumentError, "Missing the required parameter 'review' when calling ItemApi.insert_review"
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.insert_review"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}/reviews'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(review)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemReviewResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#insert_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_digital_item(digital_item_oid, digital_item, opts = {}) ⇒ ItemDigitalItemResponse

Updates a file within the digital library Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.

Parameters:

  • digital_item_oid —

    The digital item oid to update.

  • digital_item —

    Digital item to update

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

    the optional parameters

Returns:



993
994
995
996
 
# File 'lib/ultracart_api/api/item_api.rb', line 993

def update_digital_item(digital_item_oid, digital_item, opts = {})
  data, _status_code, _headers = update_digital_item_with_http_info(digital_item_oid, digital_item, opts)
  data
end

#update_digital_item_with_http_info(digital_item_oid, digital_item, opts = {}) ⇒ Array<(ItemDigitalItemResponse, Fixnum, Hash)>

Updates a file within the digital library Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.

Parameters:

  • digital_item_oid —

    The digital item oid to update.

  • digital_item —

    Digital item to update

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

    the optional parameters

Returns:

  • (Array<(ItemDigitalItemResponse, Fixnum, Hash)>) —

    ItemDigitalItemResponse data, response status code and response headers



1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/ultracart_api/api/item_api.rb', line 1004

def update_digital_item_with_http_info(digital_item_oid, digital_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.update_digital_item ...'
  end
  # verify the required parameter 'digital_item_oid' is set
  if @api_client.config.client_side_validation && digital_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'digital_item_oid' when calling ItemApi.update_digital_item"
  end
  # verify the required parameter 'digital_item' is set
  if @api_client.config.client_side_validation && digital_item.nil?
    fail ArgumentError, "Missing the required parameter 'digital_item' when calling ItemApi.update_digital_item"
  end
  # resource path
  local_var_path = '/item/digital_library/{digital_item_oid}'.sub('{' + 'digital_item_oid' + '}', digital_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(digital_item)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemDigitalItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#update_digital_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_item(item, merchant_item_oid, opts = {}) ⇒ ItemResponse

Update an item Update a new item on the UltraCart account.

Parameters:

  • item —

    Item to update

  • merchant_item_oid —

    The item oid to update.

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:



1056
1057
1058
1059
 
# File 'lib/ultracart_api/api/item_api.rb', line 1056

def update_item(item, merchant_item_oid, opts = {})
  data, _status_code, _headers = update_item_with_http_info(item, merchant_item_oid, opts)
  data
end

#update_item_with_http_info(item, merchant_item_oid, opts = {}) ⇒ Array<(ItemResponse, Fixnum, Hash)>

Update an item Update a new item on the UltraCart account.

Parameters:

  • item —

    Item to update

  • merchant_item_oid —

    The item oid to update.

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

Returns:

  • (Array<(ItemResponse, Fixnum, Hash)>) —

    ItemResponse data, response status code and response headers



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'lib/ultracart_api/api/item_api.rb', line 1069

def update_item_with_http_info(item, merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.update_item ...'
  end
  # verify the required parameter 'item' is set
  if @api_client.config.client_side_validation && item.nil?
    fail ArgumentError, "Missing the required parameter 'item' when calling ItemApi.update_item"
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.update_item"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#update_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_items(items_request, opts = {}) ⇒ ItemsResponse

Update multiple items Update multiple item on the UltraCart account.

Parameters:

  • items_request —

    Items to update (synchronous maximum 20 / asynchronous maximum 100)

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

  • :_async (BOOLEAN) —

    True if the operation should be run async. No result returned

Returns:



1123
1124
1125
1126
 
# File 'lib/ultracart_api/api/item_api.rb', line 1123

def update_items(items_request, opts = {})
  data, _status_code, _headers = update_items_with_http_info(items_request, opts)
  data
end

#update_items_with_http_info(items_request, opts = {}) ⇒ Array<(ItemsResponse, Fixnum, Hash)>

Update multiple items Update multiple item on the UltraCart account.

Parameters:

  • items_request —

    Items to update (synchronous maximum 20 / asynchronous maximum 100)

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

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

  • :_placeholders (BOOLEAN) —

    Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.

  • :_async (BOOLEAN) —

    True if the operation should be run async. No result returned

Returns:

  • (Array<(ItemsResponse, Fixnum, Hash)>) —

    ItemsResponse data, response status code and response headers



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'lib/ultracart_api/api/item_api.rb', line 1136

def update_items_with_http_info(items_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.update_items ...'
  end
  # verify the required parameter 'items_request' is set
  if @api_client.config.client_side_validation && items_request.nil?
    fail ArgumentError, "Missing the required parameter 'items_request' when calling ItemApi.update_items"
  end
  # resource path
  local_var_path = '/item/items/batch'

  # query parameters
  query_params = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
  query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
  query_params[:'_async'] = opts[:'_async'] if !opts[:'_async'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(items_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#update_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_review(review, review_oid, merchant_item_oid, opts = {}) ⇒ ItemReviewResponse

Update a review Update an item review.

Parameters:

  • review —

    Review to update

  • review_oid —

    The review oid to update.

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:



1186
1187
1188
1189
 
# File 'lib/ultracart_api/api/item_api.rb', line 1186

def update_review(review, review_oid, merchant_item_oid, opts = {})
  data, _status_code, _headers = update_review_with_http_info(review, review_oid, merchant_item_oid, opts)
  data
end

#update_review_with_http_info(review, review_oid, merchant_item_oid, opts = {}) ⇒ Array<(ItemReviewResponse, Fixnum, Hash)>

Update a review Update an item review.

Parameters:

  • review —

    Review to update

  • review_oid —

    The review oid to update.

  • merchant_item_oid —

    The item oid the review is associated with.

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

    the optional parameters

Returns:

  • (Array<(ItemReviewResponse, Fixnum, Hash)>) —

    ItemReviewResponse data, response status code and response headers



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/ultracart_api/api/item_api.rb', line 1198

def update_review_with_http_info(review, review_oid, merchant_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.update_review ...'
  end
  # verify the required parameter 'review' is set
  if @api_client.config.client_side_validation && review.nil?
    fail ArgumentError, "Missing the required parameter 'review' when calling ItemApi.update_review"
  end
  # verify the required parameter 'review_oid' is set
  if @api_client.config.client_side_validation && review_oid.nil?
    fail ArgumentError, "Missing the required parameter 'review_oid' when calling ItemApi.update_review"
  end
  # verify the required parameter 'merchant_item_oid' is set
  if @api_client.config.client_side_validation && merchant_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.update_review"
  end
  # resource path
  local_var_path = '/item/items/{merchant_item_oid}/reviews/{review_oid}'.sub('{' + 'review_oid' + '}', review_oid.to_s).sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(review)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ItemReviewResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#update_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_temporary_multimedia(file, opts = {}) ⇒ TempMultimediaResponse

Upload an image to the temporary multimedia. Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.

Parameters:

  • file —

    File to upload

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

    the optional parameters

Returns:



1251
1252
1253
1254
 
# File 'lib/ultracart_api/api/item_api.rb', line 1251

def upload_temporary_multimedia(file, opts = {})
  data, _status_code, _headers = upload_temporary_multimedia_with_http_info(file, opts)
  data
end

#upload_temporary_multimedia_with_http_info(file, opts = {}) ⇒ Array<(TempMultimediaResponse, Fixnum, Hash)>

Upload an image to the temporary multimedia. Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.

Parameters:

  • file —

    File to upload

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

    the optional parameters

Returns:

  • (Array<(TempMultimediaResponse, Fixnum, Hash)>) —

    TempMultimediaResponse data, response status code and response headers



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'lib/ultracart_api/api/item_api.rb', line 1261

def upload_temporary_multimedia_with_http_info(file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ItemApi.upload_temporary_multimedia ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling ItemApi.upload_temporary_multimedia"
  end
  # resource path
  local_var_path = '/item/temp_multimedia'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TempMultimediaResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ItemApi#upload_temporary_multimedia\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end