Class: Trycourier::Models::AudienceUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/trycourier/models/audience_update_params.rb

Overview

See Also:

• Resources::Audiences#update

Defined Under Namespace

Modules: Operator

Instance Attribute Summary

• #description ⇒ String^?

  A description of the audience.

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

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

• #name ⇒ String^?

  The name of the audience.

• #operator ⇒ Symbol, ...

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(description: nil, filter: nil, name: nil, operator: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AudienceUpdateParams 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(description: nil, filter: nil, name: nil, operator: nil, request_options: {}) ⇒ Object

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

Parameters:

• description (String, nil) (defaults to: nil) —

  A description of the audience

• filter (Trycourier::Models::AudienceFilterConfig, nil) (defaults to: nil) —

  Filter configuration for audience membership containing an array of filter rules

• name (String, nil) (defaults to: nil) —

  The name of the audience

• operator (Symbol, Trycourier::Models::AudienceUpdateParams::Operator, nil) (defaults to: nil) —

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

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

# File 'lib/trycourier/models/audience_update_params.rb', line 34

Instance Attribute Details

#description ⇒ String^?

A description of the audience

Returns:

• (String, nil)

# File 'lib/trycourier/models/audience_update_params.rb', line 14

optional :description, String, nil?: true

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

Filter configuration for audience membership containing an array of filter rules

Returns:

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

# File 'lib/trycourier/models/audience_update_params.rb', line 20

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

#name ⇒ String^?

The name of the audience

Returns:

• (String, nil)

# File 'lib/trycourier/models/audience_update_params.rb', line 26

optional :name, String, nil?: true

#operator ⇒ Symbol, ...

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

Returns:

• (Symbol, Trycourier::Models::AudienceUpdateParams::Operator, nil)

# File 'lib/trycourier/models/audience_update_params.rb', line 32

optional :operator, enum: -> { Trycourier::AudienceUpdateParams::Operator }, nil?: true