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

data/lib/modern_treasury/models/ledger_account_settlements/account_entry_update_params.rb

@@ -5,8 +5,7 @@ module ModernTreasury
     module LedgerAccountSettlements
       # @see ModernTreasury::Resources::LedgerAccountSettlements::AccountEntries#update
       class AccountEntryUpdateParams < ModernTreasury::Internal::Type::BaseModel
-        # @!parse
-        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        extend ModernTreasury::Internal::Type::RequestParameters::Converter
         include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute ledger_entry_ids
@@ -16,13 +15,14 @@ module ModernTreasury
         #   @return [Array<String>, nil]
         required :ledger_entry_ids, ModernTreasury::Internal::Type::ArrayOf[String], nil?: true
 
-        # @!parse
-        #   # @param ledger_entry_ids [Array<String>, nil]
-        #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(ledger_entry_ids:, request_options: {}, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(ledger_entry_ids:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LedgerAccountSettlements::AccountEntryUpdateParams} for
+        #   more details.
+        #
+        #   @param ledger_entry_ids [Array<String>, nil] The ids of the ledger entries that are to be added or removed from the ledger ac
+        #
+        #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

data/lib/modern_treasury/models/ledger_account_statement_create_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::LedgerAccountStatements#create
     class LedgerAccountStatementCreateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute effective_at_lower_bound
@@ -35,38 +34,28 @@ module ModernTreasury
       #   @return [String, nil]
       optional :description, String, nil?: true
 
-      # @!attribute [r] metadata
+      # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
       #   strings.
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
-      # @!parse
-      #   # @return [Hash{Symbol=>String}]
-      #   attr_writer :metadata
-
-      # @!parse
-      #   # @param effective_at_lower_bound [Time]
-      #   # @param effective_at_upper_bound [Time]
-      #   # @param ledger_account_id [String]
-      #   # @param description [String, nil]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     effective_at_lower_bound:,
-      #     effective_at_upper_bound:,
-      #     ledger_account_id:,
-      #     description: nil,
-      #     metadata: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(effective_at_lower_bound:, effective_at_upper_bound:, ledger_account_id:, description: nil, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::LedgerAccountStatementCreateParams} for more details.
+      #
+      #   @param effective_at_lower_bound [Time] The inclusive lower bound of the effective_at timestamp of the ledger entries to
+      #
+      #   @param effective_at_upper_bound [Time] The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #
+      #   @param ledger_account_id [String] The id of the ledger account whose ledger entries are queried against, and its b
+      #
+      #   @param description [String, nil] The description of the ledger account statement.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/ledger_account_statement_create_response.rb

@@ -61,8 +61,8 @@ module ModernTreasury
       # @!attribute ledger_account_normal_balance
       #   The normal balance of the ledger account.
       #
-      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
-      required :ledger_account_normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
+      #   @return [Symbol, ModernTreasury::TransactionDirection]
+      required :ledger_account_normal_balance, enum: -> { ModernTreasury::TransactionDirection }
 
       # @!attribute ledger_id
       #   The id of the ledger that this ledger account statement belongs to.
@@ -105,45 +105,39 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param created_at [Time]
-      #   # @param description [String, nil]
-      #   # @param effective_at_lower_bound [Time]
-      #   # @param effective_at_upper_bound [Time]
-      #   # @param ending_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance]
-      #   # @param ledger_account_id [String]
-      #   # @param ledger_account_lock_version [Integer]
-      #   # @param ledger_account_normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
-      #   # @param ledger_id [String]
-      #   # @param live_mode [Boolean]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param object [String]
-      #   # @param starting_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     created_at:,
-      #     description:,
-      #     effective_at_lower_bound:,
-      #     effective_at_upper_bound:,
-      #     ending_balance:,
-      #     ledger_account_id:,
-      #     ledger_account_lock_version:,
-      #     ledger_account_normal_balance:,
-      #     ledger_id:,
-      #     live_mode:,
-      #     metadata:,
-      #     object:,
-      #     starting_balance:,
-      #     updated_at:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, created_at:, description:, effective_at_lower_bound:, effective_at_upper_bound:, ending_balance:, ledger_account_id:, ledger_account_lock_version:, ledger_account_normal_balance:, ledger_id:, live_mode:, metadata:, object:, starting_balance:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::LedgerAccountStatementCreateResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param description [String, nil] The description of the ledger account statement.
+      #
+      #   @param effective_at_lower_bound [Time] The inclusive lower bound of the effective_at timestamp of the ledger entries to
+      #
+      #   @param effective_at_upper_bound [Time] The exclusive upper bound of the effective_at timestamp of the ledger entries to
+      #
+      #   @param ending_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance] The pending, posted, and available balances for this ledger account at the `effe
+      #
+      #   @param ledger_account_id [String] The id of the ledger account whose ledger entries are queried against, and its b
+      #
+      #   @param ledger_account_lock_version [Integer] Lock version of the ledger account at the time of statement generation.
+      #
+      #   @param ledger_account_normal_balance [Symbol, ModernTreasury::TransactionDirection] The normal balance of the ledger account.
+      #
+      #   @param ledger_id [String] The id of the ledger that this ledger account statement belongs to.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param object [String]
+      #
+      #   @param starting_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance] The pending, posted, and available balances for this ledger account at the `effe
+      #
+      #   @param updated_at [Time]
 
       # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse#ending_balance
       class EndingBalance < ModernTreasury::Internal::Type::BaseModel
