visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/amount_details3.rb

@@ -0,0 +1,105 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails3 Model.
+  class AmountDetails3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Additional charges that have to be authorized against a lodging or
+    # auto-rental order.
+    # This value cannot be negative. You can include a decimal point (.), but no
+    # other special characters.
+    # @return [String]
+    attr_accessor :additional_amount
+
+    # Currency used for the order. Use the three-character [ISO Standard
+    # Currency Codes.](
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # **Authorization Reversal**
+    # For an authorization reversal (`reversalInformation`) or a capture
+    # (`processingOptions.capture` is set to `true`), you must use the same
+    # currency that you used in your payment authorization request.
+    # #### PIN Debit
+    # Currency for the amount you requested for the PIN debit purchase. This
+    # value is returned for partial authorizations. The issuing bank can approve
+    # a partial amount if the balance on the debit card is less than the
+    # requested transaction amount. For the possible values, see the [ISO
+    # Standard Currency Codes](
+    # Returned by PIN debit purchase.
+    # For PIN debit reversal requests, you must use the same currency that was
+    # used for the PIN debit purchase or PIN debit credit that you are
+    # reversing.
+    # For the possible values, see the [ISO Standard Currency Codes](
+    # Required field for PIN Debit purchase and PIN Debit credit requests.
+    # Optional field for PIN Debit reversal requests.
+    # #### GPX
+    # This field is optional for reversing an authorization or credit.
+    # #### DCC for First Data
+    # Your local currency.
+    # #### Tax Calculation
+    # Required for international tax and value added tax only.
+    # Optional for U.S. and Canadian taxes.
+    # Your local currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_amount'] = 'additionalAmount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_amount = SKIP, currency = SKIP)
+      @additional_amount = additional_amount unless additional_amount == SKIP
+      @currency = currency unless currency == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      additional_amount =
+        hash.key?('additionalAmount') ? hash['additionalAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails3.new(additional_amount,
+                         currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_amount: #{@additional_amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_amount: #{@additional_amount.inspect}, currency:"\
+      " #{@currency.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details32.rb

@@ -0,0 +1,142 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails32 Model.
+  class AmountDetails32 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Grand total for the order. This value cannot be negative. You can include
+    # a decimal point (.), but you cannot include any other special characters.
+    # Visa Acceptance truncates the amount to the correct number of decimal
+    # places
+    # @return [String]
+    attr_accessor :total_amount
+
+    # Currency used for the order
+    # @return [String]
+    attr_accessor :currency
+
+    # Discount amount for the transaction.
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # Aggregate shipping charges for the transactions.
+    # @return [String]
+    attr_accessor :shipping_amount
+
+    # Shipping discount amount for the transaction.
+    # @return [String]
+    attr_accessor :shipping_discount_amount
+
+    # Total tax amount.
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # Amount being charged for the insurance fee.
+    # @return [String]
+    attr_accessor :insurance_amount
+
+    # Amount being charged as duty amount.
+    # @return [String]
+    attr_accessor :duty_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['currency'] = 'currency'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash['shipping_amount'] = 'shippingAmount'
+      @_hash['shipping_discount_amount'] = 'shippingDiscountAmount'
+      @_hash['tax_amount'] = 'taxAmount'
+      @_hash['insurance_amount'] = 'insuranceAmount'
+      @_hash['duty_amount'] = 'dutyAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        currency
+        discount_amount
+        shipping_amount
+        shipping_discount_amount
+        tax_amount
+        insurance_amount
+        duty_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount = SKIP, currency = SKIP, discount_amount = SKIP,
+                   shipping_amount = SKIP, shipping_discount_amount = SKIP,
+                   tax_amount = SKIP, insurance_amount = SKIP,
+                   duty_amount = SKIP)
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency = currency unless currency == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @shipping_amount = shipping_amount unless shipping_amount == SKIP
+      @shipping_discount_amount = shipping_discount_amount unless shipping_discount_amount == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @insurance_amount = insurance_amount unless insurance_amount == SKIP
+      @duty_amount = duty_amount unless duty_amount == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : SKIP
+      shipping_amount =
+        hash.key?('shippingAmount') ? hash['shippingAmount'] : SKIP
+      shipping_discount_amount =
+        hash.key?('shippingDiscountAmount') ? hash['shippingDiscountAmount'] : SKIP
+      tax_amount = hash.key?('taxAmount') ? hash['taxAmount'] : SKIP
+      insurance_amount =
+        hash.key?('insuranceAmount') ? hash['insuranceAmount'] : SKIP
+      duty_amount = hash.key?('dutyAmount') ? hash['dutyAmount'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails32.new(total_amount,
+                          currency,
+                          discount_amount,
+                          shipping_amount,
+                          shipping_discount_amount,
+                          tax_amount,
+                          insurance_amount,
+                          duty_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount}, currency: #{@currency}, discount_amount:"\
+      " #{@discount_amount}, shipping_amount: #{@shipping_amount}, shipping_discount_amount:"\
+      " #{@shipping_discount_amount}, tax_amount: #{@tax_amount}, insurance_amount:"\
+      " #{@insurance_amount}, duty_amount: #{@duty_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount.inspect}, currency: #{@currency.inspect},"\
+      " discount_amount: #{@discount_amount.inspect}, shipping_amount:"\
+      " #{@shipping_amount.inspect}, shipping_discount_amount:"\
+      " #{@shipping_discount_amount.inspect}, tax_amount: #{@tax_amount.inspect},"\
+      " insurance_amount: #{@insurance_amount.inspect}, duty_amount: #{@duty_amount.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details35.rb

@@ -0,0 +1,198 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails35 Model.
+  class AmountDetails35 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Grand total for the order. This value cannot be negative. You can include
+    # a decimal point (.), but no other special characters.
+    # Visa Acceptance truncates the amount to the correct number of decimal
+    # places.
+    # **Note** For CTV, FDCCompass, Paymentech processors, the maximum length
+    # for this field is 12.
+    # **Important** Some processors have specific requirements and limitations,
+    # such as maximum amounts and maximum field lengths.
+    # If your processor supports zero amount authorizations, you can set this
+    # field to 0 for the authorization to check if the card is lost or stolen. 
+    # #### Card Present
+    # Required to include either this field or
+    # `orderInformation.lineItems[].unitPrice` for the order.
+    # #### Invoicing / Pay By Link
+    # Required for creating a new invoice or payment link.
+    # #### PIN Debit
+    # Amount you requested for the PIN debit purchase. This value is returned
+    # for partial authorizations. The issuing bank can approve a partial amount
+    # if the balance on the debit card is less than the requested transaction
+    # amount.
+    # Required field for PIN Debit purchase and PIN Debit credit requests.
+    # Optional field for PIN Debit reversal requests.
+    # #### GPX
+    # This field is optional for reversing an authorization or credit; however,
+    # for all other processors, these fields are required.
+    # #### DCC with a Third-Party Provider
+    # Set this field to the converted amount that was returned by the DCC
+    # provider. You must include either this field or the 1st line item in the
+    # order and the specific line-order amount in your request. 
+    # #### DCC for First Data
+    # Not used.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # Currency used for the order. Use the three-character [ISO Standard
+    # Currency Codes.](
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # **Authorization Reversal**
+    # For an authorization reversal (`reversalInformation`) or a capture
+    # (`processingOptions.capture` is set to `true`), you must use the same
+    # currency that you used in your payment authorization request.
+    # #### PIN Debit
+    # Currency for the amount you requested for the PIN debit purchase. This
+    # value is returned for partial authorizations. The issuing bank can approve
+    # a partial amount if the balance on the debit card is less than the
+    # requested transaction amount. For the possible values, see the [ISO
+    # Standard Currency Codes](
+    # Returned by PIN debit purchase.
+    # For PIN debit reversal requests, you must use the same currency that was
+    # used for the PIN debit purchase or PIN debit credit that you are
+    # reversing.
+    # For the possible values, see the [ISO Standard Currency Codes](
+    # Required field for PIN Debit purchase and PIN Debit credit requests.
+    # Optional field for PIN Debit reversal requests.
+    # #### GPX
+    # This field is optional for reversing an authorization or credit.
+    # #### DCC for First Data
+    # Your local currency.
+    # #### Tax Calculation
+    # Required for international tax and value added tax only.
+    # Optional for U.S. and Canadian taxes.
+    # Your local currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Total tax amount for all the items in the order.
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # Amount that was authorized.
+    # Returned by authorization service.
+    # #### PIN debit
+    # Amount of the purchase.
+    # Returned by PIN debit purchase.
+    # @return [String]
+    attr_accessor :authorized_amount
+
+    # This is a multicurrency field. It contains the transaction amount (field
+    # 4), converted to the Currency used to bill the cardholder’s account.
+    # This field is returned for OCT transactions.
+    # @return [String]
+    attr_accessor :settlement_amount
+
+    # This is a multicurrency-only field. It contains a 3-digit numeric code
+    # that identifies the currency used by the issuer to bill the cardholder's
+    # account.
+    # This field is returned for OCT transactions.
+    # @return [String]
+    attr_accessor :settlement_currency
+
+    # This is a multicurrency-only field. It contains a 3-digit numeric code
+    # that identifies the currency used by the issuer to bill the cardholder's
+    # account.
+    # This field is returned for OCT transactions.
+    # @return [Surcharge1]
+    attr_accessor :surcharge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['currency'] = 'currency'
+      @_hash['tax_amount'] = 'taxAmount'
+      @_hash['authorized_amount'] = 'authorizedAmount'
+      @_hash['settlement_amount'] = 'settlementAmount'
+      @_hash['settlement_currency'] = 'settlementCurrency'
+      @_hash['surcharge'] = 'surcharge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        currency
+        tax_amount
+        authorized_amount
+        settlement_amount
+        settlement_currency
+        surcharge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount = SKIP, currency = SKIP, tax_amount = SKIP,
+                   authorized_amount = SKIP, settlement_amount = SKIP,
+                   settlement_currency = SKIP, surcharge = SKIP)
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency = currency unless currency == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @authorized_amount = authorized_amount unless authorized_amount == SKIP
+      @settlement_amount = settlement_amount unless settlement_amount == SKIP
+      @settlement_currency = settlement_currency unless settlement_currency == SKIP
+      @surcharge = surcharge unless surcharge == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      tax_amount = hash.key?('taxAmount') ? hash['taxAmount'] : SKIP
+      authorized_amount =
+        hash.key?('authorizedAmount') ? hash['authorizedAmount'] : SKIP
+      settlement_amount =
+        hash.key?('settlementAmount') ? hash['settlementAmount'] : SKIP
+      settlement_currency =
+        hash.key?('settlementCurrency') ? hash['settlementCurrency'] : SKIP
+      surcharge = Surcharge1.from_hash(hash['surcharge']) if hash['surcharge']
+
+      # Create object from extracted values.
+      AmountDetails35.new(total_amount,
+                          currency,
+                          tax_amount,
+                          authorized_amount,
+                          settlement_amount,
+                          settlement_currency,
+                          surcharge)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount}, currency: #{@currency}, tax_amount:"\
+      " #{@tax_amount}, authorized_amount: #{@authorized_amount}, settlement_amount:"\
+      " #{@settlement_amount}, settlement_currency: #{@settlement_currency}, surcharge:"\
+      " #{@surcharge}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount.inspect}, currency: #{@currency.inspect},"\
+      " tax_amount: #{@tax_amount.inspect}, authorized_amount: #{@authorized_amount.inspect},"\
+      " settlement_amount: #{@settlement_amount.inspect}, settlement_currency:"\
+      " #{@settlement_currency.inspect}, surcharge: #{@surcharge.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details36.rb

