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

data/rbi/lib/modern_treasury/models/ledger_entry.rbi

@@ -2,144 +2,101 @@
 
 module ModernTreasury
   module Models
-    class LedgerEntry < ModernTreasury::BaseModel
+    class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
       sig { returns(String) }
-      def id
-      end
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :id
 
+      # Value in specified currency's smallest unit. e.g. $10 would be represented
+      # as 1000. Can be any integer up to 36 digits.
       sig { returns(Integer) }
-      def amount
-      end
-
-      sig { params(_: Integer).returns(Integer) }
-      def amount=(_)
-      end
+      attr_accessor :amount
 
       sig { returns(Time) }
-      def created_at
-      end
+      attr_accessor :created_at
 
-      sig { params(_: Time).returns(Time) }
-      def created_at=(_)
-      end
-
-      sig { returns(Symbol) }
-      def direction
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def direction=(_)
-      end
+      # One of `credit`, `debit`. Describes the direction money is flowing in the
+      # transaction. A `credit` moves money from your account to someone else's. A
+      # `debit` pulls money from someone else's account to your own. Note that wire,
+      # rtp, and check payments will always be `credit`.
+      sig { returns(ModernTreasury::Models::TransactionDirection::TaggedSymbol) }
+      attr_accessor :direction
 
       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 currency of the ledger account.
       sig { returns(String) }
-      def ledger_account_currency
-      end
-
-      sig { params(_: String).returns(String) }
-      def ledger_account_currency=(_)
-      end
+      attr_accessor :ledger_account_currency
 
+      # The currency exponent of the ledger account.
       sig { returns(Integer) }
-      def ledger_account_currency_exponent
-      end
-
-      sig { params(_: Integer).returns(Integer) }
-      def ledger_account_currency_exponent=(_)
-      end
+      attr_accessor :ledger_account_currency_exponent
 
+      # The ledger account that this ledger entry is associated with.
       sig { returns(String) }
-      def ledger_account_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def ledger_account_id=(_)
-      end
+      attr_accessor :ledger_account_id
 
+      # Lock version of the ledger account. This can be passed when creating a ledger
+      # transaction to only succeed if no ledger transactions have posted since the
+      # given version. See our post about Designing the Ledgers API with Optimistic
+      # Locking for more details.
       sig { returns(T.nilable(Integer)) }
-      def ledger_account_lock_version
-      end
-
-      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
-      def ledger_account_lock_version=(_)
-      end
+      attr_accessor :ledger_account_lock_version
 
+      # The ledger transaction that this ledger entry is associated with.
       sig { returns(String) }
-      def ledger_transaction_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def ledger_transaction_id=(_)
-      end
+      attr_accessor :ledger_transaction_id
 
+      # 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
 
+      # 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
 
       sig { returns(String) }
-      def object
-      end
-
-      sig { params(_: String).returns(String) }
-      def object=(_)
-      end
-
+      attr_accessor :object
+
+      # The pending, posted, and available balances for this ledger entry's 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. Please see
+      # https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
+      # details.
       sig { returns(T.nilable(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances)) }
-      def resulting_ledger_account_balances
-      end
+      attr_reader :resulting_ledger_account_balances
 
       sig do
-        params(_: T.nilable(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances))
-          .returns(T.nilable(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances))
-      end
-      def resulting_ledger_account_balances=(_)
-      end
-
-      sig { returns(Symbol) }
-      def status
+        params(
+          resulting_ledger_account_balances: T.nilable(
+            T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances,
+              ModernTreasury::Internal::AnyHash
+            )
+          )
+        )
+          .void
       end
+      attr_writer :resulting_ledger_account_balances
 
-      sig { params(_: Symbol).returns(Symbol) }
-      def status=(_)
-      end
+      # Equal to the state of the ledger transaction when the ledger entry was created.
+      # One of `pending`, `posted`, or `archived`.
+      sig { returns(ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol) }
+      attr_accessor :status
 
       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,
           amount: Integer,
           created_at: Time,
-          direction: Symbol,
+          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
           discarded_at: T.nilable(Time),
           ledger_account_currency: String,
           ledger_account_currency_exponent: Integer,
@@ -149,13 +106,18 @@ module ModernTreasury
           live_mode: T::Boolean,
           metadata: T::Hash[Symbol, String],
           object: String,
-          resulting_ledger_account_balances: T.nilable(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances),
-          status: Symbol,
+          resulting_ledger_account_balances: T.nilable(
+            T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances,
+              ModernTreasury::Internal::AnyHash
+            )
+          ),
+          status: ModernTreasury::Models::LedgerEntry::Status::OrSymbol,
           updated_at: Time
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         id:,
         amount:,
         created_at:,
@@ -172,9 +134,7 @@ module ModernTreasury
         resulting_ledger_account_balances:,
         status:,
         updated_at:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -182,7 +142,7 @@ module ModernTreasury
               id: String,
               amount: Integer,
               created_at: Time,
