modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/rbi/lib/modern_treasury/models/ledger_account_retrieve_params.rbi

@@ -2,30 +2,35 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountRetrieveParams < ModernTreasury::BaseModel
-      extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
-
+    class LedgerAccountRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # 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)) }
-      def balances
-      end
+      attr_reader :balances
 
       sig do
-        params(_: ModernTreasury::Models::LedgerAccountRetrieveParams::Balances)
-          .returns(ModernTreasury::Models::LedgerAccountRetrieveParams::Balances)
-      end
-      def balances=(_)
+        params(
+          balances: T.any(ModernTreasury::Models::LedgerAccountRetrieveParams::Balances, ModernTreasury::Internal::AnyHash)
+        )
+          .void
       end
+      attr_writer :balances
 
       sig do
         params(
-          balances: ModernTreasury::Models::LedgerAccountRetrieveParams::Balances,
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          balances: T.any(ModernTreasury::Models::LedgerAccountRetrieveParams::Balances, ModernTreasury::Internal::AnyHash),
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
         )
-          .void
-      end
-      def initialize(balances: nil, request_options: {})
+          .returns(T.attached_class)
       end
+      def self.new(balances: nil, request_options: {}); end
 
       sig do
         override
@@ -36,50 +41,45 @@ module ModernTreasury
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
-      class Balances < ModernTreasury::BaseModel
+      class Balances < ModernTreasury::Internal::Type::BaseModel
         sig { returns(T.nilable(Date)) }
-        def as_of_date
-        end
+        attr_reader :as_of_date
 
-        sig { params(_: Date).returns(Date) }
-        def as_of_date=(_)
-        end
+        sig { params(as_of_date: Date).void }
+        attr_writer :as_of_date
 
         sig { returns(T.nilable(Integer)) }
-        def as_of_lock_version
-        end
+        attr_reader :as_of_lock_version
 
-        sig { params(_: Integer).returns(Integer) }
-        def as_of_lock_version=(_)
-        end
+        sig { params(as_of_lock_version: Integer).void }
+        attr_writer :as_of_lock_version
 
         sig { returns(T.nilable(Time)) }
-        def effective_at
-        end
+        attr_reader :effective_at
 
-        sig { params(_: Time).returns(Time) }
-        def effective_at=(_)
-        end
+        sig { params(effective_at: Time).void }
+        attr_writer :effective_at
 
         sig { returns(T.nilable(Time)) }
-        def effective_at_lower_bound
-        end
+        attr_reader :effective_at_lower_bound
 
-        sig { params(_: Time).returns(Time) }
-        def effective_at_lower_bound=(_)
-        end
+        sig { params(effective_at_lower_bound: Time).void }
+        attr_writer :effective_at_lower_bound
 
         sig { returns(T.nilable(Time)) }
-        def effective_at_upper_bound
-        end
+        attr_reader :effective_at_upper_bound
 
-        sig { params(_: Time).returns(Time) }
-        def effective_at_upper_bound=(_)
-        end
+        sig { params(effective_at_upper_bound: Time).void }
+        attr_writer :effective_at_upper_bound
 
+        # 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 do
           params(
             as_of_date: Date,
@@ -88,17 +88,15 @@ module ModernTreasury
             effective_at_lower_bound: Time,
             effective_at_upper_bound: Time
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           as_of_date: nil,
           as_of_lock_version: nil,
           effective_at: nil,
           effective_at_lower_bound: nil,
           effective_at_upper_bound: nil
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
@@ -111,8 +109,7 @@ module ModernTreasury
               }
             )
         end
-        def to_hash
-        end
+        def to_hash; end
       end
     end
   end

data/rbi/lib/modern_treasury/models/ledger_account_settlement.rbi

@@ -2,142 +2,77 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountSettlement < ModernTreasury::BaseModel
+    class LedgerAccountSettlement < ModernTreasury::Internal::Type::BaseModel
       sig { returns(String) }
