tesser-api-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bd3e5421a72b28fa7ef686008d89421a650b0dd581eaa0218139074921a6257
+  data.tar.gz: 58dc68d4d0a2d9d75378ecacddfa120f5fb1c88df07a2f3934f82421e704cb18
+SHA512:
+  metadata.gz: b28672156d73a447570d848e04b11308f13c1dd55808557e57c399c63bb87e22cec745e5e46421a93b8c2dacbdf335c054fd7dec2e8e6eb9d57d26a3bfa7a0e7
+  data.tar.gz: 306173c6f47ad8c2b039edbd4c7036ce801e463752af87084e4b04d9216deb748c0cdf1f1f6b09587d32820144c11d82115af0707bd36eb62034b129d5fa1ca3

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,148 @@
+
+# Getting Started with Tesser API (v1)
+
+## Introduction
+
+The Tesser Payments Platform API documentation (v1)
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install tesser-api-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'tesser-api-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the tesser-api-sdk gem](https://rubygems.org/gems/tesser-api-sdk/versions/1.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'tesser_apiv1'
+include TesserApiv1
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/tesser_apiv1
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'tesser_apiv1'
+include TesserApiv1
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'tesser_apiv1'
+include TesserApiv1
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`bearer (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Payments](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/payments.md)
+* [Health](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/health.md)
+* [Accounts](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/accounts.md)
+* [Currencies](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/currencies.md)
+* [Counterparties](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/counterparties.md)
+* [Tenants](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/tenants.md)
+* [Networks](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/networks.md)
+* [Experimental](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/experimental.md)
+* [Treasury](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/controllers/treasury.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/tesser-api-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'tesser_apiv1'
+
+puts 'TesserApiv1 SDK loaded!'
+puts 'You can now create a client with: client = TesserApiv1::Client.new'
+puts 'Or use from_env: client = TesserApiv1::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/tesser_apiv1/api_helper.rb

@@ -0,0 +1,10 @@
+# tesser_apiv1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TesserApiv1
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/tesser_apiv1/client.rb

@@ -0,0 +1,118 @@
+# tesser_apiv1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TesserApiv1
+  #  tesser_apiv1 client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to payments controller.
+    # @return [PaymentsController] Returns the controller instance.
+    def payments
+      @payments ||= PaymentsController.new @global_configuration
+    end
+
+    # Access to health controller.
+    # @return [HealthController] Returns the controller instance.
+    def health
+      @health ||= HealthController.new @global_configuration
+    end
+
+    # Access to accounts controller.
+    # @return [AccountsController] Returns the controller instance.
+    def accounts
+      @accounts ||= AccountsController.new @global_configuration
+    end
+
+    # Access to currencies controller.
+    # @return [CurrenciesController] Returns the controller instance.
+    def currencies
+      @currencies ||= CurrenciesController.new @global_configuration
+    end
+
+    # Access to counterparties controller.
+    # @return [CounterpartiesController] Returns the controller instance.
+    def counterparties
+      @counterparties ||= CounterpartiesController.new @global_configuration
+    end
+
+    # Access to tenants controller.
+    # @return [TenantsController] Returns the controller instance.
+    def tenants
+      @tenants ||= TenantsController.new @global_configuration
+    end
+
+    # Access to networks controller.
+    # @return [NetworksController] Returns the controller instance.
+    def networks
+      @networks ||= NetworksController.new @global_configuration
+    end
+
+    # Access to experimental controller.
+    # @return [ExperimentalController] Returns the controller instance.
+    def experimental
+      @experimental ||= ExperimentalController.new @global_configuration
+    end
+
+    # Access to treasury controller.
+    # @return [TreasuryController] Returns the controller instance.
+    def treasury
+      @treasury ||= TreasuryController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      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,
+      environment: Environment::PRODUCTION, access_token: nil,
+      bearer_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  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, environment: environment,
+                    access_token: access_token,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[bearer].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['bearer'] = OAuth2.new(http_client_config.bearer_auth_credentials)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/tesser_apiv1/configuration.rb

@@ -0,0 +1,182 @@
+# tesser_apiv1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TesserApiv1
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Sandbox 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
+    ].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
+    def access_token
+      @bearer_auth_credentials.access_token
+    end
+
+    # 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: 60,
+      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,
+      environment: Environment::PRODUCTION, access_token: nil,
+      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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The OAuth 2.0 Access Token to use for API requests.
+      @access_token = access_token
+
+      # Initializing OAuth 2 Bearer token credentials with the provided auth parameters
+      @bearer_auth_credentials = create_auth_credentials_object(
+        access_token, 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, environment: nil, access_token: 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
+      environment ||= self.environment
+      bearer_auth_credentials = create_auth_credentials_object(
+        access_token, 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,
+                        environment: environment,
+                        bearer_auth_credentials: bearer_auth_credentials)
+    end
+
+    def create_auth_credentials_object(access_token, bearer_auth_credentials)
+      return bearer_auth_credentials if access_token.nil?
+
+      warn('The \'access_token\' params are deprecated. Use \'bearer_auth_cred'\
+           'entials\' param instead.')
+
+      unless bearer_auth_credentials.nil?
+        return bearer_auth_credentials.clone_with(
+          access_token: access_token
+        )
+      end
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://tesser-platform-v1-pull-51-me-98e48a7.zuplo.app'
+      }
+    }.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'] || 60).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
+
+      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
+      )
+    end
+  end
+end