adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/stored_payment_method_request.rb

@@ -0,0 +1,128 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # StoredPaymentMethodRequest Model.
+  class StoredPaymentMethodRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant account identifier, with which you want to process the
+    # transaction.
+    # @return [String]
+    attr_accessor :merchant_account
+
+    # Contains the information required to store a payment method.
+    # @return [PaymentMethodToStore1]
+    attr_accessor :payment_method
+
+    # Defines a recurring payment type. Required when creating a token to store
+    # payment details.
+    # Allowed values:
+    # * `Subscription` – A transaction for a fixed or variable amount, which
+    # follows a fixed schedule.
+    # * `CardOnFile` – With a card-on-file (CoF) transaction, card details are
+    # stored to enable one-click or omnichannel journeys, or simply to
+    # streamline the checkout process. Any subscription not following a fixed
+    # schedule is also considered a card-on-file transaction.
+    # * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction
+    # is a transaction that occurs on a non-fixed schedule and/or have variable
+    # amounts. For example, automatic top-ups when a cardholder's balance drops
+    # below a certain amount.
+    # @return [RecurringProcessingModel1]
+    attr_accessor :recurring_processing_model
+
+    # The shopper's email address. We recommend that you provide this data, as
+    # it is used in velocity fraud checks.
+    # @return [String]
+    attr_accessor :shopper_email
+
+    # The IP address of a shopper.
+    # @return [String]
+    attr_accessor :shopper_ip
+
+    # A unique identifier for the shopper (for example, user ID or account ID).
+    # @return [String]
+    attr_accessor :shopper_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_account'] = 'merchantAccount'
+      @_hash['payment_method'] = 'paymentMethod'
+      @_hash['recurring_processing_model'] = 'recurringProcessingModel'
+      @_hash['shopper_email'] = 'shopperEmail'
+      @_hash['shopper_ip'] = 'shopperIP'
+      @_hash['shopper_reference'] = 'shopperReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shopper_email
+        shopper_ip
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_account:, payment_method:,
+                   recurring_processing_model:, shopper_reference:,
+                   shopper_email: SKIP, shopper_ip: SKIP)
+      @merchant_account = merchant_account
+      @payment_method = payment_method
+      @recurring_processing_model = recurring_processing_model
+      @shopper_email = shopper_email unless shopper_email == SKIP
+      @shopper_ip = shopper_ip unless shopper_ip == SKIP
+      @shopper_reference = shopper_reference
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      merchant_account =
+        hash.key?('merchantAccount') ? hash['merchantAccount'] : nil
+      payment_method = PaymentMethodToStore1.from_hash(hash['paymentMethod']) if
+        hash['paymentMethod']
+      recurring_processing_model =
+        hash.key?('recurringProcessingModel') ? hash['recurringProcessingModel'] : nil
+      shopper_reference =
+        hash.key?('shopperReference') ? hash['shopperReference'] : nil
+      shopper_email = hash.key?('shopperEmail') ? hash['shopperEmail'] : SKIP
+      shopper_ip = hash.key?('shopperIP') ? hash['shopperIP'] : SKIP
+
+      # Create object from extracted values.
+      StoredPaymentMethodRequest.new(merchant_account: merchant_account,
+                                     payment_method: payment_method,
+                                     recurring_processing_model: recurring_processing_model,
+                                     shopper_reference: shopper_reference,
+                                     shopper_email: shopper_email,
+                                     shopper_ip: shopper_ip)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_account: #{@merchant_account}, payment_method: #{@payment_method},"\
+      " recurring_processing_model: #{@recurring_processing_model}, shopper_email:"\
+      " #{@shopper_email}, shopper_ip: #{@shopper_ip}, shopper_reference: #{@shopper_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_account: #{@merchant_account.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, recurring_processing_model:"\
+      " #{@recurring_processing_model.inspect}, shopper_email: #{@shopper_email.inspect},"\
+      " shopper_ip: #{@shopper_ip.inspect}, shopper_reference: #{@shopper_reference.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/stored_payment_method_resource.rb