-      def id
-      end
-
-      sig { params(_: String).returns(String) }
-      def id=(_)
-      end
+      attr_accessor :id
 
+      # The amount of the ledger account settlement.
       sig { returns(T.nilable(Integer)) }
-      def amount
-      end
-
-      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
-      def amount=(_)
-      end
+      attr_accessor :amount
 
+      # The id of the contra ledger account that sends to or receives funds from the
+      # settled ledger account.
       sig { returns(String) }
-      def contra_ledger_account_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def contra_ledger_account_id=(_)
-      end
+      attr_accessor :contra_ledger_account_id
 
       sig { returns(Time) }
-      def created_at
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def created_at=(_)
-      end
+      attr_accessor :created_at
 
+      # The currency of the ledger account settlement.
       sig { returns(String) }
-      def currency
-      end
-
-      sig { params(_: String).returns(String) }
-      def currency=(_)
-      end
+      attr_accessor :currency
 
+      # The currency exponent of the ledger account settlement.
       sig { returns(T.nilable(Integer)) }
-      def currency_exponent
-      end
-
-      sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
-      def currency_exponent=(_)
-      end
+      attr_accessor :currency_exponent
 
+      # The description of the ledger account settlement.
       sig { returns(T.nilable(String)) }
-      def description
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def description=(_)
-      end
+      attr_accessor :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.
       sig { returns(Time) }
-      def effective_at_upper_bound
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def effective_at_upper_bound=(_)
-      end
+      attr_accessor :effective_at_upper_bound
 
+      # The id of the ledger that this ledger account settlement belongs to.
       sig { returns(String) }
-      def ledger_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def ledger_id=(_)
-      end
+      attr_accessor :ledger_id
 
+      # The id of the ledger transaction that this settlement is associated with.
       sig { returns(T.nilable(String)) }
-      def ledger_transaction_id
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def ledger_transaction_id=(_)
-      end
+      attr_accessor :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.
       sig { returns(T::Boolean) }
-      def live_mode
-      end
-
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def live_mode=(_)
-      end
+      attr_accessor :live_mode
 
+      # Additional data represented as key-value pairs. Both the key and value must be
+      # strings.
       sig { returns(T::Hash[Symbol, String]) }
-      def metadata
-      end
-
-      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
-      def metadata=(_)
-      end
+      attr_accessor :metadata
 
       sig { returns(String) }
-      def object
-      end
-
-      sig { params(_: String).returns(String) }
-      def object=(_)
-      end
+      attr_accessor :object
 
+      # The id of the settled ledger account whose ledger entries are queried against,
+      # and its balance is reduced as a result.
       sig { returns(String) }
-      def settled_ledger_account_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def settled_ledger_account_id=(_)
-      end
+      attr_accessor :settled_ledger_account_id
 
+      # The direction of the ledger entry with the settlement_ledger_account.
       sig { returns(T.nilable(String)) }
-      def settlement_entry_direction
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def settlement_entry_direction=(_)
-      end
+      attr_accessor :settlement_entry_direction
 
-      sig { returns(Symbol) }
-      def status
-      end
-
-      sig { params(_: Symbol).returns(Symbol) }
-      def status=(_)
-      end
+      # The status of the ledger account settlement. One of `processing`, `pending`,
+      # `posted`, `archiving` or `archived`.
+      sig { returns(ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol) }
+      attr_accessor :status
 
       sig { returns(Time) }
-      def updated_at
-      end
-
-      sig { params(_: Time).returns(Time) }
-      def updated_at=(_)
-      end
+      attr_accessor :updated_at
 
       sig do
         params(
@@ -156,12 +91,12 @@ module ModernTreasury
           object: String,
           settled_ledger_account_id: String,
           settlement_entry_direction: T.nilable(String),
-          status: Symbol,
+          status: ModernTreasury::Models::LedgerAccountSettlement::Status::OrSymbol,
           updated_at: Time
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         id:,
         amount:,
         contra_ledger_account_id:,
@@ -179,9 +114,7 @@ module ModernTreasury
         settlement_entry_direction:,
         status:,
         updated_at:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -201,27 +134,31 @@ module ModernTreasury
               object: String,
               settled_ledger_account_id: String,
               settlement_entry_direction: T.nilable(String),
-              status: Symbol,
+              status: ModernTreasury::Models::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
 
-      class Status < ModernTreasury::Enum
-        abstract!
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlement::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol) }
 
