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

data/lib/modern_treasury/models/ledger_transaction_create_partial_post_params.rb

@@ -2,23 +2,24 @@
 
 module ModernTreasury
   module Models
-    class LedgerTransactionCreatePartialPostParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerTransactions#create_partial_post
+    class LedgerTransactionCreatePartialPostParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute posted_ledger_entries
       #   An array of ledger entry objects to be set on the posted ledger transaction.
-      #     There must be one entry for each of the existing entries with a lesser amount
-      #     than the existing entry.
+      #   There must be one entry for each of the existing entries with a lesser amount
+      #   than the existing entry.
       #
       #   @return [Array<ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry>]
       required :posted_ledger_entries,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry] }
 
       # @!attribute [r] description
       #   An optional free-form description for the posted ledger transaction. Maximum of
-      #     1000 characters allowed.
+      #   1000 characters allowed.
       #
       #   @return [String, nil]
       optional :description, String
@@ -29,7 +30,7 @@ module ModernTreasury
 
       # @!attribute [r] effective_at
       #   The timestamp (IS08601 format) at which the posted ledger transaction happened
-      #     for reporting purposes.
+      #   for reporting purposes.
       #
       #   @return [Time, nil]
       optional :effective_at, Time
@@ -40,10 +41,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}]
@@ -58,21 +59,21 @@ module ModernTreasury
       #   #
       #   def initialize(posted_ledger_entries:, description: nil, effective_at: nil, metadata: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class PostedLedgerEntry < ModernTreasury::BaseModel
+      class PostedLedgerEntry < 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::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry::Direction]
         required :direction,
@@ -86,10 +87,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}]
@@ -103,25 +104,17 @@ module ModernTreasury
         #   #
         #   def initialize(amount:, direction:, ledger_account_id:, metadata: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        # @abstract
-        #
         # 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`.
         #
-        # @example
-        # ```ruby
-        # case direction
-        # in :credit
-        #   # ...
-        # in :debit
-        #   # ...
-        # end
-        # ```
-        class Direction < ModernTreasury::Enum
+        # @see ModernTreasury::Models::LedgerTransactionCreatePartialPostParams::PostedLedgerEntry#direction
+        module Direction
+          extend ModernTreasury::Internal::Type::Enum
+
           CREDIT = :credit
           DEBIT = :debit
 
@@ -129,7 +122,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/ledger_transaction_create_reversal_params.rb

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class LedgerTransactionCreateReversalParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerTransactions#create_reversal
+    class LedgerTransactionCreateReversalParams < 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] description
       #   An optional free-form description for the reversal ledger transaction. Maximum
-      #     of 1000 characters allowed.
+      #   of 1000 characters allowed.
       #
       #   @return [String, nil]
       optional :description, String
@@ -20,8 +21,8 @@ module ModernTreasury
 
       # @!attribute effective_at
       #   The timestamp (ISO8601 format) at which the reversal ledger transaction happened
-      #     for reporting purposes. It defaults to the `effective_at` of the original ledger
-      #     transaction if not provided.
+      #   for reporting purposes. It defaults to the `effective_at` of the original ledger
+      #   transaction if not provided.
       #
       #   @return [Time, nil]
       optional :effective_at, Time, nil?: true
@@ -38,7 +39,7 @@ module ModernTreasury
 
       # @!attribute [r] ledgerable_id
       #   Specify this if you'd like to link the reversal ledger transaction to a Payment
-      #     object like Return or Reversal.
+      #   object like Return or Reversal.
       #
       #   @return [String, nil]
       optional :ledgerable_id, String
@@ -49,7 +50,7 @@ module ModernTreasury
 
       # @!attribute [r] ledgerable_type
       #   Specify this if you'd like to link the reversal ledger transaction to a Payment
-      #     object like Return or Reversal.
+      #   object like Return or Reversal.
       #
       #   @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateReversalParams::LedgerableType, nil]
       optional :ledgerable_type,
@@ -61,10 +62,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data to be added to the reversal ledger transaction as key-value
-      #     pairs. Both the key and value must be strings.
+      #   pairs. Both the key and value must be strings.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -72,7 +73,7 @@ module ModernTreasury
 
       # @!attribute [r] status
       #   Status of the reversal ledger transaction. It defaults to `posted` if not
-      #     provided.
+      #   provided.
       #
       #   @return [Symbol, ModernTreasury::Models::LedgerTransactionCreateReversalParams::Status, nil]
       optional :status, enum: -> { ModernTreasury::Models::LedgerTransactionCreateReversalParams::Status }
@@ -105,31 +106,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Specify this if you'd like to link the reversal ledger transaction to a Payment
-      #   object like Return 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
+      # object like Return or Reversal.
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
+
         EXPECTED_PAYMENT = :expected_payment
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         PAPER_ITEM = :paper_item
@@ -141,27 +124,14 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # Status of the reversal ledger transaction. It defaults to `posted` if not
-      #   provided.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :archived
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :posted
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # provided.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         ARCHIVED = :archived
         PENDING = :pending
         POSTED = :posted
