first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/payment_tokenization_error_response.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -18,26 +18,26 @@ module OpenapiClient
     # Echoes back the value in the request header for tracking.
     attr_accessor :client_request_id
 
-    # Echoes back the value in the request header.
+    # Request identifier in API, can be used to request logs from the support team.
     attr_accessor :api_trace_id
 
     attr_accessor :response_type
 
-    # The status of the request
+    # The status of the request.
     attr_accessor :request_status
 
-    # Time of the request
+    # Time of the request.
     attr_accessor :request_time
 
     attr_accessor :avs_response
 
-    # Optional security code check response
+    # Security code check response.
     attr_accessor :security_code_response
 
-    # Card brand
+    # Card brand.
     attr_accessor :brand
 
-    # Country of the card issued
+    # Country of the card issued.
     attr_accessor :country
 
     attr_accessor :payment_token
@@ -93,12 +93,12 @@ module OpenapiClient
         :'api_trace_id' => :'String',
         :'response_type' => :'ResponseType',
         :'request_status' => :'String',
-        :'request_time' => :'String',
+        :'request_time' => :'Integer',
         :'avs_response' => :'AVSResponse',
         :'security_code_response' => :'String',
         :'brand' => :'String',
         :'country' => :'String',
-        :'payment_token' => :'PaymentTokenization',
+        :'payment_token' => :'PaymentTokenDetails',
         :'payment_card' => :'PaymentCard',
         :'error' => :'Error'
       }
@@ -165,17 +165,12 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @response_type.nil?
-        invalid_properties.push('invalid value for "response_type", response_type 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 @response_type.nil?
       request_status_validator = EnumAttributeValidator.new('String', ['DELETED', 'FAILED', 'SUCCESS', 'APPROVED', 'WAITING', 'VALIDATION_FAILED', 'DECLINED'])
       return false unless request_status_validator.valid?(@request_status)
       true

data/lib/openapi_client/models/payment_tokenization_request.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -13,56 +13,40 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # this object is used to generate payment tokens.
+  # Used to generate payment tokens. Abstract class, do not use this class directly, use one of its children.
   class PaymentTokenizationRequest
-    # Use this to indicate the type of tokenization source
-    attr_accessor :type
+    # Object name of tokenization request.
+    attr_accessor :request_type
 
-    attr_accessor :payment_card
-
-    attr_accessor :referenced_order
+    # An optional outlet ID for clients that support multiple stores in the same app.
+    attr_accessor :store_id
 
     attr_accessor :billing_address
 
-    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
+    attr_accessor :create_token
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    # If the account should be verified prior to token creation.
+    attr_accessor :account_verification
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type',
-        :'payment_card' => :'paymentCard',
-        :'referenced_order' => :'referencedOrder',
-        :'billing_address' => :'billingAddress'
+        :'request_type' => :'requestType',
+        :'store_id' => :'storeId',
+        :'billing_address' => :'billingAddress',
+        :'create_token' => :'createToken',
+        :'account_verification' => :'accountVerification'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'String',
-        :'payment_card' => :'PaymentCard',
-        :'referenced_order' => :'ReferencedOrder',
-        :'billing_address' => :'Address'
+        :'request_type' => :'String',
+        :'store_id' => :'String',
+        :'billing_address' => :'Address',
+        :'create_token' => :'CreatePaymentToken',
+        :'account_verification' => :'BOOLEAN'
       }
     end
 
@@ -74,29 +58,43 @@ module OpenapiClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
-      end
-
-      if attributes.has_key?(:'paymentCard')
-        self.payment_card = attributes[:'paymentCard']
+      if attributes.has_key?(:'requestType')
+        self.request_type = attributes[:'requestType']
       end
 
-      if attributes.has_key?(:'referencedOrder')
-        self.referenced_order = attributes[:'referencedOrder']
+      if attributes.has_key?(:'storeId')
+        self.store_id = attributes[:'storeId']
       end
 
       if attributes.has_key?(:'billingAddress')
         self.billing_address = attributes[:'billingAddress']
       end
+
+      if attributes.has_key?(:'createToken')
+        self.create_token = attributes[:'createToken']
+      end
+
+      if attributes.has_key?(:'accountVerification')
+        self.account_verification = attributes[:'accountVerification']
+      else
+        self.account_verification = false
+      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 @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      if @request_type.nil?
+        invalid_properties.push('invalid value for "request_type", request_type cannot be nil.')
+      end
+
+      if !@store_id.nil? && @store_id.to_s.length > 20
+        invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.')
+      end
+
+      if @create_token.nil?
+        invalid_properties.push('invalid value for "create_token", create_token cannot be nil.')
       end
 
       invalid_properties
@@ -105,20 +103,20 @@ module OpenapiClient
     # 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 @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ['PAYMENT_CARD', 'EXISTING_ORDER'])
