first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/expiration.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,12 +13,12 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Required for normal transactions except for payment with 'RECURRING' flags
+  # Required for normal transactions except for payment with 'RECURRING' flags.
   class Expiration
-    # Month of the card expiration date
+    # Month of the card expiration date.
     attr_accessor :month
 
-    # Year of the card expiration date
+    # Year of the card expiration date.
     attr_accessor :year
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/fraud_order.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

data/lib/openapi_client/models/fraud_order_items.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,6 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
+  # Product details.
   class FraudOrderItems
     # A unique ID associated with the product. Must be unique within the merchant's system.
     attr_accessor :id
@@ -35,6 +36,7 @@ module OpenapiClient
     # The URL to the merchant's management system, for reporting and analysis.
     attr_accessor :details_url
 
+    # A JSON object that can carry any additional information about the order that might be helpful for fraud detection.
     attr_accessor :user_defined
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/fraud_order_ship_to_address.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,22 +18,22 @@ module OpenapiClient
     # Free-form phone number associated with the ship-to address.
     attr_accessor :phone
 
-    # Street Address 1. This field is required if the parent object is present.
+    # First line of street address.
     attr_accessor :address1
 
-    # Street Address 2.
+    # Second line of street address.
     attr_accessor :address2
 
-    # City
+    # City.
     attr_accessor :city
 
-    # State or Province
+    # State or province.
     attr_accessor :state
 
-    # Postal Code, free form. This field is required if the parent object is present.
+    # Postal Code, free form.
     attr_accessor :zip
 
-    # Country. This field is required if the parent object is present.
+    # Country.
     attr_accessor :country
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/frequency.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,12 +13,12 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # How often payments are sent
+  # How often payments are sent.
   class Frequency
-    # Rate of frequency
+    # Rate of frequency.
     attr_accessor :every
 
-    # Unit which defines the frequency
+    # Unit which defines the frequency.
     attr_accessor :unit
 
     class EnumAttributeValidator

data/lib/openapi_client/models/industry_specific_extensions.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,7 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Model for Industry Specific information
+  # Industry-specific information.
   class IndustrySpecificExtensions
     attr_accessor :airline
 

data/lib/openapi_client/models/installment_options.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,21 +15,51 @@ require 'date'
 module OpenapiClient
   # Indicates that the total sum payable is divided for payment at successive fixed times.
   class InstallmentOptions
-    # Number of installments for a Sale transaction if the customer pays the total amount in multiple transactions
+    # Number of installments for a sale transaction if the customer pays the total amount in multiple transactions.
     attr_accessor :number_of_installments
 
-    # Indicates whether the installment interest amount has been applied. Possible values are \"yes\" or \"no\".
+    # Indicates whether the installment interest amount has been applied.
     attr_accessor :installments_interest
 
-    # The number of months the first installment payment will be delayed
+    # The number of months the first installment payment will be delayed.
     attr_accessor :installment_delay_months
 
+    # The type of recurring payment.
+    attr_accessor :recurring_type
+
+    # Indicates if the merchant supports merchant advice code (MAC) in order to receive table 55 code for a declined recurring transaction.
+    attr_accessor :merchant_advice_code_supported
+
+    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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'number_of_installments' => :'numberOfInstallments',
         :'installments_interest' => :'installmentsInterest',
-        :'installment_delay_months' => :'installmentDelayMonths'
+        :'installment_delay_months' => :'installmentDelayMonths',
+        :'recurring_type' => :'recurringType',
+        :'merchant_advice_code_supported' => :'merchantAdviceCodeSupported'
       }
     end
 
@@ -38,7 +68,9 @@ module OpenapiClient
       {
         :'number_of_installments' => :'Integer',
         :'installments_interest' => :'BOOLEAN',
-        :'installment_delay_months' => :'Integer'
+        :'installment_delay_months' => :'Integer',
+        :'recurring_type' => :'String',
+        :'merchant_advice_code_supported' => :'BOOLEAN'
       }
     end
 
@@ -61,6 +93,14 @@ module OpenapiClient
       if attributes.has_key?(:'installmentDelayMonths')
         self.installment_delay_months = attributes[:'installmentDelayMonths']
       end
