modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/models/payment_flow.rb

@@ -4,37 +4,25 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentFlows#create
     class PaymentFlow < ModernTreasury::Internal::Type::BaseModel
-      # @!attribute [r] id
+      # @!attribute id
       #
       #   @return [String, nil]
       optional :id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :id
-
-      # @!attribute [r] amount
+      # @!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.
       #
       #   @return [Integer, nil]
       optional :amount, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :amount
-
-      # @!attribute [r] client_token
+      # @!attribute client_token
       #   The client token of the payment flow. This token can be used to embed a payment
       #   workflow in your client-side application.
       #
       #   @return [String, nil]
       optional :client_token, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :client_token
-
       # @!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.
@@ -42,35 +30,23 @@ module ModernTreasury
       #   @return [String, nil]
       optional :counterparty_id, String, nil?: true
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #
       #   @return [Time, nil]
       optional :created_at, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :created_at
-
-      # @!attribute [r] currency
+      # @!attribute currency
       #   The currency of the payment.
       #
       #   @return [String, nil]
       optional :currency, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :currency
-
-      # @!attribute [r] direction
+      # @!attribute 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.
       #
-      #   @return [Symbol, ModernTreasury::Models::PaymentFlow::Direction, nil]
-      optional :direction, enum: -> { ModernTreasury::Models::PaymentFlow::Direction }
-
-      # @!parse
-      #   # @return [Symbol, ModernTreasury::Models::PaymentFlow::Direction]
-      #   attr_writer :direction
+      #   @return [Symbol, ModernTreasury::PaymentFlow::Direction, nil]
+      optional :direction, enum: -> { ModernTreasury::PaymentFlow::Direction }
 
       # @!attribute due_date
       #   The due date for the flow. Can only be passed in when
@@ -79,60 +55,46 @@ module ModernTreasury
       #   @return [Date, nil]
       optional :due_date, Date, nil?: true
 
-      # @!attribute [r] effective_date_selection_enabled
+      # @!attribute effective_date_selection_enabled
       #   When `true`, your end-user can schedule the payment `effective_date` while
       #   completing the pre-built UI.
       #
       #   @return [Boolean, nil]
       optional :effective_date_selection_enabled, ModernTreasury::Internal::Type::Boolean
 
-      # @!parse
-      #   # @return [Boolean]
-      #   attr_writer :effective_date_selection_enabled
-
       # @!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`.
       #
-      #   @return [Symbol, ModernTreasury::Models::PaymentFlow::ExistingExternalAccountsFilter, nil]
+      #   @return [Symbol, ModernTreasury::PaymentFlow::ExistingExternalAccountsFilter, nil]
       optional :existing_external_accounts_filter,
-               enum: -> { ModernTreasury::Models::PaymentFlow::ExistingExternalAccountsFilter },
+               enum: -> { ModernTreasury::PaymentFlow::ExistingExternalAccountsFilter },
                nil?: true
 
-      # @!attribute [r] external_account_collection
+      # @!attribute 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.
       #
-      #   @return [Symbol, ModernTreasury::Models::PaymentFlow::ExternalAccountCollection, nil]
+      #   @return [Symbol, ModernTreasury::PaymentFlow::ExternalAccountCollection, nil]
       optional :external_account_collection,
-               enum: -> { ModernTreasury::Models::PaymentFlow::ExternalAccountCollection }
+               enum: -> {
+                 ModernTreasury::PaymentFlow::ExternalAccountCollection
+               }
 
-      # @!parse
-      #   # @return [Symbol, ModernTreasury::Models::PaymentFlow::ExternalAccountCollection]
-      #   attr_writer :external_account_collection
-
-      # @!attribute [r] live_mode
+      # @!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.
       #
       #   @return [Boolean, nil]
       optional :live_mode, ModernTreasury::Internal::Type::Boolean
 
-      # @!parse
-      #   # @return [Boolean]
-      #   attr_writer :live_mode
-
-      # @!attribute [r] object
+      # @!attribute object
       #
       #   @return [String, nil]
       optional :object, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :object