-      return false unless type_validator.valid?(@type)
+      return false if @request_type.nil?
+      return false if !@store_id.nil? && @store_id.to_s.length > 20
+      return false if @create_token.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ['PAYMENT_CARD', 'EXISTING_ORDER'])
-      unless validator.valid?(type)
-        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
+    # Custom attribute writer method with validation
+    # @param [Object] store_id Value to be assigned
+    def store_id=(store_id)
+      if !store_id.nil? && store_id.to_s.length > 20
+        fail ArgumentError, 'invalid value for "store_id", the character length must be smaller than or equal to 20.'
       end
-      @type = type
+
+      @store_id = store_id
     end
 
     # Checks equality by comparing each attribute.
@@ -126,10 +124,11 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          type == o.type &&
-          payment_card == o.payment_card &&
-          referenced_order == o.referenced_order &&
-          billing_address == o.billing_address
+          request_type == o.request_type &&
+          store_id == o.store_id &&
+          billing_address == o.billing_address &&
+          create_token == o.create_token &&
+          account_verification == o.account_verification
     end
 
     # @see the `==` method
@@ -141,7 +140,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, payment_card, referenced_order, billing_address].hash
+      [request_type, store_id, billing_address, create_token, account_verification].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/payment_tokenization_response.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -17,26 +17,26 @@ module OpenapiClient
     # Echoes back the value in the request header for tracking.
     attr_accessor :client_request_id
 
-    # Echoes back the value in the request header.
+    # Request identifier in API, can be used to request logs from the support team.
     attr_accessor :api_trace_id
 
     attr_accessor :response_type
 
-    # The status of the request
+    # The status of the request.
     attr_accessor :request_status
 
-    # Time of the request
+    # Time of the request.
     attr_accessor :request_time
 
     attr_accessor :avs_response
 
-    # Optional security code check response
+    # Security code check response.
     attr_accessor :security_code_response
 
-    # Card brand
+    # Card brand.
     attr_accessor :brand
 
-    # Country of the card issued
+    # Country of the card issued.
     attr_accessor :country
 
     attr_accessor :payment_token
@@ -89,12 +89,12 @@ module OpenapiClient
         :'api_trace_id' => :'String',
         :'response_type' => :'ResponseType',
         :'request_status' => :'String',
-        :'request_time' => :'String',
+        :'request_time' => :'Integer',
         :'avs_response' => :'AVSResponse',
         :'security_code_response' => :'String',
         :'brand' => :'String',
         :'country' => :'String',
-        :'payment_token' => :'PaymentTokenization',
+        :'payment_token' => :'PaymentTokenDetails',
         :'payment_card' => :'PaymentCard'
       }
     end
