first_data_gateway 1.3.0 → 1.7.1

data/lib/openapi_client/api/verification_api.rb

@@ -0,0 +1,228 @@
+=begin
+#Payment Gateway API Specification.
+
+#The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
+
+The version of the OpenAPI document: 6.12.0.20200605.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class VerificationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Verify a payment card or payment token.
+    # Use this to perform an account verification for a payment card or payment token.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param account_verification_request [AccountVerificationRequest] Accepted request type: PaymentCardVerificationRequest and PaymentTokenVerificationRequest.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
+    # @return [TransactionResponse]
+    def verify_account(content_type, client_request_id, api_key, timestamp, account_verification_request, opts = {})
+      data, _status_code, _headers = verify_account_with_http_info(content_type, client_request_id, api_key, timestamp, account_verification_request, opts)
+      data
+    end
+
+    # Verify a payment card or payment token.
+    # Use this to perform an account verification for a payment card or payment token.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param account_verification_request [AccountVerificationRequest] Accepted request type: PaymentCardVerificationRequest and PaymentTokenVerificationRequest.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
+    # @return [Array<(TransactionResponse, Integer, Hash)>] TransactionResponse data, response status code and response headers
+    def verify_account_with_http_info(content_type, client_request_id, api_key, timestamp, account_verification_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VerificationApi.verify_account ...'
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling VerificationApi.verify_account"
+      end
+      # verify enum value
+      allowable_values = ["application/json"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
+        fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'client_request_id' is set
+      if @api_client.config.client_side_validation && client_request_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_request_id' when calling VerificationApi.verify_account"
+      end
+      # verify the required parameter 'api_key' is set
+      if @api_client.config.client_side_validation && api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'api_key' when calling VerificationApi.verify_account"
+      end
+      # verify the required parameter 'timestamp' is set
+      if @api_client.config.client_side_validation && timestamp.nil?
+        fail ArgumentError, "Missing the required parameter 'timestamp' when calling VerificationApi.verify_account"
+      end
+      # verify the required parameter 'account_verification_request' is set
+      if @api_client.config.client_side_validation && account_verification_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_verification_request' when calling VerificationApi.verify_account"
+      end
+      # resource path
+      local_var_path = '/account-verification'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      #header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      #header_params[:'Content-Type'] = content_type
+      header_params[:'Client-Request-Id'] = client_request_id
+      header_params[:'Api-Key'] = api_key
+      header_params[:'Timestamp'] = timestamp
+      header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
+      header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(account_verification_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'TransactionResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VerificationApi#verify_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify a payment card.
+    # Use this to perform card verification for a payment card. Use the account-verification endpoint instead for this request.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param card_verification_request [CardVerificationRequest] Accepted request type: CardVerificationRequest.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
+    # @return [TransactionResponse]
+    def verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts = {})
+      data, _status_code, _headers = verify_card_with_http_info(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
+      data
+    end
+
+    # Verify a payment card.
+    # Use this to perform card verification for a payment card. Use the account-verification endpoint instead for this request.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param card_verification_request [CardVerificationRequest] Accepted request type: CardVerificationRequest.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
+    # @return [Array<(TransactionResponse, Integer, Hash)>] TransactionResponse data, response status code and response headers
+    def verify_card_with_http_info(content_type, client_request_id, api_key, timestamp, card_verification_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VerificationApi.verify_card ...'
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling VerificationApi.verify_card"
+      end
+      # verify enum value
+      allowable_values = ["application/json"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
+        fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'client_request_id' is set
+      if @api_client.config.client_side_validation && client_request_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_request_id' when calling VerificationApi.verify_card"
+      end
+      # verify the required parameter 'api_key' is set
+      if @api_client.config.client_side_validation && api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'api_key' when calling VerificationApi.verify_card"
+      end
+      # verify the required parameter 'timestamp' is set
+      if @api_client.config.client_side_validation && timestamp.nil?
+        fail ArgumentError, "Missing the required parameter 'timestamp' when calling VerificationApi.verify_card"
+      end
+      # verify the required parameter 'card_verification_request' is set
+      if @api_client.config.client_side_validation && card_verification_request.nil?
+        fail ArgumentError, "Missing the required parameter 'card_verification_request' when calling VerificationApi.verify_card"
+      end
+      # resource path
+      local_var_path = '/card-verification'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      #header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      #header_params[:'Content-Type'] = content_type
+      header_params[:'Client-Request-Id'] = client_request_id
+      header_params[:'Api-Key'] = api_key
+      header_params[:'Timestamp'] = timestamp
+      header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
+      header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(card_verification_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'TransactionResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VerificationApi#verify_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/openapi_client/api_client.rb

@@ -3,10 +3,10 @@
 
 #The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
 
-The version of the OpenAPI document: 6.6.0.20190507.002
+The version of the OpenAPI document: 6.12.0.20200605.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -15,7 +15,6 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
 
 module OpenapiClient
   class ApiClient
@@ -54,37 +53,23 @@ module OpenapiClient
         @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
       end
 
-      return_type = nil
-
-      if opts[:custom_responses] and opts[:custom_responses].key?(response.code)
-        return_type = opts[:custom_responses][response.code] 
-      end
-
-      if !return_type
-        case response.code
-        when 0..199
-          if response.code == 0
-            # Errors from libcurl will be made visible here
-            fail ApiError.new(:code => 0,
-                              :message => response.return_message)
-          end
-        when 200
-          return_type = opts[:return_type] ? opts[:return_type] : ""
-        when 409 || 422
-          if opts[:error_type]
-            return_type = opts[:error_type] ? opts[:error_type] : ""
-          else
-            return_type = opts[:default_error_type] ? opts[:default_error_type] : ""
-          end
-        when 201..599
-          return_type = opts[:default_error_type] ? opts[:default_error_type] : ""
+      unless response.success?
+        if response.timed_out?
+          fail ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
         else
-          fail ApiError.new('Connection timed out') if response.timed_out?
+          fail ApiError.new(:code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.status_message
         end
       end
 
-      if return_type
-        data = deserialize(response, return_type)
+      if opts[:return_type]
+        data = deserialize(response, opts[:return_type])
       else
         data = nil
       end
@@ -141,6 +126,34 @@ module OpenapiClient
       request
     end
 
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -255,11 +268,13 @@ module OpenapiClient
         tempfile.write(chunk)
       end
       request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
       end
     end
 
@@ -275,35 +290,7 @@ module OpenapiClient
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
-    end
-
-    # Builds the HTTP request body
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] form_params Query parameters
-    # @param [Object] body HTTP body (JSON/XML)
-    # @return [String] HTTP body data in the form of string
-    def build_request_body(header_params, form_params, body)
-      # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-          header_params['Content-Type'] == 'multipart/form-data'
-        data = {}
-        form_params.each do |key, value|
-          case value
-          when ::File, ::Array, nil
-            # let typhoeus handle File, Array and nil parameters
-            data[key] = value
-          else
-            data[key] = value.to_s
-          end
-        end
-      elsif body
-        data = body.is_a?(String) ? body : body.to_json
-      else
-        data = nil
-      end
-      data
+      @config.base_url + path
     end
 
     # Update hearder and query params based on authentication settings.

data/lib/openapi_client/api_error.rb

@@ -3,10 +3,10 @@
 
 #The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
 
-The version of the OpenAPI document: 6.6.0.20190507.002
+The version of the OpenAPI document: 6.12.0.20200605.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/openapi_client/configuration.rb

@@ -3,15 +3,13 @@
 
 #The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
 
-The version of the OpenAPI document: 6.6.0.20190507.002
+The version of the OpenAPI document: 6.12.0.20200605.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.3.1
 
 =end
 
-require 'uri'
-
 module OpenapiClient
   class Configuration
     # Defines url scheme
@@ -127,9 +125,9 @@ module OpenapiClient
 
     attr_accessor :force_ending_format
 
-    def initialize
+    def initialize(environment="CERT")
       @scheme = 'https'
-      @host = 'cert.api.firstdata.com'
+      @host = environment == "PROD" ? 'prod.api.firstdata.com' : 'cert.api.firstdata.com'
       @base_path = '/gateway/v2'
       @api_key = {}
       @api_key_prefix = {}
@@ -174,8 +172,7 @@ module OpenapiClient
     end
 
     def base_url
-      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
     end
 
     # Gets API key (with prefix if set).
@@ -204,7 +201,7 @@ module OpenapiClient
       [
         {
           url: "https://cert.api.firstdata.com/gateway/v2",
-          description: "No descriptoin provided",
+          description: "No description provided",
         }
       ]
     end