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

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

@@ -1,410 +0,0 @@
-# typed: strong
-
-module ModernTreasury
-  module Models
-    class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
-      sig { returns(String) }
-      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) }
-      attr_accessor :amount
-
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # 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)) }
-      attr_accessor :discarded_at
-
-      # The currency of the ledger account.
-      sig { returns(String) }
-      attr_accessor :ledger_account_currency
-
-      # The currency exponent of the ledger account.
-      sig { returns(Integer) }
-      attr_accessor :ledger_account_currency_exponent
-
-      # The ledger account that this ledger entry is associated with.
-      sig { returns(String) }
-      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)) }
-      attr_accessor :ledger_account_lock_version
-
-      # The ledger transaction that this ledger entry is associated with.
-      sig { returns(String) }
-      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) }
-      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]) }
-      attr_accessor :metadata
-
-      sig { returns(String) }
-      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)) }
-      attr_reader :resulting_ledger_account_balances
-
-      sig do
-        params(
-          resulting_ledger_account_balances: T.nilable(
-            T.any(
-              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-        )
-          .void
-      end
-      attr_writer :resulting_ledger_account_balances
-
-      # 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) }
-      attr_accessor :updated_at
-
-      sig do
-        params(
-          id: String,
-          amount: Integer,
-          created_at: Time,
-          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
-          discarded_at: T.nilable(Time),
-          ledger_account_currency: String,
-          ledger_account_currency_exponent: Integer,
-          ledger_account_id: String,
-          ledger_account_lock_version: T.nilable(Integer),
-          ledger_transaction_id: String,
-          live_mode: T::Boolean,
-          metadata: T::Hash[Symbol, String],
-          object: String,
-          resulting_ledger_account_balances: T.nilable(
-            T.any(
-              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances,
-              ModernTreasury::Internal::AnyHash
-            )
-          ),
-          status: ModernTreasury::Models::LedgerEntry::Status::OrSymbol,
-          updated_at: Time
-        )
-          .returns(T.attached_class)
-      end
-      def self.new(
-        id:,
-        amount:,
-        created_at:,
-        direction:,
-        discarded_at:,
-        ledger_account_currency:,
-        ledger_account_currency_exponent:,
-        ledger_account_id:,
-        ledger_account_lock_version:,
-        ledger_transaction_id:,
-        live_mode:,
-        metadata:,
-        object:,
-        resulting_ledger_account_balances:,
-        status:,
-        updated_at:
-      ); end
-      sig do
-        override
-          .returns(
-            {
-              id: String,
-              amount: Integer,
-              created_at: Time,
-              direction: ModernTreasury::Models::TransactionDirection::TaggedSymbol,
-              discarded_at: T.nilable(Time),
-              ledger_account_currency: String,
-              ledger_account_currency_exponent: Integer,
-              ledger_account_id: String,
-              ledger_account_lock_version: T.nilable(Integer),
-              ledger_transaction_id: String,
-              live_mode: T::Boolean,
-              metadata: T::Hash[Symbol, String],
-              object: String,
-              resulting_ledger_account_balances: T.nilable(ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances),
-              status: ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol,
-              updated_at: Time
-            }
-          )
-      end
-      def to_hash; end
-
-      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) }
-        attr_reader :available_balance
-
-        sig do
-          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) }
-        attr_reader :pending_balance
-
-        sig do
-          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) }
-        attr_reader :posted_balance
-
-        sig do
-          params(
-            posted_balance: T.any(
-              ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance,
-              ModernTreasury::Internal::AnyHash
-            )
-          )
-            .void
-        end
-        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
-            .returns(
-              {
-                available_balance: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
-                pending_balance: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
-                posted_balance: ModernTreasury::Models::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance
-              }
-            )
-        end
-        def to_hash; end
-
-        class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
-          sig { returns(Integer) }
-          attr_accessor :amount
-
-          sig { returns(Integer) }
-          attr_accessor :credits
-
-          # The currency of the ledger account.
-          sig { returns(String) }
-          attr_accessor :currency
-
-          # The currency exponent of the ledger account.
-          sig { returns(Integer) }
-          attr_accessor :currency_exponent
-
-          sig { returns(Integer) }
-          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,
-              credits: Integer,
-              currency: String,
-              currency_exponent: Integer,
-              debits: Integer
-            )
-              .returns(T.attached_class)
-          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
-                }
-              )
-          end
-          def to_hash; end
-        end
-
-        class PendingBalance < ModernTreasury::Internal::Type::BaseModel
-          sig { returns(Integer) }
-          attr_accessor :amount
-
-          sig { returns(Integer) }
-          attr_accessor :credits
-
-          # The currency of the ledger account.
-          sig { returns(String) }
-          attr_accessor :currency
-
-          # The currency exponent of the ledger account.
-          sig { returns(Integer) }
-          attr_accessor :currency_exponent
-
-          sig { returns(Integer) }
-          attr_accessor :debits
-
-          # The pending_balance is the sum of all pending and posted entries.
-          sig do
-            params(
-              amount: Integer,
-              credits: Integer,
-              currency: String,
-              currency_exponent: Integer,
-              debits: Integer
-            )
-              .returns(T.attached_class)
-          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
-                }
-              )
-          end
-          def to_hash; end
-        end
-
-        class PostedBalance < ModernTreasury::Internal::Type::BaseModel
-          sig { returns(Integer) }
-          attr_accessor :amount
-
-          sig { returns(Integer) }
-          attr_accessor :credits
-
-          # The currency of the ledger account.
-          sig { returns(String) }
-          attr_accessor :currency
-
-          # The currency exponent of the ledger account.
-          sig { returns(Integer) }
-          attr_accessor :currency_exponent
-
-          sig { returns(Integer) }
-          attr_accessor :debits
-
-          # The posted_balance is the sum of all posted entries.
-          sig do
-            params(
-              amount: Integer,
-              credits: Integer,
-              currency: String,
-              currency_exponent: Integer,
-              debits: Integer
-            )
-              .returns(T.attached_class)
-          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
-                }
-              )
-          end
-          def to_hash; end
-        end
-      end
-
-      # 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
-
-        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntry::Status) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerEntry::Status::TaggedSymbol) }
-
-        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
-end