@@ -0,0 +1,277 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # StoredPaymentMethodResource Model.
+  class StoredPaymentMethodResource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The brand of the card.
+    # @return [String]
+    attr_accessor :brand
+
+    # The bank identification number (BIN) of the card.
+    # @return [String]
+    attr_accessor :card_bin
+
+    # The month the card expires.
+    # @return [String]
+    attr_accessor :expiry_month
+
+    # The last two digits of the year the card expires. For example, **22** for
+    # the year 2022.
+    # @return [String]
+    attr_accessor :expiry_year
+
+    # The response code returned by an external system (for example after a
+    # provisioning operation).
+    # @return [String]
+    attr_accessor :external_response_code
+
+    # The token reference of a linked token in an external system (for example a
+    # network token reference).
+    # @return [String]
+    attr_accessor :external_token_reference
+
+    # The unique payment method code.
+    # @return [String]
+    attr_accessor :holder_name
+
+    # The IBAN of the bank account.
+    # @return [String]
+    attr_accessor :iban
+
+    # A unique identifier of this stored payment method.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the issuer of token or card.
+    # @return [String]
+    attr_accessor :issuer_name
+
+    # The last four digits of the PAN.
+    # @return [String]
+    attr_accessor :last_four
+
+    # Mandate details for the stored payment method.
+    # @return [TokenMandate2]
+    attr_accessor :mandate
+
+    # The display name of the stored payment method.
+    # @return [String]
+    attr_accessor :name
+
+    # Returned in the response if you are not tokenizing with Adyen and are
+    # using the Merchant-initiated transactions (MIT) framework from Mastercard
+    # or Visa.
+    # This contains either the Mastercard Trace ID or the Visa Transaction ID.
+    # @return [String]
+    attr_accessor :network_tx_reference
+
+    # The name of the bank account holder.
+    # @return [String]
+    attr_accessor :owner_name
+
+    # The shopper’s email address.
+    # @return [String]
+    attr_accessor :shopper_email
+
+    # Your reference to uniquely identify this shopper, for example user ID or
+    # account ID. The value is case-sensitive and must be at least three
+    # characters.
+    # > Your reference must not include personally identifiable information
+    # (PII) such as name or email address.
+    # @return [String]
+    attr_accessor :shopper_reference
+
+    # Defines a recurring payment type.
+    # Allowed values:
+    # * `Subscription` – A transaction for a fixed or variable amount, which
+    # follows a fixed schedule.
+    # * `CardOnFile` – With a card-on-file (CoF) transaction, card details are
+    # stored to enable one-click or omnichannel journeys, or simply to
+    # streamline the checkout process. Any subscription not following a fixed
+    # schedule is also considered a card-on-file transaction.
+    # * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction
+    # is a transaction that occurs on a non-fixed schedule and/or have variable
+    # amounts. For example, automatic top-ups when a cardholder's balance drops
+    # below a certain amount.
+    # @return [Array[String]]
+    attr_accessor :supported_recurring_processing_models
+
+    # The type of payment method.
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['brand'] = 'brand'
+      @_hash['card_bin'] = 'cardBin'
+      @_hash['expiry_month'] = 'expiryMonth'
+      @_hash['expiry_year'] = 'expiryYear'
+      @_hash['external_response_code'] = 'externalResponseCode'
+      @_hash['external_token_reference'] = 'externalTokenReference'
+      @_hash['holder_name'] = 'holderName'
+      @_hash['iban'] = 'iban'
+      @_hash['id'] = 'id'
+      @_hash['issuer_name'] = 'issuerName'
+      @_hash['last_four'] = 'lastFour'
+      @_hash['mandate'] = 'mandate'
+      @_hash['name'] = 'name'
+      @_hash['network_tx_reference'] = 'networkTxReference'
+      @_hash['owner_name'] = 'ownerName'
+      @_hash['shopper_email'] = 'shopperEmail'
+      @_hash['shopper_reference'] = 'shopperReference'
+      @_hash['supported_recurring_processing_models'] =
+        'supportedRecurringProcessingModels'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        brand
+        card_bin
+        expiry_month
+        expiry_year
+        external_response_code
+        external_token_reference
+        holder_name
+        iban
+        id
+        issuer_name
+        last_four
+        mandate
+        name
+        network_tx_reference
+        owner_name
+        shopper_email
+        shopper_reference
+        supported_recurring_processing_models
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(brand: SKIP, card_bin: SKIP, expiry_month: SKIP,
+                   expiry_year: SKIP, external_response_code: SKIP,
+                   external_token_reference: SKIP, holder_name: SKIP,
+                   iban: SKIP, id: SKIP, issuer_name: SKIP, last_four: SKIP,
+                   mandate: SKIP, name: SKIP, network_tx_reference: SKIP,
+                   owner_name: SKIP, shopper_email: SKIP,
+                   shopper_reference: SKIP,
+                   supported_recurring_processing_models: SKIP, type: SKIP)
+      @brand = brand unless brand == SKIP
+      @card_bin = card_bin unless card_bin == SKIP
+      @expiry_month = expiry_month unless expiry_month == SKIP
+      @expiry_year = expiry_year unless expiry_year == SKIP
+      @external_response_code = external_response_code unless external_response_code == SKIP
+      @external_token_reference = external_token_reference unless external_token_reference == SKIP
+      @holder_name = holder_name unless holder_name == SKIP
+      @iban = iban unless iban == SKIP
+      @id = id unless id == SKIP
+      @issuer_name = issuer_name unless issuer_name == SKIP
+      @last_four = last_four unless last_four == SKIP
+      @mandate = mandate unless mandate == SKIP
+      @name = name unless name == SKIP
+      @network_tx_reference = network_tx_reference unless network_tx_reference == SKIP
+      @owner_name = owner_name unless owner_name == SKIP
+      @shopper_email = shopper_email unless shopper_email == SKIP
+      @shopper_reference = shopper_reference unless shopper_reference == SKIP
+      unless supported_recurring_processing_models == SKIP
+        @supported_recurring_processing_models =
+          supported_recurring_processing_models
+      end
+      @type = type unless 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.
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      card_bin = hash.key?('cardBin') ? hash['cardBin'] : SKIP
+      expiry_month = hash.key?('expiryMonth') ? hash['expiryMonth'] : SKIP
+      expiry_year = hash.key?('expiryYear') ? hash['expiryYear'] : SKIP
+      external_response_code =
+        hash.key?('externalResponseCode') ? hash['externalResponseCode'] : SKIP
+      external_token_reference =
+        hash.key?('externalTokenReference') ? hash['externalTokenReference'] : SKIP
+      holder_name = hash.key?('holderName') ? hash['holderName'] : SKIP
+      iban = hash.key?('iban') ? hash['iban'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      issuer_name = hash.key?('issuerName') ? hash['issuerName'] : SKIP
+      last_four = hash.key?('lastFour') ? hash['lastFour'] : SKIP
+      mandate = TokenMandate2.from_hash(hash['mandate']) if hash['mandate']
+      name = hash.key?('name') ? hash['name'] : SKIP
+      network_tx_reference =
+        hash.key?('networkTxReference') ? hash['networkTxReference'] : SKIP
+      owner_name = hash.key?('ownerName') ? hash['ownerName'] : SKIP
+      shopper_email = hash.key?('shopperEmail') ? hash['shopperEmail'] : SKIP
+      shopper_reference =
+        hash.key?('shopperReference') ? hash['shopperReference'] : SKIP
+      supported_recurring_processing_models =
+        hash.key?('supportedRecurringProcessingModels') ? hash['supportedRecurringProcessingModels'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      StoredPaymentMethodResource.new(brand: brand,
+                                      card_bin: card_bin,
+                                      expiry_month: expiry_month,
+                                      expiry_year: expiry_year,
+                                      external_response_code: external_response_code,
+                                      external_token_reference: external_token_reference,
+                                      holder_name: holder_name,
+                                      iban: iban,
+                                      id: id,
+                                      issuer_name: issuer_name,
+                                      last_four: last_four,
+                                      mandate: mandate,
+                                      name: name,
+                                      network_tx_reference: network_tx_reference,
+                                      owner_name: owner_name,
+                                      shopper_email: shopper_email,
+                                      shopper_reference: shopper_reference,
+                                      supported_recurring_processing_models: supported_recurring_processing_models,
+                                      type: type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand: #{@brand}, card_bin: #{@card_bin}, expiry_month: #{@expiry_month},"\
+      " expiry_year: #{@expiry_year}, external_response_code: #{@external_response_code},"\
+      " external_token_reference: #{@external_token_reference}, holder_name: #{@holder_name},"\
+      " iban: #{@iban}, id: #{@id}, issuer_name: #{@issuer_name}, last_four: #{@last_four},"\
+      " mandate: #{@mandate}, name: #{@name}, network_tx_reference: #{@network_tx_reference},"\
+      " owner_name: #{@owner_name}, shopper_email: #{@shopper_email}, shopper_reference:"\
+      " #{@shopper_reference}, supported_recurring_processing_models:"\
+      " #{@supported_recurring_processing_models}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} brand: #{@brand.inspect}, card_bin: #{@card_bin.inspect}, expiry_month:"\
+      " #{@expiry_month.inspect}, expiry_year: #{@expiry_year.inspect}, external_response_code:"\
+      " #{@external_response_code.inspect}, external_token_reference:"\
+      " #{@external_token_reference.inspect}, holder_name: #{@holder_name.inspect}, iban:"\
+      " #{@iban.inspect}, id: #{@id.inspect}, issuer_name: #{@issuer_name.inspect}, last_four:"\
+      " #{@last_four.inspect}, mandate: #{@mandate.inspect}, name: #{@name.inspect},"\
+      " network_tx_reference: #{@network_tx_reference.inspect}, owner_name:"\
+      " #{@owner_name.inspect}, shopper_email: #{@shopper_email.inspect}, shopper_reference:"\
+      " #{@shopper_reference.inspect}, supported_recurring_processing_models:"\
+      " #{@supported_recurring_processing_models.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/sub_input_detail.rb

@@ -0,0 +1,120 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SubInputDetail Model.
+  class SubInputDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Configuration parameters for the required input.
+    # @return [Hash[String, String]]
+    attr_accessor :configuration
+
+    # In case of a select, the items to choose from.
+    # @return [Array[Item]]
+    attr_accessor :items
+
+    # The value to provide in the result.
+    # @return [String]
+    attr_accessor :key
+
+    # True if this input is optional to provide.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :optional
+
+    # The type of the required input.
+    # @return [String]
+    attr_accessor :type
+
+    # The value can be pre-filled, if available.
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['configuration'] = 'configuration'
+      @_hash['items'] = 'items'
+      @_hash['key'] = 'key'
+      @_hash['optional'] = 'optional'
+      @_hash['type'] = 'type'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        configuration
+        items
+        key
+        optional
+        type
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(configuration: SKIP, items: SKIP, key: SKIP, optional: SKIP,
+                   type: SKIP, value: SKIP)
+      @configuration = configuration unless configuration == SKIP
+      @items = items unless items == SKIP
+      @key = key unless key == SKIP
+      @optional = optional unless optional == SKIP
+      @type = type unless type == SKIP
+      @value = value unless value == 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.
+      configuration = hash.key?('configuration') ? hash['configuration'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Item.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      key = hash.key?('key') ? hash['key'] : SKIP
+      optional = hash.key?('optional') ? hash['optional'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      SubInputDetail.new(configuration: configuration,
+                         items: items,
+                         key: key,
+                         optional: optional,
+                         type: type,
+                         value: value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} configuration: #{@configuration}, items: #{@items}, key: #{@key}, optional:"\
+      " #{@optional}, type: #{@type}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} configuration: #{@configuration.inspect}, items: #{@items.inspect}, key:"\
+      " #{@key.inspect}, optional: #{@optional.inspect}, type: #{@type.inspect}, value:"\
+      " #{@value.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/sub_merchant.rb

@@ -0,0 +1,115 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SubMerchant Model.
+  class SubMerchant < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The city of the sub-merchant's address.
+    # * Format: Alphanumeric
+    # * Maximum length: 13 characters
+    # @return [String]
+    attr_accessor :city
+
+    # The three-letter country code of the sub-merchant's address. For example,
+    # **BRA** for Brazil. 
+    # * Format: [ISO 3166-1
+    # alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
+    # * Fixed length: 3 characters
+    # @return [String]
+    attr_accessor :country
+
+    # The sub-merchant's 4-digit Merchant Category Code (MCC). 
+    # * Format: Numeric
+    # * Fixed length: 4 digits
+    # @return [String]
+    attr_accessor :mcc
+
+    # The name of the sub-merchant. Based on scheme specifications, this value
+    # will overwrite the shopper statement  that will appear in the card
+    # statement.
+    # * Format: Alphanumeric
+    # * Maximum length: 22 characters
+    # @return [String]
+    attr_accessor :name
+
+    # The tax ID of the sub-merchant.
+    # * Format: Numeric
+    # * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ
+    # @return [String]
+    attr_accessor :tax_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['mcc'] = 'mcc'
+      @_hash['name'] = 'name'
+      @_hash['tax_id'] = 'taxId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        country
+        mcc
+        name
+        tax_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city: SKIP, country: SKIP, mcc: SKIP, name: SKIP,
+                   tax_id: SKIP)
+      @city = city unless city == SKIP
+      @country = country unless country == SKIP
+      @mcc = mcc unless mcc == SKIP
+      @name = name unless name == SKIP
+      @tax_id = tax_id unless tax_id == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      mcc = hash.key?('mcc') ? hash['mcc'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+
+      # Create object from extracted values.
+      SubMerchant.new(city: city,
+                      country: country,
+                      mcc: mcc,
+                      name: name,
+                      tax_id: tax_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, country: #{@country}, mcc: #{@mcc}, name: #{@name}, tax_id:"\
+      " #{@tax_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, country: #{@country.inspect}, mcc: #{@mcc.inspect},"\
+      " name: #{@name.inspect}, tax_id: #{@tax_id.inspect}>"
+    end
+  end
+end