first_data_gateway 1.4.0 → 1.8.0

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.13.0.20200810.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.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.8.0.20190731.002
+The version of the OpenAPI document: 6.13.0.20200810.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.1.1
 
 =end
 
@@ -53,44 +53,29 @@ 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
       return data, response.code, response.headers
     end
 
-
     # Builds the HTTP request
     #
     # @param [String] http_method HTTP method/verb (e.g. POST)

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.8.0.20190731.002
+The version of the OpenAPI document: 6.13.0.20200810.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.1.1
 
 =end
 

data/lib/openapi_client/configuration.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.8.0.20190731.002
+The version of the OpenAPI document: 6.13.0.20200810.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.1.1
 
 =end
 
@@ -125,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 = {}

data/lib/openapi_client/models/access_token_request.rb

@@ -0,0 +1,242 @@
+=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.13.0.20200810.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Access token generation request.
+  class AccessTokenRequest
+    # Domain name.
+    attr_accessor :domain
+
+    # The token value.
+    attr_accessor :token
+
+    # Indicates whether public key is requested or not.
+    attr_accessor :public_key_required
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'domain' => :'domain',
+        :'token' => :'token',
+        :'public_key_required' => :'publicKeyRequired'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'domain' => :'String',
+        :'token' => :'String',
+        :'public_key_required' => :'Boolean'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AccessTokenRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AccessTokenRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
+      end
+
+      if attributes.key?(:'public_key_required')
+        self.public_key_required = attributes[:'public_key_required']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @domain.nil?
+        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
+      end
+
+      if @token.nil?
+        invalid_properties.push('invalid value for "token", token cannot be nil.')
+      end
+
+      if @public_key_required.nil?
+        invalid_properties.push('invalid value for "public_key_required", public_key_required cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @domain.nil?
+      return false if @token.nil?
+      return false if @public_key_required.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          domain == o.domain &&
+          token == o.token &&
+          public_key_required == o.public_key_required
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [domain, token, public_key_required].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
+      return nil unless attributes.is_a?(Hash)
+      openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        klass = OpenapiClient.const_get(type)
+        if klass.respond_to?(:openapi_discriminator_name)
+          klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
+        end
+ 
+        klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
+      hash = {}
+      attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end