@@ -156,17 +156,12 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @response_type.nil?
-        invalid_properties.push('invalid value for "response_type", response_type 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 @response_type.nil?
       request_status_validator = EnumAttributeValidator.new('String', ['DELETED', 'FAILED', 'SUCCESS', 'APPROVED', 'WAITING', 'VALIDATION_FAILED', 'DECLINED'])
       return false unless request_status_validator.valid?(@request_status)
       true

data/lib/openapi_client/models/payment_url_error_response.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -26,10 +26,10 @@ module OpenapiClient
     # Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.
     attr_accessor :request_status
 
-    # Client Order ID if supplied by client, otherwise the Order ID.
+    # Client order ID if supplied by client, otherwise the order ID.
     attr_accessor :order_id
 
-    # URL for embedded payment link
+    # URL for embedded payment link.
     attr_accessor :payment_url
 
     # ID code from the transaction.
@@ -132,17 +132,12 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @response_type.nil?
-        invalid_properties.push('invalid value for "response_type", response_type 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 @response_type.nil?
       request_status_validator = EnumAttributeValidator.new('String', ['SUCCESS', 'VALIDATION_FAILED', 'PROCESSING_FAILED', 'FAILURE'])
       return false unless request_status_validator.valid?(@request_status)
       true

data/lib/openapi_client/models/payment_url_request.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -20,18 +20,18 @@ module OpenapiClient
 
     attr_accessor :client_locale
 
-    attr_accessor :amount
+    attr_accessor :transaction_amount
 
     attr_accessor :transaction_type
 
-    # Client Order ID if supplied by client, otherwise the Order ID.
+    # Client order ID if supplied by client, otherwise the order ID.
     attr_accessor :order_id
 
     attr_accessor :billing
 
     attr_accessor :shipping
 
-    # URL for notifying merchant with payment result.
+    # URL for notifying merchant of payment result.
     attr_accessor :transaction_notification_url
 
     # Time until payment URL expires.
@@ -57,7 +57,7 @@ module OpenapiClient
       {
         :'store_id' => :'storeId',
         :'client_locale' => :'clientLocale',
-        :'amount' => :'amount',
+        :'transaction_amount' => :'transactionAmount',
         :'transaction_type' => :'transactionType',
         :'order_id' => :'orderId',
         :'billing' => :'billing',
@@ -77,7 +77,7 @@ module OpenapiClient
       {
         :'store_id' => :'String',
         :'client_locale' => :'ClientLocale',
-        :'amount' => :'Amount',
+        :'transaction_amount' => :'Amount',
         :'transaction_type' => :'TransactionType',
         :'order_id' => :'String',
         :'billing' => :'Billing',
@@ -108,8 +108,8 @@ module OpenapiClient
         self.client_locale = attributes[:'clientLocale']
       end
 
-      if attributes.has_key?(:'amount')
-        self.amount = attributes[:'amount']
+      if attributes.has_key?(:'transactionAmount')
+        self.transaction_amount = attributes[:'transactionAmount']
       end
 
       if attributes.has_key?(:'transactionType')
@@ -165,10 +165,6 @@ module OpenapiClient
         invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.')
       end
 
-      if @amount.nil?
-        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
-      end
-
       if @transaction_type.nil?
         invalid_properties.push('invalid value for "transaction_type", transaction_type cannot be nil.')
       end
@@ -180,7 +176,6 @@ module OpenapiClient
     # @return true if the model is valid
     def valid?
       return false if !@store_id.nil? && @store_id.to_s.length > 20
-      return false if @amount.nil?
       return false if @transaction_type.nil?
       true
     end
@@ -202,7 +197,7 @@ module OpenapiClient
       self.class == o.class &&
           store_id == o.store_id &&
           client_locale == o.client_locale &&
-          amount == o.amount &&
+          transaction_amount == o.transaction_amount &&
           transaction_type == o.transaction_type &&
           order_id == o.order_id &&
           billing == o.billing &&
@@ -225,7 +220,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [store_id, client_locale, amount, transaction_type, order_id, billing, shipping, transaction_notification_url, expiration, authenticate_transaction, dynamic_merchant_name, invoice_number, purchase_order_number, ip].hash
+      [store_id, client_locale, transaction_amount, transaction_type, order_id, billing, shipping, transaction_notification_url, expiration, authenticate_transaction, dynamic_merchant_name, invoice_number, purchase_order_number, ip].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/payment_url_response.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -26,10 +26,10 @@ module OpenapiClient
     # Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.
     attr_accessor :request_status
 
-    # Client Order ID if supplied by client, otherwise the Order ID.
+    # Client order ID if supplied by client, otherwise the order ID.
     attr_accessor :order_id
 
-    # URL for embedded payment link
+    # URL for embedded payment link.
     attr_accessor :payment_url
 
     # ID code from the transaction.
@@ -124,17 +124,12 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @response_type.nil?
-        invalid_properties.push('invalid value for "response_type", response_type 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 @response_type.nil?
       request_status_validator = EnumAttributeValidator.new('String', ['SUCCESS', 'VALIDATION_FAILED', 'PROCESSING_FAILED', 'FAILURE'])
       return false unless request_status_validator.valid?(@request_status)
       true

data/lib/openapi_client/models/payment_verification3ds.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -15,13 +15,13 @@ require 'date'
 module OpenapiClient
   # The result of the 3DS (3D Secure) check.
   class PaymentVerification3ds
-    # 3DS Response Code. This field is required if the parent object is present.
+    # 3DS response code.
     attr_accessor :code
 
-    # Interpretation of the Response Code.
+    # Interpretation of the response code.
     attr_accessor :status
 
-    # Identifier of the Scheme. This field is required if the parent object is present.
+    # Identifier of the scheme.
     attr_accessor :scheme
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/payment_verification_avs.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -15,13 +15,13 @@ require 'date'
 module OpenapiClient
   # The result of the AVS (Address Verification System) check.
   class PaymentVerificationAvs
-    # AVS Response Code. This field is required if the parent object is present.
+    # AVS response code.
     attr_accessor :code
 
-    # Interpretation of the Response Code.
+    # Interpretation of the response code.
     attr_accessor :status
 
-    # Identifier of the Scheme. This field is required if the parent object is present.
+    # Identifier of the scheme.
     attr_accessor :scheme
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/payment_verification_cvv.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -15,13 +15,13 @@ require 'date'
 module OpenapiClient
   # The result of the CVV (Card Verification Value, or Card Security Code) check.
   class PaymentVerificationCvv
-    # CVV Response Code. This field is required if the parent object is present.
+    # CVV response code.
     attr_accessor :code
 
-    # Interpretation of the Response Code.
+    # Interpretation of the response code.
     attr_accessor :status
 
-    # Identifier of the Scheme. This field is required if the parent object is present.
+    # Identifier of the scheme.
     attr_accessor :scheme
 
     # Attribute mapping from ruby-style variable name to JSON key.