Class: Knockapi::Models::UserListSubscriptionsParams

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

Overview

See Also:

Defined Under Namespace

Modules: Include

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Knockapi::Internal::Type::BaseModel

Instance Attribute Details

#after ⇒ String?

The cursor to fetch entries after.

Returns:

  • (String, nil) 


14
 
# File 'lib/knockapi/models/user_list_subscriptions_params.rb', line 14

optional :after, String

#before ⇒ String?

The cursor to fetch entries before.

Returns:

  • (String, nil) 


20
 
# File 'lib/knockapi/models/user_list_subscriptions_params.rb', line 20

optional :before, String

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

Associated resources to include in the response.

Returns:



26
27
 
# File 'lib/knockapi/models/user_list_subscriptions_params.rb', line 26

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

#objects ⇒ Array<String, Knockapi::Models::RecipientReference::ObjectReference>?

Only returns subscriptions for the specified object references.

Returns:



33
 
# File 'lib/knockapi/models/user_list_subscriptions_params.rb', line 33

optional :objects, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }

#page_size ⇒ Integer?

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

Returns:

  • (Integer, nil) 


39
 
# File 'lib/knockapi/models/user_list_subscriptions_params.rb', line 39

optional :page_size, Integer