first_data_gateway 1.5.0 → 1.6.0

data/lib/openapi_client/api/payment_token_api.rb

@@ -3,7 +3,7 @@
 
 #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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -232,5 +232,112 @@ module OpenapiClient
       end
       return data, status_code, headers
     end
+
+    # Get payment card details associated with token.
+    # Get payment card details associated with 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 token_id [String] Identifies a payment token.
+    # @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] :authorization The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'.
+    # @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.
+    # @option opts [String] :store_id 
+    # @return [PaymentTokenizationResponse]
+    def get_payment_token_details(content_type, client_request_id, api_key, timestamp, token_id, opts = {})
+      data, _status_code, _headers = get_payment_token_details_with_http_info(content_type, client_request_id, api_key, timestamp, token_id, opts)
+      data
+    end
+
+    # Get payment card details associated with token.
+    # Get payment card details associated with 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 token_id [String] Identifies a payment token.
+    # @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] :authorization The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'.
+    # @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.
+    # @option opts [String] :store_id 
+    # @return [Array<(PaymentTokenizationResponse, Integer, Hash)>] PaymentTokenizationResponse data, response status code and response headers
+    def get_payment_token_details_with_http_info(content_type, client_request_id, api_key, timestamp, token_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentTokenApi.get_payment_token_details ...'
+      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 PaymentTokenApi.get_payment_token_details"
+      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 PaymentTokenApi.get_payment_token_details"
+      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 PaymentTokenApi.get_payment_token_details"
+      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 PaymentTokenApi.get_payment_token_details"
+      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 PaymentTokenApi.get_payment_token_details"
+      end
+      # resource path
+      local_var_path = '/payment-tokens/{token-id}'.sub('{' + 'token-id' + '}', CGI.escape(token_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+      header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PaymentTokenizationResponse' 
+
+      # 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 => 'PaymentTokenizationResponse',
+        :default_error_type => 'ErrorResponse')
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentTokenApi#get_payment_token_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/openapi_client/api/payment_url_api.rb

@@ -3,7 +3,7 @@
 
 #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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset

data/lib/openapi_client/api_client.rb

@@ -3,7 +3,7 @@
 
 #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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset

data/lib/openapi_client/api_error.rb

@@ -3,7 +3,7 @@
 
 #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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset

data/lib/openapi_client/configuration.rb

@@ -1,10 +1,9 @@
-
 =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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset

data/lib/openapi_client/models/access_token_request.rb

@@ -0,0 +1,233 @@
+=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.10.1.20200226.002
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=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)
+      return nil unless attributes.is_a?(Hash)
+      self.class.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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.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
+        OpenapiClient.const_get(type).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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        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

data/lib/openapi_client/models/access_token_response.rb

@@ -3,7 +3,7 @@
 
 #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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -16,51 +16,49 @@ module OpenapiClient
   # Access token generation response.
   class AccessTokenResponse
     # Access token for authentication.
-    attr_accessor :access_token
+    attr_accessor :token_id
 
-    # Echoes back the value from the request header for tracking.
-    attr_accessor :client_request_id
+    # The token status.
+    attr_accessor :status
 
-    # The result of the requested operation. If this is anything other than 'SUCCESS', please refer to the 400s HTTP error codes. See ErrorResponse object for details.
-    attr_accessor :request_status
-
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
+    # Access token issued time in milliseconds.
+    attr_accessor :issued_on
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    # Access token expiration time.
+    attr_accessor :expires_in_seconds
+
+    # Public key to encrypt data.
+    attr_accessor :public_key_base64
+
+    # Encyption algorithym. One way ECDH 256 bit key.
+    attr_accessor :algorithm
+
+    # Echoes back the value from the request header for tracking.
+    attr_accessor :client_request_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'access_token' => :'accessToken',
-        :'client_request_id' => :'clientRequestId',
-        :'request_status' => :'requestStatus'
+        :'token_id' => :'tokenId',
+        :'status' => :'status',
+        :'issued_on' => :'issuedOn',
+        :'expires_in_seconds' => :'expiresInSeconds',
+        :'public_key_base64' => :'publicKeyBase64',
+        :'algorithm' => :'algorithm',
+        :'client_request_id' => :'clientRequestId'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'access_token' => :'String',
-        :'client_request_id' => :'String',
-        :'request_status' => :'String'
+        :'token_id' => :'String',
+        :'status' => :'String',
+        :'issued_on' => :'String',
+        :'expires_in_seconds' => :'String',
+        :'public_key_base64' => :'String',
+        :'algorithm' => :'String',
+        :'client_request_id' => :'String'
       }
     end
 
@@ -79,16 +77,32 @@ module OpenapiClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'access_token')
-        self.access_token = attributes[:'access_token']
+      if attributes.key?(:'token_id')
+        self.token_id = attributes[:'token_id']
       end
 
-      if attributes.key?(:'client_request_id')
-        self.client_request_id = attributes[:'client_request_id']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'request_status')
-        self.request_status = attributes[:'request_status']
+      if attributes.key?(:'issued_on')
+        self.issued_on = attributes[:'issued_on']
+      end
+
+      if attributes.key?(:'expires_in_seconds')
+        self.expires_in_seconds = attributes[:'expires_in_seconds']
+      end
+
+      if attributes.key?(:'public_key_base64')
+        self.public_key_base64 = attributes[:'public_key_base64']
+      end
+
+      if attributes.key?(:'algorithm')
+        self.algorithm = attributes[:'algorithm']
+      end
+
+      if attributes.key?(:'client_request_id')
+        self.client_request_id = attributes[:'client_request_id']
       end
     end
 
@@ -102,29 +116,21 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      request_status_validator = EnumAttributeValidator.new('String', ["SUCCESS"])
-      return false unless request_status_validator.valid?(@request_status)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] request_status Object to be assigned
-    def request_status=(request_status)
-      validator = EnumAttributeValidator.new('String', ["SUCCESS"])
-      unless validator.valid?(request_status)
-        fail ArgumentError, "invalid value for \"request_status\", must be one of #{validator.allowable_values}."
-      end
-      @request_status = request_status
-    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 &&
-          access_token == o.access_token &&
-          client_request_id == o.client_request_id &&
-          request_status == o.request_status
+          token_id == o.token_id &&
+          status == o.status &&
+          issued_on == o.issued_on &&
+          expires_in_seconds == o.expires_in_seconds &&
+          public_key_base64 == o.public_key_base64 &&
+          algorithm == o.algorithm &&
+          client_request_id == o.client_request_id
     end
 
     # @see the `==` method
@@ -136,7 +142,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [access_token, client_request_id, request_status].hash
+      [token_id, status, issued_on, expires_in_seconds, public_key_base64, algorithm, client_request_id].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/account_updater_response.rb

@@ -3,7 +3,7 @@
 
 #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.9.1.20191223.002
+The version of the OpenAPI document: 6.10.1.20200226.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset