Class: Openlayer::Models::Governance::Frameworks::DocumentListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openlayer/models/governance/frameworks/document_list_params.rb,
sig/openlayer/models/governance/frameworks/document_list_params.rbs

Overview

See Also:

  • Openlayer::Resources::Governance::Frameworks::Documents#list

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Openlayer

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(framework_id:, page: nil, per_page: nil, request_options: {}) ⇒ Object

Parameters:

  • (defaults to: nil)

    The page to return in a paginated query.

  • (defaults to: nil)

    Maximum number of items to return per page.

  • (defaults to: {}) 



# File 'lib/openlayer/models/governance/frameworks/document_list_params.rb', line 29

Instance Attribute Details

#framework_id ⇒ String

Parameters:

Returns:



15
 
# File 'lib/openlayer/models/governance/frameworks/document_list_params.rb', line 15

required :framework_id, String

#page ⇒ Integer?

The page to return in a paginated query.

Parameters:

Returns:



21
 
# File 'lib/openlayer/models/governance/frameworks/document_list_params.rb', line 21

optional :page, Integer

#per_page ⇒ Integer?

Maximum number of items to return per page.

Parameters:

Returns:



27
 
# File 'lib/openlayer/models/governance/frameworks/document_list_params.rb', line 27

optional :per_page, Integer

Instance Method Details

#to_hash ⇒ {

Returns:



30
 
# File 'sig/openlayer/models/governance/frameworks/document_list_params.rbs', line 30

def to_hash: -> {