modern_treasury 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/models/document_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Documents#list
     class DocumentListParams < 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,47 +12,38 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] documentable_id
+      # @!attribute documentable_id
       #   The unique identifier for the associated object.
       #
       #   @return [String, nil]
       optional :documentable_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :documentable_id
-
-      # @!attribute [r] documentable_type
+      # @!attribute documentable_type
       #   The type of the associated object. Currently can be one of `payment_order`,
       #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
       #   `case`, `internal_account`, `decision`, or `external_account`.
       #
-      #   @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType, nil]
-      optional :documentable_type, enum: -> { ModernTreasury::Models::DocumentListParams::DocumentableType }
-
-      # @!parse
-      #   # @return [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType]
-      #   attr_writer :documentable_type
+      #   @return [Symbol, ModernTreasury::DocumentListParams::DocumentableType, nil]
+      optional :documentable_type, enum: -> { ModernTreasury::DocumentListParams::DocumentableType }
 
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!parse
-      #   # @param after_cursor [String, nil]
-      #   # @param documentable_id [String]
-      #   # @param documentable_type [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType]
-      #   # @param per_page [Integer]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::DocumentListParams} for more details.
+      #
+      #   @param after_cursor [String, nil]
+      #
+      #   @param documentable_id [String] The unique identifier for the associated object.
+      #
+      #   @param documentable_type [Symbol, ModernTreasury::DocumentListParams::DocumentableType] The type of the associated object. Currently can be one of `payment_order`, `tra
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of the associated object. Currently can be one of `payment_order`,
       # `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
@@ -74,11 +64,8 @@ module ModernTreasury
         DECISIONS = :decisions
         CONNECTIONS = :connections
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/document_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Documents#retrieve
     class DocumentRetrieveParams < 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/event.rb

@@ -61,35 +61,29 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param created_at [Time]
-      #   # @param data [Hash{Symbol=>Object}]
-      #   # @param entity_id [String]
-      #   # @param event_name [String]
-      #   # @param event_time [Time]
-      #   # @param live_mode [Boolean]
-      #   # @param object [String]
-      #   # @param resource [String]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     created_at:,
-      #     data:,
-      #     entity_id:,
-      #     event_name:,
-      #     event_time:,
-      #     live_mode:,
-      #     object:,
-      #     resource:,
-      #     updated_at:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, created_at:, data:, entity_id:, event_name:, event_time:, live_mode:, object:, resource:, updated_at:)
+      #   Some parameter documentations has been truncated, see {ModernTreasury::Event}
+      #   for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param data [Hash{Symbol=>Object}] The body of the event.
+      #
+      #   @param entity_id [String] The ID of the entity for the event.
+      #
+      #   @param event_name [String] The name of the event.
+      #
+      #   @param event_time [Time] The time of the event.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param resource [String] The type of resource for the event.
+      #
+      #   @param updated_at [Time]
     end
   end
 end

data/lib/modern_treasury/models/event_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Events#list
     class EventListParams < 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,87 +12,54 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] entity_id
+      # @!attribute entity_id
       #
       #   @return [String, nil]
       optional :entity_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :entity_id
-
-      # @!attribute [r] event_name
+      # @!attribute event_name
       #
       #   @return [String, nil]
       optional :event_name, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :event_name
-
-      # @!attribute [r] event_time_end
+      # @!attribute event_time_end
       #   An inclusive upper bound for when the event occurred
       #
       #   @return [Time, nil]
       optional :event_time_end, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :event_time_end
-
-      # @!attribute [r] event_time_start
+      # @!attribute event_time_start
       #   An inclusive lower bound for when the event occurred
       #
       #   @return [Time, nil]
       optional :event_time_start, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :event_time_start
-
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!attribute [r] resource
+      # @!attribute resource
       #
       #   @return [String, nil]
       optional :resource, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :resource
-
-      # @!parse
-      #   # @param after_cursor [String, nil]
-      #   # @param entity_id [String]
-      #   # @param event_name [String]
-      #   # @param event_time_end [Time]
-      #   # @param event_time_start [Time]
-      #   # @param per_page [Integer]
-      #   # @param resource [String]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     after_cursor: nil,
-      #     entity_id: nil,
-      #     event_name: nil,
-      #     event_time_end: nil,
-      #     event_time_start: nil,
-      #     per_page: nil,
-      #     resource: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, entity_id: nil, event_name: nil, event_time_end: nil, event_time_start: nil, per_page: nil, resource: nil, request_options: {})
+      #   @param after_cursor [String, nil]
+      #
+      #   @param entity_id [String]
+      #
+      #   @param event_name [String]
+      #
+      #   @param event_time_end [Time] An inclusive upper bound for when the event occurred
+      #
+      #   @param event_time_start [Time] An inclusive lower bound for when the event occurred
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param resource [String]
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/event_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Events#retrieve
     class EventRetrieveParams < 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/expected_payment.rb