-              direction: Symbol,
+              direction: ModernTreasury::Models::TransactionDirection::TaggedSymbol,
               discarded_at: T.nilable(Time),
               ledger_account_currency: String,
               ledger_account_currency_exponent: Integer,
@@ -193,58 +153,87 @@ module ModernTreasury
               metadata: T::Hash[Symbol, String],
               object: String,
               resulting_ledger_account_balances: T.nilable(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances),
-              status: Symbol,
+              status: ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol,
               updated_at: Time
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
-      class ResultingLedgerAccountBalances < ModernTreasury::BaseModel
+      class ResultingLedgerAccountBalances < ModernTreasury::Internal::Type::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::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance) }
-        def available_balance
-        end
+        attr_reader :available_balance
 
         sig do
-          params(_: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance)
-            .returns(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance)
-        end
-        def available_balance=(_)
+          params(
+            available_balance: T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
+              ModernTreasury::Internal::AnyHash
+            )
+          )
+            .void
         end
+        attr_writer :available_balance
 
+        # The pending_balance is the sum of all pending and posted entries.
         sig { returns(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance) }
-        def pending_balance
-        end
+        attr_reader :pending_balance
 
         sig do
-          params(_: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance)
-            .returns(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance)
-        end
-        def pending_balance=(_)
+          params(
+            pending_balance: T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
+              ModernTreasury::Internal::AnyHash
+            )
+          )
+            .void
         end
+        attr_writer :pending_balance
 
+        # The posted_balance is the sum of all posted entries.
         sig { returns(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance) }
-        def posted_balance
-        end
-
-        sig do
-          params(_: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance)
-            .returns(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance)
-        end
-        def posted_balance=(_)
-        end
+        attr_reader :posted_balance
 
         sig do
           params(
-            available_balance: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
-            pending_balance: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
-            posted_balance: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance
+            posted_balance: T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance,
+              ModernTreasury::Internal::AnyHash
+            )
           )
             .void
         end
-        def initialize(available_balance:, pending_balance:, posted_balance:)
+        attr_writer :posted_balance
+
+        # The pending, posted, and available balances for this ledger entry's 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. Please see
+        # https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
+        # details.
+        sig do
+          params(
+            available_balance: T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
+              ModernTreasury::Internal::AnyHash
+            ),
+            pending_balance: T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
+              ModernTreasury::Internal::AnyHash
+            ),
+            posted_balance: T.any(
+              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance,
+              ModernTreasury::Internal::AnyHash
+            )
+          )
+            .returns(T.attached_class)
         end
+        def self.new(available_balance:, pending_balance:, posted_balance:); end
 
         sig do
           override
@@ -256,50 +245,30 @@ module ModernTreasury
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
 
-        class AvailableBalance < ModernTreasury::BaseModel
+        class AvailableBalance < ModernTreasury::Internal::Type::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,
@@ -308,10 +277,9 @@ module ModernTreasury
               currency_exponent: Integer,
               debits: Integer
             )
-              .void
-          end
-          def initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+              .returns(T.attached_class)
           end
+          def self.new(amount:, credits:, currency:, currency_exponent:, debits:); end
 
           sig do
             override
@@ -325,51 +293,28 @@ module ModernTreasury
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
         end
 
-        class PendingBalance < ModernTreasury::BaseModel
+        class PendingBalance < ModernTreasury::Internal::Type::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,
@@ -378,10 +323,9 @@ module ModernTreasury
               currency_exponent: Integer,
               debits: Integer
             )
-              .void
-          end
-          def initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+              .returns(T.attached_class)
           end
+          def self.new(amount:, credits:, currency:, currency_exponent:, debits:); end
 
           sig do
             override
@@ -395,51 +339,28 @@ module ModernTreasury
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
         end
 
-        class PostedBalance < ModernTreasury::BaseModel
+        class PostedBalance < ModernTreasury::Internal::Type::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,
@@ -448,10 +369,9 @@ module ModernTreasury
               currency_exponent: Integer,
               debits: Integer
             )
-              .void
-          end
-          def initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+              .returns(T.attached_class)
           end
+          def self.new(amount:, credits:, currency:, currency_exponent:, debits:); end
 
           sig do
             override
@@ -465,21 +385,25 @@ module ModernTreasury
                 }
               )
           end
-          def to_hash
-          end
+          def to_hash; end
         end
       end
 
-      class Status < ModernTreasury::Enum
-        abstract!
+      # Equal to the state of the ledger transaction when the ledger entry was created.
+      # One of `pending`, `posted`, or `archived`.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
 
-        ARCHIVED = :archived
-        PENDING = :pending
-        POSTED = :posted
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntry::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol) }
 
-        sig { override.returns(T::Array[Symbol]) }
-        def self.values
-        end
+        ARCHIVED = T.let(:archived, ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol)
+        PENDING = T.let(:pending, ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol)
+        POSTED = T.let(:posted, ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol]) }
+        def self.values; end
       end
     end
   end