+
+      if attributes.has_key?(:'recurringType')
+        self.recurring_type = attributes[:'recurringType']
+      end
+
+      if attributes.has_key?(:'merchantAdviceCodeSupported')
+        self.merchant_advice_code_supported = attributes[:'merchantAdviceCodeSupported']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,6 +133,8 @@ module OpenapiClient
       return false if !@number_of_installments.nil? && @number_of_installments < 1
       return false if !@installment_delay_months.nil? && @installment_delay_months > 99
       return false if !@installment_delay_months.nil? && @installment_delay_months < 1
+      recurring_type_validator = EnumAttributeValidator.new('String', ['FIRST', 'REPEAT', 'STANDING_INSTRUCTION'])
+      return false unless recurring_type_validator.valid?(@recurring_type)
       true
     end
 
@@ -124,6 +166,16 @@ module OpenapiClient
       @installment_delay_months = installment_delay_months
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] recurring_type Object to be assigned
+    def recurring_type=(recurring_type)
+      validator = EnumAttributeValidator.new('String', ['FIRST', 'REPEAT', 'STANDING_INSTRUCTION'])
+      unless validator.valid?(recurring_type)
+        fail ArgumentError, 'invalid value for "recurring_type", must be one of #{validator.allowable_values}.'
+      end
+      @recurring_type = recurring_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -131,7 +183,9 @@ module OpenapiClient
       self.class == o.class &&
           number_of_installments == o.number_of_installments &&
           installments_interest == o.installments_interest &&
-          installment_delay_months == o.installment_delay_months
+          installment_delay_months == o.installment_delay_months &&
+          recurring_type == o.recurring_type &&
+          merchant_advice_code_supported == o.merchant_advice_code_supported
     end
 
     # @see the `==` method
@@ -143,7 +197,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [number_of_installments, installments_interest, installment_delay_months].hash
+      [number_of_installments, installments_interest, installment_delay_months, recurring_type, merchant_advice_code_supported].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/lodging.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,21 +13,21 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Additional data specific to the lodging/hotel industry
+  # Additional data specific to the lodging/hotel industry.
   class Lodging
-    # Date of arrival
+    # Date of arrival.
     attr_accessor :arrival_date
 
-    # Date of departure
+    # Date of departure.
     attr_accessor :departure_date
 
-    # Portfolio number
+    # Portfolio number.
     attr_accessor :folio_number
 
-    # Information about charges other than base lodging
+    # Information about charges other than base lodging.
     attr_accessor :extra_charges
 
-    # Indicates if the transaction is associated with a delayed or no-show penalty
+    # Indicates if the transaction is associated with a delayed or no-show penalty.
     attr_accessor :no_show_indicator
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/lodging_extra_charges.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

data/lib/openapi_client/models/loyalty.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

data/lib/openapi_client/models/merchant.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

data/lib/openapi_client/models/merchant_location.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

data/lib/openapi_client/models/merchant_location_merchant_address.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,24 +13,24 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Info for the Merchant Address.
+  # Info for the merchant address.
   class MerchantLocationMerchantAddress
-    # Merchant Street Address 1. This field is required if the parent object is present.
+    # First line of street address.
     attr_accessor :street
 
-    # Merchant Street Address 2
+    # Second line of street address.
     attr_accessor :street2
 
-    # Merchant State
+    # Merchant state or provinceu.
     attr_accessor :state_province
 
-    # Merchant City
+    # Merchant city.
     attr_accessor :city
 
-    # Merchant Country.
+    # Merchant country.
     attr_accessor :country
 
-    # Merchant Zip Code.
+    # Merchant ZIP code.
     attr_accessor :zip_postal_code
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/order.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,7 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Model for Orders
+  # Use this model to provide order related details.
   class Order
     # Client Order ID if supplied by client.
     attr_accessor :order_id
@@ -22,12 +22,27 @@ module OpenapiClient
 
     attr_accessor :shipping
 
+    attr_accessor :industry_specific_extensions
+
+    attr_accessor :purchase_card
+
+    attr_accessor :installment_options
+
+    attr_accessor :soft_descriptor
+
+    attr_accessor :additional_details
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'order_id' => :'orderId',
         :'billing' => :'billing',
-        :'shipping' => :'shipping'
+        :'shipping' => :'shipping',
+        :'industry_specific_extensions' => :'industrySpecificExtensions',
+        :'purchase_card' => :'purchaseCard',
+        :'installment_options' => :'installmentOptions',
+        :'soft_descriptor' => :'softDescriptor',
+        :'additional_details' => :'additionalDetails'
       }
     end
 
