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

data/lib/modern_treasury/models/payment_order_create_async_params.rb

@@ -2,23 +2,24 @@
 
 module ModernTreasury
   module Models
-    class PaymentOrderCreateAsyncParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentOrders#create_async
+    class PaymentOrderCreateAsyncParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute amount
       #   Value in specified currency's smallest unit. e.g. $10 would be represented as
-      #     1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
+      #   1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
       #
       #   @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::PaymentOrderCreateAsyncParams::Direction]
       required :direction, enum: -> { ModernTreasury::Models::PaymentOrderCreateAsyncParams::Direction }
@@ -31,8 +32,8 @@ module ModernTreasury
 
       # @!attribute type
       #   One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
-      #     `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
-      #     `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
+      #   `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
+      #   `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderType]
       required :type, enum: -> { ModernTreasury::Models::PaymentOrderType }
@@ -48,22 +49,22 @@ module ModernTreasury
 
       # @!attribute accounting_category_id
       #   The ID of one of your accounting categories. Note that these will only be
-      #     accessible if your accounting system has been connected.
+      #   accessible if your accounting system has been connected.
       #
       #   @return [String, nil]
       optional :accounting_category_id, String, nil?: true
 
       # @!attribute accounting_ledger_class_id
       #   The ID of one of your accounting ledger classes. Note that these will only be
-      #     accessible if your accounting system has been connected.
+      #   accessible if your accounting system has been connected.
       #
       #   @return [String, nil]
       optional :accounting_ledger_class_id, String, nil?: true
 
       # @!attribute charge_bearer
       #   The party that will pay the fees for the payment order. Only applies to wire
-      #     payment orders. Can be one of shared, sender, or receiver, which correspond
-      #     respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+      #   payment orders. Can be one of shared, sender, or receiver, which correspond
+      #   respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ChargeBearer, nil]
       optional :charge_bearer,
@@ -88,8 +89,8 @@ module ModernTreasury
 
       # @!attribute [r] effective_date
       #   Date transactions are to be posted to the participants' account. Defaults to the
-      #     current business day or the next business day if the current day is a bank
-      #     holiday or weekend. Format: yyyy-mm-dd.
+      #   current business day or the next business day if the current day is a bank
+      #   holiday or weekend. Format: yyyy-mm-dd.
       #
       #   @return [Date, nil]
       optional :effective_date, Date
@@ -106,8 +107,8 @@ module ModernTreasury
 
       # @!attribute [r] fallback_type
       #   A payment type to fallback to if the original type is not valid for the
-      #     receiving account. Currently, this only supports falling back from RTP to ACH
-      #     (type=rtp and fallback_type=ach)
+      #   receiving account. Currently, this only supports falling back from RTP to ACH
+      #   (type=rtp and fallback_type=ach)
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::FallbackType, nil]
       optional :fallback_type, enum: -> { ModernTreasury::Models::PaymentOrderCreateAsyncParams::FallbackType }
@@ -118,15 +119,15 @@ module ModernTreasury
 
       # @!attribute foreign_exchange_contract
       #   If present, indicates a specific foreign exchange contract number that has been
-      #     generated by your financial institution.
+      #   generated by your financial institution.
       #
       #   @return [String, nil]
       optional :foreign_exchange_contract, String, nil?: true
 
       # @!attribute foreign_exchange_indicator
       #   Indicates the type of FX transfer to initiate, can be either
-      #     `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
-      #     currency matches the originating account currency.
+      #   `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
+      #   currency matches the originating account currency.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ForeignExchangeIndicator, nil]
       optional :foreign_exchange_indicator,
@@ -135,9 +136,9 @@ module ModernTreasury
 
       # @!attribute [r] ledger_transaction
       #   Specifies a ledger transaction object that will be created with the payment
