Class: CyberSource::InstrumentIdentifierApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of InstrumentIdentifierApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_instrument_identifier(instrument_identifier_token_id, opts = {}) ⇒ nil

Delete an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

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


28
29
30
31
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 28

def delete_instrument_identifier(instrument_identifier_token_id, opts = {})
  data, status_code, headers = delete_instrument_identifier_with_http_info(instrument_identifier_token_id, opts)
  return data, status_code, headers
end

#delete_instrument_identifier_with_http_info(instrument_identifier_token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

  • 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



38
39
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
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 38

def delete_instrument_identifier_with_http_info(instrument_identifier_token_id, opts = {})

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

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

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}'.sub('{' + 'instrumentIdentifierTokenId' + '}', instrument_identifier_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: InstrumentIdentifierApi#delete_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_instrument_identifier(instrument_identifier_token_id, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier

Retrieve an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The id of a profile containing user specific TMS configuration.

Returns:



109
110
111
112
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 109

def get_instrument_identifier(instrument_identifier_token_id, opts = {})
  data, status_code, headers = get_instrument_identifier_with_http_info(instrument_identifier_token_id, opts)
  return data, status_code, headers
end

#get_instrument_identifier_payment_instruments_list(instrument_identifier_token_id, opts = {}) ⇒ PaymentInstrumentList

List Payment Instruments for an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

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



193
194
195
196
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 193

def get_instrument_identifier_payment_instruments_list(instrument_identifier_token_id, opts = {})
  data, status_code, headers = get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_token_id, opts)
  return data, status_code, headers
end

#get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_token_id, opts = {}) ⇒ Array<(PaymentInstrumentList, Fixnum, Hash)>

List Payment Instruments for an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

  • 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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
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
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 205

def get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_token_id, opts = {})

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

  if @api_client.config.client_side_validation && instrument_identifier_token_id.to_s.length < 12
    fail ArgumentError, 'invalid value for "instrument_identifier_token_id" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, the character length must be great than or equal to 12.'
  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 InstrumentIdentifierApi.get_instrument_identifier_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 InstrumentIdentifierApi.get_instrument_identifier_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 InstrumentIdentifierApi.get_instrument_identifier_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 InstrumentIdentifierApi.get_instrument_identifier_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 InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/paymentinstruments'.sub('{' + 'instrumentIdentifierTokenId' + '}', instrument_identifier_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: InstrumentIdentifierApi#get_instrument_identifier_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

#get_instrument_identifier_with_http_info(instrument_identifier_token_id, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>

Retrieve an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The id of a profile containing user specific TMS configuration.

Returns:



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

def get_instrument_identifier_with_http_info(instrument_identifier_token_id, opts = {})

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

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

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}'.sub('{' + 'instrumentIdentifierTokenId' + '}', instrument_identifier_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 => 'Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#patch_instrument_identifier(instrument_identifier_token_id, patch_instrument_identifier_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier

Update an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

  • patch_instrument_identifier_request —

    Specify the previous transaction ID to update.

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



293
294
295
296
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 293

def patch_instrument_identifier(instrument_identifier_token_id, patch_instrument_identifier_request, opts = {})
  data, status_code, headers = patch_instrument_identifier_with_http_info(instrument_identifier_token_id, patch_instrument_identifier_request, opts)
  return data, status_code, headers
end

#patch_instrument_identifier_with_http_info(instrument_identifier_token_id, patch_instrument_identifier_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>

Update an Instrument Identifier

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

  • patch_instrument_identifier_request —

    Specify the previous transaction ID to update.

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



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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 305

def patch_instrument_identifier_with_http_info(instrument_identifier_token_id, patch_instrument_identifier_request, opts = {})

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

  if @api_client.config.client_side_validation && instrument_identifier_token_id.to_s.length < 12
    fail ArgumentError, 'invalid value for "instrument_identifier_token_id" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be great than or equal to 12.'
  end

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

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}'.sub('{' + 'instrumentIdentifierTokenId' + '}', instrument_identifier_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_instrument_identifier_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 => 'Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#patch_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#post_instrument_identifier(post_instrument_identifier_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier

Create an Instrument Identifier

Parameters:

  • post_instrument_identifier_request —

    Specify either a Card, Bank Account or Enrollable Card

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The id of a profile containing user specific TMS configuration.

Returns:



390
391
392
393
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 390

def post_instrument_identifier(post_instrument_identifier_request, opts = {})
  data, status_code, headers = post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts)
  return data, status_code, headers
end

#post_instrument_identifier_enrollment(instrument_identifier_token_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ nil

Enroll an Instrument Identifier for Network Tokenization

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

  • post_instrument_identifier_enrollment_request —

    Specify Enrollable Card details

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


465
466
467
468
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 465

def post_instrument_identifier_enrollment(instrument_identifier_token_id, post_instrument_identifier_enrollment_request, opts = {})
  data, status_code, headers = post_instrument_identifier_enrollment_with_http_info(instrument_identifier_token_id, post_instrument_identifier_enrollment_request, opts)
  return data, status_code, headers
end

#post_instrument_identifier_enrollment_with_http_info(instrument_identifier_token_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enroll an Instrument Identifier for Network Tokenization

Parameters:

  • instrument_identifier_token_id —

    The TokenId of a Instrument Identifier.

  • post_instrument_identifier_enrollment_request —

    Specify Enrollable Card details

  • 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



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
537
538
539
540
541
542
543
544
545
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 476

def post_instrument_identifier_enrollment_with_http_info(instrument_identifier_token_id, post_instrument_identifier_enrollment_request, opts = {})

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

  if @api_client.config.client_side_validation && instrument_identifier_token_id.to_s.length < 12
    fail ArgumentError, 'invalid value for "instrument_identifier_token_id" when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment, the character length must be great than or equal to 12.'
  end

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

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}/enrollment'.sub('{' + 'instrumentIdentifierTokenId' + '}', instrument_identifier_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_instrument_identifier_enrollment_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)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#post_instrument_identifier_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>

Create an Instrument Identifier

Parameters:

  • post_instrument_identifier_request —

    Specify either a Card, Bank Account or Enrollable Card

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The id of a profile containing user specific TMS configuration.

Returns:



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
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 400

def post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.post_instrument_identifier ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'post_instrument_identifier_request' is set
  if @api_client.config.client_side_validation && post_instrument_identifier_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_instrument_identifier_request' when calling InstrumentIdentifierApi.post_instrument_identifier"
  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 InstrumentIdentifierApi.post_instrument_identifier, 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 InstrumentIdentifierApi.post_instrument_identifier, the character length must be great than or equal to 36.'
  end

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers'

  # 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_instrument_identifier_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 => 'Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InstrumentIdentifierApi#post_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end