Class: CyberSource::PaymentInstrumentApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentInstrumentApi

Returns a new instance of PaymentInstrumentApi.



19
20
21
 
# File 'lib/cyberSource_client/api/payment_instrument_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/payment_instrument_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#paymentinstruments_post(profile_id, body, opts = {}) ⇒ InlineResponse2016

Create a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • body —

    Please specify the customers payment details for card or bank account.

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

    the optional parameters

Returns:



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

def paymentinstruments_post(profile_id, body, opts = {})
  data, _status_code, _headers = paymentinstruments_post_with_http_info(profile_id, body, opts)
  return data, _status_code, _headers
end

#paymentinstruments_post_with_http_info(profile_id, body, opts = {}) ⇒ Array<(InlineResponse2016, Fixnum, Hash)>

Create a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • body —

    Please specify the customers payment details for card or bank account.

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

    the optional parameters

Returns:

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

    InlineResponse2016 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
83
84
85
86
 
# File 'lib/cyberSource_client/api/payment_instrument_api.rb', line 37

def paymentinstruments_post_with_http_info(profile_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_post"
  end
  # if @api_client.config.client_side_validation && profile_id > 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_post, must be greater than or equal to 36.'
  # 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 PaymentInstrumentApi.paymentinstruments_post"
  end
  # resource path
  local_var_path = 'tms/v1/paymentinstruments'

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

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

Delete a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/cyberSource_client/api/payment_instrument_api.rb', line 92

def paymentinstruments_token_id_delete(profile_id, token_id, opts = {})
  data, _status_code, _headers = paymentinstruments_token_id_delete_with_http_info(profile_id, token_id, opts)
  return data, _status_code, _headers
end

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

Delete a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/cyberSource_client/api/payment_instrument_api.rb', line 102

def paymentinstruments_token_id_delete_with_http_info(profile_id, token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_delete"
  end
  # if @api_client.config.client_side_validation && profile_id > 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.paymentinstruments_token_id_delete, 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 PaymentInstrumentApi.paymentinstruments_token_id_delete, 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 PaymentInstrumentApi.paymentinstruments_token_id_delete"
  end
  # if @api_client.config.client_side_validation && token_id > 32
  #   fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_delete, must be greater than or equal to 16.'
  # end

  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{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: PaymentInstrumentApi#paymentinstruments_token_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#paymentinstruments_token_id_get(profile_id, token_id, opts = {}) ⇒ InlineResponse2016

Retrieve a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/cyberSource_client/api/payment_instrument_api.rb', line 164

def paymentinstruments_token_id_get(profile_id, token_id, opts = {})
  data, _status_code, _headers = paymentinstruments_token_id_get_with_http_info(profile_id, token_id, opts)
  return data, _status_code, _headers
end

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

Retrieve a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

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

    the optional parameters

Returns:

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

    InlineResponse2016 data, response status code and response headers



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
226
227
228
229
230
231
 
# File 'lib/cyberSource_client/api/payment_instrument_api.rb', line 174

def paymentinstruments_token_id_get_with_http_info(profile_id, token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_get"
  end
  # if @api_client.config.client_side_validation && profile_id > 36
  #   fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_get"
  end
  # if @api_client.config.client_side_validation && token_id > 32
  #   fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_get, must be greater than or equal to 16.'
  # end

  # resource path
  local_var_path = 'tms/v1/paymentinstruments/{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 => 'InlineResponse2016')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentInstrumentApi#paymentinstruments_token_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#paymentinstruments_token_id_patch(profile_id, token_id, body, opts = {}) ⇒ InlineResponse2016

Update a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

  • body —

    Please specify the customers payment details.

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/cyberSource_client/api/payment_instrument_api.rb', line 238

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

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

Update a Payment Instrument

Parameters:

  • profile_id —

    The id of a profile containing user specific TMS configuration.

  • token_id —

    The TokenId of a Payment Instrument.

  • body —

    Please specify the customers payment details.

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

    the optional parameters

Returns:

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

    InlineResponse2016 data, response status code and response headers



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

def paymentinstruments_token_id_patch_with_http_info(profile_id, token_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_patch"
  end
  if @api_client.config.client_side_validation && profile_id > 36
    fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_patch"
  end
  if @api_client.config.client_side_validation && token_id > 32
    fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_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 PaymentInstrumentApi.paymentinstruments_token_id_patch"
  end
  # resource path
  local_var_path = '/paymentinstruments/{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 => 'InlineResponse2016')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentInstrumentApi#paymentinstruments_token_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end