Class: Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject

Defined in:

lib/knockapi/models/users/bulk_set_preferences_params.rb,
sig/knockapi/models/users/bulk_set_preferences_params.rbs

Defined Under Namespace

Modules: Channel

Instance Attribute Summary

• #channel_types ⇒ Knockapi::Models::Recipients::PreferenceSetChannelTypes^?

  Channel type preferences.

• #channels ⇒ Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}^?

  Channel preferences.

• #conditions ⇒ Array<Knockapi::Models::Condition>^?

  A list of conditions to apply to a channel type.

Instance Method Summary

• #initialize(channel_types: nil, channels: nil, conditions: nil) ⇒ Object constructor

  The settings object for a workflow or category, where you can specify channel types or conditions.

• #to_hash ⇒ {

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(channel_types: nil, channels: nil, conditions: nil) ⇒ Object

The settings object for a workflow or category, where you can specify channel types or conditions.

Parameters:

• channel_types (Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil) (defaults to: nil) —

  Channel type preferences.

• channels (Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil) (defaults to: nil) —

  Channel preferences.

• conditions (Array<Knockapi::Models::Condition>, nil) (defaults to: nil) —

  A list of conditions to apply to a channel type.

# File 'lib/knockapi/models/users/bulk_set_preferences_params.rb', line 239

Instance Attribute Details

#channel_types ⇒ Knockapi::Models::Recipients::PreferenceSetChannelTypes^?

Channel type preferences.

Parameters:

• value (Knockapi::Recipients::PreferenceSetChannelTypes, nil)

Returns:

• (Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil)

# File 'lib/knockapi/models/users/bulk_set_preferences_params.rb', line 219

optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true

#channels ⇒ Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}^?

Channel preferences.

Parameters:

• value (::Hash[Symbol, Knockapi::Models::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject::channel], nil)

Returns:

• (Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetChannelSetting}, nil)

# File 'lib/knockapi/models/users/bulk_set_preferences_params.rb', line 225

optional :channels,
-> do
  Knockapi::Internal::Type::HashOf[
    union: Knockapi::Users::BulkSetPreferencesParams::Preferences::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel
  ]
end,
nil?: true

#conditions ⇒ Array<Knockapi::Models::Condition>^?

A list of conditions to apply to a channel type.

Parameters:

• value (::Array[Knockapi::Condition], nil)

Returns:

• (Array<Knockapi::Models::Condition>, nil)

# File 'lib/knockapi/models/users/bulk_set_preferences_params.rb', line 237

optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/knockapi/models/users/bulk_set_preferences_params.rbs', line 165

def to_hash: -> {