modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/ledger_account.rbi

@@ -4,149 +4,96 @@ module ModernTreasury
   module Models
     class LedgerAccount < ModernTreasury::BaseModel
       sig { returns(String) }
-      def id
-      end
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :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.
       sig { returns(ModernTreasury::Models::LedgerAccount::Balances) }
-      def balances
-      end
+      attr_reader :balances
 
       sig do
-        params(_: ModernTreasury::Models::LedgerAccount::Balances)
-          .returns(ModernTreasury::Models::LedgerAccount::Balances)
-      end
-      def balances=(_)
+        params(balances: T.any(ModernTreasury::Models::LedgerAccount::Balances, ModernTreasury::Util::AnyHash))
+          .void
       end
+      attr_writer :balances
 
       sig { returns(Time) }
-      def created_at
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def created_at=(_)
-      end
+      attr_accessor :created_at
 
+      # The description of the ledger account.
       sig { returns(T.nilable(String)) }
-      def description
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def description=(_)
-      end
+      attr_accessor :description
 
       sig { returns(T.nilable(Time)) }
-      def discarded_at
-      end
-
-      sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
-      def discarded_at=(_)
-      end
+      attr_accessor :discarded_at
 
+      # The id of the ledger that this account belongs to.
       sig { returns(String) }
-      def ledger_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def ledger_id=(_)
-      end
+      attr_accessor :ledger_id
 
+      # If the ledger account links to another object in Modern Treasury, the id will be
+      #   populated here, otherwise null.
       sig { returns(T.nilable(String)) }
-      def ledgerable_id
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def ledgerable_id=(_)
-      end
-
-      sig { returns(T.nilable(Symbol)) }
-      def ledgerable_type
-      end
+      attr_accessor :ledgerable_id
 
-      sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-      def ledgerable_type=(_)
-      end
+      # 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)) }
+      attr_accessor :ledgerable_type
 
+      # This field will be true if this object exists in the live environment or false
+      #   if it exists in the test environment.
       sig { returns(T::Boolean) }
-      def live_mode
-      end
-
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def live_mode=(_)
-      end
+      attr_accessor :live_mode
 
+      # Lock version of the ledger account.
       sig { returns(Integer) }
-      def lock_version
-      end
-
-      sig { params(_: Integer).returns(Integer) }
-      def lock_version=(_)
-      end
+      attr_accessor :lock_version
 
+      # Additional data represented as key-value pairs. Both the key and value must be
+      #   strings.
       sig { returns(T::Hash[Symbol, String]) }
-      def metadata
-      end
-
-      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
-      def metadata=(_)
-      end
+      attr_accessor :metadata
 
+      # The name of the ledger account.
       sig { returns(String) }
-      def name
-      end
-
-      sig { params(_: String).returns(String) }
-      def name=(_)
-      end
+      attr_accessor :name
 
-      sig { returns(Symbol) }
-      def normal_balance
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def normal_balance=(_)
-      end
+      # The normal balance of the ledger account.
+      sig { returns(ModernTreasury::Models::TransactionDirection::TaggedSymbol) }
+      attr_accessor :normal_balance
 
       sig { returns(String) }
-      def object
-      end
-
-      sig { params(_: String).returns(String) }
-      def object=(_)
-      end
+      attr_accessor :object
 
       sig { returns(Time) }
