modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/lib/modern_treasury/models/ledger_account_category.rb

@@ -16,8 +16,8 @@ module ModernTreasury
       #   available balance is the posted incoming entries minus the sum of the pending
       #   and posted outgoing amounts.
       #
-      #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances]
-      required :balances, -> { ModernTreasury::LedgerAccountCategory::Balances }
+      #   @return [ModernTreasury::Models::LedgerBalances]
+      required :balances, -> { ModernTreasury::LedgerBalances }
 
       # @!attribute created_at
       #
@@ -89,7 +89,7 @@ module ModernTreasury
       #
       #   @param id [String]
       #
-      #   @param balances [ModernTreasury::Models::LedgerAccountCategory::Balances] The pending, posted, and available balances for this ledger account category. Th
+      #   @param balances [ModernTreasury::Models::LedgerBalances] The pending, posted, and available balances for this ledger account category. Th
       #
       #   @param created_at [Time]
       #
@@ -112,178 +112,6 @@ module ModernTreasury
       #   @param object [String]
       #
       #   @param updated_at [Time]
-
-      # @see ModernTreasury::Models::LedgerAccountCategory#balances
-      class Balances < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute available_balance
-        #   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.
-        #
-        #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances::AvailableBalance]
-        required :available_balance, -> { ModernTreasury::LedgerAccountCategory::Balances::AvailableBalance }
-
-        # @!attribute pending_balance
-        #   The pending_balance is the sum of all pending and posted entries.
-        #
-        #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance]
-        required :pending_balance, -> { ModernTreasury::LedgerAccountCategory::Balances::PendingBalance }
-
-        # @!attribute posted_balance
-        #   The posted_balance is the sum of all posted entries.
-        #
-        #   @return [ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance]
-        required :posted_balance, -> { ModernTreasury::LedgerAccountCategory::Balances::PostedBalance }
-
-        # @!method initialize(available_balance:, pending_balance:, posted_balance:)
-        #   Some parameter documentations has been truncated, see
-        #   {ModernTreasury::Models::LedgerAccountCategory::Balances} for more details.
-        #
-        #   The pending, posted, and available balances for this ledger account category.
-        #   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::LedgerAccountCategory::Balances::AvailableBalance] The available_balance is the sum of all posted inbound entries and pending outbo
-        #
-        #   @param pending_balance [ModernTreasury::Models::LedgerAccountCategory::Balances::PendingBalance] The pending_balance is the sum of all pending and posted entries.
-        #
-        #   @param posted_balance [ModernTreasury::Models::LedgerAccountCategory::Balances::PostedBalance] The posted_balance is the sum of all posted entries.
-
-        # @see ModernTreasury::Models::LedgerAccountCategory::Balances#available_balance
-        class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute amount
-          #
-          #   @return [Integer]
-          required :amount, Integer
-
-          # @!attribute credits
-          #
-          #   @return [Integer]
-          required :credits, Integer
-
-          # @!attribute currency
-          #   The currency of the ledger account.
-          #
-          #   @return [String]
-          required :currency, String
-
-          # @!attribute currency_exponent
-          #   The currency exponent of the ledger account.
-          #
-          #   @return [Integer]
-          required :currency_exponent, Integer
-
-          # @!attribute debits
-          #
-          #   @return [Integer]
-          required :debits, Integer
-
-          # @!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::LedgerAccountCategory::Balances#pending_balance
-        class PendingBalance < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute amount
-          #
-          #   @return [Integer]
-          required :amount, Integer
-
-          # @!attribute credits
-          #
-          #   @return [Integer]
-          required :credits, Integer
-
-          # @!attribute currency
-          #   The currency of the ledger account.
-          #
-          #   @return [String]
-          required :currency, String
-
-          # @!attribute currency_exponent
-          #   The currency exponent of the ledger account.
-          #
-          #   @return [Integer]
-          required :currency_exponent, Integer
-
-          # @!attribute debits
-          #
-          #   @return [Integer]
-          required :debits, Integer
-
-          # @!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::LedgerAccountCategory::Balances#posted_balance
-        class PostedBalance < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute amount
-          #
-          #   @return [Integer]
-          required :amount, Integer
-
-          # @!attribute credits
-          #
-          #   @return [Integer]
-          required :credits, Integer
-
-          # @!attribute currency
-          #   The currency of the ledger account.
-          #
-          #   @return [String]
-          required :currency, String
-
-          # @!attribute currency_exponent
-          #   The currency exponent of the ledger account.
-          #
-          #   @return [Integer]
-          required :currency_exponent, Integer
-
-          # @!attribute debits
-          #
-          #   @return [Integer]
-          required :debits, Integer
-
-          # @!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
   end
 end

