Class: OrderCloud::MeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MeApi

Returns a new instance of MeApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_address(address, opts = {}) ⇒ BuyerAddress

Parameters:

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

    the optional parameters

Returns:



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

def create_address(address, opts = {})
  data, _status_code, _headers = create_address_with_http_info(address, opts)
  return data
end

#create_address_with_http_info(address, opts = {}) ⇒ Array<(BuyerAddress, Fixnum, Hash)>

Returns BuyerAddress data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    BuyerAddress 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/me_api.rb', line 49

def create_address_with_http_info(address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.create_address ..."
  end
  # verify the required parameter 'address' is set
  fail ArgumentError, "Missing the required parameter 'address' when calling MeApi.create_address" if address.nil?
  # resource path
  local_var_path = "/me/addresses".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(address)
  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 => 'BuyerAddress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#create_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credit_card(credit_card, opts = {}) ⇒ BuyerCreditCard

Parameters:

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

    the optional parameters

Returns:



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

def create_credit_card(credit_card, opts = {})
  data, _status_code, _headers = create_credit_card_with_http_info(credit_card, opts)
  return data
end

#create_credit_card_with_http_info(credit_card, opts = {}) ⇒ Array<(BuyerCreditCard, Fixnum, Hash)>

Returns BuyerCreditCard data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    BuyerCreditCard data, 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
146
 
# File 'lib/order_cloud/api/me_api.rb', line 106

def create_credit_card_with_http_info(credit_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.create_credit_card ..."
  end
  # verify the required parameter 'credit_card' is set
  fail ArgumentError, "Missing the required parameter 'credit_card' when calling MeApi.create_credit_card" if credit_card.nil?
  # resource path
  local_var_path = "/me/creditcards".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(credit_card)
  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 => 'BuyerCreditCard')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#create_credit_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_address(address_id, opts = {}) ⇒ nil

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

  • (nil) 


153
154
155
156
 
# File 'lib/order_cloud/api/me_api.rb', line 153

def delete_address(address_id, opts = {})
  delete_address_with_http_info(address_id, opts)
  return nil
end

#delete_address_with_http_info(address_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/order_cloud/api/me_api.rb', line 163

def delete_address_with_http_info(address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.delete_address ..."
  end
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling MeApi.delete_address" if address_id.nil?
  # resource path
  local_var_path = "/me/addresses/{addressID}".sub('{format}','json').sub('{' + 'addressID' + '}', address_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: MeApi#delete_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_credit_card(creditcard_id, opts = {}) ⇒ nil

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:

  • (nil) 


209
210
211
212
 
# File 'lib/order_cloud/api/me_api.rb', line 209

def delete_credit_card(creditcard_id, opts = {})
  delete_credit_card_with_http_info(creditcard_id, opts)
  return nil
end

#delete_credit_card_with_http_info(creditcard_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
258
 
# File 'lib/order_cloud/api/me_api.rb', line 219

def delete_credit_card_with_http_info(creditcard_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.delete_credit_card ..."
  end
  # verify the required parameter 'creditcard_id' is set
  fail ArgumentError, "Missing the required parameter 'creditcard_id' when calling MeApi.delete_credit_card" if creditcard_id.nil?
  # resource path
  local_var_path = "/me/creditcards/{creditcardID}".sub('{format}','json').sub('{' + 'creditcardID' + '}', creditcard_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: MeApi#delete_credit_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(opts = {}) ⇒ MeUser

Parameters:

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/order_cloud/api/me_api.rb', line 264

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

#get_address(address_id, opts = {}) ⇒ BuyerAddress

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/order_cloud/api/me_api.rb', line 318

def get_address(address_id, opts = {})
  data, _status_code, _headers = get_address_with_http_info(address_id, opts)
  return data
end

#get_address_with_http_info(address_id, opts = {}) ⇒ Array<(BuyerAddress, Fixnum, Hash)>

Returns BuyerAddress data, response status code and response headers.

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    BuyerAddress 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
 
# File 'lib/order_cloud/api/me_api.rb', line 328

def get_address_with_http_info(address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_address ..."
  end
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling MeApi.get_address" if address_id.nil?
  # resource path
  local_var_path = "/me/addresses/{addressID}".sub('{format}','json').sub('{' + 'addressID' + '}', address_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 => 'BuyerAddress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_catalog(catalog_id, opts = {}) ⇒ Catalog

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:



375
376
377
378
 
# File 'lib/order_cloud/api/me_api.rb', line 375

def get_catalog(catalog_id, opts = {})
  data, _status_code, _headers = get_catalog_with_http_info(catalog_id, opts)
  return data
end

#get_catalog_with_http_info(catalog_id, opts = {}) ⇒ Array<(Catalog, Fixnum, Hash)>

Returns Catalog data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    Catalog data, response status code and response headers



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

def get_catalog_with_http_info(catalog_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_catalog ..."
  end
  # verify the required parameter 'catalog_id' is set
  fail ArgumentError, "Missing the required parameter 'catalog_id' when calling MeApi.get_catalog" if catalog_id.nil?
  # resource path
  local_var_path = "/me/catalogs/{catalogID}".sub('{format}','json').sub('{' + 'catalogID' + '}', catalog_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 => 'Catalog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_catalog\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_card(creditcard_id, opts = {}) ⇒ BuyerCreditCard

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:



432
433
434
435
 
# File 'lib/order_cloud/api/me_api.rb', line 432

def get_credit_card(creditcard_id, opts = {})
  data, _status_code, _headers = get_credit_card_with_http_info(creditcard_id, opts)
  return data
end

#get_credit_card_with_http_info(creditcard_id, opts = {}) ⇒ Array<(BuyerCreditCard, Fixnum, Hash)>

Returns BuyerCreditCard data, response status code and response headers.

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:

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

    BuyerCreditCard data, response status code and response headers



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
481
482
 
# File 'lib/order_cloud/api/me_api.rb', line 442

def get_credit_card_with_http_info(creditcard_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_credit_card ..."
  end
  # verify the required parameter 'creditcard_id' is set
  fail ArgumentError, "Missing the required parameter 'creditcard_id' when calling MeApi.get_credit_card" if creditcard_id.nil?
  # resource path
  local_var_path = "/me/creditcards/{creditcardID}".sub('{format}','json').sub('{' + 'creditcardID' + '}', creditcard_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 => 'BuyerCreditCard')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_credit_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_product(product_id, opts = {}) ⇒ BuyerProduct

Parameters:

  • product_id —

    ID of the product.

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

    the optional parameters

Returns:



489
490
491
492
 
# File 'lib/order_cloud/api/me_api.rb', line 489

def get_product(product_id, opts = {})
  data, _status_code, _headers = get_product_with_http_info(product_id, opts)
  return data
end

#get_product_with_http_info(product_id, opts = {}) ⇒ Array<(BuyerProduct, Fixnum, Hash)>

Returns BuyerProduct data, response status code and response headers.

Parameters:

  • product_id —

    ID of the product.

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

    the optional parameters

Returns:

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

    BuyerProduct 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
 
# File 'lib/order_cloud/api/me_api.rb', line 499

def get_product_with_http_info(product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_product ..."
  end
  # verify the required parameter 'product_id' is set
  fail ArgumentError, "Missing the required parameter 'product_id' when calling MeApi.get_product" if product_id.nil?
  # resource path
  local_var_path = "/me/products/{productID}".sub('{format}','json').sub('{' + 'productID' + '}', product_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 => 'BuyerProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_promotion(promotion_id, opts = {}) ⇒ Promotion

Parameters:

  • promotion_id —

    ID of the promotion.

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

    the optional parameters

Returns:



546
547
548
549
 
# File 'lib/order_cloud/api/me_api.rb', line 546

def get_promotion(promotion_id, opts = {})
  data, _status_code, _headers = get_promotion_with_http_info(promotion_id, opts)
  return data
end

#get_promotion_with_http_info(promotion_id, opts = {}) ⇒ Array<(Promotion, Fixnum, Hash)>

Returns Promotion data, response status code and response headers.

Parameters:

  • promotion_id —

    ID of the promotion.

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

    the optional parameters

Returns:

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

    Promotion data, response status code and response headers



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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/order_cloud/api/me_api.rb', line 556

def get_promotion_with_http_info(promotion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_promotion ..."
  end
  # verify the required parameter 'promotion_id' is set
  fail ArgumentError, "Missing the required parameter 'promotion_id' when calling MeApi.get_promotion" if promotion_id.nil?
  # resource path
  local_var_path = "/me/promotions/{promotionID}".sub('{format}','json').sub('{' + 'promotionID' + '}', promotion_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 => 'Promotion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_promotion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shipment(shipment_id, opts = {}) ⇒ BuyerShipment

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:



603
604
605
606
 
# File 'lib/order_cloud/api/me_api.rb', line 603

def get_shipment(shipment_id, opts = {})
  data, _status_code, _headers = get_shipment_with_http_info(shipment_id, opts)
  return data
end

#get_shipment_with_http_info(shipment_id, opts = {}) ⇒ Array<(BuyerShipment, Fixnum, Hash)>

Returns BuyerShipment data, response status code and response headers.

Parameters:

  • shipment_id —

    ID of the shipment.

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

    the optional parameters

Returns:

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

    BuyerShipment data, response status code and response headers



613
614
615
616
617
618
619
620
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
 
# File 'lib/order_cloud/api/me_api.rb', line 613

def get_shipment_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_shipment ..."
  end
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling MeApi.get_shipment" if shipment_id.nil?
  # resource path
  local_var_path = "/me/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 => 'BuyerShipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_spec(product_id, spec_id, opts = {}) ⇒ BuyerSpec

Parameters:

  • product_id —

    ID of the product.

  • spec_id —

    ID of the spec.

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

Returns:



662
663
664
665
 
# File 'lib/order_cloud/api/me_api.rb', line 662

def get_spec(product_id, spec_id, opts = {})
  data, _status_code, _headers = get_spec_with_http_info(product_id, spec_id, opts)
  return data
end

#get_spec_with_http_info(product_id, spec_id, opts = {}) ⇒ Array<(BuyerSpec, Fixnum, Hash)>

Returns BuyerSpec data, response status code and response headers.

Parameters:

  • product_id —

    ID of the product.

  • spec_id —

    ID of the spec.

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

Returns:

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

    BuyerSpec data, response status code and response headers



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/order_cloud/api/me_api.rb', line 674

def get_spec_with_http_info(product_id, spec_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_spec ..."
  end
  # verify the required parameter 'product_id' is set
  fail ArgumentError, "Missing the required parameter 'product_id' when calling MeApi.get_spec" if product_id.nil?
  # verify the required parameter 'spec_id' is set
  fail ArgumentError, "Missing the required parameter 'spec_id' when calling MeApi.get_spec" if spec_id.nil?
  # resource path
  local_var_path = "/me/products/{productID}/specs/{specID}".sub('{format}','json').sub('{' + 'productID' + '}', product_id.to_s).sub('{' + 'specID' + '}', spec_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'catalogID'] = opts[:'catalog_id'] if !opts[:'catalog_id'].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 => 'BuyerSpec')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_spec\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_spending_account(spending_account_id, opts = {}) ⇒ SpendingAccount

Parameters:

  • spending_account_id —

    ID of the spending account.

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

    the optional parameters

Returns:



724
725
726
727
 
# File 'lib/order_cloud/api/me_api.rb', line 724

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

#get_spending_account_with_http_info(spending_account_id, opts = {}) ⇒ Array<(SpendingAccount, Fixnum, Hash)>

Returns SpendingAccount data, response status code and response headers.

Parameters:

  • spending_account_id —

    ID of the spending account.

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

    the optional parameters

Returns:

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

    SpendingAccount data, response status code and response headers



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/order_cloud/api/me_api.rb', line 734

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_spending_account ..."
  end
  # verify the required parameter 'spending_account_id' is set
  fail ArgumentError, "Missing the required parameter 'spending_account_id' when calling MeApi.get_spending_account" if .nil?
  # resource path
  local_var_path = "/me/spendingaccounts/{spendingAccountID}".sub('{format}','json').sub('{' + 'spendingAccountID' + '}', .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 => 'SpendingAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_spending_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns MeUser data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    MeUser data, response status code and response headers



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
306
307
308
309
310
311
 
# File 'lib/order_cloud/api/me_api.rb', line 273

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get ..."
  end
  # resource path
  local_var_path = "/me".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 = 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 => 'MeUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_addresses(opts = {}) ⇒ ListBuyerAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the address.

  • :search_on (Array<String>) —

    Search on of the address.

  • :sort_by (Array<String>) —

    Sort by of the address.

  • :page (Integer) —

    Page of the address.

  • :page_size (Integer) —

    Page size of the address.

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

    Filters of the address.

Returns:



786
787
788
789
 
# File 'lib/order_cloud/api/me_api.rb', line 786

def list_addresses(opts = {})
  data, _status_code, _headers = list_addresses_with_http_info(opts)
  return data
end

#list_addresses_with_http_info(opts = {}) ⇒ Array<(ListBuyerAddress, Fixnum, Hash)>

Returns ListBuyerAddress data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the address.

  • :search_on (Array<String>) —

    Search on of the address.

  • :sort_by (Array<String>) —

    Sort by of the address.

  • :page (Integer) —

    Page of the address.

  • :page_size (Integer) —

    Page size of the address.

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

    Filters of the address.

Returns:

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

    ListBuyerAddress data, response status code and response headers



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'lib/order_cloud/api/me_api.rb', line 801

def list_addresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_addresses ..."
  end
  # resource path
  local_var_path = "/me/addresses".sub('{format}','json')

  # 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 => 'ListBuyerAddress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_approvable_orders(opts = {}) ⇒ ListOrder

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (String) —

    Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :to (String) —

    Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :search (String) —

    Search of the order.

  • :search_on (Array<String>) —

    Search on of the order.

  • :sort_by (Array<String>) —

    Sort by of the order.

  • :page (Integer) —

    Page of the order.

  • :page_size (Integer) —

    Page size of the order.

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

    Filters of the order.

Returns:



859
860
861
862
 
# File 'lib/order_cloud/api/me_api.rb', line 859

def list_approvable_orders(opts = {})
  data, _status_code, _headers = list_approvable_orders_with_http_info(opts)
  return data
end

#list_approvable_orders_with_http_info(opts = {}) ⇒ Array<(ListOrder, Fixnum, Hash)>

Returns ListOrder data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (String) —

    Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :to (String) —

    Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :search (String) —

    Search of the order.

  • :search_on (Array<String>) —

    Search on of the order.

  • :sort_by (Array<String>) —

    Sort by of the order.

  • :page (Integer) —

    Page of the order.

  • :page_size (Integer) —

    Page size of the order.

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

    Filters of the order.

Returns:

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

    ListOrder data, response status code and response headers



876
877
878
879
880
881
882
883
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
 
# File 'lib/order_cloud/api/me_api.rb', line 876

def list_approvable_orders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_approvable_orders ..."
  end
  # resource path
  local_var_path = "/me/orders/approvable".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].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 => 'ListOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_approvable_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_catalogs(opts = {}) ⇒ ListCatalog

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the catalog.

  • :search_on (Array<String>) —

    Search on of the catalog.

  • :sort_by (Array<String>) —

    Sort by of the catalog.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

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

    Filters of the catalog.

Returns:



934
935
936
937
 
# File 'lib/order_cloud/api/me_api.rb', line 934

def list_catalogs(opts = {})
  data, _status_code, _headers = list_catalogs_with_http_info(opts)
  return data
end

#list_catalogs_with_http_info(opts = {}) ⇒ Array<(ListCatalog, Fixnum, Hash)>

Returns ListCatalog data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the catalog.

  • :search_on (Array<String>) —

    Search on of the catalog.

  • :sort_by (Array<String>) —

    Sort by of the catalog.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

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

    Filters of the catalog.

Returns:

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

    ListCatalog data, response status code and response headers



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
987
988
989
990
991
992
993
 
# File 'lib/order_cloud/api/me_api.rb', line 949

def list_catalogs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_catalogs ..."
  end
  # resource path
  local_var_path = "/me/catalogs".sub('{format}','json')

  # 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 => 'ListCatalog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_catalogs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_categories(opts = {}) ⇒ ListCategory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :catalog_id (String) —

    ID of the catalog.

  • :search (String) —

    Search of the category.

  • :search_on (Array<String>) —

    Search on of the category.

  • :sort_by (Array<String>) —

    Sort by of the category.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

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

    Filters of the category.

Returns:



1007
1008
1009
1010
 
# File 'lib/order_cloud/api/me_api.rb', line 1007

def list_categories(opts = {})
  data, _status_code, _headers = list_categories_with_http_info(opts)
  return data
end

#list_categories_with_http_info(opts = {}) ⇒ Array<(ListCategory, Fixnum, Hash)>

Returns ListCategory data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :catalog_id (String) —

    ID of the catalog.

  • :search (String) —

    Search of the category.

  • :search_on (Array<String>) —

    Search on of the category.

  • :sort_by (Array<String>) —

    Sort by of the category.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

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

    Filters of the category.

Returns:

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

    ListCategory data, response status code and response headers



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/order_cloud/api/me_api.rb', line 1024

def list_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_categories ..."
  end
  # resource path
  local_var_path = "/me/categories".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
  query_params[:'catalogID'] = opts[:'catalog_id'] if !opts[:'catalog_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 => 'ListCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_centers(opts = {}) ⇒ ListCostCenter

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the cost center.

  • :search_on (Array<String>) —

    Search on of the cost center.

  • :sort_by (Array<String>) —

    Sort by of the cost center.

  • :page (Integer) —

    Page of the cost center.

  • :page_size (Integer) —

    Page size of the cost center.

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

    Filters of the cost center.

Returns:



1082
1083
1084
1085
 
# File 'lib/order_cloud/api/me_api.rb', line 1082

def list_cost_centers(opts = {})
  data, _status_code, _headers = list_cost_centers_with_http_info(opts)
  return data
end

#list_cost_centers_with_http_info(opts = {}) ⇒ Array<(ListCostCenter, Fixnum, Hash)>

Returns ListCostCenter data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the cost center.

  • :search_on (Array<String>) —

    Search on of the cost center.

  • :sort_by (Array<String>) —

    Sort by of the cost center.

  • :page (Integer) —

    Page of the cost center.

  • :page_size (Integer) —

    Page size of the cost center.

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

    Filters of the cost center.

Returns:

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

    ListCostCenter data, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/order_cloud/api/me_api.rb', line 1097

def list_cost_centers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_cost_centers ..."
  end
  # resource path
  local_var_path = "/me/costcenters".sub('{format}','json')

  # 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 => 'ListCostCenter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_cost_centers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_credit_cards(opts = {}) ⇒ ListBuyerCreditCard

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the credit card.

  • :search_on (Array<String>) —

    Search on of the credit card.

  • :sort_by (Array<String>) —

    Sort by of the credit card.

  • :page (Integer) —

    Page of the credit card.

  • :page_size (Integer) —

    Page size of the credit card.

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

    Filters of the credit card.

Returns:



1153
1154
1155
1156
 
# File 'lib/order_cloud/api/me_api.rb', line 1153

def list_credit_cards(opts = {})
  data, _status_code, _headers = list_credit_cards_with_http_info(opts)
  return data
end

#list_credit_cards_with_http_info(opts = {}) ⇒ Array<(ListBuyerCreditCard, Fixnum, Hash)>

Returns ListBuyerCreditCard data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the credit card.

  • :search_on (Array<String>) —

    Search on of the credit card.

  • :sort_by (Array<String>) —

    Sort by of the credit card.

  • :page (Integer) —

    Page of the credit card.

  • :page_size (Integer) —

    Page size of the credit card.

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

    Filters of the credit card.

Returns:

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

    ListBuyerCreditCard data, response status code and response headers



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/order_cloud/api/me_api.rb', line 1168

def list_credit_cards_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_credit_cards ..."
  end
  # resource path
  local_var_path = "/me/creditcards".sub('{format}','json')

  # 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 => 'ListBuyerCreditCard')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_credit_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_orders(opts = {}) ⇒ ListOrder

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (String) —

    Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :to (String) —

    Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :search (String) —

    Search of the order.

  • :search_on (Array<String>) —

    Search on of the order.

  • :sort_by (Array<String>) —

    Sort by of the order.

  • :page (Integer) —

    Page of the order.

  • :page_size (Integer) —

    Page size of the order.

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

    Filters of the order.

Returns:



1226
1227
1228
1229
 
# File 'lib/order_cloud/api/me_api.rb', line 1226

def list_orders(opts = {})
  data, _status_code, _headers = list_orders_with_http_info(opts)
  return data
end

#list_orders_with_http_info(opts = {}) ⇒ Array<(ListOrder, Fixnum, Hash)>

Returns ListOrder data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (String) —

    Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :to (String) —

    Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).

  • :search (String) —

    Search of the order.

  • :search_on (Array<String>) —

    Search on of the order.

  • :sort_by (Array<String>) —

    Sort by of the order.

  • :page (Integer) —

    Page of the order.

  • :page_size (Integer) —

    Page size of the order.

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

    Filters of the order.

Returns:

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

    ListOrder data, response status code and response headers



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
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
 
# File 'lib/order_cloud/api/me_api.rb', line 1243

def list_orders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_orders ..."
  end
  # resource path
  local_var_path = "/me/orders".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].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 => 'ListOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_products(opts = {}) ⇒ ListBuyerProduct

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :category_id (String) —

    ID of the category.

  • :depth (String) —

    Depth of the product.

  • :search (String) —

    Search of the product.

  • :search_on (Array<String>) —

    Search on of the product.

  • :sort_by (Array<String>) —

    Sort by of the product.

  • :page (Integer) —

    Page of the product.

  • :page_size (Integer) —

    Page size of the product.

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

    Filters of the product.

Returns:



1304
1305
1306
1307
 
# File 'lib/order_cloud/api/me_api.rb', line 1304

def list_products(opts = {})
  data, _status_code, _headers = list_products_with_http_info(opts)
  return data
end

#list_products_with_http_info(opts = {}) ⇒ Array<(ListBuyerProduct, Fixnum, Hash)>

Returns ListBuyerProduct data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :category_id (String) —

    ID of the category.

  • :depth (String) —

    Depth of the product.

  • :search (String) —

    Search of the product.

  • :search_on (Array<String>) —

    Search on of the product.

  • :sort_by (Array<String>) —

    Sort by of the product.

  • :page (Integer) —

    Page of the product.

  • :page_size (Integer) —

    Page size of the product.

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

    Filters of the product.

Returns:

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

    ListBuyerProduct data, response status code and response headers



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/order_cloud/api/me_api.rb', line 1322

def list_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_products ..."
  end
  # resource path
  local_var_path = "/me/products".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'catalogID'] = opts[:'catalog_id'] if !opts[:'catalog_id'].nil?
  query_params[:'categoryID'] = opts[:'category_id'] if !opts[:'category_id'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].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 => 'ListBuyerProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_promotions(opts = {}) ⇒ ListPromotion

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the promotion.

  • :search_on (Array<String>) —

    Search on of the promotion.

  • :sort_by (Array<String>) —

    Sort by of the promotion.

  • :page (Integer) —

    Page of the promotion.

  • :page_size (Integer) —

    Page size of the promotion.

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

    Filters of the promotion.

Returns:



1381
1382
1383
1384
 
# File 'lib/order_cloud/api/me_api.rb', line 1381

def list_promotions(opts = {})
  data, _status_code, _headers = list_promotions_with_http_info(opts)
  return data
end

#list_promotions_with_http_info(opts = {}) ⇒ Array<(ListPromotion, Fixnum, Hash)>

Returns ListPromotion data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the promotion.

  • :search_on (Array<String>) —

    Search on of the promotion.

  • :sort_by (Array<String>) —

    Sort by of the promotion.

  • :page (Integer) —

    Page of the promotion.

  • :page_size (Integer) —

    Page size of the promotion.

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

    Filters of the promotion.

Returns:

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

    ListPromotion data, response status code and response headers



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/order_cloud/api/me_api.rb', line 1396

def list_promotions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_promotions ..."
  end
  # resource path
  local_var_path = "/me/promotions".sub('{format}','json')

  # 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 => 'ListPromotion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_promotions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • shipment_id —

    ID of the shipment.

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



1454
1455
1456
1457
 
# File 'lib/order_cloud/api/me_api.rb', line 1454

def list_shipment_items(shipment_id, opts = {})
  data, _status_code, _headers = list_shipment_items_with_http_info(shipment_id, opts)
  return data
end

#list_shipment_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):

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

    ListShipmentItem data, response status code and response headers



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/order_cloud/api/me_api.rb', line 1471

def list_shipment_items_with_http_info(shipment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_shipment_items ..."
  end
  # verify the required parameter 'shipment_id' is set
  fail ArgumentError, "Missing the required parameter 'shipment_id' when calling MeApi.list_shipment_items" if shipment_id.nil?
  # resource path
  local_var_path = "/me/shipments/{shipmentID}/items".sub('{format}','json').sub('{' + 'shipmentID' + '}', shipment_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'] = @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: MeApi#list_shipment_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_shipments(opts = {}) ⇒ ListBuyerShipment

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:



1531
1532
1533
1534
 
# File 'lib/order_cloud/api/me_api.rb', line 1531

def list_shipments(opts = {})
  data, _status_code, _headers = list_shipments_with_http_info(opts)
  return data
end

#list_shipments_with_http_info(opts = {}) ⇒ Array<(ListBuyerShipment, Fixnum, Hash)>

Returns ListBuyerShipment 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<(ListBuyerShipment, Fixnum, Hash)>) —

    ListBuyerShipment data, response status code and response headers



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/order_cloud/api/me_api.rb', line 1547

def list_shipments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_shipments ..."
  end
  # resource path
  local_var_path = "/me/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 => 'ListBuyerShipment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_shipments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_specs(product_id, opts = {}) ⇒ ListBuyerSpec

Parameters:

  • product_id —

    ID of the product.

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :search (String) —

    Search of the product.

  • :search_on (Array<String>) —

    Search on of the product.

  • :sort_by (Array<String>) —

    Sort by of the product.

  • :page (Integer) —

    Page of the product.

  • :page_size (Integer) —

    Page size of the product.

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

    Filters of the product.

Returns:



1606
1607
1608
1609
 
# File 'lib/order_cloud/api/me_api.rb', line 1606

def list_specs(product_id, opts = {})
  data, _status_code, _headers = list_specs_with_http_info(product_id, opts)
  return data
end

#list_specs_with_http_info(product_id, opts = {}) ⇒ Array<(ListBuyerSpec, Fixnum, Hash)>

Returns ListBuyerSpec data, response status code and response headers.

Parameters:

  • product_id —

    ID of the product.

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :search (String) —

    Search of the product.

  • :search_on (Array<String>) —

    Search on of the product.

  • :sort_by (Array<String>) —

    Sort by of the product.

  • :page (Integer) —

    Page of the product.

  • :page_size (Integer) —

    Page size of the product.

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

    Filters of the product.

Returns:

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

    ListBuyerSpec data, response status code and response headers



1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/order_cloud/api/me_api.rb', line 1623

def list_specs_with_http_info(product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_specs ..."
  end
  # verify the required parameter 'product_id' is set
  fail ArgumentError, "Missing the required parameter 'product_id' when calling MeApi.list_specs" if product_id.nil?
  # resource path
  local_var_path = "/me/products/{productID}/specs".sub('{format}','json').sub('{' + 'productID' + '}', product_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'catalogID'] = opts[:'catalog_id'] if !opts[:'catalog_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 => 'ListBuyerSpec')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_specs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_spending_accounts(opts = {}) ⇒ ListSpendingAccount

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the spending account.

  • :search_on (Array<String>) —

    Search on of the spending account.

  • :sort_by (Array<String>) —

    Sort by of the spending account.

  • :page (Integer) —

    Page of the spending account.

  • :page_size (Integer) —

    Page size of the spending account.

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

    Filters of the spending account.

Returns:



1682
1683
1684
1685
 
# File 'lib/order_cloud/api/me_api.rb', line 1682

def list_spending_accounts(opts = {})
  data, _status_code, _headers = list_spending_accounts_with_http_info(opts)
  return data
end

#list_spending_accounts_with_http_info(opts = {}) ⇒ Array<(ListSpendingAccount, Fixnum, Hash)>

Returns ListSpendingAccount data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the spending account.

  • :search_on (Array<String>) —

    Search on of the spending account.

  • :sort_by (Array<String>) —

    Sort by of the spending account.

  • :page (Integer) —

    Page of the spending account.

  • :page_size (Integer) —

    Page size of the spending account.

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

    Filters of the spending account.

Returns:

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

    ListSpendingAccount data, response status code and response headers



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/order_cloud/api/me_api.rb', line 1697

def list_spending_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_spending_accounts ..."
  end
  # resource path
  local_var_path = "/me/spendingAccounts".sub('{format}','json')

  # 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 => 'ListSpendingAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_spending_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_groups(opts = {}) ⇒ ListUserGroup

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the user group.

  • :search_on (Array<String>) —

    Search on of the user group.

  • :sort_by (Array<String>) —

    Sort by of the user group.

  • :page (Integer) —

    Page of the user group.

  • :page_size (Integer) —

    Page size of the user group.

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

    Filters of the user group.

Returns:



1753
1754
1755
1756
 
# File 'lib/order_cloud/api/me_api.rb', line 1753

def list_user_groups(opts = {})
  data, _status_code, _headers = list_user_groups_with_http_info(opts)
  return data
end

#list_user_groups_with_http_info(opts = {}) ⇒ Array<(ListUserGroup, Fixnum, Hash)>

Returns ListUserGroup data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the user group.

  • :search_on (Array<String>) —

    Search on of the user group.

  • :sort_by (Array<String>) —

    Sort by of the user group.

  • :page (Integer) —

    Page of the user group.

  • :page_size (Integer) —

    Page size of the user group.

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

    Filters of the user group.

Returns:

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

    ListUserGroup data, response status code and response headers



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
 
# File 'lib/order_cloud/api/me_api.rb', line 1768

def list_user_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_user_groups ..."
  end
  # resource path
  local_var_path = "/me/usergroups".sub('{format}','json')

  # 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 => 'ListUserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_user_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch(user, opts = {}) ⇒ MeUser

Parameters:

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

    the optional parameters

Returns:



1819
1820
1821
1822
 
# File 'lib/order_cloud/api/me_api.rb', line 1819

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

#patch_address(address_id, address, opts = {}) ⇒ nil

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

  • (nil) 


1877
1878
1879
1880
 
# File 'lib/order_cloud/api/me_api.rb', line 1877

def patch_address(address_id, address, opts = {})
  patch_address_with_http_info(address_id, address, opts)
  return nil
end

#patch_address_with_http_info(address_id, address, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/order_cloud/api/me_api.rb', line 1888

def patch_address_with_http_info(address_id, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.patch_address ..."
  end
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling MeApi.patch_address" if address_id.nil?
  # verify the required parameter 'address' is set
  fail ArgumentError, "Missing the required parameter 'address' when calling MeApi.patch_address" if address.nil?
  # resource path
  local_var_path = "/me/addresses/{addressID}".sub('{format}','json').sub('{' + 'addressID' + '}', address_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(:PATCH, 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: MeApi#patch_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_credit_card(creditcard_id, credit_card, opts = {}) ⇒ nil

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:

  • (nil) 


1937
1938
1939
1940
 
# File 'lib/order_cloud/api/me_api.rb', line 1937

def patch_credit_card(creditcard_id, credit_card, opts = {})
  patch_credit_card_with_http_info(creditcard_id, credit_card, opts)
  return nil
end

#patch_credit_card_with_http_info(creditcard_id, credit_card, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
 
# File 'lib/order_cloud/api/me_api.rb', line 1948

def patch_credit_card_with_http_info(creditcard_id, credit_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.patch_credit_card ..."
  end
  # verify the required parameter 'creditcard_id' is set
  fail ArgumentError, "Missing the required parameter 'creditcard_id' when calling MeApi.patch_credit_card" if creditcard_id.nil?
  # verify the required parameter 'credit_card' is set
  fail ArgumentError, "Missing the required parameter 'credit_card' when calling MeApi.patch_credit_card" if credit_card.nil?
  # resource path
  local_var_path = "/me/creditcards/{creditcardID}".sub('{format}','json').sub('{' + 'creditcardID' + '}', creditcard_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(credit_card)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#patch_credit_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_with_http_info(user, opts = {}) ⇒ Array<(MeUser, Fixnum, Hash)>

Returns MeUser data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    MeUser data, response status code and response headers



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/order_cloud/api/me_api.rb', line 1829

def patch_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.patch ..."
  end
  # verify the required parameter 'user' is set
  fail ArgumentError, "Missing the required parameter 'user' when calling MeApi.patch" if user.nil?
  # resource path
  local_var_path = "/me".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(user)
  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 => 'MeUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#register(anon_user_token, user, opts = {}) ⇒ Object

Parameters:

  • anon_user_token —

    Anon user token of the me.

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

    the optional parameters

Returns:

  • (Object) 


1997
1998
1999
2000
 
# File 'lib/order_cloud/api/me_api.rb', line 1997

def register(anon_user_token, user, opts = {})
  data, _status_code, _headers = register_with_http_info(anon_user_token, user, opts)
  return data
end

#register_with_http_info(anon_user_token, user, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Returns Object data, response status code and response headers.

Parameters:

  • anon_user_token —

    Anon user token of the me.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
 
# File 'lib/order_cloud/api/me_api.rb', line 2008

def register_with_http_info(anon_user_token, user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.register ..."
  end
  # verify the required parameter 'anon_user_token' is set
  fail ArgumentError, "Missing the required parameter 'anon_user_token' when calling MeApi.register" if anon_user_token.nil?
  # verify the required parameter 'user' is set
  fail ArgumentError, "Missing the required parameter 'user' when calling MeApi.register" if user.nil?
  # resource path
  local_var_path = "/me/register".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'anonUserToken'] = anon_user_token

  # 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(user)
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#register\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_password_by_token(reset, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


2058
2059
2060
2061
 
# File 'lib/order_cloud/api/me_api.rb', line 2058

def reset_password_by_token(reset, opts = {})
  reset_password_by_token_with_http_info(reset, opts)
  return nil
end

#reset_password_by_token_with_http_info(reset, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
 
# File 'lib/order_cloud/api/me_api.rb', line 2068

def reset_password_by_token_with_http_info(reset, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.reset_password_by_token ..."
  end
  # verify the required parameter 'reset' is set
  fail ArgumentError, "Missing the required parameter 'reset' when calling MeApi.reset_password_by_token" if reset.nil?
  # resource path
  local_var_path = "/me/password".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(reset)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#reset_password_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transfer_anon_user_order(anon_user_token, opts = {}) ⇒ nil

Parameters:

  • anon_user_token —

    Anon user token of the me.

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

    the optional parameters

Returns:

  • (nil) 


2114
2115
2116
2117
 
# File 'lib/order_cloud/api/me_api.rb', line 2114

def transfer_anon_user_order(anon_user_token, opts = {})
  transfer_anon_user_order_with_http_info(anon_user_token, opts)
  return nil
end

#transfer_anon_user_order_with_http_info(anon_user_token, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • anon_user_token —

    Anon user token of the me.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
 
# File 'lib/order_cloud/api/me_api.rb', line 2124

def transfer_anon_user_order_with_http_info(anon_user_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.transfer_anon_user_order ..."
  end
  # verify the required parameter 'anon_user_token' is set
  fail ArgumentError, "Missing the required parameter 'anon_user_token' when calling MeApi.transfer_anon_user_order" if anon_user_token.nil?
  # resource path
  local_var_path = "/me/orders".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'anonUserToken'] = anon_user_token

  # 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(:PUT, 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: MeApi#transfer_anon_user_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(user, opts = {}) ⇒ MeUser

Parameters:

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

    the optional parameters

Returns:



2171
2172
2173
2174
 
# File 'lib/order_cloud/api/me_api.rb', line 2171

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

#update_address(address_id, address, opts = {}) ⇒ BuyerAddress

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:



2229
2230
2231
2232
 
# File 'lib/order_cloud/api/me_api.rb', line 2229

def update_address(address_id, address, opts = {})
  data, _status_code, _headers = update_address_with_http_info(address_id, address, opts)
  return data
end

#update_address_with_http_info(address_id, address, opts = {}) ⇒ Array<(BuyerAddress, Fixnum, Hash)>

Returns BuyerAddress data, response status code and response headers.

Parameters:

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    BuyerAddress data, response status code and response headers



2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
 
# File 'lib/order_cloud/api/me_api.rb', line 2240

def update_address_with_http_info(address_id, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.update_address ..."
  end
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling MeApi.update_address" if address_id.nil?
  # verify the required parameter 'address' is set
  fail ArgumentError, "Missing the required parameter 'address' when calling MeApi.update_address" if address.nil?
  # resource path
  local_var_path = "/me/addresses/{addressID}".sub('{format}','json').sub('{' + 'addressID' + '}', address_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 => 'BuyerAddress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#update_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_credit_card(creditcard_id, credit_card, opts = {}) ⇒ BuyerCreditCard

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:



2290
2291
2292
2293
 
# File 'lib/order_cloud/api/me_api.rb', line 2290

def update_credit_card(creditcard_id, credit_card, opts = {})
  data, _status_code, _headers = update_credit_card_with_http_info(creditcard_id, credit_card, opts)
  return data
end

#update_credit_card_with_http_info(creditcard_id, credit_card, opts = {}) ⇒ Array<(BuyerCreditCard, Fixnum, Hash)>

Returns BuyerCreditCard data, response status code and response headers.

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:

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

    BuyerCreditCard data, response status code and response headers



2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
 
# File 'lib/order_cloud/api/me_api.rb', line 2301

def update_credit_card_with_http_info(creditcard_id, credit_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.update_credit_card ..."
  end
  # verify the required parameter 'creditcard_id' is set
  fail ArgumentError, "Missing the required parameter 'creditcard_id' when calling MeApi.update_credit_card" if creditcard_id.nil?
  # verify the required parameter 'credit_card' is set
  fail ArgumentError, "Missing the required parameter 'credit_card' when calling MeApi.update_credit_card" if credit_card.nil?
  # resource path
  local_var_path = "/me/creditcards/{creditcardID}".sub('{format}','json').sub('{' + 'creditcardID' + '}', creditcard_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(credit_card)
  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 => 'BuyerCreditCard')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#update_credit_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_with_http_info(user, opts = {}) ⇒ Array<(MeUser, Fixnum, Hash)>

Returns MeUser data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    MeUser data, response status code and response headers



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
 
# File 'lib/order_cloud/api/me_api.rb', line 2181

def update_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.update ..."
  end
  # verify the required parameter 'user' is set
  fail ArgumentError, "Missing the required parameter 'user' when calling MeApi.update" if user.nil?
  # resource path
  local_var_path = "/me".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(user)
  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 => 'MeUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end