-      def updated_at
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def updated_at=(_)
-      end
+      attr_accessor :updated_at
 
       sig do
         params(
           id: String,
-          balances: ModernTreasury::Models::LedgerAccount::Balances,
+          balances: T.any(ModernTreasury::Models::LedgerAccount::Balances, ModernTreasury::Util::AnyHash),
           created_at: Time,
           description: T.nilable(String),
           discarded_at: T.nilable(Time),
           ledger_id: String,
           ledgerable_id: T.nilable(String),
-          ledgerable_type: T.nilable(Symbol),
+          ledgerable_type: T.nilable(ModernTreasury::Models::LedgerAccount::LedgerableType::OrSymbol),
           live_mode: T::Boolean,
           lock_version: Integer,
           metadata: T::Hash[Symbol, String],
           name: String,
-          normal_balance: Symbol,
+          normal_balance: ModernTreasury::Models::TransactionDirection::OrSymbol,
           object: String,
           updated_at: Time
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         id:,
         balances:,
         created_at:,
@@ -176,12 +123,12 @@ module ModernTreasury
               discarded_at: T.nilable(Time),
               ledger_id: String,
               ledgerable_id: T.nilable(String),
-              ledgerable_type: T.nilable(Symbol),
+              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: Symbol,
+              normal_balance: ModernTreasury::Models::TransactionDirection::TaggedSymbol,
               object: String,
               updated_at: Time
             }
@@ -191,66 +138,71 @@ module ModernTreasury
       end
 
       class Balances < ModernTreasury::BaseModel
+        # 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) }
-        def available_balance
-        end
+        attr_reader :available_balance
 
         sig do
-          params(_: ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance)
-            .returns(ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance)
-        end
-        def available_balance=(_)
+          params(
+            available_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance, ModernTreasury::Util::AnyHash)
+          )
+            .void
         end
+        attr_writer :available_balance
 
+        # The inclusive lower bound of the effective_at timestamp for the returned
+        #   balances.
         sig { returns(T.nilable(Time)) }
-        def effective_at_lower_bound
-        end
-
-        sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
-        def effective_at_lower_bound=(_)
-        end
+        attr_accessor :effective_at_lower_bound
 
+        # The exclusive upper bound of the effective_at timestamp for the returned
+        #   balances.
         sig { returns(T.nilable(Time)) }
-        def effective_at_upper_bound
-        end
-
-        sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
-        def effective_at_upper_bound=(_)
-        end
+        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) }
-        def pending_balance
-        end
+        attr_reader :pending_balance
 
         sig do
-          params(_: ModernTreasury::Models::LedgerAccount::Balances::PendingBalance)
-            .returns(ModernTreasury::Models::LedgerAccount::Balances::PendingBalance)
-        end
-        def pending_balance=(_)
+          params(
+            pending_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PendingBalance, ModernTreasury::Util::AnyHash)
+          )
+            .void
         end
+        attr_writer :pending_balance
 
+        # The posted_balance is the sum of all posted entries.
         sig { returns(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance) }
-        def posted_balance
-        end
+        attr_reader :posted_balance
 
         sig do
-          params(_: ModernTreasury::Models::LedgerAccount::Balances::PostedBalance)
-            .returns(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance)
-        end
-        def posted_balance=(_)
+          params(
+            posted_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance, ModernTreasury::Util::AnyHash)
+          )
+            .void
         end
+        attr_writer :posted_balance
 
+        # 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.
         sig do
           params(
-            available_balance: ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance,
+            available_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance, ModernTreasury::Util::AnyHash),
             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
+            pending_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PendingBalance, ModernTreasury::Util::AnyHash),
+            posted_balance: T.any(ModernTreasury::Models::LedgerAccount::Balances::PostedBalance, ModernTreasury::Util::AnyHash)
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           available_balance:,
           effective_at_lower_bound:,
           effective_at_upper_bound:,
@@ -276,45 +228,26 @@ module ModernTreasury
 
         class AvailableBalance < ModernTreasury::BaseModel
           sig { returns(Integer) }
-          def amount
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def amount=(_)
-          end
+          attr_accessor :amount
 
           sig { returns(Integer) }
-          def credits
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def credits=(_)
-          end
+          attr_accessor :credits
 
+          # The currency of the ledger account.
           sig { returns(String) }
-          def currency
-          end
-
-          sig { params(_: String).returns(String) }
-          def currency=(_)
-          end
+          attr_accessor :currency
 
+          # The currency exponent of the ledger account.
           sig { returns(Integer) }
-          def currency_exponent
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def currency_exponent=(_)
-          end
+          attr_accessor :currency_exponent
 
           sig { returns(Integer) }
