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

data/lib/modern_treasury/models/line_item_retrieve_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LineItemRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::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
 
       # @!attribute itemizable_type
       #
@@ -24,20 +25,11 @@ module ModernTreasury
       #   #
       #   def initialize(itemizable_type:, itemizable_id:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module ItemizableType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case itemizable_type
-      # in :expected_payments
-      #   # ...
-      # in :payment_orders
-      #   # ...
-      # end
-      # ```
-      class ItemizableType < ModernTreasury::Enum
         EXPECTED_PAYMENTS = :expected_payments
         PAYMENT_ORDERS = :payment_orders
 
@@ -45,7 +37,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/line_item_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LineItemUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LineItems#update
+    class LineItemUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute itemizable_type
       #
@@ -19,10 +20,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}]
@@ -36,20 +37,11 @@ module ModernTreasury
       #   #
       #   def initialize(itemizable_type:, itemizable_id:, metadata: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module ItemizableType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case itemizable_type
-      # in :expected_payments
-      #   # ...
-      # in :payment_orders
-      #   # ...
-      # end
-      # ```
-      class ItemizableType < ModernTreasury::Enum
         EXPECTED_PAYMENTS = :expected_payments
         PAYMENT_ORDERS = :payment_orders
 
@@ -57,7 +49,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/paper_item.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class PaperItem < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaperItems#retrieve
+    class PaperItem < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -51,10 +52,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 lockbox_number
       #   The identifier for the lockbox assigned by the bank.
@@ -87,7 +88,7 @@ module ModernTreasury
 
       # @!attribute status
       #   The current status of the paper item. One of `pending`, `completed`, or
-      #     `returned`.
+      #   `returned`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaperItem::Status]
       required :status, enum: -> { ModernTreasury::Models::PaperItem::Status }
@@ -153,25 +154,15 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The current status of the paper item. One of `pending`, `completed`, or
-      #   `returned`.
+      # `returned`.
       #
-      # @example
-      # ```ruby
-      # case status
-      # in :completed
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :returned
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # @see ModernTreasury::Models::PaperItem#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         COMPLETED = :completed
         PENDING = :pending
         RETURNED = :returned
@@ -180,7 +171,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/paper_item_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class PaperItemListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaperItems#list
+    class PaperItemListParams < 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
       #
@@ -34,7 +35,7 @@ module ModernTreasury
 
       # @!attribute [r] lockbox_number
       #   Specify `lockbox_number` if you wish to see paper items that are associated with
-      #     a specific lockbox number.
+      #   a specific lockbox number.
       #
       #   @return [String, nil]
       optional :lockbox_number, String
@@ -72,7 +73,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/paper_item_retrieve_params.rb

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

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class PaymentFlow < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentFlows#create
+    class PaymentFlow < ModernTreasury::Internal::Type::BaseModel
       # @!attribute [r] id
       #
       #   @return [String, nil]
@@ -14,7 +15,7 @@ module ModernTreasury
 
       # @!attribute [r] 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, nil]
       optional :amount, Integer
@@ -25,7 +26,7 @@ module ModernTreasury
 
       # @!attribute [r] client_token
       #   The client token of the payment flow. This token can be used to embed a payment
-      #     workflow in your client-side application.
+      #   workflow in your client-side application.
       #
       #   @return [String, nil]
       optional :client_token, String
@@ -36,7 +37,7 @@ module ModernTreasury
 
       # @!attribute counterparty_id
       #   The ID of a counterparty associated with the payment. As part of the payment
-      #     workflow an external account will be associated with this counterparty.
+      #   workflow an external account will be associated with this counterparty.
       #
       #   @return [String, nil]
       optional :counterparty_id, String, nil?: true
@@ -62,7 +63,7 @@ module ModernTreasury
 
       # @!attribute [r] direction
       #   Describes the direction money is flowing in the transaction. Can only be
-      #     `debit`. A `debit` pulls money from someone else's account to your own.
+      #   `debit`. A `debit` pulls money from someone else's account to your own.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentFlow::Direction, nil]
       optional :direction, enum: -> { ModernTreasury::Models::PaymentFlow::Direction }
@@ -73,17 +74,17 @@ module ModernTreasury
 
       # @!attribute due_date
       #   The due date for the flow. Can only be passed in when
