Class: OrderCloud::ShipmentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/shipment_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShipmentApi

Returns a new instance of ShipmentApi.



30
31
32
 
# File 'lib/order_cloud/api/shipment_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/shipment_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(buyer_id, shipment, opts = {}) ⇒ Shipment

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:



40
41
42
43
 
# File 'lib/order_cloud/api/shipment_api.rb', line 40

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

#create_with_http_info(buyer_id, shipment, opts = {}) ⇒ Array<(Shipment, Fixnum, Hash)>

Returns Shipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/order_cloud/api/shipment_api.rb', line 51

def create_with_http_info(buyer_id, shipment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.create ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.create" if buyer_id.nil?
  # verify the required parameter 'shipment' is set
  fail ArgumentError, "Missing the required parameter 'shipment' when calling ShipmentApi.create" if shipment.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(shipment)
  auth_names = ['oauth2']
  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 => 'Shipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(buyer_id, shipment_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

  • (nil) 


101
102
103
104
 
# File 'lib/order_cloud/api/shipment_api.rb', line 101

def delete(buyer_id, shipment_id, opts = {})
  delete_with_http_info(buyer_id, shipment_id, opts)
  return nil
end

#delete_item(buyer_id, shipment_id, order_id, line_item_id, opts = {}) ⇒ Shipment

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/order_cloud/api/shipment_api.rb', line 163

def delete_item(buyer_id, shipment_id, order_id, line_item_id, opts = {})
  data, _status_code, _headers = delete_item_with_http_info(buyer_id, shipment_id, order_id, line_item_id, opts)
  return data
end

#delete_item_with_http_info(buyer_id, shipment_id, order_id, line_item_id, opts = {}) ⇒ Array<(Shipment, Fixnum, Hash)>

Returns Shipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 176

def delete_item_with_http_info(buyer_id, shipment_id, order_id, line_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.delete_item ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.delete_item" if buyer_id.nil?
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.delete_item" if shipment_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling ShipmentApi.delete_item" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling ShipmentApi.delete_item" if line_item_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments/{shipmentID}/items/{orderID}/{lineItemID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'shipmentID' + '}', shipment_id.to_s).sub('{' + 'orderID' + '}', order_id.to_s).sub('{' + 'lineItemID' + '}', line_item_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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,
    :return_type => 'Shipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#delete_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_with_http_info(buyer_id, shipment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 112

def delete_with_http_info(buyer_id, shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.delete ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.delete" if buyer_id.nil?
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.delete" if shipment_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments/{shipmentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'shipmentID' + '}', shipment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ShipmentApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(buyer_id, shipment_id, opts = {}) ⇒ Shipment

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



230
231
232
233
 
# File 'lib/order_cloud/api/shipment_api.rb', line 230

def get(buyer_id, shipment_id, opts = {})
  data, _status_code, _headers = get_with_http_info(buyer_id, shipment_id, opts)
  return data
end

#get_with_http_info(buyer_id, shipment_id, opts = {}) ⇒ Array<(Shipment, Fixnum, Hash)>

Returns Shipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 241

def get_with_http_info(buyer_id, shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.get ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.get" if buyer_id.nil?
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.get" if shipment_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments/{shipmentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'shipmentID' + '}', shipment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Shipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(buyer_id, opts = {}) ⇒ ListShipment

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :order_id (String) —

    ID of the order.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:



297
298
299
300
 
# File 'lib/order_cloud/api/shipment_api.rb', line 297

def list(buyer_id, opts = {})
  data, _status_code, _headers = list_with_http_info(buyer_id, opts)
  return data
end

#list_with_http_info(buyer_id, opts = {}) ⇒ Array<(ListShipment, Fixnum, Hash)>

Returns ListShipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :order_id (String) —

    ID of the order.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:

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

    ListShipment data, response status code and response headers



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
358
359
360
361
 
# File 'lib/order_cloud/api/shipment_api.rb', line 314

def list_with_http_info(buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.list ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.list" if buyer_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'orderID'] = opts[:'order_id'] if !opts[:'order_id'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'ListShipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch(buyer_id, shipment_id, shipment, opts = {}) ⇒ Shipment

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



370
371
372
373
 
# File 'lib/order_cloud/api/shipment_api.rb', line 370

def patch(buyer_id, shipment_id, shipment, opts = {})
  data, _status_code, _headers = patch_with_http_info(buyer_id, shipment_id, shipment, opts)
  return data
end

#patch_with_http_info(buyer_id, shipment_id, shipment, opts = {}) ⇒ Array<(Shipment, Fixnum, Hash)>

Returns Shipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 382

def patch_with_http_info(buyer_id, shipment_id, shipment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.patch ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.patch" if buyer_id.nil?
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.patch" if shipment_id.nil?
  # verify the required parameter 'shipment' is set
  fail ArgumentError, "Missing the required parameter 'shipment' when calling ShipmentApi.patch" if shipment.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments/{shipmentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'shipmentID' + '}', shipment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(shipment)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Shipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_item(buyer_id, shipment_id, item, opts = {}) ⇒ Shipment

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



435
436
437
438
 
# File 'lib/order_cloud/api/shipment_api.rb', line 435

def save_item(buyer_id, shipment_id, item, opts = {})
  data, _status_code, _headers = save_item_with_http_info(buyer_id, shipment_id, item, opts)
  return data
end

#save_item_with_http_info(buyer_id, shipment_id, item, opts = {}) ⇒ Array<(Shipment, Fixnum, Hash)>

Returns Shipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 447

def save_item_with_http_info(buyer_id, shipment_id, item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.save_item ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.save_item" if buyer_id.nil?
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.save_item" if shipment_id.nil?
  # verify the required parameter 'item' is set
  fail ArgumentError, "Missing the required parameter 'item' when calling ShipmentApi.save_item" if item.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments/{shipmentID}/items".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'shipmentID' + '}', shipment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item)
  auth_names = ['oauth2']
  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 => 'Shipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#save_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(buyer_id, shipment_id, shipment, opts = {}) ⇒ Shipment

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



500
501
502
503
 
# File 'lib/order_cloud/api/shipment_api.rb', line 500

def update(buyer_id, shipment_id, shipment, opts = {})
  data, _status_code, _headers = update_with_http_info(buyer_id, shipment_id, shipment, opts)
  return data
end

#update_with_http_info(buyer_id, shipment_id, shipment, opts = {}) ⇒ Array<(Shipment, Fixnum, Hash)>

Returns Shipment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 512

def update_with_http_info(buyer_id, shipment_id, shipment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.update ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling ShipmentApi.update" if buyer_id.nil?
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.update" if shipment_id.nil?
  # verify the required parameter 'shipment' is set
  fail ArgumentError, "Missing the required parameter 'shipment' when calling ShipmentApi.update" if shipment.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/shipments/{shipmentID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'shipmentID' + '}', shipment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(shipment)
  auth_names = ['oauth2']
  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 => 'Shipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end