Class: CyberSource::PaymentInstrumentsApi
- Inherits:
-
Object
- Object
- CyberSource::PaymentInstrumentsApi
- Defined in:
- lib/cybersource_rest_client/api/payment_instruments_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default, config) ⇒ PaymentInstrumentsApi
constructor
A new instance of PaymentInstrumentsApi.
-
#tms_v1_instrumentidentifiers_token_id_paymentinstruments_get(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response
Retrieve all Payment Instruments associated with an Instrument Identifier.
-
#tms_v1_instrumentidentifiers_token_id_paymentinstruments_get_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response, Fixnum, Hash)>
Retrieve all Payment Instruments associated with an Instrument Identifier.
-
#tms_v1_paymentinstruments_post(profile_id, body, opts = {}) ⇒ TmsV1PaymentinstrumentsPost201Response
Create a Payment Instrument.
-
#tms_v1_paymentinstruments_post_with_http_info(profile_id, body, opts = {}) ⇒ Array<(TmsV1PaymentinstrumentsPost201Response, Fixnum, Hash)>
Create a Payment Instrument.
-
#tms_v1_paymentinstruments_token_id_delete(profile_id, token_id, opts = {}) ⇒ nil
Delete a Payment Instrument.
-
#tms_v1_paymentinstruments_token_id_delete_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete a Payment Instrument.
-
#tms_v1_paymentinstruments_token_id_get(profile_id, token_id, opts = {}) ⇒ TmsV1PaymentinstrumentsPost201Response
Retrieve a Payment Instrument.
-
#tms_v1_paymentinstruments_token_id_get_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1PaymentinstrumentsPost201Response, Fixnum, Hash)>
Retrieve a Payment Instrument.
-
#tms_v1_paymentinstruments_token_id_patch(profile_id, token_id, body, opts = {}) ⇒ TmsV1PaymentinstrumentsPost201Response
Update a Payment Instrument.
-
#tms_v1_paymentinstruments_token_id_patch_with_http_info(profile_id, token_id, body, opts = {}) ⇒ Array<(TmsV1PaymentinstrumentsPost201Response, Fixnum, Hash)>
Update a Payment Instrument.
Constructor Details
#initialize(api_client = ApiClient.default, config) ⇒ PaymentInstrumentsApi
Returns a new instance of PaymentInstrumentsApi.
19 20 21 22 |
# File 'lib/cybersource_rest_client/api/payment_instruments_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/payment_instruments_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#tms_v1_instrumentidentifiers_token_id_paymentinstruments_get(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response
Retrieve all Payment Instruments associated with an Instrument Identifier
30 31 32 33 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 30 def tms_v1_instrumentidentifiers_token_id_paymentinstruments_get(profile_id, token_id, opts = {}) data, _status_code, _headers = tms_v1_instrumentidentifiers_token_id_paymentinstruments_get_with_http_info(profile_id, token_id, opts) return data, _status_code, _headers end |
#tms_v1_instrumentidentifiers_token_id_paymentinstruments_get_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response, Fixnum, Hash)>
Retrieve all Payment Instruments associated with an Instrument Identifier
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 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 42 def tms_v1_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: PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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;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'] = 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 => 'TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentInstrumentsApi#tms_v1_instrumentidentifiers_token_id_paymentinstruments_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tms_v1_paymentinstruments_post(profile_id, body, opts = {}) ⇒ TmsV1PaymentinstrumentsPost201Response
Create a Payment Instrument
121 122 123 124 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 121 def tms_v1_paymentinstruments_post(profile_id, body, opts = {}) data, _status_code, _headers = tms_v1_paymentinstruments_post_with_http_info(profile_id, body, opts) return data, _status_code, _headers end |
#tms_v1_paymentinstruments_post_with_http_info(profile_id, body, opts = {}) ⇒ Array<(TmsV1PaymentinstrumentsPost201Response, Fixnum, Hash)>
Create a Payment Instrument
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 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 131 def tms_v1_paymentinstruments_post_with_http_info(profile_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_post" end # if @api_client.config.client_side_validation && profile_id > 36 # fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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;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'] = 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 => 'TmsV1PaymentinstrumentsPost201Response') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentInstrumentsApi#tms_v1_paymentinstruments_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tms_v1_paymentinstruments_token_id_delete(profile_id, token_id, opts = {}) ⇒ nil
Delete a Payment Instrument
188 189 190 191 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 188 def tms_v1_paymentinstruments_token_id_delete(profile_id, token_id, opts = {}) data, status_code, headers = tms_v1_paymentinstruments_token_id_delete_with_http_info(profile_id, token_id, opts) return data, status_code, headers end |
#tms_v1_paymentinstruments_token_id_delete_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete a Payment Instrument
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 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 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 198 def tms_v1_paymentinstruments_token_id_delete_with_http_info(profile_id, token_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_delete" end # if @api_client.config.client_side_validation && profile_id > 36 # fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_delete" end # if @api_client.config.client_side_validation && token_id > 32 # fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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;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'] = 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: PaymentInstrumentsApi#tms_v1_paymentinstruments_token_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tms_v1_paymentinstruments_token_id_get(profile_id, token_id, opts = {}) ⇒ TmsV1PaymentinstrumentsPost201Response
Retrieve a Payment Instrument
262 263 264 265 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 262 def tms_v1_paymentinstruments_token_id_get(profile_id, token_id, opts = {}) data, _status_code, _headers = tms_v1_paymentinstruments_token_id_get_with_http_info(profile_id, token_id, opts) return data, _status_code, _headers end |
#tms_v1_paymentinstruments_token_id_get_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1PaymentinstrumentsPost201Response, Fixnum, Hash)>
Retrieve a Payment Instrument
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 272 def tms_v1_paymentinstruments_token_id_get_with_http_info(profile_id, token_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_get" end # if @api_client.config.client_side_validation && profile_id > 36 # fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_get" end # if @api_client.config.client_side_validation && token_id > 32 # fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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;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'] = 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 => 'TmsV1PaymentinstrumentsPost201Response') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentInstrumentsApi#tms_v1_paymentinstruments_token_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tms_v1_paymentinstruments_token_id_patch(profile_id, token_id, body, opts = {}) ⇒ TmsV1PaymentinstrumentsPost201Response
Update a Payment Instrument
338 339 340 341 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 338 def tms_v1_paymentinstruments_token_id_patch(profile_id, token_id, body, opts = {}) data, _status_code, _headers = tms_v1_paymentinstruments_token_id_patch_with_http_info(profile_id, token_id, body, opts) return data, _status_code, _headers end |
#tms_v1_paymentinstruments_token_id_patch_with_http_info(profile_id, token_id, body, opts = {}) ⇒ Array<(TmsV1PaymentinstrumentsPost201Response, Fixnum, Hash)>
Update a Payment Instrument
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 |
# File 'lib/cybersource_rest_client/api/payment_instruments_api.rb', line 349 def tms_v1_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: PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_patch" end # if @api_client.config.client_side_validation && profile_id > 36 # fail ArgumentError, 'invalid value for "profile_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_patch" end # if @api_client.config.client_side_validation && token_id > 32 # fail ArgumentError, 'invalid value for "token_id" when calling PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_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 PaymentInstrumentsApi.tms_v1_paymentinstruments_token_id_patch" 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;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'] = 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 => 'TmsV1PaymentinstrumentsPost201Response') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentInstrumentsApi#tms_v1_paymentinstruments_token_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |