Class: OrderCloud::AddressApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressApi

Returns a new instance of AddressApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(buyer_id, address, opts = {}) ⇒ Address

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:



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

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

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

Returns Address data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    Address data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

  • (nil) 


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

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

#delete_assignment(buyer_id, address_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

  • (nil) 


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

def delete_assignment(buyer_id, address_id, opts = {})
  delete_assignment_with_http_info(buyer_id, address_id, opts)
  return nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

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

    nil, response status code and response headers



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/order_cloud/api/address_api.rb', line 176

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

  # query parameters
  query_params = {}
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_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(: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: AddressApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/order_cloud/api/address_api.rb', line 112

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

#get(buyer_id, address_id, opts = {}) ⇒ Address

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/order_cloud/api/address_api.rb', line 227

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

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

Returns Address data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    Address data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/order_cloud/api/address_api.rb', line 238

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

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

Parameters:

  • buyer_id —

    ID of the buyer.

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



293
294
295
296
 
# File 'lib/order_cloud/api/address_api.rb', line 293

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

#list_assignments(buyer_id, opts = {}) ⇒ ListAddressAssignment

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :address_id (String) —

    ID of the address.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the address.

  • :is_shipping (BOOLEAN) —

    Is shipping of the address.

  • :is_billing (BOOLEAN) —

    Is billing of the address.

  • :page (Integer) —

    Page of the address.

  • :page_size (Integer) —

    Page size of the address.

Returns:



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

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

#list_assignments_with_http_info(buyer_id, opts = {}) ⇒ Array<(ListAddressAssignment, Fixnum, Hash)>

Returns ListAddressAssignment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :address_id (String) —

    ID of the address.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the address.

  • :is_shipping (BOOLEAN) —

    Is shipping of the address.

  • :is_billing (BOOLEAN) —

    Is billing of the address.

  • :page (Integer) —

    Page of the address.

  • :page_size (Integer) —

    Page size of the address.

Returns:

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

    ListAddressAssignment data, response status code and response headers



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/order_cloud/api/address_api.rb', line 388

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

  # query parameters
  query_params = {}
  query_params[:'addressID'] = opts[:'address_id'] if !opts[:'address_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'isShipping'] = opts[:'is_shipping'] if !opts[:'is_shipping'].nil?
  query_params[:'isBilling'] = opts[:'is_billing'] if !opts[:'is_billing'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 => 'ListAddressAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns ListAddress data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    ListAddress data, response status code and response headers



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/order_cloud/api/address_api.rb', line 309

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

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch(buyer_id, address_id, address, opts = {}) ⇒ Address

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:



445
446
447
448
 
# File 'lib/order_cloud/api/address_api.rb', line 445

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

#patch_with_http_info(buyer_id, address_id, address, opts = {}) ⇒ Array<(Address, Fixnum, Hash)>

Returns Address data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    Address data, response status code and response headers



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/order_cloud/api/address_api.rb', line 457

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

#save_assignment(buyer_id, assignment, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

  • (nil) 


509
510
511
512
 
# File 'lib/order_cloud/api/address_api.rb', line 509

def save_assignment(buyer_id, assignment, opts = {})
  save_assignment_with_http_info(buyer_id, assignment, opts)
  return nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/order_cloud/api/address_api.rb', line 520

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(assignment)
  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: AddressApi#save_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(buyer_id, address_id, address, opts = {}) ⇒ Address

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:



570
571
572
573
 
# File 'lib/order_cloud/api/address_api.rb', line 570

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

#update_with_http_info(buyer_id, address_id, address, opts = {}) ⇒ Array<(Address, Fixnum, Hash)>

Returns Address data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • address_id —

    ID of the address.

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

    the optional parameters

Returns:

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

    Address data, response status code and response headers



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/order_cloud/api/address_api.rb', line 582

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