modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/modern_treasury/models/ledger_event_handler.rb

@@ -3,7 +3,9 @@
 module ModernTreasury
   module Models
     # @deprecated
-    class LedgerEventHandler < ModernTreasury::BaseModel
+    #
+    # @see ModernTreasury::Resources::LedgerEventHandlers#create
+    class LedgerEventHandler < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -44,17 +46,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}, nil]
-      required :metadata, ModernTreasury::HashOf[String], nil?: true
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute name
       #   Name of the ledger event handler.
@@ -76,7 +78,7 @@ module ModernTreasury
       #
       #   @return [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil]
       required :variables,
-               -> { ModernTreasury::HashOf[ModernTreasury::Models::LedgerEventHandlerVariable] },
+               -> { ModernTreasury::Internal::Type::HashOf[ModernTreasury::Models::LedgerEventHandlerVariable] },
                nil?: true
 
       # @!parse
@@ -113,10 +115,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # @deprecated
-      class Conditions < ModernTreasury::BaseModel
+      #
+      # @see ModernTreasury::Models::LedgerEventHandler#conditions
+      class Conditions < ModernTreasury::Internal::Type::BaseModel
         # @!attribute field
         #   The LHS of the conditional.
         #
@@ -142,11 +146,13 @@ module ModernTreasury
         #   #
         #   def initialize(field:, operator:, value:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
       # @deprecated
-      class LedgerTransactionTemplate < ModernTreasury::BaseModel
+      #
+      # @see ModernTreasury::Models::LedgerEventHandler#ledger_transaction_template
+      class LedgerTransactionTemplate < ModernTreasury::Internal::Type::BaseModel
         # @!attribute description
         #   An optional description for internal use.
         #
@@ -155,7 +161,7 @@ module ModernTreasury
 
         # @!attribute effective_at
         #   The timestamp (ISO8601 format) at which the ledger transaction happened for
-        #     reporting purposes.
+        #   reporting purposes.
         #
         #   @return [String, nil]
         required :effective_at, String, nil?: true
@@ -165,7 +171,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry>]
         required :ledger_entries,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LedgerEventHandler::LedgerTransactionTemplate::LedgerEntry] }
 
         # @!attribute status
         #   To post a ledger transaction at creation, use `posted`.
@@ -181,10 +187,10 @@ module ModernTreasury
         #   #
         #   def initialize(description:, effective_at:, ledger_entries:, status:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # @deprecated
-        class LedgerEntry < ModernTreasury::BaseModel
+        class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #   The LHS of the conditional.
           #
@@ -210,7 +216,7 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, direction:, ledger_account_id:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
       end
     end

data/lib/modern_treasury/models/ledger_event_handler_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LedgerEventHandlerCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerEventHandlers#create
+    class LedgerEventHandlerCreateParams < 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_transaction_template
       #
@@ -44,16 +45,16 @@ module ModernTreasury
 
       # @!attribute 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], nil?: true
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute variables
       #
       #   @return [Hash{Symbol=>ModernTreasury::Models::LedgerEventHandlerVariable}, nil]
       optional :variables,
-               -> { ModernTreasury::HashOf[ModernTreasury::Models::LedgerEventHandlerVariable] },
+               -> { ModernTreasury::Internal::Type::HashOf[ModernTreasury::Models::LedgerEventHandlerVariable] },
                nil?: true
 
       # @!parse
@@ -80,10 +81,10 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # @deprecated
-      class LedgerTransactionTemplate < ModernTreasury::BaseModel
+      class LedgerTransactionTemplate < ModernTreasury::Internal::Type::BaseModel
         # @!attribute description
         #   An optional description for internal use.
         #
@@ -92,7 +93,7 @@ module ModernTreasury
 
         # @!attribute effective_at
         #   The timestamp (ISO8601 format) at which the ledger transaction happened for
-        #     reporting purposes.
+        #   reporting purposes.
         #
         #   @return [String, nil]
         required :effective_at, String, nil?: true