@@ -170,7 +140,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/ledger_transaction_list_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerTransactionListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerTransactions#list
+    class LedgerTransactionListParams < 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] effective_at
       #   Use "gt" (>), "gte" (>=), "lt" (<), "lte" (<=), or "eq" (=) to filter by
-      #     effective at. For example, for all transactions after Jan 1 2000, use
-      #     effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z.
+      #   effective at. For example, for all transactions after Jan 1 2000, use
+      #   effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z.
       #
       #   @return [Hash{Symbol=>Time}, nil]
-      optional :effective_at, ModernTreasury::HashOf[Time]
+      optional :effective_at, ModernTreasury::Internal::Type::HashOf[Time]
 
       # @!parse
       #   # @return [Hash{Symbol=>Time}]
@@ -37,11 +38,11 @@ module ModernTreasury
 
       # @!attribute [r] effective_date
       #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by
-      #     effective date. For example, for all dates after Jan 1 2000, use
-      #     effective_date%5Bgt%5D=2000-01-01.
+      #   effective date. For example, for all dates after Jan 1 2000, use
+      #   effective_date%5Bgt%5D=2000-01-01.
       #
       #   @return [Hash{Symbol=>Time}, nil]
-      optional :effective_date, ModernTreasury::HashOf[Time]
+      optional :effective_date, ModernTreasury::Internal::Type::HashOf[Time]
 
       # @!parse
       #   # @return [Hash{Symbol=>Time}]
@@ -113,11 +114,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}]
@@ -125,8 +126,8 @@ module ModernTreasury
 
       # @!attribute [r] order_by
       #   Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
-      #     to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
-      #     by only one field at a time is supported.
+      #   to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+      #   by only one field at a time is supported.
       #
       #   @return [ModernTreasury::Models::LedgerTransactionListParams::OrderBy, nil]
       optional :order_by, -> { ModernTreasury::Models::LedgerTransactionListParams::OrderBy }
@@ -155,11 +156,11 @@ module ModernTreasury
 
       # @!attribute [r] posted_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
-      #     posted_at%5Bgt%5D=2000-01-01T12:00:00Z.
+      #   posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use
+      #   posted_at%5Bgt%5D=2000-01-01T12:00:00Z.
       #
       #   @return [Hash{Symbol=>Time}, nil]
-      optional :posted_at, ModernTreasury::HashOf[Time]
+      optional :posted_at, ModernTreasury::Internal::Type::HashOf[Time]
 
       # @!parse
       #   # @return [Hash{Symbol=>Time}]
@@ -185,11 +186,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}]
@@ -243,28 +244,11 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module LedgerableType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @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
         EXPECTED_PAYMENT = :expected_payment
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         PAPER_ITEM = :paper_item
@@ -276,11 +260,10 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class OrderBy < ModernTreasury::BaseModel
+      class OrderBy < ModernTreasury::Internal::Type::BaseModel
         # @!attribute [r] created_at
         #
         #   @return [Symbol, ModernTreasury::Models::LedgerTransactionListParams::OrderBy::CreatedAt, nil]
@@ -302,28 +285,20 @@ module ModernTreasury
 
         # @!parse
         #   # Order by `created_at` or `effective_at` in `asc` or `desc` order. For example,
-        #   #   to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
-        #   #   by only one field at a time is supported.
+        #   # to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering
+        #   # by only one field at a time is supported.
         #   #
         #   # @param created_at [Symbol, ModernTreasury::Models::LedgerTransactionListParams::OrderBy::CreatedAt]
         #   # @param effective_at [Symbol, ModernTreasury::Models::LedgerTransactionListParams::OrderBy::EffectiveAt]
         #   #
         #   def initialize(created_at: nil, effective_at: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+        # @see ModernTreasury::Models::LedgerTransactionListParams::OrderBy#created_at
+        module CreatedAt
+          extend ModernTreasury::Internal::Type::Enum
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case created_at
-        # in :asc
-        #   # ...
-        # in :desc
-        #   # ...
-        # end
-        # ```
-        class CreatedAt < ModernTreasury::Enum
           ASC = :asc
           DESC = :desc
 
@@ -331,22 +306,13 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case effective_at
-        # in :asc
-        #   # ...
-        # in :desc
-        #   # ...
-        # end
-        # ```
-        class EffectiveAt < ModernTreasury::Enum
+        # @see ModernTreasury::Models::LedgerTransactionListParams::OrderBy#effective_at
+        module EffectiveAt
+          extend ModernTreasury::Internal::Type::Enum
+
           ASC = :asc
           DESC = :desc
 
@@ -354,25 +320,13 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :pending
-      #   # ...
-      # in :posted
-      #   # ...
-      # in :archived
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         PENDING = :pending
         POSTED = :posted
         ARCHIVED = :archived
@@ -381,7 +335,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/ledger_transaction_retrieve_params.rb

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