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

data/lib/modern_treasury/models/transaction_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class TransactionListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Transactions#list
+    class TransactionListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -14,7 +15,7 @@ module ModernTreasury
 
       # @!attribute [r] as_of_date_end
       #   Filters transactions with an `as_of_date` starting on or before the specified
-      #     date (YYYY-MM-DD).
+      #   date (YYYY-MM-DD).
       #
       #   @return [Date, nil]
       optional :as_of_date_end, Date
@@ -25,7 +26,7 @@ module ModernTreasury
 
       # @!attribute [r] as_of_date_start
       #   Filters transactions with an `as_of_date` starting on or after the specified
-      #     date (YYYY-MM-DD).
+      #   date (YYYY-MM-DD).
       #
       #   @return [Date, nil]
       optional :as_of_date_start, Date
@@ -64,7 +65,7 @@ module ModernTreasury
 
       # @!attribute [r] internal_account_id
       #   Specify `internal_account_id` if you wish to see transactions to/from a specific
-      #     account.
+      #   account.
       #
       #   @return [String, nil]
       optional :internal_account_id, String
@@ -75,11 +76,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}]
@@ -107,7 +108,7 @@ module ModernTreasury
       #   Either `true` or `false`.
       #
       #   @return [Boolean, nil]
-      optional :posted, ModernTreasury::BooleanModel
+      optional :posted, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -124,7 +125,7 @@ module ModernTreasury
 
       # @!attribute [r] vendor_id
       #   Filters for transactions including the queried vendor id (an identifier given to
-      #     transactions by the bank).
+      #   transactions by the bank).
       #
       #   @return [String, nil]
       optional :vendor_id, String
@@ -180,7 +181,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/transaction_retrieve_params.rb

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

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class TransactionUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Transactions#update
+    class TransactionUpdateParams < 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] metadata
       #   Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
+      #   an empty string or `null` as the value.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -24,7 +25,7 @@ module ModernTreasury
       #   #
       #   def initialize(metadata: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/transactions/line_item_create_params.rb

@@ -3,14 +3,15 @@
 module ModernTreasury
   module Models
     module Transactions
-      class LineItemCreateParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::Transactions::LineItems#create
+      class LineItemCreateParams < 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
         #   If a matching object exists in Modern Treasury, `amount` will be populated.
-        #     Value in specified currency's smallest unit (taken from parent Transaction).
+        #   Value in specified currency's smallest unit (taken from parent Transaction).
         #
         #   @return [Integer]
         required :amount, Integer
@@ -35,7 +36,7 @@ module ModernTreasury
         #   #
         #   def initialize(amount:, expected_payment_id:, transaction_id:, 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/transactions/line_item_delete_params.rb

@@ -3,17 +3,18 @@
 module ModernTreasury
   module Models
     module Transactions
-      class LineItemDeleteParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::Transactions::LineItems#delete
+      class LineItemDeleteParams < 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/transactions/line_item_list_params.rb

@@ -3,15 +3,16 @@
 module ModernTreasury
   module Models
     module Transactions
-      class LineItemListParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::Transactions::LineItems#list
+      class LineItemListParams < 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
         #
         #   @return [Hash{Symbol=>String}, nil]
-        optional :id, ModernTreasury::HashOf[String]
+        optional :id, ModernTreasury::Internal::Type::HashOf[String]
 
         # @!parse
         #   # @return [Hash{Symbol=>String}]
@@ -55,10 +56,10 @@ module ModernTreasury
         #   #
         #   def initialize(id: nil, after_cursor: nil, per_page: nil, transaction_id: nil, type: nil, request_options: {}, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         module Type
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ORIGINATING = :originating
           RECEIVING = :receiving

data/lib/modern_treasury/models/transactions/line_item_retrieve_params.rb

@@ -3,17 +3,18 @@
 module ModernTreasury
   module Models
     module Transactions
-      class LineItemRetrieveParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::Transactions::LineItems#retrieve
+      class LineItemRetrieveParams < 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/transactions/transaction_line_item.rb

@@ -3,7 +3,8 @@
 module ModernTreasury
   module Models
     module Transactions
-      class TransactionLineItem < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::Transactions::LineItems#create
+      class TransactionLineItem < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -11,7 +12,7 @@ module ModernTreasury
 
         # @!attribute amount
         #   If a matching object exists in Modern Treasury, `amount` will be populated.
-        #     Value in specified currency's smallest unit (taken from parent Transaction).
+        #   Value in specified currency's smallest unit (taken from parent Transaction).
         #
         #   @return [Integer]
         required :amount, Integer
@@ -29,10 +30,10 @@ module ModernTreasury
 
         # @!attribute description
         #   If no matching object is found, `description` will be a free-form text field
-        #     describing the line item. This field may contain personally identifiable
-        #     information (PII) and is not included in API responses by default. Learn more
-        #     about changing your settings at
-        #     https://docs.moderntreasury.com/reference/personally-identifiable-information.
+        #   describing the line item. This field may contain personally identifiable
+        #   information (PII) and is not included in API responses by default. Learn more
+        #   about changing your settings at
+        #   https://docs.moderntreasury.com/reference/personally-identifiable-information.
         #
         #   @return [String]
         required :description, String
@@ -50,10 +51,10 @@ module ModernTreasury
 
         # @!attribute live_mode
         #   This field will be true if this object exists in the live environment, or false
-        #     if it exists in the test environment.
+        #   if it exists in the test environment.
         #
         #   @return [Boolean]