-      #     `effective_date_selection_enabled` is `true`.
+      #   `effective_date_selection_enabled` is `true`.
       #
       #   @return [Date, nil]
       optional :due_date, Date, nil?: true
 
       # @!attribute [r] effective_date_selection_enabled
       #   When `true`, your end-user can schedule the payment `effective_date` while
-      #     completing the pre-built UI.
+      #   completing the pre-built UI.
       #
       #   @return [Boolean, nil]
-      optional :effective_date_selection_enabled, ModernTreasury::BooleanModel
+      optional :effective_date_selection_enabled, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -91,8 +92,8 @@ module ModernTreasury
 
       # @!attribute existing_external_accounts_filter
       #   When `verified` and `external_account_collection` is `enabled`, filters the list
-      #     of external accounts your end-user can select to those with a
-      #     `verification_status` of `verified`.
+      #   of external accounts your end-user can select to those with a
+      #   `verification_status` of `verified`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentFlow::ExistingExternalAccountsFilter, nil]
       optional :existing_external_accounts_filter,
@@ -101,8 +102,8 @@ module ModernTreasury
 
       # @!attribute [r] external_account_collection
       #   When `enabled`, your end-user can select from an existing external account when
-      #     completing the flow. When `disabled`, your end-user must add new payment details
-      #     when completing the flow.
+      #   completing the flow. When `disabled`, your end-user must add new payment details
+      #   when completing the flow.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentFlow::ExternalAccountCollection, nil]
       optional :external_account_collection,
@@ -114,10 +115,10 @@ module ModernTreasury
 
       # @!attribute [r] 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, nil]
-      optional :live_mode, ModernTreasury::BooleanModel
+      optional :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -152,15 +153,15 @@ module ModernTreasury
 
       # @!attribute selected_effective_date
       #   This field is set after your end-user selects a payment date while completing
-      #     the pre-built UI. This field is always `null` unless
-      #     `effective_date_selection_enabled` is `true`.
+      #   the pre-built UI. This field is always `null` unless
+      #   `effective_date_selection_enabled` is `true`.
       #
       #   @return [Date, nil]
       optional :selected_effective_date, Date, nil?: true
 
       # @!attribute [r] status
       #   The current status of the payment flow. One of `pending`, `completed`,
-      #     `expired`, or `cancelled`.
+      #   `expired`, or `cancelled`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentFlow::Status, nil]
       optional :status, enum: -> { ModernTreasury::Models::PaymentFlow::Status }
@@ -224,23 +225,15 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Describes the direction money is flowing in the transaction. Can only be
-      #   `debit`. A `debit` pulls money from someone else's account to your own.
+      # `debit`. A `debit` pulls money from someone else's account to your own.
       #
-      # @example
-      # ```ruby
-      # case direction
-      # in :credit
-      #   # ...
-      # in :debit
-      #   # ...
-      # end
-      # ```
-      class Direction < ModernTreasury::Enum
+      # @see ModernTreasury::Models::PaymentFlow#direction
+      module Direction
+        extend ModernTreasury::Internal::Type::Enum
+
         CREDIT = :credit
         DEBIT = :debit
 
@@ -248,50 +241,34 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # When `verified` and `external_account_collection` is `enabled`, filters the list
-      #   of external accounts your end-user can select to those with a
-      #   `verification_status` of `verified`.
+      # of external accounts your end-user can select to those with a
+      # `verification_status` of `verified`.
       #
-      # @example
-      # ```ruby
-      # case existing_external_accounts_filter
-      # in :verified
-      #   # ...
-      # end
-      # ```
-      class ExistingExternalAccountsFilter < ModernTreasury::Enum
+      # @see ModernTreasury::Models::PaymentFlow#existing_external_accounts_filter
+      module ExistingExternalAccountsFilter
+        extend ModernTreasury::Internal::Type::Enum
+
         VERIFIED = :verified
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # When `enabled`, your end-user can select from an existing external account when
-      #   completing the flow. When `disabled`, your end-user must add new payment details
-      #   when completing the flow.
+      # completing the flow. When `disabled`, your end-user must add new payment details
+      # when completing the flow.
       #
