adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/recurring.rb

@@ -0,0 +1,132 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module AdyenApIs
+  # Recurring Model.
+  class Recurring < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of recurring contract to be used.
+    # Possible values:
+    # * `ONECLICK` – Payment details can be used to initiate a one-click
+    # payment, where the shopper enters the [card security code
+    # (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#c
+    # ard-security-code-cvc-cvv-cid).
+    # * `RECURRING` – Payment details can be used without the card security code
+    # to initiate [card-not-present
+    # transactions](https://docs.adyen.com/payments-fundamentals/payment-glossar
+    # y#card-not-present-cnp).
+    # * `ONECLICK,RECURRING` – Payment details can be used regardless of whether
+    # the shopper is on your site or not.
+    # * `PAYOUT` – Payment details can be used to [make a
+    # payout](https://docs.adyen.com/online-payments/online-payouts).
+    # * `EXTERNAL` - Use this when you store payment details and send the raw
+    # card number or network token directly in your API request.
+    # @return [Contract]
+    attr_accessor :contract
+
+    # A descriptive name for this detail.
+    # @return [String]
+    attr_accessor :recurring_detail_name
+
+    # Date after which no further authorisations shall be performed. Only for 3D
+    # Secure 2.
+    # @return [DateTime]
+    attr_accessor :recurring_expiry
+
+    # Minimum number of days between authorisations. Only for 3D Secure 2.
+    # @return [String]
+    attr_accessor :recurring_frequency
+
+    # The name of the token service.
+    # @return [TokenService]
+    attr_accessor :token_service
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contract'] = 'contract'
+      @_hash['recurring_detail_name'] = 'recurringDetailName'
+      @_hash['recurring_expiry'] = 'recurringExpiry'
+      @_hash['recurring_frequency'] = 'recurringFrequency'
+      @_hash['token_service'] = 'tokenService'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contract
+        recurring_detail_name
+        recurring_expiry
+        recurring_frequency
+        token_service
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contract: SKIP, recurring_detail_name: SKIP,
+                   recurring_expiry: SKIP, recurring_frequency: SKIP,
+                   token_service: SKIP)
+      @contract = contract unless contract == SKIP
+      @recurring_detail_name = recurring_detail_name unless recurring_detail_name == SKIP
+      @recurring_expiry = recurring_expiry unless recurring_expiry == SKIP
+      @recurring_frequency = recurring_frequency unless recurring_frequency == SKIP
+      @token_service = token_service unless token_service == 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.
+      contract = hash.key?('contract') ? hash['contract'] : SKIP
+      recurring_detail_name =
+        hash.key?('recurringDetailName') ? hash['recurringDetailName'] : SKIP
+      recurring_expiry = if hash.key?('recurringExpiry')
+                           (DateTimeHelper.from_rfc3339(hash['recurringExpiry']) if hash['recurringExpiry'])
+                         else
+                           SKIP
+                         end
+      recurring_frequency =
+        hash.key?('recurringFrequency') ? hash['recurringFrequency'] : SKIP
+      token_service = hash.key?('tokenService') ? hash['tokenService'] : SKIP
+
+      # Create object from extracted values.
+      Recurring.new(contract: contract,
+                    recurring_detail_name: recurring_detail_name,
+                    recurring_expiry: recurring_expiry,
+                    recurring_frequency: recurring_frequency,
+                    token_service: token_service)
+    end
+
+    def to_custom_recurring_expiry
+      DateTimeHelper.to_rfc3339(recurring_expiry)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contract: #{@contract}, recurring_detail_name: #{@recurring_detail_name},"\
+      " recurring_expiry: #{@recurring_expiry}, recurring_frequency: #{@recurring_frequency},"\
+      " token_service: #{@token_service}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contract: #{@contract.inspect}, recurring_detail_name:"\
+      " #{@recurring_detail_name.inspect}, recurring_expiry: #{@recurring_expiry.inspect},"\
+      " recurring_frequency: #{@recurring_frequency.inspect}, token_service:"\
+      " #{@token_service.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/recurring2.rb

