Class: Knockapi::Models::ObjectListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/knockapi/models/object_list_params.rb,
sig/knockapi/models/object_list_params.rbs

Overview

See Also:

  • Knockapi::Resources::Objects#list

Defined Under Namespace

Modules: Include

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 ⇒ Object 



37
 
# File 'sig/knockapi/models/object_list_params.rbs', line 37

def initialize: (

Instance Attribute Details

#after ⇒ String?

The cursor to fetch entries after.

Parameters:

  • (String)

Returns:

  • (String, nil) 


19
 
# File 'lib/knockapi/models/object_list_params.rb', line 19

optional :after, String

#before ⇒ String?

The cursor to fetch entries before.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/knockapi/models/object_list_params.rb', line 25

optional :before, String

#collection ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/knockapi/models/object_list_params.rb', line 13

required :collection, String

#include ⇒ Array<Symbol, Knockapi::Models::ObjectListParams::Include>?

Includes preferences of the objects in the response.

Returns:



31
 
# File 'lib/knockapi/models/object_list_params.rb', line 31

optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::Include] }

#page_size ⇒ Integer?

The number of items per page (defaults to 50).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


37
 
# File 'lib/knockapi/models/object_list_params.rb', line 37

optional :page_size, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/knockapi/models/object_list_params.rbs', line 46

def to_hash: -> {