-
       # @!attribute originating_account_id
       #   The ID of one of your organization's internal accounts.
       #
@@ -159,130 +121,107 @@ module ModernTreasury
       #   @return [Date, nil]
       optional :selected_effective_date, Date, nil?: true
 
-      # @!attribute [r] status
+      # @!attribute status
       #   The current status of the payment flow. One of `pending`, `completed`,
       #   `expired`, or `cancelled`.
       #
-      #   @return [Symbol, ModernTreasury::Models::PaymentFlow::Status, nil]
-      optional :status, enum: -> { ModernTreasury::Models::PaymentFlow::Status }
-
-      # @!parse
-      #   # @return [Symbol, ModernTreasury::Models::PaymentFlow::Status]
-      #   attr_writer :status
+      #   @return [Symbol, ModernTreasury::PaymentFlow::Status, nil]
+      optional :status, enum: -> { ModernTreasury::PaymentFlow::Status }
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #
       #   @return [Time, nil]
       optional :updated_at, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :updated_at
-
-      # @!parse
-      #   # @param id [String]
-      #   # @param amount [Integer]
-      #   # @param client_token [String]
-      #   # @param counterparty_id [String, nil]
-      #   # @param created_at [Time]
-      #   # @param currency [String]
-      #   # @param direction [Symbol, ModernTreasury::Models::PaymentFlow::Direction]
-      #   # @param due_date [Date, nil]
-      #   # @param effective_date_selection_enabled [Boolean]
-      #   # @param existing_external_accounts_filter [Symbol, ModernTreasury::Models::PaymentFlow::ExistingExternalAccountsFilter, nil]
-      #   # @param external_account_collection [Symbol, ModernTreasury::Models::PaymentFlow::ExternalAccountCollection]
-      #   # @param live_mode [Boolean]
-      #   # @param object [String]
-      #   # @param originating_account_id [String, nil]
-      #   # @param payment_order_id [String, nil]
-      #   # @param receiving_account_id [String, nil]
-      #   # @param selected_effective_date [Date, nil]
-      #   # @param status [Symbol, ModernTreasury::Models::PaymentFlow::Status]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id: nil,
-      #     amount: nil,
-      #     client_token: nil,
-      #     counterparty_id: nil,
-      #     created_at: nil,
-      #     currency: nil,
-      #     direction: nil,
-      #     due_date: nil,
-      #     effective_date_selection_enabled: nil,
-      #     existing_external_accounts_filter: nil,
-      #     external_account_collection: nil,
-      #     live_mode: nil,
-      #     object: nil,
-      #     originating_account_id: nil,
-      #     payment_order_id: nil,
-      #     receiving_account_id: nil,
-      #     selected_effective_date: nil,
-      #     status: nil,
-      #     updated_at: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id: nil, amount: nil, client_token: nil, counterparty_id: nil, created_at: nil, currency: nil, direction: nil, due_date: nil, effective_date_selection_enabled: nil, existing_external_accounts_filter: nil, external_account_collection: nil, live_mode: nil, object: nil, originating_account_id: nil, payment_order_id: nil, receiving_account_id: nil, selected_effective_date: nil, status: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::PaymentFlow} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+      #
+      #   @param client_token [String] The client token of the payment flow. This token can be used to embed a payment
+      #
+      #   @param counterparty_id [String, nil] The ID of a counterparty associated with the payment. As part of the payment wor
+      #
+      #   @param created_at [Time]
+      #
+      #   @param currency [String] The currency of the payment.
+      #
+      #   @param direction [Symbol, ModernTreasury::PaymentFlow::Direction] Describes the direction money is flowing in the transaction. Can only be `debit`
+      #
+      #   @param due_date [Date, nil] The due date for the flow. Can only be passed in when `effective*date_selection*
+      #
+      #   @param effective_date_selection_enabled [Boolean] When `true`, your end-user can schedule the payment `effective_date` while compl
+      #
+      #   @param existing_external_accounts_filter [Symbol, ModernTreasury::PaymentFlow::ExistingExternalAccountsFilter, nil] When `verified` and `external_account_collection` is `enabled`, filters the list
+      #
+      #   @param external_account_collection [Symbol, ModernTreasury::PaymentFlow::ExternalAccountCollection] When `enabled`, your end-user can select from an existing external account when
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param originating_account_id [String, nil] The ID of one of your organization's internal accounts.
+      #
+      #   @param payment_order_id [String, nil] If present, the ID of the payment order created using this flow.
+      #
+      #   @param receiving_account_id [String, nil] If present, the ID of the external account created using this flow.
+      #
+      #   @param selected_effective_date [Date, nil] This field is set after your end-user selects a payment date while completing th
+      #
+      #   @param status [Symbol, ModernTreasury::PaymentFlow::Status] The current status of the payment flow. One of `pending`, `completed`, `expired`
+      #
+      #   @param updated_at [Time]
 
       # 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.
       #
