visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/amount_details1.rb

@@ -0,0 +1,92 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails1 Model.
+  class AmountDetails1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total amount that has been spent on healthcare in a transaction.
+    # Valid Values for **Visa**:
+    # - `healthcare` - Total Amount Healthcare
+    # - `healthcare-transit` - Amount Transit
+    # - `vision` - Amount Vision/Optical
+    # - `prescription` - Amount Prescription/RX
+    # - `clinic` - Amount Clinic/Other Qualified Medical
+    # - `dental` - Amount Dental
+    # `Note:` -  Prescription, Clinic and dental amounts must be preceded with
+    # the total healthcare amount and cannot occur individually.  Vision and
+    # Transit must be sent individually and cannot be combined with total
+    # healthcare amount or any other amounts. Total Healthcare amount can be
+    # sent individually.
+    # Valid Values for **MasterCard**:
+    # - `prescription` - Amount Prescription/RX
+    # - `eligible-total` - Total Amount Healthcare
+    # `Note:` -  Prescription must be preceded with the total healthcare amount
+    # and cannot occur individually. Total Healthcare amount can be sent
+    # individually.
+    # @return [String]
+    attr_accessor :amount_type
+
+    # Total Amount that has been spent on the corresponding amountType. This is
+    # 13 byte field including sign.
+    # If the amount is positive, then it is a debit for the customer.
+    # If the amount is negative, then it is a credit for the customer.
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount_type'] = 'amountType'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount_type
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount_type = SKIP, amount = SKIP)
+      @amount_type = amount_type unless amount_type == SKIP
+      @amount = amount unless 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.
+      amount_type = hash.key?('amountType') ? hash['amountType'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails1.new(amount_type,
+                         amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_type: #{@amount_type}, amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_type: #{@amount_type.inspect}, amount: #{@amount.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details10.rb

@@ -0,0 +1,116 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails10 Model.
+  class AmountDetails10 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount you requested for the capture.
+    # @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
+
+    # The fee decided by the PSP/Processor per transaction.
+    # @return [String]
+    attr_accessor :processor_transaction_fee
+
+    # 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['processor_transaction_fee'] = 'processorTransactionFee'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        currency
+        processor_transaction_fee
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount = SKIP, currency = SKIP,
+                   processor_transaction_fee = SKIP)
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency = currency unless currency == SKIP
+      unless processor_transaction_fee == SKIP
+        @processor_transaction_fee =
+          processor_transaction_fee
+      end
+    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
+      processor_transaction_fee =
+        hash.key?('processorTransactionFee') ? hash['processorTransactionFee'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails10.new(total_amount,
+                          currency,
+                          processor_transaction_fee)
+    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},"\
+      " processor_transaction_fee: #{@processor_transaction_fee}>"
+    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},"\
+      " processor_transaction_fee: #{@processor_transaction_fee.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details12.rb

