visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/payment_information.rb

@@ -0,0 +1,494 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # PaymentInformation Model.
+  class PaymentInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Card]
+    attr_accessor :card
+
+    # TODO: Write general description for this method
+    # @return [TokenizedCard]
+    attr_accessor :tokenized_card
+
+    # TODO: Write general description for this method
+    # @return [TokenizedPaymentMethod]
+    attr_accessor :tokenized_payment_method
+
+    # TODO: Write general description for this method
+    # @return [DirectDebit]
+    attr_accessor :direct_debit
+
+    # TODO: Write general description for this method
+    # @return [FluidData]
+    attr_accessor :fluid_data
+
+    # TODO: Write general description for this method
+    # @return [Customer]
+    attr_accessor :customer
+
+    # TODO: Write general description for this method
+    # @return [PaymentInstrument]
+    attr_accessor :payment_instrument
+
+    # TODO: Write general description for this method
+    # @return [InstrumentIdentifier]
+    attr_accessor :instrument_identifier
+
+    # TODO: Write general description for this method
+    # @return [ShippingAddress]
+    attr_accessor :shipping_address
+
+    # TODO: Write general description for this method
+    # @return [LegacyToken]
+    attr_accessor :legacy_token
+
+    # TODO: Write general description for this method
+    # @return [Bank]
+    attr_accessor :bank
+
+    # TODO: Write general description for this method
+    # @return [Options]
+    attr_accessor :options
+
+    # TODO: Write general description for this method
+    # @return [PaymentType]
+    attr_accessor :payment_type
+
+    # Mastercard-defined code that indicates how the account information was
+    # obtained.
+    # - `00`: Card
+    # - `01`: Mobile Network Operator (MNO) controlled removable secure element
+    # (SIM or UICC) personalized for use with a mobile phone or smartphone
+    # - `02`: Key fob
+    # - `03`: Watch using a contactless chip or a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `04`: Mobile tag
+    # - `05`: Wristband
+    # - `06`: Mobile phone case or sleeve
+    # - `07`: Mobile phone or smartphone with a fixed (non-removable) secure
+    # element controlled by the MNO,for example, code division multiple access
+    # (CDMA)
+    # - `08`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized forused with a mobile phone or smartphone
+    # - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `10`: MNO controlled removable secure element (SIM or UICC) personalized
+    # for use with a tablet or e-book
+    # - `11`: Tablet or e-book with a fixed (non-removable) secure element
+    # controlled by the MNO
+    # - `12`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized foruse with a tablet or e-book
+    # - `13`: Tablet or e-book with fixed (non-removable) secure element not
+    # controlled by the MNO
+    # - `14`: Mobile phone or smartphone with a payment application running in a
+    # host processor
+    # - `15`: Tablet or e-book with a payment application running in a host
+    # processor
+    # - `16`: Mobile phone or smartphone with a payment application running in
+    # the Trusted ExecutionEnvironment (TEE) of a host processor
+    # - `17`: Tablet or e-book with a payment application running in the TEE of
+    # a host processor
+    # - `18`: Watch with a payment application running in the TEE of a host
+    # processor
+    # - `19`: Watch with a payment application running in a host processor
+    # Values from 20–99 exclusively indicate the form factor only without also
+    # indicating the storage technology
+    # - `20`: Card
+    # - `21`: Phone e.g. Mobile Phone
+    # - `22`: Tablet/e-reader
+    # - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band,
+    # smart strap, disposable band, watch add-on, and security/ID band
+    # - `24`: Sticker
+    # - `25`: PC
+    # - `26`: Device Peripheral e.g. mobile phone case or sleeve
+    # - `27`: Tag e.g. key fob or mobile tag
+    # - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links
+    # - `29`: Fashion Accessory e.g. handbag, bag charm and glasses
+    # - `30`: Garment e.g. dress
+    # - `31`: Domestic Appliance e.g refrigerator, washing machine
+    # - `32`: Vehicle e.g. vehicle, including vehicle attached devices
+    # - `33`: Media/Gaming Device e.g. media or gaming device, including a set
+    # top box, media player and television
+    # 34–99 are reserved for future form factors. Any value in this range may
+    # occur within form factor and transaction data without prior notice.
+    # This field is supported only for Mastercard on Visa Acceptance through
+    # VisaNet.
+    # When initiation channel is not provided via this API field, the value is
+    # extracted from EMV tag 9F6E for Mastercard transactions. To enable this
+    # feature please call support.
+    # #### Used by
+    # **Authorization**
+    # Optional field.
+    # @return [String]
+    attr_accessor :initiation_channel
+
+    # Mastercard-defined code that indicates how the account information was
+    # obtained.
+    # - `00`: Card
+    # - `01`: Mobile Network Operator (MNO) controlled removable secure element
+    # (SIM or UICC) personalized for use with a mobile phone or smartphone
+    # - `02`: Key fob
+    # - `03`: Watch using a contactless chip or a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `04`: Mobile tag
+    # - `05`: Wristband
+    # - `06`: Mobile phone case or sleeve
+    # - `07`: Mobile phone or smartphone with a fixed (non-removable) secure
+    # element controlled by the MNO,for example, code division multiple access
+    # (CDMA)
+    # - `08`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized forused with a mobile phone or smartphone
+    # - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `10`: MNO controlled removable secure element (SIM or UICC) personalized
+    # for use with a tablet or e-book
+    # - `11`: Tablet or e-book with a fixed (non-removable) secure element
+    # controlled by the MNO
+    # - `12`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized foruse with a tablet or e-book
+    # - `13`: Tablet or e-book with fixed (non-removable) secure element not
+    # controlled by the MNO
+    # - `14`: Mobile phone or smartphone with a payment application running in a
+    # host processor
+    # - `15`: Tablet or e-book with a payment application running in a host
+    # processor
+    # - `16`: Mobile phone or smartphone with a payment application running in
+    # the Trusted ExecutionEnvironment (TEE) of a host processor
+    # - `17`: Tablet or e-book with a payment application running in the TEE of
+    # a host processor
+    # - `18`: Watch with a payment application running in the TEE of a host
+    # processor
+    # - `19`: Watch with a payment application running in a host processor
+    # Values from 20–99 exclusively indicate the form factor only without also
+    # indicating the storage technology
+    # - `20`: Card
+    # - `21`: Phone e.g. Mobile Phone
+    # - `22`: Tablet/e-reader
+    # - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band,
+    # smart strap, disposable band, watch add-on, and security/ID band
+    # - `24`: Sticker
+    # - `25`: PC
+    # - `26`: Device Peripheral e.g. mobile phone case or sleeve
+    # - `27`: Tag e.g. key fob or mobile tag
+    # - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links
+    # - `29`: Fashion Accessory e.g. handbag, bag charm and glasses
+    # - `30`: Garment e.g. dress
+    # - `31`: Domestic Appliance e.g refrigerator, washing machine
+    # - `32`: Vehicle e.g. vehicle, including vehicle attached devices
+    # - `33`: Media/Gaming Device e.g. media or gaming device, including a set
+    # top box, media player and television
+    # 34–99 are reserved for future form factors. Any value in this range may
+    # occur within form factor and transaction data without prior notice.
+    # This field is supported only for Mastercard on Visa Acceptance through
+    # VisaNet.
+    # When initiation channel is not provided via this API field, the value is
+    # extracted from EMV tag 9F6E for Mastercard transactions. To enable this
+    # feature please call support.
+    # #### Used by
+    # **Authorization**
+    # Optional field.
+    # @return [Sepa]
+    attr_accessor :sepa
+
+    # Mastercard-defined code that indicates how the account information was
+    # obtained.
+    # - `00`: Card
+    # - `01`: Mobile Network Operator (MNO) controlled removable secure element
+    # (SIM or UICC) personalized for use with a mobile phone or smartphone
+    # - `02`: Key fob
+    # - `03`: Watch using a contactless chip or a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `04`: Mobile tag
+    # - `05`: Wristband
+    # - `06`: Mobile phone case or sleeve
+    # - `07`: Mobile phone or smartphone with a fixed (non-removable) secure
+    # element controlled by the MNO,for example, code division multiple access
+    # (CDMA)
+    # - `08`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized forused with a mobile phone or smartphone
+    # - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `10`: MNO controlled removable secure element (SIM or UICC) personalized
+    # for use with a tablet or e-book
+    # - `11`: Tablet or e-book with a fixed (non-removable) secure element
+    # controlled by the MNO
+    # - `12`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized foruse with a tablet or e-book
+    # - `13`: Tablet or e-book with fixed (non-removable) secure element not
+    # controlled by the MNO
+    # - `14`: Mobile phone or smartphone with a payment application running in a
+    # host processor
+    # - `15`: Tablet or e-book with a payment application running in a host
+    # processor
+    # - `16`: Mobile phone or smartphone with a payment application running in
+    # the Trusted ExecutionEnvironment (TEE) of a host processor
+    # - `17`: Tablet or e-book with a payment application running in the TEE of
+    # a host processor
+    # - `18`: Watch with a payment application running in the TEE of a host
+    # processor
+    # - `19`: Watch with a payment application running in a host processor
+    # Values from 20–99 exclusively indicate the form factor only without also
+    # indicating the storage technology
+    # - `20`: Card
+    # - `21`: Phone e.g. Mobile Phone
+    # - `22`: Tablet/e-reader
+    # - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band,
+    # smart strap, disposable band, watch add-on, and security/ID band
+    # - `24`: Sticker
+    # - `25`: PC
+    # - `26`: Device Peripheral e.g. mobile phone case or sleeve
+    # - `27`: Tag e.g. key fob or mobile tag
+    # - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links
+    # - `29`: Fashion Accessory e.g. handbag, bag charm and glasses
+    # - `30`: Garment e.g. dress
+    # - `31`: Domestic Appliance e.g refrigerator, washing machine
+    # - `32`: Vehicle e.g. vehicle, including vehicle attached devices
+    # - `33`: Media/Gaming Device e.g. media or gaming device, including a set
+    # top box, media player and television
+    # 34–99 are reserved for future form factors. Any value in this range may
+    # occur within form factor and transaction data without prior notice.
+    # This field is supported only for Mastercard on Visa Acceptance through
+    # VisaNet.
+    # When initiation channel is not provided via this API field, the value is
+    # extracted from EMV tag 9F6E for Mastercard transactions. To enable this
+    # feature please call support.
+    # #### Used by
+    # **Authorization**
+    # Optional field.
+    # @return [EWallet]
+    attr_accessor :e_wallet
+
+    # Mastercard-defined code that indicates how the account information was
+    # obtained.
+    # - `00`: Card
+    # - `01`: Mobile Network Operator (MNO) controlled removable secure element
+    # (SIM or UICC) personalized for use with a mobile phone or smartphone
+    # - `02`: Key fob
+    # - `03`: Watch using a contactless chip or a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `04`: Mobile tag
+    # - `05`: Wristband
+    # - `06`: Mobile phone case or sleeve
+    # - `07`: Mobile phone or smartphone with a fixed (non-removable) secure
+    # element controlled by the MNO,for example, code division multiple access
+    # (CDMA)
+    # - `08`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized forused with a mobile phone or smartphone
+    # - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure
+    # element not controlled by the MNO
+    # - `10`: MNO controlled removable secure element (SIM or UICC) personalized
+    # for use with a tablet or e-book
+    # - `11`: Tablet or e-book with a fixed (non-removable) secure element
+    # controlled by the MNO
+    # - `12`: Removable secure element not controlled by the MNO, for example,
+    # memory card personalized foruse with a tablet or e-book
+    # - `13`: Tablet or e-book with fixed (non-removable) secure element not
+    # controlled by the MNO
+    # - `14`: Mobile phone or smartphone with a payment application running in a
+    # host processor
+    # - `15`: Tablet or e-book with a payment application running in a host
+    # processor
+    # - `16`: Mobile phone or smartphone with a payment application running in
+    # the Trusted ExecutionEnvironment (TEE) of a host processor
+    # - `17`: Tablet or e-book with a payment application running in the TEE of
+    # a host processor
+    # - `18`: Watch with a payment application running in the TEE of a host
+    # processor
+    # - `19`: Watch with a payment application running in a host processor
+    # Values from 20–99 exclusively indicate the form factor only without also
+    # indicating the storage technology
+    # - `20`: Card
+    # - `21`: Phone e.g. Mobile Phone
+    # - `22`: Tablet/e-reader
+    # - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band,
+    # smart strap, disposable band, watch add-on, and security/ID band
+    # - `24`: Sticker
+    # - `25`: PC
+    # - `26`: Device Peripheral e.g. mobile phone case or sleeve
+    # - `27`: Tag e.g. key fob or mobile tag
+    # - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links
+    # - `29`: Fashion Accessory e.g. handbag, bag charm and glasses
+    # - `30`: Garment e.g. dress
+    # - `31`: Domestic Appliance e.g refrigerator, washing machine
+    # - `32`: Vehicle e.g. vehicle, including vehicle attached devices
+    # - `33`: Media/Gaming Device e.g. media or gaming device, including a set
+    # top box, media player and television
+    # 34–99 are reserved for future form factors. Any value in this range may
+    # occur within form factor and transaction data without prior notice.
+    # This field is supported only for Mastercard on Visa Acceptance through
+    # VisaNet.
+    # When initiation channel is not provided via this API field, the value is
+    # extracted from EMV tag 9F6E for Mastercard transactions. To enable this
+    # feature please call support.
+    # #### Used by
+    # **Authorization**
+    # Optional field.
+    # @return [PaymentAccountReference]
+    attr_accessor :payment_account_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['tokenized_card'] = 'tokenizedCard'
+      @_hash['tokenized_payment_method'] = 'tokenizedPaymentMethod'
+      @_hash['direct_debit'] = 'directDebit'
+      @_hash['fluid_data'] = 'fluidData'
+      @_hash['customer'] = 'customer'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['instrument_identifier'] = 'instrumentIdentifier'
+      @_hash['shipping_address'] = 'shippingAddress'
+      @_hash['legacy_token'] = 'legacyToken'
+      @_hash['bank'] = 'bank'
+      @_hash['options'] = 'options'
+      @_hash['payment_type'] = 'paymentType'
+      @_hash['initiation_channel'] = 'initiationChannel'
+      @_hash['sepa'] = 'sepa'
+      @_hash['e_wallet'] = 'eWallet'
+      @_hash['payment_account_reference'] = 'paymentAccountReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        tokenized_card
+        tokenized_payment_method
+        direct_debit
+        fluid_data
+        customer
+        payment_instrument
+        instrument_identifier
+        shipping_address
+        legacy_token
+        bank
+        options
+        payment_type
+        initiation_channel
+        sepa
+        e_wallet
+        payment_account_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card = SKIP, tokenized_card = SKIP,
+                   tokenized_payment_method = SKIP, direct_debit = SKIP,
+                   fluid_data = SKIP, customer = SKIP,
+                   payment_instrument = SKIP, instrument_identifier = SKIP,
+                   shipping_address = SKIP, legacy_token = SKIP, bank = SKIP,
+                   options = SKIP, payment_type = SKIP,
+                   initiation_channel = SKIP, sepa = SKIP, e_wallet = SKIP,
+                   payment_account_reference = SKIP)
+      @card = card unless card == SKIP
+      @tokenized_card = tokenized_card unless tokenized_card == SKIP
+      @tokenized_payment_method = tokenized_payment_method unless tokenized_payment_method == SKIP
+      @direct_debit = direct_debit unless direct_debit == SKIP
+      @fluid_data = fluid_data unless fluid_data == SKIP
+      @customer = customer unless customer == SKIP
+      @payment_instrument = payment_instrument unless payment_instrument == SKIP
+      @instrument_identifier = instrument_identifier unless instrument_identifier == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @legacy_token = legacy_token unless legacy_token == SKIP
+      @bank = bank unless bank == SKIP
+      @options = options unless options == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @initiation_channel = initiation_channel unless initiation_channel == SKIP
+      @sepa = sepa unless sepa == SKIP
+      @e_wallet = e_wallet unless e_wallet == SKIP
+      unless payment_account_reference == SKIP
+        @payment_account_reference =
+          payment_account_reference
+      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.
+      card = Card.from_hash(hash['card']) if hash['card']
+      tokenized_card = TokenizedCard.from_hash(hash['tokenizedCard']) if hash['tokenizedCard']
+      tokenized_payment_method = TokenizedPaymentMethod.from_hash(hash['tokenizedPaymentMethod']) if
+        hash['tokenizedPaymentMethod']
+      direct_debit = DirectDebit.from_hash(hash['directDebit']) if hash['directDebit']
+      fluid_data = FluidData.from_hash(hash['fluidData']) if hash['fluidData']
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
+      payment_instrument = PaymentInstrument.from_hash(hash['paymentInstrument']) if
+        hash['paymentInstrument']
+      instrument_identifier = InstrumentIdentifier.from_hash(hash['instrumentIdentifier']) if
+        hash['instrumentIdentifier']
+      shipping_address = ShippingAddress.from_hash(hash['shippingAddress']) if
+        hash['shippingAddress']
+      legacy_token = LegacyToken.from_hash(hash['legacyToken']) if hash['legacyToken']
+      bank = Bank.from_hash(hash['bank']) if hash['bank']
+      options = Options.from_hash(hash['options']) if hash['options']
+      payment_type = PaymentType.from_hash(hash['paymentType']) if hash['paymentType']
+      initiation_channel =
+        hash.key?('initiationChannel') ? hash['initiationChannel'] : SKIP
+      sepa = Sepa.from_hash(hash['sepa']) if hash['sepa']
+      e_wallet = EWallet.from_hash(hash['eWallet']) if hash['eWallet']
+      if hash['paymentAccountReference']
+        payment_account_reference = PaymentAccountReference.from_hash(hash['paymentAccountReference'])
+      end
+
+      # Create object from extracted values.
+      PaymentInformation.new(card,
+                             tokenized_card,
+                             tokenized_payment_method,
+                             direct_debit,
+                             fluid_data,
+                             customer,
+                             payment_instrument,
+                             instrument_identifier,
+                             shipping_address,
+                             legacy_token,
+                             bank,
+                             options,
+                             payment_type,
+                             initiation_channel,
+                             sepa,
+                             e_wallet,
+                             payment_account_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, tokenized_card: #{@tokenized_card},"\
+      " tokenized_payment_method: #{@tokenized_payment_method}, direct_debit: #{@direct_debit},"\
+      " fluid_data: #{@fluid_data}, customer: #{@customer}, payment_instrument:"\
+      " #{@payment_instrument}, instrument_identifier: #{@instrument_identifier},"\
+      " shipping_address: #{@shipping_address}, legacy_token: #{@legacy_token}, bank: #{@bank},"\
+      " options: #{@options}, payment_type: #{@payment_type}, initiation_channel:"\
+      " #{@initiation_channel}, sepa: #{@sepa}, e_wallet: #{@e_wallet}, payment_account_reference:"\
+      " #{@payment_account_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, tokenized_card: #{@tokenized_card.inspect},"\
+      " tokenized_payment_method: #{@tokenized_payment_method.inspect}, direct_debit:"\
+      " #{@direct_debit.inspect}, fluid_data: #{@fluid_data.inspect}, customer:"\
+      " #{@customer.inspect}, payment_instrument: #{@payment_instrument.inspect},"\
+      " instrument_identifier: #{@instrument_identifier.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, legacy_token: #{@legacy_token.inspect}, bank:"\
+      " #{@bank.inspect}, options: #{@options.inspect}, payment_type: #{@payment_type.inspect},"\
+      " initiation_channel: #{@initiation_channel.inspect}, sepa: #{@sepa.inspect}, e_wallet:"\
+      " #{@e_wallet.inspect}, payment_account_reference: #{@payment_account_reference.inspect}>"
+    end
+  end
+end