-      # @see ModernTreasury::Models::PaymentFlow#direction
+      # @see ModernTreasury::PaymentFlow#direction
       module Direction
         extend ModernTreasury::Internal::Type::Enum
 
         CREDIT = :credit
         DEBIT = :debit
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       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`.
       #
-      # @see ModernTreasury::Models::PaymentFlow#existing_external_accounts_filter
+      # @see ModernTreasury::PaymentFlow#existing_external_accounts_filter
       module ExistingExternalAccountsFilter
         extend ModernTreasury::Internal::Type::Enum
 
         VERIFIED = :verified
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       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.
       #
-      # @see ModernTreasury::Models::PaymentFlow#external_account_collection
+      # @see ModernTreasury::PaymentFlow#external_account_collection
       module ExternalAccountCollection
         extend ModernTreasury::Internal::Type::Enum
 
         DISABLED = :disabled
         ENABLED = :enabled
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The current status of the payment flow. One of `pending`, `completed`,
       # `expired`, or `cancelled`.
       #
-      # @see ModernTreasury::Models::PaymentFlow#status
+      # @see ModernTreasury::PaymentFlow#status
       module Status
         extend ModernTreasury::Internal::Type::Enum
 
@@ -291,11 +230,8 @@ module ModernTreasury
         EXPIRED = :expired
         PENDING = :pending
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/payment_flow_create_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentFlows#create
     class PaymentFlowCreateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute amount
@@ -32,8 +31,8 @@ module ModernTreasury
       #   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.
       #
-      #   @return [Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction]
-      required :direction, enum: -> { ModernTreasury::Models::PaymentFlowCreateParams::Direction }
+      #   @return [Symbol, ModernTreasury::PaymentFlowCreateParams::Direction]
+      required :direction, enum: -> { ModernTreasury::PaymentFlowCreateParams::Direction }
 
       # @!attribute originating_account_id
       #   Required. The ID of one of your organization's internal accounts.
@@ -41,7 +40,7 @@ module ModernTreasury
       #   @return [String]
       required :originating_account_id, String
 
-      # @!attribute [r] due_date
+      # @!attribute 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`.
@@ -49,33 +48,23 @@ module ModernTreasury
       #   @return [Date, nil]
       optional :due_date, Date
 
-      # @!parse
-      #   # @return [Date]
-      #   attr_writer :due_date
-
-      # @!parse
-      #   # @param amount [Integer]
-      #   # @param counterparty_id [String]
-      #   # @param currency [String]
-      #   # @param direction [Symbol, ModernTreasury::Models::PaymentFlowCreateParams::Direction]
-      #   # @param originating_account_id [String]
-      #   # @param due_date [Date]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     amount:,
-      #     counterparty_id:,
-      #     currency:,
-      #     direction:,
-      #     originating_account_id:,
-      #     due_date: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount:, counterparty_id:, currency:, direction:, originating_account_id:, due_date: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentFlowCreateParams} for more details.
+      #
+      #   @param amount [Integer] Required. Value in specified currency's smallest unit. e.g. $10 would be represe
+      #
+      #   @param counterparty_id [String] Required. The ID of a counterparty associated with the payment. As part of the p
+      #
+      #   @param currency [String] Required. The currency of the payment.
+      #
+      #   @param direction [Symbol, ModernTreasury::PaymentFlowCreateParams::Direction] Required. Describes the direction money is flowing in the transaction. Can only
+      #
+      #   @param originating_account_id [String] Required. The ID of one of your organization's internal accounts.
+      #
+      #   @param due_date [Date] Optional. Can only be passed in when `effective_date_selection_enabled` is `true
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # 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.
@@ -85,11 +74,8 @@ module ModernTreasury
         CREDIT = :credit
         DEBIT = :debit
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/payment_flow_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentFlows#list
     class PaymentFlowListParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
