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 = {}) ⇒ User

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_credit_card(creditcard_id, opts = {}) ⇒ BuyerCreditCard

Parameters:

  • creditcard_id —

    ID of the creditcard.

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

    the optional parameters

Returns:



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

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



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_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_order(order_id, opts = {}) ⇒ Order

Parameters:

  • order_id —

    ID of the order.

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

    the optional parameters

Returns:



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

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

#get_order_with_http_info(order_id, opts = {}) ⇒ Array<(Order, Fixnum, Hash)>

Returns Order data, response status code and response headers.

Parameters:

  • order_id —

    ID of the order.

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

    the optional parameters

Returns:

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

    Order 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_order_with_http_info(order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.get_order ..."
  end
  # verify the required parameter 'order_id' is set
  fail ArgumentError, "Missing the required parameter 'order_id' when calling MeApi.get_order" if order_id.nil?
  # resource path
  local_var_path = "/me/orders/{orderID}".sub('{format}','json').sub('{' + 'orderID' + '}', order_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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 => 'Order')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#get_order\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_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

Returns:



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

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

Returns:

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

    BuyerSpec data, response status code and response headers



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
654
655
656
657
 
# File 'lib/order_cloud/api/me_api.rb', line 615

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 = {}

  # 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_with_http_info(opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Returns User data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    User 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 => 'User')
  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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



669
670
671
672
 
# File 'lib/order_cloud/api/me_api.rb', line 669

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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListBuyerAddress data, response status code and response headers



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
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/order_cloud/api/me_api.rb', line 684

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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_categories(opts = {}) ⇒ ListCategory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



741
742
743
744
 
# File 'lib/order_cloud/api/me_api.rb', line 741

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.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListCategory data, response status code and response headers



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/order_cloud/api/me_api.rb', line 757

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[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



814
815
816
817
 
# File 'lib/order_cloud/api/me_api.rb', line 814

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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListCostCenter data, response status code and response headers



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/order_cloud/api/me_api.rb', line 829

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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



885
886
887
888
 
# File 'lib/order_cloud/api/me_api.rb', line 885

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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListBuyerCreditCard data, response status code and response headers



900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/order_cloud/api/me_api.rb', line 900

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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_incoming_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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



958
959
960
961
 
# File 'lib/order_cloud/api/me_api.rb', line 958

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

#list_incoming_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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListOrder data, response status code and response headers



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/order_cloud/api/me_api.rb', line 975

def list_incoming_orders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_incoming_orders ..."
  end
  # resource path
  local_var_path = "/me/orders/incoming".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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#list_outgoing_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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



1035
1036
1037
1038
 
# File 'lib/order_cloud/api/me_api.rb', line 1035

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

#list_outgoing_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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListOrder data, response status code and response headers



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/order_cloud/api/me_api.rb', line 1052

def list_outgoing_orders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MeApi.list_outgoing_orders ..."
  end
  # resource path
  local_var_path = "/me/orders/outgoing".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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MeApi#list_outgoing_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):

  • :category_id (String) —

    ID of the category.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



1111
1112
1113
1114
 
# File 'lib/order_cloud/api/me_api.rb', line 1111

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

  • :category_id (String) —

    ID of the category.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListBuyerProduct data, response status code and response headers



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/order_cloud/api/me_api.rb', line 1127

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[:'categoryID'] = opts[:'category_id'] if !opts[:'category_id'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



1184
1185
1186
1187
 
# File 'lib/order_cloud/api/me_api.rb', line 1184

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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListPromotion data, response status code and response headers



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

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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_specs(product_id, opts = {}) ⇒ ListBuyerSpec

Parameters:

  • product_id —

    ID of the product.

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



1256
1257
1258
1259
 
# File 'lib/order_cloud/api/me_api.rb', line 1256

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

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListBuyerSpec data, response status code and response headers



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'lib/order_cloud/api/me_api.rb', line 1272

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[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_user_groups(opts = {}) ⇒ ListUserGroup

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:



1330
1331
1332
1333
 
# File 'lib/order_cloud/api/me_api.rb', line 1330

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) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

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

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

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

Returns:

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

    ListUserGroup data, response status code and response headers



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
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/order_cloud/api/me_api.rb', line 1345

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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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 = {}) ⇒ User

Parameters:

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

    the optional parameters

Returns:



1396
1397
1398
1399
 
# File 'lib/order_cloud/api/me_api.rb', line 1396

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) 


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

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



1465
1466
1467
1468
1469
1470
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
 
# File 'lib/order_cloud/api/me_api.rb', line 1465

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) 


1514
1515
1516
1517
 
# File 'lib/order_cloud/api/me_api.rb', line 1514

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



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/order_cloud/api/me_api.rb', line 1525

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<(User, Fixnum, Hash)>

Returns User data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



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
1441
1442
1443
1444
1445
1446
 
# File 'lib/order_cloud/api/me_api.rb', line 1406

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 => 'User')
  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

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

Parameters:

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

    the optional parameters

Returns:



1573
1574
1575
1576
 
# File 'lib/order_cloud/api/me_api.rb', line 1573

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:



1631
1632
1633
1634
 
# File 'lib/order_cloud/api/me_api.rb', line 1631

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



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
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
 
# File 'lib/order_cloud/api/me_api.rb', line 1642

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:



1692
1693
1694
1695
 
# File 'lib/order_cloud/api/me_api.rb', line 1692

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



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
1742
1743
1744
1745
 
# File 'lib/order_cloud/api/me_api.rb', line 1703

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<(User, Fixnum, Hash)>

Returns User data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
 
# File 'lib/order_cloud/api/me_api.rb', line 1583

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 => 'User')
  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