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

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_retrieve_params.rbi

@@ -6,44 +6,74 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountRetrieveParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # Use `balances[effective_at_lower_bound]` and
       # `balances[effective_at_upper_bound]` to get the balances change between the two
       # timestamps. The lower bound is inclusive while the upper bound is exclusive of
       # the provided timestamps. If no value is supplied the balances will be retrieved
       # not including that bound. Use `balances[as_of_lock_version]` to retrieve a
       # balance as of a specific Ledger Account `lock_version`.
-      sig { returns(T.nilable(ModernTreasury::Models::LedgerAccountRetrieveParams::Balances)) }
+      sig do
+        returns(
+          T.nilable(ModernTreasury::LedgerAccountRetrieveParams::Balances)
+        )
+      end
       attr_reader :balances
 
       sig do
         params(
-          balances: T.any(ModernTreasury::Models::LedgerAccountRetrieveParams::Balances, ModernTreasury::Internal::AnyHash)
-        )
-          .void
+          balances:
+            ModernTreasury::LedgerAccountRetrieveParams::Balances::OrHash
+        ).void
       end
       attr_writer :balances
 
       sig do
         params(
-          balances: T.any(ModernTreasury::Models::LedgerAccountRetrieveParams::Balances, ModernTreasury::Internal::AnyHash),
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          balances:
+            ModernTreasury::LedgerAccountRetrieveParams::Balances::OrHash,
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Use `balances[effective_at_lower_bound]` and
+        # `balances[effective_at_upper_bound]` to get the balances change between the two
+        # timestamps. The lower bound is inclusive while the upper bound is exclusive of
+        # the provided timestamps. If no value is supplied the balances will be retrieved
+        # not including that bound. Use `balances[as_of_lock_version]` to retrieve a
+        # balance as of a specific Ledger Account `lock_version`.
+        balances: nil,
+        request_options: {}
+      )
       end
-      def self.new(balances: nil, request_options: {}); end
 
       sig do