@@ -13,96 +12,51 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] client_token
+      # @!attribute client_token
       #
       #   @return [String, nil]
       optional :client_token, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :client_token
-
-      # @!attribute [r] counterparty_id
+      # @!attribute counterparty_id
       #
       #   @return [String, nil]
       optional :counterparty_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :counterparty_id
-
-      # @!attribute [r] originating_account_id
+      # @!attribute originating_account_id
       #
       #   @return [String, nil]
       optional :originating_account_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :originating_account_id
-
-      # @!attribute [r] payment_order_id
+      # @!attribute payment_order_id
       #
       #   @return [String, nil]
       optional :payment_order_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :payment_order_id
-
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!attribute [r] receiving_account_id
+      # @!attribute receiving_account_id
       #
       #   @return [String, nil]
       optional :receiving_account_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :receiving_account_id
-
-      # @!attribute [r] status
+      # @!attribute status
       #
       #   @return [String, nil]
       optional :status, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :status
-
-      # @!parse
-      #   # @param after_cursor [String, nil]
-      #   # @param client_token [String]
-      #   # @param counterparty_id [String]
-      #   # @param originating_account_id [String]
-      #   # @param payment_order_id [String]
-      #   # @param per_page [Integer]
-      #   # @param receiving_account_id [String]
-      #   # @param status [String]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     after_cursor: nil,
-      #     client_token: nil,
-      #     counterparty_id: nil,
-      #     originating_account_id: nil,
-      #     payment_order_id: nil,
-      #     per_page: nil,
-      #     receiving_account_id: nil,
-      #     status: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, client_token: nil, counterparty_id: nil, originating_account_id: nil, payment_order_id: nil, per_page: nil, receiving_account_id: nil, status: nil, request_options: {})
+      #   @param after_cursor [String, nil]
+      #   @param client_token [String]
+      #   @param counterparty_id [String]
+      #   @param originating_account_id [String]
+      #   @param payment_order_id [String]
+      #   @param per_page [Integer]
+      #   @param receiving_account_id [String]
+      #   @param status [String]
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/payment_flow_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentFlows#retrieve
     class PaymentFlowRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      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::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/payment_flow_update_params.rb

@@ -4,24 +4,23 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentFlows#update
     class PaymentFlowUpdateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      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`.
       #
-      #   @return [Symbol, ModernTreasury::Models::PaymentFlowUpdateParams::Status]
-      required :status, enum: -> { ModernTreasury::Models::PaymentFlowUpdateParams::Status }
+      #   @return [Symbol, ModernTreasury::PaymentFlowUpdateParams::Status]
+      required :status, enum: -> { ModernTreasury::PaymentFlowUpdateParams::Status }
 
-      # @!parse
-      #   # @param status [Symbol, ModernTreasury::Models::PaymentFlowUpdateParams::Status]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(status:, request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(status:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentFlowUpdateParams} for more details.
+      #
+      #   @param status [Symbol, ModernTreasury::PaymentFlowUpdateParams::Status] Required. The updated status of the payment flow. Can only be used to mark a flo
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # Required. The updated status of the payment flow. Can only be used to mark a
       # flow as `cancelled`.
@@ -30,11 +29,8 @@ module ModernTreasury
 
         CANCELLED = :cancelled
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end