modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/rbi/modern_treasury/models/ledger_account_category_list_params.rbi

@@ -27,7 +27,8 @@ module ModernTreasury
 
       # For example, if you want the balances as of a particular time (ISO8601), the
       # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-      # The balances as of a time are inclusive of entries with that exact time.
+      # The balances as of a time are inclusive of entries with that exact time, but
+      # with respect to the ledger accounts that are currently present in the category.
       sig do
         returns(
           T.nilable(ModernTreasury::LedgerAccountCategoryListParams::Balances)
@@ -78,10 +79,12 @@ module ModernTreasury
       sig { params(metadata: T::Hash[Symbol, String]).void }
       attr_writer :metadata
 
-      sig { returns(T.nilable(String)) }
+      # If you have specific names to retrieve in bulk, you can pass them as query
+      # parameters delimited with `name[]=`, for example `?name[]=123&name[]=abc`.
+      sig { returns(T.nilable(T::Array[String])) }
       attr_reader :name
 
-      sig { params(name: String).void }
+      sig { params(name: T::Array[String]).void }
       attr_writer :name
 
       # Query categories that are nested underneath a parent category
@@ -108,7 +111,7 @@ module ModernTreasury
           ledger_account_id: String,
           ledger_id: String,
           metadata: T::Hash[Symbol, String],
-          name: String,
+          name: T::Array[String],
           parent_ledger_account_category_id: String,
           per_page: Integer,
           request_options: ModernTreasury::RequestOptions::OrHash
@@ -121,7 +124,8 @@ module ModernTreasury
         after_cursor: nil,
         # For example, if you want the balances as of a particular time (ISO8601), the
         # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-        # The balances as of a time are inclusive of entries with that exact time.
+        # The balances as of a time are inclusive of entries with that exact time, but
+        # with respect to the ledger accounts that are currently present in the category.
         balances: nil,
         currency: nil,
         external_id: nil,
@@ -133,6 +137,8 @@ module ModernTreasury
         # `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
         # parameters.
         metadata: nil,
+        # If you have specific names to retrieve in bulk, you can pass them as query
+        # parameters delimited with `name[]=`, for example `?name[]=123&name[]=abc`.
         name: nil,
         # Query categories that are nested underneath a parent category
         parent_ledger_account_category_id: nil,
@@ -152,7 +158,7 @@ module ModernTreasury
             ledger_account_id: String,
             ledger_id: String,
             metadata: T::Hash[Symbol, String],
-            name: String,
+            name: T::Array[String],
             parent_ledger_account_category_id: String,
             per_page: Integer,
             request_options: ModernTreasury::RequestOptions
@@ -179,7 +185,8 @@ module ModernTreasury
 
         # For example, if you want the balances as of a particular time (ISO8601), the
         # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-        # The balances as of a time are inclusive of entries with that exact time.
+        # The balances as of a time are inclusive of entries with that exact time, but
+        # with respect to the ledger accounts that are currently present in the category.
         sig { params(effective_at: Time).returns(T.attached_class) }
         def self.new(effective_at: nil)
         end

data/rbi/modern_treasury/models/ledger_account_category_retrieve_params.rbi

@@ -16,7 +16,8 @@ module ModernTreasury
 
       # For example, if you want the balances as of a particular time (ISO8601), the
       # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-      # The balances as of a time are inclusive of entries with that exact time.
+      # The balances as of a time are inclusive of entries with that exact time, but
+      # with respect to the ledger accounts that are currently present in the category.
       sig do
         returns(
           T.nilable(
@@ -44,7 +45,8 @@ module ModernTreasury
       def self.new(
         # For example, if you want the balances as of a particular time (ISO8601), the
         # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-        # The balances as of a time are inclusive of entries with that exact time.
+        # The balances as of a time are inclusive of entries with that exact time, but
+        # with respect to the ledger accounts that are currently present in the category.
         balances: nil,
         request_options: {}
       )
@@ -85,7 +87,8 @@ module ModernTreasury
 
         # For example, if you want the balances as of a particular time (ISO8601), the
         # encoded query string would be `balances%5Beffective_at%5D=2000-12-31T12:00:00Z`.
-        # The balances as of a time are inclusive of entries with that exact time.
+        # The balances as of a time are inclusive of entries with that exact time, but
+        # with respect to the ledger accounts that are currently present in the category.
         sig do
           params(as_of_date: Date, effective_at: Time).returns(T.attached_class)
         end

data/rbi/modern_treasury/models/ledger_account_create_params.rbi

@@ -2,7 +2,7 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountCreateParams < ModernTreasury::Internal::Type::BaseModel
+    class LedgerAccountCreateParams < ModernTreasury::Models::LedgerAccountCreateRequest
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
@@ -14,187 +14,19 @@ module ModernTreasury
           )
         end
 
-      # The currency of the ledger account.
-      sig { returns(String) }
-      attr_accessor :currency
-
-      # The id of the ledger that this account belongs to.
-      sig { returns(String) }
-      attr_accessor :ledger_id
-
-      # The name of the ledger account.
-      sig { returns(String) }
-      attr_accessor :name
-
-      # The normal balance of the ledger account.
-      sig { returns(ModernTreasury::TransactionDirection::OrSymbol) }
-      attr_accessor :normal_balance
-
-      # The currency exponent of the ledger account.
-      sig { returns(T.nilable(Integer)) }
-      attr_accessor :currency_exponent
-
-      # The description of the ledger account.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :description
-
-      # The array of ledger account category ids that this ledger account should be a
-      # child of.
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :ledger_account_category_ids
-
-      sig { params(ledger_account_category_ids: T::Array[String]).void }
-      attr_writer :ledger_account_category_ids
-
-      # If the ledger account links 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 account links to another object in Modern Treasury, the type will
-      # be populated here, otherwise null. The value is one of internal_account or
-      # external_account.
       sig do
-        returns(
-          T.nilable(
-            ModernTreasury::LedgerAccountCreateParams::LedgerableType::OrSymbol
-          )
+        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
+          T.attached_class
         )
       end
-      attr_reader :ledgerable_type
-
-      sig do
-        params(
-          ledgerable_type:
-            ModernTreasury::LedgerAccountCreateParams::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
-
-      sig do
-        params(
-          currency: String,
-          ledger_id: String,
-          name: String,
-          normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
-          currency_exponent: T.nilable(Integer),
-          description: T.nilable(String),
-          ledger_account_category_ids: T::Array[String],
-          ledgerable_id: String,
-          ledgerable_type:
-            ModernTreasury::LedgerAccountCreateParams::LedgerableType::OrSymbol,
-          metadata: T::Hash[Symbol, String],
-          request_options: ModernTreasury::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The currency of the ledger account.
-        currency:,
-        # The id of the ledger that this account belongs to.
-        ledger_id:,
-        # The name of the ledger account.
-        name:,
-        # The normal balance of the ledger account.
-        normal_balance:,
-        # The currency exponent of the ledger account.
-        currency_exponent: nil,
-        # The description of the ledger account.
-        description: nil,
-        # The array of ledger account category ids that this ledger account should be a
-        # child of.
-        ledger_account_category_ids: nil,
-        # If the ledger account links to another object in Modern Treasury, the id will be
-        # populated here, otherwise null.
-        ledgerable_id: nil,
-        # If the ledger account links to another object in Modern Treasury, the type will
-        # be populated here, otherwise null. The value is one of internal_account or
-        # external_account.
-        ledgerable_type: nil,
-        # Additional data represented as key-value pairs. Both the key and value must be
-        # strings.
-        metadata: nil,
-        request_options: {}
-      )
+      def self.new(request_options: {})
       end
 
       sig do
-        override.returns(
-          {
-            currency: String,
-            ledger_id: String,
-            name: String,
-            normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
-            currency_exponent: T.nilable(Integer),
-            description: T.nilable(String),
-            ledger_account_category_ids: T::Array[String],
-            ledgerable_id: String,
-            ledgerable_type:
-              ModernTreasury::LedgerAccountCreateParams::LedgerableType::OrSymbol,
-            metadata: T::Hash[Symbol, String],
-            request_options: ModernTreasury::RequestOptions
-          }
-        )
+        override.returns({ request_options: ModernTreasury::RequestOptions })
       end
       def to_hash
       end
-
-      # If the ledger account links to another object in Modern Treasury, the type will
-      # be populated here, otherwise null. The value is one of internal_account or
-      # external_account.
-      module LedgerableType
-        extend ModernTreasury::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              ModernTreasury::LedgerAccountCreateParams::LedgerableType
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        COUNTERPARTY =
-          T.let(
-            :counterparty,
-            ModernTreasury::LedgerAccountCreateParams::LedgerableType::TaggedSymbol
-          )
-        EXTERNAL_ACCOUNT =
-          T.let(
-            :external_account,
-            ModernTreasury::LedgerAccountCreateParams::LedgerableType::TaggedSymbol
-          )
-        INTERNAL_ACCOUNT =
-          T.let(
-            :internal_account,
-            ModernTreasury::LedgerAccountCreateParams::LedgerableType::TaggedSymbol
-          )
-        VIRTUAL_ACCOUNT =
-          T.let(
-            :virtual_account,
-            ModernTreasury::LedgerAccountCreateParams::LedgerableType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              ModernTreasury::LedgerAccountCreateParams::LedgerableType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/modern_treasury/models/ledger_account_create_request.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::LedgerAccountCreateRequest,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # The currency of the ledger account.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # The id of the ledger that this account belongs to.
+      sig { returns(String) }
+      attr_accessor :ledger_id
+
+      # The name of the ledger account.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The normal balance of the ledger account.
+      sig { returns(ModernTreasury::TransactionDirection::OrSymbol) }
+      attr_accessor :normal_balance
+
+      # The currency exponent of the ledger account.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :currency_exponent
+
+      # The description of the ledger account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The array of ledger account category ids that this ledger account should be a
+      # child of.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :ledger_account_category_ids
+
+      sig { params(ledger_account_category_ids: T::Array[String]).void }
+      attr_writer :ledger_account_category_ids
+
+      # If the ledger account links 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 account links to another object in Modern Treasury, the type will
+      # be populated here, otherwise null. The value is one of internal_account or
+      # external_account.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::LedgerAccountCreateRequest::LedgerableType::OrSymbol
+          )
+        )
+      end
+      attr_reader :ledgerable_type
+
+      sig do
+        params(
+          ledgerable_type:
+            ModernTreasury::LedgerAccountCreateRequest::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
+
+      sig do
+        params(
+          currency: String,
+          ledger_id: String,
+          name: String,
+          normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
+          currency_exponent: T.nilable(Integer),
+          description: T.nilable(String),
+          ledger_account_category_ids: T::Array[String],
+          ledgerable_id: String,
+          ledgerable_type:
+            ModernTreasury::LedgerAccountCreateRequest::LedgerableType::OrSymbol,
+          metadata: T::Hash[Symbol, String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The currency of the ledger account.
+        currency:,
+        # The id of the ledger that this account belongs to.
+        ledger_id:,
+        # The name of the ledger account.
+        name:,
+        # The normal balance of the ledger account.
+        normal_balance:,
+        # The currency exponent of the ledger account.
+        currency_exponent: nil,
+        # The description of the ledger account.
+        description: nil,
+        # The array of ledger account category ids that this ledger account should be a
+        # child of.
+        ledger_account_category_ids: nil,
+        # If the ledger account links to another object in Modern Treasury, the id will be
+        # populated here, otherwise null.
+        ledgerable_id: nil,
+        # If the ledger account links to another object in Modern Treasury, the type will
+        # be populated here, otherwise null. The value is one of internal_account or
+        # external_account.
+        ledgerable_type: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
+        metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            currency: String,
+            ledger_id: String,
+            name: String,
+            normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
+            currency_exponent: T.nilable(Integer),
+            description: T.nilable(String),
+            ledger_account_category_ids: T::Array[String],
+            ledgerable_id: String,
+            ledgerable_type:
+              ModernTreasury::LedgerAccountCreateRequest::LedgerableType::OrSymbol,
+            metadata: T::Hash[Symbol, String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # If the ledger account links to another object in Modern Treasury, the type will
+      # be populated here, otherwise null. The value is one of internal_account or
+      # external_account.
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::LedgerAccountCreateRequest::LedgerableType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        COUNTERPARTY =
+          T.let(
+            :counterparty,
+            ModernTreasury::LedgerAccountCreateRequest::LedgerableType::TaggedSymbol
+          )
+        EXTERNAL_ACCOUNT =
+          T.let(
+            :external_account,
+            ModernTreasury::LedgerAccountCreateRequest::LedgerableType::TaggedSymbol
+          )
+        INTERNAL_ACCOUNT =
+          T.let(
+            :internal_account,
+            ModernTreasury::LedgerAccountCreateRequest::LedgerableType::TaggedSymbol
+          )
+        VIRTUAL_ACCOUNT =
+          T.let(
+            :virtual_account,
+            ModernTreasury::LedgerAccountCreateRequest::LedgerableType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::LedgerAccountCreateRequest::LedgerableType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end