@@ -102,7 +103,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LedgerEventHandlerCreateParams::LedgerTransactionTemplate::LedgerEntry>]
         required :ledger_entries,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerEventHandlerCreateParams::LedgerTransactionTemplate::LedgerEntry] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LedgerEventHandlerCreateParams::LedgerTransactionTemplate::LedgerEntry] }
 
         # @!attribute status
         #   To post a ledger transaction at creation, use `posted`.
@@ -118,10 +119,10 @@ module ModernTreasury
         #   #
         #   def initialize(description:, effective_at:, ledger_entries:, status:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # @deprecated
-        class LedgerEntry < ModernTreasury::BaseModel
+        class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
           # @!attribute amount
           #   The LHS of the conditional.
           #
@@ -147,12 +148,12 @@ module ModernTreasury
           #   #
           #   def initialize(amount:, direction:, ledger_account_id:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
       end
 
       # @deprecated
-      class Conditions < ModernTreasury::BaseModel
+      class Conditions < ModernTreasury::Internal::Type::BaseModel
         # @!attribute field
         #   The LHS of the conditional.
         #
@@ -178,7 +179,7 @@ module ModernTreasury
         #   #
         #   def initialize(field:, operator:, value:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/ledger_event_handler_delete_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerEventHandlerDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerEventHandlers#delete
+    class LedgerEventHandlerDeleteParams < 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

data/lib/modern_treasury/models/ledger_event_handler_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LedgerEventHandlerListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerEventHandlers#list
+    class LedgerEventHandlerListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -14,11 +15,11 @@ module ModernTreasury
 
       # @!attribute [r] created_at
       #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-      #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
+      #   posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+      #   created_at%5Bgt%5D=2000-01-01T12:00:00Z.
       #
       #   @return [Hash{Symbol=>Time}, nil]
-      optional :created_at, ModernTreasury::HashOf[Time]
+      optional :created_at, ModernTreasury::Internal::Type::HashOf[Time]
 
       # @!parse
       #   # @return [Hash{Symbol=>Time}]
@@ -26,11 +27,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -64,7 +65,7 @@ module ModernTreasury
       #   #
       #   def initialize(after_cursor: nil, created_at: nil, metadata: nil, name: nil, per_page: nil, 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_event_handler_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerEventHandlerRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerEventHandlers#retrieve
+    class LedgerEventHandlerRetrieveParams < 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

data/lib/modern_treasury/models/ledger_event_handler_variable.rb

@@ -3,7 +3,7 @@
 module ModernTreasury
   module Models
     # @deprecated
-    class LedgerEventHandlerVariable < ModernTreasury::BaseModel
+    class LedgerEventHandlerVariable < ModernTreasury::Internal::Type::BaseModel
       # @!attribute query
       #
       #   @return [ModernTreasury::Models::LedgerEventHandlerVariable::Query]
@@ -11,7 +11,7 @@ module ModernTreasury
 
       # @!attribute type
       #   The type of object this variable is. Currently, only "ledger_account" is
-      #     supported.
+      #   supported.
       #
       #   @return [String]
       required :type, String
@@ -22,10 +22,12 @@ module ModernTreasury
       #   #
       #   def initialize(query:, type:, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # @deprecated
-      class Query < ModernTreasury::BaseModel
+      #
+      # @see ModernTreasury::Models::LedgerEventHandlerVariable#query
+      class Query < ModernTreasury::Internal::Type::BaseModel
         # @!attribute field
         #   The LHS of the conditional.
         #
@@ -51,7 +53,7 @@ module ModernTreasury
         #   #
         #   def initialize(field:, operator:, value:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/ledger_list_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Ledgers#list
+    class LedgerListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute [r] id
       #   If you have specific IDs to retrieve in bulk, you can pass them as query
-      #     parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
+      #   parameters delimited with `id[]=`, for example `?id[]=123&id[]=abc`.
       #
       #   @return [Array<String>, nil]
-      optional :id, ModernTreasury::ArrayOf[String]
+      optional :id, ModernTreasury::Internal::Type::ArrayOf[String]
 
       # @!parse
       #   # @return [Array<String>]