-        override
-          .returns(
-            {
-              balances: ModernTreasury::Models::LedgerAccountRetrieveParams::Balances,
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            balances: ModernTreasury::LedgerAccountRetrieveParams::Balances,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       class Balances < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::LedgerAccountRetrieveParams::Balances,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
         sig { returns(T.nilable(Date)) }
         attr_reader :as_of_date
 
@@ -87,8 +117,7 @@ module ModernTreasury
             effective_at: Time,
             effective_at_lower_bound: Time,
             effective_at_upper_bound: Time
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           as_of_date: nil,
@@ -96,20 +125,22 @@ module ModernTreasury
           effective_at: nil,
           effective_at_lower_bound: nil,
           effective_at_upper_bound: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                as_of_date: Date,
-                as_of_lock_version: Integer,
-                effective_at: Time,
-                effective_at_lower_bound: Time,
-                effective_at_upper_bound: Time
-              }
-            )
+          override.returns(
+            {
+              as_of_date: Date,
+              as_of_lock_version: Integer,
+              effective_at: Time,
+              effective_at_lower_bound: Time,
+              effective_at_upper_bound: Time
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_settlement.rbi

@@ -3,6 +3,14 @@
 module ModernTreasury
   module Models
     class LedgerAccountSettlement < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountSettlement,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       sig { returns(String) }
       attr_accessor :id
 
@@ -68,7 +76,9 @@ module ModernTreasury
 
       # The status of the ledger account settlement. One of `processing`, `pending`,
       # `posted`, `archiving` or `archived`.
-      sig { returns(ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol) }
+      sig do
+        returns(ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol)
+      end
       attr_accessor :status
 
       sig { returns(Time) }
@@ -91,74 +101,129 @@ module ModernTreasury
           object: String,
           settled_ledger_account_id: String,
           settlement_entry_direction: T.nilable(String),
-          status: ModernTreasury::Models::LedgerAccountSettlement::Status::OrSymbol,
+          status: ModernTreasury::LedgerAccountSettlement::Status::OrSymbol,
           updated_at: Time
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         id:,
+        # The amount of the ledger account settlement.
         amount:,
+        # The id of the contra ledger account that sends to or receives funds from the
+        # settled ledger account.
         contra_ledger_account_id:,
         created_at:,
+        # The currency of the ledger account settlement.
         currency:,
+        # The currency exponent of the ledger account settlement.
         currency_exponent:,
+        # The description of the ledger account settlement.
         description:,
+        # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+        # be included in the ledger account settlement. The default value is the
+        # created_at timestamp of the ledger account settlement.
         effective_at_upper_bound:,
+        # The id of the ledger that this ledger account settlement belongs to.
         ledger_id:,
+        # The id of the ledger transaction that this settlement is associated with.
         ledger_transaction_id:,
+        # This field will be true if this object exists in the live environment or false
+        # if it exists in the test environment.
         live_mode:,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata:,
         object:,
+        # The id of the settled ledger account whose ledger entries are queried against,
+        # and its balance is reduced as a result.
         settled_ledger_account_id:,
+        # The direction of the ledger entry with the settlement_ledger_account.
         settlement_entry_direction:,
+        # The status of the ledger account settlement. One of `processing`, `pending`,
+        # `posted`, `archiving` or `archived`.
         status:,
         updated_at:
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: String,
-              amount: T.nilable(Integer),
-              contra_ledger_account_id: String,
-              created_at: Time,
-              currency: String,
-              currency_exponent: T.nilable(Integer),
-              description: T.nilable(String),
-              effective_at_upper_bound: Time,
-              ledger_id: String,
-              ledger_transaction_id: T.nilable(String),
-              live_mode: T::Boolean,
-              metadata: T::Hash[Symbol, String],
-              object: String,
-              settled_ledger_account_id: String,
-              settlement_entry_direction: T.nilable(String),
-              status: ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol,
-              updated_at: Time
-            }
-          )
+        override.returns(
+          {
+            id: String,
+            amount: T.nilable(Integer),
+            contra_ledger_account_id: String,
+            created_at: Time,
+            currency: String,
+            currency_exponent: T.nilable(Integer),
+            description: T.nilable(String),
+            effective_at_upper_bound: Time,
+            ledger_id: String,
+            ledger_transaction_id: T.nilable(String),
+            live_mode: T::Boolean,
+            metadata: T::Hash[Symbol, String],
+            object: String,
+            settled_ledger_account_id: String,
+            settlement_entry_direction: T.nilable(String),
+            status:
+              ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       # The status of the ledger account settlement. One of `processing`, `pending`,
       # `posted`, `archiving` or `archived`.
       module Status
         extend ModernTreasury::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlement::Status) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol) }
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::LedgerAccountSettlement::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        ARCHIVED = T.let(:archived, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
-        ARCHIVING = T.let(:archiving, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
-        DRAFTING = T.let(:drafting, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
-        PENDING = T.let(:pending, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
-        POSTED = T.let(:posted, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
-        PROCESSING = T.let(:processing, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol)
+        ARCHIVED =
+          T.let(
+            :archived,
+            ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+          )
+        ARCHIVING =
+          T.let(
+            :archiving,
+            ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+          )
+        DRAFTING =
+          T.let(
+            :drafting,
+            ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+          )
+        POSTED =
+          T.let(
+            :posted,
+            ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+          )
+        PROCESSING =
+          T.let(
+            :processing,
+            ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+          )
 
-        sig { override.returns(T::Array[ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerAccountSettlement::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_settlement_create_params.rbi

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountSettlementCreateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # The id of the contra ledger account that sends to or receives funds from the
       # settled ledger account.
       sig { returns(String) }
@@ -47,7 +55,13 @@ module ModernTreasury
 
       # The status of the ledger account settlement. It is set to `pending` by default.
       # To post a ledger account settlement at creation, use `posted`.
-      sig { returns(T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol)) }
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::LedgerAccountSettlementCreateParams::Status::OrSymbol
+          )
+        )
+      end
       attr_accessor :status
 
       sig do
@@ -59,39 +73,63 @@ module ModernTreasury
           effective_at_upper_bound: T.nilable(Time),
           metadata: T::Hash[Symbol, String],
           skip_settlement_ledger_transaction: T.nilable(T::Boolean),
-          status: T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol),
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          status:
+            T.nilable(
+              ModernTreasury::LedgerAccountSettlementCreateParams::Status::OrSymbol
+            ),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
+        # The id of the contra ledger account that sends to or receives funds from the
+        # settled ledger account.
         contra_ledger_account_id:,
+        # The id of the settled ledger account whose ledger entries are queried against,
+        # and its balance is reduced as a result.
         settled_ledger_account_id:,
+        # If true, the settlement amount and settlement_entry_direction will bring the
+        # settlement ledger account's balance closer to zero, even if the balance is
+        # negative.
         allow_either_direction: nil,
+        # The description of the ledger account settlement.
         description: nil,
+        # The exclusive upper bound of the effective_at timestamp of the ledger entries to
+        # be included in the ledger account settlement. The default value is the
+        # created_at timestamp of the ledger account settlement.
         effective_at_upper_bound: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
         metadata: nil,
+        # It is set to `false` by default. It should be set to `true` when migrating
+        # existing settlements.
         skip_settlement_ledger_transaction: nil,
+        # The status of the ledger account settlement. It is set to `pending` by default.
+        # To post a ledger account settlement at creation, use `posted`.
         status: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              contra_ledger_account_id: String,
-              settled_ledger_account_id: String,
-              allow_either_direction: T.nilable(T::Boolean),
-              description: T.nilable(String),
-              effective_at_upper_bound: T.nilable(Time),
-              metadata: T::Hash[Symbol, String],
-              skip_settlement_ledger_transaction: T.nilable(T::Boolean),
-              status: T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol),
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            contra_ledger_account_id: String,
+            settled_ledger_account_id: String,
+            allow_either_direction: T.nilable(T::Boolean),
+            description: T.nilable(String),
+            effective_at_upper_bound: T.nilable(Time),
+            metadata: T::Hash[Symbol, String],
+            skip_settlement_ledger_transaction: T.nilable(T::Boolean),
+            status:
+              T.nilable(
+                ModernTreasury::LedgerAccountSettlementCreateParams::Status::OrSymbol
+              ),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       # The status of the ledger account settlement. It is set to `pending` by default.
       # To post a ledger account settlement at creation, use `posted`.
@@ -99,20 +137,34 @@ module ModernTreasury
         extend ModernTreasury::Internal::Type::Enum
 
         TaggedSymbol =
-          T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol) }
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::LedgerAccountSettlementCreateParams::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         PENDING =
-          T.let(:pending, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol)
+          T.let(
+            :pending,
+            ModernTreasury::LedgerAccountSettlementCreateParams::Status::TaggedSymbol
+          )
         POSTED =
-          T.let(:posted, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol)
+          T.let(
+            :posted,
+            ModernTreasury::LedgerAccountSettlementCreateParams::Status::TaggedSymbol
+          )
 
         sig do
-          override
-            .returns(T::Array[ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol])
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerAccountSettlementCreateParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
         end
-        def self.values; end
       end
     end
   end

data/rbi/{lib/modern_treasury → modern_treasury}/models/ledger_account_settlement_list_params.rbi

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountSettlementListParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # If you have specific IDs to retrieve in bulk, you can pass them as query
       # parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
       sig { returns(T.nilable(T::Array[String])) }
@@ -86,42 +94,54 @@ module ModernTreasury
           settled_ledger_account_id: String,
           settlement_entry_direction: String,
           updated_at: T::Hash[Symbol, Time],
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
+        # If you have specific IDs to retrieve in bulk, you can pass them as query
+        # parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
         id: nil,
         after_cursor: nil,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        # created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+        # created_at%5Bgt%5D=2000-01-01T12:00:00Z.
         created_at: nil,
         ledger_id: nil,
         ledger_transaction_id: nil,
+        # For example, if you want to query for records with metadata key `Type` and value
+        # `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+        # parameters.
         metadata: nil,
         per_page: nil,
         settled_ledger_account_id: nil,
         settlement_entry_direction: nil,
+        # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+        # updated at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+        # updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
         updated_at: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              id: T::Array[String],
-              after_cursor: T.nilable(String),
-              created_at: T::Hash[Symbol, Time],
-              ledger_id: String,
-              ledger_transaction_id: String,
-              metadata: T::Hash[Symbol, String],
-              per_page: Integer,
-              settled_ledger_account_id: String,
-              settlement_entry_direction: String,
-              updated_at: T::Hash[Symbol, Time],
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            id: T::Array[String],
+            after_cursor: T.nilable(String),
+            created_at: T::Hash[Symbol, Time],
+            ledger_id: String,
+            ledger_transaction_id: String,
+            metadata: T::Hash[Symbol, String],
+            per_page: Integer,
+            settled_ledger_account_id: String,
+            settlement_entry_direction: String,
+            updated_at: T::Hash[Symbol, Time],
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/modern_treasury/models/ledger_account_settlement_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountSettlementRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountSettlementRetrieveParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: ModernTreasury::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end