@@ -0,0 +1,71 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails36 Model.
+  class AmountDetails36 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This field defines the total order amount.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # This field defines the currency applicable to the order.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount = SKIP, currency = SKIP)
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency = currency unless currency == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails36.new(total_amount,
+                          currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details5.rb

@@ -0,0 +1,130 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails5 Model.
+  class AmountDetails5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Grand total for the order. This value cannot be negative. You can include
+    # a decimal point (.), but no other special characters.
+    # Visa Acceptance truncates the amount to the correct number of decimal
+    # places.
+    # **Note** For CTV, FDCCompass, Paymentech processors, the maximum length
+    # for this field is 12.
+    # **Important** Some processors have specific requirements and limitations,
+    # such as maximum amounts and maximum field lengths.
+    # If your processor supports zero amount authorizations, you can set this
+    # field to 0 for the authorization to check if the card is lost or stolen. 
+    # #### Card Present
+    # Required to include either this field or
+    # `orderInformation.lineItems[].unitPrice` for the order.
+    # #### Invoicing / Pay By Link
+    # Required for creating a new invoice or payment link.
+    # #### PIN Debit
+    # Amount you requested for the PIN debit purchase. This value is returned
+    # for partial authorizations. The issuing bank can approve a partial amount
+    # if the balance on the debit card is less than the requested transaction
+    # amount.
+    # Required field for PIN Debit purchase and PIN Debit credit requests.
+    # Optional field for PIN Debit reversal requests.
+    # #### GPX
+    # This field is optional for reversing an authorization or credit; however,
+    # for all other processors, these fields are required.
+    # #### DCC with a Third-Party Provider
+    # Set this field to the converted amount that was returned by the DCC
+    # provider. You must include either this field or the 1st line item in the
+    # order and the specific line-order amount in your request. 
+    # #### DCC for First Data
+    # Not used.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # Currency used for the order. Use the three-character [ISO Standard
+    # Currency Codes.](
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # **Authorization Reversal**
+    # For an authorization reversal (`reversalInformation`) or a capture
+    # (`processingOptions.capture` is set to `true`), you must use the same
+    # currency that you used in your payment authorization request.
+    # #### PIN Debit
+    # Currency for the amount you requested for the PIN debit purchase. This
+    # value is returned for partial authorizations. The issuing bank can approve
+    # a partial amount if the balance on the debit card is less than the
+    # requested transaction amount. For the possible values, see the [ISO
+    # Standard Currency Codes](
+    # Returned by PIN debit purchase.
+    # For PIN debit reversal requests, you must use the same currency that was
+    # used for the PIN debit purchase or PIN debit credit that you are
+    # reversing.
+    # For the possible values, see the [ISO Standard Currency Codes](
+    # Required field for PIN Debit purchase and PIN Debit credit requests.
+    # Optional field for PIN Debit reversal requests.
+    # #### GPX
+    # This field is optional for reversing an authorization or credit.
+    # #### DCC for First Data
+    # Your local currency.
+    # #### Tax Calculation
+    # Required for international tax and value added tax only.
+    # Optional for U.S. and Canadian taxes.
+    # Your local currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount = SKIP, currency = SKIP)
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency = currency unless currency == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails5.new(total_amount,
+                         currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_amount: #{@total_amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end