Class: Zavudev::Models::BroadcastCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/broadcast_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(channel:, name:, content: nil, email_html_body: nil, email_subject: nil, idempotency_key: nil, message_type: nil, metadata: nil, scheduled_at: nil, sender_id: nil, text: nil, request_options: {}) ⇒ Object

Parameters:

  • channel (Symbol, Zavudev::Models::BroadcastChannel) —

    Broadcast delivery channel. Use ‘smart’ for per-contact intelligent routing.

  • name (String) —

    Name of the broadcast campaign.

  • content (Zavudev::Models::BroadcastContent) (defaults to: nil) —

    Content for non-text broadcast message types.

  • email_html_body (String) (defaults to: nil) —

    HTML body for email broadcasts.

  • email_subject (String) (defaults to: nil) —

    Email subject line. Required for email broadcasts.

  • idempotency_key (String) (defaults to: nil) —

    Idempotency key to prevent duplicate broadcasts.

  • message_type (Symbol, Zavudev::Models::BroadcastMessageType) (defaults to: nil) —

    Type of message for broadcast.

  • metadata (Hash{Symbol=>String}) (defaults to: nil)
  • scheduled_at (Time) (defaults to: nil) —

    Schedule the broadcast for future delivery.

  • sender_id (String) (defaults to: nil) —

    Sender profile ID. Uses default sender if omitted.

  • text (String) (defaults to: nil) —

    Text content or caption. Supports template variables: {name}, {1}, etc.

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



# File 'lib/zavudev/models/broadcast_create_params.rb', line 75

Instance Attribute Details

#channel ⇒ Symbol, Zavudev::Models::BroadcastChannel

Broadcast delivery channel. Use ‘smart’ for per-contact intelligent routing.

Returns:



14
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 14

required :channel, enum: -> { Zavudev::BroadcastChannel }

#content ⇒ Zavudev::Models::BroadcastContent?

Content for non-text broadcast message types.

Returns:



26
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 26

optional :content, -> { Zavudev::BroadcastContent }

#email_html_body ⇒ String?

HTML body for email broadcasts.

Returns:

  • (String, nil) 


32
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 32

optional :email_html_body, String, api_name: :emailHtmlBody

#email_subject ⇒ String?

Email subject line. Required for email broadcasts.

Returns:

  • (String, nil) 


38
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 38

optional :email_subject, String, api_name: :emailSubject

#idempotency_key ⇒ String?

Idempotency key to prevent duplicate broadcasts.

Returns:

  • (String, nil) 


44
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 44

optional :idempotency_key, String, api_name: :idempotencyKey

#message_type ⇒ Symbol, ...

Type of message for broadcast.

Returns:



50
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 50

optional :message_type, enum: -> { Zavudev::BroadcastMessageType }, api_name: :messageType

#metadata ⇒ Hash{Symbol=>String}?

Returns:

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


55
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 55

optional :metadata, Zavudev::Internal::Type::HashOf[String]

#name ⇒ String

Name of the broadcast campaign.

Returns:

  • (String) 


20
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 20

required :name, String

#scheduled_at ⇒ Time?

Schedule the broadcast for future delivery.

Returns:

  • (Time, nil) 


61
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 61

optional :scheduled_at, Time, api_name: :scheduledAt

#sender_id ⇒ String?

Sender profile ID. Uses default sender if omitted.

Returns:

  • (String, nil) 


67
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 67

optional :sender_id, String, api_name: :senderId

#text ⇒ String?

Text content or caption. Supports template variables: {name}, {1}, etc.

Returns:

  • (String, nil) 


73
 
# File 'lib/zavudev/models/broadcast_create_params.rb', line 73

optional :text, String