adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/pay_to_info1.rb

@@ -0,0 +1,72 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Details to provide if `type` is **payto**.
+  class PayToInfo1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant name displayed to the shopper in the Agreements
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # Represents the purpose of the Agreements created, it relates to the
+    # business type
+    # **Allowed values**: mortgage, utility, loan, gambling, retail, salary,
+    # personal, government, pension, tax, other
+    # @return [String]
+    attr_accessor :pay_to_purpose
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_name'] = 'merchantName'
+      @_hash['pay_to_purpose'] = 'payToPurpose'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_name:, pay_to_purpose:)
+      @merchant_name = merchant_name
+      @pay_to_purpose = pay_to_purpose
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      merchant_name = hash.key?('merchantName') ? hash['merchantName'] : nil
+      pay_to_purpose = hash.key?('payToPurpose') ? hash['payToPurpose'] : nil
+
+      # Create object from extracted values.
+      PayToInfo1.new(merchant_name: merchant_name,
+                     pay_to_purpose: pay_to_purpose)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_name: #{@merchant_name}, pay_to_purpose: #{@pay_to_purpose}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_name: #{@merchant_name.inspect}, pay_to_purpose:"\
+      " #{@pay_to_purpose.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/pay_to_payment_method.rb

@@ -0,0 +1,83 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'shopper_id_payment_method'
+
+module AdyenApIs
+  # PayToPaymentMethod Model.
+  class PayToPaymentMethod < ShopperIdPaymentMethod
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :shopper_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shopper_reference'] = 'shopperReference'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        shopper_reference
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(shopper_reference: SKIP, type: 'payTo',
+                   additional_properties: nil)
+      @shopper_reference = shopper_reference unless shopper_reference == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(type: type,
+            additional_properties: additional_properties)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      shopper_reference =
+        hash.key?('shopperReference') ? hash['shopperReference'] : SKIP
+      type = hash['type'] ||= 'payTo'
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PayToPaymentMethod.new(shopper_reference: shopper_reference,
+                             type: type,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, shopper_reference: #{@shopper_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, shopper_reference: #{@shopper_reference.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/pay_u.rb

@@ -0,0 +1,155 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # PayU Model.
+  class PayU < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout attempt identifier.
+    # @return [String]
+    attr_accessor :checkout_attempt_id
+
+    # This is the `recurringDetailReference` returned in the response when you
+    # created the token.
+    # @return [String]
+    attr_accessor :recurring_detail_reference
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :sdk_data
+
+    # The `shopperNotificationReference` returned in the response when you
+    # requested to notify the shopper. Used for recurring payment only.
+    # @return [String]
+    attr_accessor :shopper_notification_reference
+
+    # This is the `recurringDetailReference` returned in the response when you
+    # created the token.
+    # @return [String]
+    attr_accessor :stored_payment_method_id
+
+    # **payu_IN_upi**
+    # @return [String]
+    attr_reader :type
+
+    # The virtual payment address for UPI.
+    # @return [String]
+    attr_accessor :virtual_payment_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_attempt_id'] = 'checkoutAttemptId'
+      @_hash['recurring_detail_reference'] = 'recurringDetailReference'
+      @_hash['sdk_data'] = 'sdkData'
+      @_hash['shopper_notification_reference'] =
+        'shopperNotificationReference'
+      @_hash['stored_payment_method_id'] = 'storedPaymentMethodId'
+      @_hash['type'] = 'type'
+      @_hash['virtual_payment_address'] = 'virtualPaymentAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_attempt_id
+        recurring_detail_reference
+        sdk_data
+        shopper_notification_reference
+        stored_payment_method_id
+        virtual_payment_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(checkout_attempt_id: SKIP, recurring_detail_reference: SKIP,
+                   sdk_data: SKIP, shopper_notification_reference: SKIP,
+                   stored_payment_method_id: SKIP,
+                   virtual_payment_address: SKIP)
+      @checkout_attempt_id = checkout_attempt_id unless checkout_attempt_id == SKIP
+      unless recurring_detail_reference == SKIP
+        @recurring_detail_reference =
+          recurring_detail_reference
+      end
+      @sdk_data = sdk_data unless sdk_data == SKIP
+      unless shopper_notification_reference == SKIP
+        @shopper_notification_reference =
+          shopper_notification_reference
+      end
+      @stored_payment_method_id = stored_payment_method_id unless stored_payment_method_id == SKIP
+      @type = 'payu_IN_upi'
+      @virtual_payment_address = virtual_payment_address unless virtual_payment_address == 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
+      recurring_detail_reference =
+        hash.key?('recurringDetailReference') ? hash['recurringDetailReference'] : SKIP
+      sdk_data = hash.key?('sdkData') ? hash['sdkData'] : SKIP
+      shopper_notification_reference =
+        hash.key?('shopperNotificationReference') ? hash['shopperNotificationReference'] : SKIP
+      stored_payment_method_id =
+        hash.key?('storedPaymentMethodId') ? hash['storedPaymentMethodId'] : SKIP
+      virtual_payment_address =
+        hash.key?('virtualPaymentAddress') ? hash['virtualPaymentAddress'] : SKIP
+
+      # Create object from extracted values.
+      PayU.new(checkout_attempt_id: checkout_attempt_id,
+               recurring_detail_reference: recurring_detail_reference,
+               sdk_data: sdk_data,
+               shopper_notification_reference: shopper_notification_reference,
+               stored_payment_method_id: stored_payment_method_id,
+               virtual_payment_address: virtual_payment_address)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PayU | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(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} checkout_attempt_id: #{@checkout_attempt_id}, recurring_detail_reference:"\
+      " #{@recurring_detail_reference}, sdk_data: #{@sdk_data}, shopper_notification_reference:"\
+      " #{@shopper_notification_reference}, stored_payment_method_id:"\
+      " #{@stored_payment_method_id}, type: #{@type}, virtual_payment_address:"\
+      " #{@virtual_payment_address}>"
+    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},"\
+      " recurring_detail_reference: #{@recurring_detail_reference.inspect}, sdk_data:"\
+      " #{@sdk_data.inspect}, shopper_notification_reference:"\
+      " #{@shopper_notification_reference.inspect}, stored_payment_method_id:"\
+      " #{@stored_payment_method_id.inspect}, type: #{@type.inspect}, virtual_payment_address:"\
+      " #{@virtual_payment_address.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment.rb