@@ -171,20 +165,22 @@ module ModernTreasury
         required :posted_balance,
                  -> { ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::PostedBalance }
 
-        # @!parse
-        #   # The pending, posted, and available balances for this ledger account at the
-        #   # `effective_at_upper_bound`. The posted balance is the sum of all posted entries
-        #   # on the account. The pending balance is the sum of all pending and posted entries
-        #   # on the account. The available balance is the posted incoming entries minus the
-        #   # sum of the pending and posted outgoing amounts.
-        #   #
-        #   # @param available_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::AvailableBalance]
-        #   # @param pending_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::PendingBalance]
-        #   # @param posted_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::PostedBalance]
-        #   #
-        #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(available_balance:, pending_balance:, posted_balance:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance}
+        #   for more details.
+        #
+        #   The pending, posted, and available balances for this ledger account at the
+        #   `effective_at_upper_bound`. The posted balance is the sum of all posted entries
+        #   on the account. The pending balance is the sum of all pending and posted entries
+        #   on the account. The available balance is the posted incoming entries minus the
+        #   sum of the pending and posted outgoing amounts.
+        #
+        #   @param available_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::AvailableBalance] The available_balance is the sum of all posted inbound entries and pending outbo
+        #
+        #   @param pending_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::PendingBalance] The pending_balance is the sum of all pending and posted entries.
+        #
+        #   @param posted_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::PostedBalance] The posted_balance is the sum of all posted entries.
 
         # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance#available_balance
         class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
@@ -215,21 +211,21 @@ module ModernTreasury
           #   @return [Integer]
           required :debits, Integer
 
-          # @!parse
-          #   # The available_balance is the sum of all posted inbound entries and pending
-          #   # outbound entries. For credit normal, available_amount = posted_credits -
-          #   # pending_debits; for debit normal, available_amount = posted_debits -
-          #   # pending_credits.
-          #   #
-          #   # @param amount [Integer]
-          #   # @param credits [Integer]
-          #   # @param currency [String]
-          #   # @param currency_exponent [Integer]
-          #   # @param debits [Integer]
-          #   #
-          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          #   The available_balance is the sum of all posted inbound entries and pending
+          #   outbound entries. For credit normal, available_amount = posted_credits -
+          #   pending_debits; for debit normal, available_amount = posted_debits -
+          #   pending_credits.
+          #
+          #   @param amount [Integer]
+          #
+          #   @param credits [Integer]
+          #
+          #   @param currency [String] The currency of the ledger account.
+          #
+          #   @param currency_exponent [Integer] The currency exponent of the ledger account.
+          #
+          #   @param debits [Integer]
         end
 
         # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance#pending_balance
@@ -261,18 +257,18 @@ module ModernTreasury
           #   @return [Integer]
           required :debits, Integer
 
-          # @!parse
-          #   # The pending_balance is the sum of all pending and posted entries.
-          #   #
-          #   # @param amount [Integer]
-          #   # @param credits [Integer]
-          #   # @param currency [String]
-          #   # @param currency_exponent [Integer]
-          #   # @param debits [Integer]
-          #   #
-          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          #   The pending_balance is the sum of all pending and posted entries.
+          #
+          #   @param amount [Integer]
+          #
+          #   @param credits [Integer]
+          #
+          #   @param currency [String] The currency of the ledger account.
+          #
+          #   @param currency_exponent [Integer] The currency exponent of the ledger account.
+          #
+          #   @param debits [Integer]
         end
 
         # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance#posted_balance
@@ -304,18 +300,18 @@ module ModernTreasury
           #   @return [Integer]
           required :debits, Integer
 
-          # @!parse
-          #   # The posted_balance is the sum of all posted entries.
-          #   #
-          #   # @param amount [Integer]
-          #   # @param credits [Integer]
-          #   # @param currency [String]
-          #   # @param currency_exponent [Integer]
-          #   # @param debits [Integer]
-          #   #
-          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          #   The posted_balance is the sum of all posted entries.
+          #
+          #   @param amount [Integer]
+          #
+          #   @param credits [Integer]
+          #
+          #   @param currency [String] The currency of the ledger account.
+          #
+          #   @param currency_exponent [Integer] The currency exponent of the ledger account.
+          #
+          #   @param debits [Integer]
         end
       end
 
