modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/rbi/modern_treasury/models/ledger_transaction_create_request.rbi

@@ -0,0 +1,258 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerTransactionCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerTransactionCreateRequest,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # An array of ledger entry objects.
+      sig { returns(T::Array[ModernTreasury::LedgerEntryCreateRequest]) }
+      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, or reversal.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::OrSymbol
+          )
+        )
+      end
+      attr_reader :ledgerable_type
+
+      sig do
+        params(
+          ledgerable_type:
+            ModernTreasury::LedgerTransactionCreateRequest::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::LedgerTransactionCreateRequest::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            ModernTreasury::LedgerTransactionCreateRequest::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          ledger_entries:
+            T::Array[ModernTreasury::LedgerEntryCreateRequest::OrHash],
+          description: T.nilable(String),
+          effective_at: Time,
+          effective_date: Date,
+          external_id: String,
+          ledgerable_id: String,
+          ledgerable_type:
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::OrSymbol,
+          metadata: T::Hash[Symbol, String],
+          status:
+            ModernTreasury::LedgerTransactionCreateRequest::Status::OrSymbol
+        ).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, 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            ledger_entries: T::Array[ModernTreasury::LedgerEntryCreateRequest],
+            description: T.nilable(String),
+            effective_at: Time,
+            effective_date: Date,
+            external_id: String,
+            ledgerable_id: String,
+            ledgerable_type:
+              ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::OrSymbol,
+            metadata: T::Hash[Symbol, String],
+            status:
+              ModernTreasury::LedgerTransactionCreateRequest::Status::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      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, or reversal.
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::LedgerTransactionCreateRequest::LedgerableType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPECTED_PAYMENT =
+          T.let(
+            :expected_payment,
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::TaggedSymbol
+          )
+        INCOMING_PAYMENT_DETAIL =
+          T.let(
+            :incoming_payment_detail,
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::TaggedSymbol
+          )
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::TaggedSymbol
+          )
+        RETURN =
+          T.let(
+            :return,
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::TaggedSymbol
+          )
+        REVERSAL =
+          T.let(
+            :reversal,
+            ModernTreasury::LedgerTransactionCreateRequest::LedgerableType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerTransactionCreateRequest::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::LedgerTransactionCreateRequest::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ARCHIVED =
+          T.let(
+            :archived,
+            ModernTreasury::LedgerTransactionCreateRequest::Status::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            ModernTreasury::LedgerTransactionCreateRequest::Status::TaggedSymbol
+          )
+        POSTED =
+          T.let(
+            :posted,
+            ModernTreasury::LedgerTransactionCreateRequest::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerTransactionCreateRequest::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/ledger_transaction_create_reversal_params.rbi

@@ -172,11 +172,6 @@ module ModernTreasury
             :incoming_payment_detail,
             ModernTreasury::LedgerTransactionCreateReversalParams::LedgerableType::TaggedSymbol
           )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::LedgerTransactionCreateReversalParams::LedgerableType::TaggedSymbol
-          )
         PAYMENT_ORDER =
           T.let(
             :payment_order,

data/rbi/modern_treasury/models/ledger_transaction_list_params.rbi

@@ -150,7 +150,12 @@ module ModernTreasury
       sig do
         returns(
           T.nilable(
-            ModernTreasury::LedgerTransactionListParams::Status::OrSymbol
+            T.any(
+              ModernTreasury::LedgerTransactionListParams::Status::OrSymbol,
+              T::Array[
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::OrSymbol
+              ]
+            )
           )
         )
       end
@@ -158,7 +163,13 @@ module ModernTreasury
 
       sig do
         params(
-          status: ModernTreasury::LedgerTransactionListParams::Status::OrSymbol
+          status:
+            T.any(
+              ModernTreasury::LedgerTransactionListParams::Status::OrSymbol,
+              T::Array[
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::OrSymbol
+              ]
+            )
         ).void
       end
       attr_writer :status
@@ -193,7 +204,13 @@ module ModernTreasury
           per_page: Integer,
           posted_at: T::Hash[Symbol, Time],
           reverses_ledger_transaction_id: String,
-          status: ModernTreasury::LedgerTransactionListParams::Status::OrSymbol,
+          status:
+            T.any(
+              ModernTreasury::LedgerTransactionListParams::Status::OrSymbol,
+              T::Array[
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::OrSymbol
+              ]
+            ),
           updated_at: T::Hash[Symbol, Time],
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -264,7 +281,12 @@ module ModernTreasury
             posted_at: T::Hash[Symbol, Time],
             reverses_ledger_transaction_id: String,
             status:
-              ModernTreasury::LedgerTransactionListParams::Status::OrSymbol,
+              T.any(
+                ModernTreasury::LedgerTransactionListParams::Status::OrSymbol,
+                T::Array[
+                  ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::OrSymbol
+                ]
+              ),
             updated_at: T::Hash[Symbol, Time],
             request_options: ModernTreasury::RequestOptions
           }
