modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/rbi/modern_treasury/models/ledger_entry_list_params.rbi

@@ -155,17 +155,31 @@ module ModernTreasury
       attr_writer :show_deleted
 
       # Get all ledger entries that match the status specified. One of `pending`,
-      # `posted`, or `archived`.
+      # `posted`, or `archived`. For multiple statuses, use
+      # `status[]=pending&status[]=posted`.
       sig do
         returns(
-          T.nilable(ModernTreasury::LedgerEntryListParams::Status::OrSymbol)
+          T.nilable(
+            T.any(
+              ModernTreasury::LedgerEntryListParams::Status::OrSymbol,
+              T::Array[
+                ModernTreasury::LedgerEntryListParams::Status::UnionMember1::OrSymbol
+              ]
+            )
+          )
         )
       end
       attr_reader :status
 
       sig do
         params(
-          status: ModernTreasury::LedgerEntryListParams::Status::OrSymbol
+          status:
+            T.any(
+              ModernTreasury::LedgerEntryListParams::Status::OrSymbol,
+              T::Array[
+                ModernTreasury::LedgerEntryListParams::Status::UnionMember1::OrSymbol
+              ]
+            )
         ).void
       end
       attr_writer :status
@@ -199,7 +213,13 @@ module ModernTreasury
           per_page: Integer,
           show_balances: T::Boolean,
           show_deleted: T::Boolean,
-          status: ModernTreasury::LedgerEntryListParams::Status::OrSymbol,
+          status:
+            T.any(
+              ModernTreasury::LedgerEntryListParams::Status::OrSymbol,
+              T::Array[
+                ModernTreasury::LedgerEntryListParams::Status::UnionMember1::OrSymbol
+              ]
+            ),
           updated_at: T::Hash[Symbol, Time],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -253,7 +273,8 @@ module ModernTreasury
         # deleted.
         show_deleted: nil,
         # Get all ledger entries that match the status specified. One of `pending`,
-        # `posted`, or `archived`.
+        # `posted`, or `archived`. For multiple statuses, use
+        # `status[]=pending&status[]=posted`.
         status: nil,
         # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
         # posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
@@ -284,7 +305,13 @@ module ModernTreasury
             per_page: Integer,
             show_balances: T::Boolean,
             show_deleted: T::Boolean,
-            status: ModernTreasury::LedgerEntryListParams::Status::OrSymbol,
+            status:
+              T.any(
+                ModernTreasury::LedgerEntryListParams::Status::OrSymbol,
+                T::Array[
+                  ModernTreasury::LedgerEntryListParams::Status::UnionMember1::OrSymbol
+                ]
+              ),
             updated_at: T::Hash[Symbol, Time],
             request_options: ModernTreasury::RequestOptions
           }
@@ -433,9 +460,67 @@ module ModernTreasury
       end
 
       # Get all ledger entries that match the status specified. One of `pending`,
-      # `posted`, or `archived`.
+      # `posted`, or `archived`. For multiple statuses, use
+      # `status[]=pending&status[]=posted`.
       module Status
-        extend ModernTreasury::Internal::Type::Enum
+        extend ModernTreasury::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              ModernTreasury::LedgerEntryListParams::Status::TaggedSymbol,
+              T::Array[
+                ModernTreasury::LedgerEntryListParams::Status::UnionMember1::TaggedSymbol
+              ]
+            )
+          end
+
+        module UnionMember1
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModernTreasury::LedgerEntryListParams::Status::UnionMember1
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              ModernTreasury::LedgerEntryListParams::Status::UnionMember1::TaggedSymbol
+            )
+          POSTED =
+            T.let(
+              :posted,
+              ModernTreasury::LedgerEntryListParams::Status::UnionMember1::TaggedSymbol
+            )
+          ARCHIVED =
+            T.let(
+              :archived,
+              ModernTreasury::LedgerEntryListParams::Status::UnionMember1::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::LedgerEntryListParams::Status::UnionMember1::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::LedgerEntryListParams::Status::Variants]
+          )
+        end
+        def self.variants
+        end
 
         TaggedSymbol =
           T.type_alias do
@@ -459,15 +544,13 @@ module ModernTreasury
             ModernTreasury::LedgerEntryListParams::Status::TaggedSymbol
           )
 
