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

data/lib/modern_treasury/models/transaction_create_params.rb

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class TransactionCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Transactions#create
+    class TransactionCreateParams < 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.
+      #   as 1000.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -34,26 +35,26 @@ module ModernTreasury
 
       # @!attribute vendor_code
       #   When applicable, the bank-given code that determines the transaction's category.
-      #     For most banks this is the BAI2/BTRS transaction code.
+      #   For most banks this is the BAI2/BTRS transaction code.
       #
       #   @return [String, nil]
       required :vendor_code, String, nil?: true
 
       # @!attribute vendor_code_type
       #   The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
-      #     `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-      #     `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-      #     `swift`, `us_bank`, or others.
+      #   `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+      #   `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+      #   `swift`, `us_bank`, or others.
       #
       #   @return [String, nil]
       required :vendor_code_type, String, 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}]
@@ -63,7 +64,7 @@ module ModernTreasury
       #   This field will be `true` if the transaction has posted to the account.
       #
       #   @return [Boolean, nil]
-      optional :posted, ModernTreasury::BooleanModel
+      optional :posted, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -71,14 +72,14 @@ module ModernTreasury
 
       # @!attribute type
       #   The type of the transaction. Examples could be
-      #     `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
       #
       #   @return [Symbol, ModernTreasury::Models::TransactionCreateParams::Type, nil]
       optional :type, enum: -> { ModernTreasury::Models::TransactionCreateParams::Type }, nil?: true
 
       # @!attribute vendor_description
       #   The transaction detail text that often appears in on your bank statement and in
-      #     your banking portal.
+      #   your banking portal.
       #
       #   @return [String, nil]
       optional :vendor_description, String, nil?: true
@@ -113,31 +114,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of the transaction. Examples could be
-      #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
-      #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      # `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -174,7 +157,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/transaction_delete_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class TransactionDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Transactions#delete
+    class TransactionDeleteParams < 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_direction.rb

@@ -2,18 +2,9 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
-    # @example
-    # ```ruby
-    # case transaction_direction
-    # in :credit
-    #   # ...
-    # in :debit
-    #   # ...
-    # end
-    # ```
-    class TransactionDirection < ModernTreasury::Enum
+    module TransactionDirection
+      extend ModernTreasury::Internal::Type::Enum
+
       CREDIT = :credit
       DEBIT = :debit
 
@@ -21,7 +12,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

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,20 +56,11 @@ 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::Internal::Type::Enum
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :originating
-        #   # ...
-        # in :receiving
-        #   # ...
-        # end
-        # ```
-        class Type < ModernTreasury::Enum
           ORIGINATING = :originating
           RECEIVING = :receiving
 
@@ -76,7 +68,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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,31 +140,15 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        # @abstract
-        #
         # If a matching object exists in Modern Treasury, the type will be populated here,
-        #   otherwise `null`.
+        # otherwise `null`.
         #
-        # @example
-        # ```ruby
-        # case transactable_type
-        # in :incoming_payment_detail
-        #   # ...
-        # in :paper_item
-        #   # ...
-        # in :payment_order
-        #   # ...
-        # in :payment_order_attempt
-        #   # ...
-        # in :return
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class TransactableType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::Transactions::TransactionLineItem#transactable_type
+        module TransactableType
+          extend ModernTreasury::Internal::Type::Enum
+
           INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
           PAPER_ITEM = :paper_item
           PAYMENT_ORDER = :payment_order
@@ -175,25 +160,16 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # 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).
         #
-        # @example
-        # ```ruby
-        # case type
-        # in :originating
-        #   # ...
-        # in :receiving
-        #   # ...
-        # end
-        # ```
-        class Type < ModernTreasury::Enum
+        # @see ModernTreasury::Models::Transactions::TransactionLineItem#type
+        module Type
+          extend ModernTreasury::Internal::Type::Enum
+
           ORIGINATING = :originating
           RECEIVING = :receiving
 
@@ -201,7 +177,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end