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

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,12 +225,14 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # 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.
+      #
+      # @see ModernTreasury::Models::PaymentFlow#direction
       module Direction
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CREDIT = :credit
         DEBIT = :debit
@@ -242,10 +245,12 @@ module ModernTreasury
       end
 
       # 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`.
+      #
+      # @see ModernTreasury::Models::PaymentFlow#existing_external_accounts_filter
       module ExistingExternalAccountsFilter
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         VERIFIED = :verified
 
@@ -257,10 +262,12 @@ module ModernTreasury
       end
 
       # 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.
+      #
+      # @see ModernTreasury::Models::PaymentFlow#external_account_collection
       module ExternalAccountCollection
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         DISABLED = :disabled
         ENABLED = :enabled
@@ -273,9 +280,11 @@ module ModernTreasury
       end
 
       # The current status of the payment flow. One of `pending`, `completed`,
-      #   `expired`, or `cancelled`.
+      # `expired`, or `cancelled`.
+      #
+      # @see ModernTreasury::Models::PaymentFlow#status
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CANCELLED = :cancelled
         COMPLETED = :completed

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,12 +75,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # 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.
       module Direction
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CREDIT = :credit
         DEBIT = :debit

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,12 +21,12 @@ module ModernTreasury
       #   #
       #   def initialize(status:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # Required. The updated status of the payment flow. Can only be used to mark a
-      #   flow as `cancelled`.
+      # flow as `cancelled`.
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CANCELLED = :cancelled