-        sig do
-          override.returns(
-            T::Array[
-              ModernTreasury::LedgerEntryListParams::Status::TaggedSymbol
-            ]
+        UnionMember1Array =
+          T.let(
+            ModernTreasury::Internal::Type::ArrayOf[
+              enum: ModernTreasury::LedgerEntryListParams::Status::UnionMember1
+            ],
+            ModernTreasury::Internal::Type::Converter
           )
-        end
-        def self.values
-        end
       end
     end
   end

data/rbi/modern_treasury/models/ledger_transaction.rbi

@@ -14,6 +14,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
 
@@ -51,8 +58,7 @@ module ModernTreasury
 
       # If the ledger transaction can be reconciled to another object in Modern
       # Treasury, the type will be populated here, otherwise null. This can be one of
-      # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      # reversal.
+      # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
       sig do
         returns(
           T.nilable(
@@ -102,6 +108,7 @@ module ModernTreasury
       sig do
         params(
           id: String,
+          archived_reason: T.nilable(String),
           created_at: Time,
           description: T.nilable(String),
           effective_at: Time,
@@ -127,6 +134,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:,
@@ -148,8 +160,7 @@ module ModernTreasury
         ledgerable_id:,
         # If the ledger transaction can be reconciled to another object in Modern
         # Treasury, the type will be populated here, otherwise null. This can be one of
-        # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-        # reversal.
+        # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
         ledgerable_type:,
         # This field will be true if this object exists in the live environment or false
         # if it exists in the test environment.
@@ -177,6 +188,7 @@ module ModernTreasury
         override.returns(
           {
             id: String,
+            archived_reason: T.nilable(String),
             created_at: Time,
             description: T.nilable(String),
             effective_at: Time,
@@ -206,8 +218,7 @@ module ModernTreasury
 
       # If the ledger transaction can be reconciled to another object in Modern
       # Treasury, the type will be populated here, otherwise null. This can be one of
-      # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      # reversal.
+      # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
       module LedgerableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -227,11 +238,6 @@ module ModernTreasury
             :incoming_payment_detail,
             ModernTreasury::LedgerTransaction::LedgerableType::TaggedSymbol
           )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::LedgerTransaction::LedgerableType::TaggedSymbol
-          )
         PAYMENT_ORDER =
           T.let(
             :payment_order,

data/rbi/modern_treasury/models/ledger_transaction_create_params.rbi

@@ -2,7 +2,7 @@
 
 module ModernTreasury
   module Models
-    class LedgerTransactionCreateParams < ModernTreasury::Internal::Type::BaseModel
+    class LedgerTransactionCreateParams < ModernTreasury::Models::LedgerTransactionCreateRequest
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
@@ -14,397 +14,19 @@ module ModernTreasury
           )
         end
 
-      # An array of ledger entry objects.
       sig do
-        returns(
-          T::Array[ModernTreasury::LedgerTransactionCreateParams::LedgerEntry]
+        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+          T.attached_class
         )
       end
-      attr_accessor :ledger_entries
-
-      # An optional description for internal use.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :description
-
-      # The timestamp (ISO8601 format) at which the ledger transaction happened for
-      # reporting purposes.
-      sig { returns(T.nilable(Time)) }
-      attr_reader :effective_at
-
-      sig { params(effective_at: Time).void }
-      attr_writer :effective_at
-
-      # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-      # purposes.
-      sig { returns(T.nilable(Date)) }
-      attr_reader :effective_date
-
-      sig { params(effective_date: Date).void }
-      attr_writer :effective_date
-
-      # A unique string to represent the ledger transaction. Only one pending or posted
-      # ledger transaction may have this ID in the ledger.
-      sig { returns(T.nilable(String)) }
-      attr_reader :external_id
-
-      sig { params(external_id: String).void }
-      attr_writer :external_id
-
-      # If the ledger transaction can be reconciled to another object in Modern
-      # Treasury, the id will be populated here, otherwise null.
-      sig { returns(T.nilable(String)) }
-      attr_reader :ledgerable_id
-
-      sig { params(ledgerable_id: String).void }
-      attr_writer :ledgerable_id
-
-      # If the ledger transaction can be reconciled to another object in Modern
-      # Treasury, the type will be populated here, otherwise null. This can be one of
-      # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      # reversal.
-      sig do
-        returns(
-          T.nilable(
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::OrSymbol
-          )
-        )
-      end
-      attr_reader :ledgerable_type
-
-      sig do
-        params(
-          ledgerable_type:
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::OrSymbol
-        ).void
-      end
-      attr_writer :ledgerable_type
-
-      # 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
-
-      # To post a ledger transaction at creation, use `posted`.
-      sig do
-        returns(
-          T.nilable(
-            ModernTreasury::LedgerTransactionCreateParams::Status::OrSymbol
-          )
-        )
-      end
-      attr_reader :status
-
-      sig do
-        params(
-          status:
-            ModernTreasury::LedgerTransactionCreateParams::Status::OrSymbol
-        ).void
+      def self.new(request_options: {})
       end
-      attr_writer :status
 
       sig do
-        params(
-          ledger_entries:
-            T::Array[
-              ModernTreasury::LedgerTransactionCreateParams::LedgerEntry::OrHash
-            ],
-          description: T.nilable(String),
-          effective_at: Time,
-          effective_date: Date,
-          external_id: String,
-          ledgerable_id: String,
-          ledgerable_type:
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::OrSymbol,
-          metadata: T::Hash[Symbol, String],
-          status:
-            ModernTreasury::LedgerTransactionCreateParams::Status::OrSymbol,
-          request_options: ModernTreasury::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # An array of ledger entry objects.
-        ledger_entries:,
-        # An optional description for internal use.
-        description: nil,
-        # The timestamp (ISO8601 format) at which the ledger transaction happened for
-        # reporting purposes.
-        effective_at: nil,
-        # The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-        # purposes.
-        effective_date: nil,
-        # A unique string to represent the ledger transaction. Only one pending or posted
-        # ledger transaction may have this ID in the ledger.
-        external_id: nil,
-        # If the ledger transaction can be reconciled to another object in Modern
-        # Treasury, the id will be populated here, otherwise null.
-        ledgerable_id: nil,
-        # If the ledger transaction can be reconciled to another object in Modern
-        # Treasury, the type will be populated here, otherwise null. This can be one of
-        # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-        # reversal.
-        ledgerable_type: nil,
-        # Additional data represented as key-value pairs. Both the key and value must be
-        # strings.
-        metadata: nil,
-        # To post a ledger transaction at creation, use `posted`.
-        status: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            ledger_entries:
-              T::Array[
-                ModernTreasury::LedgerTransactionCreateParams::LedgerEntry
-              ],
-            description: T.nilable(String),
-            effective_at: Time,
-            effective_date: Date,
-            external_id: String,
-            ledgerable_id: String,
-            ledgerable_type:
-              ModernTreasury::LedgerTransactionCreateParams::LedgerableType::OrSymbol,
-            metadata: T::Hash[Symbol, String],
-            status:
-              ModernTreasury::LedgerTransactionCreateParams::Status::OrSymbol,
-            request_options: ModernTreasury::RequestOptions
-          }
-        )
+        override.returns({ request_options: ModernTreasury::RequestOptions })
       end
       def to_hash
       end
-
-      class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::LedgerTransactionCreateParams::LedgerEntry,
-              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
-
-      # If the ledger transaction can be reconciled to another object in Modern
-      # Treasury, the type will be populated here, otherwise null. This can be one of
-      # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      # reversal.
-      module LedgerableType
-        extend ModernTreasury::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              ModernTreasury::LedgerTransactionCreateParams::LedgerableType
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        EXPECTED_PAYMENT =
-          T.let(
-            :expected_payment,
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-          )
-        INCOMING_PAYMENT_DETAIL =
-          T.let(
-            :incoming_payment_detail,
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-          )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-          )
-        PAYMENT_ORDER =
-          T.let(
-            :payment_order,
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-          )
-        RETURN =
-          T.let(
-            :return,
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-          )
-        REVERSAL =
-          T.let(
-            :reversal,
-            ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              ModernTreasury::LedgerTransactionCreateParams::LedgerableType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      # To post a ledger transaction at creation, use `posted`.
-      module Status
-        extend ModernTreasury::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, ModernTreasury::LedgerTransactionCreateParams::Status)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ARCHIVED =
-          T.let(
-            :archived,
-            ModernTreasury::LedgerTransactionCreateParams::Status::TaggedSymbol
-          )
-        PENDING =
-          T.let(
-            :pending,
-            ModernTreasury::LedgerTransactionCreateParams::Status::TaggedSymbol
-          )
-        POSTED =
-          T.let(
-            :posted,
-            ModernTreasury::LedgerTransactionCreateParams::Status::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              ModernTreasury::LedgerTransactionCreateParams::Status::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end