modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/resources/transactions.rb

@@ -8,40 +8,23 @@ module ModernTreasury
 
       # create transaction
       #
-      # @param params [ModernTreasury::Models::TransactionCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount Value in specified currency's smallest unit. e.g. $10 would be represented
-      #     as 1000.
-      #
-      #   @option params [Date, nil] :as_of_date The date on which the transaction occurred.
-      #
-      #   @option params [String] :direction Either `credit` or `debit`.
-      #
-      #   @option params [String] :internal_account_id The ID of the relevant Internal Account.
-      #
-      #   @option params [String, nil] :vendor_code When applicable, the bank-given code that determines the transaction's category.
-      #     For most banks this is the BAI2/BTRS transaction code.
-      #
-      #   @option params [String, nil] :vendor_code_type The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
-      #     `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-      #     `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-      #     `swift`, `us_bank`, or others.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Boolean] :posted This field will be `true` if the transaction has posted to the account.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::TransactionCreateParams::Type, nil] :type The type of the transaction. Examples could be
-      #     `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
-      #
-      #   @option params [String, nil] :vendor_description The transaction detail text that often appears in on your bank statement and in
-      #     your banking portal.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(amount:, as_of_date:, direction:, internal_account_id:, vendor_code:, vendor_code_type:, metadata: nil, posted: nil, type: nil, vendor_description: nil, request_options: {})
+      #
+      # @param amount [Integer]
+      # @param as_of_date [Date, nil]
+      # @param direction [String]
+      # @param internal_account_id [String]
+      # @param vendor_code [String, nil]
+      # @param vendor_code_type [String, nil]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param posted [Boolean]
+      # @param type [Symbol, ModernTreasury::Models::TransactionCreateParams::Type, nil]
+      # @param vendor_description [String, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Transaction]
       #
+      # @see ModernTreasury::Models::TransactionCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::TransactionCreateParams.dump_request(params)
         @client.request(
@@ -55,18 +38,18 @@ module ModernTreasury
 
       # Get details on a single transaction.
       #
-      # @param id [String] Transaction ID
+      # @overload retrieve(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::TransactionRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Transaction]
       #
+      # @see ModernTreasury::Models::TransactionRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/transactions/%0s", id],
+          path: ["api/transactions/%1$s", id],
           model: ModernTreasury::Models::Transaction,
           options: params[:request_options]
         )
@@ -74,22 +57,20 @@ module ModernTreasury
 
       # Update a single transaction.
       #
-      # @param id [String] Transaction ID
-      #
-      # @param params [ModernTreasury::Models::TransactionUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(id, metadata: nil, request_options: {})
       #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Transaction]
       #
+      # @see ModernTreasury::Models::TransactionUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::TransactionUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/transactions/%0s", id],
+          path: ["api/transactions/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::Transaction,
           options: options
@@ -98,53 +79,34 @@ module ModernTreasury
 
       # Get a list of all transactions.
       #
-      # @param params [ModernTreasury::Models::TransactionListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [Date] :as_of_date_end Filters transactions with an `as_of_date` starting on or before the specified
-      #     date (YYYY-MM-DD).
-      #
-      #   @option params [Date] :as_of_date_start Filters transactions with an `as_of_date` starting on or after the specified
-      #     date (YYYY-MM-DD).
-      #
-      #   @option params [String] :counterparty_id
-      #
-      #   @option params [String] :description Filters for transactions including the queried string in the description.
-      #
-      #   @option params [String] :direction
-      #
-      #   @option params [String] :internal_account_id Specify `internal_account_id` if you wish to see transactions to/from a specific
-      #     account.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
-      #
-      #   @option params [String] :payment_type
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [Boolean] :posted Either `true` or `false`.
-      #
-      #   @option params [String] :transactable_type
-      #
-      #   @option params [String] :vendor_id Filters for transactions including the queried vendor id (an identifier given to
-      #     transactions by the bank).
-      #
-      #   @option params [String] :virtual_account_id
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::Transaction>]
-      #
+      # @overload list(after_cursor: nil, as_of_date_end: nil, as_of_date_start: nil, counterparty_id: nil, description: nil, direction: nil, internal_account_id: nil, metadata: nil, payment_type: nil, per_page: nil, posted: nil, transactable_type: nil, vendor_id: nil, virtual_account_id: nil, request_options: {})
+      #
+      # @param after_cursor [String, nil]
+      # @param as_of_date_end [Date]
+      # @param as_of_date_start [Date]
+      # @param counterparty_id [String]
+      # @param description [String]
+      # @param direction [String]
+      # @param internal_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param payment_type [String]
+      # @param per_page [Integer]
+      # @param posted [Boolean]
+      # @param transactable_type [String]
+      # @param vendor_id [String]
+      # @param virtual_account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Transaction>]
+      #
+      # @see ModernTreasury::Models::TransactionListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::TransactionListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/transactions",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::Transaction,
           options: options
         )
