modern_treasury 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/resources/virtual_accounts.rb

@@ -3,32 +3,45 @@
 module ModernTreasury
   module Resources
     class VirtualAccounts
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::VirtualAccountCreateParams} for more details.
+      #
       # create virtual_account
       #
       # @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 internal_account_id [String] The ID of the internal account that this virtual account is associated with.
+      #
+      # @param name [String] The name of the virtual account.
+      #
+      # @param account_details [Array<ModernTreasury::VirtualAccountCreateParams::AccountDetail>] An array of account detail objects.
+      #
+      # @param counterparty_id [String] The ID of the counterparty that the virtual account belongs to.
+      #
+      # @param credit_ledger_account_id [String] The ID of a credit normal ledger account. When money leaves the virtual account,
+      #
+      # @param debit_ledger_account_id [String] The ID of a debit normal ledger account. When money enters the virtual account,
+      #
+      # @param description [String] An optional description for internal use.
+      #
+      # @param ledger_account [ModernTreasury::VirtualAccountCreateParams::LedgerAccount] Specifies a ledger account object that will be created with the virtual account.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param routing_details [Array<ModernTreasury::VirtualAccountCreateParams::RoutingDetail>] An array of routing detail objects.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::VirtualAccount]
+      # @return [ModernTreasury::VirtualAccount]
       #
       # @see ModernTreasury::Models::VirtualAccountCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::VirtualAccountCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::VirtualAccountCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/virtual_accounts",
           body: parsed,
-          model: ModernTreasury::Models::VirtualAccount,
+          model: ModernTreasury::VirtualAccount,
           options: options
         )
       end
@@ -37,17 +50,18 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] Virtual Acccount ID
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::VirtualAccount]
+      # @return [ModernTreasury::VirtualAccount]
       #
       # @see ModernTreasury::Models::VirtualAccountRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/virtual_accounts/%1$s", id],
-          model: ModernTreasury::Models::VirtualAccount,
+          model: ModernTreasury::VirtualAccount,
           options: params[:request_options]
         )
       end
@@ -56,49 +70,62 @@ module ModernTreasury
       #
       # @overload update(id, counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] Virtual Acccount ID
+      #
       # @param counterparty_id [String]
-      # @param ledger_account_id [String]
+      #
+      # @param ledger_account_id [String] The ledger account that you'd like to link to the virtual account.
+      #
       # @param metadata [Hash{Symbol=>String}]
+      #
       # @param name [String, nil]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::VirtualAccount]
+      # @return [ModernTreasury::VirtualAccount]
       #
       # @see ModernTreasury::Models::VirtualAccountUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::VirtualAccountUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::VirtualAccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/virtual_accounts/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::VirtualAccount,
+          model: ModernTreasury::VirtualAccount,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::VirtualAccountListParams} for more details.
+      #
       # Get a list of virtual accounts.
       #
       # @overload list(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, metadata: nil, per_page: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
+      #
       # @param counterparty_id [String]
+      #
       # @param internal_account_id [String]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param per_page [Integer]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::VirtualAccount>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::VirtualAccount>]
       #
       # @see ModernTreasury::Models::VirtualAccountListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::VirtualAccountListParams.dump_request(params)
+        parsed, options = ModernTreasury::VirtualAccountListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/virtual_accounts",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::VirtualAccount,
+          model: ModernTreasury::VirtualAccount,
           options: options
         )
       end
@@ -107,17 +134,18 @@ module ModernTreasury
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] Virtual Acccount ID
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::VirtualAccount]
+      # @return [ModernTreasury::VirtualAccount]
       #
       # @see ModernTreasury::Models::VirtualAccountDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
           path: ["api/virtual_accounts/%1$s", id],
-          model: ModernTreasury::Models::VirtualAccount,
+          model: ModernTreasury::VirtualAccount,
           options: params[:request_options]
         )
       end

data/lib/modern_treasury/version.rb

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

data/lib/modern_treasury.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
 require "English"
 require "cgi"
 require "date"
