modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/rbi/modern_treasury/models/ledger_balance.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerBalance < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerBalance,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      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
+
+      sig do
+        params(
+          amount: Integer,
+          credits: Integer,
+          currency: String,
+          currency_exponent: Integer,
+          debits: Integer
+        ).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
+
+      sig do
+        override.returns(
+          {
+            amount: Integer,
+            credits: Integer,
+            currency: String,
+            currency_exponent: Integer,
+            debits: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/ledger_balances.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerBalances < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerBalances,
+            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::LedgerBalance) }
+      attr_reader :available_balance
+
+      sig do
+        params(available_balance: ModernTreasury::LedgerBalance::OrHash).void
+      end
+      attr_writer :available_balance
+
+      # The pending_balance is the sum of all pending and posted entries.
+      sig { returns(ModernTreasury::LedgerBalance) }
+      attr_reader :pending_balance
+
+      sig do
+        params(pending_balance: ModernTreasury::LedgerBalance::OrHash).void
+      end
+      attr_writer :pending_balance
+
+      # The posted_balance is the sum of all posted entries.
+      sig { returns(ModernTreasury::LedgerBalance) }
+      attr_reader :posted_balance
+
+      sig { params(posted_balance: ModernTreasury::LedgerBalance::OrHash).void }
+      attr_writer :posted_balance
+
+      sig do
+        params(
+          available_balance: ModernTreasury::LedgerBalance::OrHash,
+          pending_balance: ModernTreasury::LedgerBalance::OrHash,
+          posted_balance: ModernTreasury::LedgerBalance::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
+
+      sig do
+        override.returns(
+          {
+            available_balance: ModernTreasury::LedgerBalance,
+            pending_balance: ModernTreasury::LedgerBalance,
+            posted_balance: ModernTreasury::LedgerBalance
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/ledger_entry.rbi

@@ -72,19 +72,13 @@ module ModernTreasury
       # and posted outgoing amounts. Please see
       # https://docs.moderntreasury.com/docs/transaction-status-and-balances for more
       # details.
-      sig do
-        returns(
-          T.nilable(ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances)
-        )
-      end
+      sig { returns(T.nilable(ModernTreasury::LedgerBalances)) }
       attr_reader :resulting_ledger_account_balances
 
       sig do
         params(
           resulting_ledger_account_balances:
-            T.nilable(
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::OrHash
-            )
+            T.nilable(ModernTreasury::LedgerBalances::OrHash)
         ).void
       end
       attr_writer :resulting_ledger_account_balances
@@ -113,9 +107,7 @@ module ModernTreasury
           metadata: T::Hash[Symbol, String],
           object: String,
           resulting_ledger_account_balances:
-            T.nilable(
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::OrHash
-            ),
+            T.nilable(ModernTreasury::LedgerBalances::OrHash),
           status: ModernTreasury::LedgerEntry::Status::OrSymbol,
           updated_at: Time
         ).returns(T.attached_class)
@@ -184,9 +176,7 @@ module ModernTreasury
             metadata: T::Hash[Symbol, String],
             object: String,
             resulting_ledger_account_balances:
-              T.nilable(
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances
-              ),
+              T.nilable(ModernTreasury::LedgerBalances),
             status: ModernTreasury::LedgerEntry::Status::TaggedSymbol,
             updated_at: Time
           }
@@ -195,301 +185,6 @@ module ModernTreasury
       def to_hash
       end
 
-      class ResultingLedgerAccountBalances < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances,
-              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 do
-          returns(
-            ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance
-          )
-        end
-        attr_reader :available_balance
-
-        sig do
-          params(
-            available_balance:
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance::OrHash
-          ).void
-        end
-        attr_writer :available_balance
-
-        # The pending_balance is the sum of all pending and posted entries.
-        sig do
-          returns(
-            ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance
-          )
-        end
-        attr_reader :pending_balance
-
-        sig do
-          params(
-            pending_balance:
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance::OrHash
-          ).void
-        end
-        attr_writer :pending_balance
-
-        # The posted_balance is the sum of all posted entries.
-        sig do
-          returns(
-            ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance
-          )
-        end
-        attr_reader :posted_balance
-
-        sig do
-          params(
-            posted_balance:
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance::OrHash
-          ).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:
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance::OrHash,
-            pending_balance:
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance::OrHash,
-            posted_balance:
-              ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::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
-
-        sig do
-          override.returns(
-            {
-              available_balance:
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
-              pending_balance:
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
-              posted_balance:
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
-                ModernTreasury::Internal::AnyHash
-              )
-            end
-
-          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:,
-            # The currency of the ledger account.
-            currency:,
-            # The currency exponent of the ledger account.
-            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
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
-                ModernTreasury::Internal::AnyHash
-              )
-            end
-
-          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:,
-            # The currency of the ledger account.
-            currency:,
-            # The currency exponent of the ledger account.
-            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
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance,
-                ModernTreasury::Internal::AnyHash
-              )
-            end
-
-          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:,
-            # The currency of the ledger account.
-            currency:,
-            # The currency exponent of the ledger account.
-            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