-          def debits
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def debits=(_)
-          end
+          attr_accessor :debits
 
+          # 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 do
             params(
               amount: Integer,
@@ -323,9 +256,9 @@ module ModernTreasury
               currency_exponent: Integer,
               debits: Integer
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          def self.new(amount:, credits:, currency:, currency_exponent:, debits:)
           end
 
           sig do
@@ -346,45 +279,23 @@ module ModernTreasury
 
         class PendingBalance < ModernTreasury::BaseModel
           sig { returns(Integer) }
-          def amount
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def amount=(_)
-          end
+          attr_accessor :amount
 
           sig { returns(Integer) }
-          def credits
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def credits=(_)
-          end
+          attr_accessor :credits
 
+          # The currency of the ledger account.
           sig { returns(String) }
-          def currency
-          end
-
-          sig { params(_: String).returns(String) }
-          def currency=(_)
-          end
+          attr_accessor :currency
 
+          # The currency exponent of the ledger account.
           sig { returns(Integer) }
-          def currency_exponent
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def currency_exponent=(_)
-          end
+          attr_accessor :currency_exponent
 
           sig { returns(Integer) }
-          def debits
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def debits=(_)
-          end
+          attr_accessor :debits
 
+          # The pending_balance is the sum of all pending and posted entries.
           sig do
             params(
               amount: Integer,
@@ -393,9 +304,9 @@ module ModernTreasury
               currency_exponent: Integer,
               debits: Integer
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          def self.new(amount:, credits:, currency:, currency_exponent:, debits:)
           end
 
           sig do
@@ -416,45 +327,23 @@ module ModernTreasury
 
         class PostedBalance < ModernTreasury::BaseModel
           sig { returns(Integer) }
-          def amount
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def amount=(_)
-          end
+          attr_accessor :amount
 
           sig { returns(Integer) }
-          def credits
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def credits=(_)
-          end
+          attr_accessor :credits
 
+          # The currency of the ledger account.
           sig { returns(String) }
-          def currency
-          end
-
-          sig { params(_: String).returns(String) }
-          def currency=(_)
-          end
+          attr_accessor :currency
 
+          # The currency exponent of the ledger account.
           sig { returns(Integer) }
-          def currency_exponent
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def currency_exponent=(_)
-          end
+          attr_accessor :currency_exponent
 
           sig { returns(Integer) }
-          def debits
-          end
-
-          sig { params(_: Integer).returns(Integer) }
-          def debits=(_)
-          end
+          attr_accessor :debits
 
+          # The posted_balance is the sum of all posted entries.
           sig do
             params(
               amount: Integer,
@@ -463,9 +352,9 @@ module ModernTreasury
               currency_exponent: Integer,
               debits: Integer
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          def self.new(amount:, credits:, currency:, currency_exponent:, debits:)
           end
 
           sig do
@@ -485,15 +374,25 @@ module ModernTreasury
         end
       end
 
-      class LedgerableType < ModernTreasury::Enum
-        abstract!
+      # 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.
+      module LedgerableType
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccount::LedgerableType) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol) }
 
-        COUNTERPARTY = T.let(:counterparty, T.nilable(Symbol))
-        EXTERNAL_ACCOUNT = T.let(:external_account, T.nilable(Symbol))
-        INTERNAL_ACCOUNT = T.let(:internal_account, T.nilable(Symbol))
-        VIRTUAL_ACCOUNT = T.let(:virtual_account, T.nilable(Symbol))
+        COUNTERPARTY = T.let(:counterparty, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+        EXTERNAL_ACCOUNT =
+          T.let(:external_account, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+        INTERNAL_ACCOUNT =
+          T.let(:internal_account, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
+        VIRTUAL_ACCOUNT =
+          T.let(:virtual_account, ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol)
 
-        sig { override.returns(T::Array[Symbol]) }
+        sig { override.returns(T::Array[ModernTreasury::Models::LedgerAccount::LedgerableType::TaggedSymbol]) }
         def self.values
         end
       end