Class: Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/objects/bulk_add_subscriptions_params.rb,
sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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

Some parameter documentations has been truncated, see Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription for more details.

A list of subscriptions. 1 subscribed-to id, and N subscriber recipients.

Parameters:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/knockapi/models/objects/bulk_add_subscriptions_params.rb', line 30

class Subscription < Knockapi::Internal::Type::BaseModel
  # @!attribute id
  #   Unique identifier for the object.
  #
  #   @return [String]
  required :id, String

  # @!attribute recipients
  #   The recipients of the subscription. You can subscribe up to 100 recipients to an
  #   object at a time.
  #
  #   @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
  required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }

  # @!attribute properties
  #   The custom properties associated with the subscription relationship.
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :properties,
           Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
           nil?: true

  # @!method initialize(id:, recipients:, properties: nil)
  #   Some parameter documentations has been truncated, see
  #   {Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription} for more
  #   details.
  #
  #   A list of subscriptions. 1 subscribed-to id, and N subscriber recipients.
  #
  #   @param id [String] Unique identifier for the object.
  #
  #   @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
  #
  #   @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
end

Instance Attribute Details

#id ⇒ String

Unique identifier for the object.

Parameters:

  • value (String)

Returns:

  • (String) 


35
 
# File 'lib/knockapi/models/objects/bulk_add_subscriptions_params.rb', line 35

required :id, String

#properties ⇒ Hash{Symbol=>Object}?

The custom properties associated with the subscription relationship.

Parameters:

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

Returns:



48
49
50
 
# File 'lib/knockapi/models/objects/bulk_add_subscriptions_params.rb', line 48

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:



42
 
# File 'lib/knockapi/models/objects/bulk_add_subscriptions_params.rb', line 42

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


51
 
# File 'sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs', line 51

def to_hash: -> {