adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/phone2.rb

@@ -0,0 +1,86 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The work phone number provided by the cardholder. The phone number must
+  # consist of a country code, followed by the number. If the value you provide
+  # does not follow the guidelines, we do not submit it for authentication. >
+  # Required for Visa and JCB transactions that require 3D Secure 2
+  # authentication, if you did not include the `shopperEmail`, and did not send
+  # the shopper's phone number in `telephoneNumber`.
+  class Phone2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country code. Length: 1–3 digits.
+    # @return [String]
+    attr_accessor :cc
+
+    # Subscriber number. Length: 4-15  digits.
+    # @return [String]
+    attr_accessor :subscriber
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cc'] = 'cc'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cc
+        subscriber
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cc: SKIP, subscriber: SKIP)
+      @cc = cc unless cc == SKIP
+      @subscriber = subscriber unless subscriber == 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.
+      cc = hash.key?('cc') ? hash['cc'] : SKIP
+      subscriber = hash.key?('subscriber') ? hash['subscriber'] : SKIP
+
+      # Create object from extracted values.
+      Phone2.new(cc: cc,
+                 subscriber: subscriber)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Phone2 | 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} cc: #{@cc}, subscriber: #{@subscriber}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cc: #{@cc.inspect}, subscriber: #{@subscriber.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/phone3.rb

@@ -0,0 +1,86 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The home phone number provided by the cardholder. The phone number must
+  # consist of a country code, followed by the number. If the value you provide
+  # does not follow the guidelines, we do not submit it for authentication. >
+  # Required for Visa and JCB transactions that require 3D Secure 2
+  # authentication, if you did not include the `shopperEmail`, and did not send
+  # the shopper's phone number in `telephoneNumber`.
+  class Phone3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country code. Length: 1–3 digits.
+    # @return [String]
+    attr_accessor :cc
+
+    # Subscriber number. Length: 4-15  digits.
+    # @return [String]
+    attr_accessor :subscriber
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cc'] = 'cc'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cc
+        subscriber
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cc: SKIP, subscriber: SKIP)
+      @cc = cc unless cc == SKIP
+      @subscriber = subscriber unless subscriber == 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.
+      cc = hash.key?('cc') ? hash['cc'] : SKIP
+      subscriber = hash.key?('subscriber') ? hash['subscriber'] : SKIP
+
+      # Create object from extracted values.
+      Phone3.new(cc: cc,
+                 subscriber: subscriber)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Phone3 | 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} cc: #{@cc}, subscriber: #{@subscriber}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cc: #{@cc.inspect}, subscriber: #{@subscriber.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/pin_support.rb

