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(shipment, opts = {}) ⇒ Shipment

Parameters:

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

    the optional parameters

Returns:



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

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

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

Returns Shipment data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    Shipment data, response status code and response headers



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

def create_with_http_info(shipment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.create ..."
  end
  # 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 = "/shipments".sub('{format}','json')

  # 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(shipment_id, opts = {}) ⇒ nil

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/order_cloud/api/shipment_api.rb', line 96

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

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

Parameters:

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

  • (nil) 


154
155
156
157
 
# File 'lib/order_cloud/api/shipment_api.rb', line 154

def delete_item(shipment_id, order_id, line_item_id, opts = {})
  delete_item_with_http_info(shipment_id, order_id, line_item_id, opts)
  return nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • 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<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
203
204
205
206
207
208
209
 
# File 'lib/order_cloud/api/shipment_api.rb', line 166

def delete_item_with_http_info(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 '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 = "/shipments/{shipmentID}/items/{orderID}/{lineItemID}".sub('{format}','json').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)
  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(shipment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • 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



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

def delete_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.delete ..."
  end
  # 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 = "/shipments/{shipmentID}".sub('{format}','json').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(shipment_id, opts = {}) ⇒ Shipment

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/order_cloud/api/shipment_api.rb', line 216

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

#get_item(shipment_id, order_id, line_item_id, opts = {}) ⇒ ShipmentItem

Parameters:

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



275
276
277
278
 
# File 'lib/order_cloud/api/shipment_api.rb', line 275

def get_item(shipment_id, order_id, line_item_id, opts = {})
  data, _status_code, _headers = get_item_with_http_info(shipment_id, order_id, line_item_id, opts)
  return data
end

#get_item_with_http_info(shipment_id, order_id, line_item_id, opts = {}) ⇒ Array<(ShipmentItem, Fixnum, Hash)>

Returns ShipmentItem data, response status code and response headers.

Parameters:

  • 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<(ShipmentItem, Fixnum, Hash)>) —

    ShipmentItem data, response status code and response headers



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
325
326
327
328
329
330
331
 
# File 'lib/order_cloud/api/shipment_api.rb', line 287

def get_item_with_http_info(shipment_id, order_id, line_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.get_item ..."
  end
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentApi.get_item" if shipment_id.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling ShipmentApi.get_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.get_item" if line_item_id.nil?
  # resource path
  local_var_path = "/shipments/{shipmentID}/items/{orderID}/{lineItemID}".sub('{format}','json').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(: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 => 'ShipmentItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#get_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns Shipment data, response status code and response headers.

Parameters:

  • 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



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
258
259
260
261
262
263
264
265
266
 
# File 'lib/order_cloud/api/shipment_api.rb', line 226

def get_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.get ..."
  end
  # 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 = "/shipments/{shipmentID}".sub('{format}','json').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(opts = {}) ⇒ ListShipment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :order_id (String) —

    ID of the order.

  • :search (String) —

    Search of the shipment.

  • :search_on (Array<String>) —

    Search on of the shipment.

  • :sort_by (Array<String>) —

    Sort by of the shipment.

  • :page (Integer) —

    Page of the shipment.

  • :page_size (Integer) —

    Page size of the shipment.

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

    Filters of the shipment.

Returns:



344
345
346
347
 
# File 'lib/order_cloud/api/shipment_api.rb', line 344

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

#list_items(shipment_id, opts = {}) ⇒ ListShipmentItem

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the shipment.

  • :search_on (Array<String>) —

    Search on of the shipment.

  • :sort_by (Array<String>) —

    Sort by of the shipment.

  • :page (Integer) —

    Page of the shipment.

  • :page_size (Integer) —

    Page size of the shipment.

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

    Filters of the shipment.

Returns:



418
419
420
421
 
# File 'lib/order_cloud/api/shipment_api.rb', line 418

def list_items(shipment_id, opts = {})
  data, _status_code, _headers = list_items_with_http_info(shipment_id, opts)
  return data
end

#list_items_with_http_info(shipment_id, opts = {}) ⇒ Array<(ListShipmentItem, Fixnum, Hash)>

Returns ListShipmentItem data, response status code and response headers.

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the shipment.

  • :search_on (Array<String>) —

    Search on of the shipment.

  • :sort_by (Array<String>) —

    Sort by of the shipment.

  • :page (Integer) —

    Page of the shipment.

  • :page_size (Integer) —

    Page size of the shipment.

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

    Filters of the shipment.

Returns:

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

    ListShipmentItem data, response status code and response headers



434
435
436
437
438
439
440
441
442
443
444
445
446
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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 434

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

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) 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 => 'ListShipmentItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShipmentApi#list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns ListShipment data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :order_id (String) —

    ID of the order.

  • :search (String) —

    Search of the shipment.

  • :search_on (Array<String>) —

    Search on of the shipment.

  • :sort_by (Array<String>) —

    Sort by of the shipment.

  • :page (Integer) —

    Page of the shipment.

  • :page_size (Integer) —

    Page size of the shipment.

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

    Filters of the shipment.

Returns:

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

    ListShipment data, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/order_cloud/api/shipment_api.rb', line 360

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.list ..."
  end
  # resource path
  local_var_path = "/shipments".sub('{format}','json')

  # 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'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) 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(shipment_id, shipment, opts = {}) ⇒ Shipment

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



488
489
490
491
 
# File 'lib/order_cloud/api/shipment_api.rb', line 488

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

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

Returns Shipment data, response status code and response headers.

Parameters:

  • 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



499
500
501
502
503
504
505
506
507
508
509
510
511
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
 
# File 'lib/order_cloud/api/shipment_api.rb', line 499

def patch_with_http_info(shipment_id, shipment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.patch ..."
  end
  # 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 = "/shipments/{shipmentID}".sub('{format}','json').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(shipment_id, item, opts = {}) ⇒ ShipmentItem

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



549
550
551
552
 
# File 'lib/order_cloud/api/shipment_api.rb', line 549

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

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

Returns ShipmentItem data, response status code and response headers.

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    ShipmentItem data, response status code and response headers



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/order_cloud/api/shipment_api.rb', line 560

def save_item_with_http_info(shipment_id, item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.save_item ..."
  end
  # 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 = "/shipments/{shipmentID}/items".sub('{format}','json').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 => 'ShipmentItem')
  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(shipment_id, shipment, opts = {}) ⇒ Shipment

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



610
611
612
613
 
# File 'lib/order_cloud/api/shipment_api.rb', line 610

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

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

Returns Shipment data, response status code and response headers.

Parameters:

  • 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



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/order_cloud/api/shipment_api.rb', line 621

def update_with_http_info(shipment_id, shipment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShipmentApi.update ..."
  end
  # 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 = "/shipments/{shipmentID}".sub('{format}','json').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