-      #     order. If the ledger transaction cannot be created, then the payment order
-      #     creation will fail. The resulting ledger transaction will mirror the status of
-      #     the payment order.
+      #   order. If the ledger transaction cannot be created, then the payment order
+      #   creation will fail. The resulting ledger transaction will mirror the status of
+      #   the payment order.
       #
       #   @return [ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction, nil]
       optional :ledger_transaction,
@@ -149,9 +150,9 @@ module ModernTreasury
 
       # @!attribute [r] ledger_transaction_id
       #   Either ledger_transaction or ledger_transaction_id can be provided. Only a
-      #     pending ledger transaction can be attached upon payment order creation. Once the
-      #     payment order is created, the status of the ledger transaction tracks the
-      #     payment order automatically.
+      #   pending ledger transaction can be attached upon payment order creation. Once the
+      #   payment order is created, the status of the ledger transaction tracks the
+      #   payment order automatically.
       #
       #   @return [String, nil]
       optional :ledger_transaction_id, String
@@ -165,7 +166,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::LineItem>, nil]
       optional :line_items,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::LineItem] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::LineItem] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::LineItem>]
@@ -173,10 +174,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}]
@@ -184,10 +185,10 @@ module ModernTreasury
 
       # @!attribute [r] nsf_protected
       #   A boolean to determine if NSF Protection is enabled for this payment order. Note
-      #     that this setting must also be turned on in your organization settings page.
+      #   that this setting must also be turned on in your organization settings page.
       #
       #   @return [Boolean, nil]
-      optional :nsf_protected, ModernTreasury::BooleanModel
+      optional :nsf_protected, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -195,17 +196,17 @@ module ModernTreasury
 
       # @!attribute originating_party_name
       #   If present, this will replace your default company name on receiver's bank
-      #     statement. This field can only be used for ACH payments currently. For ACH, only
-      #     the first 16 characters of this string will be used. Any additional characters
-      #     will be truncated.
+      #   statement. This field can only be used for ACH payments currently. For ACH, only
+      #   the first 16 characters of this string will be used. Any additional characters
+      #   will be truncated.
       #
       #   @return [String, nil]
       optional :originating_party_name, String, nil?: true
 
       # @!attribute [r] priority
       #   Either `normal` or `high`. For ACH and EFT payments, `high` represents a
-      #     same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
-      #     an overnight check rather than standard mail.
+      #   same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
+      #   an overnight check rather than standard mail.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::Priority, nil]
       optional :priority, enum: -> { ModernTreasury::Models::PaymentOrderCreateAsyncParams::Priority }
@@ -216,26 +217,26 @@ module ModernTreasury
 
       # @!attribute process_after
       #   If present, Modern Treasury will not process the payment until after this time.
-      #     If `process_after` is past the cutoff for `effective_date`, `process_after` will
-      #     take precedence and `effective_date` will automatically update to reflect the
-      #     earliest possible sending date after `process_after`. Format is ISO8601
-      #     timestamp.
+      #   If `process_after` is past the cutoff for `effective_date`, `process_after` will
+      #   take precedence and `effective_date` will automatically update to reflect the
+      #   earliest possible sending date after `process_after`. Format is ISO8601
+      #   timestamp.
       #
       #   @return [Time, nil]
       optional :process_after, Time, nil?: true
 
       # @!attribute purpose
       #   For `wire`, this is usually the purpose which is transmitted via the
-      #     "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3
-      #     digit CPA Code that will be attached to the payment.
+      #   "InstrForDbtrAgt" field in the ISO20022 file. For `eft`, this field is the 3
+      #   digit CPA Code that will be attached to the payment.
       #
       #   @return [String, nil]
       optional :purpose, String, nil?: true
 
       # @!attribute [r] receiving_account
       #   Either `receiving_account` or `receiving_account_id` must be present. When using
-      #     `receiving_account_id`, you may pass the id of an external account or an
-      #     internal account.
+      #   `receiving_account_id`, you may pass the id of an external account or an
+      #   internal account.
       #
       #   @return [ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount, nil]
       optional :receiving_account,
