adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/application_info1.rb

@@ -0,0 +1,142 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Information about your application. For more details, see [Building Adyen
+  # solutions](https://docs.adyen.com/development-resources/building-adyen-solut
+  # ions).
+  class ApplicationInfo1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Adyen-developed software, such as libraries and plugins, used to interact
+    # with the Adyen API. For example, Magento plugin, Java API library, etc.
+    # @return [CommonField4]
+    attr_accessor :adyen_library
+
+    # Adyen-developed software to get payment details. For example, Checkout
+    # SDK, Secured Fields SDK, etc.
+    # @return [CommonField1]
+    attr_accessor :adyen_payment_source
+
+    # Third-party developed platform used to initiate payment requests. For
+    # example, Magento, Zuora, etc.
+    # @return [ExternalPlatform2]
+    attr_accessor :external_platform
+
+    # Merchant developed software, such as cashier application, used to interact
+    # with the Adyen API.
+    # @return [CommonField2]
+    attr_accessor :merchant_application
+
+    # Merchant device information.
+    # @return [MerchantDevice2]
+    attr_accessor :merchant_device
+
+    # Shopper interaction device, such as terminal, mobile device or web
+    # browser, to initiate payment requests.
+    # @return [ShopperInteractionDevice2]
+    attr_accessor :shopper_interaction_device
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['adyen_library'] = 'adyenLibrary'
+      @_hash['adyen_payment_source'] = 'adyenPaymentSource'
+      @_hash['external_platform'] = 'externalPlatform'
+      @_hash['merchant_application'] = 'merchantApplication'
+      @_hash['merchant_device'] = 'merchantDevice'
+      @_hash['shopper_interaction_device'] = 'shopperInteractionDevice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        adyen_library
+        adyen_payment_source
+        external_platform
+        merchant_application
+        merchant_device
+        shopper_interaction_device
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(adyen_library: SKIP, adyen_payment_source: SKIP,
+                   external_platform: SKIP, merchant_application: SKIP,
+                   merchant_device: SKIP, shopper_interaction_device: SKIP)
+      @adyen_library = adyen_library unless adyen_library == SKIP
+      @adyen_payment_source = adyen_payment_source unless adyen_payment_source == SKIP
+      @external_platform = external_platform unless external_platform == SKIP
+      @merchant_application = merchant_application unless merchant_application == SKIP
+      @merchant_device = merchant_device unless merchant_device == SKIP
+      unless shopper_interaction_device == SKIP
+        @shopper_interaction_device =
+          shopper_interaction_device
+      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.
+      adyen_library = CommonField4.from_hash(hash['adyenLibrary']) if hash['adyenLibrary']
+      adyen_payment_source = CommonField1.from_hash(hash['adyenPaymentSource']) if
+        hash['adyenPaymentSource']
+      external_platform = ExternalPlatform2.from_hash(hash['externalPlatform']) if
+        hash['externalPlatform']
+      merchant_application = CommonField2.from_hash(hash['merchantApplication']) if
+        hash['merchantApplication']
+      merchant_device = MerchantDevice2.from_hash(hash['merchantDevice']) if
+        hash['merchantDevice']
+      if hash['shopperInteractionDevice']
+        shopper_interaction_device = ShopperInteractionDevice2.from_hash(hash['shopperInteractionDevice'])
+      end
+
+      # Create object from extracted values.
+      ApplicationInfo1.new(adyen_library: adyen_library,
+                           adyen_payment_source: adyen_payment_source,
+                           external_platform: external_platform,
+                           merchant_application: merchant_application,
+                           merchant_device: merchant_device,
+                           shopper_interaction_device: shopper_interaction_device)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ApplicationInfo1 | 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} adyen_library: #{@adyen_library}, adyen_payment_source:"\
+      " #{@adyen_payment_source}, external_platform: #{@external_platform}, merchant_application:"\
+      " #{@merchant_application}, merchant_device: #{@merchant_device},"\
+      " shopper_interaction_device: #{@shopper_interaction_device}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} adyen_library: #{@adyen_library.inspect}, adyen_payment_source:"\
+      " #{@adyen_payment_source.inspect}, external_platform: #{@external_platform.inspect},"\
+      " merchant_application: #{@merchant_application.inspect}, merchant_device:"\
+      " #{@merchant_device.inspect}, shopper_interaction_device:"\
+      " #{@shopper_interaction_device.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/attempt_authentication.rb