@@ -0,0 +1,36 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # PIN Support. For ecommerce, PIN is required.
+  class PinSupport
+    PIN_SUPPORT = [
+      # TODO: Write general description for PIN
+      PIN = 'PIN'.freeze,
+
+      # TODO: Write general description for ENUM_NO_PIN
+      ENUM_NO_PIN = 'NO PIN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PIN_SUPPORT.include?(value)
+    end
+
+    def self.from_value(value, default_value = PIN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pin' then PIN
+      when 'enum_no_pin' then ENUM_NO_PIN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/pix_recurring.rb

@@ -0,0 +1,183 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # PixRecurring Model.
+  class PixRecurring < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date on which the shopper's payment method will be charged, in
+    # YYYY-MM-DD format.
+    # @return [String]
+    attr_accessor :billing_date
+
+    # Flag used to define whether liquidation can happen only on business days
+    # @return [TrueClass | FalseClass]
+    attr_accessor :business_day_only
+
+    # End date of the billing plan, in YYYY-MM-DD format. The end date must
+    # align with the frequency and the start date of the billing plan. If left
+    # blank, the subscription will continue indefinitely unless it is cancelled
+    # by the shopper.
+    # @return [String]
+    attr_accessor :ends_at
+
+    # The frequency at which the shopper will be charged.
+    # @return [Frequency2]
+    attr_accessor :frequency
+
+    # For a billing plan where the payment amounts are variable, the minimum
+    # amount to charge the shopper for each recurring payment. When a shopper
+    # approves the billing plan, they can also specify a maximum amount in their
+    # banking app.
+    # @return [Amount41]
+    attr_accessor :min_amount
+
+    # The pspReference for the failed recurring payment. Find this in
+    # AUTHORISATION webhook you received after the billing date.
+    # @return [String]
+    attr_accessor :original_psp_reference
+
+    # For a billing plan where the payment amount is fixed, the amount the
+    # shopper will be charged for each recurring payment.
+    # @return [Amount42]
+    attr_accessor :recurring_amount
+
+    # The text that that will be shown on the shopper's bank statement for the
+    # recurring payments. We recommend to add a descriptive text about the
+    # subscription to let your shoppers recognize your recurring payments.
+    # Maximum length: 35 characters.
+    # @return [String]
+    attr_accessor :recurring_statement
+
+    # When set to true, you can retry for failed recurring payments. The default
+    # value is true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :retry_policy
+
+    # Start date of the billing plan, in YYYY-MM-DD format. The default value is
+    # the transaction date.
+    # @return [String]
+    attr_accessor :starts_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_date'] = 'billingDate'
+      @_hash['business_day_only'] = 'businessDayOnly'
+      @_hash['ends_at'] = 'endsAt'
+      @_hash['frequency'] = 'frequency'
+      @_hash['min_amount'] = 'minAmount'
+      @_hash['original_psp_reference'] = 'originalPspReference'
+      @_hash['recurring_amount'] = 'recurringAmount'
+      @_hash['recurring_statement'] = 'recurringStatement'
+      @_hash['retry_policy'] = 'retryPolicy'
+      @_hash['starts_at'] = 'startsAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing_date
+        business_day_only
+        ends_at
+        frequency
+        min_amount
+        original_psp_reference
+        recurring_amount
+        recurring_statement
+        retry_policy
+        starts_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_date: SKIP, business_day_only: SKIP, ends_at: SKIP,
+                   frequency: SKIP, min_amount: SKIP,
+                   original_psp_reference: SKIP, recurring_amount: SKIP,
+                   recurring_statement: SKIP, retry_policy: SKIP,
+                   starts_at: SKIP)
+      @billing_date = billing_date unless billing_date == SKIP
+      @business_day_only = business_day_only unless business_day_only == SKIP
+      @ends_at = ends_at unless ends_at == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @min_amount = min_amount unless min_amount == SKIP
+      @original_psp_reference = original_psp_reference unless original_psp_reference == SKIP
+      @recurring_amount = recurring_amount unless recurring_amount == SKIP
+      @recurring_statement = recurring_statement unless recurring_statement == SKIP
+      @retry_policy = retry_policy unless retry_policy == SKIP
+      @starts_at = starts_at unless starts_at == 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.
+      billing_date = hash.key?('billingDate') ? hash['billingDate'] : SKIP
+      business_day_only =
+        hash.key?('businessDayOnly') ? hash['businessDayOnly'] : SKIP
+      ends_at = hash.key?('endsAt') ? hash['endsAt'] : SKIP
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      min_amount = Amount41.from_hash(hash['minAmount']) if hash['minAmount']
+      original_psp_reference =
+        hash.key?('originalPspReference') ? hash['originalPspReference'] : SKIP
+      recurring_amount = Amount42.from_hash(hash['recurringAmount']) if hash['recurringAmount']
+      recurring_statement =
+        hash.key?('recurringStatement') ? hash['recurringStatement'] : SKIP
+      retry_policy = hash.key?('retryPolicy') ? hash['retryPolicy'] : SKIP
+      starts_at = hash.key?('startsAt') ? hash['startsAt'] : SKIP
+
+      # Create object from extracted values.
+      PixRecurring.new(billing_date: billing_date,
+                       business_day_only: business_day_only,
+                       ends_at: ends_at,
+                       frequency: frequency,
+                       min_amount: min_amount,
+                       original_psp_reference: original_psp_reference,
+                       recurring_amount: recurring_amount,
+                       recurring_statement: recurring_statement,
+                       retry_policy: retry_policy,
+                       starts_at: starts_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PixRecurring | 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} billing_date: #{@billing_date}, business_day_only: #{@business_day_only},"\
+      " ends_at: #{@ends_at}, frequency: #{@frequency}, min_amount: #{@min_amount},"\
+      " original_psp_reference: #{@original_psp_reference}, recurring_amount:"\
+      " #{@recurring_amount}, recurring_statement: #{@recurring_statement}, retry_policy:"\
+      " #{@retry_policy}, starts_at: #{@starts_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_date: #{@billing_date.inspect}, business_day_only:"\
+      " #{@business_day_only.inspect}, ends_at: #{@ends_at.inspect}, frequency:"\
+      " #{@frequency.inspect}, min_amount: #{@min_amount.inspect}, original_psp_reference:"\
+      " #{@original_psp_reference.inspect}, recurring_amount: #{@recurring_amount.inspect},"\
+      " recurring_statement: #{@recurring_statement.inspect}, retry_policy:"\
+      " #{@retry_policy.inspect}, starts_at: #{@starts_at.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/plan.rb

@@ -0,0 +1,72 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # The installment plan, used for [card installments in
+  # Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments
+  # #make-a-payment-japan). and
+  # [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installmen
+  # ts/#getting-paid-mexico). By default, this is set to **regular**.
+  class Plan
+    PLAN = [
+      # TODO: Write general description for BONUS
+      BONUS = 'bonus'.freeze,
+
+      # TODO: Write general description for BUYNOW_PAYLATER
+      BUYNOW_PAYLATER = 'buynow_paylater'.freeze,
+
+      # TODO: Write general description for INTERES_REFUND_PRCTG
+      INTERES_REFUND_PRCTG = 'interes_refund_prctg'.freeze,
+
+      # TODO: Write general description for INTEREST_BONUS
+      INTEREST_BONUS = 'interest_bonus'.freeze,
+
+      # TODO: Write general description for NOINTERES_REFUND_PRCTG
+      NOINTERES_REFUND_PRCTG = 'nointeres_refund_prctg'.freeze,
+
+      # TODO: Write general description for NOINTEREST_BONUS
+      NOINTEREST_BONUS = 'nointerest_bonus'.freeze,
+
+      # TODO: Write general description for REFUND_PRCTG
+      REFUND_PRCTG = 'refund_prctg'.freeze,
+
+      # TODO: Write general description for REGULAR
+      REGULAR = 'regular'.freeze,
+
+      # TODO: Write general description for REVOLVING
+      REVOLVING = 'revolving'.freeze,
+
+      # TODO: Write general description for WITH_INTEREST
+      WITH_INTEREST = 'with_interest'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PLAN.include?(value)
+    end
+
+    def self.from_value(value, default_value = BONUS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bonus' then BONUS
+      when 'buynow_paylater' then BUYNOW_PAYLATER
+      when 'interes_refund_prctg' then INTERES_REFUND_PRCTG
+      when 'interest_bonus' then INTEREST_BONUS
+      when 'nointeres_refund_prctg' then NOINTERES_REFUND_PRCTG
+      when 'nointerest_bonus' then NOINTEREST_BONUS
+      when 'refund_prctg' then REFUND_PRCTG
+      when 'regular' then REGULAR
+      when 'revolving' then REVOLVING
+      when 'with_interest' then WITH_INTEREST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/plan1.rb

@@ -0,0 +1,68 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Plan1.
+  class Plan1
+    PLAN1 = [
+      # TODO: Write general description for BONUS
+      BONUS = 'bonus'.freeze,
+
+      # TODO: Write general description for BUYNOW_PAYLATER
+      BUYNOW_PAYLATER = 'buynow_paylater'.freeze,
+
+      # TODO: Write general description for INTERES_REFUND_PRCTG
+      INTERES_REFUND_PRCTG = 'interes_refund_prctg'.freeze,
+
+      # TODO: Write general description for INTEREST_BONUS
+      INTEREST_BONUS = 'interest_bonus'.freeze,
+
+      # TODO: Write general description for NOINTERES_REFUND_PRCTG
+      NOINTERES_REFUND_PRCTG = 'nointeres_refund_prctg'.freeze,
+
+      # TODO: Write general description for NOINTEREST_BONUS
+      NOINTEREST_BONUS = 'nointerest_bonus'.freeze,
+
+      # TODO: Write general description for REFUND_PRCTG
+      REFUND_PRCTG = 'refund_prctg'.freeze,
+
+      # TODO: Write general description for REGULAR
+      REGULAR = 'regular'.freeze,
+
+      # TODO: Write general description for REVOLVING
+      REVOLVING = 'revolving'.freeze,
+
+      # TODO: Write general description for WITH_INTEREST
+      WITH_INTEREST = 'with_interest'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PLAN1.include?(value)
+    end
+
+    def self.from_value(value, default_value = BONUS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bonus' then BONUS
+      when 'buynow_paylater' then BUYNOW_PAYLATER
+      when 'interes_refund_prctg' then INTERES_REFUND_PRCTG
+      when 'interest_bonus' then INTEREST_BONUS
+      when 'nointeres_refund_prctg' then NOINTERES_REFUND_PRCTG
+      when 'nointerest_bonus' then NOINTEREST_BONUS
+      when 'refund_prctg' then REFUND_PRCTG
+      when 'regular' then REGULAR
+      when 'revolving' then REVOLVING
+      when 'with_interest' then WITH_INTEREST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/platform_chargeback_logic.rb

@@ -0,0 +1,90 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # PlatformChargebackLogic Model.
+  class PlatformChargebackLogic < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The method of handling the chargeback.
+    # Possible values: **deductFromLiableAccount**,
+    # **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
+    # @return [Behavior]
+    attr_accessor :behavior
+
+    # The unique identifier of the balance account to which the chargeback fees
+    # are booked. By default, the chargeback fees are booked to your liable
+    # balance account.
+    # @return [String]
+    attr_accessor :cost_allocation_account
+
+    # The unique identifier of the balance account against which the disputed
+    # amount is booked.
+    # Required if `behavior` is **deductFromOneBalanceAccount**.
+    # @return [String]
+    attr_accessor :target_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['behavior'] = 'behavior'
+      @_hash['cost_allocation_account'] = 'costAllocationAccount'
+      @_hash['target_account'] = 'targetAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        behavior
+        cost_allocation_account
+        target_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(behavior: SKIP, cost_allocation_account: SKIP,
+                   target_account: SKIP)
+      @behavior = behavior unless behavior == SKIP
+      @cost_allocation_account = cost_allocation_account unless cost_allocation_account == SKIP
+      @target_account = target_account unless target_account == 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.
+      behavior = hash.key?('behavior') ? hash['behavior'] : SKIP
+      cost_allocation_account =
+        hash.key?('costAllocationAccount') ? hash['costAllocationAccount'] : SKIP
+      target_account = hash.key?('targetAccount') ? hash['targetAccount'] : SKIP
+
+      # Create object from extracted values.
+      PlatformChargebackLogic.new(behavior: behavior,
+                                  cost_allocation_account: cost_allocation_account,
+                                  target_account: target_account)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} behavior: #{@behavior}, cost_allocation_account:"\
+      " #{@cost_allocation_account}, target_account: #{@target_account}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} behavior: #{@behavior.inspect}, cost_allocation_account:"\
+      " #{@cost_allocation_account.inspect}, target_account: #{@target_account.inspect}>"
+    end
+  end
+end