Module: Knockapi::Models::ObjectListParams::Include

Extended by:
Internal::Type::Enum
Defined in:
lib/knockapi/models/object_list_params.rb,
sig/knockapi/models/object_list_params.rbs

Constant Summary collapse

PREFERENCES =

Returns:

  • (:preferences) 
:preferences

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#initialize(collection:, after: nil, before: nil, include: nil, page_size: nil, request_options: {}) ⇒ Object

Parameters:

  • collection (String)
  • after (String) (defaults to: nil) —

    The cursor to fetch entries after.

  • before (String) (defaults to: nil) —

    The cursor to fetch entries before.

  • include (Array<Symbol, Knockapi::Models::ObjectListParams::Include>) (defaults to: nil) —

    Includes preferences of the objects in the response.

  • page_size (Integer) (defaults to: nil) —

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

  • request_options (Knockapi::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


52
53
54
55
56
57
58
59
 
# File 'lib/knockapi/models/object_list_params.rb', line 52

module Include
  extend Knockapi::Internal::Type::Enum

  PREFERENCES = :preferences

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Knockapi::Models::ObjectListParams::include_]

Returns:

  • (::Array[Knockapi::Models::ObjectListParams::include_]) 


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

def self?.values: -> ::Array[Knockapi::Models::ObjectListParams::include_]