mt-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 137ddcb52b7852c895fcde86787cce2f554946a6e1dc097c4fe99aada0b8ee64
+  data.tar.gz: 5363158cfc5fbbe7e3285e5a41158dea47c3e1509f2fb3d56997a1fbfdaddb6b
+SHA512:
+  metadata.gz: 7da015c13eb3e45d5154d1a96c84cc9647bf06a168047fda3a45e5c85b6009cc59badf4ddac7e1f56793cb2c0ae8f8b45d34b0bfcaa71da59961ad3de449e87e
+  data.tar.gz: a393e00c5bda09d98d2c3d3c1de2418b79486b587785be98547b19c5fdddc4f104f3f8f1609c5cdc3f98d55f7395cc84e3f143caed5dfa7004a78acf4e31ca29

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,188 @@
+
+# Getting Started with Modern Treasury
+
+## Introduction
+
+The Modern Treasury REST API. Please see https://docs.moderntreasury.com for more details.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install mt-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'mt-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the mt-sdk gem](https://rubygems.org/gems/mt-sdk/versions/0.0.1).
+
+## 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 'modern_treasury'
+include ModernTreasury
+```
+
+### 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/modern_treasury
+```
+
+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/mt-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| 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/mt-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'modern_treasury'
+include ModernTreasury
+
+client = Client.new(
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'BasicAuthUserName',
+    password: 'BasicAuthPassword'
+  ),
+  environment: Environment::PRODUCTION
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'modern_treasury'
+include ModernTreasury
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+| ENVIRONMENT2 | - |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`basic_auth (Basic Authentication)`](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md)
+
+## List of APIs
+
+* [Account Detail](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/account-detail.md)
+* [Balance Report](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/balance-report.md)
+* [Connection](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/connection.md)
+* [Counterparty](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/counterparty.md)
+* [Document](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/document.md)
+* [Event](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/event.md)
+* [Expected Payment](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/expected-payment.md)
+* [External Account](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/external-account.md)
+* [Incoming Payment Detail](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/incoming-payment-detail.md)
+* [Internal Account](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/internal-account.md)
+* [Invoice Line Item](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/invoice-line-item.md)
+* [Invoice](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/invoice.md)
+* [Ledger Account Category](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-account-category.md)
+* [Ledger Account Payout](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-account-payout.md)
+* [Ledger Account Statement](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-account-statement.md)
+* [Ledger Account](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-account.md)
+* [Ledger Entry](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-entry.md)
+* [Ledger Event Handler](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-event-handler.md)
+* [Ledger Transaction](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger-transaction.md)
+* [Ledgerable Event](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledgerable-event.md)
+* [Ledger](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ledger.md)
+* [Line Item](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/line-item.md)
+* [Paper Item](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/paper-item.md)
+* [Payment Order](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/payment-order.md)
+* [Payment Reference](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/payment-reference.md)
+* [Ping](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/ping.md)
+* [Return](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/return.md)
+* [Reversal](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/reversal.md)
+* [Routing Detail](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/routing-detail.md)
+* [Transaction Line Item](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/transaction-line-item.md)
+* [Transaction](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/transaction.md)
+* [Validation](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/validation.md)
+* [Virtual Account](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/virtual-account.md)
+* [Account Collection Flow](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/account-collection-flow.md)
+* [Payment Flow](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/controllers/payment-flow.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/mt-ruby-sdk/tree/0.0.1/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 'modern_treasury'
+
+puts 'ModernTreasury SDK loaded!'
+puts 'You can now create a client with: client = ModernTreasury::Client.new'
+puts 'Or use from_env: client = ModernTreasury::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/modern_treasury/api_helper.rb

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

data/lib/modern_treasury/client.rb

@@ -0,0 +1,275 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  #  modern_treasury client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to account_detail controller.
+    # @return [AccountDetailController] Returns the controller instance.
+    def account_detail
+      @account_detail ||= AccountDetailController.new @global_configuration
+    end
+
+    # Access to balance_report controller.
+    # @return [BalanceReportController] Returns the controller instance.
+    def balance_report
+      @balance_report ||= BalanceReportController.new @global_configuration
+    end
+
+    # Access to connection controller.
+    # @return [ConnectionController] Returns the controller instance.
+    def connection
+      @connection ||= ConnectionController.new @global_configuration
+    end
+
+    # Access to counterparty controller.
+    # @return [CounterpartyController] Returns the controller instance.
+    def counterparty
+      @counterparty ||= CounterpartyController.new @global_configuration
+    end
+
+    # Access to document controller.
+    # @return [DocumentController] Returns the controller instance.
+    def document
+      @document ||= DocumentController.new @global_configuration
+    end
+
+    # Access to event controller.
+    # @return [EventController] Returns the controller instance.
+    def event
+      @event ||= EventController.new @global_configuration
+    end
+
+    # Access to expected_payment controller.
+    # @return [ExpectedPaymentController] Returns the controller instance.
+    def expected_payment
+      @expected_payment ||= ExpectedPaymentController.new @global_configuration
+    end
+
+    # Access to external_account controller.
+    # @return [ExternalAccountController] Returns the controller instance.
+    def external_account
+      @external_account ||= ExternalAccountController.new @global_configuration
+    end
+
+    # Access to incoming_payment_detail controller.
+    # @return [IncomingPaymentDetailController] Returns the controller instance.
+    def incoming_payment_detail
+      @incoming_payment_detail ||= IncomingPaymentDetailController.new @global_configuration
+    end
+
+    # Access to internal_account controller.
+    # @return [InternalAccountController] Returns the controller instance.
+    def internal_account
+      @internal_account ||= InternalAccountController.new @global_configuration
+    end
+
+    # Access to invoice_line_item controller.
+    # @return [InvoiceLineItemController] Returns the controller instance.
+    def invoice_line_item
+      @invoice_line_item ||= InvoiceLineItemController.new @global_configuration
+    end
+
+    # Access to invoice controller.
+    # @return [InvoiceController] Returns the controller instance.
+    def invoice
+      @invoice ||= InvoiceController.new @global_configuration
+    end
+
+    # Access to ledger_account_category controller.
+    # @return [LedgerAccountCategoryController] Returns the controller instance.
+    def ledger_account_category
+      @ledger_account_category ||= LedgerAccountCategoryController.new @global_configuration
+    end
+
+    # Access to ledger_account_payout controller.
+    # @return [LedgerAccountPayoutController] Returns the controller instance.
+    def ledger_account_payout
+      @ledger_account_payout ||= LedgerAccountPayoutController.new @global_configuration
+    end
+
+    # Access to ledger_account_statement controller.
+    # @return [LedgerAccountStatementController] Returns the controller instance.
+    def ledger_account_statement
+      @ledger_account_statement ||= LedgerAccountStatementController.new @global_configuration
+    end
+
+    # Access to ledger_account controller.
+    # @return [LedgerAccountController] Returns the controller instance.
+    def ledger_account
+      @ledger_account ||= LedgerAccountController.new @global_configuration
+    end
+
+    # Access to ledger_entry controller.
+    # @return [LedgerEntryController] Returns the controller instance.
+    def ledger_entry
+      @ledger_entry ||= LedgerEntryController.new @global_configuration
+    end
+
+    # Access to ledger_event_handler controller.
+    # @return [LedgerEventHandlerController] Returns the controller instance.
+    def ledger_event_handler
+      @ledger_event_handler ||= LedgerEventHandlerController.new @global_configuration
+    end
+
+    # Access to ledger_transaction controller.
+    # @return [LedgerTransactionController] Returns the controller instance.
+    def ledger_transaction
+      @ledger_transaction ||= LedgerTransactionController.new @global_configuration
+    end
+
+    # Access to ledgerable_event controller.
+    # @return [LedgerableEventController] Returns the controller instance.
+    def ledgerable_event
+      @ledgerable_event ||= LedgerableEventController.new @global_configuration
+    end
+
+    # Access to ledger controller.
+    # @return [LedgerController] Returns the controller instance.
+    def ledger
+      @ledger ||= LedgerController.new @global_configuration
+    end
+
+    # Access to line_item controller.
+    # @return [LineItemController] Returns the controller instance.
+    def line_item
+      @line_item ||= LineItemController.new @global_configuration
+    end
+
+    # Access to paper_item controller.
+    # @return [PaperItemController] Returns the controller instance.
+    def paper_item
+      @paper_item ||= PaperItemController.new @global_configuration
+    end
+
+    # Access to payment_order controller.
+    # @return [PaymentOrderController] Returns the controller instance.
+    def payment_order
+      @payment_order ||= PaymentOrderController.new @global_configuration
+    end
+
+    # Access to payment_reference controller.
+    # @return [PaymentReferenceController] Returns the controller instance.
+    def payment_reference
+      @payment_reference ||= PaymentReferenceController.new @global_configuration
+    end
+
+    # Access to ping controller.
+    # @return [PingController] Returns the controller instance.
+    def ping
+      @ping ||= PingController.new @global_configuration
+    end
+
+    # Access to mreturn controller.
+    # @return [ReturnController] Returns the controller instance.
+    def mreturn
+      @mreturn ||= ReturnController.new @global_configuration
+    end
+
+    # Access to reversal controller.
+    # @return [ReversalController] Returns the controller instance.
+    def reversal
+      @reversal ||= ReversalController.new @global_configuration
+    end
+
+    # Access to routing_detail controller.
+    # @return [RoutingDetailController] Returns the controller instance.
+    def routing_detail
+      @routing_detail ||= RoutingDetailController.new @global_configuration
+    end
+
+    # Access to transaction_line_item controller.
+    # @return [TransactionLineItemController] Returns the controller instance.
+    def transaction_line_item
+      @transaction_line_item ||= TransactionLineItemController.new @global_configuration
+    end
+
+    # Access to transaction controller.
+    # @return [TransactionController] Returns the controller instance.
+    def transaction
+      @transaction ||= TransactionController.new @global_configuration
+    end
+
+    # Access to validation controller.
+    # @return [ValidationController] Returns the controller instance.
+    def validation
+      @validation ||= ValidationController.new @global_configuration
+    end
+
+    # Access to virtual_account controller.
+    # @return [VirtualAccountController] Returns the controller instance.
+    def virtual_account
+      @virtual_account ||= VirtualAccountController.new @global_configuration
+    end
+
+    # Access to account_collection_flow controller.
+    # @return [AccountCollectionFlowController] Returns the controller instance.
+    def account_collection_flow
+      @account_collection_flow ||= AccountCollectionFlowController.new @global_configuration
+    end
+
+    # Access to payment_flow controller.
+    # @return [PaymentFlowController] Returns the controller instance.
+    def payment_flow
+      @payment_flow ||= PaymentFlowController.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, basic_auth_user_name: nil,
+      basic_auth_password: nil, basic_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,
+                    basic_auth_user_name: basic_auth_user_name,
+                    basic_auth_password: basic_auth_password,
+                    basic_auth_credentials: basic_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[basic_auth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['basic_auth'] = BasicAuth.new(http_client_config.basic_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