cybersource_rest_client 0.0.83 → 0.0.84

data/lib/cybersource_rest_client/api/token_api.rb

@@ -1,306 +0,0 @@
-=begin
-#CyberSource Merged Spec
-
-#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
-
-OpenAPI spec version: 0.0.1
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.38
-=end
-
-require 'uri'
-require 'AuthenticationSDK/util/MLEUtility'
-module CyberSource
-  class TokenApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default, config)
-      @api_client = api_client
-      @api_client.set_configuration(config)
-    end
-    # Retrieve Card Art
-    # Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned. 
-    #
-    # @param instrument_identifier_id The Id of an Instrument Identifier.
-    # @param token_provider The token provider.
-    # @param asset_type The type of asset.
-    # @param [Hash] opts the optional parameters
-    # @return [InlineResponse2002]
-    #
-    def get_card_art_asset(instrument_identifier_id, token_provider, asset_type, opts = {})
-      data, status_code, headers = get_card_art_asset_with_http_info(instrument_identifier_id, token_provider, asset_type, opts)
-      return data, status_code, headers
-    end
-
-    # Retrieve Card Art
-    # Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned. 
-    # @param instrument_identifier_id The Id of an Instrument Identifier.
-    # @param token_provider The token provider.
-    # @param asset_type The type of asset.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
-    def get_card_art_asset_with_http_info(instrument_identifier_id, token_provider, asset_type, opts = {})
-
-      if @api_client.config.debugging
-          begin
-            raise
-                @api_client.config.logger.debug 'Calling API: TokenApi.get_card_art_asset ...'
-            rescue
-                puts 'Cannot write to log'
-            end
-      end
-      # verify the required parameter 'instrument_identifier_id' is set
-      if @api_client.config.client_side_validation && instrument_identifier_id.nil?
-        fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling TokenApi.get_card_art_asset"
-      end
-      # verify the required parameter 'token_provider' is set
-      if @api_client.config.client_side_validation && token_provider.nil?
-        fail ArgumentError, "Missing the required parameter 'token_provider' when calling TokenApi.get_card_art_asset"
-      end
-      # verify enum value
-      if @api_client.config.client_side_validation && !['vts', 'mdes', 'amex', 'mscof'].include?(token_provider)
-        fail ArgumentError, "invalid value for 'token_provider', must be one of vts, mdes, amex, mscof"
-      end
-      # verify the required parameter 'asset_type' is set
-      if @api_client.config.client_side_validation && asset_type.nil?
-        fail ArgumentError, "Missing the required parameter 'asset_type' when calling TokenApi.get_card_art_asset"
-      end
-      # verify enum value
-      if @api_client.config.client_side_validation && !['card-art-combined', 'brand-logo', 'issuer-logo', 'icon-logo'].include?(asset_type)
-        fail ArgumentError, "invalid value for 'asset_type', must be one of card-art-combined, brand-logo, issuer-logo, icon-logo"
-      end
-      # resource path
-      local_var_path = 'tms/v2/tokens/{instrumentIdentifierId}/{tokenProvider}/assets/{assetType}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s).sub('{' + 'tokenProvider' + '}', token_provider.to_s).sub('{' + 'assetType' + '}', asset_type.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'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      if 'GET' == 'POST'
-        post_body = '{}'
-      else
-        post_body = nil
-      end
-      inbound_mle_status = "false"
-      if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_card_art_asset","get_card_art_asset_with_http_info"])
-        begin
-          post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
-        rescue
-          raise
-        end
-      end
-
-      is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["get_card_art_asset","get_card_art_asset_with_http_info"])
-
-      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 => 'InlineResponse2002',
-        :isResponseMLEForApi => is_response_mle_for_api)
-      if @api_client.config.debugging
-        begin
-        raise
-            @api_client.config.logger.debug "API called: TokenApi#get_card_art_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-        rescue
-            puts 'Cannot write to log'
-        end
-      end
-      return data, status_code, headers
-    end
-    # Generate Payment Credentials v2
-    # **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post). The SDK will remain available for now; however, it will no longer be documented or maintain in the Developer Centre.<br> **Token**<br>A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.<br> **Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. 
-    #
-    # @param token_id The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
-    # @param post_payment_credentials_request 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :profile_id The Id of a profile containing user specific TMS configuration.
-    # @return [String]
-    #
-    def post_token_payment_credentials(token_id, post_payment_credentials_request, opts = {})
-      data, status_code, headers = post_token_payment_credentials_with_http_info(token_id, post_payment_credentials_request, opts)
-      return data, status_code, headers
-    end
-
-    # Generate Payment Credentials v2
-    # **Note**: This resource will be replace by [payment credentials version 3](#/paths/~1tms~1v3~1tokens~1{tokenId}~1payment-credentials/post). The SDK will remain available for now; however, it will no longer be documented or maintain in the Developer Centre.&lt;br&gt; **Token**&lt;br&gt;A Token can represent your tokenized Customer, Payment Instrument, Instrument Identifier or Tokenized Card information.&lt;br&gt; **Payment Credentials**&lt;br&gt;Contains payment information such as the network token, generated cryptogram for Visa &amp; MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.&lt;br&gt;Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.&lt;br&gt;Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. 
-    # @param token_id The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
-    # @param post_payment_credentials_request 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :profile_id The Id of a profile containing user specific TMS configuration.
-    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
-    def post_token_payment_credentials_with_http_info(token_id, post_payment_credentials_request, opts = {})
-
-      if @api_client.config.debugging
-          begin
-            raise
-                @api_client.config.logger.debug 'Calling API: TokenApi.post_token_payment_credentials ...'
-            rescue
-                puts 'Cannot write to log'
-            end
-      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 TokenApi.post_token_payment_credentials"
-      end
-      # verify the required parameter 'post_payment_credentials_request' is set
-      if @api_client.config.client_side_validation && post_payment_credentials_request.nil?
-        fail ArgumentError, "Missing the required parameter 'post_payment_credentials_request' when calling TokenApi.post_token_payment_credentials"
-      end
-      # resource path
-      local_var_path = 'tms/v2/tokens/{tokenId}/payment-credentials'.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/jose;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_payment_credentials_request)
-      sdk_tracker = SdkTracker.new
-      post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostPaymentCredentialsRequest1', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
-      inbound_mle_status = "optional"
-      if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["post_token_payment_credentials","post_token_payment_credentials_with_http_info"])
-        begin
-          post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
-        rescue
-          raise
-        end
-      end
-
-      is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["post_token_payment_credentials","post_token_payment_credentials_with_http_info"])
-
-      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 => 'String',
-        :isResponseMLEForApi => is_response_mle_for_api)
-      if @api_client.config.debugging
-        begin
-        raise
-            @api_client.config.logger.debug "API called: TokenApi#post_token_payment_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-        rescue
-            puts 'Cannot write to log'
-        end
-      end
-      return data, status_code, headers
-    end
-    # Generate Payment Credentials Latest Version v3
-    # **Payment Credentials**<br>Contains payment information such as the network token, generated TAVV cryptogram for Visa & MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA. This latest version (v3) returns the Primary Account Number details, if the network token is not present. The response is provided in JSON Web Encryption (JWE) format. <br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.<br>Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. 
-    #
-    # @param token_id The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
-    # @param post_payment_credentials_request 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :profile_id The Id of a profile containing user specific TMS configuration.
-    # @return [InlineResponse2011]
-    #
-    def post_token_payment_credentials_v3(token_id, post_payment_credentials_request, opts = {})
-      data, status_code, headers = post_token_payment_credentials_v3_with_http_info(token_id, post_payment_credentials_request, opts)
-      return data, status_code, headers
-    end
-
-    # Generate Payment Credentials Latest Version v3
-    # **Payment Credentials**&lt;br&gt;Contains payment information such as the network token, generated TAVV cryptogram for Visa &amp; MasterCard, dynamic CVV for Amex, or DTVV cryptogram for VISA. This latest version (v3) returns the Primary Account Number details, if the network token is not present. The response is provided in JSON Web Encryption (JWE) format. &lt;br&gt;Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument, Instrument Identifier or Tokenized Card.&lt;br&gt;Optionally, **authenticated identities** information from Passkey authentication can be provided to potentially achieve liability shift, which may result in the return of an e-commerce indicator of 5 if successful. 
-    # @param token_id The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
-    # @param post_payment_credentials_request 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :profile_id The Id of a profile containing user specific TMS configuration.
-    # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers
-    def post_token_payment_credentials_v3_with_http_info(token_id, post_payment_credentials_request, opts = {})
-
-      if @api_client.config.debugging
-          begin
-            raise
-                @api_client.config.logger.debug 'Calling API: TokenApi.post_token_payment_credentials_v3 ...'
-            rescue
-                puts 'Cannot write to log'
-            end
-      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 TokenApi.post_token_payment_credentials_v3"
-      end
-      # verify the required parameter 'post_payment_credentials_request' is set
-      if @api_client.config.client_side_validation && post_payment_credentials_request.nil?
-        fail ArgumentError, "Missing the required parameter 'post_payment_credentials_request' when calling TokenApi.post_token_payment_credentials_v3"
-      end
-      # resource path
-      local_var_path = 'tms/v3/tokens/{tokenId}/payment-credentials'.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/jose;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_payment_credentials_request)
-      sdk_tracker = SdkTracker.new
-      post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostPaymentCredentialsRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
-      inbound_mle_status = "optional"
-      if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["post_token_payment_credentials_v3","post_token_payment_credentials_v3_with_http_info"])
-        begin
-          post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
-        rescue
-          raise
-        end
-      end
-
-      is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["post_token_payment_credentials_v3","post_token_payment_credentials_v3_with_http_info"])
-
-      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 => 'InlineResponse2011',
-        :isResponseMLEForApi => is_response_mle_for_api)
-      if @api_client.config.debugging
-        begin
-        raise
-            @api_client.config.logger.debug "API called: TokenApi#post_token_payment_credentials_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-        rescue
-            puts 'Cannot write to log'
-        end
-      end
-      return data, status_code, headers
-    end
-  end
-end