Class: CyberSource::InstrumentIdentifierApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InstrumentIdentifierApi

Returns a new instance of InstrumentIdentifierApi.



19
20
21
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#instrumentidentifiers_post(profile_id, opts = {}) ⇒ InlineResponse2007

Create an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

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

    the optional parameters

Options Hash (opts):

  • :body (Body) —

    Please specify either a Card or Bank Account.

Returns:



27
28
29
30
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 27

def instrumentidentifiers_post(profile_id, opts = {})
  data, _status_code, _headers = instrumentidentifiers_post_with_http_info(profile_id, opts)
  return data, _status_code, _headers
end

#instrumentidentifiers_post_with_http_info(profile_id, opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>

Create an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

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

    the optional parameters

Options Hash (opts):

  • :body (Body) —

    Please specify either a Card or Bank Account.

Returns:

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

    InlineResponse2007 data, response status code and response headers



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

def instrumentidentifiers_post_with_http_info(profile_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.instrumentidentifiers_post ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.instrumentidentifiers_post"
  end
  # if @api_client.config.client_side_validation && profile_id > 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_post, must be smaller than or equal to 36.'
  # end

  # if @api_client.config.client_side_validation && profile_id < 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_post, must be greater 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'])
  header_params[:'profile-id'] = profile_id

  # form parameters
  form_params = {}

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

#instrumentidentifiers_token_id_delete(profile_id, token_id, opts = {}) ⇒ nil

Delete an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier.

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 88

def instrumentidentifiers_token_id_delete(profile_id, token_id, opts = {})
  data, _status_code, _headers = instrumentidentifiers_token_id_delete_with_http_info(profile_id, token_id, opts)
  return data, _status_code, _headers
end

#instrumentidentifiers_token_id_delete_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def instrumentidentifiers_token_id_delete_with_http_info(profile_id, token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.instrumentidentifiers_token_id_delete ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_delete"
  end
  # z

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

  # if @api_client.config.client_side_validation && token_id < 16
  #   fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_delete, must be greater than or equal to 16.'
  # end

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}'.sub('{' + 'tokenId' + '}', 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'])
  header_params[:'profile-id'] = profile_id

  # 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
    @api_client.config.logger.debug "API called: InstrumentIdentifierApi#instrumentidentifiers_token_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#instrumentidentifiers_token_id_get(profile_id, token_id, opts = {}) ⇒ InlineResponse2007

Retrieve an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier.

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

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 154

def instrumentidentifiers_token_id_get(profile_id, token_id, opts = {})
  data, _status_code, _headers = instrumentidentifiers_token_id_get_with_http_info(profile_id, token_id, opts)
  return data, _status_code, _headers
end

#instrumentidentifiers_token_id_get_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>

Retrieve an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier.

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

    the optional parameters

Returns:

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

    InlineResponse2007 data, response status code and response headers



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

def instrumentidentifiers_token_id_get_with_http_info(profile_id, token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.instrumentidentifiers_token_id_get ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_get"
  end
  # if @api_client.config.client_side_validation && profile_id > "36"
  #   fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_get, must be smaller than or equal to 36.'
  # end

  # if @api_client.config.client_side_validation && profile_id < "36"
  #   fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_get, must be greater than or equal to 36.'
  # end

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

  # if @api_client.config.client_side_validation && token_id < 16
  #   fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_get, must be greater than or equal to 16.'
  # end

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}'.sub('{' + 'tokenId' + '}', 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'])
  header_params[:'profile-id'] = profile_id

  # 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 => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstrumentIdentifierApi#instrumentidentifiers_token_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#instrumentidentifiers_token_id_patch(profile_id, token_id, body, opts = {}) ⇒ InlineResponse2007

Update a Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier

  • body —

    Please specify the previous transaction Id to update.

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

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 228

def instrumentidentifiers_token_id_patch(profile_id, token_id, body, opts = {})
  data, _status_code, _headers = instrumentidentifiers_token_id_patch_with_http_info(profile_id, token_id, body, opts)
  return data, _status_code, _headers
end

#instrumentidentifiers_token_id_patch_with_http_info(profile_id, token_id, body, opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>

Update a Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier

  • body —

    Please specify the previous transaction Id to update.

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

    the optional parameters

Returns:

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

    InlineResponse2007 data, response status code and response headers



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

def instrumentidentifiers_token_id_patch_with_http_info(profile_id, token_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.instrumentidentifiers_token_id_patch ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_patch"
  end
  if @api_client.config.client_side_validation && profile_id > 36
    fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_patch, must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && profile_id < 36
    fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_patch, must be greater than or equal to 36.'
  end

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

  if @api_client.config.client_side_validation && token_id < 16
    fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_patch, must be greater than or equal to 16.'
  end

  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_patch"
  end
  # resource path
  local_var_path = '/instrumentidentifiers/{tokenId}'.sub('{' + 'tokenId' + '}', 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'])
  header_params[:'profile-id'] = profile_id

  # form parameters
  form_params = {}

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

#instrumentidentifiers_token_id_paymentinstruments_get(profile_id, token_id, opts = {}) ⇒ InlineResponse2008

Retrieve all Payment Instruments associated with an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (String) —

    The maximum number of Payment Instruments 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:



308
309
310
311
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 308

def instrumentidentifiers_token_id_paymentinstruments_get(profile_id, token_id, opts = {})
  data, _status_code, _headers = instrumentidentifiers_token_id_paymentinstruments_get_with_http_info(profile_id, token_id, opts)
  return data, _status_code, _headers
end

#instrumentidentifiers_token_id_paymentinstruments_get_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(InlineResponse2008, Fixnum, Hash)>

Retrieve all Payment Instruments associated with an Instrument Identifier

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of an Instrument Identifier.

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (String) —

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

Returns:

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

    InlineResponse2008 data, response status code and response headers



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
385
386
387
388
389
390
391
 
# File 'lib/cyberSource_client/api/instrument_identifier_api.rb', line 320

def instrumentidentifiers_token_id_paymentinstruments_get_with_http_info(profile_id, token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.instrumentidentifiers_token_id_paymentinstruments_get ...'
  end
  # verify the required parameter 'profile_id' is set
  if @api_client.config.client_side_validation && profile_id.nil?
    fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_paymentinstruments_get"
  end
  # if @api_client.config.client_side_validation && profile_id > 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_paymentinstruments_get, must be smaller than or equal to 36.'
  # end

  # if @api_client.config.client_side_validation && profile_id < 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_paymentinstruments_get, must be greater than or equal to 36.'
  # end

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

  # if @api_client.config.client_side_validation && token_id < 16
  #   fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_paymentinstruments_get, must be greater than or equal to 16.'
  # end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InstrumentIdentifierApi.instrumentidentifiers_token_id_paymentinstruments_get, 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.instrumentidentifiers_token_id_paymentinstruments_get, 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.instrumentidentifiers_token_id_paymentinstruments_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments'.sub('{' + 'tokenId' + '}', 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'])
  header_params[:'profile-id'] = profile_id

  # 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 => 'InlineResponse2008')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InstrumentIdentifierApi#instrumentidentifiers_token_id_paymentinstruments_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end