Class: ModernTreasury::Models::DocumentListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/document_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: DocumentableType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::DocumentListParams for more details.

Parameters:

  • after_cursor (String, nil) (defaults to: nil)
  • documentable_id (String) (defaults to: nil) —

    The unique identifier for the associated object.

  • documentable_type (Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType) (defaults to: nil) —

    The type of the associated object. Currently can be one of ‘payment_order`, `tra

  • per_page (Integer) (defaults to: nil)
  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/modern_treasury/models/document_list_params.rb', line 34

Instance Attribute Details

#after_cursor ⇒ String?

Returns:

  • (String, nil) 


13
 
# File 'lib/modern_treasury/models/document_list_params.rb', line 13

optional :after_cursor, String, nil?: true

#documentable_id ⇒ String?

The unique identifier for the associated object.

Returns:

  • (String, nil) 


19
 
# File 'lib/modern_treasury/models/document_list_params.rb', line 19

optional :documentable_id, String

#documentable_type ⇒ Symbol, ...

The type of the associated object. Currently can be one of ‘payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`.

Returns:



27
 
# File 'lib/modern_treasury/models/document_list_params.rb', line 27

optional :documentable_type, enum: -> { ModernTreasury::DocumentListParams::DocumentableType }

#per_page ⇒ Integer?

Returns:

  • (Integer, nil) 


32
 
# File 'lib/modern_treasury/models/document_list_params.rb', line 32

optional :per_page, Integer