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

data/lib/modern_treasury/models/ledger_event_handler_variable.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class LedgerEventHandlerVariable < ModernTreasury::BaseModel
+    # @deprecated
+    class LedgerEventHandlerVariable < ModernTreasury::Internal::Type::BaseModel
       # @!attribute query
       #
       #   @return [ModernTreasury::Models::LedgerEventHandlerVariable::Query]
@@ -10,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
@@ -21,9 +22,12 @@ module ModernTreasury
       #   #
       #   def initialize(query:, type:, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class Query < ModernTreasury::BaseModel
+      # @deprecated
+      #
+      # @see ModernTreasury::Models::LedgerEventHandlerVariable#query
+      class Query < ModernTreasury::Internal::Type::BaseModel
         # @!attribute field
         #   The LHS of the conditional.
         #
@@ -49,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,33 +173,17 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # 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.
       #
-      # @example
-      # ```ruby
-      # case ledgerable_type
-      # in :expected_payment
-      #   # ...
-      # in :incoming_payment_detail
-      #   # ...
-      # in :paper_item
-      #   # ...
-      # in :payment_order
-      #   # ...
-      # in :return
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class LedgerableType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::LedgerTransaction#ledgerable_type
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
+
         EXPECTED_PAYMENT = :expected_payment
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         PAPER_ITEM = :paper_item
@@ -209,26 +195,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # To post a ledger transaction at creation, use `posted`.
       #
-      # @example
-      # ```ruby
-      # case status
-      # in :archived
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :posted
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # @see ModernTreasury::Models::LedgerTransaction#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         ARCHIVED = :archived
         PENDING = :pending
         POSTED = :posted
@@ -237,7 +212,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/ledger_transaction_create_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerTransactionCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerTransactions#create
+    class LedgerTransactionCreateParams < 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_entries
       #   An array of ledger entry objects.
       #
       #   @return [Array<ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry>]
       required :ledger_entries,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LedgerTransactionCreateParams::LedgerEntry] }
 
       # @!attribute description
       #   An optional description for internal use.
@@ -22,7 +23,7 @@ module ModernTreasury
 
       # @!attribute [r] effective_at
       #   The timestamp (ISO8601 format) at which the ledger transaction happened for
-      #     reporting purposes.
+      #   reporting purposes.
       #
       #   @return [Time, nil]
       optional :effective_at, Time
@@ -33,7 +34,7 @@ module ModernTreasury
 
       # @!attribute [r] effective_date
       #   The date (YYYY-MM-DD) on which the ledger transaction happened for reporting
-      #     purposes.
+      #   purposes.
       #
       #   @return [Date, nil]
       optional :effective_date, Date
@@ -44,7 +45,7 @@ module ModernTreasury
 
       # @!attribute [r] 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]
       optional :external_id, String
@@ -55,7 +56,7 @@ module ModernTreasury
 
       # @!attribute [r] 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]
       optional :ledgerable_id, String
@@ -66,9 +67,9 @@ module ModernTreasury
 
       # @!attribute [r] 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::LedgerTransactionCreateParams::LedgerableType, nil]
       optional :ledgerable_type,
@@ -80,10 +81,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}]
@@ -127,21 +128,21 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class LedgerEntry < ModernTreasury::BaseModel
+      class LedgerEntry < ModernTreasury::Internal::Type::BaseModel
         # @!attribute amount
         #   Value in specified currency's smallest unit. e.g. $10 would be represented
-        #     as 1000. Can be any integer up to 36 digits.
+        #   as 1000. Can be any integer up to 36 digits.
         #
         #   @return [Integer]
         required :amount, Integer
 
         # @!attribute direction
         #   One of `credit`, `debit`. Describes the direction money is flowing in the
-        #     transaction. A `credit` moves money from your account to someone else's. A
-        #     `debit` pulls money from someone else's account to your own. Note that wire,
-        #     rtp, and check payments will always be `credit`.
+        #   transaction. A `credit` moves money from your account to someone else's. A
+        #   `debit` pulls money from someone else's account to your own. Note that wire,
+        #   rtp, and check payments will always be `credit`.
         #
         #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
         required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
@@ -154,27 +155,27 @@ module ModernTreasury
 
         # @!attribute available_balance_amount
         #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-        #     account’s available balance. If any of these conditions would be false after the
-        #     transaction is created, the entire call will fail with error code 422.
+        #   account’s available balance. If any of these conditions would be false after the
+        #   transaction is created, the entire call will fail with error code 422.
         #
         #   @return [Hash{Symbol=>Integer}, nil]
-        optional :available_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
+        optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
 
         # @!attribute lock_version
         #   Lock version of the ledger account. This can be passed when creating a ledger
-        #     transaction to only succeed if no ledger transactions have posted since the
-        #     given version. See our post about Designing the Ledgers API with Optimistic
-        #     Locking for more details.
+        #   transaction to only succeed if no ledger transactions have posted since the
+        #   given version. See our post about Designing the Ledgers API with Optimistic
+        #   Locking for more details.
         #
         #   @return [Integer, nil]
         optional :lock_version, Integer, nil?: true
 
         # @!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}]
@@ -182,26 +183,26 @@ module ModernTreasury
 
         # @!attribute pending_balance_amount
         #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-        #     account’s pending balance. If any of these conditions would be false after the
-        #     transaction is created, the entire call will fail with error code 422.
+        #   account’s pending balance. If any of these conditions would be false after the
+        #   transaction is created, the entire call will fail with error code 422.
         #
         #   @return [Hash{Symbol=>Integer}, nil]
-        optional :pending_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
+        optional :pending_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
 
         # @!attribute posted_balance_amount
         #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the
-        #     account’s posted balance. If any of these conditions would be false after the
-        #     transaction is created, the entire call will fail with error code 422.
+        #   account’s posted balance. If any of these conditions would be false after the
+        #   transaction is created, the entire call will fail with error code 422.
         #
         #   @return [Hash{Symbol=>Integer}, nil]
-        optional :posted_balance_amount, ModernTreasury::HashOf[Integer], nil?: true
+        optional :posted_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
 
         # @!attribute show_resulting_ledger_account_balances
         #   If true, response will include the balance of the associated ledger account for
-        #     the entry.
+        #   the entry.
         #
         #   @return [Boolean, nil]
-        optional :show_resulting_ledger_account_balances, ModernTreasury::BooleanModel, nil?: true
+        optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
 
         # @!parse
         #   # @param amount [Integer]
@@ -229,34 +230,16 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # 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.
-      #
-      # @example
-      # ```ruby
-      # case ledgerable_type
-      # in :expected_payment
-      #   # ...
-      # in :incoming_payment_detail
-      #   # ...
-      # in :paper_item
-      #   # ...
-      # in :payment_order
-      #   # ...
-      # in :return
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class LedgerableType < ModernTreasury::Enum
+      # 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.
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
+
         EXPECTED_PAYMENT = :expected_payment
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         PAPER_ITEM = :paper_item
@@ -268,26 +251,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # To post a ledger transaction at creation, use `posted`.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :archived
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :posted
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         ARCHIVED = :archived
         PENDING = :pending
         POSTED = :posted
@@ -296,7 +266,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end