adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/address21.rb

@@ -0,0 +1,136 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The address details of the shipping location.
+  class Address21 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the city.
+    # @return [String]
+    attr_accessor :city
+
+    # The name of the company.
+    # @return [String]
+    attr_accessor :company_name
+
+    # The two-letter country code, in [ISO 3166-1
+    # alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+    # @return [String]
+    attr_accessor :country
+
+    # The postal code.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The state or province as defined in [ISO
+    # 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for
+    # Ontario, Canada. 
+    # Applicable for the following countries:
+    # - Australia
+    # - Brazil
+    # - Canada
+    # - India
+    # - Mexico
+    # - New Zealand
+    # - United States
+    # @return [String]
+    attr_accessor :state_or_province
+
+    # The name of the street, and the house or building number.
+    # @return [String]
+    attr_accessor :street_address
+
+    # Additional address details, if any.
+    # @return [String]
+    attr_accessor :street_address2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['company_name'] = 'companyName'
+      @_hash['country'] = 'country'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash['street_address'] = 'streetAddress'
+      @_hash['street_address2'] = 'streetAddress2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        company_name
+        country
+        postal_code
+        state_or_province
+        street_address
+        street_address2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city: SKIP, company_name: SKIP, country: SKIP,
+                   postal_code: SKIP, state_or_province: SKIP,
+                   street_address: SKIP, street_address2: SKIP)
+      @city = city unless city == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @country = country unless country == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @state_or_province = state_or_province unless state_or_province == SKIP
+      @street_address = street_address unless street_address == SKIP
+      @street_address2 = street_address2 unless street_address2 == 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
+      company_name = hash.key?('companyName') ? hash['companyName'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+      street_address = hash.key?('streetAddress') ? hash['streetAddress'] : SKIP
+      street_address2 =
+        hash.key?('streetAddress2') ? hash['streetAddress2'] : SKIP
+
+      # Create object from extracted values.
+      Address21.new(city: city,
+                    company_name: company_name,
+                    country: country,
+                    postal_code: postal_code,
+                    state_or_province: state_or_province,
+                    street_address: street_address,
+                    street_address2: street_address2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, company_name: #{@company_name}, country: #{@country},"\
+      " postal_code: #{@postal_code}, state_or_province: #{@state_or_province}, street_address:"\
+      " #{@street_address}, street_address2: #{@street_address2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, company_name: #{@company_name.inspect}, country:"\
+      " #{@country.inspect}, postal_code: #{@postal_code.inspect}, state_or_province:"\
+      " #{@state_or_province.inspect}, street_address: #{@street_address.inspect},"\
+      " street_address2: #{@street_address2.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/address3.rb

@@ -0,0 +1,150 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The address where to send the invoice.
+  class Address3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the city. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :city
+
+    # The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
+    # > If you don't know the country or are not collecting the country from the
+    # shopper, provide `country` as `ZZ`.
+    # @return [String]
+    attr_accessor :country
+
+    # The number or name of the house. Maximum length: 3000 characters.
+    # @return [String]
+    attr_accessor :house_number_or_name
+
+    # A maximum of five digits for an address in the US, or a maximum of ten
+    # characters for an address in all other countries.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The two-character ISO 3166-2 state or province code. For example, **CA**
+    # in the US or **ON** in Canada.
+    # > Required for the US and Canada.
+    # @return [String]
+    attr_accessor :state_or_province
+
+    # The name of the street. Maximum length: 3000 characters.
+    # > The house number should not be included in this field; it should be
+    # separately provided via `houseNumberOrName`.
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['house_number_or_name'] = 'houseNumberOrName'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state_or_province
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city:, country:, house_number_or_name:, postal_code:,
+                   street:, state_or_province: SKIP)
+      @city = city
+      @country = country
+      @house_number_or_name = house_number_or_name
+      @postal_code = postal_code
+      @state_or_province = state_or_province unless state_or_province == SKIP
+      @street = street
+    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'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      house_number_or_name =
+        hash.key?('houseNumberOrName') ? hash['houseNumberOrName'] : nil
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : nil
+      street = hash.key?('street') ? hash['street'] : nil
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+
+      # Create object from extracted values.
+      Address3.new(city: city,
+                   country: country,
+                   house_number_or_name: house_number_or_name,
+                   postal_code: postal_code,
+                   street: street,
+                   state_or_province: state_or_province)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Address3 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.city,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.country,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.house_number_or_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.postal_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.street,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['city'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['country'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['houseNumberOrName'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['postalCode'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['street'],
+                                ->(val) { val.instance_of? String })
+      )
+    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}, house_number_or_name:"\
+      " #{@house_number_or_name}, postal_code: #{@postal_code}, state_or_province:"\
+      " #{@state_or_province}, street: #{@street}>"
+    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}, house_number_or_name:"\
+      " #{@house_number_or_name.inspect}, postal_code: #{@postal_code.inspect}, state_or_province:"\
+      " #{@state_or_province.inspect}, street: #{@street.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/address4.rb

@@ -0,0 +1,136 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Address4 Model.
+  class Address4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the city.
+    # @return [String]
+    attr_accessor :city
+
+    # The name of the company.
+    # @return [String]
+    attr_accessor :company_name
+
+    # The two-letter country code, in [ISO 3166-1
+    # alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+    # @return [String]
+    attr_accessor :country
+
+    # The postal code.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The state or province as defined in [ISO
+    # 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for
+    # Ontario, Canada. 
+    # Applicable for the following countries:
+    # - Australia
+    # - Brazil
+    # - Canada
+    # - India
+    # - Mexico
+    # - New Zealand
+    # - United States
+    # @return [String]
+    attr_accessor :state_or_province
+
+    # The name of the street, and the house or building number.
+    # @return [String]
+    attr_accessor :street_address
+
+    # Additional address details, if any.
+    # @return [String]
+    attr_accessor :street_address2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['company_name'] = 'companyName'
+      @_hash['country'] = 'country'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state_or_province'] = 'stateOrProvince'
+      @_hash['street_address'] = 'streetAddress'
+      @_hash['street_address2'] = 'streetAddress2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        company_name
+        country
+        postal_code
+        state_or_province
+        street_address
+        street_address2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city: SKIP, company_name: SKIP, country: SKIP,
+                   postal_code: SKIP, state_or_province: SKIP,
+                   street_address: SKIP, street_address2: SKIP)
+      @city = city unless city == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @country = country unless country == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @state_or_province = state_or_province unless state_or_province == SKIP
+      @street_address = street_address unless street_address == SKIP
+      @street_address2 = street_address2 unless street_address2 == 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
+      company_name = hash.key?('companyName') ? hash['companyName'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      state_or_province =
+        hash.key?('stateOrProvince') ? hash['stateOrProvince'] : SKIP
+      street_address = hash.key?('streetAddress') ? hash['streetAddress'] : SKIP
+      street_address2 =
+        hash.key?('streetAddress2') ? hash['streetAddress2'] : SKIP
+
+      # Create object from extracted values.
+      Address4.new(city: city,
+                   company_name: company_name,
+                   country: country,
+                   postal_code: postal_code,
+                   state_or_province: state_or_province,
+                   street_address: street_address,
+                   street_address2: street_address2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, company_name: #{@company_name}, country: #{@country},"\
+      " postal_code: #{@postal_code}, state_or_province: #{@state_or_province}, street_address:"\
+      " #{@street_address}, street_address2: #{@street_address2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, company_name: #{@company_name.inspect}, country:"\
+      " #{@country.inspect}, postal_code: #{@postal_code.inspect}, state_or_province:"\
+      " #{@state_or_province.inspect}, street_address: #{@street_address.inspect},"\
+      " street_address2: #{@street_address2.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/adyen_commission.rb

@@ -0,0 +1,40 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Deducts the transaction fee due to Adyen under [blended
+  # rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/ge
+  # t-the-best-from-your-card-processing) from the specified balance account.
+  # Possible values: **deductFromLiableAccount**,
+  # **deductFromOneBalanceAccount**.
+  class AdyenCommission
+    ADYEN_COMMISSION = [
+      # TODO: Write general description for DEDUCTFROMLIABLEACCOUNT
+      DEDUCTFROMLIABLEACCOUNT = 'deductFromLiableAccount'.freeze,
+
+      # TODO: Write general description for DEDUCTFROMONEBALANCEACCOUNT
+      DEDUCTFROMONEBALANCEACCOUNT = 'deductFromOneBalanceAccount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADYEN_COMMISSION.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEDUCTFROMLIABLEACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'deductfromliableaccount' then DEDUCTFROMLIABLEACCOUNT
+      when 'deductfromonebalanceaccount' then DEDUCTFROMONEBALANCEACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/adyen_fees.rb

@@ -0,0 +1,38 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Deducts the fees due to Adyen (markup or commission) from the specified
+  # balance account. Possible values: **deductFromLiableAccount**,
+  # **deductFromOneBalanceAccount**.
+  class AdyenFees
+    ADYEN_FEES = [
+      # TODO: Write general description for DEDUCTFROMLIABLEACCOUNT
+      DEDUCTFROMLIABLEACCOUNT = 'deductFromLiableAccount'.freeze,
+
+      # TODO: Write general description for DEDUCTFROMONEBALANCEACCOUNT
+      DEDUCTFROMONEBALANCEACCOUNT = 'deductFromOneBalanceAccount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADYEN_FEES.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEDUCTFROMLIABLEACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'deductfromliableaccount' then DEDUCTFROMLIABLEACCOUNT
+      when 'deductfromonebalanceaccount' then DEDUCTFROMONEBALANCEACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/adyen_markup.rb

@@ -0,0 +1,39 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Deducts the transaction fee due to Adyen under [Interchange ++
+  # pricing](https://www.adyen.com/what-is-interchange) from the specified
+  # balance account. Possible values: **deductFromLiableAccount**,
+  # **deductFromOneBalanceAccount**.
+  class AdyenMarkup
+    ADYEN_MARKUP = [
+      # TODO: Write general description for DEDUCTFROMLIABLEACCOUNT
+      DEDUCTFROMLIABLEACCOUNT = 'deductFromLiableAccount'.freeze,
+
+      # TODO: Write general description for DEDUCTFROMONEBALANCEACCOUNT
+      DEDUCTFROMONEBALANCEACCOUNT = 'deductFromOneBalanceAccount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADYEN_MARKUP.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEDUCTFROMLIABLEACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'deductfromliableaccount' then DEDUCTFROMLIABLEACCOUNT
+      when 'deductfromonebalanceaccount' then DEDUCTFROMONEBALANCEACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/affirm.rb

@@ -0,0 +1,95 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Affirm Model.
+  class Affirm < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout attempt identifier.
+    # @return [String]
+    attr_accessor :checkout_attempt_id
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :sdk_data
+
+    # **affirm**
+    # @return [Type1]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_attempt_id'] = 'checkoutAttemptId'
+      @_hash['sdk_data'] = 'sdkData'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_attempt_id
+        sdk_data
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(checkout_attempt_id: SKIP, sdk_data: SKIP,
+                   type: Type1::AFFIRM)
+      @checkout_attempt_id = checkout_attempt_id unless checkout_attempt_id == SKIP
+      @sdk_data = sdk_data unless sdk_data == SKIP
+      @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.
+      checkout_attempt_id =
+        hash.key?('checkoutAttemptId') ? hash['checkoutAttemptId'] : SKIP
+      sdk_data = hash.key?('sdkData') ? hash['sdkData'] : SKIP
+      type = hash['type'] ||= Type1::AFFIRM
+
+      # Create object from extracted values.
+      Affirm.new(checkout_attempt_id: checkout_attempt_id,
+                 sdk_data: sdk_data,
+                 type: type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Affirm | 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} checkout_attempt_id: #{@checkout_attempt_id}, sdk_data: #{@sdk_data}, type:"\
+      " #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_attempt_id: #{@checkout_attempt_id.inspect}, sdk_data:"\
+      " #{@sdk_data.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end