@@ -345,20 +341,22 @@ module ModernTreasury
         required :posted_balance,
                  -> { ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::PostedBalance }
 
-        # @!parse
-        #   # The pending, posted, and available balances for this ledger account at the
-        #   # `effective_at_lower_bound`. The posted balance is the sum of all posted entries
-        #   # on the account. The pending balance is the sum of all pending and posted entries
-        #   # on the account. The available balance is the posted incoming entries minus the
-        #   # sum of the pending and posted outgoing amounts.
-        #   #
-        #   # @param available_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::AvailableBalance]
-        #   # @param pending_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::PendingBalance]
-        #   # @param posted_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::PostedBalance]
-        #   #
-        #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(available_balance:, pending_balance:, posted_balance:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance}
+        #   for more details.
+        #
+        #   The pending, posted, and available balances for this ledger account at the
+        #   `effective_at_lower_bound`. The posted balance is the sum of all posted entries
+        #   on the account. The pending balance is the sum of all pending and posted entries
+        #   on the account. The available balance is the posted incoming entries minus the
+        #   sum of the pending and posted outgoing amounts.
+        #
+        #   @param available_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::AvailableBalance] The available_balance is the sum of all posted inbound entries and pending outbo
+        #
+        #   @param pending_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::PendingBalance] The pending_balance is the sum of all pending and posted entries.
+        #
+        #   @param posted_balance [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::PostedBalance] The posted_balance is the sum of all posted entries.
 
         # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance#available_balance
         class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
@@ -389,21 +387,21 @@ module ModernTreasury
           #   @return [Integer]
           required :debits, Integer
 
-          # @!parse
-          #   # The available_balance is the sum of all posted inbound entries and pending
-          #   # outbound entries. For credit normal, available_amount = posted_credits -
-          #   # pending_debits; for debit normal, available_amount = posted_debits -
-          #   # pending_credits.
-          #   #
-          #   # @param amount [Integer]
-          #   # @param credits [Integer]
-          #   # @param currency [String]
-          #   # @param currency_exponent [Integer]
-          #   # @param debits [Integer]
-          #   #
-          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          #   The available_balance is the sum of all posted inbound entries and pending
+          #   outbound entries. For credit normal, available_amount = posted_credits -
+          #   pending_debits; for debit normal, available_amount = posted_debits -
+          #   pending_credits.
+          #
+          #   @param amount [Integer]
+          #
+          #   @param credits [Integer]
+          #
+          #   @param currency [String] The currency of the ledger account.
+          #
+          #   @param currency_exponent [Integer] The currency exponent of the ledger account.
+          #
+          #   @param debits [Integer]
         end
 
         # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance#pending_balance
@@ -435,18 +433,18 @@ module ModernTreasury
           #   @return [Integer]
           required :debits, Integer
 
-          # @!parse
-          #   # The pending_balance is the sum of all pending and posted entries.
-          #   #
-          #   # @param amount [Integer]
-          #   # @param credits [Integer]
-          #   # @param currency [String]
-          #   # @param currency_exponent [Integer]
-          #   # @param debits [Integer]
-          #   #
-          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          #   The pending_balance is the sum of all pending and posted entries.
+          #
+          #   @param amount [Integer]
+          #
+          #   @param credits [Integer]
+          #
+          #   @param currency [String] The currency of the ledger account.
+          #
+          #   @param currency_exponent [Integer] The currency exponent of the ledger account.
+          #
+          #   @param debits [Integer]
         end
 
         # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance#posted_balance
@@ -478,18 +476,18 @@ module ModernTreasury
           #   @return [Integer]
           required :debits, Integer
 
-          # @!parse
-          #   # The posted_balance is the sum of all posted entries.
-          #   #
-          #   # @param amount [Integer]
-          #   # @param credits [Integer]
-          #   # @param currency [String]
-          #   # @param currency_exponent [Integer]
-          #   # @param debits [Integer]
-          #   #
-          #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
-
-          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, credits:, currency:, currency_exponent:, debits:)
+          #   The posted_balance is the sum of all posted entries.
+          #
+          #   @param amount [Integer]
+          #
+          #   @param credits [Integer]
+          #
+          #   @param currency [String] The currency of the ledger account.
+          #
+          #   @param currency_exponent [Integer] The currency exponent of the ledger account.
+          #
+          #   @param debits [Integer]
         end
       end
     end

data/lib/modern_treasury/models/ledger_account_statement_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::LedgerAccountStatements#retrieve
     class LedgerAccountStatementRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end