modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/rbi/modern_treasury/models/ledger_account_balance_monitor_delete_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountBalanceMonitorDeleteParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountBalanceMonitorDeleteParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: ModernTreasury::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_balance_monitor_list_params.rbi

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountBalanceMonitorListParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # 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`.
       sig { returns(T.nilable(T::Array[String])) }
@@ -46,14 +54,19 @@ module ModernTreasury
           ledger_account_id: String,
           metadata: T::Hash[Symbol, String],
           per_page: Integer,
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
+        # 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,
+        # Query the balance monitors for a single ledger account.
         ledger_account_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,
         request_options: {}
@@ -61,19 +74,19 @@ module ModernTreasury
       end
 
       sig do
-        override
-          .returns(
-            {
-              id: T::Array[String],
-              after_cursor: T.nilable(String),
-              ledger_account_id: String,
-              metadata: T::Hash[Symbol, String],
-              per_page: Integer,
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            id: T::Array[String],
+            after_cursor: T.nilable(String),
+            ledger_account_id: String,
+            metadata: T::Hash[Symbol, String],
+            per_page: Integer,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/modern_treasury/models/ledger_account_balance_monitor_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountBalanceMonitorRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountBalanceMonitorRetrieveParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: ModernTreasury::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_balance_monitor_update_params.rbi

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountBalanceMonitorUpdateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # An optional, free-form description for internal use.
       sig { returns(T.nilable(String)) }
       attr_reader :description
@@ -25,23 +33,30 @@ module ModernTreasury
         params(
           description: String,
           metadata: T::Hash[Symbol, String],
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # An optional, free-form description for internal use.
+        description: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
+        metadata: nil,
+        request_options: {}
+      )
       end
-      def self.new(description: nil, metadata: nil, request_options: {}); end
 
       sig do
-        override
-          .returns(
-            {
-              description: String,
-              metadata: T::Hash[Symbol, String],
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            description: String,
+            metadata: T::Hash[Symbol, String],
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_category.rbi

@@ -3,6 +3,14 @@
 module ModernTreasury
   module Models
     class LedgerAccountCategory < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountCategory,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       sig { returns(String) }
       attr_accessor :id
 
@@ -11,14 +19,13 @@ module ModernTreasury
       # balance is the sum of all pending and posted entries on the account. The
       # available balance is the posted incoming entries minus the sum of the pending
       # and posted outgoing amounts.
-      sig { returns(ModernTreasury::Models::LedgerAccountCategory::Balances) }
+      sig { returns(ModernTreasury::LedgerAccountCategory::Balances) }
       attr_reader :balances
 
       sig do
         params(
-          balances: T.any(ModernTreasury::Models::LedgerAccountCategory::Balances, ModernTreasury::Internal::AnyHash)
-        )
-          .void
+          balances: ModernTreasury::LedgerAccountCategory::Balances::OrHash
+        ).void
       end
       attr_writer :balances
 
@@ -51,7 +58,7 @@ module ModernTreasury
       attr_accessor :name
 
       # The normal balance of the ledger account category.
-      sig { returns(ModernTreasury::Models::TransactionDirection::TaggedSymbol) }
+      sig { returns(ModernTreasury::TransactionDirection::TaggedSymbol) }
       attr_accessor :normal_balance
 
       sig { returns(String) }
@@ -63,7 +70,7 @@ module ModernTreasury
       sig do
         params(
           id: String,
-          balances: T.any(ModernTreasury::Models::LedgerAccountCategory::Balances, ModernTreasury::Internal::AnyHash),
+          balances: ModernTreasury::LedgerAccountCategory::Balances::OrHash,
           created_at: Time,
           description: T.nilable(String),
           discarded_at: T.nilable(Time),
@@ -71,93 +78,118 @@ module ModernTreasury
           live_mode: T::Boolean,
           metadata: T::Hash[Symbol, String],
           name: String,
-          normal_balance: ModernTreasury::Models::TransactionDirection::OrSymbol,
+          normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
           object: String,
           updated_at: Time
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         id:,
+        # The pending, posted, and available balances for this ledger account category.
+        # The posted balance is the sum of all posted entries on the account. The pending
+        # balance is the sum of all pending and posted entries on the account. The
+        # available balance is the posted incoming entries minus the sum of the pending
+        # and posted outgoing amounts.
         balances:,
         created_at:,
+        # The description of the ledger account category.
         description:,
         discarded_at:,
+        # The id of the ledger that this account category belongs to.
         ledger_id:,
+        # This field will be true if this object exists in the live environment or false
+        # if it exists in the test environment.
         live_mode:,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata:,
+        # The name of the ledger account category.
         name:,
+        # The normal balance of the ledger account category.
         normal_balance:,
         object:,
         updated_at:
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              balances: ModernTreasury::Models::LedgerAccountCategory::Balances,
-              created_at: Time,
-              description: T.nilable(String),
-              discarded_at: T.nilable(Time),
-              ledger_id: String,
-              live_mode: T::Boolean,
-              metadata: T::Hash[Symbol, String],
-              name: String,
-              normal_balance: ModernTreasury::Models::TransactionDirection::TaggedSymbol,
-              object: String,
-              updated_at: Time
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            balances: ModernTreasury::LedgerAccountCategory::Balances,
+            created_at: Time,
+            description: T.nilable(String),
+            discarded_at: T.nilable(Time),
+            ledger_id: String,
+            live_mode: T::Boolean,
+            metadata: T::Hash[Symbol, String],
+            name: String,
+            normal_balance: ModernTreasury::TransactionDirection::TaggedSymbol,
+            object: String,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Balances < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::LedgerAccountCategory::Balances,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
         # The available_balance is the sum of all posted inbound entries and pending
         # outbound entries. For credit normal, available_amount = posted_credits -
         # pending_debits; for debit normal, available_amount = posted_debits -
         # pending_credits.
-        sig { returns(ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance) }
+        sig do
+          returns(
+            ModernTreasury::LedgerAccountCategory::Balances::AvailableBalance
+          )
+        end
         attr_reader :available_balance
 
         sig do
           params(
-            available_balance: T.any(
-              ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-            .void
+            available_balance:
+              ModernTreasury::LedgerAccountCategory::Balances::AvailableBalance::OrHash
+          ).void
         end
         attr_writer :available_balance
 
         # The pending_balance is the sum of all pending and posted entries.
-        sig { returns(ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance) }
+        sig do
+          returns(
+            ModernTreasury::LedgerAccountCategory::Balances::PendingBalance
+          )
+        end
         attr_reader :pending_balance
 
         sig do
           params(
-            pending_balance: T.any(
-              ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-            .void
+            pending_balance:
+              ModernTreasury::LedgerAccountCategory::Balances::PendingBalance::OrHash
+          ).void
         end
         attr_writer :pending_balance
 
         # The posted_balance is the sum of all posted entries.
-        sig { returns(ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance) }
+        sig do
+          returns(
+            ModernTreasury::LedgerAccountCategory::Balances::PostedBalance
+          )
+        end
         attr_reader :posted_balance
 
         sig do
           params(
-            posted_balance: T.any(
-              ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-            .void
+            posted_balance:
+              ModernTreasury::LedgerAccountCategory::Balances::PostedBalance::OrHash
+          ).void
         end
         attr_writer :posted_balance
 
@@ -168,36 +200,51 @@ module ModernTreasury
         # and posted outgoing amounts.
         sig do
           params(
-            available_balance: T.any(
-              ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance,
-              ModernTreasury::Internal::AnyHash
-            ),
-            pending_balance: T.any(
-              ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance,
-              ModernTreasury::Internal::AnyHash
-            ),
-            posted_balance: T.any(
-              ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-            .returns(T.attached_class)
+            available_balance:
+              ModernTreasury::LedgerAccountCategory::Balances::AvailableBalance::OrHash,
+            pending_balance:
+              ModernTreasury::LedgerAccountCategory::Balances::PendingBalance::OrHash,
+            posted_balance:
+              ModernTreasury::LedgerAccountCategory::Balances::PostedBalance::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The available_balance is the sum of all posted inbound entries and pending
+          # outbound entries. For credit normal, available_amount = posted_credits -
+          # pending_debits; for debit normal, available_amount = posted_debits -
+          # pending_credits.
+          available_balance:,
+          # The pending_balance is the sum of all pending and posted entries.
+          pending_balance:,
+          # The posted_balance is the sum of all posted entries.
+          posted_balance:
+        )
         end
-        def self.new(available_balance:, pending_balance:, posted_balance:); end
 
         sig do
-          override
-            .returns(
-              {
-                available_balance: ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance,
-                pending_balance: ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance,
-                posted_balance: ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance
-              }
-            )
+          override.returns(
+            {
+              available_balance:
+                ModernTreasury::LedgerAccountCategory::Balances::AvailableBalance,
+              pending_balance:
+                ModernTreasury::LedgerAccountCategory::Balances::PendingBalance,
+              posted_balance:
+                ModernTreasury::LedgerAccountCategory::Balances::PostedBalance
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModernTreasury::LedgerAccountCategory::Balances::AvailableBalance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(Integer) }
           attr_accessor :amount
 
@@ -226,27 +273,43 @@ module ModernTreasury
               currency: String,
               currency_exponent: Integer,
               debits: Integer
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            credits:,
+            # The currency of the ledger account.
+            currency:,
+            # The currency exponent of the ledger account.
+            currency_exponent:,
+            debits:
+          )
           end
-          def self.new(amount:, credits:, currency:, currency_exponent:, debits:); end
 
           sig do
-            override
-              .returns(
-                {
-                  amount: Integer,
-                  credits: Integer,
-                  currency: String,
-                  currency_exponent: Integer,
-                  debits: Integer
-                }
-              )
+            override.returns(
+              {
+                amount: Integer,
+                credits: Integer,
+                currency: String,
+                currency_exponent: Integer,
+                debits: Integer
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
         end
 
         class PendingBalance < ModernTreasury::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModernTreasury::LedgerAccountCategory::Balances::PendingBalance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(Integer) }
           attr_accessor :amount
 
@@ -272,27 +335,43 @@ module ModernTreasury
               currency: String,
               currency_exponent: Integer,
               debits: Integer
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            credits:,
+            # The currency of the ledger account.
+            currency:,
+            # The currency exponent of the ledger account.
+            currency_exponent:,
+            debits:
+          )
           end
-          def self.new(amount:, credits:, currency:, currency_exponent:, debits:); end
 
           sig do
-            override
-              .returns(
-                {
-                  amount: Integer,
-                  credits: Integer,
-                  currency: String,
-                  currency_exponent: Integer,
-                  debits: Integer
-                }
-              )
+            override.returns(
+              {
+                amount: Integer,
+                credits: Integer,
+                currency: String,
+                currency_exponent: Integer,
+                debits: Integer
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
         end
 
         class PostedBalance < ModernTreasury::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModernTreasury::LedgerAccountCategory::Balances::PostedBalance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(Integer) }
           attr_accessor :amount
 
@@ -318,24 +397,32 @@ module ModernTreasury
               currency: String,
               currency_exponent: Integer,
               debits: Integer
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            credits:,
+            # The currency of the ledger account.
+            currency:,
+            # The currency exponent of the ledger account.
+            currency_exponent:,
+            debits:
+          )
           end
-          def self.new(amount:, credits:, currency:, currency_exponent:, debits:); end
 
           sig do
-            override
-              .returns(
-                {
-                  amount: Integer,
-                  credits: Integer,
-                  currency: String,
-                  currency_exponent: Integer,
-                  debits: Integer
-                }
-              )
+            override.returns(
+              {
+                amount: Integer,
+                credits: Integer,
+                currency: String,
+                currency_exponent: Integer,
+                debits: Integer
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
         end
       end
     end

data/rbi/modern_treasury/models/ledger_account_category_add_ledger_account_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCategoryAddLedgerAccountParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountCategoryAddLedgerAccountParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: ModernTreasury::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end