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

data/rbi/lib/modern_treasury/resources/ledger_account_categories.rbi

@@ -3,62 +3,95 @@
 module ModernTreasury
   module Resources
     class LedgerAccountCategories
+      # Create a ledger account category.
       sig do
         params(
           currency: String,
           ledger_id: String,
           name: String,
-          normal_balance: Symbol,
+          normal_balance: ModernTreasury::Models::TransactionDirection::OrSymbol,
           currency_exponent: T.nilable(Integer),
           description: T.nilable(String),
           ledger_account_category_ids: T::Array[String],
           metadata: T::Hash[Symbol, String],
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountCategory)
       end
       def create(
+        # The currency of the ledger account category.
         currency:,
+        # The id of the ledger that this account category belongs to.
         ledger_id:,
+        # The name of the ledger account category.
         name:,
+        # The normal balance of the ledger account category.
         normal_balance:,
+        # The currency exponent of the ledger account category.
         currency_exponent: nil,
+        # The description of the ledger account category.
         description: nil,
+        # The array of ledger account category ids that this ledger account category
+        # should be a child of.
         ledger_account_category_ids: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata: nil,
         request_options: {}
-      )
-      end
-
+      ); end
+      # Get the details on a single ledger account category.
       sig do
         params(
           id: String,
-          balances: ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          balances: T.any(
+            ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances,
+            ModernTreasury::Internal::AnyHash
+          ),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountCategory)
       end
-      def retrieve(id, balances: nil, request_options: {})
-      end
-
+      def retrieve(
+        # id
+        id,
+        # For example, if you want the balances as of a particular time (ISO8601), the
+        # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+        # The balances as of a time are inclusive of entries with that exact time.
+        balances: nil,
+        request_options: {}
+      ); end
+      # Update the details of a ledger account category.
       sig do
         params(
           id: String,
           description: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           name: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountCategory)
       end
-      def update(id, description: nil, metadata: nil, name: nil, request_options: {})
-      end
-
+      def update(
+        # id
+        id,
+        # The description of the ledger account category.
+        description: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
+        metadata: nil,
+        # The name of the ledger account category.
+        name: nil,
+        request_options: {}
+      ); end
+      # Get a list of ledger account categories.
       sig do
         params(
           id: T::Array[String],
           after_cursor: T.nilable(String),
-          balances: ModernTreasury::Models::LedgerAccountCategoryListParams::Balances,
+          balances: T.any(
+            ModernTreasury::Models::LedgerAccountCategoryListParams::Balances,
+            ModernTreasury::Internal::AnyHash
+          ),
           currency: String,
           ledger_account_id: String,
           ledger_id: String,
@@ -66,82 +99,114 @@ module ModernTreasury
           name: String,
           parent_ledger_account_category_id: String,
           per_page: Integer,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
-          .returns(ModernTreasury::Page[ModernTreasury::Models::LedgerAccountCategory])
+          .returns(ModernTreasury::Internal::Page[ModernTreasury::Models::LedgerAccountCategory])
       end
       def list(
+        # If you have specific IDs to retrieve in bulk, you can pass them as query
+        # parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
         id: nil,
         after_cursor: nil,
+        # For example, if you want the balances as of a particular time (ISO8601), the
+        # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
+        # The balances as of a time are inclusive of entries with that exact time.
         balances: nil,
         currency: nil,
+        # Query categories which contain a ledger account directly or through child
+        # categories.
         ledger_account_id: nil,
         ledger_id: nil,
+        # 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.
         metadata: nil,
         name: nil,
+        # Query categories that are nested underneath a parent category
         parent_ledger_account_category_id: nil,
         per_page: nil,
         request_options: {}
-      )
-      end
-
+      ); end
+      # Delete a ledger account category.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountCategory)
       end