@@ -295,11 +317,6 @@ module ModernTreasury
             :incoming_payment_detail,
             ModernTreasury::LedgerTransactionListParams::LedgerableType::TaggedSymbol
           )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::LedgerTransactionListParams::LedgerableType::TaggedSymbol
-          )
         PAYMENT_ORDER =
           T.let(
             :payment_order,
@@ -467,7 +484,66 @@ module ModernTreasury
       end
 
       module Status
-        extend ModernTreasury::Internal::Type::Enum
+        extend ModernTreasury::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              ModernTreasury::LedgerTransactionListParams::Status::TaggedSymbol,
+              T::Array[
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::TaggedSymbol
+              ]
+            )
+          end
+
+        module UnionMember1
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::TaggedSymbol
+            )
+          POSTED =
+            T.let(
+              :posted,
+              ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::TaggedSymbol
+            )
+          ARCHIVED =
+            T.let(
+              :archived,
+              ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerTransactionListParams::Status::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
 
         TaggedSymbol =
           T.type_alias do
@@ -491,15 +567,14 @@ module ModernTreasury
             ModernTreasury::LedgerTransactionListParams::Status::TaggedSymbol
           )
 
-        sig do
-          override.returns(
-            T::Array[
-              ModernTreasury::LedgerTransactionListParams::Status::TaggedSymbol
-            ]
+        UnionMember1Array =
+          T.let(
+            ModernTreasury::Internal::Type::ArrayOf[
+              enum:
+                ModernTreasury::LedgerTransactionListParams::Status::UnionMember1
+            ],
+            ModernTreasury::Internal::Type::Converter
           )
-        end
-        def self.values
-        end
       end
     end
   end

data/rbi/modern_treasury/models/ledger_transaction_update_params.rbi

@@ -28,20 +28,14 @@ module ModernTreasury
 
       # An array of ledger entry objects.
       sig do
-        returns(
-          T.nilable(
-            T::Array[ModernTreasury::LedgerTransactionUpdateParams::LedgerEntry]
-          )
-        )
+        returns(T.nilable(T::Array[ModernTreasury::LedgerEntryCreateRequest]))
       end
       attr_reader :ledger_entries
 
       sig do
         params(
           ledger_entries:
-            T::Array[
-              ModernTreasury::LedgerTransactionUpdateParams::LedgerEntry::OrHash
-            ]
+            T::Array[ModernTreasury::LedgerEntryCreateRequest::OrHash]
         ).void
       end
       attr_writer :ledger_entries
@@ -56,8 +50,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(
@@ -106,9 +99,7 @@ module ModernTreasury
           description: T.nilable(String),
           effective_at: Time,
           ledger_entries:
-            T::Array[
-              ModernTreasury::LedgerTransactionUpdateParams::LedgerEntry::OrHash
-            ],
+            T::Array[ModernTreasury::LedgerEntryCreateRequest::OrHash],
           ledgerable_id: String,
           ledgerable_type:
             ModernTreasury::LedgerTransactionUpdateParams::LedgerableType::OrSymbol,
@@ -131,8 +122,7 @@ module ModernTreasury
         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.
+        # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
         ledgerable_type: nil,
         # Additional data represented as key-value pairs. Both the key and value must be
         # strings.
@@ -148,10 +138,7 @@ module ModernTreasury
           {
             description: T.nilable(String),
             effective_at: Time,
-            ledger_entries:
-              T::Array[
-                ModernTreasury::LedgerTransactionUpdateParams::LedgerEntry
-              ],
+            ledger_entries: T::Array[ModernTreasury::LedgerEntryCreateRequest],
             ledgerable_id: String,
             ledgerable_type:
               ModernTreasury::LedgerTransactionUpdateParams::LedgerableType::OrSymbol,
@@ -165,142 +152,9 @@ module ModernTreasury
       def to_hash
       end
 
-      class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::LedgerTransactionUpdateParams::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.
+      # payment_order, incoming_payment_detail, expected_payment, return, or reversal.
       module LedgerableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -323,11 +177,6 @@ module ModernTreasury
             :incoming_payment_detail,
             ModernTreasury::LedgerTransactionUpdateParams::LedgerableType::TaggedSymbol
           )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::LedgerTransactionUpdateParams::LedgerableType::TaggedSymbol
-          )
         PAYMENT_ORDER =
           T.let(
             :payment_order,