@@ -36,7 +51,12 @@ module OpenapiClient
       {
         :'order_id' => :'String',
         :'billing' => :'Billing',
-        :'shipping' => :'Shipping'
+        :'shipping' => :'Shipping',
+        :'industry_specific_extensions' => :'IndustrySpecificExtensions',
+        :'purchase_card' => :'PurchaseCards',
+        :'installment_options' => :'InstallmentOptions',
+        :'soft_descriptor' => :'SoftDescriptor',
+        :'additional_details' => :'AdditionalDetails'
       }
     end
 
@@ -59,6 +79,26 @@ module OpenapiClient
       if attributes.has_key?(:'shipping')
         self.shipping = attributes[:'shipping']
       end
+
+      if attributes.has_key?(:'industrySpecificExtensions')
+        self.industry_specific_extensions = attributes[:'industrySpecificExtensions']
+      end
+
+      if attributes.has_key?(:'purchaseCard')
+        self.purchase_card = attributes[:'purchaseCard']
+      end
+
+      if attributes.has_key?(:'installmentOptions')
+        self.installment_options = attributes[:'installmentOptions']
+      end
+
+      if attributes.has_key?(:'softDescriptor')
+        self.soft_descriptor = attributes[:'softDescriptor']
+      end
+
+      if attributes.has_key?(:'additionalDetails')
+        self.additional_details = attributes[:'additionalDetails']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -96,7 +136,12 @@ module OpenapiClient
       self.class == o.class &&
           order_id == o.order_id &&
           billing == o.billing &&
-          shipping == o.shipping
+          shipping == o.shipping &&
+          industry_specific_extensions == o.industry_specific_extensions &&
+          purchase_card == o.purchase_card &&
+          installment_options == o.installment_options &&
+          soft_descriptor == o.soft_descriptor &&
+          additional_details == o.additional_details
     end
 
     # @see the `==` method
@@ -108,7 +153,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [order_id, billing, shipping].hash
+      [order_id, billing, shipping, industry_specific_extensions, purchase_card, installment_options, soft_descriptor, additional_details].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/order_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
@@ -23,13 +23,10 @@ module OpenapiClient
 
     attr_accessor :response_type
 
-    # The response transaction ID
-    attr_accessor :ipg_transaction_id
-
-    # 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
 
-    # The transaction time in seconds since Epoch
+    # The transaction time in seconds since epoch.
     attr_accessor :transaction_time
 
     attr_accessor :billing
@@ -38,7 +35,7 @@ module OpenapiClient
 
     attr_accessor :mandate
 
-    # Required for some payment methods (for example, Klarna)
+    # Required for some payment methods (for example, Klarna).
     attr_accessor :transactions
 
     attr_accessor :processor
@@ -51,7 +48,6 @@ module OpenapiClient
         :'client_request_id' => :'clientRequestId',
         :'api_trace_id' => :'apiTraceId',
         :'response_type' => :'responseType',
-        :'ipg_transaction_id' => :'ipgTransactionId',
         :'order_id' => :'orderId',
         :'transaction_time' => :'transactionTime',
         :'billing' => :'billing',
@@ -69,7 +65,6 @@ module OpenapiClient
         :'client_request_id' => :'String',
         :'api_trace_id' => :'String',
         :'response_type' => :'ResponseType',
-        :'ipg_transaction_id' => :'String',
         :'order_id' => :'String',
         :'transaction_time' => :'Integer',
         :'billing' => :'Billing',
@@ -101,10 +96,6 @@ module OpenapiClient
         self.response_type = attributes[:'responseType']
       end
 
-      if attributes.has_key?(:'ipgTransactionId')
-        self.ipg_transaction_id = attributes[:'ipgTransactionId']
-      end
-
       if attributes.has_key?(:'orderId')
         self.order_id = attributes[:'orderId']
       end
@@ -144,17 +135,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?
       true
     end
 
@@ -166,7 +152,6 @@ module OpenapiClient
           client_request_id == o.client_request_id &&
           api_trace_id == o.api_trace_id &&
           response_type == o.response_type &&
-          ipg_transaction_id == o.ipg_transaction_id &&
           order_id == o.order_id &&
           transaction_time == o.transaction_time &&
           billing == o.billing &&
@@ -186,7 +171,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [client_request_id, api_trace_id, response_type, ipg_transaction_id, order_id, transaction_time, billing, shipping, mandate, transactions, processor, error].hash
+      [client_request_id, api_trace_id, response_type, order_id, transaction_time, billing, shipping, mandate, transactions, processor, error].hash
     end
 
     # Builds the object from hash