Module: Knockapi::Models::ObjectListSubscriptionsParams::Include

Extended by:

Internal::Type::Enum

Defined in:

lib/knockapi/models/object_list_subscriptions_params.rb,
sig/knockapi/models/object_list_subscriptions_params.rbs

Constant Summary

PREFERENCES =

Returns:

• (:preferences)

:preferences

Instance Method Summary

• #initialize(collection:, object_id_:, after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {}) ⇒ Object

  Some parameter documentations has been truncated, see Knockapi::Models::ObjectListSubscriptionsParams for more details.

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

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, 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

Instance Method Details

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

Some parameter documentations has been truncated, see Knockapi::Models::ObjectListSubscriptionsParams for more details.

Parameters:

• collection (String)
• object_id_ (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::ObjectListSubscriptionsParams::Include>) (defaults to: nil) —

  Additional fields to include in the response.

• mode (Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode) (defaults to: nil) —

  Mode of the request. recipient to list the objects that the provided object is

• objects (Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>) (defaults to: nil) —

  Objects to filter by (only used if mode is recipient).

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

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

• recipients (Array<String, Knockapi::Models::RecipientReference::ObjectReference>) (defaults to: nil) —

  Recipients to filter by (only used if mode is object).

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

# File 'lib/knockapi/models/object_list_subscriptions_params.rb', line 90

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

  PREFERENCES = :preferences

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

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

Returns:

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

# File 'sig/knockapi/models/object_list_subscriptions_params.rbs', line 94

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