adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/sepa_direct_debit_info1.rb

@@ -0,0 +1,77 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Details to provide if `type` is **sepadirectdebit**.
+  class SepaDirectDebitInfo1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Creditor id
+    # @return [String]
+    attr_accessor :creditor_id
+
+    # Information regarding the transaction description.
+    # > You cannot configure the transaction description in the test
+    # environment.
+    # @return [TransactionDescriptionInfo1]
+    attr_accessor :transaction_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['creditor_id'] = 'creditorId'
+      @_hash['transaction_description'] = 'transactionDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        creditor_id
+        transaction_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(creditor_id: SKIP, transaction_description: SKIP)
+      @creditor_id = creditor_id unless creditor_id == SKIP
+      @transaction_description = transaction_description unless transaction_description == 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.
+      creditor_id = hash.key?('creditorId') ? hash['creditorId'] : SKIP
+      if hash['transactionDescription']
+        transaction_description = TransactionDescriptionInfo1.from_hash(hash['transactionDescription'])
+      end
+
+      # Create object from extracted values.
+      SepaDirectDebitInfo1.new(creditor_id: creditor_id,
+                               transaction_description: transaction_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} creditor_id: #{@creditor_id}, transaction_description:"\
+      " #{@transaction_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} creditor_id: #{@creditor_id.inspect}, transaction_description:"\
+      " #{@transaction_description.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/service_level.rb