@@ -247,8 +248,8 @@ module ModernTreasury
 
       # @!attribute [r] receiving_account_id
       #   Either `receiving_account` or `receiving_account_id` must be present. When using
-      #     `receiving_account_id`, you may pass the id of an external account or an
-      #     internal account.
+      #   `receiving_account_id`, you may pass the id of an external account or an
+      #   internal account.
       #
       #   @return [String, nil]
       optional :receiving_account_id, String
@@ -259,45 +260,45 @@ module ModernTreasury
 
       # @!attribute remittance_information
       #   For `ach`, this field will be passed through on an addenda record. For `wire`
-      #     payments the field will be passed through as the "Originator to Beneficiary
-      #     Information", also known as OBI or Fedwire tag 6000.
+      #   payments the field will be passed through as the "Originator to Beneficiary
+      #   Information", also known as OBI or Fedwire tag 6000.
       #
       #   @return [String, nil]
       optional :remittance_information, String, nil?: true
 
       # @!attribute send_remittance_advice
       #   Send an email to the counterparty when the payment order is sent to the bank. If
-      #     `null`, `send_remittance_advice` on the Counterparty is used.
+      #   `null`, `send_remittance_advice` on the Counterparty is used.
       #
       #   @return [Boolean, nil]
-      optional :send_remittance_advice, ModernTreasury::BooleanModel, nil?: true
+      optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean, nil?: true
 
       # @!attribute statement_descriptor
       #   An optional descriptor which will appear in the receiver's statement. For
-      #     `check` payments this field will be used as the memo line. For `ach` the maximum
-      #     length is 10 characters. Note that for ACH payments, the name on your bank
-      #     account will be included automatically by the bank, so you can use the
-      #     characters for other useful information. For `eft` the maximum length is 15
-      #     characters.
+      #   `check` payments this field will be used as the memo line. For `ach` the maximum
+      #   length is 10 characters. Note that for ACH payments, the name on your bank
+      #   account will be included automatically by the bank, so you can use the
+      #   characters for other useful information. For `eft` the maximum length is 15
+      #   characters.
       #
       #   @return [String, nil]
       optional :statement_descriptor, String, nil?: true
 
       # @!attribute subtype
       #   An additional layer of classification for the type of payment order you are
-      #     doing. This field is only used for `ach` payment orders currently. For `ach`
-      #     payment orders, the `subtype` represents the SEC code. We currently support
-      #     `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
+      #   doing. This field is only used for `ach` payment orders currently. For `ach`
+      #   payment orders, the `subtype` represents the SEC code. We currently support
+      #   `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
       optional :subtype, enum: -> { ModernTreasury::Models::PaymentOrderSubtype }, nil?: true
 
       # @!attribute [r] transaction_monitoring_enabled
       #   A flag that determines whether a payment order should go through transaction
-      #     monitoring.
+      #   monitoring.
       #
       #   @return [Boolean, nil]
-      optional :transaction_monitoring_enabled, ModernTreasury::BooleanModel
+      optional :transaction_monitoring_enabled, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -407,14 +408,14 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # 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`.
       module Direction
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CREDIT = :credit
         DEBIT = :debit
@@ -426,18 +427,18 @@ module ModernTreasury
         #   def self.values; end
       end
 
-      class Accounting < ModernTreasury::BaseModel
+      class Accounting < ModernTreasury::Internal::Type::BaseModel
         # @!attribute account_id
         #   The ID of one of your accounting categories. Note that these will only be
-        #     accessible if your accounting system has been connected.
+        #   accessible if your accounting system has been connected.
         #
         #   @return [String, nil]
         optional :account_id, String, nil?: true
 
         # @!attribute class_id
         #   The ID of one of the class objects in your accounting system. Class objects
-        #     track segments of your business independent of client or project. Note that
-        #     these will only be accessible if your accounting system has been connected.
+        #   track segments of your business independent of client or project. Note that
+        #   these will only be accessible if your accounting system has been connected.
         #
         #   @return [String, nil]
         optional :class_id, String, nil?: true
