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

data/lib/modern_treasury/models/ledger_account.rb

@@ -16,8 +16,8 @@ module ModernTreasury
       #   is the posted incoming entries minus the sum of the pending and posted outgoing
       #   amounts.
       #
-      #   @return [ModernTreasury::Models::LedgerAccount::Balances]
-      required :balances, -> { ModernTreasury::Models::LedgerAccount::Balances }
+      #   @return [ModernTreasury::LedgerAccount::Balances]
+      required :balances, -> { ModernTreasury::LedgerAccount::Balances }
 
       # @!attribute created_at
       #
@@ -53,8 +53,8 @@ module ModernTreasury
       #   be populated here, otherwise null. The value is one of internal_account or
       #   external_account.
       #
-      #   @return [Symbol, ModernTreasury::Models::LedgerAccount::LedgerableType, nil]
-      required :ledgerable_type, enum: -> { ModernTreasury::Models::LedgerAccount::LedgerableType }, nil?: true
+      #   @return [Symbol, ModernTreasury::LedgerAccount::LedgerableType, nil]
+      required :ledgerable_type, enum: -> { ModernTreasury::LedgerAccount::LedgerableType }, nil?: true
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
@@ -85,8 +85,8 @@ module ModernTreasury
       # @!attribute normal_balance
       #   The normal balance of the ledger account.
       #
-      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
-      required :normal_balance, enum: -> { ModernTreasury::Models::TransactionDirection }
+      #   @return [Symbol, ModernTreasury::TransactionDirection]
+      required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
 
       # @!attribute object
       #
@@ -98,47 +98,41 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param balances [ModernTreasury::Models::LedgerAccount::Balances]
-      #   # @param created_at [Time]
-      #   # @param description [String, nil]
-      #   # @param discarded_at [Time, nil]
-      #   # @param ledger_id [String]
-      #   # @param ledgerable_id [String, nil]
-      #   # @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerAccount::LedgerableType, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param lock_version [Integer]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param name [String]
-      #   # @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection]
-      #   # @param object [String]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     balances:,
-      #     created_at:,
-      #     description:,
-      #     discarded_at:,
-      #     ledger_id:,
-      #     ledgerable_id:,
-      #     ledgerable_type:,
-      #     live_mode:,
-      #     lock_version:,
-      #     metadata:,
-      #     name:,
-      #     normal_balance:,
-      #     object:,
-      #     updated_at:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
-
-      # @see ModernTreasury::Models::LedgerAccount#balances
+      # @!method initialize(id:, balances:, created_at:, description:, discarded_at:, ledger_id:, ledgerable_id:, ledgerable_type:, live_mode:, lock_version:, metadata:, name:, normal_balance:, object:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::LedgerAccount} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param balances [ModernTreasury::LedgerAccount::Balances] The pending, posted, and available balances for this ledger account. The posted
+      #
+      #   @param created_at [Time]
+      #
+      #   @param description [String, nil] The description of the ledger account.
+      #
+      #   @param discarded_at [Time, nil]
+      #
+      #   @param ledger_id [String] The id of the ledger that this account belongs to.
+      #
+      #   @param ledgerable_id [String, nil] If the ledger account links to another object in Modern Treasury, the id will be
+      #
+      #   @param ledgerable_type [Symbol, ModernTreasury::LedgerAccount::LedgerableType, nil] If the ledger account links to another object in Modern Treasury, the type will
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param lock_version [Integer] Lock version of the ledger account.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param name [String] The name of the ledger account.
+      #
+      #   @param normal_balance [Symbol, ModernTreasury::TransactionDirection] The normal balance of the ledger account.
+      #
+      #   @param object [String]
+      #
+      #   @param updated_at [Time]
+
+      # @see ModernTreasury::LedgerAccount#balances
       class Balances < ModernTreasury::Internal::Type::BaseModel
         # @!attribute available_balance
         #   The available_balance is the sum of all posted inbound entries and pending
@@ -146,8 +140,8 @@ module ModernTreasury
         #   pending_debits; for debit normal, available_amount = posted_debits -
         #   pending_credits.
         #
