univapay-client-sdk 1.0.0

data/lib/univapay_client_sdk/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # 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/univapay_client_sdk/extensions.rb

@@ -0,0 +1,127 @@
+# Hand-authored SDK extensions kept OUTSIDE the generated files.
+#
+# APIMatic regenerates the controllers and the client on every build, so any
+# customization injected into those files risks a merge conflict whenever the
+# spec changes nearby. Keeping the extensions here -- in a file APIMatic never
+# generates -- means regeneration can never conflict with them.
+#
+# This file is required last (after the API classes and models are loaded), so
+# the reopened classes below augment the already-defined generated classes.
+
+require_relative 'http/http_call_back'
+
+module UnivapayClientSdk
+  # Injects an Idempotency-Key header into mutating requests if absent.
+  class IdempotencyCallback < HttpCallBack
+    def initialize(user_callback = nil)
+      @user_callback = user_callback
+      super()
+    end
+
+    def on_before_request(request)
+      if request
+        method = request.http_method.to_s.upcase
+        if %w[POST PUT PATCH].include?(method)
+          headers = request.headers || {}
+          has_idempotency = headers.any? { |k, _| k.to_s.downcase == 'idempotency-key' }
+          unless has_idempotency
+            require 'securerandom'
+            request.headers['Idempotency-Key'] = SecureRandom.uuid
+          end
+        end
+      end
+      @user_callback&.on_before_request(request)
+    end
+
+    def on_after_response(response)
+      @user_callback&.on_after_response(response)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @user_callback && @user_callback.respond_to?(method_name)
+        @user_callback.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      (@user_callback && @user_callback.respond_to?(method_name, include_private)) || super
+    end
+  end
+
+  # poll_* helpers, reopened onto the generated controller classes.
+  class ChargesApi
+    def poll_charge(store_id, id, max_attempts: 10)
+      terminal_statuses = [
+        ChargeStatus::SUCCESSFUL,
+        ChargeStatus::FAILED,
+        ChargeStatus::ERROR,
+        ChargeStatus::CANCELED,
+        ChargeStatus::AUTHORIZED,
+        ChargeStatus::AWAITING
+      ]
+      attempts = 0
+      while attempts < max_attempts
+        response = get_charge(store_id, id, polling: true)
+        if response && response.data && terminal_statuses.include?(response.data.status)
+          return response
+        end
+        attempts += 1
+      end
+      get_charge(store_id, id, polling: true)
+    end
+  end
+
+  class CancelsApi
+    def poll_cancel(store_id, charge_id, id, max_attempts: 10)
+      terminal_statuses = [
+        CancelStatus::SUCCESSFUL,
+        CancelStatus::FAILED,
+        CancelStatus::ERROR
+      ]
+      attempts = 0
+      while attempts < max_attempts
+        response = get_cancel(store_id, charge_id, id, polling: true)
+        if response && response.data && terminal_statuses.include?(response.data.status)
+          return response
+        end
+        attempts += 1
+      end
+      get_cancel(store_id, charge_id, id, polling: true)
+    end
+  end
+
+  class RefundsApi
+    def poll_refund(store_id, charge_id, id, max_attempts: 10)
+      terminal_statuses = [
+        RefundStatus::SUCCESSFUL,
+        RefundStatus::FAILED,
+        RefundStatus::ERROR
+      ]
+      attempts = 0
+      while attempts < max_attempts
+        response = get_refund(store_id, charge_id, id, polling: true)
+        if response && response.data && terminal_statuses.include?(response.data.status)
+          return response
+        end
+        attempts += 1
+      end
+      get_refund(store_id, charge_id, id, polling: true)
+    end
+  end
+
+  class SubscriptionsApi
+    def poll_subscription(store_id, id, max_attempts: 10)
+      attempts = 0
+      while attempts < max_attempts
+        response = get_subscription(store_id, id, polling: true)
+        if response && response.data && response.data.status != SubscriptionStatus::UNVERIFIED
+          return response
+        end
+        attempts += 1
+      end
+      get_subscription(store_id, id, polling: true)
+    end
+  end
+end

data/lib/univapay_client_sdk/http/api_response.rb

@@ -0,0 +1,19 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # 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/univapay_client_sdk/http/auth/oauth_2.rb

@@ -0,0 +1,58 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Utility class for OAuth 2 authorization and token management.
+  class Oauth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BearerAuth: secret_key/jwt_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(bearer_auth_credentials)
+      auth_params = {}
+      unless bearer_auth_credentials.nil? ||
+             bearer_auth_credentials.secret_key.nil? ||
+             bearer_auth_credentials.jwt_token.nil?
+        @_secret_key = bearer_auth_credentials.secret_key
+        @_jwt_token = bearer_auth_credentials.jwt_token
+      end
+      auth_params[:Authorization] = "Bearer #{@_secret_key}.#{@_jwt_token}" unless @_secret_key.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for BearerAuthCredentials.
+  class BearerAuthCredentials
+    attr_reader :secret_key, :jwt_token
+
+    def initialize(secret_key:, jwt_token:)
+      raise ArgumentError, 'secret_key cannot be nil' if secret_key.nil?
+      raise ArgumentError, 'jwt_token cannot be nil' if jwt_token.nil?
+
+      @secret_key = secret_key
+      @jwt_token = jwt_token
+    end
+
+    def self.from_env
+      secret_key = ENV['SECRET_KEY']
+      jwt_token = ENV['JWT_TOKEN']
+      return nil if secret_key.nil? || jwt_token.nil?
+
+      new(secret_key: secret_key, jwt_token: jwt_token)
+    end
+
+    def clone_with(secret_key: nil, jwt_token: nil)
+      secret_key ||= self.secret_key
+      jwt_token ||= self.jwt_token
+
+      BearerAuthCredentials.new(secret_key: secret_key, jwt_token: jwt_token)
+    end
+  end
+end

data/lib/univapay_client_sdk/http/http_call_back.rb

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

data/lib/univapay_client_sdk/http/http_method_enum.rb

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

data/lib/univapay_client_sdk/http/http_request.rb

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

data/lib/univapay_client_sdk/http/http_response.rb

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

data/lib/univapay_client_sdk/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  ##
+  # 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

data/lib/univapay_client_sdk/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/univapay_client_sdk/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/univapay_client_sdk/models/api_error_detail.rb

@@ -0,0 +1,87 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Structured detail entry describing a single API validation or business
+  # error.
+  class ApiErrorDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field name of the parameter that caused the error (lower_snake_case).
+    # @return [String]
+    attr_accessor :field
+
+    # Detailed reason for the nested error (UPPER_SNAKE_CASE or English
+    # description).
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field: SKIP, reason: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field = field unless field == SKIP
+      @reason = reason unless reason == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      field = hash.key?('field') ? hash['field'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ApiErrorDetail.new(field: field,
+                         reason: reason,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field}, reason: #{@reason}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field.inspect}, reason: #{@reason.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/api_error_status.rb

@@ -0,0 +1,26 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Always returns 'error'.
+  class ApiErrorStatus
+    API_ERROR_STATUS = [
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      API_ERROR_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ERROR)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/univapay_client_sdk/models/bank_transfer_event.rb

@@ -0,0 +1,27 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Event type discriminator — always `bank_transfer_status_updated` for this
+  # callback.
+  class BankTransferEvent
+    BANK_TRANSFER_EVENT = [
+      # TODO: Write general description for BANK_TRANSFER_STATUS_UPDATED
+      BANK_TRANSFER_STATUS_UPDATED = 'bank_transfer_status_updated'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_TRANSFER_EVENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = BANK_TRANSFER_STATUS_UPDATED)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end