@@ -448,14 +449,14 @@ module ModernTreasury
         #   #
         #   def initialize(account_id: nil, class_id: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
       # The party that will pay the fees for the payment order. Only applies to wire
-      #   payment orders. Can be one of shared, sender, or receiver, which correspond
-      #   respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+      # payment orders. Can be one of shared, sender, or receiver, which correspond
+      # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
       module ChargeBearer
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         SHARED = :shared
         SENDER = :sender
@@ -469,10 +470,10 @@ module ModernTreasury
       end
 
       # A payment type to fallback to if the original type is not valid for the
-      #   receiving account. Currently, this only supports falling back from RTP to ACH
-      #   (type=rtp and fallback_type=ach)
+      # receiving account. Currently, this only supports falling back from RTP to ACH
+      # (type=rtp and fallback_type=ach)
       module FallbackType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ACH = :ach
 
@@ -484,10 +485,10 @@ module ModernTreasury
       end
 
       # Indicates the type of FX transfer to initiate, can be either
-      #   `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
-      #   currency matches the originating account currency.
+      # `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
+      # currency matches the originating account currency.
       module ForeignExchangeIndicator
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         FIXED_TO_VARIABLE = :fixed_to_variable
         VARIABLE_TO_FIXED = :variable_to_fixed
@@ -499,13 +500,13 @@ module ModernTreasury
         #   def self.values; end
       end
 
-      class LedgerTransaction < ModernTreasury::BaseModel
+      class LedgerTransaction < ModernTreasury::Internal::Type::BaseModel
         # @!attribute ledger_entries
         #   An array of ledger entry objects.
         #
         #   @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction::LedgerEntry>]
         required :ledger_entries,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction::LedgerEntry] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction::LedgerEntry] }
 
         # @!attribute description
         #   An optional description for internal use.
@@ -515,7 +516,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
@@ -526,7 +527,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
@@ -537,7 +538,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
@@ -548,7 +549,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
@@ -559,9 +560,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::PaymentOrderCreateAsyncParams::LedgerTransaction::LedgerableType, nil]
         optional :ledgerable_type,
@@ -573,10 +574,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}]
@@ -595,9 +596,9 @@ module ModernTreasury
 
         # @!parse
         #   # Specifies a ledger transaction object that will be created with the payment
-        #   #   order. If the ledger transaction cannot be created, then the payment order
-        #   #   creation will fail. The resulting ledger transaction will mirror the status of
-        #   #   the payment order.
+        #   # order. If the ledger transaction cannot be created, then the payment order
+        #   # creation will fail. The resulting ledger transaction will mirror the status of
+        #   # the payment order.
         #   #
         #   # @param ledger_entries [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction::LedgerEntry>]
         #   # @param description [String, nil]
@@ -624,21 +625,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 }
@@ -651,27 +652,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}]
@@ -679,26 +680,28 @@ 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]
@@ -726,15 +729,17 @@ module ModernTreasury
           #     super
           #   end
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
         # 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::PaymentOrderCreateAsyncParams::LedgerTransaction#ledgerable_type
         module LedgerableType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           EXPECTED_PAYMENT = :expected_payment
           INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
@@ -751,8 +756,10 @@ module ModernTreasury
         end
 
         # To post a ledger transaction at creation, use `posted`.
+        #
+        # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction#status
         module Status
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ARCHIVED = :archived
           PENDING = :pending
@@ -766,17 +773,17 @@ module ModernTreasury
         end
       end
 
-      class LineItem < ModernTreasury::BaseModel
+      class LineItem < ModernTreasury::Internal::Type::BaseModel
         # @!attribute amount
         #   Value in specified currency's smallest unit. e.g. $10 would be represented
-        #     as 1000.
+        #   as 1000.
         #
         #   @return [Integer]
         required :amount, Integer
 
         # @!attribute accounting_category_id
         #   The ID of one of your accounting categories. Note that these will only be