@@ -15,19 +16,11 @@ require "set"
 require "stringio"
 require "time"
 require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
 # 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
 
@@ -40,6 +33,7 @@ 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/file_input"
 require_relative "modern_treasury/internal/type/enum"
 require_relative "modern_treasury/internal/type/union"
 require_relative "modern_treasury/internal/type/array_of"
@@ -49,6 +43,7 @@ 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/file_part"
 require_relative "modern_treasury/errors"
 require_relative "modern_treasury/internal/transport/base_client"
 require_relative "modern_treasury/internal/transport/pooled_net_requester"
@@ -276,6 +271,7 @@ require_relative "modern_treasury/models/virtual_account_list_params"
 require_relative "modern_treasury/models/virtual_account_retrieve_params"
 require_relative "modern_treasury/models/virtual_account_update_params"
 require_relative "modern_treasury/models/wealth_and_employment_details"
+require_relative "modern_treasury/models"
 require_relative "modern_treasury/resources/account_collection_flows"
 require_relative "modern_treasury/resources/account_details"
 require_relative "modern_treasury/resources/bulk_requests"

data/rbi/{lib/modern_treasury → modern_treasury}/client.rbi

@@ -130,16 +130,17 @@ module ModernTreasury
     # A test endpoint often used to confirm credentials and headers are being passed
     # in correctly.
     sig do
-      params(
-        request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
+      params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+        ModernTreasury::PingResponse
       )
-        .returns(ModernTreasury::Models::PingResponse)
     end
-    def ping(request_options: {}); end
+    def ping(request_options: {})
+    end
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers; end
+    private def auth_headers
+    end
 
     # Creates and returns a new client for interacting with the API.
     sig do
@@ -152,22 +153,23 @@ module ModernTreasury
         initial_retry_delay: Float,
         max_retry_delay: Float,
         idempotency_header: String
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
     end
     def self.new(
       # Defaults to `ENV["MODERN_TREASURY_API_KEY"]`
       api_key: ENV["MODERN_TREASURY_API_KEY"],
       # Defaults to `ENV["MODERN_TREASURY_ORGANIZATION_ID"]`
       organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"],
-      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
-      base_url: nil,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERN_TREASURY_BASE_URL"]`
+      base_url: ENV["MODERN_TREASURY_BASE_URL"],
       # Max number of retries to attempt after a failed retryable request.
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      max_retries: ModernTreasury::Client::DEFAULT_MAX_RETRIES,
+      timeout: ModernTreasury::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: ModernTreasury::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: ModernTreasury::Client::DEFAULT_MAX_RETRY_DELAY,
       idempotency_header: "Idempotency-Key"
-    ); end
+    )
+    end
   end
 end

data/rbi/{lib/modern_treasury → modern_treasury}/errors.rbi

@@ -29,10 +29,17 @@ module ModernTreasury
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
     end
 
     class APIConnectionError < ModernTreasury::Errors::APIError
@@ -51,10 +58,16 @@ module ModernTreasury
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
       end
     end
 
@@ -68,10 +81,16 @@ module ModernTreasury
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
       end
     end
 
@@ -85,10 +104,10 @@ module ModernTreasury
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil); end
 
       sig { returns(Integer) }
       attr_accessor :status
@@ -102,10 +121,10 @@ module ModernTreasury
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil); end
     end
 
     class BadRequestError < ModernTreasury::Errors::APIStatusError

data/rbi/modern_treasury/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module ModernTreasury
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end

data/rbi/{lib/modern_treasury → modern_treasury}/internal/page.rbi

@@ -14,16 +14,21 @@ module ModernTreasury
       attr_accessor :after_cursor
 
       sig { override.returns(T::Boolean) }
-      def next_page?; end
+      def next_page?
+      end
 
       sig { override.returns(T.self_type) }
-      def next_page; end
+      def next_page
+      end
 
       sig { override.params(blk: T.proc.params(arg0: Elem).void).void }
-      def auto_paging_each(&blk); end
+      def auto_paging_each(&blk)
+      end
 
+      # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end