Class: CyberSource::CustomerPaymentInstrumentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CustomerPaymentInstrumentApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_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_payment_instrument_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_customer_payment_instrument(customer_token_id, payment_instrument_token_id, opts = {}) ⇒ nil

Delete a Customer Payment Instrument

Parameters:

  • customer_token_id —

    The TokenId of a customer.

  • payment_instrument_token_id —

    The TokenId of a payment instrument.

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


29
30
31
32
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 29

def delete_customer_payment_instrument(customer_token_id, payment_instrument_token_id, opts = {})
  data, status_code, headers = delete_customer_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, opts)
  return data, status_code, headers
end

#delete_customer_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Customer Payment Instrument

Parameters:

  • customer_token_id —

    The TokenId of a customer.

  • payment_instrument_token_id —

    The TokenId of a payment instrument.

  • 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



40
41
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
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 40

def delete_customer_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, opts = {})

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

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

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

  if @api_client.config.client_side_validation && payment_instrument_token_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "payment_instrument_token_id" when calling CustomerPaymentInstrumentApi.delete_customer_payment_instrument, 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 CustomerPaymentInstrumentApi.delete_customer_payment_instrument, 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 CustomerPaymentInstrumentApi.delete_customer_payment_instrument, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerTokenId}/payment-instruments/{paymentInstrumentTokenId}'.sub('{' + 'customerTokenId' + '}', customer_token_id.to_s).sub('{' + 'paymentInstrumentTokenId' + '}', payment_instrument_token_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 = nil
  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: CustomerPaymentInstrumentApi#delete_customer_payment_instrument\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_payment_instrument(customer_token_id, payment_instrument_token_id, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrument

Retrieve a Customer Payment Instrument

Parameters:

  • customer_token_id —

    The TokenId of a customer.

  • payment_instrument_token_id —

    The TokenId of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The id of a profile containing user specific TMS configuration.

Returns:



124
125
126
127
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 124

def get_customer_payment_instrument(customer_token_id, payment_instrument_token_id, opts = {})
  data, status_code, headers = get_customer_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, opts)
  return data, status_code, headers
end

#get_customer_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrument, Fixnum, Hash)>

Retrieve a Customer Payment Instrument

Parameters:

  • customer_token_id —

    The TokenId of a customer.

  • payment_instrument_token_id —

    The TokenId of a payment instrument.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The id of a profile containing user specific TMS configuration.

Returns:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 135

def get_customer_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, opts = {})

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

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

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

  if @api_client.config.client_side_validation && payment_instrument_token_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "payment_instrument_token_id" when calling CustomerPaymentInstrumentApi.get_customer_payment_instrument, 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 CustomerPaymentInstrumentApi.get_customer_payment_instrument, 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 CustomerPaymentInstrumentApi.get_customer_payment_instrument, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerTokenId}/payment-instruments/{paymentInstrumentTokenId}'.sub('{' + 'customerTokenId' + '}', customer_token_id.to_s).sub('{' + 'paymentInstrumentTokenId' + '}', payment_instrument_token_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 = nil
  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 => 'Tmsv2customersEmbeddedDefaultPaymentInstrument')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#get_customer_payment_instrument\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_payment_instruments_list(customer_token_id, opts = {}) ⇒ PaymentInstrumentList

List Payment Instruments for a Customer

Parameters:

  • customer_token_id —

    The TokenId 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:



221
222
223
224
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 221

def get_customer_payment_instruments_list(customer_token_id, opts = {})
  data, status_code, headers = get_customer_payment_instruments_list_with_http_info(customer_token_id, opts)
  return data, status_code, headers
end

#get_customer_payment_instruments_list_with_http_info(customer_token_id, opts = {}) ⇒ Array<(PaymentInstrumentList, Fixnum, Hash)>

List Payment Instruments for a Customer

Parameters:

  • customer_token_id —

    The TokenId 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:

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

    PaymentInstrumentList data, response status code and response headers



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
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
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 233

def get_customer_payment_instruments_list_with_http_info(customer_token_id, opts = {})

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

  if @api_client.config.client_side_validation && customer_token_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "customer_token_id" when calling CustomerPaymentInstrumentApi.get_customer_payment_instruments_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 CustomerPaymentInstrumentApi.get_customer_payment_instruments_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 CustomerPaymentInstrumentApi.get_customer_payment_instruments_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 CustomerPaymentInstrumentApi.get_customer_payment_instruments_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 CustomerPaymentInstrumentApi.get_customer_payment_instruments_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 CustomerPaymentInstrumentApi.get_customer_payment_instruments_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerTokenId}/payment-instruments'.sub('{' + 'customerTokenId' + '}', customer_token_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)
  post_body = nil
  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 => 'PaymentInstrumentList')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#get_customer_payment_instruments_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_payment_instrument(customer_token_id, payment_instrument_token_id, patch_customer_payment_instrument_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrument

Update a Customer Payment Instrument

Parameters:

  • customer_token_id —

    The TokenId of a customer.

  • payment_instrument_token_id —

    The TokenId of a payment instrument.

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



322
323
324
325
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 322

def patch_customers_payment_instrument(customer_token_id, payment_instrument_token_id, patch_customer_payment_instrument_request, opts = {})
  data, status_code, headers = patch_customers_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, patch_customer_payment_instrument_request, opts)
  return data, status_code, headers
end

#patch_customers_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, patch_customer_payment_instrument_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrument, Fixnum, Hash)>

Update a Customer Payment Instrument

Parameters:

  • customer_token_id —

    The TokenId of a customer.

  • payment_instrument_token_id —

    The TokenId of a payment instrument.

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
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
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 335

def patch_customers_payment_instrument_with_http_info(customer_token_id, payment_instrument_token_id, patch_customer_payment_instrument_request, opts = {})

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

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

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

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

  # verify the required parameter 'patch_customer_payment_instrument_request' is set
  if @api_client.config.client_side_validation && patch_customer_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_customer_payment_instrument_request' when calling CustomerPaymentInstrumentApi.patch_customers_payment_instrument"
  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 CustomerPaymentInstrumentApi.patch_customers_payment_instrument, 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 CustomerPaymentInstrumentApi.patch_customers_payment_instrument, 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 CustomerPaymentInstrumentApi.patch_customers_payment_instrument, 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 CustomerPaymentInstrumentApi.patch_customers_payment_instrument, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerTokenId}/payment-instruments/{paymentInstrumentTokenId}'.sub('{' + 'customerTokenId' + '}', customer_token_id.to_s).sub('{' + 'paymentInstrumentTokenId' + '}', payment_instrument_token_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_payment_instrument_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 => 'Tmsv2customersEmbeddedDefaultPaymentInstrument')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#patch_customers_payment_instrument\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_payment_instrument(customer_token_id, post_customer_payment_instrument_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrument

Create a Customer Payment Instrument Include an existing TMS Customer & Instrument Identifier token id in the request. * A Customer token can be created by calling: **POST */tms/v2/customers*** * An Instrument Identifier token can be created by calling: **POST */tms/v1/instrumentidentifiers***

Parameters:

  • customer_token_id —

    The TokenId of a customer.

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



434
435
436
437
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 434

def post_customer_payment_instrument(customer_token_id, post_customer_payment_instrument_request, opts = {})
  data, status_code, headers = post_customer_payment_instrument_with_http_info(customer_token_id, post_customer_payment_instrument_request, opts)
  return data, status_code, headers
end

#post_customer_payment_instrument_with_http_info(customer_token_id, post_customer_payment_instrument_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrument, Fixnum, Hash)>

Create a Customer Payment Instrument Include an existing TMS Customer &amp; Instrument Identifier token id in the request. * A Customer token can be created by calling: **POST */tms/v2/customers*** * An Instrument Identifier token can be created by calling: **POST */tms/v1/instrumentidentifiers***

Parameters:

  • customer_token_id —

    The TokenId of a customer.

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



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
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
 
# File 'lib/cybersource_rest_client/api/customer_payment_instrument_api.rb', line 446

def post_customer_payment_instrument_with_http_info(customer_token_id, post_customer_payment_instrument_request, opts = {})

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

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

  # verify the required parameter 'post_customer_payment_instrument_request' is set
  if @api_client.config.client_side_validation && post_customer_payment_instrument_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_customer_payment_instrument_request' when calling CustomerPaymentInstrumentApi.post_customer_payment_instrument"
  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 CustomerPaymentInstrumentApi.post_customer_payment_instrument, 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 CustomerPaymentInstrumentApi.post_customer_payment_instrument, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v2/customers/{customerTokenId}/payment-instruments'.sub('{' + 'customerTokenId' + '}', customer_token_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_payment_instrument_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 => 'Tmsv2customersEmbeddedDefaultPaymentInstrument')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: CustomerPaymentInstrumentApi#post_customer_payment_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end