@@ -37,8 +37,8 @@ module ModernTreasury
       # @!attribute currency
       #   Must conform to ISO 4217. Defaults to the currency of the internal account.
       #
-      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
-      required :currency, enum: -> { ModernTreasury::Models::Currency }, nil?: true
+      #   @return [Symbol, ModernTreasury::Currency, nil]
+      required :currency, enum: -> { ModernTreasury::Currency }, nil?: true
 
       # @!attribute date_lower_bound
       #   The earliest date the payment may come in. Format: yyyy-mm-dd
@@ -62,8 +62,8 @@ module ModernTreasury
       #   One of credit or debit. When you are receiving money, use credit. When you are
       #   being charged, use debit.
       #
-      #   @return [Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil]
-      required :direction, enum: -> { ModernTreasury::Models::ExpectedPayment::Direction }, nil?: true
+      #   @return [Symbol, ModernTreasury::ExpectedPayment::Direction, nil]
+      required :direction, enum: -> { ModernTreasury::ExpectedPayment::Direction }, nil?: true
 
       # @!attribute internal_account_id
       #   The ID of the Internal Account for the expected payment.
@@ -113,17 +113,17 @@ module ModernTreasury
       #   automatic if it was automatically reconciled by Modern Treasury, or null if it
       #   is unreconciled.
       #
-      #   @return [Symbol, ModernTreasury::Models::ExpectedPayment::ReconciliationMethod, nil]
+      #   @return [Symbol, ModernTreasury::ExpectedPayment::ReconciliationMethod, nil]
       required :reconciliation_method,
-               enum: -> { ModernTreasury::Models::ExpectedPayment::ReconciliationMethod },
+               enum: -> { ModernTreasury::ExpectedPayment::ReconciliationMethod },
                nil?: true
 
       # @!attribute reconciliation_rule_variables
       #   An array of reconciliation rule variables for this payment.
       #
-      #   @return [Array<ModernTreasury::Models::ReconciliationRule>, nil]
+      #   @return [Array<ModernTreasury::ReconciliationRule>, nil]
       required :reconciliation_rule_variables,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ReconciliationRule] },
                nil?: true
 
       # @!attribute remittance_information
@@ -146,8 +146,8 @@ module ModernTreasury
       # @!attribute status
       #   One of unreconciled, partially_reconciled, reconciled, or archived.
       #
-      #   @return [Symbol, ModernTreasury::Models::ExpectedPayment::Status]
-      required :status, enum: -> { ModernTreasury::Models::ExpectedPayment::Status }
+      #   @return [Symbol, ModernTreasury::ExpectedPayment::Status]
+      required :status, enum: -> { ModernTreasury::ExpectedPayment::Status }
 
       # @!attribute transaction_id
       #   The ID of the Transaction this expected payment object has been matched to.
@@ -165,114 +165,102 @@ module ModernTreasury
       #   One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
       #   sepa, signet, wire.
       #