@@ -0,0 +1,106 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Payment Model.
+  class Payment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authorised amount in the transaction.
+    # @return [Amount25]
+    attr_accessor :amount
+
+    # Only returned for `resultCode`: **Authorised**. 
+    # Details about the payment method used in the transaction.
+    # @return [PaymentResponse3]
+    attr_accessor :payment_method
+
+    # Adyen's 16-character reference associated with the transaction/request.
+    # This value is globally unique. Use this reference when you communicate
+    # with us about this request.
+    # @return [String]
+    attr_accessor :psp_reference
+
+    # The result of the payment. For more information, see [Result
+    # codes](https://docs.adyen.com/online-payments/payment-result-codes).
+    # Possible values:
+    # * **Authorised** – The payment was successfully authorised. This state
+    # serves as an indicator to proceed with the delivery of goods and services.
+    # This is a final state.
+    # * **Received** – Indicates the payment request was successfully received
+    # by Adyen, and will be processed. This is the initial state for all
+    # payments.
+    # * **Pending** – The payment order was successfully received but the final
+    # status of the payment is not available yet. This is common for payment
+    # methods with an asynchronous flow.
+    # @return [ResultCode2]
+    attr_accessor :result_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['payment_method'] = 'paymentMethod'
+      @_hash['psp_reference'] = 'pspReference'
+      @_hash['result_code'] = 'resultCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        payment_method
+        psp_reference
+        result_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, payment_method: SKIP, psp_reference: SKIP,
+                   result_code: SKIP)
+      @amount = amount unless amount == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @psp_reference = psp_reference unless psp_reference == SKIP
+      @result_code = result_code unless result_code == 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.
+      amount = Amount25.from_hash(hash['amount']) if hash['amount']
+      payment_method = PaymentResponse3.from_hash(hash['paymentMethod']) if hash['paymentMethod']
+      psp_reference = hash.key?('pspReference') ? hash['pspReference'] : SKIP
+      result_code = hash.key?('resultCode') ? hash['resultCode'] : SKIP
+
+      # Create object from extracted values.
+      Payment.new(amount: amount,
+                  payment_method: payment_method,
+                  psp_reference: psp_reference,
+                  result_code: result_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, payment_method: #{@payment_method}, psp_reference:"\
+      " #{@psp_reference}, result_code: #{@result_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, payment_method: #{@payment_method.inspect},"\
+      " psp_reference: #{@psp_reference.inspect}, result_code: #{@result_code.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment1.rb

@@ -0,0 +1,85 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Payment1 Model.
+  class Payment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The default currency for contactless payments on the payment terminal, in
+    # three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency
+    # code format.
+    # Contact Adyen before you update this setting for the first time. To enable
+    # you to change the contactless currency, we first need to check if you meet
+    # the compliance requirements.
+    # @return [String]
+    attr_accessor :contactless_currency
+
+    # Hides the minor units for the listed [ISO currency
+    # codes](https://en.wikipedia.org/wiki/ISO_4217).
+    # @return [Array[String]]
+    attr_accessor :hide_minor_units_in_currencies
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contactless_currency'] = 'contactlessCurrency'
+      @_hash['hide_minor_units_in_currencies'] = 'hideMinorUnitsInCurrencies'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contactless_currency
+        hide_minor_units_in_currencies
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contactless_currency: SKIP,
+                   hide_minor_units_in_currencies: SKIP)
+      @contactless_currency = contactless_currency unless contactless_currency == SKIP
+      unless hide_minor_units_in_currencies == SKIP
+        @hide_minor_units_in_currencies =
+          hide_minor_units_in_currencies
+      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.
+      contactless_currency =
+        hash.key?('contactlessCurrency') ? hash['contactlessCurrency'] : SKIP
+      hide_minor_units_in_currencies =
+        hash.key?('hideMinorUnitsInCurrencies') ? hash['hideMinorUnitsInCurrencies'] : SKIP
+
+      # Create object from extracted values.
+      Payment1.new(contactless_currency: contactless_currency,
+                   hide_minor_units_in_currencies: hide_minor_units_in_currencies)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contactless_currency: #{@contactless_currency},"\
+      " hide_minor_units_in_currencies: #{@hide_minor_units_in_currencies}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contactless_currency: #{@contactless_currency.inspect},"\
+      " hide_minor_units_in_currencies: #{@hide_minor_units_in_currencies.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment11.rb