@@ -152,25 +114,26 @@ module ModernTreasury
 
       # delete transaction
       #
-      # @param id [String] Transaction ID
-      #
-      # @param params [ModernTreasury::Models::TransactionDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(id, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::TransactionDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/transactions/%0s", id],
+          path: ["api/transactions/%1$s", id],
           model: NilClass,
           options: params[:request_options]
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
         @line_items = ModernTreasury::Resources::Transactions::LineItems.new(client: client)

data/lib/modern_treasury/resources/validations.rb

@@ -4,21 +4,17 @@ module ModernTreasury
   module Resources
     class Validations
       # Validates the routing number information supplied without creating a routing
-      #   detail
+      # detail
       #
-      # @param params [ModernTreasury::Models::ValidationValidateRoutingNumberParams, Hash{Symbol=>Object}] .
+      # @overload validate_routing_number(routing_number:, routing_number_type:, request_options: {})
       #
-      #   @option params [String] :routing_number The routing number that is being validated.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType] :routing_number_type The type of routing number. See
-      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #     more details. In sandbox mode we currently only support `aba` and `swift` with
-      #     routing numbers '123456789' and 'GRINUST0XXX' respectively.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param routing_number [String]
+      # @param routing_number_type [Symbol, ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::RoutingNumberLookupRequest]
       #
