class CyberSource::PaymentInstrumentApi
Attributes
Public Class Methods
# File lib/cyberSource_client/api/payment_instrument_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param body Please specify the customers payment details for card or bank account. @param [Hash] opts the optional parameters @return [InlineResponse2016]
# 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
Create a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param body Please specify the customers payment details for card or bank account. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2016
, Fixnum, Hash)>] InlineResponse2016
data, response status code and response headers
# 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
Delete a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param token_id The TokenId of a Payment Instrument. @param [Hash] opts the optional parameters @return [nil]
# 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
Delete a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param token_id The TokenId of a Payment Instrument. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# 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
Retrieve a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param token_id The TokenId of a Payment Instrument. @param [Hash] opts the optional parameters @return [InlineResponse2016]
# 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
Retrieve a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param token_id The TokenId of a Payment Instrument. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2016
, Fixnum, Hash)>] InlineResponse2016
data, response status code and response headers
# 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
Update a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param token_id The TokenId of a Payment Instrument. @param body Please specify the customers payment details. @param [Hash] opts the optional parameters @return [InlineResponse2016]
# 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
Update a Payment Instrument @param profile_id The id of a profile containing user specific TMS configuration. @param token_id The TokenId of a Payment Instrument. @param body Please specify the customers payment details. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2016
, Fixnum, Hash)>] InlineResponse2016
data, response status code and response headers
# 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