Class: Trycourier::Models::AudienceRecipient

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Trycourier::Models::AudienceRecipient

Defined in:

lib/trycourier/models/audience_recipient.rb

Instance Attribute Summary

• #audience_id ⇒ String

  A unique identifier associated with an Audience.

• #data ⇒ Hash{Symbol=>Object}^?
• #filters ⇒ Array<Trycourier::Models::AudienceFilter>^?

Instance Method Summary

• #initialize(audience_id:, data: nil, filters: nil) ⇒ Object constructor

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

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(audience_id:, data: nil, filters: nil) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::AudienceRecipient for more details.

Send to all users in an audience

Parameters:

• audience_id (String) —

  A unique identifier associated with an Audience. A message will be sent to each

• data (Hash{Symbol=>Object}, nil) (defaults to: nil)
• filters (Array<Trycourier::Models::AudienceFilter>, nil) (defaults to: nil)

# File 'lib/trycourier/models/audience_recipient.rb', line 23

Instance Attribute Details

#audience_id ⇒ String

A unique identifier associated with an Audience. A message will be sent to each user in the audience.

Returns:

• (String)

# File 'lib/trycourier/models/audience_recipient.rb', line 11

required :audience_id, String

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

Returns:

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

# File 'lib/trycourier/models/audience_recipient.rb', line 16

optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true

#filters ⇒ Array<Trycourier::Models::AudienceFilter>^?

Returns:

• (Array<Trycourier::Models::AudienceFilter>, nil)

# File 'lib/trycourier/models/audience_recipient.rb', line 21

optional :filters, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::AudienceFilter] }, nil?: true