@@ -0,0 +1,115 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails12 Model.
+  class AmountDetails12 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # Exchange rate returned by the DCC service. Includes a decimal point and a
+    # maximum of 4 decimal places.
+    # @return [String]
+    attr_accessor :exchange_rate
+
+    # Set this field to the converted amount that was returned by the DCC
+    # provider.
+    # @return [String]
+    attr_accessor :foreign_amount
+
+    # Set this field to the converted amount that was returned by the DCC
+    # provider.
+    # @return [String]
+    attr_accessor :foreign_currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['settlement_amount'] = 'settlementAmount'
+      @_hash['settlement_currency'] = 'settlementCurrency'
+      @_hash['exchange_rate'] = 'exchangeRate'
+      @_hash['foreign_amount'] = 'foreignAmount'
+      @_hash['foreign_currency'] = 'foreignCurrency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        settlement_amount
+        settlement_currency
+        exchange_rate
+        foreign_amount
+        foreign_currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(settlement_amount = SKIP, settlement_currency = SKIP,
+                   exchange_rate = SKIP, foreign_amount = SKIP,
+                   foreign_currency = SKIP)
+      @settlement_amount = settlement_amount unless settlement_amount == SKIP
+      @settlement_currency = settlement_currency unless settlement_currency == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @foreign_amount = foreign_amount unless foreign_amount == SKIP
+      @foreign_currency = foreign_currency unless foreign_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.
+      settlement_amount =
+        hash.key?('settlementAmount') ? hash['settlementAmount'] : SKIP
+      settlement_currency =
+        hash.key?('settlementCurrency') ? hash['settlementCurrency'] : SKIP
+      exchange_rate = hash.key?('exchangeRate') ? hash['exchangeRate'] : SKIP
+      foreign_amount = hash.key?('foreignAmount') ? hash['foreignAmount'] : SKIP
+      foreign_currency =
+        hash.key?('foreignCurrency') ? hash['foreignCurrency'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails12.new(settlement_amount,
+                          settlement_currency,
+                          exchange_rate,
+                          foreign_amount,
+                          foreign_currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} settlement_amount: #{@settlement_amount}, settlement_currency:"\
+      " #{@settlement_currency}, exchange_rate: #{@exchange_rate}, foreign_amount:"\
+      " #{@foreign_amount}, foreign_currency: #{@foreign_currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} settlement_amount: #{@settlement_amount.inspect}, settlement_currency:"\
+      " #{@settlement_currency.inspect}, exchange_rate: #{@exchange_rate.inspect}, foreign_amount:"\
+      " #{@foreign_amount.inspect}, foreign_currency: #{@foreign_currency.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details2.rb

@@ -0,0 +1,241 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails2 Model.
+  class AmountDetails2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount you requested for the payment or capture.
+    # This value is returned for partial authorizations.
+    # This field is also returned on incremental authorizations will contain the
+    # aggregated amount from the original authorizations and all the incremental
+    # authorizations.
+    # @return [String]
+    attr_accessor :total_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
+
+    # 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
+
+    # 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
+
+    # Amount in your original local pricing currency.
+    # This value cannot be negative. You can include a decimal point (.) in this
+    # field to denote the currency
+    # exponent, but you cannot include any other special characters.
+    # If needed, Visa Acceptance truncates the amount to the correct number of
+    # decimal places.
+    # @return [String]
+    attr_accessor :original_amount
+
+    # Your local pricing currency code.
+    # For the possible values, see the [ISO Standard Currency Codes.](
+    # @return [String]
+    attr_accessor :original_currency
+
+    # Amount up to N digit after the decimals separator as defined in ISO 4217
+    # for the appropriate currency code.
+    # @return [String]
+    attr_accessor :processor_transaction_fee
+
+    # The rate of conversion of the currency given in the request to CNY. The
+    # conversion happens at the time when Alipay’s trade order is created
+    # @return [String]
+    attr_accessor :exchange_rate
+
+    # Currency code for the transaction performed in cross border currency.
+    # @return [String]
+    attr_accessor :foreign_currency
+
+    # The transaction amount in CNY.
+    # @return [String]
+    attr_accessor :foreign_amount
+
+    # If coupons/vouchers are used in the transaction, the discount amount
+    # redeemed in the settlement currency will be returned. Otherwise, no
+    # return.
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['authorized_amount'] = 'authorizedAmount'
+      @_hash['currency'] = 'currency'
+      @_hash['settlement_amount'] = 'settlementAmount'
+      @_hash['settlement_currency'] = 'settlementCurrency'
+      @_hash['original_amount'] = 'originalAmount'
+      @_hash['original_currency'] = 'originalCurrency'
+      @_hash['processor_transaction_fee'] = 'processorTransactionFee'
+      @_hash['exchange_rate'] = 'exchangeRate'
+      @_hash['foreign_currency'] = 'foreignCurrency'
+      @_hash['foreign_amount'] = 'foreignAmount'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        authorized_amount
+        currency
+        settlement_amount
+        settlement_currency
+        original_amount
+        original_currency
+        processor_transaction_fee
+        exchange_rate
+        foreign_currency
+        foreign_amount
+        discount_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount = SKIP, authorized_amount = SKIP,
+                   currency = SKIP, settlement_amount = SKIP,
+                   settlement_currency = SKIP, original_amount = SKIP,
+                   original_currency = SKIP, processor_transaction_fee = SKIP,
+                   exchange_rate = SKIP, foreign_currency = SKIP,
+                   foreign_amount = SKIP, discount_amount = SKIP)
+      @total_amount = total_amount unless total_amount == SKIP
+      @authorized_amount = authorized_amount unless authorized_amount == SKIP
+      @currency = currency unless currency == SKIP
+      @settlement_amount = settlement_amount unless settlement_amount == SKIP
+      @settlement_currency = settlement_currency unless settlement_currency == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @original_currency = original_currency unless original_currency == SKIP
+      unless processor_transaction_fee == SKIP
+        @processor_transaction_fee =
+          processor_transaction_fee
+      end
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @foreign_currency = foreign_currency unless foreign_currency == SKIP
+      @foreign_amount = foreign_amount unless foreign_amount == SKIP
+      @discount_amount = discount_amount unless discount_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
+      authorized_amount =
+        hash.key?('authorizedAmount') ? hash['authorizedAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      settlement_amount =
+        hash.key?('settlementAmount') ? hash['settlementAmount'] : SKIP
+      settlement_currency =
+        hash.key?('settlementCurrency') ? hash['settlementCurrency'] : SKIP
+      original_amount =
+        hash.key?('originalAmount') ? hash['originalAmount'] : SKIP
+      original_currency =
+        hash.key?('originalCurrency') ? hash['originalCurrency'] : SKIP
+      processor_transaction_fee =
+        hash.key?('processorTransactionFee') ? hash['processorTransactionFee'] : SKIP
+      exchange_rate = hash.key?('exchangeRate') ? hash['exchangeRate'] : SKIP
+      foreign_currency =
+        hash.key?('foreignCurrency') ? hash['foreignCurrency'] : SKIP
+      foreign_amount = hash.key?('foreignAmount') ? hash['foreignAmount'] : SKIP
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails2.new(total_amount,
+                         authorized_amount,
+                         currency,
+                         settlement_amount,
+                         settlement_currency,
+                         original_amount,
+                         original_currency,
+                         processor_transaction_fee,
+                         exchange_rate,
+                         foreign_currency,
+                         foreign_amount,
+                         discount_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}, authorized_amount: #{@authorized_amount},"\
+      " currency: #{@currency}, settlement_amount: #{@settlement_amount}, settlement_currency:"\
+      " #{@settlement_currency}, original_amount: #{@original_amount}, original_currency:"\
+      " #{@original_currency}, processor_transaction_fee: #{@processor_transaction_fee},"\
+      " exchange_rate: #{@exchange_rate}, foreign_currency: #{@foreign_currency}, foreign_amount:"\
+      " #{@foreign_amount}, discount_amount: #{@discount_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}, authorized_amount:"\
+      " #{@authorized_amount.inspect}, currency: #{@currency.inspect}, settlement_amount:"\
+      " #{@settlement_amount.inspect}, settlement_currency: #{@settlement_currency.inspect},"\
+      " original_amount: #{@original_amount.inspect}, original_currency:"\
+      " #{@original_currency.inspect}, processor_transaction_fee:"\
+      " #{@processor_transaction_fee.inspect}, exchange_rate: #{@exchange_rate.inspect},"\
+      " foreign_currency: #{@foreign_currency.inspect}, foreign_amount:"\
+      " #{@foreign_amount.inspect}, discount_amount: #{@discount_amount.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/amount_details22.rb

@@ -0,0 +1,62 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # AmountDetails22 Model.
+  class AmountDetails22 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This field will carry the remaning amount which can be refunded.
+    # @return [String]
+    attr_accessor :refund_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['refund_balance'] = 'refundBalance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        refund_balance
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refund_balance = SKIP)
+      @refund_balance = refund_balance unless refund_balance == 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.
+      refund_balance = hash.key?('refundBalance') ? hash['refundBalance'] : SKIP
+
+      # Create object from extracted values.
+      AmountDetails22.new(refund_balance)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} refund_balance: #{@refund_balance}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} refund_balance: #{@refund_balance.inspect}>"
+    end
+  end
+end