adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/configuration.rb

@@ -0,0 +1,180 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      DEFAULT1 = 'default1'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'default' then DEFAULT
+      when 'default1' then DEFAULT1
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :api_key_auth_credentials, :basic_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      api_key_auth_credentials: nil, basic_auth_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding Custom Header Signature credentials
+      @api_key_auth_credentials = api_key_auth_credentials
+
+      # The object holding Basic Authentication credentials
+      @basic_auth_credentials = basic_auth_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, api_key_auth_credentials: nil,
+                   basic_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      api_key_auth_credentials ||= self.api_key_auth_credentials
+      basic_auth_credentials ||= self.basic_auth_credentials
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        logging_configuration: logging_configuration,
+                        environment: environment,
+                        api_key_auth_credentials: api_key_auth_credentials,
+                        basic_auth_credentials: basic_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://checkout-test.adyen.com/v71',
+        Server::DEFAULT1 => 'https://management-test.adyen.com/v3'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      api_key_auth_credentials = ApiKeyAuthCredentials.from_env
+      basic_auth_credentials = BasicAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        api_key_auth_credentials: api_key_auth_credentials,
+        basic_auth_credentials: basic_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/adyen_ap_is/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/exceptions/default_error_response_entity_exception.rb

@@ -0,0 +1,97 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Standardized error response following RFC-7807 format
+  class DefaultErrorResponseEntityException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A human-readable explanation specific to this occurrence of the problem.
+    # @return [String]
+    attr_accessor :detail
+
+    # Unique business error code.
+    # @return [String]
+    attr_accessor :error_code
+
+    # A URI that identifies the specific occurrence of the problem if
+    # applicable.
+    # @return [String]
+    attr_accessor :instance
+
+    # Array of fields with validation errors when applicable.
+    # @return [Array[InvalidField]]
+    attr_accessor :invalid_fields
+
+    # The unique reference for the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # The HTTP status code.
+    # @return [Integer]
+    attr_accessor :status
+
+    # A short, human-readable summary of the problem type.
+    # @return [String]
+    attr_accessor :title
+
+    # A URI that identifies the validation error type. It points to
+    # human-readable documentation for the problem type.
+    # @return [String]
+    attr_accessor :type
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @instance = hash.key?('instance') ? hash['instance'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      @invalid_fields = nil
+      unless hash['invalidFields'].nil?
+        @invalid_fields = []
+        hash['invalidFields'].each do |structure|
+          @invalid_fields << (InvalidField.from_hash(structure) if structure)
+        end
+      end
+
+      @invalid_fields = SKIP unless hash.key?('invalidFields')
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      @title = hash.key?('title') ? hash['title'] : SKIP
+      @type = hash.key?('type') ? hash['type'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} detail: #{@detail}, error_code: #{@error_code}, instance: #{@instance},"\
+      " invalid_fields: #{@invalid_fields}, request_id: #{@request_id}, status: #{@status}, title:"\
+      " #{@title}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} detail: #{@detail.inspect}, error_code: #{@error_code.inspect}, instance:"\
+      " #{@instance.inspect}, invalid_fields: #{@invalid_fields.inspect}, request_id:"\
+      " #{@request_id.inspect}, status: #{@status.inspect}, title: #{@title.inspect}, type:"\
+      " #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/exceptions/rest_service_error_exception.rb

@@ -0,0 +1,102 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # RestServiceError class.
+  class RestServiceErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A human-readable explanation specific to this occurrence of the problem.
+    # @return [String]
+    attr_accessor :detail
+
+    # A code that identifies the problem type.
+    # @return [String]
+    attr_accessor :error_code
+
+    # A unique URI that identifies the specific occurrence of the problem.
+    # @return [String]
+    attr_accessor :instance
+
+    # Detailed explanation of each validation error, when applicable.
+    # @return [Array[InvalidField]]
+    attr_accessor :invalid_fields
+
+    # A unique reference for the request, essentially the same as
+    # `pspReference`.
+    # @return [String]
+    attr_accessor :request_id
+
+    # JSON response payload.
+    # @return [Object]
+    attr_accessor :response
+
+    # The HTTP status code.
+    # @return [Integer]
+    attr_accessor :status
+
+    # A short, human-readable summary of the problem type.
+    # @return [String]
+    attr_accessor :title
+
+    # A URI that identifies the problem type, pointing to human-readable
+    # documentation on this problem type.
+    # @return [String]
+    attr_accessor :type
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @detail = hash.key?('detail') ? hash['detail'] : nil
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @instance = hash.key?('instance') ? hash['instance'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      @invalid_fields = nil
+      unless hash['invalidFields'].nil?
+        @invalid_fields = []
+        hash['invalidFields'].each do |structure|
+          @invalid_fields << (InvalidField.from_hash(structure) if structure)
+        end
+      end
+
+      @invalid_fields = SKIP unless hash.key?('invalidFields')
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+      @response = hash.key?('response') ? hash['response'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : nil
+      @title = hash.key?('title') ? hash['title'] : nil
+      @type = hash.key?('type') ? hash['type'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} detail: #{@detail}, error_code: #{@error_code}, instance: #{@instance},"\
+      " invalid_fields: #{@invalid_fields}, request_id: #{@request_id}, response: #{@response},"\
+      " status: #{@status}, title: #{@title}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} detail: #{@detail.inspect}, error_code: #{@error_code.inspect}, instance:"\
+      " #{@instance.inspect}, invalid_fields: #{@invalid_fields.inspect}, request_id:"\
+      " #{@request_id.inspect}, response: #{@response.inspect}, status: #{@status.inspect}, title:"\
+      " #{@title.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/exceptions/service_error_exception.rb

@@ -0,0 +1,78 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # ServiceError class.
+  class ServiceErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains additional information about the payment. Some data fields are
+    # included only if you select them first. Go to **Customer Area** >
+    # **Developers** > **Additional data**.
+    # @return [Hash[String, String]]
+    attr_accessor :additional_data
+
+    # The error code mapped to the error message.
+    # @return [String]
+    attr_accessor :error_code
+
+    # The category of the error.
+    # @return [String]
+    attr_accessor :error_type
+
+    # A short explanation of the issue.
+    # @return [String]
+    attr_accessor :message
+
+    # The PSP reference of the payment.
+    # @return [String]
+    attr_accessor :psp_reference
+
+    # The HTTP response status.
+    # @return [Integer]
+    attr_accessor :status
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @additional_data =
+        hash.key?('additionalData') ? hash['additionalData'] : SKIP
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_type = hash.key?('errorType') ? hash['errorType'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+      @psp_reference = hash.key?('pspReference') ? hash['pspReference'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+    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}, error_code: #{@error_code},"\
+      " error_type: #{@error_type}, message: #{@message}, psp_reference: #{@psp_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}, error_code:"\
+      " #{@error_code.inspect}, error_type: #{@error_type.inspect}, message: #{@message.inspect},"\
+      " psp_reference: #{@psp_reference.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/http/api_response.rb

@@ -0,0 +1,19 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/adyen_ap_is/http/auth/api_key_auth.rb

@@ -0,0 +1,52 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Utility class for custom header authorization.
+  class ApiKeyAuth < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ApiKeyAuth: x_api_key is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(api_key_auth_credentials)
+      auth_params = {}
+      auth_params['X-API-Key'] = api_key_auth_credentials.x_api_key unless
+        api_key_auth_credentials.nil? || api_key_auth_credentials.x_api_key.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for ApiKeyAuthCredentials.
+  # Data class for ApiKeyAuthCredentials.
+  class ApiKeyAuthCredentials
+    attr_reader :x_api_key
+
+    def initialize(x_api_key:)
+      raise ArgumentError, 'x_api_key cannot be nil' if x_api_key.nil?
+
+      @x_api_key = x_api_key
+    end
+
+    def self.from_env
+      x_api_key = ENV['API_KEY_AUTH_X_API_KEY']
+      all_nil = [
+        x_api_key
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(x_api_key: x_api_key)
+    end
+
+    def clone_with(x_api_key: nil)
+      x_api_key ||= self.x_api_key
+
+      ApiKeyAuthCredentials.new(x_api_key: x_api_key)
+    end
+  end
+end

data/lib/adyen_ap_is/http/auth/basic_auth.rb

@@ -0,0 +1,62 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Utility class for basic authorization.
+  class BasicAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BasicAuth: username or password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(basic_auth_credentials)
+      auth_params = {}
+      unless basic_auth_credentials.nil? ||
+             basic_auth_credentials.username.nil? ||
+             basic_auth_credentials.password.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(basic_auth_credentials.username,
+                                                       basic_auth_credentials.password)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for BasicAuthCredentials.
+  class BasicAuthCredentials
+    attr_reader :username, :password
+
+    def initialize(username:, password:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @username = username
+      @password = password
+    end
+
+    def self.from_env
+      username = ENV['BASIC_AUTH_USERNAME']
+      password = ENV['BASIC_AUTH_PASSWORD']
+      all_nil = [
+        username,
+        password
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(username: username, password: password)
+    end
+
+    def clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicAuthCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/adyen_ap_is/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/adyen_ap_is/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/adyen_ap_is/http/http_request.rb

@@ -0,0 +1,10 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/adyen_ap_is/http/http_response.rb

@@ -0,0 +1,10 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/adyen_ap_is/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end