Class: Knockapi::Models::ObjectDeleteSubscriptionsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::ObjectDeleteSubscriptionsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Knockapi::Resources::Objects#delete_subscriptions

Instance Attribute Summary

• #collection ⇒ String
• #object_id_ ⇒ String
• #recipients ⇒ Array<String, Knockapi::Models::RecipientReference::ObjectReference>

  The recipients of the subscription.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(collection:, object_id_:, recipients:, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ObjectDeleteSubscriptionsParams for more details.

• #to_hash ⇒ {

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:, request_options: {}) ⇒ Object

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

Parameters:

• collection (String)
• object_id_ (String)
• recipients (Array<String, Knockapi::Models::RecipientReference::ObjectReference>) —

  The recipients of the subscription. You can subscribe up to 100 recipients to an

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

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

Instance Attribute Details

#collection ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :collection, String

#object_id_ ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :object_id_, String

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

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

Parameters:

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

Returns:

• (Array<String, Knockapi::Models::RecipientReference::ObjectReference>)

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

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/knockapi/models/object_delete_subscriptions_params.rbs', line 28

def to_hash: -> {