+      # @see ModernTreasury::Models::ValidationValidateRoutingNumberParams
       def validate_routing_number(params)
         parsed, options = ModernTreasury::Models::ValidationValidateRoutingNumberParams.dump_request(params)
         @client.request(
@@ -30,8 +26,9 @@ module ModernTreasury
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/virtual_accounts.rb

@@ -5,39 +5,23 @@ module ModernTreasury
     class VirtualAccounts
       # create virtual_account
       #
-      # @param params [ModernTreasury::Models::VirtualAccountCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :internal_account_id The ID of the internal account that this virtual account is associated with.
-      #
-      #   @option params [String] :name The name of the virtual account.
-      #
-      #   @option params [Array<ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail>] :account_details An array of account detail objects.
-      #
-      #   @option params [String] :counterparty_id The ID of the counterparty that the virtual account belongs to.
-      #
-      #   @option params [String] :credit_ledger_account_id The ID of a credit normal ledger account. When money leaves the virtual account,
-      #     this ledger account will be credited. Must be accompanied by a
-      #     debit_ledger_account_id if present.
-      #
-      #   @option params [String] :debit_ledger_account_id The ID of a debit normal ledger account. When money enters the virtual account,
-      #     this ledger account will be debited. Must be accompanied by a
-      #     credit_ledger_account_id if present.
-      #
-      #   @option params [String] :description An optional description for internal use.
-      #
-      #   @option params [ModernTreasury::Models::VirtualAccountCreateParams::LedgerAccount] :ledger_account Specifies a ledger account object that will be created with the virtual account.
-      #     The resulting ledger account is linked to the virtual account for auto-ledgering
-      #     IPDs.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
-      #
-      #   @option params [Array<ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail>] :routing_details An array of routing detail objects.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(internal_account_id:, name:, account_details: nil, counterparty_id: nil, credit_ledger_account_id: nil, debit_ledger_account_id: nil, description: nil, ledger_account: nil, metadata: nil, routing_details: nil, request_options: {})
+      #
+      # @param internal_account_id [String]
+      # @param name [String]
+      # @param account_details [Array<ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail>]
+      # @param counterparty_id [String]
+      # @param credit_ledger_account_id [String]
+      # @param debit_ledger_account_id [String]
+      # @param description [String]
+      # @param ledger_account [ModernTreasury::Models::VirtualAccountCreateParams::LedgerAccount]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param routing_details [Array<ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail>]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::VirtualAccount]
       #
+      # @see ModernTreasury::Models::VirtualAccountCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::VirtualAccountCreateParams.dump_request(params)
         @client.request(
@@ -51,18 +35,18 @@ module ModernTreasury
 
       # get virtual_account
       #
-      # @param id [String] Virtual Acccount ID
-      #
-      # @param params [ModernTreasury::Models::VirtualAccountRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::VirtualAccount]
       #
+      # @see ModernTreasury::Models::VirtualAccountRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/virtual_accounts/%0s", id],
+          path: ["api/virtual_accounts/%1$s", id],
           model: ModernTreasury::Models::VirtualAccount,
           options: params[:request_options]
         )
@@ -70,27 +54,23 @@ module ModernTreasury
 
       # update virtual_account
       #
-      # @param id [String] Virtual Acccount ID
-      #
-      # @param params [ModernTreasury::Models::VirtualAccountUpdateParams, Hash{Symbol=>Object}] .
+      # @overload update(id, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, request_options: {})
       #
-      #   @option params [String] :counterparty_id
-      #
-      #   @option params [String] :ledger_account_id The ledger account that you'd like to link to the virtual account.
-      #
-      #   @option params [Hash{Symbol=>String}] :metadata
-      #
-      #   @option params [String, nil] :name
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param counterparty_id [String]
+      # @param ledger_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param name [String, nil]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::VirtualAccount]
       #
+      # @see ModernTreasury::Models::VirtualAccountUpdateParams
       def update(id, params = {})
         parsed, options = ModernTreasury::Models::VirtualAccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/virtual_accounts/%0s", id],
+          path: ["api/virtual_accounts/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::VirtualAccount,
           options: options
@@ -99,31 +79,25 @@ module ModernTreasury
 
       # Get a list of virtual accounts.
       #
-      # @param params [ModernTreasury::Models::VirtualAccountListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
-      #
-      #   @option params [String] :counterparty_id
+      # @overload list(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, metadata: nil, per_page: nil, request_options: {})
       #
-      #   @option params [String] :internal_account_id
+      # @param after_cursor [String, nil]
+      # @param counterparty_id [String]
+      # @param internal_account_id [String]
+      # @param metadata [Hash{Symbol=>String}]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::VirtualAccount>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::VirtualAccount>]
       #
+      # @see ModernTreasury::Models::VirtualAccountListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::VirtualAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/virtual_accounts",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::VirtualAccount,
           options: options
         )
@@ -131,25 +105,26 @@ module ModernTreasury
 
       # delete virtual_account
       #
-      # @param id [String] Virtual Acccount ID
+      # @overload delete(id, request_options: {})
       #
-      # @param params [ModernTreasury::Models::VirtualAccountDeleteParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::VirtualAccount]
       #
+      # @see ModernTreasury::Models::VirtualAccountDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
-          path: ["api/virtual_accounts/%0s", id],
+          path: ["api/virtual_accounts/%1$s", id],
           model: ModernTreasury::Models::VirtualAccount,
           options: params[:request_options]
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  VERSION = "0.1.0-alpha.15"
+  VERSION = "0.1.0.pre.alpha.17"
 end

data/lib/modern_treasury.rb

@@ -1,33 +1,59 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+require "English"
 require "cgi"
 require "date"
 require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "pathname"
+require "rbconfig"
 require "securerandom"
 require "set"
 require "stringio"
 require "time"
 require "uri"
 
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+  Warning.warn(
+    <<~WARN
+      \n
+      ⚠️ skipped loading of "modern_treasury" gem under `tapioca`.
+
+      This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation.
+      \n
+    WARN
+  )
+  return
+end
+
 # Gems.
 require "connection_pool"
 
 # Package files.
 require_relative "modern_treasury/version"
-require_relative "modern_treasury/util"
-require_relative "modern_treasury/extern"
-require_relative "modern_treasury/base_model"
-require_relative "modern_treasury/base_page"
+require_relative "modern_treasury/internal/util"
+require_relative "modern_treasury/internal/type/converter"
+require_relative "modern_treasury/internal/type/unknown"
+require_relative "modern_treasury/internal/type/boolean"
+require_relative "modern_treasury/internal/type/enum"
+require_relative "modern_treasury/internal/type/union"
+require_relative "modern_treasury/internal/type/array_of"
+require_relative "modern_treasury/internal/type/hash_of"
+require_relative "modern_treasury/internal/type/base_model"
+require_relative "modern_treasury/internal/type/base_page"
+require_relative "modern_treasury/internal/type/request_parameters"
+require_relative "modern_treasury/internal"
 require_relative "modern_treasury/request_options"
 require_relative "modern_treasury/errors"
-require_relative "modern_treasury/base_client"
-require_relative "modern_treasury/pooled_net_requester"
+require_relative "modern_treasury/internal/transport/base_client"
+require_relative "modern_treasury/internal/transport/pooled_net_requester"
 require_relative "modern_treasury/client"
-require_relative "modern_treasury/page"
+require_relative "modern_treasury/internal/page"
 require_relative "modern_treasury/models/account_collection_flow"
 require_relative "modern_treasury/models/account_collection_flow_create_params"
 require_relative "modern_treasury/models/account_collection_flow_list_params"
@@ -184,7 +210,9 @@ require_relative "modern_treasury/models/ledger_update_params"
 require_relative "modern_treasury/models/legal_entity"
 require_relative "modern_treasury/models/legal_entity_association"
 require_relative "modern_treasury/models/legal_entity_association_create_params"
+require_relative "modern_treasury/models/legal_entity_compliance_detail"
 require_relative "modern_treasury/models/legal_entity_create_params"
+require_relative "modern_treasury/models/legal_entity_industry_classification"
 require_relative "modern_treasury/models/legal_entity_list_params"
 require_relative "modern_treasury/models/legal_entity_retrieve_params"
 require_relative "modern_treasury/models/legal_entity_update_params"

data/manifest.yaml

@@ -1,10 +1,13 @@
 dependencies:
+  - English
   - cgi
   - date
   - erb
   - etc
   - json
   - net/http
+  - pathname
+  - rbconfig
   - securerandom
   - set
   - stringio