-        ARCHIVED = :archived
-        ARCHIVING = :archiving
-        DRAFTING = :drafting
-        PENDING = :pending
-        POSTED = :posted
-        PROCESSING = :processing
+        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)
 
-        sig { override.returns(T::Array[Symbol]) }
-        def self.values
-        end
+        sig { override.returns(T::Array[ModernTreasury::Models::LedgerAccountSettlement::Status::TaggedSymbol]) }
+        def self.values; end
       end
     end
   end

data/rbi/lib/modern_treasury/models/ledger_account_settlement_create_params.rbi

@@ -2,73 +2,53 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountSettlementCreateParams < ModernTreasury::BaseModel
-      extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+    class LedgerAccountSettlementCreateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
+      # The id of the contra ledger account that sends to or receives funds from the
+      # settled ledger account.
       sig { returns(String) }
-      def contra_ledger_account_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def contra_ledger_account_id=(_)
-      end
+      attr_accessor :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.
       sig { returns(String) }
-      def settled_ledger_account_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def settled_ledger_account_id=(_)
-      end
+      attr_accessor :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.
       sig { returns(T.nilable(T::Boolean)) }
-      def allow_either_direction
-      end
-
-      sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
-      def allow_either_direction=(_)
-      end
+      attr_accessor :allow_either_direction
 
+      # The description of the ledger account settlement.
       sig { returns(T.nilable(String)) }
-      def description
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def description=(_)
-      end
+      attr_accessor :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.
       sig { returns(T.nilable(Time)) }
-      def effective_at_upper_bound
-      end
-
-      sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) }
-      def effective_at_upper_bound=(_)
-      end
+      attr_accessor :effective_at_upper_bound
 
+      # Additional data represented as key-value pairs. Both the key and value must be
+      # strings.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
-      def metadata
-      end
+      attr_reader :metadata
 
-      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
-      def metadata=(_)
-      end
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
 
+      # It is set to `false` by default. It should be set to `true` when migrating
+      # existing settlements.
       sig { returns(T.nilable(T::Boolean)) }
-      def skip_settlement_ledger_transaction
-      end
+      attr_accessor :skip_settlement_ledger_transaction
 
-      sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
-      def skip_settlement_ledger_transaction=(_)
-      end
-
-      sig { returns(T.nilable(Symbol)) }
-      def status
-      end
-
-      sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-      def status=(_)
-      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`.
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol)) }
+      attr_accessor :status
 
       sig do
         params(
@@ -79,12 +59,12 @@ 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(Symbol),
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          status: T.nilable(ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::OrSymbol),
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         contra_ledger_account_id:,
         settled_ledger_account_id:,
         allow_either_direction: nil,
@@ -94,9 +74,7 @@ module ModernTreasury
         skip_settlement_ledger_transaction: nil,
         status: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -108,23 +86,33 @@ 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(Symbol),
+              status: T.nilable(ModernTreasury::Models::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`.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
 
-      class Status < ModernTreasury::Enum
-        abstract!
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol) }
 
-        PENDING = T.let(:pending, T.nilable(Symbol))
-        POSTED = T.let(:posted, T.nilable(Symbol))
+        PENDING =
+          T.let(:pending, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol)
+        POSTED =
+          T.let(:posted, ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol)
 
-        sig { override.returns(T::Array[Symbol]) }
-        def self.values
+        sig do
+          override
+            .returns(T::Array[ModernTreasury::Models::LedgerAccountSettlementCreateParams::Status::TaggedSymbol])
         end
+        def self.values; end
       end
     end
   end