-      #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
-      required :type, enum: -> { ModernTreasury::Models::ExpectedPaymentType }, nil?: true
+      #   @return [Symbol, ModernTreasury::ExpectedPaymentType, nil]
+      required :type, enum: -> { ModernTreasury::ExpectedPaymentType }, nil?: true
 
       # @!attribute updated_at
       #
       #   @return [Time]
       required :updated_at, Time
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param amount_lower_bound [Integer, nil]
-      #   # @param amount_upper_bound [Integer, nil]
-      #   # @param counterparty_id [String, nil]
-      #   # @param created_at [Time]
-      #   # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
-      #   # @param date_lower_bound [Date, nil]
-      #   # @param date_upper_bound [Date, nil]
-      #   # @param description [String, nil]
-      #   # @param direction [Symbol, ModernTreasury::Models::ExpectedPayment::Direction, nil]
-      #   # @param internal_account_id [String, nil]
-      #   # @param ledger_transaction_id [String, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param object [String]
-      #   # @param reconciliation_filters [Object, nil]
-      #   # @param reconciliation_groups [Object, nil]
-      #   # @param reconciliation_method [Symbol, ModernTreasury::Models::ExpectedPayment::ReconciliationMethod, nil]
-      #   # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil]
-      #   # @param remittance_information [String, nil]
-      #   # @param statement_descriptor [String, nil]
-      #   # @param status [Symbol, ModernTreasury::Models::ExpectedPayment::Status]
-      #   # @param transaction_id [String, nil]
-      #   # @param transaction_line_item_id [String, nil]
-      #   # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     amount_lower_bound:,
-      #     amount_upper_bound:,
-      #     counterparty_id:,
-      #     created_at:,
-      #     currency:,
-      #     date_lower_bound:,
-      #     date_upper_bound:,
-      #     description:,
-      #     direction:,
-      #     internal_account_id:,
-      #     ledger_transaction_id:,
-      #     live_mode:,
-      #     metadata:,
-      #     object:,
-      #     reconciliation_filters:,
-      #     reconciliation_groups:,
-      #     reconciliation_method:,
-      #     reconciliation_rule_variables:,
-      #     remittance_information:,
-      #     statement_descriptor:,
-      #     status:,
-      #     transaction_id:,
-      #     transaction_line_item_id:,
-      #     type:,
-      #     updated_at:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, amount_lower_bound:, amount_upper_bound:, counterparty_id:, created_at:, currency:, date_lower_bound:, date_upper_bound:, description:, direction:, internal_account_id:, ledger_transaction_id:, live_mode:, metadata:, object:, reconciliation_filters:, reconciliation_groups:, reconciliation_method:, reconciliation_rule_variables:, remittance_information:, statement_descriptor:, status:, transaction_id:, transaction_line_item_id:, type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::ExpectedPayment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
+      #
+      #   @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
+      #
+      #   @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param currency [Symbol, ModernTreasury::Currency, nil] Must conform to ISO 4217. Defaults to the currency of the internal account.
+      #
+      #   @param date_lower_bound [Date, nil] The earliest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @param date_upper_bound [Date, nil] The latest date the payment may come in. Format: yyyy-mm-dd
+      #
+      #   @param description [String, nil] An optional description for internal use.
+      #
+      #   @param direction [Symbol, ModernTreasury::ExpectedPayment::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
+      #
+      #   @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
+      #
+      #   @param ledger_transaction_id [String, nil] The ID of the ledger transaction linked to the expected payment.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param object [String]
+      #
+      #   @param reconciliation_filters [Object, nil] The reconciliation filters you have for this payment.
+      #
+      #   @param reconciliation_groups [Object, nil] The reconciliation groups you have for this payment.
+      #
+      #   @param reconciliation_method [Symbol, ModernTreasury::ExpectedPayment::ReconciliationMethod, nil] One of manual if this expected payment was manually reconciled in the dashboard,
+      #
+      #   @param reconciliation_rule_variables [Array<ModernTreasury::ReconciliationRule>, nil] An array of reconciliation rule variables for this payment.
+      #
+      #   @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
+      #
+      #   @param statement_descriptor [String, nil] The statement description you expect to see on the transaction. For ACH payments
+      #
+      #   @param status [Symbol, ModernTreasury::ExpectedPayment::Status] One of unreconciled, partially_reconciled, reconciled, or archived.
+      #
+      #   @param transaction_id [String, nil] The ID of the Transaction this expected payment object has been matched to.
+      #
+      #   @param transaction_line_item_id [String, nil] The ID of the Transaction Line Item this expected payment has been matched to.
+      #
+      #   @param type [Symbol, ModernTreasury::ExpectedPaymentType, nil] One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, se
+      #
+      #   @param updated_at [Time]
 
       # One of credit or debit. When you are receiving money, use credit. When you are
       # being charged, use debit.
       #
-      # @see ModernTreasury::Models::ExpectedPayment#direction
+      # @see ModernTreasury::ExpectedPayment#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
 
       # One of manual if this expected payment was manually reconciled in the dashboard,
       # automatic if it was automatically reconciled by Modern Treasury, or null if it
       # is unreconciled.
       #
-      # @see ModernTreasury::Models::ExpectedPayment#reconciliation_method
+      # @see ModernTreasury::ExpectedPayment#reconciliation_method
       module ReconciliationMethod
         extend ModernTreasury::Internal::Type::Enum
 
         AUTOMATIC = :automatic
         MANUAL = :manual
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # One of unreconciled, partially_reconciled, reconciled, or archived.
       #
-      # @see ModernTreasury::Models::ExpectedPayment#status
+      # @see ModernTreasury::ExpectedPayment#status
       module Status
         extend ModernTreasury::Internal::Type::Enum
 
@@ -281,11 +269,8 @@ module ModernTreasury
         RECONCILED = :reconciled
         UNRECONCILED = :unreconciled
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end