Class: OrderCloud::LineItemApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LineItemApi

Returns a new instance of LineItemApi.



30
31
32
 
# File 'lib/order_cloud/api/line_item_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/line_item_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(direction, order_id, line_item, opts = {}) ⇒ LineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

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

    the optional parameters

Returns:



41
42
43
44
 
# File 'lib/order_cloud/api/line_item_api.rb', line 41

def create(direction, order_id, line_item, opts = {})
  data, _status_code, _headers = create_with_http_info(direction, order_id, line_item, opts)
  return data
end

#create_with_http_info(direction, order_id, line_item, opts = {}) ⇒ Array<(LineItem, Fixnum, Hash)>

Returns LineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

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

    the optional parameters

Returns:

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

    LineItem data, response status code and response headers



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
94
95
96
97
 
# File 'lib/order_cloud/api/line_item_api.rb', line 53

def create_with_http_info(direction, order_id, line_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.create ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.create" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.create" if order_id.nil?
  # verify the required parameter 'line_item' is set
  fail ArgumentError, "Missing the required parameter 'line_item' when calling LineItemApi.create" if line_item.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems".sub('{format}','json').sub('{' + 'direction' + '}', direction.to_s).sub('{' + 'orderID' + '}', order_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(line_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 => 'LineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(direction, order_id, line_item_id, opts = {}) ⇒ nil

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

  • (nil) 


106
107
108
109
 
# File 'lib/order_cloud/api/line_item_api.rb', line 106

def delete(direction, order_id, line_item_id, opts = {})
  delete_with_http_info(direction, order_id, line_item_id, opts)
  return nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • 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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/order_cloud/api/line_item_api.rb', line 118

def delete_with_http_info(direction, order_id, line_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.delete ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.delete" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.delete" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling LineItemApi.delete" if line_item_id.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems/{lineItemID}".sub('{format}','json').sub('{' + 'direction' + '}', direction.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: LineItemApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(direction, order_id, line_item_id, opts = {}) ⇒ LineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/order_cloud/api/line_item_api.rb', line 170

def get(direction, order_id, line_item_id, opts = {})
  data, _status_code, _headers = get_with_http_info(direction, order_id, line_item_id, opts)
  return data
end

#get_with_http_info(direction, order_id, line_item_id, opts = {}) ⇒ Array<(LineItem, Fixnum, Hash)>

Returns LineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

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

    LineItem data, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/order_cloud/api/line_item_api.rb', line 182

def get_with_http_info(direction, order_id, line_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.get ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.get" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.get" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling LineItemApi.get" if line_item_id.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems/{lineItemID}".sub('{format}','json').sub('{' + 'direction' + '}', direction.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 => 'LineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(direction, order_id, opts = {}) ⇒ ListLineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the line item.

  • :search_on (Array<String>) —

    Search on of the line item.

  • :sort_by (Array<String>) —

    Sort by of the line item.

  • :page (Integer) —

    Page of the line item.

  • :page_size (Integer) —

    Page size of the line item.

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

    Filters of the line item.

Returns:



240
241
242
243
 
# File 'lib/order_cloud/api/line_item_api.rb', line 240

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

#list_with_http_info(direction, order_id, opts = {}) ⇒ Array<(ListLineItem, Fixnum, Hash)>

Returns ListLineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the line item.

  • :search_on (Array<String>) —

    Search on of the line item.

  • :sort_by (Array<String>) —

    Sort by of the line item.

  • :page (Integer) —

    Page of the line item.

  • :page_size (Integer) —

    Page size of the line item.

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

    Filters of the line item.

Returns:

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

    ListLineItem data, response status code and response headers



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/order_cloud/api/line_item_api.rb', line 257

def list_with_http_info(direction, order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.list ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.list" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.list" if order_id.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems".sub('{format}','json').sub('{' + 'direction' + '}', direction.to_s).sub('{' + 'orderID' + '}', order_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 => 'ListLineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch(direction, order_id, line_item_id, partial_line_item, opts = {}) ⇒ LineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:



315
316
317
318
 
# File 'lib/order_cloud/api/line_item_api.rb', line 315

def patch(direction, order_id, line_item_id, partial_line_item, opts = {})
  data, _status_code, _headers = patch_with_http_info(direction, order_id, line_item_id, partial_line_item, opts)
  return data
end

#patch_shipping_address(direction, order_id, line_item_id, partial_address, opts = {}) ⇒ LineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:



384
385
386
387
 
# File 'lib/order_cloud/api/line_item_api.rb', line 384

def patch_shipping_address(direction, order_id, line_item_id, partial_address, opts = {})
  data, _status_code, _headers = patch_shipping_address_with_http_info(direction, order_id, line_item_id, partial_address, opts)
  return data
end

#patch_shipping_address_with_http_info(direction, order_id, line_item_id, partial_address, opts = {}) ⇒ Array<(LineItem, Fixnum, Hash)>

Returns LineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

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

    LineItem data, response status code and response headers



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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/order_cloud/api/line_item_api.rb', line 397

def patch_shipping_address_with_http_info(direction, order_id, line_item_id, partial_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.patch_shipping_address ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.patch_shipping_address" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.patch_shipping_address" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling LineItemApi.patch_shipping_address" if line_item_id.nil?
  # verify the required parameter 'partial_address' is set
  fail ArgumentError, "Missing the required parameter 'partial_address' when calling LineItemApi.patch_shipping_address" if partial_address.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto".sub('{format}','json').sub('{' + 'direction' + '}', direction.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 = @api_client.object_to_http_body(partial_address)
  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 => 'LineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#patch_shipping_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_with_http_info(direction, order_id, line_item_id, partial_line_item, opts = {}) ⇒ Array<(LineItem, Fixnum, Hash)>

Returns LineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

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

    LineItem data, response status code and response headers



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
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/order_cloud/api/line_item_api.rb', line 328

def patch_with_http_info(direction, order_id, line_item_id, partial_line_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.patch ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.patch" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.patch" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling LineItemApi.patch" if line_item_id.nil?
  # verify the required parameter 'partial_line_item' is set
  fail ArgumentError, "Missing the required parameter 'partial_line_item' when calling LineItemApi.patch" if partial_line_item.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems/{lineItemID}".sub('{format}','json').sub('{' + 'direction' + '}', direction.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 = @api_client.object_to_http_body(partial_line_item)
  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 => 'LineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_shipping_address(direction, order_id, line_item_id, address, opts = {}) ⇒ LineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:



453
454
455
456
 
# File 'lib/order_cloud/api/line_item_api.rb', line 453

def set_shipping_address(direction, order_id, line_item_id, address, opts = {})
  data, _status_code, _headers = set_shipping_address_with_http_info(direction, order_id, line_item_id, address, opts)
  return data
end

#set_shipping_address_with_http_info(direction, order_id, line_item_id, address, opts = {}) ⇒ Array<(LineItem, Fixnum, Hash)>

Returns LineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

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

    LineItem data, response status code and response headers



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

def set_shipping_address_with_http_info(direction, order_id, line_item_id, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.set_shipping_address ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.set_shipping_address" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.set_shipping_address" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling LineItemApi.set_shipping_address" if line_item_id.nil?
  # verify the required parameter 'address' is set
  fail ArgumentError, "Missing the required parameter 'address' when calling LineItemApi.set_shipping_address" if address.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto".sub('{format}','json').sub('{' + 'direction' + '}', direction.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 = @api_client.object_to_http_body(address)
  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 => 'LineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#set_shipping_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(direction, order_id, line_item_id, line_item, opts = {}) ⇒ LineItem

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:



522
523
524
525
 
# File 'lib/order_cloud/api/line_item_api.rb', line 522

def update(direction, order_id, line_item_id, line_item, opts = {})
  data, _status_code, _headers = update_with_http_info(direction, order_id, line_item_id, line_item, opts)
  return data
end

#update_with_http_info(direction, order_id, line_item_id, line_item, opts = {}) ⇒ Array<(LineItem, Fixnum, Hash)>

Returns LineItem data, response status code and response headers.

Parameters:

  • direction —

    Direction of the line item. Possible values: Incoming, Outgoing.

  • order_id —

    ID of the order.

  • line_item_id —

    ID of the line item.

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

    the optional parameters

Returns:

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

    LineItem data, response status code and response headers



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
575
576
577
578
579
580
581
 
# File 'lib/order_cloud/api/line_item_api.rb', line 535

def update_with_http_info(direction, order_id, line_item_id, line_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LineItemApi.update ..."
  end
  # verify the required parameter 'direction' is set
  fail ArgumentError, "Missing the required parameter 'direction' when calling LineItemApi.update" if direction.nil?
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling LineItemApi.update" if order_id.nil?
  # verify the required parameter 'line_item_id' is set
  fail ArgumentError, "Missing the required parameter 'line_item_id' when calling LineItemApi.update" if line_item_id.nil?
  # verify the required parameter 'line_item' is set
  fail ArgumentError, "Missing the required parameter 'line_item' when calling LineItemApi.update" if line_item.nil?
  # resource path
  local_var_path = "/orders/{direction}/{orderID}/lineitems/{lineItemID}".sub('{format}','json').sub('{' + 'direction' + '}', direction.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 = @api_client.object_to_http_body(line_item)
  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 => 'LineItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LineItemApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end