@@ -0,0 +1,41 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Indicates when 3D Secure authentication should be attempted. This overrides
+  # all other rules, including [Dynamic 3D Secure
+  # settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).
+  # Possible values: * **always**: Perform 3D Secure authentication. *
+  # **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other
+  # national regulations require authentication, the transaction gets declined.
+  class AttemptAuthentication
+    ATTEMPT_AUTHENTICATION = [
+      # TODO: Write general description for ALWAYS
+      ALWAYS = 'always'.freeze,
+
+      # TODO: Write general description for NEVER
+      NEVER = 'never'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ATTEMPT_AUTHENTICATION.include?(value)
+    end
+
+    def self.from_value(value, default_value = ALWAYS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'always' then ALWAYS
+      when 'never' then NEVER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/authentication_data.rb

@@ -0,0 +1,97 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # AuthenticationData Model.
+  class AuthenticationData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates when 3D Secure authentication should be attempted. This
+    # overrides all other rules, including [Dynamic 3D Secure
+    # settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).
+    # Possible values:
+    # * **always**: Perform 3D Secure authentication.
+    # * **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other
+    # national regulations require authentication, the transaction gets
+    # declined.
+    # @return [AttemptAuthentication]
+    attr_accessor :attempt_authentication
+
+    # Required to trigger the [authentication-only
+    # flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only
+    # /). If set to **true**, you will only perform the 3D Secure 2
+    # authentication, and will not proceed to the payment authorization.
+    # Default: **false**.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :authentication_only
+
+    # Object with additional parameters for the 3D Secure authentication flow.
+    # @return [ThreeDsRequestData2]
+    attr_accessor :three_ds_request_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attempt_authentication'] = 'attemptAuthentication'
+      @_hash['authentication_only'] = 'authenticationOnly'
+      @_hash['three_ds_request_data'] = 'threeDSRequestData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attempt_authentication
+        authentication_only
+        three_ds_request_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attempt_authentication: SKIP, authentication_only: false,
+                   three_ds_request_data: SKIP)
+      @attempt_authentication = attempt_authentication unless attempt_authentication == SKIP
+      @authentication_only = authentication_only unless authentication_only == SKIP
+      @three_ds_request_data = three_ds_request_data unless three_ds_request_data == 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.
+      attempt_authentication =
+        hash.key?('attemptAuthentication') ? hash['attemptAuthentication'] : SKIP
+      authentication_only = hash['authenticationOnly'] ||= false
+      three_ds_request_data = ThreeDsRequestData2.from_hash(hash['threeDSRequestData']) if
+        hash['threeDSRequestData']
+
+      # Create object from extracted values.
+      AuthenticationData.new(attempt_authentication: attempt_authentication,
+                             authentication_only: authentication_only,
+                             three_ds_request_data: three_ds_request_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attempt_authentication: #{@attempt_authentication}, authentication_only:"\
+      " #{@authentication_only}, three_ds_request_data: #{@three_ds_request_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attempt_authentication: #{@attempt_authentication.inspect},"\
+      " authentication_only: #{@authentication_only.inspect}, three_ds_request_data:"\
+      " #{@three_ds_request_data.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/authentication_data1.rb

@@ -0,0 +1,97 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Configuration data for 3DS payments.
+  class AuthenticationData1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates when 3D Secure authentication should be attempted. This
+    # overrides all other rules, including [Dynamic 3D Secure
+    # settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).
+    # Possible values:
+    # * **always**: Perform 3D Secure authentication.
+    # * **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other
+    # national regulations require authentication, the transaction gets
+    # declined.
+    # @return [AttemptAuthentication]
+    attr_accessor :attempt_authentication
+
+    # Required to trigger the [authentication-only
+    # flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only
+    # /). If set to **true**, you will only perform the 3D Secure 2
+    # authentication, and will not proceed to the payment authorization.
+    # Default: **false**.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :authentication_only
+
+    # Object with additional parameters for the 3D Secure authentication flow.
+    # @return [ThreeDsRequestData2]
+    attr_accessor :three_ds_request_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attempt_authentication'] = 'attemptAuthentication'
+      @_hash['authentication_only'] = 'authenticationOnly'
+      @_hash['three_ds_request_data'] = 'threeDSRequestData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attempt_authentication
+        authentication_only
+        three_ds_request_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attempt_authentication: SKIP, authentication_only: false,
+                   three_ds_request_data: SKIP)
+      @attempt_authentication = attempt_authentication unless attempt_authentication == SKIP
+      @authentication_only = authentication_only unless authentication_only == SKIP
+      @three_ds_request_data = three_ds_request_data unless three_ds_request_data == 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.
+      attempt_authentication =
+        hash.key?('attemptAuthentication') ? hash['attemptAuthentication'] : SKIP
+      authentication_only = hash['authenticationOnly'] ||= false
+      three_ds_request_data = ThreeDsRequestData2.from_hash(hash['threeDSRequestData']) if
+        hash['threeDSRequestData']
+
+      # Create object from extracted values.
+      AuthenticationData1.new(attempt_authentication: attempt_authentication,
+                              authentication_only: authentication_only,
+                              three_ds_request_data: three_ds_request_data)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attempt_authentication: #{@attempt_authentication}, authentication_only:"\
+      " #{@authentication_only}, three_ds_request_data: #{@three_ds_request_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attempt_authentication: #{@attempt_authentication.inspect},"\
+      " authentication_only: #{@authentication_only.inspect}, three_ds_request_data:"\
+      " #{@three_ds_request_data.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/authentication_data3.rb

@@ -0,0 +1,107 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Data for 3DS authentication.
+  class AuthenticationData3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates when 3D Secure authentication should be attempted. This
+    # overrides all other rules, including [Dynamic 3D Secure
+    # settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).
+    # Possible values:
+    # * **always**: Perform 3D Secure authentication.
+    # * **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other
+    # national regulations require authentication, the transaction gets
+    # declined.
+    # @return [AttemptAuthentication]
+    attr_accessor :attempt_authentication
+
+    # Required to trigger the [authentication-only
+    # flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only
+    # /). If set to **true**, you will only perform the 3D Secure 2
+    # authentication, and will not proceed to the payment authorization.
+    # Default: **false**.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :authentication_only
+
+    # Object with additional parameters for the 3D Secure authentication flow.
+    # @return [ThreeDsRequestData2]
+    attr_accessor :three_ds_request_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attempt_authentication'] = 'attemptAuthentication'
+      @_hash['authentication_only'] = 'authenticationOnly'
+      @_hash['three_ds_request_data'] = 'threeDSRequestData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attempt_authentication
+        authentication_only
+        three_ds_request_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attempt_authentication: SKIP, authentication_only: false,
+                   three_ds_request_data: SKIP)
+      @attempt_authentication = attempt_authentication unless attempt_authentication == SKIP
+      @authentication_only = authentication_only unless authentication_only == SKIP
+      @three_ds_request_data = three_ds_request_data unless three_ds_request_data == 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.
+      attempt_authentication =
+        hash.key?('attemptAuthentication') ? hash['attemptAuthentication'] : SKIP
+      authentication_only = hash['authenticationOnly'] ||= false
+      three_ds_request_data = ThreeDsRequestData2.from_hash(hash['threeDSRequestData']) if
+        hash['threeDSRequestData']
+
+      # Create object from extracted values.
+      AuthenticationData3.new(attempt_authentication: attempt_authentication,
+                              authentication_only: authentication_only,
+                              three_ds_request_data: three_ds_request_data)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AuthenticationData3 | 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} attempt_authentication: #{@attempt_authentication}, authentication_only:"\
+      " #{@authentication_only}, three_ds_request_data: #{@three_ds_request_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attempt_authentication: #{@attempt_authentication.inspect},"\
+      " authentication_only: #{@authentication_only.inspect}, three_ds_request_data:"\
+      " #{@three_ds_request_data.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/authentication_method.rb

@@ -0,0 +1,36 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Allowed authentication methods: Magswipe, Manual Entry.
+  class AuthenticationMethod
+    AUTHENTICATION_METHOD = [
+      # TODO: Write general description for MAGSWIPE
+      MAGSWIPE = 'MAGSWIPE'.freeze,
+
+      # TODO: Write general description for MKE
+      MKE = 'MKE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTHENTICATION_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = MAGSWIPE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'magswipe' then MAGSWIPE
+      when 'mke' then MKE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/adyen_ap_is/models/authentication_response.rb

@@ -0,0 +1,45 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # In 3D Secure 2, this is the `transStatus` from the challenge result. If the
+  # transaction was frictionless, omit this parameter.
+  class AuthenticationResponse
+    AUTHENTICATION_RESPONSE = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze,
+
+      # TODO: Write general description for U
+      U = 'U'.freeze,
+
+      # TODO: Write general description for A
+      A = 'A'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTHENTICATION_RESPONSE.include?(value)
+    end
+
+    def self.from_value(value, default_value = Y)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'y' then Y
+      when 'n' then N
+      when 'u' then U
+      when 'a' then A
+      else
+        default_value
+      end
+    end
+  end
+end