fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/purchase.rb

@@ -0,0 +1,327 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Contains purchase information
+  class Purchase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the maximum number of authorizations permitted for installment
+    # payments.
+    # The fields is required if the Merchant and Cardholder have agreed to
+    # installment payments, i.e. if 3DS Requestor Authentication Indicator = 03.
+    # Omitted if not an installment payment authentication.
+    # Starting from EMV 3DS 2.3.1:
+    # Additionally this field is required for device_channel = 03 (3RI) if
+    # three_ri_ind = 02.
+    # @return [Integer]
+    attr_accessor :purchase_install_data
+
+    # Contains purchase information
+    # @return [MerchantRiskIndicator]
+    attr_accessor :merchant_risk_indicator
+
+    # Purchase amount in minor units of currency with all punctuation removed.
+    # When used in conjunction with the Purchase Currency Exponent field, proper
+    # punctuation can be calculated. Example: If the purchase amount is USD
+    # 123.45, element will contain the value 12345. The field is limited to
+    # maximum 48 characters.
+    # This field is required for 02-NPA message category if 3DS Requestor
+    # Authentication Indicator = 02 or 03. 
+    #  This field is always required for message_category = 01 (PA).  
+    # Starting from EMV 3DS 2.3.1:
+    # Additionally this field is required for message_category = 02-NPA if
+    # three_ri_ind = 01, 02, 06, 07, 08, 09, or 11.
+    # @return [Integer]
+    attr_accessor :purchase_amount
+
+    # Currency in which purchase amount is expressed. The value is limited to 3
+    # numeric characters and is represented by the ISO 4217 three-digit currency
+    # code, except 955-964 and 999.
+    # This field is always required for message_category = 01-PA.  
+    # It is required for message_category = 02-NPA if 3DS Requestor
+    # Authentication Indicator = 02 or 03.
+    # Starting from EMV 3DS 2.3.1:
+    # Additionally this field is required for message_category = 02-NPA if
+    # three_ri_ind = 01, 02, 06, 07, 08, 09, or 11.
+    # @return [String]
+    attr_accessor :purchase_currency
+
+    # Minor units of currency as specified in the ISO 4217 currency exponent.
+    # The field is limited to 1 character. 
+    # This field is always required for message_category = 01-PA.  
+    # It is required for message_category = 02-NPA if 3DS Requestor
+    # Authentication Indicator = 02 or 03. 
+    # Example: for currency USD the exponent should be 2, and for Yen the
+    # exponent should be 0.
+    # Starting from EMV 3DS 2.3.1:
+    # Additionally this field is required for message_category = 02-NPA if
+    # three_ri_ind = 01, 02, 06, 07, 08, 09, or 11.
+    # @return [Integer]
+    attr_accessor :purchase_exponent
+
+    # Date and time of the purchase, converted into UTC. The field is limited to
+    # 14 characters, formatted as YYYYMMDDHHMMSS.  
+    # This field is always required for message_category = 01-PA.  
+    # It is required for message_category = 02-NPA if 3DS Requestor
+    # Authentication Indicator = 02 or 03. 
+    # Starting from EMV 3DS 2.3.1:
+    # Additionally this field is required for message_category = 02-NPA if
+    # three_ri_ind = 01, 02, 06, 07, 08, 09, or 11.
+    # @return [String]
+    attr_accessor :purchase_date
+
+    # Date after which no further authorizations shall be performed. This field
+    # is limited to 8 characters, and the accepted format is YYYYMMDD.
+    # This field is required if 3DS Requestor Authentication Indicator = 02 or
+    # 03 and message_category = 01 or 02. Required if there is an end date.
+    # @return [String]
+    attr_accessor :recurring_expiry
+
+    # Indicates the minimum number of days between authorizations.
+    # This field is required if 3DS Requestor Authentication Indicator = 02 or
+    # 03 and frequency_ind = 01.
+    # @return [Integer]
+    attr_accessor :recurring_frequency
+
+    # Identifies the type of transaction being authenticated. The values are
+    # derived from ISO 8583. This field is required in some markets. Otherwise,
+    # the field is optional.
+    # >01 - Goods / Service purchase
+    # >
+    # >03 - Check Acceptance
+    # >
+    # >10 - Account Funding
+    # >
+    # >11 - Quasi-Cash Transaction
+    # >
+    # >28 - Prepaid activation and Loan
+    # >
+    # @return [TransactionTypeEnum]
+    attr_accessor :transaction_type
+
+    # Recurring amount after first/promotional payment in minor units of
+    # currency with all punctuation removed. Example: If the recurring amount is
+    # USD 123.45, element will contain the value 12345. The field is limited to
+    # maximum 48 characters.
+    # The field is required if three_ds_requestor_authentication_ind = 02 or 03
+    # AND three_ri_iInd = 01 or 02 AND amount_ind = 01.
+    # Available for supporting EMV 3DS 2.3.1 and later versions.
+    # @return [Integer]
+    attr_accessor :recurring_amount
+
+    # Currency in which recurring amount is expressed. The value is limited to 3
+    # numeric characters and is represented by the ISO 4217 three-digit currency
+    # code, except 955-964 and 999.
+    # This field is required if recurring_amount is present.
+    # Available for supporting EMV 3DS 2.3.1 and later versions.
+    # @return [String]
+    attr_accessor :recurring_currency
+
+    # Minor units of currency as specified in the ISO 4217 currency exponent.
+    # Example: USD = 2, Yen = 0. The value is limited to 1 numeric character.
+    # This field is required if recurring_amount is present.
+    # Available for supporting EMV 3DS 2.3.1 and later versions.
+    # @return [Integer]
+    attr_accessor :recurring_exponent
+
+    # Effective date of new authorized amount following first/promotional
+    # payment in recurring transaction. The value is limited to 8 characters.
+    # Accepted format: YYYYMMDD.
+    # This field is required if frequency_ind = 01.
+    # Available for supporting EMV 3DS 2.3.1 and later versions.
+    # @return [String]
+    attr_accessor :recurring_date
+
+    # Part of the indication whether the recurring or installment payment has a
+    # fixed or variable amount.
+    # Starting from EMV 3DS 2.3.1: 
+    #  This field is required if
+    # three_ds_requestor.three_ds_requestor_authentication_ind = 02 or 03. 
+    #  This field is required if three_ri_ind= 01 or 02.
+    # >01 - Fixed Purchase Amount
+    # >
+    # >02 - Variable Purchase Amount
+    # >
+    # >03 through 79 - Reserved for EMVCo future use (values invalid until
+    # defined by EMVCo)
+    # >
+    # >80 through 99 - PS-specific value (dependent on the payment scheme type)
+    # >
+    # @return [AmountIndEnum]
+    attr_accessor :amount_ind
+
+    # Part of the indication whether the recurring or instalment payment has a
+    # fixed or variable frequency.
+    # Starting from EMV 3DS 2.3.1: 
+    #  This field is required if
+    # three_ds_requestor.three_ds_requestor_authentication_ind = 02 or 03. 
+    #  This field is required if three_ri_ind= 01 or 02.
+    # @return [String]
+    attr_accessor :frequency_ind
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_install_data'] = 'purchase_install_data'
+      @_hash['merchant_risk_indicator'] = 'merchant_risk_indicator'
+      @_hash['purchase_amount'] = 'purchase_amount'
+      @_hash['purchase_currency'] = 'purchase_currency'
+      @_hash['purchase_exponent'] = 'purchase_exponent'
+      @_hash['purchase_date'] = 'purchase_date'
+      @_hash['recurring_expiry'] = 'recurring_expiry'
+      @_hash['recurring_frequency'] = 'recurring_frequency'
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['recurring_amount'] = 'recurring_amount'
+      @_hash['recurring_currency'] = 'recurring_currency'
+      @_hash['recurring_exponent'] = 'recurring_exponent'
+      @_hash['recurring_date'] = 'recurring_date'
+      @_hash['amount_ind'] = 'amount_ind'
+      @_hash['frequency_ind'] = 'frequency_ind'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purchase_install_data
+        merchant_risk_indicator
+        purchase_amount
+        purchase_currency
+        purchase_exponent
+        purchase_date
+        recurring_expiry
+        recurring_frequency
+        transaction_type
+        recurring_amount
+        recurring_currency
+        recurring_exponent
+        recurring_date
+        amount_ind
+        frequency_ind
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_install_data = SKIP, merchant_risk_indicator = SKIP,
+                   purchase_amount = SKIP, purchase_currency = SKIP,
+                   purchase_exponent = SKIP, purchase_date = SKIP,
+                   recurring_expiry = SKIP, recurring_frequency = SKIP,
+                   transaction_type = SKIP, recurring_amount = SKIP,
+                   recurring_currency = SKIP, recurring_exponent = SKIP,
+                   recurring_date = SKIP, amount_ind = SKIP,
+                   frequency_ind = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @purchase_install_data = purchase_install_data unless purchase_install_data == SKIP
+      @merchant_risk_indicator = merchant_risk_indicator unless merchant_risk_indicator == SKIP
+      @purchase_amount = purchase_amount unless purchase_amount == SKIP
+      @purchase_currency = purchase_currency unless purchase_currency == SKIP
+      @purchase_exponent = purchase_exponent unless purchase_exponent == SKIP
+      @purchase_date = purchase_date unless purchase_date == SKIP
+      @recurring_expiry = recurring_expiry unless recurring_expiry == SKIP
+      @recurring_frequency = recurring_frequency unless recurring_frequency == SKIP
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @recurring_amount = recurring_amount unless recurring_amount == SKIP
+      @recurring_currency = recurring_currency unless recurring_currency == SKIP
+      @recurring_exponent = recurring_exponent unless recurring_exponent == SKIP
+      @recurring_date = recurring_date unless recurring_date == SKIP
+      @amount_ind = amount_ind unless amount_ind == SKIP
+      @frequency_ind = frequency_ind unless frequency_ind == 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.
+      purchase_install_data =
+        hash.key?('purchase_install_data') ? hash['purchase_install_data'] : SKIP
+      merchant_risk_indicator = MerchantRiskIndicator.from_hash(hash['merchant_risk_indicator']) if
+        hash['merchant_risk_indicator']
+      purchase_amount =
+        hash.key?('purchase_amount') ? hash['purchase_amount'] : SKIP
+      purchase_currency =
+        hash.key?('purchase_currency') ? hash['purchase_currency'] : SKIP
+      purchase_exponent =
+        hash.key?('purchase_exponent') ? hash['purchase_exponent'] : SKIP
+      purchase_date = hash.key?('purchase_date') ? hash['purchase_date'] : SKIP
+      recurring_expiry =
+        hash.key?('recurring_expiry') ? hash['recurring_expiry'] : SKIP
+      recurring_frequency =
+        hash.key?('recurring_frequency') ? hash['recurring_frequency'] : SKIP
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      recurring_amount =
+        hash.key?('recurring_amount') ? hash['recurring_amount'] : SKIP
+      recurring_currency =
+        hash.key?('recurring_currency') ? hash['recurring_currency'] : SKIP
+      recurring_exponent =
+        hash.key?('recurring_exponent') ? hash['recurring_exponent'] : SKIP
+      recurring_date =
+        hash.key?('recurring_date') ? hash['recurring_date'] : SKIP
+      amount_ind = hash.key?('amount_ind') ? hash['amount_ind'] : SKIP
+      frequency_ind = hash.key?('frequency_ind') ? hash['frequency_ind'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Purchase.new(purchase_install_data,
+                   merchant_risk_indicator,
+                   purchase_amount,
+                   purchase_currency,
+                   purchase_exponent,
+                   purchase_date,
+                   recurring_expiry,
+                   recurring_frequency,
+                   transaction_type,
+                   recurring_amount,
+                   recurring_currency,
+                   recurring_exponent,
+                   recurring_date,
+                   amount_ind,
+                   frequency_ind,
+                   additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_install_data: #{@purchase_install_data}, merchant_risk_indicator:"\
+      " #{@merchant_risk_indicator}, purchase_amount: #{@purchase_amount}, purchase_currency:"\
+      " #{@purchase_currency}, purchase_exponent: #{@purchase_exponent}, purchase_date:"\
+      " #{@purchase_date}, recurring_expiry: #{@recurring_expiry}, recurring_frequency:"\
+      " #{@recurring_frequency}, transaction_type: #{@transaction_type}, recurring_amount:"\
+      " #{@recurring_amount}, recurring_currency: #{@recurring_currency}, recurring_exponent:"\
+      " #{@recurring_exponent}, recurring_date: #{@recurring_date}, amount_ind: #{@amount_ind},"\
+      " frequency_ind: #{@frequency_ind}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_install_data: #{@purchase_install_data.inspect},"\
+      " merchant_risk_indicator: #{@merchant_risk_indicator.inspect}, purchase_amount:"\
+      " #{@purchase_amount.inspect}, purchase_currency: #{@purchase_currency.inspect},"\
+      " purchase_exponent: #{@purchase_exponent.inspect}, purchase_date:"\
+      " #{@purchase_date.inspect}, recurring_expiry: #{@recurring_expiry.inspect},"\
+      " recurring_frequency: #{@recurring_frequency.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}, recurring_amount: #{@recurring_amount.inspect},"\
+      " recurring_currency: #{@recurring_currency.inspect}, recurring_exponent:"\
+      " #{@recurring_exponent.inspect}, recurring_date: #{@recurring_date.inspect}, amount_ind:"\
+      " #{@amount_ind.inspect}, frequency_ind: #{@frequency_ind.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end