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

data/lib/modern_treasury/models/ledger_account_settlement_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountSettlementUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerAccountSettlements#update
+    class LedgerAccountSettlementUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute description
       #   The description of the ledger account settlement.
@@ -15,10 +16,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -26,7 +27,7 @@ module ModernTreasury
 
       # @!attribute [r] status
       #   To post a pending ledger account settlement, use `posted`. To archive a pending
-      #     ledger transaction, use `archived`.
+      #   ledger transaction, use `archived`.
       #
       #   @return [Symbol, ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status, nil]
       optional :status, enum: -> { ModernTreasury::Models::LedgerAccountSettlementUpdateParams::Status }
@@ -43,23 +44,13 @@ module ModernTreasury
       #   #
       #   def initialize(description: nil, metadata: nil, status: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # To post a pending ledger account settlement, use `posted`. To archive a pending
-      #   ledger transaction, use `archived`.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :posted
-      #   # ...
-      # in :archived
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # ledger transaction, use `archived`.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         POSTED = :posted
         ARCHIVED = :archived
 
@@ -67,7 +58,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

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

@@ -3,25 +3,26 @@
 module ModernTreasury
   module Models
     module LedgerAccountSettlements
-      class AccountEntryDeleteParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::LedgerAccountSettlements::AccountEntries#delete
+      class AccountEntryDeleteParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute ledger_entry_ids
         #   The ids of the ledger entries that are to be added or removed from the ledger
-        #     account settlement.
+        #   account settlement.
         #
-        #   @return [Array<Object>, nil]
-        required :ledger_entry_ids, ModernTreasury::ArrayOf[ModernTreasury::Unknown], nil?: true
+        #   @return [Array<String>, nil]
+        required :ledger_entry_ids, ModernTreasury::Internal::Type::ArrayOf[String], nil?: true
 
         # @!parse
-        #   # @param ledger_entry_ids [Array<Object>, nil]
+        #   # @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::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

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

@@ -3,17 +3,18 @@
 module ModernTreasury
   module Models
     module LedgerAccountSettlements
-      class AccountEntryUpdateParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::LedgerAccountSettlements::AccountEntries#update
+      class AccountEntryUpdateParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute ledger_entry_ids
         #   The ids of the ledger entries that are to be added or removed from the ledger
-        #     account settlement.
+        #   account settlement.
         #
         #   @return [Array<String>, nil]
-        required :ledger_entry_ids, ModernTreasury::ArrayOf[String], nil?: true
+        required :ledger_entry_ids, ModernTreasury::Internal::Type::ArrayOf[String], nil?: true
 
         # @!parse
         #   # @param ledger_entry_ids [Array<String>, nil]
@@ -21,7 +22,7 @@ module ModernTreasury
         #   #
         #   def initialize(ledger_entry_ids:, request_options: {}, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/ledger_account_statement_create_params.rb

@@ -2,28 +2,29 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountStatementCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerAccountStatements#create
+    class LedgerAccountStatementCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute effective_at_lower_bound
       #   The inclusive lower bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account statement.
+      #   be included in the ledger account statement.
       #
       #   @return [Time]
       required :effective_at_lower_bound, Time
 
       # @!attribute effective_at_upper_bound
       #   The exclusive upper bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account statement.
+      #   be included in the ledger account statement.
       #
       #   @return [Time]
       required :effective_at_upper_bound, Time
 
       # @!attribute ledger_account_id
       #   The id of the ledger account whose ledger entries are queried against, and its
-      #     balances are computed as a result.
+      #   balances are computed as a result.
       #
       #   @return [String]
       required :ledger_account_id, String
@@ -36,10 +37,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -65,7 +66,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/ledger_account_statement_create_response.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountStatementCreateResponse < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerAccountStatements#create
+    class LedgerAccountStatementCreateResponse < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -21,24 +22,24 @@ module ModernTreasury
 
       # @!attribute effective_at_lower_bound
       #   The inclusive lower bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account statement.
+      #   be included in the ledger account statement.
       #
       #   @return [Time]
       required :effective_at_lower_bound, Time
 
       # @!attribute effective_at_upper_bound
       #   The exclusive upper bound of the effective_at timestamp of the ledger entries to
-      #     be included in the ledger account statement.
+      #   be included in the ledger account statement.
       #
       #   @return [Time]
       required :effective_at_upper_bound, Time
 
       # @!attribute ending_balance
       #   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.
+      #   `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.
       #
       #   @return [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance]
       required :ending_balance,
@@ -46,7 +47,7 @@ module ModernTreasury
 
       # @!attribute ledger_account_id
       #   The id of the ledger account whose ledger entries are queried against, and its
-      #     balances are computed as a result.
+      #   balances are computed as a result.
       #
       #   @return [String]
       required :ledger_account_id, String
@@ -71,17 +72,17 @@ module ModernTreasury
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
-      #     if it exists in the test environment.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, ModernTreasury::HashOf[String]
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute object
       #
@@ -90,10 +91,10 @@ module ModernTreasury
 
       # @!attribute starting_balance
       #   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.
+      #   `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.
       #
       #   @return [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance]
       required :starting_balance,
@@ -142,14 +143,15 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class EndingBalance < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse#ending_balance
+      class EndingBalance < 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.
+        #   outbound entries. For credit normal, available_amount = posted_credits -
+        #   pending_debits; for debit normal, available_amount = posted_debits -
+        #   pending_credits.
         #
         #   @return [ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance::AvailableBalance]
         required :available_balance,
@@ -171,10 +173,10 @@ module ModernTreasury
 
         # @!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.
+        #   # `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]
@@ -182,9 +184,10 @@ module ModernTreasury
         #   #
         #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        class AvailableBalance < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance#available_balance
+        class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
           #   @return [Integer]
@@ -214,9 +217,9 @@ module ModernTreasury
 
           # @!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.
+          #   # 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]
@@ -226,10 +229,11 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
-        class PendingBalance < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance#pending_balance
+        class PendingBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
           #   @return [Integer]
@@ -268,10 +272,11 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
-        class PostedBalance < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::EndingBalance#posted_balance
+        class PostedBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
           #   @return [Integer]
@@ -310,16 +315,17 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
       end
 
-      class StartingBalance < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse#starting_balance
+      class StartingBalance < 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.
+        #   outbound entries. For credit normal, available_amount = posted_credits -
+        #   pending_debits; for debit normal, available_amount = posted_debits -
+        #   pending_credits.
         #
         #   @return [ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance::AvailableBalance]
         required :available_balance,
@@ -341,10 +347,10 @@ module ModernTreasury
 
         # @!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.
+        #   # `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]
@@ -352,9 +358,10 @@ module ModernTreasury
         #   #
         #   def initialize(available_balance:, pending_balance:, posted_balance:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        class AvailableBalance < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance#available_balance
+        class AvailableBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
           #   @return [Integer]
@@ -384,9 +391,9 @@ module ModernTreasury
 
           # @!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.
+          #   # 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]
@@ -396,10 +403,11 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
-        class PendingBalance < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance#pending_balance
+        class PendingBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
           #   @return [Integer]
@@ -438,10 +446,11 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
-        class PostedBalance < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::LedgerAccountStatementCreateResponse::StartingBalance#posted_balance
+        class PostedBalance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #
           #   @return [Integer]
@@ -480,7 +489,7 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, credits:, currency:, currency_exponent:, debits:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
       end
     end

data/lib/modern_treasury/models/ledger_account_statement_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerAccountStatementRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerAccountStatements#retrieve
+    class LedgerAccountStatementRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   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::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end