-      def delete(id, request_options: {})
-      end
-
+      def delete(
+        # id
+        id,
+        request_options: {}
+      ); end
+      # Add a ledger account to a ledger account category.
       sig do
         params(
           ledger_account_id: String,
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .void
       end
-      def add_ledger_account(ledger_account_id, id:, request_options: {})
-      end
-
+      def add_ledger_account(
+        # ledger_account_id
+        ledger_account_id,
+        # id
+        id:,
+        request_options: {}
+      ); end
+      # Add a ledger account category to a ledger account category.
       sig do
         params(
           sub_category_id: String,
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .void
       end
-      def add_nested_category(sub_category_id, id:, request_options: {})
-      end
-
+      def add_nested_category(
+        # sub_category_id
+        sub_category_id,
+        # id
+        id:,
+        request_options: {}
+      ); end
+      # Remove a ledger account from a ledger account category.
       sig do
         params(
           ledger_account_id: String,
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .void
       end
-      def remove_ledger_account(ledger_account_id, id:, request_options: {})
-      end
-
+      def remove_ledger_account(
+        # ledger_account_id
+        ledger_account_id,
+        # id
+        id:,
+        request_options: {}
+      ); end
+      # Delete a ledger account category from a ledger account category.
       sig do
         params(
           sub_category_id: String,
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .void
       end
-      def remove_nested_category(sub_category_id, id:, request_options: {})
-      end
-
-      sig { params(client: ModernTreasury::Client).void }
-      def initialize(client:)
-      end
+      def remove_nested_category(
+        # sub_category_id
+        sub_category_id,
+        # id
+        id:,
+        request_options: {}
+      ); end
+      # @api private
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/modern_treasury/resources/ledger_account_settlements/account_entries.rbi

@@ -4,31 +4,53 @@ module ModernTreasury
   module Resources
     class LedgerAccountSettlements
       class AccountEntries
+        # Add ledger entries to a draft ledger account settlement.
         sig do
           params(
             id: String,
             ledger_entry_ids: T.nilable(T::Array[String]),
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(
+              T.any(
+                ModernTreasury::RequestOptions,
+                ModernTreasury::Internal::AnyHash
+              )
+            )
           )
             .void
         end
-        def update(id, ledger_entry_ids:, request_options: {})
-        end
-
+        def update(
+          # id
+          id,
+          # The ids of the ledger entries that are to be added or removed from the ledger
+          # account settlement.
+          ledger_entry_ids:,
+          request_options: {}
+        ); end
+        # Remove ledger entries from a draft ledger account settlement.
         sig do
           params(
             id: String,
-            ledger_entry_ids: T.nilable(T::Array[T.anything]),
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            ledger_entry_ids: T.nilable(T::Array[String]),
+            request_options: T.nilable(
+              T.any(
+                ModernTreasury::RequestOptions,
+                ModernTreasury::Internal::AnyHash
+              )
+            )
           )
             .void
         end
-        def delete(id, ledger_entry_ids:, request_options: {})
-        end
-
-        sig { params(client: ModernTreasury::Client).void }
-        def initialize(client:)
-        end
+        def delete(
+          # id
+          id,
+          # The ids of the ledger entries that are to be added or removed from the ledger
+          # account settlement.
+          ledger_entry_ids:,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+        def self.new(client:); end
       end
     end
   end

data/rbi/lib/modern_treasury/resources/ledger_account_settlements.rbi

@@ -4,9 +4,9 @@ module ModernTreasury
   module Resources
     class LedgerAccountSettlements
       sig { returns(ModernTreasury::Resources::LedgerAccountSettlements::AccountEntries) }
-      def account_entries
-      end
+      attr_reader :account_entries
 
+      # Create a ledger account settlement.
       sig do
         params(
           contra_ledger_account_id: String,
@@ -16,47 +16,77 @@ module ModernTreasury
           effective_at_upper_bound: T.nilable(Time),
           metadata: T::Hash[Symbol, String],
           skip_settlement_ledger_transaction: T.nilable(T::Boolean),
-          status: T.nilable(Symbol),
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          status: T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol),
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountSettlement)
       end
       def create(
+        # The id of the contra ledger account that sends to or receives funds from the
+        # settled ledger account.
         contra_ledger_account_id:,
+        # The id of the settled ledger account whose ledger entries are queried against,
+        # and its balance is reduced as a result.
         settled_ledger_account_id:,
+        # If true, the settlement amount and settlement_entry_direction will bring the
+        # settlement ledger account's balance closer to zero, even if the balance is
+        # negative.
         allow_either_direction: nil,
+        # The description of the ledger account settlement.
         description: nil,
+        # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+        # be included in the ledger account settlement. The default value is the
+        # created_at timestamp of the ledger account settlement.
         effective_at_upper_bound: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata: nil,
+        # It is set to `false` by default. It should be set to `true` when migrating
+        # existing settlements.
         skip_settlement_ledger_transaction: nil,
+        # The status of the ledger account settlement. It is set to `pending` by default.
+        # To post a ledger account settlement at creation, use `posted`.
         status: nil,
         request_options: {}
-      )
-      end
-
+      ); end
+      # Get details on a single ledger account settlement.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountSettlement)
       end
-      def retrieve(id, request_options: {})
-      end
-
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      ); end
+      # Update the details of a ledger account settlement.
       sig do
         params(
           id: String,
           description: T.nilable(String),
           metadata: T::Hash[Symbol, String],
-          status: Symbol,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          status: ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status::OrSymbol,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountSettlement)
       end
-      def update(id, description: nil, metadata: nil, status: nil, request_options: {})
-      end
-
+      def update(
+        # id
+        id,
+        # The description of the ledger account settlement.
+        description: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
+        metadata: nil,
+        # To post a pending ledger account settlement, use `posted`. To archive a pending
+        # ledger transaction, use `archived`.
+        status: nil,
+        request_options: {}
+      ); end
+      # Get a list of ledger account settlements.
       sig do
         params(
           id: T::Array[String],
@@ -69,28 +99,37 @@ module ModernTreasury
           settled_ledger_account_id: String,
           settlement_entry_direction: String,
           updated_at: T::Hash[Symbol, Time],
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
-          .returns(ModernTreasury::Page[ModernTreasury::Models::LedgerAccountSettlement])
+          .returns(ModernTreasury::Internal::Page[ModernTreasury::Models::LedgerAccountSettlement])
       end
       def list(
+        # If you have specific IDs to retrieve in bulk, you can pass them as query
+        # parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
         id: nil,
         after_cursor: nil,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        # created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+        # created_at%5Bgt%5D=2000-01-01T12:00:00Z.
         created_at: nil,
         ledger_id: nil,
         ledger_transaction_id: nil,
+        # 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.
         metadata: nil,
         per_page: nil,
         settled_ledger_account_id: nil,
         settlement_entry_direction: nil,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        # updated at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+        # updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
         updated_at: nil,
         request_options: {}
-      )
-      end
-
-      sig { params(client: ModernTreasury::Client).void }
-      def initialize(client:)
-      end
+      ); end
+      # @api private
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/modern_treasury/resources/ledger_account_statements.rbi

@@ -3,6 +3,7 @@
 module ModernTreasury
   module Resources
     class LedgerAccountStatements
+      # Create a ledger account statement.
       sig do
         params(
           effective_at_lower_bound: Time,
@@ -10,33 +11,43 @@ module ModernTreasury
           ledger_account_id: String,
           description: T.nilable(String),
           metadata: T::Hash[Symbol, String],
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountStatementCreateResponse)
       end
       def create(
+        # The inclusive lower bound of the effective_at timestamp of the ledger entries to
+        # be included in the ledger account statement.
         effective_at_lower_bound:,
+        # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+        # be included in the ledger account statement.
         effective_at_upper_bound:,
+        # The id of the ledger account whose ledger entries are queried against, and its
+        # balances are computed as a result.
         ledger_account_id:,
+        # The description of the ledger account statement.
         description: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata: nil,
         request_options: {}
-      )
-      end
-
+      ); end
+      # Get details on a single ledger account statement.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash))
         )
           .returns(ModernTreasury::Models::LedgerAccountStatementRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
-      end
-
-      sig { params(client: ModernTreasury::Client).void }
-      def initialize(client:)
-      end
+      def retrieve(
+        # id
+        id,
+        request_options: {}
+      ); end
+      # @api private
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:); end
     end
   end
 end