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

data/rbi/lib/modern_treasury/models/ledger_entry_list_params.rbi

@@ -2,179 +2,172 @@
 
 module ModernTreasury
   module Models
-    class LedgerEntryListParams < ModernTreasury::BaseModel
-      extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+    class LedgerEntryListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
+      # 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])) }
-      def id
-      end
+      attr_reader :id
 
-      sig { params(_: T::Array[String]).returns(T::Array[String]) }
-      def id=(_)
-      end
+      sig { params(id: T::Array[String]).void }
+      attr_writer :id
 
       sig { returns(T.nilable(String)) }
-      def after_cursor
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def after_cursor=(_)
-      end
+      attr_accessor :after_cursor
 
+      # Shows all ledger entries that were present on a ledger account at a particular
+      # `lock_version`. You must also specify `ledger_account_id`.
       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(Symbol)) }
-      def direction
-      end
+      # If true, response will include ledger entries that were deleted. When you update
+      # a ledger transaction to specify a new set of entries, the previous entries are
+      # deleted.
+      sig { returns(T.nilable(ModernTreasury::Models::TransactionDirection::OrSymbol)) }
+      attr_reader :direction
 
-      sig { params(_: Symbol).returns(Symbol) }
-      def direction=(_)
-      end
+      sig { params(direction: ModernTreasury::Models::TransactionDirection::OrSymbol).void }
+      attr_writer :direction
 
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      # transaction's effective time. Format ISO8601
       sig { returns(T.nilable(T::Hash[Symbol, Time])) }
-      def effective_at
-      end
+      attr_reader :effective_at
 
-      sig { params(_: T::Hash[Symbol, Time]).returns(T::Hash[Symbol, Time]) }
-      def effective_at=(_)
-      end
+      sig { params(effective_at: T::Hash[Symbol, Time]).void }
+      attr_writer :effective_at
 
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      # transaction's effective date. Format YYYY-MM-DD
       sig { returns(T.nilable(T::Hash[Symbol, Date])) }
-      def effective_date
-      end
+      attr_reader :effective_date
 
-      sig { params(_: T::Hash[Symbol, Date]).returns(T::Hash[Symbol, Date]) }
-      def effective_date=(_)
-      end
+      sig { params(effective_date: T::Hash[Symbol, Date]).void }
+      attr_writer :effective_date
 
+      # Get all ledger entries that match the direction specified. One of `credit`,
+      # `debit`.
       sig { returns(T.nilable(String)) }
-      def ledger_account_category_id
-      end
+      attr_reader :ledger_account_category_id
 
-      sig { params(_: String).returns(String) }
-      def ledger_account_category_id=(_)
-      end
+      sig { params(ledger_account_category_id: String).void }
+      attr_writer :ledger_account_category_id
 
       sig { returns(T.nilable(String)) }
-      def ledger_account_id
-      end
+      attr_reader :ledger_account_id
 
-      sig { params(_: String).returns(String) }
-      def ledger_account_id=(_)
-      end
+      sig { params(ledger_account_id: String).void }
+      attr_writer :ledger_account_id
 
+      # Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
+      # lock_version of a ledger account. For example, for all entries created at or
+      # before before lock_version 1000 of a ledger account, use
+      # `ledger_account_lock_version%5Blte%5D=1000`.
       sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
-      def ledger_account_lock_version
-      end
+      attr_reader :ledger_account_lock_version
 
-      sig { params(_: T::Hash[Symbol, Integer]).returns(T::Hash[Symbol, Integer]) }
-      def ledger_account_lock_version=(_)
-      end
+      sig { params(ledger_account_lock_version: T::Hash[Symbol, Integer]).void }
+      attr_writer :ledger_account_lock_version
 
       sig { returns(T.nilable(String)) }
-      def ledger_account_payout_id
-      end
+      attr_reader :ledger_account_payout_id
 
-      sig { params(_: String).returns(String) }
-      def ledger_account_payout_id=(_)
-      end
+      sig { params(ledger_account_payout_id: String).void }
+      attr_writer :ledger_account_payout_id
 
       sig { returns(T.nilable(String)) }
-      def ledger_account_settlement_id
-      end
+      attr_reader :ledger_account_settlement_id
 
-      sig { params(_: String).returns(String) }
-      def ledger_account_settlement_id=(_)
-      end
+      sig { params(ledger_account_settlement_id: String).void }
+      attr_writer :ledger_account_settlement_id
 
+      # Get all ledger entries that are included in the ledger account statement.
       sig { returns(T.nilable(String)) }
-      def ledger_account_statement_id
-      end
+      attr_reader :ledger_account_statement_id
 
-      sig { params(_: String).returns(String) }
-      def ledger_account_statement_id=(_)
-      end
+      sig { params(ledger_account_statement_id: String).void }
+      attr_writer :ledger_account_statement_id
 
       sig { returns(T.nilable(String)) }
-      def ledger_transaction_id
-      end
+      attr_reader :ledger_transaction_id
 