-        required :live_mode, ModernTreasury::BooleanModel
+        required :live_mode, ModernTreasury::Internal::Type::Boolean
 
         # @!attribute object
         #
@@ -62,21 +63,21 @@ module ModernTreasury
 
         # @!attribute reconcilable
         #   Describes whether this line item should be counted towards the corresponding
-        #     transaction’s reconciliation.
+        #   transaction’s reconciliation.
         #
         #   @return [Boolean]
-        required :reconcilable, ModernTreasury::BooleanModel
+        required :reconcilable, ModernTreasury::Internal::Type::Boolean
 
         # @!attribute transactable_id
         #   If a matching object exists in Modern Treasury, the ID will be populated here,
-        #     otherwise `null`.
+        #   otherwise `null`.
         #
         #   @return [String, nil]
         required :transactable_id, String, nil?: true
 
         # @!attribute transactable_type
         #   If a matching object exists in Modern Treasury, the type will be populated here,
-        #     otherwise `null`.
+        #   otherwise `null`.
         #
         #   @return [Symbol, ModernTreasury::Models::Transactions::TransactionLineItem::TransactableType, nil]
         required :transactable_type,
@@ -91,7 +92,7 @@ module ModernTreasury
 
         # @!attribute type
         #   Indicates whether the line item is `originating` or `receiving` (see
-        #     https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        #   https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
         #
         #   @return [Symbol, ModernTreasury::Models::Transactions::TransactionLineItem::Type]
         required :type, enum: -> { ModernTreasury::Models::Transactions::TransactionLineItem::Type }
@@ -139,12 +140,14 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # If a matching object exists in Modern Treasury, the type will be populated here,
-        #   otherwise `null`.
+        # otherwise `null`.
+        #
+        # @see ModernTreasury::Models::Transactions::TransactionLineItem#transactable_type
         module TransactableType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
           PAPER_ITEM = :paper_item
@@ -161,9 +164,11 @@ module ModernTreasury
         end
 
         # Indicates whether the line item is `originating` or `receiving` (see
-        #   https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        # https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        #
+        # @see ModernTreasury::Models::Transactions::TransactionLineItem#type
         module Type
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ORIGINATING = :originating
           RECEIVING = :receiving

data/lib/modern_treasury/models/validation_validate_routing_number_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ValidationValidateRoutingNumberParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Validations#validate_routing_number
+    class ValidationValidateRoutingNumberParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute routing_number
       #   The routing number that is being validated.
@@ -15,9 +16,9 @@ module ModernTreasury
 
       # @!attribute routing_number_type
       #   The type of routing number. See
-      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #     more details. In sandbox mode we currently only support `aba` and `swift` with
-      #     routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details. In sandbox mode we currently only support `aba` and `swift` with
+      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
       #
       #   @return [Symbol, ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType]
       required :routing_number_type,
@@ -30,14 +31,14 @@ module ModernTreasury
       #   #
       #   def initialize(routing_number:, routing_number_type:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # The type of routing number. See
-      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #   more details. In sandbox mode we currently only support `aba` and `swift` with
-      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      # https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      # more details. In sandbox mode we currently only support `aba` and `swift` with
+      # routing numbers '123456789' and 'GRINUST0XXX' respectively.
       module RoutingNumberType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ABA = :aba
         AU_BSB = :au_bsb

data/lib/modern_treasury/models/virtual_account.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class VirtualAccount < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::VirtualAccounts#create
+    class VirtualAccount < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -12,7 +13,8 @@ module ModernTreasury
       #   An array of account detail objects.
       #
       #   @return [Array<ModernTreasury::Models::AccountDetail>]
-      required :account_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::AccountDetail] }
+      required :account_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::AccountDetail] }
 
       # @!attribute counterparty_id
       #   The ID of a counterparty that the virtual account belongs to. Optional.
@@ -27,16 +29,16 @@ module ModernTreasury
 
       # @!attribute credit_ledger_account_id
       #   The ID of a credit normal ledger account. When money enters the virtual account,
-      #     this ledger account will be credited. Must be accompanied by a
-      #     debit_ledger_account_id if present.
+      #   this ledger account will be credited. Must be accompanied by a
+      #   debit_ledger_account_id if present.
       #
       #   @return [String, nil]
       required :credit_ledger_account_id, String, nil?: true
 
       # @!attribute debit_ledger_account_id
       #   The ID of a debit normal ledger account. When money enters the virtual account,
-      #     this ledger account will be debited. Must be accompanied by a
-      #     credit_ledger_account_id if present.
+      #   this ledger account will be debited. Must be accompanied by a
+      #   credit_ledger_account_id if present.
       #
       #   @return [String, nil]
       required :debit_ledger_account_id, String, nil?: true
@@ -60,24 +62,24 @@ module ModernTreasury
 
       # @!attribute ledger_account_id
       #   If the virtual account links to a ledger account in Modern Treasury, the id of
-      #     the ledger account will be populated here.
+      #   the ledger account will be populated here.
       #
       #   @return [String, nil]
       required :ledger_account_id, String, nil?: true
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
-      #     if it exists in the test environment.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, ModernTreasury::HashOf[String]
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute name
       #   The name of the virtual account.
@@ -92,10 +94,11 @@ module ModernTreasury
 
       # @!attribute routing_details
       #   An array of routing detail objects. These will be the routing details of the
-      #     internal account.
+      #   internal account.
       #
       #   @return [Array<ModernTreasury::Models::RoutingDetail>]
-      required :routing_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+      required :routing_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::RoutingDetail] }
 
       # @!attribute updated_at
       #
@@ -142,7 +145,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end