univapay-client-sdk 1.0.0

data/lib/univapay_client_sdk/configuration.rb

@@ -0,0 +1,179 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Production Server
+    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
+    ].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?
+
+      default_value
+    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, :base_url, :bearer_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, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put get put], http_callback: nil,
+      proxy_settings: nil, logging_configuration: nil,
+      environment: Environment::PRODUCTION,
+      base_url: 'https://api.univapay.com', bearer_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)
+
+      # Base URL for the API
+      @base_url = base_url
+
+      # The object holding OAuth 2 Bearer token credentials
+      @bearer_auth_credentials = bearer_auth_credentials
+
+      # Initializing OAuth 2 Bearer token credentials with the provided auth parameters
+      @bearer_auth_credentials = bearer_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, base_url: nil,
+                   bearer_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
+      base_url ||= self.base_url
+      bearer_auth_credentials ||= self.bearer_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, base_url: base_url,
+                        bearer_auth_credentials: bearer_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => '{baseUrl}'
+      }
+    }.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)
+      parameters = {
+        'baseUrl' => { 'value' => base_url, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    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'))
+      base_url = ENV.fetch('BASE_URL', 'https://api.univapay.com')
+      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, 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 get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      bearer_auth_credentials = BearerAuthCredentials.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,
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        bearer_auth_credentials: bearer_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/univapay_client_sdk/events/unknown_event.rb

@@ -0,0 +1,32 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Represents an unrecognized or unsupported event during processing.
+  class UnknownEvent
+    # @return [Array<String>]
+    attr_reader :errors
+
+    # Initialize with the errors that caused the failure.
+    # @param errors [Array<String>] A list of error messages describing the reasons for verification failure.
+    def initialize(errors)
+      @errors = errors
+    end
+
+    # Provides a user-friendly string representation of the failure.
+    # @return [String]
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    # @return [String]
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors.inspect}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/bank_transfer_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # BankTransferHandler is responsible for verifying request signatures
+  # and parsing incoming bank-transfer events into strongly typed objects.
+  class BankTransferHandler
+    include CoreLibrary
+    # Creates a new instance of the BankTransferHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[BankTransferStatusWebhookCallback, UnknownEvent]
+    # BankTransferStatusWebhookCallback for successful parsing;
+    #
+    # UnknownEvent for unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:BankTransfer)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/cancel_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # CancelHandler is responsible for verifying request signatures
+  # and parsing incoming cancel events into strongly typed objects.
+  class CancelHandler
+    include CoreLibrary
+    # Creates a new instance of the CancelHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[CancelWebhookCallback, UnknownEvent]
+    # CancelWebhookCallback for successful parsing;
+    # UnknownEvent for
+    # unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Cancel)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/charge_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # ChargeHandler is responsible for verifying request signatures
+  # and parsing incoming charge events into strongly typed objects.
+  class ChargeHandler
+    include CoreLibrary
+    # Creates a new instance of the ChargeHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[ChargeWebhookEvent, UnknownEvent]
+    # ChargeWebhookEvent for successful parsing;
+    # UnknownEvent for unknown
+    # events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Charge)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/customs_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # CustomsHandler is responsible for verifying request signatures
+  # and parsing incoming customs events into strongly typed objects.
+  class CustomsHandler
+    include CoreLibrary
+    # Creates a new instance of the CustomsHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[CustomsDeclarationWebhookCallback, UnknownEvent]
+    # CustomsDeclarationWebhookCallback for successful parsing;
+    #
+    # UnknownEvent for unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Customs)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/refund_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # RefundHandler is responsible for verifying request signatures
+  # and parsing incoming refund events into strongly typed objects.
+  class RefundHandler
+    include CoreLibrary
+    # Creates a new instance of the RefundHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[RefundWebhookCallback, UnknownEvent]
+    # RefundWebhookCallback for successful parsing;
+    # UnknownEvent for
+    # unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Refund)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/subscription_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # SubscriptionHandler is responsible for verifying request signatures
+  # and parsing incoming subscription events into strongly typed objects.
+  class SubscriptionHandler
+    include CoreLibrary
+    # Creates a new instance of the SubscriptionHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[SubscriptionWebhookEvent, UnknownEvent]
+    # SubscriptionWebhookEvent for successful parsing;
+    # UnknownEvent for
+    # unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Subscription)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/events/webhooks/token_handler.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # TokenHandler is responsible for verifying request signatures
+  # and parsing incoming token events into strongly typed objects.
+  class TokenHandler
+    include CoreLibrary
+    # Creates a new instance of the TokenHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[TokenWebhookEvent, UnknownEvent]
+    # TokenWebhookEvent for successful parsing;
+    # UnknownEvent for unknown
+    # events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Token)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/exceptions/api_error_exception.rb

@@ -0,0 +1,199 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Standard API error response payload.
+  class ApiErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Always returns 'error'.
+    # @return [String]
+    attr_reader :status
+
+    # API Request Error Codes.
+    # | HTTP | Error Code | Description |
+    # | :--- | :--- | :--- |
+    # | 400 | ALREADY_CAPTURED | The target charge is already captured or
+    # authorization is incomplete. |
+    # | 400 | AUTH_NOT_SUPPORTED | The configured gateway does not support
+    # authorization. |
+    # | 400 | CANCEL_NOT_ALLOWED | This payment method does not support
+    # cancellation, or the charge status cannot be canceled. |
+    # | 400 | CANNOT_CHANGE_CANCELED_SUBSCRIPTION | A canceled subscription
+    # cannot be modified. |
+    # | 400 | CANNOT_CHANGE_TOKEN | The transaction token for a subscription in
+    # this state cannot be changed. |
+    # | 400 | CANNOT_REFUND_UNSUCCESSFUL_CHARGE | Charges in a state other than
+    # 'successful' cannot be refunded. |
+    # | 400 | CAPTURE_AMOUNT_TOO_LARGE | The capture amount exceeds the
+    # authorized amount. |
+    # | 400 | CARD_BRAND_NOT_SUPPORTED | The configured gateway does not support
+    # the specified card brand. |
+    # | 400 | CARD_COUNTRY_NOT_SUPPORTED | The configured gateway does not
+    # support the specified card issuing country. |
+    # | 400 | CARD_PROCESSING_DISABLED | Card processing is disabled for this
+    # payment method. |
+    # | 400 | CHARGE_TOO_QUICK | Attempted to create multiple charges with the
+    # same amount within 30 seconds for the same card or recurring token. |
+    # | 400 | CONVENIENCE_PROCESSING_DISABLED | Konbini processing is disabled
+    # for this payment method. |
+    # | 400 | CURRENCY_MUST_MATCH_CHARGE | The refund currency must match the
+    # original charge currency. |
+    # | 400 | CVV_REQUIRED | CVV is required. |
+    # | 400 | CVV_AUTHORIZATION_NOT_COMPLETED | CVV authorization failed. |
+    # | 400 | FILE_INVALID_TYPE | The uploaded file has an incorrect MIME type.
+    # |
+    # | 400 | FILE_MAX_SIZE_EXCEEDED | The uploaded file size is too large. |
+    # | 400 | FORBIDDEN_IP | The country determined by the request's IP address
+    # is not permitted. |
+    # | 400 | INSTALLMENT_MAX_PAYOUT_PERIOD_EXCEEDED | The installment payment
+    # period exceeds the maximum allowed period. |
+    # | 400 | INSTALLMENT_PAYMENT_TYPE_NOT_ALLOWED_FOR_PLAN | The payment method
+    # is not allowed for this installment plan. |
+    # | 400 | INSTALLMENT_INVALID_CYCLES_COUNT | The number of installment
+    # cycles is unavailable. |
+    # | 400 | INSTALLMENT_INVALID_PLAN | Unsupported installment plan. |
+    # | 400 | INVALID_PLATFORM | Invalid platform specified. |
+    # | 400 | INVALID_TOKEN_TYPE | Invalid transaction token type. |
+    # | 400 | INVALID_QR_SCAN_GATEWAY | The QR code scanning gateway is not
+    # configured or not active. |
+    # | 400 | LAST_NAME_REQUIRED | A space-separated last name is required for
+    # the cardholder. |
+    # | 400 | LIVE_MODE_NOT_ENABLED_WHEN_UNVERIFIED | Account review must be
+    # completed to use live mode. |
+    # | 400 | NO_DIRECT_CURRENCY_GATEWAY | No gateway available to process the
+    # payment without currency conversion. |
+    # | 400 | NO_GATEWAYS_AVAILABLE | No available gateways found. |
+    # | 400 | NO_TEST_CARD_IN_LIVE_MODE | Test cards cannot be used in live
+    # mode. |
+    # | 400 | NON_SUBSCRIPTION_PAYMENT | Please specify a one-time token or
+    # recurring token to create a charge. |
+    # | 400 | NOT_ONE_TIME_TOKEN | Only one-time tokens are supported. |
+    # | 400 | NOT_SUBSCRIPTION_TOKEN | Please specify a subscription or
+    # recurring token. |
+    # | 400 | PARTIAL_CAPTURE_NOT_SUPPORTED | Partial capture is not supported.
+    # |
+    # | 400 | PAYMENT_EXPIRATION_EXCEEDS_PERIOD | Payment expiration date
+    # exceeds the allowed cycle. |
+    # | 400 | PROCESSING_MODE_MISMATCH | Application token and transaction token
+    # modes do not match (e.g., live vs. test). |
+    # | 400 | QR_PROCESSING_DISABLED | QR processing is disabled for this
+    # payment method. |
+    # | 400 | RECURRING_TOKEN_DISABLED | Transaction token is disabled or the
+    # account lacks permission to use recurring tokens. |
+    # | 400 | RECURRING_USAGE_LIMIT_REQUIRED | The `usage_limit` parameter is
+    # required. |
+    # | 400 | RECURRING_USAGE_REQUIRES_CVV | CVV is required for recurring
+    # usage. |
+    # | 400 | REFUND_EXCEEDS_CHARGE_AMOUNT | The refund amount exceeds the
+    # charge amount. |
+    # | 400 | REFUND_NOT_ALLOWED | The payment method does not support refunds,
+    # or the refund was declined. |
+    # | 400 | REFUND_EXCEEDS_SALES | The refund amount exceeds the merchant's
+    # available balance limit. |
+    # | 400 | REFUND_NOT_WITHIN_BOUNDS | The combined partial refund amounts
+    # exceed the total charge amount. |
+    # | 400 | RESOURCE_LIMIT_REACHED | Resource limit reached. |
+    # | 400 | SUBSCRIPTION_ALREADY_ENDED | The subscription has already ended. |
+    # | 400 | TOKEN_FOR_WRONG_STORE | The transaction token's store differs from
+    # the subscription's store. |
+    # | 400 | TRANSACTION_ALREADY_PROCESSED | Used transaction tokens cannot be
+    # specified again. |
+    # | 400 | TRANSACTION_TOKEN_EXPIRED | The transaction token has expired. |
+    # | 400 | USAGE_LIMIT_NOT_APPLICABLE | `usage_limit` cannot be specified
+    # here. |
+    # | 400 | VALIDATION_ERROR | There is a validation error in the request
+    # parameters. Check `errors` for details. |
+    # | 400 | CHARGE_AMOUNT_TOO_HIGH | The charge amount exceeds the maximum
+    # allowed limit. |
+    # | 400 | NOT_SUPPORTED_BY_PROCESSOR | The gateway does not support this
+    # request. |
+    # | 401 | AUTH_HEADER_MISSING | The `Authorization` header is missing. |
+    # | 401 | EXPIRED_LOGIN_TOKEN | The login token has expired. |
+    # | 401 | INVALID_APP_TOKEN | The specified application token is invalid. |
+    # | 401 | INVALID_CREDENTIALS | Authentication credentials are invalid. |
+    # | 401 | INVALID_DOMAIN | The requested `Origin` domain is not registered
+    # for the specified application token. |
+    # | 401 | INVALID_LOGIN_TOKEN | The login token is invalid. |
+    # | 401 | DIRECT_CARD_TOKEN_CREATION_DISABLED | Cannot send raw card data
+    # due to lack of PCI DSS compliance. |
+    # | 403 | CARD_LOCKED | This card is temporarily locked due to exceeding the
+    # failure threshold within a certain period. |
+    # | 403 | INVALID_PERMISSIONS | The application token type is incorrect or
+    # the account lacks sufficient permissions. |
+    # | 403 | INSTALLMENT_PROCESSOR_INITIAL_AMOUNTS_NOT_SUPPORTED | Initial
+    # installment amount specification is not supported by this gateway. |
+    # | 403 | OUTDATED_APP_TOKEN | Application token version is outdated. Please
+    # create a new one. |
+    # | 403 | TEST_CARD_CANNOT_BE_BANNED | Test cards cannot be banned. |
+    # | 403 | INSTALLMENTS_NOT_ENABLED | Installment payments are not enabled. |
+    # | 409 | IDEMPOTENCY_KEY_CONFLICT | The specified idempotency key has been
+    # used previously for a different request. |
+    # | 409 | NON_UNIQUE_ACTIVE_TOKEN | An active transaction token already
+    # exists. |
+    # | 409 | WEBHOOK_URL_EXISTS | The specified Webhook URL is already
+    # registered. |
+    # | 500 | COULD_NOT_REFRESH_AUTH | Failed to refresh the login token. |
+    # | 500 | DB_ERROR | Internal database error. |
+    # | 500 | FILE_UPLOAD_ERROR | File upload failed. |
+    # | 500 | IMPROPER_AUTH | Authorization state is improper. |
+    # | 500 | TIMEOUT | A timeout occurred during internal processing. |
+    # | 500 | UNABLE_TO_GET_IDEMPOTENT_RESULT | Cache found for idempotency key,
+    # but failed to retrieve the previous processing result. |
+    # | 500 | UNKNOWN_ERROR | An unexpected error occurred. |
+    # | 503 | SERVICE_UNAVAILABLE_TRY_AGAIN | Service is temporarily
+    # unavailable. Please try again later. |
+    # | 504 | NO_GATEWAY_AVAILABLE_TO_PROCESS_THE_REQUEST | This request is not
+    # supported by the connected gateway system. |
+    # @return [String]
+    attr_accessor :code
+
+    # List of detailed API errors.
+    # @return [Array[ApiErrorDetail]]
+    attr_accessor :errors
+
+    # 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
+
+      @code = hash.key?('code') ? hash['code'] : nil
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (ApiErrorDetail.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, code: #{@code}, errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, code: #{@code.inspect}, errors:"\
+      " #{@errors.inspect}>"
+    end
+  end
+end