-      sig { params(_: String).returns(String) }
-      def ledger_transaction_id=(_)
-      end
+      sig { params(ledger_transaction_id: String).void }
+      attr_writer :ledger_transaction_id
 
+      # 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.
       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
 
+      # Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
+      # to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+      # by only one field at a time is supported.
       sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::OrderBy)) }
-      def order_by
-      end
+      attr_reader :order_by
 
       sig do
-        params(_: ModernTreasury::Models::LedgerEntryListParams::OrderBy)
-          .returns(ModernTreasury::Models::LedgerEntryListParams::OrderBy)
-      end
-      def order_by=(_)
+        params(
+          order_by: T.any(ModernTreasury::Models::LedgerEntryListParams::OrderBy, ModernTreasury::Internal::AnyHash)
+        )
+          .void
       end
+      attr_writer :order_by
 
       sig { returns(T.nilable(Integer)) }
-      def per_page
-      end
+      attr_reader :per_page
 
-      sig { params(_: Integer).returns(Integer) }
-      def per_page=(_)
-      end
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
 
+      # If true, response will include the balances attached to the ledger entry. If
+      # there is no balance available, null will be returned instead.
       sig { returns(T.nilable(T::Boolean)) }
-      def show_balances
-      end
+      attr_reader :show_balances
 
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def show_balances=(_)
-      end
+      sig { params(show_balances: T::Boolean).void }
+      attr_writer :show_balances
 
+      # If true, response will include ledger entries that were deleted. When you update
+      # a ledger transaction to specify a new set of entries, the previous entries are
+      # deleted.
       sig { returns(T.nilable(T::Boolean)) }
-      def show_deleted
-      end
+      attr_reader :show_deleted
 
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def show_deleted=(_)
-      end
+      sig { params(show_deleted: T::Boolean).void }
+      attr_writer :show_deleted
 
-      sig { returns(T.nilable(Symbol)) }
-      def status
-      end
+      # Get all ledger entries that match the status specified. One of `pending`,
+      # `posted`, or `archived`.
+      sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol)) }
+      attr_reader :status
 
-      sig { params(_: Symbol).returns(Symbol) }
-      def status=(_)
-      end
+      sig { params(status: ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol).void }
+      attr_writer :status
 
+      # 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
+      # updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
       sig { returns(T.nilable(T::Hash[Symbol, Time])) }
-      def updated_at
-      end
+      attr_reader :updated_at
 
-      sig { params(_: T::Hash[Symbol, Time]).returns(T::Hash[Symbol, Time]) }
-      def updated_at=(_)
-      end
+      sig { params(updated_at: T::Hash[Symbol, Time]).void }
+      attr_writer :updated_at
 
       sig do
         params(
           id: T::Array[String],
           after_cursor: T.nilable(String),
           as_of_lock_version: Integer,
-          direction: Symbol,
+          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
           effective_at: T::Hash[Symbol, Time],
           effective_date: T::Hash[Symbol, Date],
           ledger_account_category_id: String,
@@ -185,17 +178,17 @@ module ModernTreasury
           ledger_account_statement_id: String,
           ledger_transaction_id: String,
           metadata: T::Hash[Symbol, String],
-          order_by: ModernTreasury::Models::LedgerEntryListParams::OrderBy,
+          order_by: T.any(ModernTreasury::Models::LedgerEntryListParams::OrderBy, ModernTreasury::Internal::AnyHash),
           per_page: Integer,
           show_balances: T::Boolean,
           show_deleted: T::Boolean,
-          status: Symbol,
+          status: ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol,
           updated_at: T::Hash[Symbol, Time],
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         id: nil,
         after_cursor: nil,
         as_of_lock_version: nil,
@@ -217,9 +210,7 @@ module ModernTreasury
         status: nil,
         updated_at: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -227,7 +218,7 @@ module ModernTreasury
               id: T::Array[String],
               after_cursor: T.nilable(String),
               as_of_lock_version: Integer,
-              direction: Symbol,
+              direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
               effective_at: T::Hash[Symbol, Time],
               effective_date: T::Hash[Symbol, Date],
               ledger_account_category_id: String,
@@ -242,73 +233,101 @@ module ModernTreasury
               per_page: Integer,
               show_balances: T::Boolean,
               show_deleted: T::Boolean,
-              status: Symbol,
+              status: ModernTreasury::Models::LedgerEntryListParams::Status::OrSymbol,
               updated_at: T::Hash[Symbol, Time],
               request_options: ModernTreasury::RequestOptions
             }
           )
       end
-      def to_hash
-      end
+      def to_hash; end
 
-      class OrderBy < ModernTreasury::BaseModel
-        sig { returns(T.nilable(Symbol)) }
-        def created_at
-        end
+      class OrderBy < ModernTreasury::Internal::Type::BaseModel
+        sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol)) }
+        attr_reader :created_at
 