@@ -0,0 +1,45 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Specifies the service level (settlement type) of this payment method.
+  # Possible values: * **noContract**: Adyen holds the contract with American
+  # Express. * **gatewayContract**: American Express receives the settlement and
+  # handles disputes, then pays out to you or your sub-merchant directly. *
+  # **paymentDesignatorContract**: Adyen receives the settlement, and handles
+  # disputes and payouts.
+  class ServiceLevel
+    SERVICE_LEVEL = [
+      # TODO: Write general description for NOCONTRACT
+      NOCONTRACT = 'noContract'.freeze,
+
+      # TODO: Write general description for GATEWAYCONTRACT
+      GATEWAYCONTRACT = 'gatewayContract'.freeze,
+
+      # TODO: Write general description for PAYMENTDESIGNATORCONTRACT
+      PAYMENTDESIGNATORCONTRACT = 'paymentDesignatorContract'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_LEVEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOCONTRACT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nocontract' then NOCONTRACT
+      when 'gatewaycontract' then GATEWAYCONTRACT
+      when 'paymentdesignatorcontract' then PAYMENTDESIGNATORCONTRACT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/service_level1.rb

@@ -0,0 +1,40 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Specifies the service level (settlement type) of this payment method.
+  # Required for merchants operating in Japan. Possible values:  *
+  # **noContract**: Adyen holds the contract with JCB.  * **gatewayContract**:
+  # JCB receives the settlement and handles disputes, then pays out to you or
+  # your sub-merchant directly.
+  class ServiceLevel1
+    SERVICE_LEVEL1 = [
+      # TODO: Write general description for NOCONTRACT
+      NOCONTRACT = 'noContract'.freeze,
+
+      # TODO: Write general description for GATEWAYCONTRACT
+      GATEWAYCONTRACT = 'gatewayContract'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_LEVEL1.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOCONTRACT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nocontract' then NOCONTRACT
+      when 'gatewaycontract' then GATEWAYCONTRACT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/service_level2.rb

@@ -0,0 +1,48 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Specifies the service level (settlement type) of this payment method.
+  # Required for merchants operating in Japan. Possible values: *
+  # **noContract**: Adyen holds the contract with JCB for merchants operating in
+  # Japan or American Express for merchants operating in Canada, Australia and
+  # New Zealand. * **gatewayContract**: JCB or American Express receives the
+  # settlement and handles disputes, then pays out to you or your sub-merchant
+  # directly. * **paymentDesignatorContract**: Available only for merchants
+  # operating in Canada, Australia and New Zealand. Adyen receives the
+  # settlement, and handles disputes and payouts.
+  class ServiceLevel2
+    SERVICE_LEVEL2 = [
+      # TODO: Write general description for NOCONTRACT
+      NOCONTRACT = 'noContract'.freeze,
+
+      # TODO: Write general description for GATEWAYCONTRACT
+      GATEWAYCONTRACT = 'gatewayContract'.freeze,
+
+      # TODO: Write general description for PAYMENTDESIGNATORCONTRACT
+      PAYMENTDESIGNATORCONTRACT = 'paymentDesignatorContract'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_LEVEL2.include?(value)
+    end
+
+    def self.from_value(value, default_value = NOCONTRACT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nocontract' then NOCONTRACT
+      when 'gatewaycontract' then GATEWAYCONTRACT
+      when 'paymentdesignatorcontract' then PAYMENTDESIGNATORCONTRACT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/session_result_response.rb

@@ -0,0 +1,129 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # SessionResultResponse Model.
+  class SessionResultResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains additional information about the payment. Some fields are
+    # included only if you enable them. To enable these fields in your Customer
+    # Area, go to **Developers** > **Additional data**.
+    # @return [Hash[String, String]]
+    attr_accessor :additional_data
+
+    # A unique identifier of the session.
+    # @return [String]
+    attr_accessor :id
+
+    # A list of all authorised payments done for this session.
+    # @return [Array[Payment]]
+    attr_accessor :payments
+
+    # The unique reference that you provided in the original `/sessions`
+    # request. This identifies the payment and is used in all communication with
+    # you about the payment status.
+    # @return [String]
+    attr_accessor :reference
+
+    # The status of the session. The status included in the response doesn't get
+    # updated. Don't make the request again to check for payment status updates.
+    # Possible values:
+    # * **completed**: the shopper completed the payment, and the payment was
+    # authorized.
+    # * **paymentPending**: the shopper is in the process of making the payment.
+    # This applies to payment methods with an asynchronous flow, like voucher
+    # payments where the shopper completes the payment in a physical shop.
+    # * **refused**: the session has been refused, because of too many refused
+    # payment attempts. The shopper can no longer complete the payment with this
+    # session.
+    # * **canceled**: the shopper canceled the payment.
+    # * **expired**: the session expired. The shopper can no longer complete the
+    # payment with this session. By default, the session expires one hour after
+    # it is created.
+    # @return [Status4]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_data'] = 'additionalData'
+      @_hash['id'] = 'id'
+      @_hash['payments'] = 'payments'
+      @_hash['reference'] = 'reference'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_data
+        id
+        payments
+        reference
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_data: SKIP, id: SKIP, payments: SKIP,
+                   reference: SKIP, status: SKIP)
+      @additional_data = additional_data unless additional_data == SKIP
+      @id = id unless id == SKIP
+      @payments = payments unless payments == SKIP
+      @reference = reference unless reference == SKIP
+      @status = status unless status == 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.
+      additional_data =
+        hash.key?('additionalData') ? hash['additionalData'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['payments'].nil?
+        payments = []
+        hash['payments'].each do |structure|
+          payments << (Payment.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('payments')
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      SessionResultResponse.new(additional_data: additional_data,
+                                id: id,
+                                payments: payments,
+                                reference: reference,
+                                status: status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_data: #{@additional_data}, id: #{@id}, payments: #{@payments},"\
+      " reference: #{@reference}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_data: #{@additional_data.inspect}, id: #{@id.inspect}, payments:"\
+      " #{@payments.inspect}, reference: #{@reference.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/settings.rb

@@ -0,0 +1,82 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Settings Model.
+  class Settings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The preferred Wi-Fi band, for use if the terminals support multiple bands.
+    # Possible values: All, 2.4GHz, 5GHz.
+    # @return [String]
+    attr_accessor :band
+
+    # Indicates whether roaming is enabled on the terminals.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :roaming
+
+    # The connection time-out in seconds. Minimum value: 0.
+    # @return [Integer]
+    attr_accessor :timeout
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['band'] = 'band'
+      @_hash['roaming'] = 'roaming'
+      @_hash['timeout'] = 'timeout'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        band
+        roaming
+        timeout
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(band: SKIP, roaming: SKIP, timeout: SKIP)
+      @band = band unless band == SKIP
+      @roaming = roaming unless roaming == SKIP
+      @timeout = timeout unless timeout == 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.
+      band = hash.key?('band') ? hash['band'] : SKIP
+      roaming = hash.key?('roaming') ? hash['roaming'] : SKIP
+      timeout = hash.key?('timeout') ? hash['timeout'] : SKIP
+
+      # Create object from extracted values.
+      Settings.new(band: band,
+                   roaming: roaming,
+                   timeout: timeout)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} band: #{@band}, roaming: #{@roaming}, timeout: #{@timeout}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} band: #{@band.inspect}, roaming: #{@roaming.inspect}, timeout:"\
+      " #{@timeout.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/settings1.rb

@@ -0,0 +1,82 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # General Wi-Fi settings.
+  class Settings1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The preferred Wi-Fi band, for use if the terminals support multiple bands.
+    # Possible values: All, 2.4GHz, 5GHz.
+    # @return [String]
+    attr_accessor :band
+
+    # Indicates whether roaming is enabled on the terminals.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :roaming
+
+    # The connection time-out in seconds. Minimum value: 0.
+    # @return [Integer]
+    attr_accessor :timeout
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['band'] = 'band'
+      @_hash['roaming'] = 'roaming'
+      @_hash['timeout'] = 'timeout'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        band
+        roaming
+        timeout
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(band: SKIP, roaming: SKIP, timeout: SKIP)
+      @band = band unless band == SKIP
+      @roaming = roaming unless roaming == SKIP
+      @timeout = timeout unless timeout == 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.
+      band = hash.key?('band') ? hash['band'] : SKIP
+      roaming = hash.key?('roaming') ? hash['roaming'] : SKIP
+      timeout = hash.key?('timeout') ? hash['timeout'] : SKIP
+
+      # Create object from extracted values.
+      Settings1.new(band: band,
+                    roaming: roaming,
+                    timeout: timeout)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} band: #{@band}, roaming: #{@roaming}, timeout: #{@timeout}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} band: #{@band.inspect}, roaming: #{@roaming.inspect}, timeout:"\
+      " #{@timeout.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/ship_address_usage_ind.rb

@@ -0,0 +1,47 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicates when the shipping address used for this transaction was first used
+  # with the 3DS Requestor.  Allowed values: * **01** — This transaction *
+  # **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60
+  # days
+  class ShipAddressUsageInd
+    SHIP_ADDRESS_USAGE_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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIP_ADDRESS_USAGE_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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/ship_name_indicator.rb

@@ -0,0 +1,39 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicates if the Cardholder Name on the account is identical to the shipping
+  # Name used for this transaction.  Allowed values: * **01** — Account Name
+  # identical to shipping Name * **02** — Account Name different to shipping
+  # Name
+  class ShipNameIndicator
+    SHIP_NAME_INDICATOR = [
+      # 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?
+
+      SHIP_NAME_INDICATOR.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/shipping_location.rb

@@ -0,0 +1,91 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # ShippingLocation Model.
+  class ShippingLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The address details of the shipping location.
+    # @return [Address21]
+    attr_accessor :address
+
+    # The contact details for the shipping location.
+    # @return [Contact1]
+    attr_accessor :contact
+
+    # The unique identifier of the shipping location, for use as
+    # `shippingLocationId` when creating an order.
+    # @return [String]
+    attr_accessor :id
+
+    # The unique name of the shipping location.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['contact'] = 'contact'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        contact
+        id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address: SKIP, contact: SKIP, id: SKIP, name: SKIP)
+      @address = address unless address == SKIP
+      @contact = contact unless contact == SKIP
+      @id = id unless id == SKIP
+      @name = name unless name == 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.
+      address = Address21.from_hash(hash['address']) if hash['address']
+      contact = Contact1.from_hash(hash['contact']) if hash['contact']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      ShippingLocation.new(address: address,
+                           contact: contact,
+                           id: id,
+                           name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, contact: #{@contact}, id: #{@id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, contact: #{@contact.inspect}, id:"\
+      " #{@id.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end