Class: CyberSource::CustomerShippingAddressApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/customer_shipping_address_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ CustomerShippingAddressApi

Returns a new instance of CustomerShippingAddressApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 19

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_customer_shipping_address(customer_id, shipping_address_id, opts = {}) ⇒ nil

Delete a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**
A Customer Shipping Address represents tokenized customer shipping information.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|      |**Deleting a Customers Shipping Address**
Your system can use this API to delete an existing Shipping Address for a Customer.
If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • shipping_address_id —

    The Id of a shipping address.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 30

def delete_customer_shipping_address(customer_id, shipping_address_id, opts = {})
  data, status_code, headers = delete_customer_shipping_address_with_http_info(customer_id, shipping_address_id, opts)
  return data, status_code, headers
end

#delete_customer_shipping_address_with_http_info(customer_id, shipping_address_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**&lt;br&gt;A Customer Shipping Address represents tokenized customer shipping information.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Deleting a Customers Shipping Address**&lt;br&gt;Your system can use this API to delete an existing Shipping Address for a Customer.&lt;br&gt;If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • shipping_address_id —

    The Id of a shipping address.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:

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

    nil, response status code and response headers



42
43
44
45
46
47
48
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 42

def delete_customer_shipping_address_with_http_info(customer_id, shipping_address_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerShippingAddressApi.delete_customer_shipping_address ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerShippingAddressApi.delete_customer_shipping_address"
  end
  if @api_client.config.client_side_validation && customer_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.delete_customer_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && customer_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.delete_customer_shipping_address, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'shipping_address_id' is set
  if @api_client.config.client_side_validation && shipping_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_address_id' when calling CustomerShippingAddressApi.delete_customer_shipping_address"
  end
  if @api_client.config.client_side_validation && shipping_address_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "shipping_address_id" when calling CustomerShippingAddressApi.delete_customer_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && shipping_address_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "shipping_address_id" when calling CustomerShippingAddressApi.delete_customer_shipping_address, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.delete_customer_shipping_address, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.delete_customer_shipping_address, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'shippingAddressId' + '}', shipping_address_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  if 'DELETE' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  auth_names = []
  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
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerShippingAddressApi#delete_customer_shipping_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_customer_shipping_address(customer_id, shipping_address_id, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultShippingAddress

Retrieve a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**
A Customer Shipping Address represents tokenized customer shipping information.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Customer Shipping Address**
Your system can use this API to retrieve an existing Shipping Address for a Customer.
To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • shipping_address_id —

    The Id of a shipping address.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



131
132
133
134
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 131

def get_customer_shipping_address(customer_id, shipping_address_id, opts = {})
  data, status_code, headers = get_customer_shipping_address_with_http_info(customer_id, shipping_address_id, opts)
  return data, status_code, headers
end

#get_customer_shipping_address_with_http_info(customer_id, shipping_address_id, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultShippingAddress, Fixnum, Hash)>

Retrieve a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**&lt;br&gt;A Customer Shipping Address represents tokenized customer shipping information.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Retrieving a Customer Shipping Address**&lt;br&gt;Your system can use this API to retrieve an existing Shipping Address for a Customer.&lt;br&gt;To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

  • shipping_address_id —

    The Id of a shipping address.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 143

def get_customer_shipping_address_with_http_info(customer_id, shipping_address_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerShippingAddressApi.get_customer_shipping_address ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerShippingAddressApi.get_customer_shipping_address"
  end
  if @api_client.config.client_side_validation && customer_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.get_customer_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && customer_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.get_customer_shipping_address, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'shipping_address_id' is set
  if @api_client.config.client_side_validation && shipping_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_address_id' when calling CustomerShippingAddressApi.get_customer_shipping_address"
  end
  if @api_client.config.client_side_validation && shipping_address_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "shipping_address_id" when calling CustomerShippingAddressApi.get_customer_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && shipping_address_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "shipping_address_id" when calling CustomerShippingAddressApi.get_customer_shipping_address, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.get_customer_shipping_address, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.get_customer_shipping_address, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'shippingAddressId' + '}', shipping_address_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  auth_names = []
  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 => 'Tmsv2customersEmbeddedDefaultShippingAddress')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerShippingAddressApi#get_customer_shipping_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_customer_shipping_addresses_list(customer_id, opts = {}) ⇒ ShippingAddressListForCustomer

List Shipping Addresses for a Customer | | | | | — | — | — | |**Customer Shipping Address**
A Customer Shipping Address represents tokenized customer shipping information.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Customer Shipping Addresses**
Your system can use this API to retrieve all existing Shipping Addresses for a Customer.

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :offset (Integer) —

    Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (default to 0)

  • :limit (Integer) —

    The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (default to 20)

Returns:



234
235
236
237
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 234

def get_customer_shipping_addresses_list(customer_id, opts = {})
  data, status_code, headers = get_customer_shipping_addresses_list_with_http_info(customer_id, opts)
  return data, status_code, headers
end

#get_customer_shipping_addresses_list_with_http_info(customer_id, opts = {}) ⇒ Array<(ShippingAddressListForCustomer, Fixnum, Hash)>

List Shipping Addresses for a Customer | | | | | — | — | — | |**Customer Shipping Address**&lt;br&gt;A Customer Shipping Address represents tokenized customer shipping information.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Retrieving all Customer Shipping Addresses**&lt;br&gt;Your system can use this API to retrieve all existing Shipping Addresses for a Customer.

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :offset (Integer) —

    Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.

  • :limit (Integer) —

    The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.

Returns:



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
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 247

def get_customer_shipping_addresses_list_with_http_info(customer_id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerShippingAddressApi.get_customer_shipping_addresses_list ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list"
  end
  if @api_client.config.client_side_validation && customer_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && customer_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, the character length must be great than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CustomerShippingAddressApi.get_customer_shipping_addresses_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/shipping-addresses'.sub('{' + 'customerId' + '}', customer_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  auth_names = []
  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 => 'ShippingAddressListForCustomer')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerShippingAddressApi#get_customer_shipping_addresses_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#patch_customers_shipping_address(customer_id, shipping_address_id, patch_customer_shipping_address_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultShippingAddress

Update a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**
A Customer Shipping Address represents tokenized customer shipping information.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Customers Shipping Address**
Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

  • customer_id —

    The Id of a Customer.

  • shipping_address_id —

    The Id of a shipping address.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :if_match (String) —

    Contains an ETag value from a GET request to make the request conditional.

Returns:



341
342
343
344
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 341

def patch_customers_shipping_address(customer_id, shipping_address_id, patch_customer_shipping_address_request, opts = {})
  data, status_code, headers = patch_customers_shipping_address_with_http_info(customer_id, shipping_address_id, patch_customer_shipping_address_request, opts)
  return data, status_code, headers
end

#patch_customers_shipping_address_with_http_info(customer_id, shipping_address_id, patch_customer_shipping_address_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultShippingAddress, Fixnum, Hash)>

Update a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**&lt;br&gt;A Customer Shipping Address represents tokenized customer shipping information.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Updating a Customers Shipping Address**&lt;br&gt;Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.

Parameters:

  • customer_id —

    The Id of a Customer.

  • shipping_address_id —

    The Id of a shipping address.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

  • :if_match (String) —

    Contains an ETag value from a GET request to make the request conditional.

Returns:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 355

def patch_customers_shipping_address_with_http_info(customer_id, shipping_address_id, patch_customer_shipping_address_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerShippingAddressApi.patch_customers_shipping_address ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerShippingAddressApi.patch_customers_shipping_address"
  end
  if @api_client.config.client_side_validation && customer_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && customer_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'shipping_address_id' is set
  if @api_client.config.client_side_validation && shipping_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_address_id' when calling CustomerShippingAddressApi.patch_customers_shipping_address"
  end
  if @api_client.config.client_side_validation && shipping_address_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "shipping_address_id" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && shipping_address_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "shipping_address_id" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'patch_customer_shipping_address_request' is set
  if @api_client.config.client_side_validation && patch_customer_shipping_address_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_customer_shipping_address_request' when calling CustomerShippingAddressApi.patch_customers_shipping_address"
  end
  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be great than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'if_match'].nil? && opts[:'if_match'].to_s.length > 32
    fail ArgumentError, 'invalid value for "opts[:"if_match"]" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && !opts[:'if_match'].nil? && opts[:'if_match'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"if_match"]" when calling CustomerShippingAddressApi.patch_customers_shipping_address, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/shipping-addresses/{shippingAddressId}'.sub('{' + 'customerId' + '}', customer_id.to_s).sub('{' + 'shippingAddressId' + '}', shipping_address_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  header_params[:'if-match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(patch_customer_shipping_address_request)
  auth_names = []
  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 => 'Tmsv2customersEmbeddedDefaultShippingAddress')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerShippingAddressApi#patch_customers_shipping_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#post_customer_shipping_address(customer_id, post_customer_shipping_address_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultShippingAddress

Create a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**
A Customer Shipping Address represents tokenized customer shipping information.
A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Creating a Customer Shipping Address**
Your system can use this API to create an existing Customers default or non default Shipping Address.
You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



454
455
456
457
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 454

def post_customer_shipping_address(customer_id, post_customer_shipping_address_request, opts = {})
  data, status_code, headers = post_customer_shipping_address_with_http_info(customer_id, post_customer_shipping_address_request, opts)
  return data, status_code, headers
end

#post_customer_shipping_address_with_http_info(customer_id, post_customer_shipping_address_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultShippingAddress, Fixnum, Hash)>

Create a Customer Shipping Address | | | | | — | — | — | |**Customer Shipping Address**&lt;br&gt;A Customer Shipping Address represents tokenized customer shipping information.&lt;br&gt;A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|**Creating a Customer Shipping Address**&lt;br&gt;Your system can use this API to create an existing Customers default or non default Shipping Address.&lt;br&gt;You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).

Parameters:

  • customer_id —

    The Id of a Customer.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/cybersource_rest_client/api/customer_shipping_address_api.rb', line 466

def post_customer_shipping_address_with_http_info(customer_id, post_customer_shipping_address_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: CustomerShippingAddressApi.post_customer_shipping_address ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling CustomerShippingAddressApi.post_customer_shipping_address"
  end
  if @api_client.config.client_side_validation && customer_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.post_customer_shipping_address, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && customer_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "customer_id" when calling CustomerShippingAddressApi.post_customer_shipping_address, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'post_customer_shipping_address_request' is set
  if @api_client.config.client_side_validation && post_customer_shipping_address_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_customer_shipping_address_request' when calling CustomerShippingAddressApi.post_customer_shipping_address"
  end
  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.post_customer_shipping_address, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling CustomerShippingAddressApi.post_customer_shipping_address, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerId}/shipping-addresses'.sub('{' + 'customerId' + '}', customer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(post_customer_shipping_address_request)
  auth_names = []
  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 => 'Tmsv2customersEmbeddedDefaultShippingAddress')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerShippingAddressApi#post_customer_shipping_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end