@@ -25,11 +26,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -46,11 +47,11 @@ module ModernTreasury
 
       # @!attribute [r] updated_at
       #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-      #     posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
-      #     updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
+      #   posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+      #   updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
       #
       #   @return [Hash{Symbol=>Time}, nil]
-      optional :updated_at, ModernTreasury::HashOf[Time]
+      optional :updated_at, ModernTreasury::Internal::Type::HashOf[Time]
 
       # @!parse
       #   # @return [Hash{Symbol=>Time}]
@@ -66,7 +67,7 @@ module ModernTreasury
       #   #
       #   def initialize(id: nil, after_cursor: nil, metadata: nil, per_page: nil, updated_at: nil, 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_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Ledgers#retrieve
+    class LedgerRetrieveParams < 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

data/lib/modern_treasury/models/ledger_transaction.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class LedgerTransaction < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerTransactions#create
+    class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -21,21 +22,21 @@ module ModernTreasury
 
       # @!attribute effective_at
       #   The timestamp (ISO8601 format) at which the ledger transaction happened for
-      #     reporting purposes.
+      #   reporting purposes.
       #
       #   @return [Time]
       required :effective_at, Time
 
       # @!attribute effective_date
       #   The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-      #     purposes.
+      #   purposes.
       #
       #   @return [Date]
       required :effective_date, Date
 
       # @!attribute external_id
       #   A unique string to represent the ledger transaction. Only one pending or posted
-      #     ledger transaction may have this ID in the ledger.
+      #   ledger transaction may have this ID in the ledger.
       #
       #   @return [String, nil]
       required :external_id, String, nil?: true
@@ -44,7 +45,8 @@ module ModernTreasury
       #   An array of ledger entry objects.
       #
       #   @return [Array<ModernTreasury::Models::LedgerEntry>]
-      required :ledger_entries, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerEntry] }
+      required :ledger_entries,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LedgerEntry] }
 
       # @!attribute ledger_id
       #   The ID of the ledger this ledger transaction belongs to.
@@ -54,16 +56,16 @@ module ModernTreasury
 
       # @!attribute ledgerable_id
       #   If the ledger transaction can be reconciled to another object in Modern
-      #     Treasury, the id will be populated here, otherwise null.
+      #   Treasury, the id will be populated here, otherwise null.
       #
       #   @return [String, nil]
       required :ledgerable_id, String, nil?: true
 
       # @!attribute ledgerable_type
       #   If the ledger transaction can be reconciled to another object in Modern
-      #     Treasury, the type will be populated here, otherwise null. This can be one of
-      #     payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      #     reversal.
+      #   Treasury, the type will be populated here, otherwise null. This can be one of
+      #   payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
+      #   reversal.
       #
       #   @return [Symbol, ModernTreasury::Models::LedgerTransaction::LedgerableType, nil]
       required :ledgerable_type,
@@ -72,17 +74,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
       #
@@ -97,7 +99,7 @@ module ModernTreasury
 
       # @!attribute posted_at
       #   The time on which the ledger transaction posted. This is null if the ledger
-      #     transaction is pending.
+      #   transaction is pending.
       #
       #   @return [Time, nil]
       required :posted_at, Time, nil?: true
@@ -171,14 +173,16 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # If the ledger transaction can be reconciled to another object in Modern
-      #   Treasury, the type will be populated here, otherwise null. This can be one of
-      #   payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
-      #   reversal.
+      # Treasury, the type will be populated here, otherwise null. This can be one of
+      # payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
+      # reversal.
+      #
+      # @see ModernTreasury::Models::LedgerTransaction#ledgerable_type
       module LedgerableType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         EXPECTED_PAYMENT = :expected_payment
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
@@ -195,8 +199,10 @@ module ModernTreasury
       end
 
       # To post a ledger transaction at creation, use `posted`.
+      #
+      # @see ModernTreasury::Models::LedgerTransaction#status
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ARCHIVED = :archived
         PENDING = :pending