modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/expected_payment_create_params.rb

@@ -2,21 +2,22 @@
 
 module ModernTreasury
   module Models
-    class ExpectedPaymentCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExpectedPayments#create
+    class ExpectedPaymentCreateParams < 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_lower_bound
       #   The lowest amount this expected payment may be equal to. Value in specified
-      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #   currency's smallest unit. e.g. $10 would be represented as 1000.
       #
       #   @return [Integer, nil]
       optional :amount_lower_bound, Integer, nil?: true
 
       # @!attribute amount_upper_bound
       #   The highest amount this expected payment may be equal to. Value in specified
-      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #   currency's smallest unit. e.g. $10 would be represented as 1000.
       #
       #   @return [Integer, nil]
       optional :amount_upper_bound, Integer, nil?: true
@@ -53,7 +54,7 @@ module ModernTreasury
 
       # @!attribute direction
       #   One of credit or debit. When you are receiving money, use credit. When you are
-      #     being charged, use debit.
+      #   being charged, use debit.
       #
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil]
       optional :direction,
@@ -68,9 +69,9 @@ module ModernTreasury
 
       # @!attribute [r] ledger_transaction
       #   Specifies a ledger transaction object that will be created with the expected
-      #     payment. If the ledger transaction cannot be created, then the expected payment
-      #     creation will fail. The resulting ledger transaction will mirror the status of
-      #     the expected payment.
+      #   payment. If the ledger transaction cannot be created, then the expected payment
+      #   creation will fail. The resulting ledger transaction will mirror the status of
+      #   the expected payment.
       #
       #   @return [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction, nil]
       optional :ledger_transaction,
@@ -82,9 +83,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 expected payment creation. Once
-      #     the expected payment is created, the status of the ledger transaction tracks the
-      #     expected payment automatically.
+      #   pending ledger transaction can be attached upon expected payment creation. Once
+      #   the expected payment is created, the status of the ledger transaction tracks the
+      #   expected payment automatically.
       #
       #   @return [String, nil]
       optional :ledger_transaction_id, String
@@ -97,7 +98,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem>, nil]
       optional :line_items,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem>]
@@ -105,10 +106,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}]
@@ -118,42 +119,42 @@ module ModernTreasury
       #   The reconciliation filters you have for this payment.
       #
       #   @return [Object, nil]
-      optional :reconciliation_filters, ModernTreasury::Unknown, nil?: true
+      optional :reconciliation_filters, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute reconciliation_groups
       #   The reconciliation groups you have for this payment.
       #
       #   @return [Object, nil]
-      optional :reconciliation_groups, ModernTreasury::Unknown, nil?: true
+      optional :reconciliation_groups, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute reconciliation_rule_variables
       #   An array of reconciliation rule variables for this payment.
       #
       #   @return [Array<ModernTreasury::Models::ReconciliationRule>, nil]
       optional :reconciliation_rule_variables,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
                nil?: true
 
       # @!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 statement_descriptor
       #   The statement description you expect to see on the transaction. For ACH
-      #     payments, this will be the full line item passed from the bank. For wire
-      #     payments, this will be the OBI field on the wire. For check payments, this will
-      #     be the memo field.
+      #   payments, this will be the full line item passed from the bank. For wire
+      #   payments, this will be the OBI field on the wire. For check payments, this will
+      #   be the memo field.
       #
       #   @return [String, nil]
       optional :statement_descriptor, String, nil?: true
 
       # @!attribute type
       #   One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
-      #     sepa, signet, wire.
+      #   sepa, signet, wire.
       #
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
       optional :type, enum: -> { ModernTreasury::Models::ExpectedPaymentType }, nil?: true
@@ -206,12 +207,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # One of credit or debit. When you are receiving money, use credit. When you are
-      #   being charged, use debit.
+      # being charged, use debit.
       module Direction
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CREDIT = :credit
         DEBIT = :debit
@@ -223,13 +224,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::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry>]
         required :ledger_entries,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry] }
 
         # @!attribute description
         #   An optional description for internal use.
@@ -239,7 +240,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
@@ -250,7 +251,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
@@ -261,7 +262,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
@@ -272,7 +273,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
@@ -283,9 +284,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::ExpectedPaymentCreateParams::LedgerTransaction::LedgerableType, nil]
         optional :ledgerable_type,
@@ -297,10 +298,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}]
@@ -319,9 +320,9 @@ module ModernTreasury
 
         # @!parse
         #   # Specifies a ledger transaction object that will be created with the expected
-        #   #   payment. If the ledger transaction cannot be created, then the expected payment
-        #   #   creation will fail. The resulting ledger transaction will mirror the status of
-        #   #   the expected payment.
+        #   # payment. If the ledger transaction cannot be created, then the expected payment
+        #   # creation will fail. The resulting ledger transaction will mirror the status of
+        #   # the expected payment.
         #   #
         #   # @param ledger_entries [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction::LedgerEntry>]
         #   # @param description [String, nil]
@@ -348,21 +349,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 }
@@ -375,27 +376,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}]
@@ -403,26 +404,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]
@@ -450,15 +453,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::ExpectedPaymentCreateParams::LedgerTransaction#ledgerable_type
         module LedgerableType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           EXPECTED_PAYMENT = :expected_payment
           INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
@@ -475,8 +480,10 @@ module ModernTreasury
         end
 
         # To post a ledger transaction at creation, use `posted`.
+        #
+        # @see ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction#status
         module Status
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ARCHIVED = :archived
           PENDING = :pending
@@ -490,17 +497,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
@@ -513,10 +520,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}]
@@ -530,7 +537,7 @@ 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
     end
   end

data/lib/modern_treasury/models/expected_payment_delete_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class ExpectedPaymentDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExpectedPayments#delete
+    class ExpectedPaymentDeleteParams < 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/expected_payment_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ExpectedPaymentListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExpectedPayments#list
+    class ExpectedPaymentListParams < 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
       #
@@ -64,11 +65,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}]
@@ -95,7 +96,7 @@ module ModernTreasury
 
       # @!attribute [r] type
       #   One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
-      #     sepa, signet, wire
+      #   sepa, signet, wire
       #
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type, nil]
       optional :type, enum: -> { ModernTreasury::Models::ExpectedPaymentListParams::Type }
@@ -134,11 +135,11 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # One of unreconciled, reconciled, or archived.
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ARCHIVED = :archived
         PARTIALLY_RECONCILED = :partially_reconciled
@@ -153,9 +154,9 @@ module ModernTreasury
       end
 
       # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
-      #   sepa, signet, wire
+      # sepa, signet, wire
       module Type
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ACH = :ach
         AU_BECS = :au_becs

data/lib/modern_treasury/models/expected_payment_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class ExpectedPaymentRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExpectedPayments#retrieve
+    class ExpectedPaymentRetrieveParams < 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/expected_payment_type.rb

@@ -3,9 +3,9 @@
 module ModernTreasury
   module Models
     # One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
-    #   sepa, signet, wire.
+    # sepa, signet, wire.
     module ExpectedPaymentType
-      extend ModernTreasury::Enum
+      extend ModernTreasury::Internal::Type::Enum
 
       ACH = :ach
       AU_BECS = :au_becs