modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

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

@@ -3,6 +3,14 @@
 module ModernTreasury
   module Models
     class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccount,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       sig { returns(String) }
       attr_accessor :id
 
@@ -11,14 +19,11 @@ module ModernTreasury
       # 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::LedgerAccount::Balances) }
+      sig { returns(ModernTreasury::LedgerAccount::Balances) }
       attr_reader :balances
 
       sig do
-        params(
-          balances: T.any(ModernTreasury::Models::LedgerAccount::Balances, ModernTreasury::Internal::AnyHash)
-        )
-          .void
+        params(balances: ModernTreasury::LedgerAccount::Balances::OrHash).void
       end
       attr_writer :balances
 
@@ -44,7 +49,11 @@ module ModernTreasury
       # If the ledger account links to another object in Modern Treasury, the type will
       # be populated here, otherwise null. The value is one of internal_account or
       # external_account.
-      sig { returns(T.nilable(ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)) }
+      sig do
+        returns(
+          T.nilable(ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol)
+        )
+      end
       attr_accessor :ledgerable_type
 
       # This field will be true if this object exists in the live environment or false
@@ -66,7 +75,7 @@ module ModernTreasury
       attr_accessor :name
 
       # The normal balance of the ledger account.
-      sig { returns(ModernTreasury::Models::TransactionDirection::TaggedSymbol) }
+      sig { returns(ModernTreasury::TransactionDirection::TaggedSymbol) }
       attr_accessor :normal_balance
 
       sig { returns(String) }
@@ -78,80 +87,111 @@ module ModernTreasury
       sig do
         params(
           id: String,
-          balances: T.any(ModernTreasury::Models::LedgerAccount::Balances, ModernTreasury::Internal::AnyHash),
+          balances: ModernTreasury::LedgerAccount::Balances::OrHash,
           created_at: Time,
           description: T.nilable(String),
           discarded_at: T.nilable(Time),
           ledger_id: String,
           ledgerable_id: T.nilable(String),
-          ledgerable_type: T.nilable(ModernTreasury::Models::LedgerAccount::LedgerableType::OrSymbol),
+          ledgerable_type:
+            T.nilable(ModernTreasury::LedgerAccount::LedgerableType::OrSymbol),
           live_mode: T::Boolean,
           lock_version: Integer,
           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. 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.
         description:,
         discarded_at:,
+        # The id of the ledger that this account belongs to.
         ledger_id:,
+        # If the ledger account links to another object in Modern Treasury, the id will be
+        # populated here, otherwise null.
         ledgerable_id:,
+        # If the ledger account links to another object in Modern Treasury, the type will
+        # be populated here, otherwise null. The value is one of internal_account or
+        # external_account.
         ledgerable_type:,
+        # This field will be true if this object exists in the live environment or false
+        # if it exists in the test environment.
         live_mode:,
+        # Lock version of the ledger account.
         lock_version:,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata:,
+        # The name of the ledger account.
         name:,
+        # The normal balance of the ledger account.
         normal_balance:,
         object:,
         updated_at:
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              balances: ModernTreasury::Models::LedgerAccount::Balances,
-              created_at: Time,
-              description: T.nilable(String),
-              discarded_at: T.nilable(Time),
-              ledger_id: String,
-              ledgerable_id: T.nilable(String),
-              ledgerable_type: T.nilable(ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol),
-              live_mode: T::Boolean,
-              lock_version: Integer,
-              metadata: T::Hash[Symbol, String],
-              name: String,
-              normal_balance: ModernTreasury::Models::TransactionDirection::TaggedSymbol,
-              object: String,
-              updated_at: Time
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            balances: ModernTreasury::LedgerAccount::Balances,
+            created_at: Time,
+            description: T.nilable(String),
+            discarded_at: T.nilable(Time),
+            ledger_id: String,
+            ledgerable_id: T.nilable(String),
+            ledgerable_type:
+              T.nilable(
+                ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol
+              ),
+            live_mode: T::Boolean,
+            lock_version: Integer,
+            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::LedgerAccount::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::LedgerAccount::Balances::AvailableBalance) }
+        sig do
+          returns(ModernTreasury::LedgerAccount::Balances::AvailableBalance)
+        end
         attr_reader :available_balance
 
         sig do
           params(
-            available_balance: T.any(
-              ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-            .void
+            available_balance:
+              ModernTreasury::LedgerAccount::Balances::AvailableBalance::OrHash
+          ).void
         end
         attr_writer :available_balance
 
@@ -166,26 +206,26 @@ module ModernTreasury
         attr_accessor :effective_at_upper_bound
 
         # The pending_balance is the sum of all pending and posted entries.
-        sig { returns(ModernTreasury::Models::LedgerAccount::Balances::PendingBalance) }
+        sig { returns(ModernTreasury::LedgerAccount::Balances::PendingBalance) }
         attr_reader :pending_balance
 
         sig do
           params(
-            pending_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PendingBalance, ModernTreasury::Internal::AnyHash)
-          )
-            .void
+            pending_balance:
+              ModernTreasury::LedgerAccount::Balances::PendingBalance::OrHash
+          ).void
         end
         attr_writer :pending_balance
 
         # The posted_balance is the sum of all posted entries.