-        #   @return [ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance]
-        required :available_balance, -> { ModernTreasury::Models::LedgerAccount::Balances::AvailableBalance }
+        #   @return [ModernTreasury::LedgerAccount::Balances::AvailableBalance]
+        required :available_balance, -> { ModernTreasury::LedgerAccount::Balances::AvailableBalance }
 
         # @!attribute effective_at_lower_bound
         #   The inclusive lower bound of the effective_at timestamp for the returned
@@ -166,42 +160,36 @@ module ModernTreasury
         # @!attribute pending_balance
         #   The pending_balance is the sum of all pending and posted entries.
         #
-        #   @return [ModernTreasury::Models::LedgerAccount::Balances::PendingBalance]
-        required :pending_balance, -> { ModernTreasury::Models::LedgerAccount::Balances::PendingBalance }
+        #   @return [ModernTreasury::LedgerAccount::Balances::PendingBalance]
+        required :pending_balance, -> { ModernTreasury::LedgerAccount::Balances::PendingBalance }
 
         # @!attribute posted_balance
         #   The posted_balance is the sum of all posted entries.
         #
-        #   @return [ModernTreasury::Models::LedgerAccount::Balances::PostedBalance]
-        required :posted_balance, -> { ModernTreasury::Models::LedgerAccount::Balances::PostedBalance }
-
-        # @!parse
-        #   # The pending, posted, and available balances for this ledger account. 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::LedgerAccount::Balances::AvailableBalance]
-        #   # @param effective_at_lower_bound [Time, nil]
-        #   # @param effective_at_upper_bound [Time, nil]
-        #   # @param pending_balance [ModernTreasury::Models::LedgerAccount::Balances::PendingBalance]
-        #   # @param posted_balance [ModernTreasury::Models::LedgerAccount::Balances::PostedBalance]
-        #   #
-        #   def initialize(
-        #     available_balance:,
-        #     effective_at_lower_bound:,
-        #     effective_at_upper_bound:,
-        #     pending_balance:,
-        #     posted_balance:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
-
-        # @see ModernTreasury::Models::LedgerAccount::Balances#available_balance
+        #   @return [ModernTreasury::LedgerAccount::Balances::PostedBalance]
+        required :posted_balance, -> { ModernTreasury::LedgerAccount::Balances::PostedBalance }
+
+        # @!method initialize(available_balance:, effective_at_lower_bound:, effective_at_upper_bound:, pending_balance:, posted_balance:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::LedgerAccount::Balances} for more details.
+        #
+        #   The pending, posted, and available balances for this ledger account. 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::LedgerAccount::Balances::AvailableBalance] The available_balance is the sum of all posted inbound entries and pending outbo
+        #
+        #   @param effective_at_lower_bound [Time, nil] The inclusive lower bound of the effective_at timestamp for the returned balance
+        #
+        #   @param effective_at_upper_bound [Time, nil] The exclusive upper bound of the effective_at timestamp for the returned balance
+        #
+        #   @param pending_balance [ModernTreasury::LedgerAccount::Balances::PendingBalance] The pending_balance is the sum of all pending and posted entries.
+        #
+        #   @param posted_balance [ModernTreasury::LedgerAccount::Balances::PostedBalance] The posted_balance is the sum of all posted entries.
+
+        # @see ModernTreasury::LedgerAccount::Balances#available_balance
         class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
@@ -230,24 +218,24 @@ 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::LedgerAccount::Balances#pending_balance
+        # @see ModernTreasury::LedgerAccount::Balances#pending_balance
         class PendingBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
@@ -276,21 +264,21 @@ 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::LedgerAccount::Balances#posted_balance
+        # @see ModernTreasury::LedgerAccount::Balances#posted_balance
         class PostedBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
@@ -319,18 +307,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
 
@@ -338,7 +326,7 @@ module ModernTreasury
       # be populated here, otherwise null. The value is one of internal_account or
       # external_account.
       #
-      # @see ModernTreasury::Models::LedgerAccount#ledgerable_type
+      # @see ModernTreasury::LedgerAccount#ledgerable_type
       module LedgerableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -347,11 +335,8 @@ module ModernTreasury
         INTERNAL_ACCOUNT = :internal_account
         VIRTUAL_ACCOUNT = :virtual_account
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end