data/lib/modern_treasury/models/ledger_account_category_list_params.rb

@@ -22,7 +22,8 @@ module ModernTreasury
       # @!attribute balances
       #   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.
       #
       #   @return [ModernTreasury::Models::LedgerAccountCategoryListParams::Balances, nil]
       optional :balances, -> { ModernTreasury::LedgerAccountCategoryListParams::Balances }
@@ -58,9 +59,11 @@ module ModernTreasury
       optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute name
+      #   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`.
       #
-      #   @return [String, nil]
-      optional :name, String
+      #   @return [Array<String>, nil]
+      optional :name, ModernTreasury::Internal::Type::ArrayOf[String]
 
       # @!attribute parent_ledger_account_category_id
       #   Query categories that are nested underneath a parent category
@@ -93,7 +96,7 @@ module ModernTreasury
       #
       #   @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
       #
-      #   @param name [String]
+      #   @param name [Array<String>] If you have specific names to retrieve in bulk, you can pass them as query param
       #
       #   @param parent_ledger_account_category_id [String] Query categories that are nested underneath a parent category
       #
@@ -110,7 +113,8 @@ module ModernTreasury
         # @!method initialize(effective_at: 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.
         #
         #   @param effective_at [Time]
       end

data/lib/modern_treasury/models/ledger_account_category_retrieve_params.rb

@@ -10,7 +10,8 @@ module ModernTreasury
       # @!attribute balances
       #   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.
       #
       #   @return [ModernTreasury::Models::LedgerAccountCategoryRetrieveParams::Balances, nil]
       optional :balances, -> { ModernTreasury::LedgerAccountCategoryRetrieveParams::Balances }
@@ -37,7 +38,8 @@ module ModernTreasury
         # @!method initialize(as_of_date: nil, effective_at: 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.
         #
         #   @param as_of_date [Date]
         #   @param effective_at [Time]

data/lib/modern_treasury/models/ledger_account_create_params.rb

@@ -3,115 +3,12 @@
 module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::LedgerAccounts#create
-    class LedgerAccountCreateParams < ModernTreasury::Internal::Type::BaseModel
+    class LedgerAccountCreateParams < ModernTreasury::Models::LedgerAccountCreateRequest
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!attribute currency
-      #   The currency of the ledger account.
-      #
-      #   @return [String]
-      required :currency, String
-
-      # @!attribute ledger_id
-      #   The id of the ledger that this account belongs to.
-      #
-      #   @return [String]
-      required :ledger_id, String
-
-      # @!attribute name
-      #   The name of the ledger account.
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute normal_balance
-      #   The normal balance of the ledger account.
-      #
-      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
-      required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
-
-      # @!attribute currency_exponent
-      #   The currency exponent of the ledger account.
-      #
-      #   @return [Integer, nil]
-      optional :currency_exponent, Integer, nil?: true
-
-      # @!attribute description
-      #   The description of the ledger account.
-      #
-      #   @return [String, nil]
-      optional :description, String, nil?: true
-
-      # @!attribute ledger_account_category_ids
-      #   The array of ledger account category ids that this ledger account should be a
-      #   child of.
-      #
-      #   @return [Array<String>, nil]
-      optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
-
-      # @!attribute ledgerable_id
-      #   If the ledger account links to another object in Modern Treasury, the id will be
-      #   populated here, otherwise null.
-      #
-      #   @return [String, nil]
-      optional :ledgerable_id, String
-
-      # @!attribute ledgerable_type
-      #   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.
-      #
-      #   @return [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType, nil]
-      optional :ledgerable_type, enum: -> { ModernTreasury::LedgerAccountCreateParams::LedgerableType }
-
-      # @!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]
-
-      # @!method initialize(currency:, ledger_id:, name:, normal_balance:, currency_exponent: nil, description: nil, ledger_account_category_ids: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ModernTreasury::Models::LedgerAccountCreateParams} for more details.
-      #
-      #   @param currency [String] The currency of the ledger account.
-      #
-      #   @param ledger_id [String] The id of the ledger that this account belongs to.
-      #
-      #   @param name [String] The name of the ledger account.
-      #
-      #   @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
-      #
-      #   @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
-      #
-      #   @param description [String, nil] The description of the ledger account.
-      #
-      #   @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
-      #
-      #   @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
-      #
-      #   @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerAccountCreateParams::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
-      #
-      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
-      #
+      # @!method initialize(request_options: {})
       #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-