-        #     accessible if your accounting system has been connected.
+        #   accessible if your accounting system has been connected.
         #
         #   @return [String, nil]
         optional :accounting_category_id, String, nil?: true
@@ -789,10 +796,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}]
@@ -806,14 +813,14 @@ module ModernTreasury
         #   #
         #   def initialize(amount:, accounting_category_id: nil, description: nil, metadata: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
       # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
-      #   same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
-      #   an overnight check rather than standard mail.
+      # same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
+      # an overnight check rather than standard mail.
       module Priority
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         HIGH = :high
         NORMAL = :normal
@@ -825,12 +832,12 @@ module ModernTreasury
         #   def self.values; end
       end
 
-      class ReceivingAccount < ModernTreasury::BaseModel
+      class ReceivingAccount < ModernTreasury::Internal::Type::BaseModel
         # @!attribute [r] account_details
         #
         #   @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail>, nil]
         optional :account_details,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail>]
@@ -850,7 +857,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::ContactDetail>, nil]
         optional :contact_details,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::ContactDetail] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::ContactDetail] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::ContactDetail>]
@@ -858,10 +865,10 @@ module ModernTreasury
 
         # @!attribute [r] ledger_account
         #   Specifies a ledger account object that will be created with the external
-        #     account. The resulting ledger account is linked to the external account for
-        #     auto-ledgering Payment objects. See
-        #     https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-        #     for more details.
+        #   account. The resulting ledger account is linked to the external account for
+        #   auto-ledgering Payment objects. See
+        #   https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
+        #   for more details.
         #
         #   @return [ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::LedgerAccount, nil]
         optional :ledger_account,
@@ -873,10 +880,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}]
@@ -884,7 +891,7 @@ module ModernTreasury
 
         # @!attribute name
         #   A nickname for the external account. This is only for internal usage and won't
-        #     affect any payments
+        #   affect any payments
         #
         #   @return [String, nil]
         optional :name, String, nil?: true
@@ -929,7 +936,7 @@ module ModernTreasury
 
         # @!attribute [r] plaid_processor_token
         #   If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
-        #     you can pass the processor token in this field.
+        #   you can pass the processor token in this field.
         #
         #   @return [String, nil]
         optional :plaid_processor_token, String
@@ -942,7 +949,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail>, nil]
         optional :routing_details,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail>]
@@ -950,8 +957,8 @@ module ModernTreasury
 
         # @!parse
         #   # Either `receiving_account` or `receiving_account_id` must be present. When using
-        #   #   `receiving_account_id`, you may pass the id of an external account or an
-        #   #   internal account.
+        #   # `receiving_account_id`, you may pass the id of an external account or an
+        #   # internal account.
         #   #
         #   # @param account_details [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail>]
         #   # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
@@ -984,9 +991,9 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        class AccountDetail < ModernTreasury::BaseModel
+        class AccountDetail < ModernTreasury::Internal::Type::BaseModel
           # @!attribute account_number
           #
           #   @return [String]
@@ -1008,10 +1015,11 @@ module ModernTreasury
           #   #
           #   def initialize(account_number:, account_number_type: nil, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
+          # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail#account_number_type
           module AccountNumberType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             AU_NUMBER = :au_number
             CLABE = :clabe
@@ -1032,7 +1040,7 @@ module ModernTreasury
           end
         end
 
-        class ContactDetail < ModernTreasury::BaseModel
+        class ContactDetail < ModernTreasury::Internal::Type::BaseModel
           # @!attribute [r] contact_identifier
           #
           #   @return [String, nil]
@@ -1058,10 +1066,11 @@ module ModernTreasury
           #   #
           #   def initialize(contact_identifier: nil, contact_identifier_type: nil, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
+          # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::ContactDetail#contact_identifier_type
           module ContactIdentifierType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             EMAIL = :email
             PHONE_NUMBER = :phone_number
@@ -1075,7 +1084,8 @@ module ModernTreasury
           end
         end
 