-      # @example
-      # ```ruby
-      # case external_account_collection
-      # in :disabled
-      #   # ...
-      # in :enabled
-      #   # ...
-      # end
-      # ```
-      class ExternalAccountCollection < ModernTreasury::Enum
+      # @see ModernTreasury::Models::PaymentFlow#external_account_collection
+      module ExternalAccountCollection
+        extend ModernTreasury::Internal::Type::Enum
+
         DISABLED = :disabled
         ENABLED = :enabled
 
@@ -299,29 +276,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The current status of the payment flow. One of `pending`, `completed`,
-      #   `expired`, or `cancelled`.
+      # `expired`, or `cancelled`.
       #
-      # @example
-      # ```ruby
-      # case status
-      # in :cancelled
-      #   # ...
-      # in :completed
-      #   # ...
-      # in :expired
-      #   # ...
-      # in :pending
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # @see ModernTreasury::Models::PaymentFlow#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         CANCELLED = :cancelled
         COMPLETED = :completed
         EXPIRED = :expired
@@ -331,7 +295,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/payment_flow_create_params.rb

@@ -2,21 +2,22 @@
 
 module ModernTreasury
   module Models
-    class PaymentFlowCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentFlows#create
+    class PaymentFlowCreateParams < 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
       #   Required. Value in specified currency's smallest unit. e.g. $10 would be
-      #     represented as 1000. Can be any integer up to 36 digits.
+      #   represented as 1000. Can be any integer up to 36 digits.
       #
       #   @return [Integer]
       required :amount, Integer
 
       # @!attribute counterparty_id
       #   Required. The ID of a counterparty associated with the payment. As part of the
-      #     payment workflow an external account will be associated with this model.
+      #   payment workflow an external account will be associated with this model.
       #
       #   @return [String]
       required :counterparty_id, String
@@ -29,7 +30,7 @@ module ModernTreasury
 
       # @!attribute direction
       #   Required. Describes the direction money is flowing in the transaction. Can only
-      #     be `debit`. A `debit` pulls money from someone else's account to your own.
+      #   be `debit`. A `debit` pulls money from someone else's account to your own.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction]
       required :direction, enum: -> { ModernTreasury::Models::PaymentFlowCreateParams::Direction }
@@ -42,8 +43,8 @@ module ModernTreasury
 
       # @!attribute [r] due_date
       #   Optional. Can only be passed in when `effective_date_selection_enabled` is
-      #     `true`. When set, the due date is shown to your end-user in the pre-built UI as
-      #     they are selecting a payment `effective_date`.
+      #   `true`. When set, the due date is shown to your end-user in the pre-built UI as
+      #   they are selecting a payment `effective_date`.
       #
       #   @return [Date, nil]
       optional :due_date, Date
@@ -74,23 +75,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Required. Describes the direction money is flowing in the transaction. Can only
-      #   be `debit`. A `debit` pulls money from someone else's account to your own.
-      #
-      # @example
-      # ```ruby
-      # case direction
-      # in :credit
-      #   # ...
-      # in :debit
-      #   # ...
-      # end
-      # ```
-      class Direction < ModernTreasury::Enum
+      # be `debit`. A `debit` pulls money from someone else's account to your own.
+      module Direction
+        extend ModernTreasury::Internal::Type::Enum
+
         CREDIT = :credit
         DEBIT = :debit
 
@@ -98,7 +89,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/payment_flow_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class PaymentFlowListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentFlows#list
+    class PaymentFlowListParams < 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
       #
@@ -101,7 +102,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/payment_flow_retrieve_params.rb

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

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class PaymentFlowUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentFlows#update
+    class PaymentFlowUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute status
       #   Required. The updated status of the payment flow. Can only be used to mark a
-      #     flow as `cancelled`.
+      #   flow as `cancelled`.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentFlowUpdateParams::Status]
       required :status, enum: -> { ModernTreasury::Models::PaymentFlowUpdateParams::Status }
@@ -20,28 +21,19 @@ module ModernTreasury
       #   #
       #   def initialize(status:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Required. The updated status of the payment flow. Can only be used to mark a
-      #   flow as `cancelled`.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :cancelled
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # flow as `cancelled`.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         CANCELLED = :cancelled
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end