modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/rbi/modern_treasury/models/ledger_transactions/ledger_transaction_version.rbi

@@ -17,6 +17,13 @@ module ModernTreasury
         sig { returns(String) }
         attr_accessor :id
 
+        # System-set reason why the ledger transaction was archived; currently only
+        # 'balance_lock_failure' for transactions that violated balance constraints. Only
+        # populated when archive_on_balance_lock_failure is true and a balance lock
+        # violation occurs, otherwise null.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :archived_reason
+
         sig { returns(Time) }
         attr_accessor :created_at
 
@@ -120,6 +127,7 @@ module ModernTreasury
         sig do
           params(
             id: String,
+            archived_reason: T.nilable(String),
             created_at: Time,
             description: T.nilable(String),
             effective_at: Time,
@@ -150,6 +158,11 @@ module ModernTreasury
         end
         def self.new(
           id:,
+          # System-set reason why the ledger transaction was archived; currently only
+          # 'balance_lock_failure' for transactions that violated balance constraints. Only
+          # populated when archive_on_balance_lock_failure is true and a balance lock
+          # violation occurs, otherwise null.
+          archived_reason:,
           created_at:,
           # An optional description for internal use.
           description:,
@@ -203,6 +216,7 @@ module ModernTreasury
           override.returns(
             {
               id: String,
+              archived_reason: T.nilable(String),
               created_at: Time,
               description: T.nilable(String),
               effective_at: Time,
@@ -305,21 +319,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::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::OrHash
-                )
+                T.nilable(ModernTreasury::LedgerBalances::OrHash)
             ).void
           end
           attr_writer :resulting_ledger_account_balances
@@ -348,9 +354,7 @@ module ModernTreasury
               metadata: T::Hash[Symbol, String],
               object: String,
               resulting_ledger_account_balances:
-                T.nilable(
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::OrHash
-                ),
+                T.nilable(ModernTreasury::LedgerBalances::OrHash),
               status:
                 ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status::OrSymbol
             ).returns(T.attached_class)
@@ -416,9 +420,7 @@ module ModernTreasury
                 metadata: T::Hash[Symbol, String],
                 object: String,
                 resulting_ledger_account_balances:
-                  T.nilable(
-                    ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances
-                  ),
+                  T.nilable(ModernTreasury::LedgerBalances),
                 status:
                   ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status::TaggedSymbol
               }
@@ -427,301 +429,6 @@ module ModernTreasury
           def to_hash
           end
 
-          class ResultingLedgerAccountBalances < ModernTreasury::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance
-              )
-            end
-            attr_reader :available_balance
-
-            sig do
-              params(
-                available_balance:
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance
-              )
-            end
-            attr_reader :pending_balance
-
-            sig do
-              params(
-                pending_balance:
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance::OrHash
-              ).void
-            end
-            attr_writer :pending_balance
-
-            # The posted_balance is the sum of all posted entries.
-            sig do
-              returns(
-                ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance
-              )
-            end
-            attr_reader :posted_balance
-
-            sig do
-              params(
-                posted_balance:
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance::OrHash,
-                pending_balance:
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance::OrHash,
-                posted_balance:
-                  ModernTreasury::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::AvailableBalance,
-                  pending_balance:
-                    ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PendingBalance,
-                  posted_balance:
-                    ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::ResultingLedgerAccountBalances::PostedBalance
-                }
-              )
-            end
-            def to_hash
-            end
-
-            class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    ModernTreasury::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::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::LedgerTransactions::LedgerTransactionVersion::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
@@ -789,11 +496,6 @@ module ModernTreasury
               :incoming_payment_detail,
               ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerableType::TaggedSymbol
             )
-          PAPER_ITEM =
-            T.let(
-              :paper_item,
-              ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerableType::TaggedSymbol
-            )
           PAYMENT_ORDER =
             T.let(
               :payment_order,

data/rbi/modern_treasury/models/legal_entity_address_create_request.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LegalEntityAddressCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LegalEntityAddressCreateRequest,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # Country code conforms to [ISO 3166-1 alpha-2]
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :line1
+
+      # Locality or City.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :locality
+
+      # The postal code of the address.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :postal_code
+
+      # Region or State.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :region
+
+      # The types of this address.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              ModernTreasury::LegalEntityAddressCreateRequest::AddressType::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :address_types
+
+      sig do
+        params(
+          address_types:
+            T::Array[
+              ModernTreasury::LegalEntityAddressCreateRequest::AddressType::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :address_types
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :line2
+
+      sig do
+        params(
+          country: T.nilable(String),
+          line1: T.nilable(String),
+          locality: T.nilable(String),
+          postal_code: T.nilable(String),
+          region: T.nilable(String),
+          address_types:
+            T::Array[
+              ModernTreasury::LegalEntityAddressCreateRequest::AddressType::OrSymbol
+            ],
+          line2: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Country code conforms to [ISO 3166-1 alpha-2]
+        country:,
+        line1:,
+        # Locality or City.
+        locality:,
+        # The postal code of the address.
+        postal_code:,
+        # Region or State.
+        region:,
+        # The types of this address.
+        address_types: nil,
+        line2: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            country: T.nilable(String),
+            line1: T.nilable(String),
+            locality: T.nilable(String),
+            postal_code: T.nilable(String),
+            region: T.nilable(String),
+            address_types:
+              T::Array[
+                ModernTreasury::LegalEntityAddressCreateRequest::AddressType::OrSymbol
+              ],
+            line2: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module AddressType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::LegalEntityAddressCreateRequest::AddressType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BUSINESS =
+          T.let(
+            :business,
+            ModernTreasury::LegalEntityAddressCreateRequest::AddressType::TaggedSymbol
+          )
+        MAILING =
+          T.let(
+            :mailing,
+            ModernTreasury::LegalEntityAddressCreateRequest::AddressType::TaggedSymbol
+          )
+        OTHER =
+          T.let(
+            :other,
+            ModernTreasury::LegalEntityAddressCreateRequest::AddressType::TaggedSymbol
+          )
+        PO_BOX =
+          T.let(
+            :po_box,
+            ModernTreasury::LegalEntityAddressCreateRequest::AddressType::TaggedSymbol
+          )
+        RESIDENTIAL =
+          T.let(
+            :residential,
+            ModernTreasury::LegalEntityAddressCreateRequest::AddressType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LegalEntityAddressCreateRequest::AddressType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/legal_entity_association.rbi

@@ -1086,6 +1086,11 @@ module ModernTreasury
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        AUTHORIZED_SIGNER =
+          T.let(
+            :authorized_signer,
+            ModernTreasury::LegalEntityAssociation::RelationshipType::TaggedSymbol
+          )
         BENEFICIAL_OWNER =
           T.let(
             :beneficial_owner,