Class: Courier::Models::Audience

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Courier::Models::Audience

Defined in:

lib/courier/models/audience.rb

Overview

See Also:

• Resources::Audiences#retrieve

Defined Under Namespace

Modules: Operator

Instance Attribute Summary

• #created_at ⇒ String
• #description ⇒ String

  A description of the audience.

• #filter ⇒ Courier::Models::AudienceFilterConfig^?

  Filter configuration for audience membership containing an array of filter rules.

• #id ⇒ String

  A unique identifier representing the audience_id.

• #name ⇒ String

  The name of the audience.

• #operator ⇒ Symbol, ...

  The logical operator (AND/OR) for the top-level filter.

• #updated_at ⇒ String

Instance Method Summary

• #initialize(id:, created_at:, description:, name:, updated_at:, filter: nil, operator: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Audience 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(id:, created_at:, description:, name:, updated_at:, filter: nil, operator: nil) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::Audience for more details.

Parameters:

• id (String) —

  A unique identifier representing the audience_id

• created_at (String)
• description (String) —

  A description of the audience

• name (String) —

  The name of the audience

• updated_at (String)
• filter (Courier::Models::AudienceFilterConfig, nil) (defaults to: nil) —

  Filter configuration for audience membership containing an array of filter rules

• operator (Symbol, Courier::Models::Audience::Operator) (defaults to: nil) —

  The logical operator (AND/OR) for the top-level filter

# File 'lib/courier/models/audience.rb', line 47

Instance Attribute Details

#created_at ⇒ String

Returns:

• (String)

# File 'lib/courier/models/audience.rb', line 16

required :created_at, String

#description ⇒ String

A description of the audience

Returns:

• (String)

# File 'lib/courier/models/audience.rb', line 22

required :description, String

#filter ⇒ Courier::Models::AudienceFilterConfig^?

Filter configuration for audience membership containing an array of filter rules

Returns:

• (Courier::Models::AudienceFilterConfig, nil)

# File 'lib/courier/models/audience.rb', line 39

optional :filter, -> { Courier::AudienceFilterConfig }, nil?: true

#id ⇒ String

A unique identifier representing the audience_id

Returns:

• (String)

# File 'lib/courier/models/audience.rb', line 11

required :id, String

#name ⇒ String

The name of the audience

Returns:

• (String)

# File 'lib/courier/models/audience.rb', line 28

required :name, String

#operator ⇒ Symbol, ...

The logical operator (AND/OR) for the top-level filter

Returns:

• (Symbol, Courier::Models::Audience::Operator, nil)

# File 'lib/courier/models/audience.rb', line 45

optional :operator, enum: -> { Courier::Audience::Operator }

#updated_at ⇒ String

Returns:

• (String)

# File 'lib/courier/models/audience.rb', line 33

required :updated_at, String