adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/sub_merchant2.rb

@@ -0,0 +1,129 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Required for back-to-back/purchase-driven-load transactions, where the funds
+  # are taken from the shopper's stored card when the wallet balance is
+  # insufficient. The final merchant who will receive the money, also known as a
+  # [sub-merchant](https://docs.adyen.com/get-started-with-adyen/payment-glossar
+  # y/#submerchant).
+  class SubMerchant2 < 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.
+      SubMerchant2.new(city: city,
+                       country: country,
+                       mcc: mcc,
+                       name: name,
+                       tax_id: tax_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubMerchant2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    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

data/lib/adyen_ap_is/models/sub_merchant_data.rb

@@ -0,0 +1,94 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SubMerchantData Model.
+  class SubMerchantData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email associated with the sub-merchant's account.
+    # @return [String]
+    attr_accessor :email
+
+    # A unique identifier that you create for the sub-merchant, used by schemes
+    # to identify the sub-merchant.
+    # * Format: Alphanumeric
+    # * Maximum length: 15 characters
+    # @return [String]
+    attr_accessor :id
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['id'] = 'id'
+      @_hash['mcc'] = 'mcc'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email:, id:, mcc:, name:)
+      @email = email
+      @id = id
+      @mcc = mcc
+      @name = name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      email = hash.key?('email') ? hash['email'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      mcc = hash.key?('mcc') ? hash['mcc'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      SubMerchantData.new(email: email,
+                          id: id,
+                          mcc: mcc,
+                          name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, id: #{@id}, mcc: #{@mcc}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, id: #{@id.inspect}, mcc: #{@mcc.inspect}, name:"\
+      " #{@name.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/sub_merchant_data1.rb

@@ -0,0 +1,95 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The sub-merchant data relevant for registered payment facilitators
+  # transacting on standalone terminals.
+  class SubMerchantData1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email associated with the sub-merchant's account.
+    # @return [String]
+    attr_accessor :email
+
+    # A unique identifier that you create for the sub-merchant, used by schemes
+    # to identify the sub-merchant.
+    # * Format: Alphanumeric
+    # * Maximum length: 15 characters
+    # @return [String]
+    attr_accessor :id
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['id'] = 'id'
+      @_hash['mcc'] = 'mcc'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email:, id:, mcc:, name:)
+      @email = email
+      @id = id
+      @mcc = mcc
+      @name = name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      email = hash.key?('email') ? hash['email'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      mcc = hash.key?('mcc') ? hash['mcc'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      SubMerchantData1.new(email: email,
+                           id: id,
+                           mcc: mcc,
+                           name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, id: #{@id}, mcc: #{@mcc}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, id: #{@id.inspect}, mcc: #{@mcc.inspect}, name:"\
+      " #{@name.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/sub_merchant_info.rb

@@ -0,0 +1,186 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SubMerchantInfo Model.
+  class SubMerchantInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required for transactions performed by registered payment facilitators.
+    # The sub-merchant's address.
+    # @return [BillingAddress4]
+    attr_accessor :address
+
+    # Required for transactions performed by registered payment facilitators.
+    # The amount of the payment corresponding to each sub-merchant. This value
+    # will be different than the request amount if shopper is purchasing items
+    # at different sub-merchants' shops.
+    # @return [Amount31]
+    attr_accessor :amount
+
+    # Required for transactions performed by registered payment facilitators.
+    # The email associated with the sub-merchant's account.
+    # @return [String]
+    attr_accessor :email
+
+    # Required for transactions performed by registered payment facilitators. A
+    # unique identifier that you create for the sub-merchant, used by schemes to
+    # identify the sub-merchant. 
+    # * Format: Alphanumeric
+    # * Maximum length: 15 characters
+    # @return [String]
+    attr_accessor :id
+
+    # Required for transactions performed by registered payment facilitators.
+    # The sub-merchant's 4-digit Merchant Category Code (MCC). 
+    # * Format: Numeric
+    # * Fixed length: 4 digits
+    # @return [String]
+    attr_accessor :mcc
+
+    # Required for transactions performed by registered payment facilitators.
+    # The name of the sub-merchant. Based on scheme specifications, this value
+    # will overwrite the shopper statement that will appear in the card
+    # statement.
+    # Exception: for acquirers in Brazil, this value does not overwrite the
+    # shopper statement.
+    # * Format: Alphanumeric
+    # * Maximum length: 22 characters
+    # @return [String]
+    attr_accessor :name
+
+    # Required for transactions performed by registered payment facilitators.
+    # The phone number associated with the sub-merchant's account.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Required for transactions performed by registered payment facilitators.
+    # The phone number associated with the sub-merchant's account.
+    # @return [String]
+    attr_accessor :registered_since
+
+    # Required for transactions performed by registered payment facilitators.
+    # 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
+
+    # Required for transactions performed by registered payment facilitators.
+    # The sub-merchant's URL on the platform, i.e. the sub-merchant's shop.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['amount'] = 'amount'
+      @_hash['email'] = 'email'
+      @_hash['id'] = 'id'
+      @_hash['mcc'] = 'mcc'
+      @_hash['name'] = 'name'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['registered_since'] = 'registeredSince'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        amount
+        email
+        id
+        mcc
+        name
+        phone_number
+        registered_since
+        tax_id
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address: SKIP, amount: SKIP, email: SKIP, id: SKIP,
+                   mcc: SKIP, name: SKIP, phone_number: SKIP,
+                   registered_since: SKIP, tax_id: SKIP, url: SKIP)
+      @address = address unless address == SKIP
+      @amount = amount unless amount == SKIP
+      @email = email unless email == SKIP
+      @id = id unless id == SKIP
+      @mcc = mcc unless mcc == SKIP
+      @name = name unless name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @registered_since = registered_since unless registered_since == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @url = url unless url == 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.
+      address = BillingAddress4.from_hash(hash['address']) if hash['address']
+      amount = Amount31.from_hash(hash['amount']) if hash['amount']
+      email = hash.key?('email') ? hash['email'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      mcc = hash.key?('mcc') ? hash['mcc'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+      registered_since =
+        hash.key?('registeredSince') ? hash['registeredSince'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      SubMerchantInfo.new(address: address,
+                          amount: amount,
+                          email: email,
+                          id: id,
+                          mcc: mcc,
+                          name: name,
+                          phone_number: phone_number,
+                          registered_since: registered_since,
+                          tax_id: tax_id,
+                          url: url)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubMerchantInfo | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, amount: #{@amount}, email: #{@email}, id: #{@id},"\
+      " mcc: #{@mcc}, name: #{@name}, phone_number: #{@phone_number}, registered_since:"\
+      " #{@registered_since}, tax_id: #{@tax_id}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, amount: #{@amount.inspect}, email:"\
+      " #{@email.inspect}, id: #{@id.inspect}, mcc: #{@mcc.inspect}, name: #{@name.inspect},"\
+      " phone_number: #{@phone_number.inspect}, registered_since: #{@registered_since.inspect},"\
+      " tax_id: #{@tax_id.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/subtype.rb

@@ -0,0 +1,40 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The type of flow to initiate.
+  class Subtype
+    SUBTYPE = [
+      # TODO: Write general description for EXPRESS
+      EXPRESS = 'express'.freeze,
+
+      # TODO: Write general description for REDIRECT
+      REDIRECT = 'redirect'.freeze,
+
+      # TODO: Write general description for SDK
+      SDK = 'sdk'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBTYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXPRESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'express' then EXPRESS
+      when 'redirect' then REDIRECT
+      when 'sdk' then SDK
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/supported_card_types.rb

@@ -0,0 +1,102 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SupportedCardTypes Model.
+  class SupportedCardTypes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to **true** to accept credit cards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :credit
+
+    # Set to **true** to accept debit cards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :debit
+
+    # Set to **true** to accept cards that allow deferred debit.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :deferred_debit
+
+    # Set to **true** to accept prepaid cards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prepaid
+
+    # Set to **true** to accept card types for which the terminal can't
+    # determine the funding source while offline.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :unknown
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit'] = 'credit'
+      @_hash['debit'] = 'debit'
+      @_hash['deferred_debit'] = 'deferredDebit'
+      @_hash['prepaid'] = 'prepaid'
+      @_hash['unknown'] = 'unknown'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit
+        debit
+        deferred_debit
+        prepaid
+        unknown
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit: SKIP, debit: SKIP, deferred_debit: SKIP,
+                   prepaid: SKIP, unknown: SKIP)
+      @credit = credit unless credit == SKIP
+      @debit = debit unless debit == SKIP
+      @deferred_debit = deferred_debit unless deferred_debit == SKIP
+      @prepaid = prepaid unless prepaid == SKIP
+      @unknown = unknown unless unknown == 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.
+      credit = hash.key?('credit') ? hash['credit'] : SKIP
+      debit = hash.key?('debit') ? hash['debit'] : SKIP
+      deferred_debit = hash.key?('deferredDebit') ? hash['deferredDebit'] : SKIP
+      prepaid = hash.key?('prepaid') ? hash['prepaid'] : SKIP
+      unknown = hash.key?('unknown') ? hash['unknown'] : SKIP
+
+      # Create object from extracted values.
+      SupportedCardTypes.new(credit: credit,
+                             debit: debit,
+                             deferred_debit: deferred_debit,
+                             prepaid: prepaid,
+                             unknown: unknown)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credit: #{@credit}, debit: #{@debit}, deferred_debit: #{@deferred_debit},"\
+      " prepaid: #{@prepaid}, unknown: #{@unknown}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credit: #{@credit.inspect}, debit: #{@debit.inspect}, deferred_debit:"\
+      " #{@deferred_debit.inspect}, prepaid: #{@prepaid.inspect}, unknown: #{@unknown.inspect}>"
+    end
+  end
+end