-      # 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
-
-        COUNTERPARTY = :counterparty
-        EXTERNAL_ACCOUNT = :external_account
-        INTERNAL_ACCOUNT = :internal_account
-        VIRTUAL_ACCOUNT = :virtual_account
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/modern_treasury/models/ledger_account_create_request.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LedgerAccountCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute currency
+      #   The currency of the ledger account.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute ledger_id
+      #   The id of the ledger that this account belongs to.
+      #
+      #   @return [String]
+      required :ledger_id, String
+
+      # @!attribute name
+      #   The name of the ledger account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute normal_balance
+      #   The normal balance of the ledger account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :normal_balance, enum: -> { ModernTreasury::TransactionDirection }
+
+      # @!attribute currency_exponent
+      #   The currency exponent of the ledger account.
+      #
+      #   @return [Integer, nil]
+      optional :currency_exponent, Integer, nil?: true
+
+      # @!attribute description
+      #   The description of the ledger account.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute ledger_account_category_ids
+      #   The array of ledger account category ids that this ledger account should be a
+      #   child of.
+      #
+      #   @return [Array<String>, nil]
+      optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
+
+      # @!attribute ledgerable_id
+      #   If the ledger account links to another object in Modern Treasury, the id will be
+      #   populated here, otherwise null.
+      #
+      #   @return [String, nil]
+      optional :ledgerable_id, String
+
+      # @!attribute ledgerable_type
+      #   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.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LedgerAccountCreateRequest::LedgerableType, nil]
+      optional :ledgerable_type, enum: -> { ModernTreasury::LedgerAccountCreateRequest::LedgerableType }
+
+      # @!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]
+
+      # @!method initialize(currency:, ledger_id:, name:, normal_balance:, currency_exponent: nil, description: nil, ledger_account_category_ids: nil, ledgerable_id: nil, ledgerable_type: nil, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::LedgerAccountCreateRequest} for more details.
+      #
+      #   @param currency [String] The currency of the ledger account.
+      #
+      #   @param ledger_id [String] The id of the ledger that this account belongs to.
+      #
+      #   @param name [String] The name of the ledger account.
+      #
+      #   @param normal_balance [Symbol, ModernTreasury::Models::TransactionDirection] The normal balance of the ledger account.
+      #
+      #   @param currency_exponent [Integer, nil] The currency exponent of the ledger account.
+      #
+      #   @param description [String, nil] The description of the ledger account.
+      #
+      #   @param ledger_account_category_ids [Array<String>] The array of ledger account category ids that this ledger account should be a ch
+      #
+      #   @param ledgerable_id [String] If the ledger account links to another object in Modern Treasury, the id will be
+      #
+      #   @param ledgerable_type [Symbol, ModernTreasury::Models::LedgerAccountCreateRequest::LedgerableType] If the ledger account links to another object in Modern Treasury, the type will
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+
+      # 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.
+      #
+      # @see ModernTreasury::Models::LedgerAccountCreateRequest#ledgerable_type
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
+
+        COUNTERPARTY = :counterparty
+        EXTERNAL_ACCOUNT = :external_account
+        INTERNAL_ACCOUNT = :internal_account
+        VIRTUAL_ACCOUNT = :virtual_account
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end