adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/supported_card_types2.rb

@@ -0,0 +1,103 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The type of card for which the terminal accepts store-and-forward payments.
+  # You can specify multiple card types.
+  class SupportedCardTypes2 < 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.
+      SupportedCardTypes2.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

data/lib/adyen_ap_is/models/surcharge.rb

@@ -0,0 +1,67 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Surcharge Model.
+  class Surcharge < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount
+    # to apply to the transaction, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes). When
+    # you apply surcharge, include the surcharge in the `amount.value` field.
+    # Review our [Surcharge compliance
+    # guide](https://docs.adyen.com/development-resources/surcharge-compliance/)
+    # to learn about how to comply with regulatory requirements when applying
+    # surcharge.
+    # @return [Integer]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:)
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      Surcharge.new(value: value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/surcharge1.rb

@@ -0,0 +1,100 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Surcharge1 Model.
+  class Surcharge1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Show the surcharge details on the terminal, so the shopper can confirm.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ask_confirmation
+
+    # Surcharge fees or percentages for specific cards, funding sources (credit
+    # or debit), and currencies.
+    # @return [Array[Configuration]]
+    attr_accessor :configurations
+
+    # Exclude the tip amount from the surcharge calculation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclude_gratuity_from_surcharge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ask_confirmation'] = 'askConfirmation'
+      @_hash['configurations'] = 'configurations'
+      @_hash['exclude_gratuity_from_surcharge'] =
+        'excludeGratuityFromSurcharge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ask_confirmation
+        configurations
+        exclude_gratuity_from_surcharge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ask_confirmation: SKIP, configurations: SKIP,
+                   exclude_gratuity_from_surcharge: SKIP)
+      @ask_confirmation = ask_confirmation unless ask_confirmation == SKIP
+      @configurations = configurations unless configurations == SKIP
+      unless exclude_gratuity_from_surcharge == SKIP
+        @exclude_gratuity_from_surcharge =
+          exclude_gratuity_from_surcharge
+      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.
+      ask_confirmation =
+        hash.key?('askConfirmation') ? hash['askConfirmation'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      configurations = nil
+      unless hash['configurations'].nil?
+        configurations = []
+        hash['configurations'].each do |structure|
+          configurations << (Configuration.from_hash(structure) if structure)
+        end
+      end
+
+      configurations = SKIP unless hash.key?('configurations')
+      exclude_gratuity_from_surcharge =
+        hash.key?('excludeGratuityFromSurcharge') ? hash['excludeGratuityFromSurcharge'] : SKIP
+
+      # Create object from extracted values.
+      Surcharge1.new(ask_confirmation: ask_confirmation,
+                     configurations: configurations,
+                     exclude_gratuity_from_surcharge: exclude_gratuity_from_surcharge)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ask_confirmation: #{@ask_confirmation}, configurations: #{@configurations},"\
+      " exclude_gratuity_from_surcharge: #{@exclude_gratuity_from_surcharge}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ask_confirmation: #{@ask_confirmation.inspect}, configurations:"\
+      " #{@configurations.inspect}, exclude_gratuity_from_surcharge:"\
+      " #{@exclude_gratuity_from_surcharge.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/surcharge2.rb

@@ -0,0 +1,88 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to
+  # apply to the transaction, in [minor
+  # units](https://docs.adyen.com/development-resources/currency-codes). When
+  # you apply surcharge, include the surcharge in the `amount.value` field.
+  # Review our [Surcharge compliance
+  # guide](https://docs.adyen.com/development-resources/surcharge-compliance/)
+  # to learn about how to comply with regulatory requirements when applying
+  # surcharge.
+  class Surcharge2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount
+    # to apply to the transaction, in [minor
+    # units](https://docs.adyen.com/development-resources/currency-codes). When
+    # you apply surcharge, include the surcharge in the `amount.value` field.
+    # Review our [Surcharge compliance
+    # guide](https://docs.adyen.com/development-resources/surcharge-compliance/)
+    # to learn about how to comply with regulatory requirements when applying
+    # surcharge.
+    # @return [Integer]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:)
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      Surcharge2.new(value: value)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Surcharge2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.value,
+                                     ->(val) { val.instance_of? Integer })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['value'],
+                            ->(val) { val.instance_of? Integer })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/surcharge21.rb

