visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/purchase_options1.rb

@@ -0,0 +1,114 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PurchaseOptions1 Model.
+  class PurchaseOptions1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This field contains installment data defined by MasterCard.
+    # Possible values:
+    #   - Y = eligible
+    #   - N = not eligile
+    # @return [String]
+    attr_accessor :eligibility_indicator
+
+    # Data mapped received in response from MasterCard.
+    # Possible values:
+    # - 01 = Meal Voucher - Employee Nutrition Program
+    # - 02 = Food Voucher - Employee Nutrition Program
+    # - 03 = Culture Voucher - Worker's Culture Program
+    # - 04 = Meal Voucher - Consolidation of Labor Laws
+    # - 05 = Food Voucher - Consolidation of Labor Laws
+    # @return [String]
+    attr_accessor :type
+
+    # Workplace benefit amount.
+    # @return [String]
+    attr_accessor :benefit_amount
+
+    # Workplace benefit type.
+    # Possible values:
+    # - 70 = employee benefit
+    # - 4T = transportation / transit
+    # - 52 = general benefit
+    # - 53 = meal voucher
+    # - 54 = fuel
+    # - 55 = ecological / sustainability
+    # - 58 = philanthropy / patronage / consumption
+    # - 59 = gift
+    # - 5S = sport / culture
+    # - 5T = book / education
+    # @return [String]
+    attr_accessor :benefit_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['eligibility_indicator'] = 'eligibilityIndicator'
+      @_hash['type'] = 'type'
+      @_hash['benefit_amount'] = 'benefitAmount'
+      @_hash['benefit_type'] = 'benefitType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        eligibility_indicator
+        type
+        benefit_amount
+        benefit_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(eligibility_indicator = SKIP, type = SKIP,
+                   benefit_amount = SKIP, benefit_type = SKIP)
+      @eligibility_indicator = eligibility_indicator unless eligibility_indicator == SKIP
+      @type = type unless type == SKIP
+      @benefit_amount = benefit_amount unless benefit_amount == SKIP
+      @benefit_type = benefit_type unless benefit_type == 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.
+      eligibility_indicator =
+        hash.key?('eligibilityIndicator') ? hash['eligibilityIndicator'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      benefit_amount = hash.key?('benefitAmount') ? hash['benefitAmount'] : SKIP
+      benefit_type = hash.key?('benefitType') ? hash['benefitType'] : SKIP
+
+      # Create object from extracted values.
+      PurchaseOptions1.new(eligibility_indicator,
+                           type,
+                           benefit_amount,
+                           benefit_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} eligibility_indicator: #{@eligibility_indicator}, type: #{@type},"\
+      " benefit_amount: #{@benefit_amount}, benefit_type: #{@benefit_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} eligibility_indicator: #{@eligibility_indicator.inspect}, type:"\
+      " #{@type.inspect}, benefit_amount: #{@benefit_amount.inspect}, benefit_type:"\
+      " #{@benefit_type.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/purchase_options2.rb

@@ -0,0 +1,74 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PurchaseOptions2 Model.
+  class PurchaseOptions2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Flag that indicates whether this transaction is an EBT transaction.
+    # Possible values:
+    # - `true`
+    # - `false`
+    # #### PIN debit
+    # Required field for EBT and EBT voucher transactions that use PIN debit
+    # credit or PIN debit purchase; otherwise, not used.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_electronic_benefits_transfer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_electronic_benefits_transfer'] =
+        'isElectronicBenefitsTransfer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_electronic_benefits_transfer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(is_electronic_benefits_transfer = SKIP)
+      unless is_electronic_benefits_transfer == SKIP
+        @is_electronic_benefits_transfer =
+          is_electronic_benefits_transfer
+      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.
+      is_electronic_benefits_transfer =
+        hash.key?('isElectronicBenefitsTransfer') ? hash['isElectronicBenefitsTransfer'] : SKIP
+
+      # Create object from extracted values.
+      PurchaseOptions2.new(is_electronic_benefits_transfer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_electronic_benefits_transfer: #{@is_electronic_benefits_transfer}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_electronic_benefits_transfer:"\
+      " #{@is_electronic_benefits_transfer.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/raw_datum.rb

@@ -0,0 +1,75 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # RawDatum Model.
+  class RawDatum < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Field that contains the device fingerprint data from the specified
+    # provider. The value should be Base64 encoded.
+    # @return [String]
+    attr_accessor :data
+
+    # Possible values:
+    # - cardinal
+    # - inauth
+    # - threatmetrix
+    # @return [String]
+    attr_accessor :provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['provider'] = 'provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        provider
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP, provider = SKIP)
+      @data = data unless data == SKIP
+      @provider = provider unless provider == 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.
+      data = hash.key?('data') ? hash['data'] : SKIP
+      provider = hash.key?('provider') ? hash['provider'] : SKIP
+
+      # Create object from extracted values.
+      RawDatum.new(data,
+                   provider)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, provider: #{@provider}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, provider: #{@provider.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/reason_enum.rb

@@ -0,0 +1,62 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Reason.
+  class ReasonEnum
+    REASON_ENUM = [
+      # TODO: Write general description for INVALID_APIKEY
+      INVALID_APIKEY = 'INVALID_APIKEY'.freeze,
+
+      # TODO: Write general description for INVALID_SHIPPING_INPUT_PARAMS
+      INVALID_SHIPPING_INPUT_PARAMS = 'INVALID_SHIPPING_INPUT_PARAMS'.freeze,
+
+      # TODO: Write general description for CAPTURE_CONTEXT_INVALID
+      CAPTURE_CONTEXT_INVALID = 'CAPTURE_CONTEXT_INVALID'.freeze,
+
+      # TODO: Write general description for CAPTURE_CONTEXT_EXPIRED
+      CAPTURE_CONTEXT_EXPIRED = 'CAPTURE_CONTEXT_EXPIRED'.freeze,
+
+      # TODO: Write general description for SDK_XHR_ERROR
+      SDK_XHR_ERROR = 'SDK_XHR_ERROR'.freeze,
+
+      # TODO: Write general description for UNIFIEDPAYMENTS_VALIDATION_PARAMS
+      UNIFIEDPAYMENTS_VALIDATION_PARAMS = 'UNIFIEDPAYMENTS_VALIDATION_PARAMS'.freeze,
+
+      # TODO: Write general description for UNIFIEDPAYMENTS_VALIDATION_FIELDS
+      UNIFIEDPAYMENTS_VALIDATION_FIELDS = 'UNIFIEDPAYMENTS_VALIDATION_FIELDS'.freeze,
+
+      # TODO: Write general description for UNIFIEDPAYMENT_PAYMENT_PARAMITERS
+      UNIFIEDPAYMENT_PAYMENT_PARAMITERS = 'UNIFIEDPAYMENT_PAYMENT_PARAMITERS'.freeze,
+
+      # TODO: Write general description for CREATE_TOKEN_TIMEOUT
+      CREATE_TOKEN_TIMEOUT = 'CREATE_TOKEN_TIMEOUT'.freeze,
+
+      # TODO: Write general description for CREATE_TOKEN_XHR_ERROR
+      CREATE_TOKEN_XHR_ERROR = 'CREATE_TOKEN_XHR_ERROR'.freeze,
+
+      # TODO: Write general description for SHOW_LOAD_CONTAINER_SELECTOR
+      SHOW_LOAD_CONTAINER_SELECTOR = 'SHOW_LOAD_CONTAINER_SELECTOR'.freeze,
+
+      # TODO: Write general description for SHOW_LOAD_INVALID_CONTAINER
+      SHOW_LOAD_INVALID_CONTAINER = 'SHOW_LOAD_INVALID_CONTAINER'.freeze,
+
+      # TODO: Write general description for SHOW_TOKEN_TIMEOUT
+      SHOW_TOKEN_TIMEOUT = 'SHOW_TOKEN_TIMEOUT'.freeze,
+
+      # TODO: Write general description for SHOW_TOKEN_XHR_ERROR
+      SHOW_TOKEN_XHR_ERROR = 'SHOW_TOKEN_XHR_ERROR'.freeze,
+
+      # TODO: Write general description for SHOW_PAYMENT_TIMEOUT
+      SHOW_PAYMENT_TIMEOUT = 'SHOW_PAYMENT_TIMEOUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_ENUM.include?(value)
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/recipient_information.rb

@@ -0,0 +1,302 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # RecipientInformation Model.
+  class RecipientInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for the recipient’s account.
+    # This field is applicable for AFT transactions.
+    # @return [String]
+    attr_accessor :account_id
+
+    # Identifies the recipient’s account type.
+    # This field is applicable for AFT transactions.
+    # Valid values are:
+    #   - `00` for Other
+    #   - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN)
+    #   - `02` for International Bank Account Number (IBAN)
+    #   - `03` for Card Account
+    #   - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC),
+    # also known as a SWIFT code
+    # @return [String]
+    attr_accessor :account_type
+
+    # First name of the recipient.
+    # This field is applicable for AFT transactions.  
+    # Only alpha numeric values are supported. Special characters not in the
+    # standard ASCII character set, are not supported and will be stripped
+    # before being sent to sent to the processor.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Middle name of the recipient.
+    # This field is applicable for AFT transactions.
+    # Only alpha numeric values are supported. Special characters not in the
+    # standard ASCII character set, are not supported and will be stripped
+    # before being sent to sent to the processor.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Last name of the recipient.
+    # This field is applicable for AFT transactions.
+    # Only alpha numeric values are supported. Special characters not in the
+    # standard ASCII character set, are not supported and will be stripped
+    # before being sent to sent to the processor.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The street address of the recipient
+    # This field is applicable for AFT and OCT transactions.
+    # Only alpha numeric values are supported. Special characters not in the
+    # standard ASCII character set are not supported and will be stripped before
+    # being sent to sent to the processor.
+    # @return [String]
+    attr_accessor :address1
+
+    # The state or province of the recipient.
+    # This field is applicable for AFT transactions when the recipient country
+    # is US or CA. Else it is optional.
+    # Must be a two character value
+    # @return [String]
+    attr_accessor :administrative_area
+
+    # Partial postal code for the recipient’s address. For example, if the
+    # postal code is **NN5 7SG**, the value for
+    # this field should be the first part of the postal code: **NN5**. This
+    # field is a _pass-through_, which means that
+    # Visa Acceptance does not verify the value or modify it in any way before
+    # sending it to the processor. If the field
+    # is not required for the transaction, Visa Acceptance does not forward it
+    # to the processor.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The country associated with the address of the recipient.
+    # This field is applicable for AFT and OCT transactions.
+    # Must be a two character ISO country code. 
+    # For example, see [ISO Country Code](
+    # @return [String]
+    attr_accessor :country
+
+    # Recipient’s date of birth. **Format**: `YYYYMMDD`.
+    # This field is a `pass-through`, which means that Visa Acceptance ensures
+    # that the value is eight numeric characters
+    # but otherwise does not verify the value or modify it in any way before
+    # sending it to the processor. If the field
+    # is not required for the transaction, Visa Acceptance does not forward it
+    # to the processor.
+    # @return [String]
+    attr_accessor :date_of_birth
+
+    # Only for e-wallets: ID, username, hash or anything uniquely identifying
+    # the ultimate beneficiary.
+    # @return [String]
+    attr_accessor :beneficiary_id
+
+    # Only for e-wallets: The ultimate beneficiary’s full name.
+    # @return [String]
+    attr_accessor :beneficiary_name
+
+    # Only for e-wallets: The ultimate beneficiary’s street address (street,
+    # zip code, city), excluding the country. Example: “Main street 1, 12345,
+    # Barcelona
+    # @return [String]
+    attr_accessor :beneficiary_address
+
+    # Account owner alias name.
+    # @return [String]
+    attr_accessor :alias_name
+
+    # Account Owner Nationality
+    # @return [String]
+    attr_accessor :nationality
+
+    # Account Owner Country of Birth
+    # @return [String]
+    attr_accessor :country_of_birth
+
+    # Account Owner Occupation
+    # @return [String]
+    attr_accessor :occupation
+
+    # Account Owner email address
+    # @return [String]
+    attr_accessor :email
+
+    # The city of the recipient.
+    # This field is applicable for AFT transactions.
+    # Only alpha numeric values are supported.
+    # Special characters not in the standard ASCII character set are not
+    # supported and will be stripped before being sent to sent to the processor.
+    # @return [String]
+    attr_accessor :locality
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['account_type'] = 'accountType'
+      @_hash['first_name'] = 'firstName'
+      @_hash['middle_name'] = 'middleName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['address1'] = 'address1'
+      @_hash['administrative_area'] = 'administrativeArea'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['beneficiary_id'] = 'beneficiaryId'
+      @_hash['beneficiary_name'] = 'beneficiaryName'
+      @_hash['beneficiary_address'] = 'beneficiaryAddress'
+      @_hash['alias_name'] = 'aliasName'
+      @_hash['nationality'] = 'nationality'
+      @_hash['country_of_birth'] = 'countryOfBirth'
+      @_hash['occupation'] = 'occupation'
+      @_hash['email'] = 'email'
+      @_hash['locality'] = 'locality'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_type
+        first_name
+        middle_name
+        last_name
+        address1
+        administrative_area
+        postal_code
+        country
+        date_of_birth
+        beneficiary_id
+        beneficiary_name
+        beneficiary_address
+        alias_name
+        nationality
+        country_of_birth
+        occupation
+        email
+        locality
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = SKIP, account_type = SKIP, first_name = SKIP,
+                   middle_name = SKIP, last_name = SKIP, address1 = SKIP,
+                   administrative_area = SKIP, postal_code = SKIP,
+                   country = SKIP, date_of_birth = SKIP, beneficiary_id = SKIP,
+                   beneficiary_name = SKIP, beneficiary_address = SKIP,
+                   alias_name = SKIP, nationality = SKIP,
+                   country_of_birth = SKIP, occupation = SKIP, email = SKIP,
+                   locality = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @address1 = address1 unless address1 == SKIP
+      @administrative_area = administrative_area unless administrative_area == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @beneficiary_id = beneficiary_id unless beneficiary_id == SKIP
+      @beneficiary_name = beneficiary_name unless beneficiary_name == SKIP
+      @beneficiary_address = beneficiary_address unless beneficiary_address == SKIP
+      @alias_name = alias_name unless alias_name == SKIP
+      @nationality = nationality unless nationality == SKIP
+      @country_of_birth = country_of_birth unless country_of_birth == SKIP
+      @occupation = occupation unless occupation == SKIP
+      @email = email unless email == SKIP
+      @locality = locality unless locality == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      middle_name = hash.key?('middleName') ? hash['middleName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      administrative_area =
+        hash.key?('administrativeArea') ? hash['administrativeArea'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      beneficiary_id = hash.key?('beneficiaryId') ? hash['beneficiaryId'] : SKIP
+      beneficiary_name =
+        hash.key?('beneficiaryName') ? hash['beneficiaryName'] : SKIP
+      beneficiary_address =
+        hash.key?('beneficiaryAddress') ? hash['beneficiaryAddress'] : SKIP
+      alias_name = hash.key?('aliasName') ? hash['aliasName'] : SKIP
+      nationality = hash.key?('nationality') ? hash['nationality'] : SKIP
+      country_of_birth =
+        hash.key?('countryOfBirth') ? hash['countryOfBirth'] : SKIP
+      occupation = hash.key?('occupation') ? hash['occupation'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      locality = hash.key?('locality') ? hash['locality'] : SKIP
+
+      # Create object from extracted values.
+      RecipientInformation.new(account_id,
+                               account_type,
+                               first_name,
+                               middle_name,
+                               last_name,
+                               address1,
+                               administrative_area,
+                               postal_code,
+                               country,
+                               date_of_birth,
+                               beneficiary_id,
+                               beneficiary_name,
+                               beneficiary_address,
+                               alias_name,
+                               nationality,
+                               country_of_birth,
+                               occupation,
+                               email,
+                               locality)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, account_type: #{@account_type}, first_name:"\
+      " #{@first_name}, middle_name: #{@middle_name}, last_name: #{@last_name}, address1:"\
+      " #{@address1}, administrative_area: #{@administrative_area}, postal_code: #{@postal_code},"\
+      " country: #{@country}, date_of_birth: #{@date_of_birth}, beneficiary_id:"\
+      " #{@beneficiary_id}, beneficiary_name: #{@beneficiary_name}, beneficiary_address:"\
+      " #{@beneficiary_address}, alias_name: #{@alias_name}, nationality: #{@nationality},"\
+      " country_of_birth: #{@country_of_birth}, occupation: #{@occupation}, email: #{@email},"\
+      " locality: #{@locality}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, account_type: #{@account_type.inspect},"\
+      " first_name: #{@first_name.inspect}, middle_name: #{@middle_name.inspect}, last_name:"\
+      " #{@last_name.inspect}, address1: #{@address1.inspect}, administrative_area:"\
+      " #{@administrative_area.inspect}, postal_code: #{@postal_code.inspect}, country:"\
+      " #{@country.inspect}, date_of_birth: #{@date_of_birth.inspect}, beneficiary_id:"\
+      " #{@beneficiary_id.inspect}, beneficiary_name: #{@beneficiary_name.inspect},"\
+      " beneficiary_address: #{@beneficiary_address.inspect}, alias_name: #{@alias_name.inspect},"\
+      " nationality: #{@nationality.inspect}, country_of_birth: #{@country_of_birth.inspect},"\
+      " occupation: #{@occupation.inspect}, email: #{@email.inspect}, locality:"\
+      " #{@locality.inspect}>"
+    end
+  end
+end