@@ -0,0 +1,85 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Settings for payment features.
+  class Payment11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The default currency for contactless payments on the payment terminal, in
+    # three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency
+    # code format.
+    # Contact Adyen before you update this setting for the first time. To enable
+    # you to change the contactless currency, we first need to check if you meet
+    # the compliance requirements.
+    # @return [String]
+    attr_accessor :contactless_currency
+
+    # Hides the minor units for the listed [ISO currency
+    # codes](https://en.wikipedia.org/wiki/ISO_4217).
+    # @return [Array[String]]
+    attr_accessor :hide_minor_units_in_currencies
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contactless_currency'] = 'contactlessCurrency'
+      @_hash['hide_minor_units_in_currencies'] = 'hideMinorUnitsInCurrencies'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contactless_currency
+        hide_minor_units_in_currencies
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contactless_currency: SKIP,
+                   hide_minor_units_in_currencies: SKIP)
+      @contactless_currency = contactless_currency unless contactless_currency == SKIP
+      unless hide_minor_units_in_currencies == SKIP
+        @hide_minor_units_in_currencies =
+          hide_minor_units_in_currencies
+      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.
+      contactless_currency =
+        hash.key?('contactlessCurrency') ? hash['contactlessCurrency'] : SKIP
+      hide_minor_units_in_currencies =
+        hash.key?('hideMinorUnitsInCurrencies') ? hash['hideMinorUnitsInCurrencies'] : SKIP
+
+      # Create object from extracted values.
+      Payment11.new(contactless_currency: contactless_currency,
+                    hide_minor_units_in_currencies: hide_minor_units_in_currencies)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contactless_currency: #{@contactless_currency},"\
+      " hide_minor_units_in_currencies: #{@hide_minor_units_in_currencies}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contactless_currency: #{@contactless_currency.inspect},"\
+      " hide_minor_units_in_currencies: #{@hide_minor_units_in_currencies.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment_acc_ind.rb

@@ -0,0 +1,51 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicates the length of time that the payment account was enrolled in the
+  # cardholder’s account with the 3DS Requestor.  Allowed values: * **01** — No
+  # account (guest checkout) * **02** — During this transaction * **03** — Less
+  # than 30 days * **04** — 30–60 days * **05** — More than 60 days
+  class PaymentAccInd
+    PAYMENT_ACC_IND = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze,
+
+      # TODO: Write general description for ENUM_05
+      ENUM_05 = '05'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_ACC_IND.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
+      when 'enum_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      when 'enum_05' then ENUM_05
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment_account_indicator.rb

@@ -0,0 +1,50 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicator for the length of time since this payment method was added to this
+  # shopper's account. Allowed values: * notApplicable * thisTransaction *
+  # lessThan30Days * from30To60Days * moreThan60Days
+  class PaymentAccountIndicator
+    PAYMENT_ACCOUNT_INDICATOR = [
+      # TODO: Write general description for NOTAPPLICABLE
+      NOTAPPLICABLE = 'notApplicable'.freeze,
+
+      # TODO: Write general description for THISTRANSACTION
+      THISTRANSACTION = 'thisTransaction'.freeze,
+
+      # TODO: Write general description for LESSTHAN30DAYS
+      LESSTHAN30DAYS = 'lessThan30Days'.freeze,
+
+      # TODO: Write general description for FROM30TO60DAYS
+      FROM30TO60DAYS = 'from30To60Days'.freeze,
+
+      # TODO: Write general description for MORETHAN60DAYS
+      MORETHAN60DAYS = 'moreThan60Days'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_ACCOUNT_INDICATOR.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOTAPPLICABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'notapplicable' then NOTAPPLICABLE
+      when 'thistransaction' then THISTRANSACTION
+      when 'lessthan30days' then LESSTHAN30DAYS
+      when 'from30to60days' then FROM30TO60DAYS
+      when 'morethan60days' then MORETHAN60DAYS
+      else
+        default_value
+      end
+    end
+  end
+end