adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/forex_quote2.rb

@@ -0,0 +1,198 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module AdyenApIs
+  # The forex quote as returned in the response of the forex service.
+  class ForexQuote2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account name.
+    # @return [String]
+    attr_accessor :account
+
+    # The account type.
+    # @return [String]
+    attr_accessor :account_type
+
+    # The base amount.
+    # @return [Amount3]
+    attr_accessor :base_amount
+
+    # The base points.
+    # @return [Integer]
+    attr_accessor :base_points
+
+    # The buy rate.
+    # @return [Amount4]
+    attr_accessor :buy
+
+    # The interbank amount.
+    # @return [Amount5]
+    attr_accessor :interbank
+
+    # The reference assigned to the forex quote request.
+    # @return [String]
+    attr_accessor :reference
+
+    # The sell rate.
+    # @return [Amount6]
+    attr_accessor :sell
+
+    # The signature to validate the integrity.
+    # @return [String]
+    attr_accessor :signature
+
+    # The source of the forex quote.
+    # @return [String]
+    attr_accessor :source
+
+    # The type of forex.
+    # @return [String]
+    attr_accessor :type
+
+    # The date until which the forex quote is valid.
+    # @return [DateTime]
+    attr_accessor :valid_till
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['account_type'] = 'accountType'
+      @_hash['base_amount'] = 'baseAmount'
+      @_hash['base_points'] = 'basePoints'
+      @_hash['buy'] = 'buy'
+      @_hash['interbank'] = 'interbank'
+      @_hash['reference'] = 'reference'
+      @_hash['sell'] = 'sell'
+      @_hash['signature'] = 'signature'
+      @_hash['source'] = 'source'
+      @_hash['type'] = 'type'
+      @_hash['valid_till'] = 'validTill'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        account_type
+        base_amount
+        buy
+        interbank
+        reference
+        sell
+        signature
+        source
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(base_points:, valid_till:, account: SKIP, account_type: SKIP,
+                   base_amount: SKIP, buy: SKIP, interbank: SKIP,
+                   reference: SKIP, sell: SKIP, signature: SKIP, source: SKIP,
+                   type: SKIP)
+      @account = account unless account == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @base_amount = base_amount unless base_amount == SKIP
+      @base_points = base_points
+      @buy = buy unless buy == SKIP
+      @interbank = interbank unless interbank == SKIP
+      @reference = reference unless reference == SKIP
+      @sell = sell unless sell == SKIP
+      @signature = signature unless signature == SKIP
+      @source = source unless source == SKIP
+      @type = type unless type == SKIP
+      @valid_till = valid_till
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      base_points = hash.key?('basePoints') ? hash['basePoints'] : nil
+      valid_till = if hash.key?('validTill')
+                     (DateTimeHelper.from_rfc3339(hash['validTill']) if hash['validTill'])
+                   end
+      account = hash.key?('account') ? hash['account'] : SKIP
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      base_amount = Amount3.from_hash(hash['baseAmount']) if hash['baseAmount']
+      buy = Amount4.from_hash(hash['buy']) if hash['buy']
+      interbank = Amount5.from_hash(hash['interbank']) if hash['interbank']
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      sell = Amount6.from_hash(hash['sell']) if hash['sell']
+      signature = hash.key?('signature') ? hash['signature'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      ForexQuote2.new(base_points: base_points,
+                      valid_till: valid_till,
+                      account: account,
+                      account_type: account_type,
+                      base_amount: base_amount,
+                      buy: buy,
+                      interbank: interbank,
+                      reference: reference,
+                      sell: sell,
+                      signature: signature,
+                      source: source,
+                      type: type)
+    end
+
+    def to_custom_valid_till
+      DateTimeHelper.to_rfc3339(valid_till)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ForexQuote2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.base_points,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.valid_till,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['basePoints'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['validTill'],
+                                ->(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} account: #{@account}, account_type: #{@account_type}, base_amount:"\
+      " #{@base_amount}, base_points: #{@base_points}, buy: #{@buy}, interbank: #{@interbank},"\
+      " reference: #{@reference}, sell: #{@sell}, signature: #{@signature}, source: #{@source},"\
+      " type: #{@type}, valid_till: #{@valid_till}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account.inspect}, account_type: #{@account_type.inspect},"\
+      " base_amount: #{@base_amount.inspect}, base_points: #{@base_points.inspect}, buy:"\
+      " #{@buy.inspect}, interbank: #{@interbank.inspect}, reference: #{@reference.inspect}, sell:"\
+      " #{@sell.inspect}, signature: #{@signature.inspect}, source: #{@source.inspect}, type:"\
+      " #{@type.inspect}, valid_till: #{@valid_till.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/fraud_check_result.rb

@@ -0,0 +1,103 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # FraudCheckResult Model.
+  class FraudCheckResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The fraud score generated by the risk check.
+    # @return [Integer]
+    attr_accessor :account_score
+
+    # The ID of the risk check.
+    # @return [Integer]
+    attr_accessor :check_id
+
+    # The name of the risk check.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_score'] = 'accountScore'
+      @_hash['check_id'] = 'checkId'
+      @_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(account_score:, check_id:, name:)
+      @account_score = account_score
+      @check_id = check_id
+      @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.
+      account_score = hash.key?('accountScore') ? hash['accountScore'] : nil
+      check_id = hash.key?('checkId') ? hash['checkId'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      FraudCheckResult.new(account_score: account_score,
+                           check_id: check_id,
+                           name: name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FraudCheckResult | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.account_score,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.check_id,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['accountScore'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['checkId'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(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} account_score: #{@account_score}, check_id: #{@check_id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_score: #{@account_score.inspect}, check_id: #{@check_id.inspect},"\
+      " name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/fraud_result.rb

@@ -0,0 +1,79 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # FraudResult Model.
+  class FraudResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total fraud score generated by the risk checks.
+    # @return [Integer]
+    attr_accessor :account_score
+
+    # The result of the individual risk checks.
+    # @return [Array[FraudCheckResult]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_score'] = 'accountScore'
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_score:, results: SKIP)
+      @account_score = account_score
+      @results = results unless results == 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.
+      account_score = hash.key?('accountScore') ? hash['accountScore'] : nil
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (FraudCheckResult.from_hash(structure) if structure)
+        end
+      end
+
+      results = SKIP unless hash.key?('results')
+
+      # Create object from extracted values.
+      FraudResult.new(account_score: account_score,
+                      results: results)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_score: #{@account_score}, results: #{@results}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_score: #{@account_score.inspect}, results: #{@results.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/fraud_result1.rb

@@ -0,0 +1,93 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The fraud result properties of the payment.
+  class FraudResult1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total fraud score generated by the risk checks.
+    # @return [Integer]
+    attr_accessor :account_score
+
+    # The result of the individual risk checks.
+    # @return [Array[FraudCheckResult]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_score'] = 'accountScore'
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_score:, results: SKIP)
+      @account_score = account_score
+      @results = results unless results == 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.
+      account_score = hash.key?('accountScore') ? hash['accountScore'] : nil
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (FraudCheckResult.from_hash(structure) if structure)
+        end
+      end
+
+      results = SKIP unless hash.key?('results')
+
+      # Create object from extracted values.
+      FraudResult1.new(account_score: account_score,
+                       results: results)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FraudResult1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.account_score,
+                                     ->(val) { val.instance_of? Integer })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['accountScore'],
+                            ->(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} account_score: #{@account_score}, results: #{@results}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_score: #{@account_score.inspect}, results: #{@results.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/fraud_result_type.rb

@@ -0,0 +1,41 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The fraud result properties of the payment. Possible values: * AMBER * GREEN
+  # * RED
+  class FraudResultType
+    FRAUD_RESULT_TYPE = [
+      # TODO: Write general description for AMBER
+      AMBER = 'AMBER'.freeze,
+
+      # TODO: Write general description for GREEN
+      GREEN = 'GREEN'.freeze,
+
+      # TODO: Write general description for RED
+      RED = 'RED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FRAUD_RESULT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = AMBER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'amber' then AMBER
+      when 'green' then GREEN
+      when 'red' then RED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/fraud_risk_level.rb

@@ -0,0 +1,52 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The risk level of the transaction as classified by the [machine
+  # learning](https://docs.adyen.com/risk-management/configure-your-risk-profile
+  # /machine-learning-rules/) fraud risk rule. The risk level indicates the
+  # likelihood that a transaction will result in a fraudulent dispute. Possible
+  # values: * veryLow * low * medium * high * veryHigh
+  class FraudRiskLevel
+    FRAUD_RISK_LEVEL = [
+      # TODO: Write general description for VERYLOW
+      VERYLOW = 'veryLow'.freeze,
+
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'medium'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for VERYHIGH
+      VERYHIGH = 'veryHigh'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FRAUD_RISK_LEVEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = VERYLOW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verylow' then VERYLOW
+      when 'low' then LOW
+      when 'medium' then MEDIUM
+      when 'high' then HIGH
+      when 'veryhigh' then VERYHIGH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/frequency.rb

@@ -0,0 +1,62 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The frequency with which a shopper should be charged. Possible values:
+  # **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**,
+  # **halfYearly**, **yearly**.
+  class Frequency
+    FREQUENCY = [
+      # TODO: Write general description for ADHOC
+      ADHOC = 'adhoc'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'daily'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'weekly'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'biWeekly'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for HALFYEARLY
+      HALFYEARLY = 'halfYearly'.freeze,
+
+      # TODO: Write general description for YEARLY
+      YEARLY = 'yearly'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FREQUENCY.include?(value)
+    end
+
+    def self.from_value(value, default_value = ADHOC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'adhoc' then ADHOC
+      when 'daily' then DAILY
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'monthly' then MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'halfyearly' then HALFYEARLY
+      when 'yearly' then YEARLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/frequency2.rb

@@ -0,0 +1,48 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The frequency at which the shopper will be charged.
+  class Frequency2
+    FREQUENCY2 = [
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'weekly'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for HALFYEARLY
+      HALFYEARLY = 'half-yearly'.freeze,
+
+      # TODO: Write general description for YEARLY
+      YEARLY = 'yearly'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FREQUENCY2.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEEKLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'weekly' then WEEKLY
+      when 'monthly' then MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'halfyearly' then HALFYEARLY
+      when 'yearly' then YEARLY
+      else
+        default_value
+      end
+    end
+  end
+end