@@ -0,0 +1,101 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Settings for payment
+  # [surcharge](https://docs.adyen.com/point-of-sale/surcharge) features.
+  class Surcharge21 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Show the surcharge details on the terminal, so the shopper can confirm.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ask_confirmation
+
+    # Surcharge fees or percentages for specific cards, funding sources (credit
+    # or debit), and currencies.
+    # @return [Array[Configuration]]
+    attr_accessor :configurations
+
+    # Exclude the tip amount from the surcharge calculation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclude_gratuity_from_surcharge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ask_confirmation'] = 'askConfirmation'
+      @_hash['configurations'] = 'configurations'
+      @_hash['exclude_gratuity_from_surcharge'] =
+        'excludeGratuityFromSurcharge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ask_confirmation
+        configurations
+        exclude_gratuity_from_surcharge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ask_confirmation: SKIP, configurations: SKIP,
+                   exclude_gratuity_from_surcharge: SKIP)
+      @ask_confirmation = ask_confirmation unless ask_confirmation == SKIP
+      @configurations = configurations unless configurations == SKIP
+      unless exclude_gratuity_from_surcharge == SKIP
+        @exclude_gratuity_from_surcharge =
+          exclude_gratuity_from_surcharge
+      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.
+      ask_confirmation =
+        hash.key?('askConfirmation') ? hash['askConfirmation'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      configurations = nil
+      unless hash['configurations'].nil?
+        configurations = []
+        hash['configurations'].each do |structure|
+          configurations << (Configuration.from_hash(structure) if structure)
+        end
+      end
+
+      configurations = SKIP unless hash.key?('configurations')
+      exclude_gratuity_from_surcharge =
+        hash.key?('excludeGratuityFromSurcharge') ? hash['excludeGratuityFromSurcharge'] : SKIP
+
+      # Create object from extracted values.
+      Surcharge21.new(ask_confirmation: ask_confirmation,
+                      configurations: configurations,
+                      exclude_gratuity_from_surcharge: exclude_gratuity_from_surcharge)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ask_confirmation: #{@ask_confirmation}, configurations: #{@configurations},"\
+      " exclude_gratuity_from_surcharge: #{@exclude_gratuity_from_surcharge}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ask_confirmation: #{@ask_confirmation.inspect}, configurations:"\
+      " #{@configurations.inspect}, exclude_gratuity_from_surcharge:"\
+      " #{@exclude_gratuity_from_surcharge.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/surcharge3.rb

@@ -0,0 +1,37 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Books the surcharge amount to the specified balance account. Possible
+  # values: **addToLiableAccount**, **addToOneBalanceAccount**
+  class Surcharge3
+    SURCHARGE3 = [
+      # TODO: Write general description for ADDTOLIABLEACCOUNT
+      ADDTOLIABLEACCOUNT = 'addToLiableAccount'.freeze,
+
+      # TODO: Write general description for ADDTOONEBALANCEACCOUNT
+      ADDTOONEBALANCEACCOUNT = 'addToOneBalanceAccount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SURCHARGE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = ADDTOLIABLEACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'addtoliableaccount' then ADDTOLIABLEACCOUNT
+      when 'addtoonebalanceaccount' then ADDTOONEBALANCEACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/suspicious_acc_activity.rb

@@ -0,0 +1,39 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicates whether the 3DS Requestor has experienced suspicious activity
+  # (including previous fraud) on the cardholder account.  Allowed values: *
+  # **01** — No suspicious activity has been observed * **02** — Suspicious
+  # activity has been observed
+  class SuspiciousAccActivity
+    SUSPICIOUS_ACC_ACTIVITY = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUSPICIOUS_ACC_ACTIVITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_01' then ENUM_01
+      when 'enum_02' then ENUM_02
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/svs_info.rb

@@ -0,0 +1,71 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SvsInfo Model.
+  class SvsInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant ID (MID) that the acquirer recognizes you by.
+    # @return [String]
+    attr_accessor :authorisation_mid
+
+    # The three-character ISO currency code, example **USD**
+    # @return [String]
+    attr_accessor :currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authorisation_mid'] = 'authorisationMid'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authorisation_mid:, currency_code:)
+      @authorisation_mid = authorisation_mid
+      @currency_code = currency_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      authorisation_mid =
+        hash.key?('authorisationMid') ? hash['authorisationMid'] : nil
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : nil
+
+      # Create object from extracted values.
+      SvsInfo.new(authorisation_mid: authorisation_mid,
+                  currency_code: currency_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorisation_mid: #{@authorisation_mid}, currency_code:"\
+      " #{@currency_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorisation_mid: #{@authorisation_mid.inspect}, currency_code:"\
+      " #{@currency_code.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/svs_info1.rb

@@ -0,0 +1,71 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Details to provide if `type` is **svs**.
+  class SvsInfo1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant ID (MID) that the acquirer recognizes you by.
+    # @return [String]
+    attr_accessor :authorisation_mid
+
+    # The three-character ISO currency code, example **USD**
+    # @return [String]
+    attr_accessor :currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authorisation_mid'] = 'authorisationMid'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authorisation_mid:, currency_code:)
+      @authorisation_mid = authorisation_mid
+      @currency_code = currency_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      authorisation_mid =
+        hash.key?('authorisationMid') ? hash['authorisationMid'] : nil
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : nil
+
+      # Create object from extracted values.
+      SvsInfo1.new(authorisation_mid: authorisation_mid,
+                   currency_code: currency_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorisation_mid: #{@authorisation_mid}, currency_code:"\
+      " #{@currency_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorisation_mid: #{@authorisation_mid.inspect}, currency_code:"\
+      " #{@currency_code.inspect}>"
+    end
+  end
+end