-        sig { params(_: Symbol).returns(Symbol) }
-        def created_at=(_)
-        end
+        sig { params(created_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol).void }
+        attr_writer :created_at
 
-        sig { returns(T.nilable(Symbol)) }
-        def effective_at
-        end
+        sig { returns(T.nilable(ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol)) }
+        attr_reader :effective_at
 
-        sig { params(_: Symbol).returns(Symbol) }
-        def effective_at=(_)
-        end
+        sig { params(effective_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol).void }
+        attr_writer :effective_at
 
-        sig { params(created_at: Symbol, effective_at: Symbol).void }
-        def initialize(created_at: nil, effective_at: nil)
+        # Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
+        # to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+        # by only one field at a time is supported.
+        sig do
+          params(
+            created_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol,
+            effective_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol
+          )
+            .returns(T.attached_class)
         end
-
-        sig { override.returns({created_at: Symbol, effective_at: Symbol}) }
-        def to_hash
+        def self.new(created_at: nil, effective_at: nil); end
+
+        sig do
+          override
+            .returns(
+              {
+                created_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::OrSymbol,
+                effective_at: ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::OrSymbol
+              }
+            )
         end
+        def to_hash; end
+
+        module CreatedAt
+          extend ModernTreasury::Internal::Type::Enum
 
-        class CreatedAt < ModernTreasury::Enum
-          abstract!
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol) }
 
-          ASC = :asc
-          DESC = :desc
+          ASC = T.let(:asc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol)
+          DESC = T.let(:desc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol)
 
-          sig { override.returns(T::Array[Symbol]) }
-          def self.values
+          sig do
+            override.returns(T::Array[ModernTreasury::Models::LedgerEntryListParams::OrderBy::CreatedAt::TaggedSymbol])
           end
+          def self.values; end
         end
 
-        class EffectiveAt < ModernTreasury::Enum
-          abstract!
+        module EffectiveAt
+          extend ModernTreasury::Internal::Type::Enum
 
-          ASC = :asc
-          DESC = :desc
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol) }
 
-          sig { override.returns(T::Array[Symbol]) }
-          def self.values
+          ASC = T.let(:asc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol)
+          DESC = T.let(:desc, ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol)
+
+          sig do
+            override
+              .returns(T::Array[ModernTreasury::Models::LedgerEntryListParams::OrderBy::EffectiveAt::TaggedSymbol])
           end
+          def self.values; end
         end
       end
 
-      class Status < ModernTreasury::Enum
-        abstract!
+      # Get all ledger entries that match the status specified. One of `pending`,
+      # `posted`, or `archived`.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
 
-        PENDING = :pending
-        POSTED = :posted
-        ARCHIVED = :archived
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::LedgerEntryListParams::Status) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, String, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol) }
 
-        sig { override.returns(T::Array[Symbol]) }
-        def self.values
-        end
+        PENDING = T.let(:pending, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol)
+        POSTED = T.let(:posted, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol)
+        ARCHIVED = T.let(:archived, ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::LedgerEntryListParams::Status::TaggedSymbol]) }
+        def self.values; end
       end
     end
   end

data/rbi/lib/modern_treasury/models/ledger_entry_retrieve_params.rbi

@@ -2,31 +2,29 @@
 
 module ModernTreasury
   module Models
-    class LedgerEntryRetrieveParams < ModernTreasury::BaseModel
-      extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+    class LedgerEntryRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
+      # If true, response will include the balances attached to the ledger entry. If
+      # there is no balance available, null will be returned instead.
       sig { returns(T.nilable(T::Boolean)) }
-      def show_balances
-      end
+      attr_reader :show_balances
 
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def show_balances=(_)
-      end
+      sig { params(show_balances: T::Boolean).void }
+      attr_writer :show_balances
 
       sig do
         params(
           show_balances: T::Boolean,
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
         )
-          .void
-      end
-      def initialize(show_balances: nil, request_options: {})
+          .returns(T.attached_class)
       end
+      def self.new(show_balances: nil, request_options: {}); end
 
       sig { override.returns({show_balances: T::Boolean, request_options: ModernTreasury::RequestOptions}) }
-      def to_hash
-      end
+      def to_hash; end
     end
   end
 end

data/rbi/lib/modern_treasury/models/ledger_entry_update_params.rbi

@@ -2,33 +2,31 @@
 
 module ModernTreasury
   module Models
-    class LedgerEntryUpdateParams < ModernTreasury::BaseModel
-      extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+    class LedgerEntryUpdateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
+      # 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
 
       sig do
         params(
           metadata: T::Hash[Symbol, String],
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
         )
-          .void
-      end
-      def initialize(metadata: nil, request_options: {})
+          .returns(T.attached_class)
       end
+      def self.new(metadata: nil, request_options: {}); end
 
       sig do
         override.returns({metadata: T::Hash[Symbol, String], request_options: ModernTreasury::RequestOptions})
       end
-      def to_hash
-      end
+      def to_hash; end
     end
   end
 end