-        class LedgerAccount < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount#ledger_account
+        class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
           # @!attribute currency
           #   The currency of the ledger account.
           #
@@ -1114,10 +1124,10 @@ module ModernTreasury
 
           # @!attribute [r] ledger_account_category_ids
           #   The array of ledger account category ids that this ledger account should be a
-          #     child of.
+          #   child of.
           #
           #   @return [Array<String>, nil]
-          optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
+          optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
 
           # @!parse
           #   # @return [Array<String>]
@@ -1125,7 +1135,7 @@ module ModernTreasury
 
           # @!attribute [r] ledgerable_id
           #   If the ledger account links to another object in Modern Treasury, the id will be
-          #     populated here, otherwise null.
+          #   populated here, otherwise null.
           #
           #   @return [String, nil]
           optional :ledgerable_id, String
@@ -1136,8 +1146,8 @@ module ModernTreasury
 
           # @!attribute [r] ledgerable_type
           #   If the ledger account links to another object in Modern Treasury, the type will
-          #     be populated here, otherwise null. The value is one of internal_account or
-          #     external_account.
+          #   be populated here, otherwise null. The value is one of internal_account or
+          #   external_account.
           #
           #   @return [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::LedgerAccount::LedgerableType, nil]
           optional :ledgerable_type,
@@ -1149,10 +1159,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}]
@@ -1160,10 +1170,10 @@ module ModernTreasury
 
           # @!parse
           #   # Specifies a ledger account object that will be created with the external
-          #   #   account. The resulting ledger account is linked to the external account for
-          #   #   auto-ledgering Payment objects. See
-          #   #   https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-          #   #   for more details.
+          #   # account. The resulting ledger account is linked to the external account for
+          #   # auto-ledgering Payment objects. See
+          #   # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
+          #   # for more details.
           #   #
           #   # @param currency [String]
           #   # @param ledger_id [String]
@@ -1192,13 +1202,15 @@ module ModernTreasury
           #     super
           #   end
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
           # If the ledger account links to another object in Modern Treasury, the type will
-          #   be populated here, otherwise null. The value is one of internal_account or
-          #   external_account.
+          # be populated here, otherwise null. The value is one of internal_account or
+          # external_account.
+          #
+          # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::LedgerAccount#ledgerable_type
           module LedgerableType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             COUNTERPARTY = :counterparty
             EXTERNAL_ACCOUNT = :external_account
@@ -1213,7 +1225,8 @@ module ModernTreasury
           end
         end
 
-        class PartyAddress < ModernTreasury::BaseModel
+        # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount#party_address
+        class PartyAddress < ModernTreasury::Internal::Type::BaseModel
           # @!attribute country
           #   Country code conforms to [ISO 3166-1 alpha-2]
           #
@@ -1260,12 +1273,14 @@ module ModernTreasury
           #   #
           #   def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
         # Either `individual` or `business`.
+        #
+        # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount#party_type
         module PartyType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           BUSINESS = :business
           INDIVIDUAL = :individual
@@ -1277,7 +1292,7 @@ module ModernTreasury
           #   def self.values; end
         end
 
-        class RoutingDetail < ModernTreasury::BaseModel
+        class RoutingDetail < ModernTreasury::Internal::Type::BaseModel
           # @!attribute routing_number
           #
           #   @return [String]
@@ -1306,10 +1321,11 @@ module ModernTreasury
           #   #
           #   def initialize(routing_number:, routing_number_type:, payment_type: nil, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
+          # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail#routing_number_type
           module RoutingNumberType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             ABA = :aba
             AU_BSB = :au_bsb
@@ -1340,8 +1356,9 @@ module ModernTreasury
             #   def self.values; end
           end
 
+          # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail#payment_type
           module PaymentType
-            extend ModernTreasury::Enum
+            extend ModernTreasury::Internal::Type::Enum
 
             ACH = :ach
             AU_BECS = :au_becs