@@ -0,0 +1,134 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module AdyenApIs
+  # The recurring settings for the payment. Use this property when you want to
+  # enable [recurring
+  # payments](https://docs.adyen.com/classic-integration/recurring-payments).
+  class Recurring2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of recurring contract to be used.
+    # Possible values:
+    # * `ONECLICK` – Payment details can be used to initiate a one-click
+    # payment, where the shopper enters the [card security code
+    # (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#c
+    # ard-security-code-cvc-cvv-cid).
+    # * `RECURRING` – Payment details can be used without the card security code
+    # to initiate [card-not-present
+    # transactions](https://docs.adyen.com/payments-fundamentals/payment-glossar
+    # y#card-not-present-cnp).
+    # * `ONECLICK,RECURRING` – Payment details can be used regardless of whether
+    # the shopper is on your site or not.
+    # * `PAYOUT` – Payment details can be used to [make a
+    # payout](https://docs.adyen.com/online-payments/online-payouts).
+    # * `EXTERNAL` - Use this when you store payment details and send the raw
+    # card number or network token directly in your API request.
+    # @return [Contract]
+    attr_accessor :contract
+
+    # A descriptive name for this detail.
+    # @return [String]
+    attr_accessor :recurring_detail_name
+
+    # Date after which no further authorisations shall be performed. Only for 3D
+    # Secure 2.
+    # @return [DateTime]
+    attr_accessor :recurring_expiry
+
+    # Minimum number of days between authorisations. Only for 3D Secure 2.
+    # @return [String]
+    attr_accessor :recurring_frequency
+
+    # The name of the token service.
+    # @return [TokenService]
+    attr_accessor :token_service
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contract'] = 'contract'
+      @_hash['recurring_detail_name'] = 'recurringDetailName'
+      @_hash['recurring_expiry'] = 'recurringExpiry'
+      @_hash['recurring_frequency'] = 'recurringFrequency'
+      @_hash['token_service'] = 'tokenService'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contract
+        recurring_detail_name
+        recurring_expiry
+        recurring_frequency
+        token_service
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contract: SKIP, recurring_detail_name: SKIP,
+                   recurring_expiry: SKIP, recurring_frequency: SKIP,
+                   token_service: SKIP)
+      @contract = contract unless contract == SKIP
+      @recurring_detail_name = recurring_detail_name unless recurring_detail_name == SKIP
+      @recurring_expiry = recurring_expiry unless recurring_expiry == SKIP
+      @recurring_frequency = recurring_frequency unless recurring_frequency == SKIP
+      @token_service = token_service unless token_service == 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.
+      contract = hash.key?('contract') ? hash['contract'] : SKIP
+      recurring_detail_name =
+        hash.key?('recurringDetailName') ? hash['recurringDetailName'] : SKIP
+      recurring_expiry = if hash.key?('recurringExpiry')
+                           (DateTimeHelper.from_rfc3339(hash['recurringExpiry']) if hash['recurringExpiry'])
+                         else
+                           SKIP
+                         end
+      recurring_frequency =
+        hash.key?('recurringFrequency') ? hash['recurringFrequency'] : SKIP
+      token_service = hash.key?('tokenService') ? hash['tokenService'] : SKIP
+
+      # Create object from extracted values.
+      Recurring2.new(contract: contract,
+                     recurring_detail_name: recurring_detail_name,
+                     recurring_expiry: recurring_expiry,
+                     recurring_frequency: recurring_frequency,
+                     token_service: token_service)
+    end
+
+    def to_custom_recurring_expiry
+      DateTimeHelper.to_rfc3339(recurring_expiry)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contract: #{@contract}, recurring_detail_name: #{@recurring_detail_name},"\
+      " recurring_expiry: #{@recurring_expiry}, recurring_frequency: #{@recurring_frequency},"\
+      " token_service: #{@token_service}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contract: #{@contract.inspect}, recurring_detail_name:"\
+      " #{@recurring_detail_name.inspect}, recurring_expiry: #{@recurring_expiry.inspect},"\
+      " recurring_frequency: #{@recurring_frequency.inspect}, token_service:"\
+      " #{@token_service.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/recurring_processing_model.rb

