Class: Knockapi::Models::ObjectAddSubscriptionsParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/knockapi/models/object_add_subscriptions_params.rb

Overview

See Also:

• Resources::Objects#add_subscriptions

Instance Attribute Summary

• #properties ⇒ Hash{Symbol=>Object}^?

  The custom properties associated with the subscription relationship.

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

  The recipients of the subscription.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(recipients:, properties: nil, request_options: {}) ⇒ Object constructor

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

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

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

Parameters:

• recipients (Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>) —

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

• properties (Hash{Symbol=>Object}, nil) (defaults to: nil) —

  The custom properties associated with the subscription relationship.

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

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

Instance Attribute Details

#properties ⇒ Hash{Symbol=>Object}^?

The custom properties associated with the subscription relationship.

Returns:

• (Hash{Symbol=>Object}, nil)

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

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.

Returns:

• (Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>)

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

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