Class: Knockapi::Models::ObjectAddSubscriptionsParams

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

Overview

See Also:

  • Knockapi::Resources::Objects#add_subscriptions

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(collection:, object_id_:, recipients:, properties: nil, request_options: {}) ⇒ Object

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

Parameters:




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

Instance Attribute Details

#collection ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :collection, String

#object_id_ ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/knockapi/models/object_add_subscriptions_params.rb', line 18

required :object_id_, String

#properties ⇒ Hash{Symbol=>Object}?

The custom properties associated with the subscription relationship.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:



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

optional :properties, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true

#recipients ⇒ Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>

The recipients of the subscription. You can subscribe up to 100 recipients to an object at a time.

Parameters:

  • value (::Array[Knockapi::Models::recipient_request])

Returns:



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

required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/knockapi/models/object_add_subscriptions_params.rbs', line 32

def to_hash: -> {