@@ -0,0 +1,50 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Defines a recurring payment type. Required when creating a token to store
+  # payment details or using stored 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.
+  class RecurringProcessingModel
+    RECURRING_PROCESSING_MODEL = [
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'CardOnFile'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'Subscription'.freeze,
+
+      # TODO: Write general description for UNSCHEDULEDCARDONFILE
+      UNSCHEDULEDCARDONFILE = 'UnscheduledCardOnFile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECURRING_PROCESSING_MODEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARDONFILE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cardonfile' then CARDONFILE
+      when 'subscription' then SUBSCRIPTION
+      when 'unscheduledcardonfile' then UNSCHEDULEDCARDONFILE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/recurring_processing_model1.rb

@@ -0,0 +1,49 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # 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.
+  class RecurringProcessingModel1
+    RECURRING_PROCESSING_MODEL1 = [
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'CardOnFile'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'Subscription'.freeze,
+
+      # TODO: Write general description for UNSCHEDULEDCARDONFILE
+      UNSCHEDULEDCARDONFILE = 'UnscheduledCardOnFile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECURRING_PROCESSING_MODEL1.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARDONFILE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cardonfile' then CARDONFILE
+      when 'subscription' then SUBSCRIPTION
+      when 'unscheduledcardonfile' then UNSCHEDULEDCARDONFILE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/recurring_processing_model4.rb

@@ -0,0 +1,50 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Defines a recurring payment type. Required when `storePaymentMethodMode` is
+  # set to **askForConsent** or **enabled**. Possible 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 has variable
+  # amounts. For example, automatic top-ups when a cardholder's balance drops
+  # below a certain amount.
+  class RecurringProcessingModel4
+    RECURRING_PROCESSING_MODEL4 = [
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'CardOnFile'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'Subscription'.freeze,
+
+      # TODO: Write general description for UNSCHEDULEDCARDONFILE
+      UNSCHEDULEDCARDONFILE = 'UnscheduledCardOnFile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECURRING_PROCESSING_MODEL4.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARDONFILE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cardonfile' then CARDONFILE
+      when 'subscription' then SUBSCRIPTION
+      when 'unscheduledcardonfile' then UNSCHEDULEDCARDONFILE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/recurring_processing_model7.rb

@@ -0,0 +1,40 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The processing model used for the recurring transaction.
+  class RecurringProcessingModel7
+    RECURRING_PROCESSING_MODEL7 = [
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'CardOnFile'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'Subscription'.freeze,
+
+      # TODO: Write general description for UNSCHEDULEDCARDONFILE
+      UNSCHEDULEDCARDONFILE = 'UnscheduledCardOnFile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RECURRING_PROCESSING_MODEL7.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARDONFILE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cardonfile' then CARDONFILE
+      when 'subscription' then SUBSCRIPTION
+      when 'unscheduledcardonfile' then UNSCHEDULEDCARDONFILE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/referenced.rb

@@ -0,0 +1,67 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Referenced Model.
+  class Referenced < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether referenced refunds are enabled on the standalone
+    # terminal.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_standalone_refunds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['enable_standalone_refunds'] = 'enableStandaloneRefunds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enable_standalone_refunds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(enable_standalone_refunds: SKIP)
+      unless enable_standalone_refunds == SKIP
+        @enable_standalone_refunds =
+          enable_standalone_refunds
+      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.
+      enable_standalone_refunds =
+        hash.key?('enableStandaloneRefunds') ? hash['enableStandaloneRefunds'] : SKIP
+
+      # Create object from extracted values.
+      Referenced.new(enable_standalone_refunds: enable_standalone_refunds)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} enable_standalone_refunds: #{@enable_standalone_refunds}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} enable_standalone_refunds: #{@enable_standalone_refunds.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/referenced1.rb

@@ -0,0 +1,67 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Settings for referenced refunds.
+  class Referenced1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether referenced refunds are enabled on the standalone
+    # terminal.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_standalone_refunds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['enable_standalone_refunds'] = 'enableStandaloneRefunds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enable_standalone_refunds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(enable_standalone_refunds: SKIP)
+      unless enable_standalone_refunds == SKIP
+        @enable_standalone_refunds =
+          enable_standalone_refunds
+      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.
+      enable_standalone_refunds =
+        hash.key?('enableStandaloneRefunds') ? hash['enableStandaloneRefunds'] : SKIP
+
+      # Create object from extracted values.
+      Referenced1.new(enable_standalone_refunds: enable_standalone_refunds)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} enable_standalone_refunds: #{@enable_standalone_refunds}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} enable_standalone_refunds: #{@enable_standalone_refunds.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/refund_cost_allocation.rb

@@ -0,0 +1,37 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Deducts the refund costs from the specified balance account. Possible
+  # values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**
+  class RefundCostAllocation
+    REFUND_COST_ALLOCATION = [
+      # 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?
+
+      REFUND_COST_ALLOCATION.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