-        sig { returns(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance) }
+        sig { returns(ModernTreasury::LedgerAccount::Balances::PostedBalance) }
         attr_reader :posted_balance
 
         sig do
           params(
-            posted_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance, ModernTreasury::Internal::AnyHash)
-          )
-            .void
+            posted_balance:
+              ModernTreasury::LedgerAccount::Balances::PostedBalance::OrHash
+          ).void
         end
         attr_writer :posted_balance
 
@@ -196,39 +236,61 @@ module ModernTreasury
         # amounts.
         sig do
           params(
-            available_balance: T.any(
-              ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance,
-              ModernTreasury::Internal::AnyHash
-            ),
+            available_balance:
+              ModernTreasury::LedgerAccount::Balances::AvailableBalance::OrHash,
             effective_at_lower_bound: T.nilable(Time),
             effective_at_upper_bound: T.nilable(Time),
-            pending_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PendingBalance, ModernTreasury::Internal::AnyHash),
-            posted_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance, ModernTreasury::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            pending_balance:
+              ModernTreasury::LedgerAccount::Balances::PendingBalance::OrHash,
+            posted_balance:
+              ModernTreasury::LedgerAccount::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 inclusive lower bound of the effective_at timestamp for the returned
+          # balances.
           effective_at_lower_bound:,
+          # The exclusive upper bound of the effective_at timestamp for the returned
+          # balances.
           effective_at_upper_bound:,
+          # 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
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                available_balance: ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance,
-                effective_at_lower_bound: T.nilable(Time),
-                effective_at_upper_bound: T.nilable(Time),
-                pending_balance: ModernTreasury::Models::LedgerAccount::Balances::PendingBalance,
-                posted_balance: ModernTreasury::Models::LedgerAccount::Balances::PostedBalance
-              }
-            )
+          override.returns(
+            {
+              available_balance:
+                ModernTreasury::LedgerAccount::Balances::AvailableBalance,
+              effective_at_lower_bound: T.nilable(Time),
+              effective_at_upper_bound: T.nilable(Time),
+              pending_balance:
+                ModernTreasury::LedgerAccount::Balances::PendingBalance,
+              posted_balance:
+                ModernTreasury::LedgerAccount::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::LedgerAccount::Balances::AvailableBalance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(Integer) }
           attr_accessor :amount
 
@@ -257,27 +319,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::LedgerAccount::Balances::PendingBalance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(Integer) }
           attr_accessor :amount
 
@@ -303,27 +381,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::LedgerAccount::Balances::PostedBalance,
+                ModernTreasury::Internal::AnyHash
+              )
+            end
+
           sig { returns(Integer) }
           attr_accessor :amount
 
@@ -349,24 +443,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
 
@@ -376,20 +478,42 @@ module ModernTreasury
       module LedgerableType
         extend ModernTreasury::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccount::LedgerableType) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::LedgerAccount::LedgerableType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        COUNTERPARTY = T.let(:counterparty, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+        COUNTERPARTY =
+          T.let(
+            :counterparty,
+            ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol
+          )
         EXTERNAL_ACCOUNT =
-          T.let(:external_account, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+          T.let(
+            :external_account,
+            ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol
+          )
         INTERNAL_ACCOUNT =
-          T.let(:internal_account, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+          T.let(
+            :internal_account,
+            ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol
+          )
         VIRTUAL_ACCOUNT =
-          T.let(:virtual_account, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+          T.let(
+            :virtual_account,
+            ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerAccount::LedgerableType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
       end
     end
   end