ps-apimatic-sdk 0.0.1

data/lib/paysecure_api_documentation_live/configuration.rb

@@ -0,0 +1,181 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # 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 = [
+      SERVER_1 = 'Server 1'.freeze,
+      SERVER_2 = 'Server 2'.freeze,
+      SERVER_3 = 'Server 3'.freeze,
+      SERVER_4 = 'Server 4'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = SERVER_1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'server_1' then SERVER_1
+      when 'server_2' then SERVER_2
+      when 'server_3' then SERVER_3
+      when 'server_4' then SERVER_4
+
+      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, :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],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      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)
+
+      # 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, 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
+      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,
+                        bearer_auth_credentials: bearer_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::SERVER_1 => 'https://<https://staging.paysecure.net/api/v1/payout',
+        Server::SERVER_2 => 'https://app.paysecure.net/api/v1',
+        Server::SERVER_3 => 'https://api.paysecure.net',
+        Server::SERVER_4 => 'https://getBalance'
+      }
+    }.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::SERVER_1)
+      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 ===
+      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,
+        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/paysecure_api_documentation_live/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # 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/paysecure_api_documentation_live/exceptions/cancel_exception.rb

@@ -0,0 +1,363 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # Cancel class.
+  class CancelException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :purchase_id
+
+    # TODO: Write general description for this method
+    # @return [Client52]
+    attr_accessor :client
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :updated_on
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount_unit
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_msg
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :force_recurring
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :created_on
+
+    # TODO: Write general description for this method
+    # @return [ExtraParam26]
+    attr_accessor :extra_param
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :merchant_ref
+
+    # TODO: Write general description for this method
+    # @return [Purchase1]
+    attr_accessor :purchase
+
+    # TODO: Write general description for this method
+    # @return [Payment3]
+    attr_accessor :payment
+
+    # TODO: Write general description for this method
+    # @return [IssuerDetails]
+    attr_accessor :issuer_details
+
+    # TODO: Write general description for this method
+    # @return [TransactionData40]
+    attr_accessor :transaction_data
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Array[StatusHistory]]
+    attr_accessor :status_history
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_test
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :brand_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_receipt
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_recurring_token
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_capture
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference_generated
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :issued
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :due
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :refund_upto
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cc_descriptor
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fraud_score
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :trust_score
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :extra_fee
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :pix_payload
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :pay_in_details
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :paid_on
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :received_amt
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :surcharge
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :surcharge_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :session_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :refund_availability
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :refundable_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :success_redirect
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :failure_redirect
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cancel_redirect
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :success_callback
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :failure_callback
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :platform
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_from_ip
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :checkout_url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direct_post_url
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :payout_process
+
+    # 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
+
+      @purchase_id = hash.key?('purchaseId') ? hash['purchaseId'] : nil
+      @client = Client52.from_hash(hash['client']) if hash['client']
+      @updated_on = hash.key?('updated_on') ? hash['updated_on'] : nil
+      @type = hash.key?('type') ? hash['type'] : nil
+      @payment_method = hash.key?('paymentMethod') ? hash['paymentMethod'] : nil
+      @amount_unit = hash.key?('amountUnit') ? hash['amountUnit'] : nil
+      @error_msg = hash.key?('errorMsg') ? hash['errorMsg'] : nil
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @force_recurring =
+        hash.key?('force_recurring') ? hash['force_recurring'] : nil
+      @created_on = hash.key?('created_on') ? hash['created_on'] : nil
+      @extra_param = ExtraParam26.from_hash(hash['extraParam']) if hash['extraParam']
+      @merchant_ref = hash.key?('merchantRef') ? hash['merchantRef'] : nil
+      @purchase = Purchase1.from_hash(hash['purchase']) if hash['purchase']
+      @payment = Payment3.from_hash(hash['payment']) if hash['payment']
+      @issuer_details = IssuerDetails.from_hash(hash['issuer_details']) if hash['issuer_details']
+      @transaction_data = TransactionData40.from_hash(hash['transaction_data']) if
+        hash['transaction_data']
+      @status = hash.key?('status') ? hash['status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      @status_history = nil
+      unless hash['status_history'].nil?
+        @status_history = []
+        hash['status_history'].each do |structure|
+          @status_history << (StatusHistory.from_hash(structure) if structure)
+        end
+      end
+
+      @status_history = nil unless hash.key?('status_history')
+      @is_test = hash.key?('is_test') ? hash['is_test'] : nil
+      @brand_id = hash.key?('brand_id') ? hash['brand_id'] : nil
+      @send_receipt = hash.key?('send_receipt') ? hash['send_receipt'] : nil
+      @is_recurring_token =
+        hash.key?('is_recurring_token') ? hash['is_recurring_token'] : nil
+      @skip_capture = hash.key?('skip_capture') ? hash['skip_capture'] : nil
+      @reference_generated =
+        hash.key?('reference_generated') ? hash['reference_generated'] : nil
+      @issued = hash.key?('issued') ? hash['issued'] : nil
+      @due = hash.key?('due') ? hash['due'] : nil
+      @refund_upto = hash.key?('refund_upto') ? hash['refund_upto'] : nil
+      @cc_descriptor = hash.key?('cc_descriptor') ? hash['cc_descriptor'] : nil
+      @fraud_score = hash.key?('fraudScore') ? hash['fraudScore'] : nil
+      @trust_score = hash.key?('trustScore') ? hash['trustScore'] : nil
+      @extra_fee = hash.key?('extraFee') ? hash['extraFee'] : nil
+      @pix_payload = hash.key?('pix_payload') ? hash['pix_payload'] : nil
+      @pay_in_details = hash.key?('payInDetails') ? hash['payInDetails'] : nil
+      @paid_on = hash.key?('paidOn') ? hash['paidOn'] : nil
+      @received_amt = hash.key?('receivedAmt') ? hash['receivedAmt'] : nil
+      @tax_amount = hash.key?('taxAmount') ? hash['taxAmount'] : nil
+      @surcharge = hash.key?('surcharge') ? hash['surcharge'] : nil
+      @surcharge_type = hash.key?('surchargeType') ? hash['surchargeType'] : nil
+      @session_id = hash.key?('sessionId') ? hash['sessionId'] : nil
+      @refund_availability =
+        hash.key?('refund_availability') ? hash['refund_availability'] : nil
+      @refundable_amount =
+        hash.key?('refundable_amount') ? hash['refundable_amount'] : nil
+      @success_redirect =
+        hash.key?('success_redirect') ? hash['success_redirect'] : nil
+      @failure_redirect =
+        hash.key?('failure_redirect') ? hash['failure_redirect'] : nil
+      @cancel_redirect =
+        hash.key?('cancel_redirect') ? hash['cancel_redirect'] : nil
+      @success_callback =
+        hash.key?('success_callback') ? hash['success_callback'] : nil
+      @failure_callback =
+        hash.key?('failure_callback') ? hash['failure_callback'] : nil
+      @platform = hash.key?('platform') ? hash['platform'] : nil
+      @created_from_ip =
+        hash.key?('created_from_ip') ? hash['created_from_ip'] : nil
+      @checkout_url = hash.key?('checkout_url') ? hash['checkout_url'] : nil
+      @direct_post_url =
+        hash.key?('direct_post_url') ? hash['direct_post_url'] : nil
+      @payout_process = hash.key?('payoutProcess') ? hash['payoutProcess'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_id: #{@purchase_id}, client: #{@client}, updated_on:"\
+      " #{@updated_on}, type: #{@type}, payment_method: #{@payment_method}, amount_unit:"\
+      " #{@amount_unit}, error_msg: #{@error_msg}, error_code: #{@error_code}, force_recurring:"\
+      " #{@force_recurring}, created_on: #{@created_on}, extra_param: #{@extra_param},"\
+      " merchant_ref: #{@merchant_ref}, purchase: #{@purchase}, payment: #{@payment},"\
+      " issuer_details: #{@issuer_details}, transaction_data: #{@transaction_data}, status:"\
+      " #{@status}, status_history: #{@status_history}, is_test: #{@is_test}, brand_id:"\
+      " #{@brand_id}, send_receipt: #{@send_receipt}, is_recurring_token: #{@is_recurring_token},"\
+      " skip_capture: #{@skip_capture}, reference_generated: #{@reference_generated}, issued:"\
+      " #{@issued}, due: #{@due}, refund_upto: #{@refund_upto}, cc_descriptor: #{@cc_descriptor},"\
+      " fraud_score: #{@fraud_score}, trust_score: #{@trust_score}, extra_fee: #{@extra_fee},"\
+      " pix_payload: #{@pix_payload}, pay_in_details: #{@pay_in_details}, paid_on: #{@paid_on},"\
+      " received_amt: #{@received_amt}, tax_amount: #{@tax_amount}, surcharge: #{@surcharge},"\
+      " surcharge_type: #{@surcharge_type}, session_id: #{@session_id}, refund_availability:"\
+      " #{@refund_availability}, refundable_amount: #{@refundable_amount}, success_redirect:"\
+      " #{@success_redirect}, failure_redirect: #{@failure_redirect}, cancel_redirect:"\
+      " #{@cancel_redirect}, success_callback: #{@success_callback}, failure_callback:"\
+      " #{@failure_callback}, platform: #{@platform}, created_from_ip: #{@created_from_ip},"\
+      " checkout_url: #{@checkout_url}, direct_post_url: #{@direct_post_url}, payout_process:"\
+      " #{@payout_process}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} purchase_id: #{@purchase_id.inspect}, client: #{@client.inspect},"\
+      " updated_on: #{@updated_on.inspect}, type: #{@type.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, amount_unit: #{@amount_unit.inspect}, error_msg:"\
+      " #{@error_msg.inspect}, error_code: #{@error_code.inspect}, force_recurring:"\
+      " #{@force_recurring.inspect}, created_on: #{@created_on.inspect}, extra_param:"\
+      " #{@extra_param.inspect}, merchant_ref: #{@merchant_ref.inspect}, purchase:"\
+      " #{@purchase.inspect}, payment: #{@payment.inspect}, issuer_details:"\
+      " #{@issuer_details.inspect}, transaction_data: #{@transaction_data.inspect}, status:"\
+      " #{@status.inspect}, status_history: #{@status_history.inspect}, is_test:"\
+      " #{@is_test.inspect}, brand_id: #{@brand_id.inspect}, send_receipt:"\
+      " #{@send_receipt.inspect}, is_recurring_token: #{@is_recurring_token.inspect},"\
+      " skip_capture: #{@skip_capture.inspect}, reference_generated:"\
+      " #{@reference_generated.inspect}, issued: #{@issued.inspect}, due: #{@due.inspect},"\
+      " refund_upto: #{@refund_upto.inspect}, cc_descriptor: #{@cc_descriptor.inspect},"\
+      " fraud_score: #{@fraud_score.inspect}, trust_score: #{@trust_score.inspect}, extra_fee:"\
+      " #{@extra_fee.inspect}, pix_payload: #{@pix_payload.inspect}, pay_in_details:"\
+      " #{@pay_in_details.inspect}, paid_on: #{@paid_on.inspect}, received_amt:"\
+      " #{@received_amt.inspect}, tax_amount: #{@tax_amount.inspect}, surcharge:"\
+      " #{@surcharge.inspect}, surcharge_type: #{@surcharge_type.inspect}, session_id:"\
+      " #{@session_id.inspect}, refund_availability: #{@refund_availability.inspect},"\
+      " refundable_amount: #{@refundable_amount.inspect}, success_redirect:"\
+      " #{@success_redirect.inspect}, failure_redirect: #{@failure_redirect.inspect},"\
+      " cancel_redirect: #{@cancel_redirect.inspect}, success_callback:"\
+      " #{@success_callback.inspect}, failure_callback: #{@failure_callback.inspect}, platform:"\
+      " #{@platform.inspect}, created_from_ip: #{@created_from_ip.inspect}, checkout_url:"\
+      " #{@checkout_url.inspect}, direct_post_url: #{@direct_post_url.inspect}, payout_process:"\
+      " #{@payout_process.inspect}>"
+    end
+  end
+end