Class: Courier::Models::WorkspacePreferenceTopicReplaceRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/workspace_preference_topic_replace_request.rb,
sig/courier/models/workspace_preference_topic_replace_request.rbs

Defined Under Namespace

Modules: AllowedPreference, DefaultStatus

Instance Attribute Summary collapse

Class Method 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(default_status:, name:, allowed_preferences: nil, description: nil, include_unsubscribe_header: nil, routing_options: nil, topic_data: nil) ⇒ Object

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

Request body for replacing a preference topic. Full document replacement; missing optional fields are cleared.

Parameters:

  • default_status (Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::DefaultStatus) —

    The default subscription status applied when a recipient has not set their own.

  • name (String) —

    Human-readable name for the preference topic.

  • allowed_preferences (Array<Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::AllowedPreference>, nil) (defaults to: nil) —

    Preference controls a recipient may customize. Omit to clear.

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

    Optional description shown under the topic on the hosted preferences page. Omit

  • include_unsubscribe_header (Boolean, nil) (defaults to: nil) —

    Whether to include a list-unsubscribe header on emails for this topic.

  • routing_options (Array<Symbol, Courier::Models::ChannelClassification>, nil) (defaults to: nil) —

    Default channels delivered for this topic. Omit to clear.

  • topic_data (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    Arbitrary metadata associated with the topic. Omit to clear.




# File 'lib/courier/models/workspace_preference_topic_replace_request.rb', line 55

Instance Attribute Details

#allowed_preferences ⇒ Array<Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::AllowedPreference>?

Preference controls a recipient may customize. Omit to clear.

Parameters:

  • value (::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference], nil)

Returns:



22
23
24
25
26
 
# File 'lib/courier/models/workspace_preference_topic_replace_request.rb', line 22

optional :allowed_preferences,
-> {
  Courier::Internal::Type::ArrayOf[enum: Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference]
},
nil?: true

#default_status ⇒ Symbol, Courier::Models::WorkspacePreferenceTopicReplaceRequest::DefaultStatus

The default subscription status applied when a recipient has not set their own.

Parameters:

  • value (Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status)

Returns:



10
 
# File 'lib/courier/models/workspace_preference_topic_replace_request.rb', line 10

required :default_status, enum: -> { Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus }

#description ⇒ String?

Optional description shown under the topic on the hosted preferences page. Omit to clear.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :description, String, nil?: true

#include_unsubscribe_header ⇒ Boolean?

Whether to include a list-unsubscribe header on emails for this topic.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


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

optional :include_unsubscribe_header, Courier::Internal::Type::Boolean, nil?: true

#name ⇒ String

Human-readable name for the preference topic.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#routing_options ⇒ Array<Symbol, Courier::Models::ChannelClassification>?

Default channels delivered for this topic. Omit to clear.

Parameters:

  • value (::Array[Courier::Models::channel_classification], nil)

Returns:



45
46
47
 
# File 'lib/courier/models/workspace_preference_topic_replace_request.rb', line 45

optional :routing_options,
-> { Courier::Internal::Type::ArrayOf[enum: Courier::ChannelClassification] },
nil?: true

#topic_data ⇒ Hash{Symbol=>Object}?

Arbitrary metadata associated with the topic. Omit to clear.

Parameters:

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

Returns:

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


53
 
# File 'lib/courier/models/workspace_preference_topic_replace_request.rb', line 53

optional :topic_data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/courier/models/workspace_preference_topic_replace_request.rb', line 86

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/courier/models/workspace_preference_topic_replace_request.rbs', line 39

def to_hash: -> {