data/rbi/modern_treasury/models/ledger_entry_create_request.rbi

@@ -0,0 +1,137 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerEntryCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerEntryCreateRequest,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # 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
+
+      # 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::TransactionDirection::OrSymbol) }
+      attr_accessor :direction
+
+      # The ledger account that this ledger entry is associated with.
+      sig { returns(String) }
+      attr_accessor :ledger_account_id
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+      # account’s available balance. If any of these conditions would be false after the
+      # transaction is created, the entire call will fail with error code 422.
+      sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
+      attr_accessor :available_balance_amount
+
+      # 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 :lock_version
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      # strings.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+      # account’s pending balance. If any of these conditions would be false after the
+      # transaction is created, the entire call will fail with error code 422.
+      sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
+      attr_accessor :pending_balance_amount
+
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+      # account’s posted balance. If any of these conditions would be false after the
+      # transaction is created, the entire call will fail with error code 422.
+      sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
+      attr_accessor :posted_balance_amount
+
+      # If true, response will include the balance of the associated ledger account for
+      # the entry.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :show_resulting_ledger_account_balances
+
+      sig do
+        params(
+          amount: Integer,
+          direction: ModernTreasury::TransactionDirection::OrSymbol,
+          ledger_account_id: String,
+          available_balance_amount: T.nilable(T::Hash[Symbol, Integer]),
+          lock_version: T.nilable(Integer),
+          metadata: T::Hash[Symbol, String],
+          pending_balance_amount: T.nilable(T::Hash[Symbol, Integer]),
+          posted_balance_amount: T.nilable(T::Hash[Symbol, Integer]),
+          show_resulting_ledger_account_balances: T.nilable(T::Boolean)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Value in specified currency's smallest unit. e.g. $10 would be represented
+        # as 1000. Can be any integer up to 36 digits.
+        amount:,
+        # 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`.
+        direction:,
+        # The ledger account that this ledger entry is associated with.
+        ledger_account_id:,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        # account’s available balance. If any of these conditions would be false after the
+        # transaction is created, the entire call will fail with error code 422.
+        available_balance_amount: nil,
+        # 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.
+        lock_version: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
+        metadata: nil,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        # account’s pending balance. If any of these conditions would be false after the
+        # transaction is created, the entire call will fail with error code 422.
+        pending_balance_amount: nil,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
+        # account’s posted balance. If any of these conditions would be false after the
+        # transaction is created, the entire call will fail with error code 422.
+        posted_balance_amount: nil,
+        # If true, response will include the balance of the associated ledger account for
+        # the entry.
+        show_resulting_ledger_account_balances: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            amount: Integer,
+            direction: ModernTreasury::TransactionDirection::OrSymbol,
+            ledger_account_id: String,
+            available_balance_amount: T.nilable(T::Hash[Symbol, Integer]),
+            lock_version: T.nilable(Integer),
+            metadata: T::Hash[Symbol, String],
+            pending_balance_amount: T.nilable(T::Hash[Symbol, Integer]),
+            posted_balance_amount: T.nilable(T::Hash[Symbol, Integer]),
+            show_resulting_ledger_account_balances: T.nilable(T::Boolean)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end