Class: Sentdm::Models::MessageSendParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/sentdm/models/message_send_params.rb,
sig/sentdm/models/message_send_params.rbs

Overview

See Also:

  • Sentdm::Resources::Messages#send_

Defined Under Namespace

Classes: Template

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 ⇒ Object 



41
 
# File 'sig/sentdm/models/message_send_params.rbs', line 41

def initialize: (

Instance Attribute Details

#channel ⇒ Array<String>?

Channels to broadcast on, e.g. ["whatsapp", "sms"]. Each channel produces a separate message per recipient. "sent" = auto-detect. Defaults to ["sent"] (auto-detect) if omitted.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


16
 
# File 'lib/sentdm/models/message_send_params.rb', line 16

optional :channel, Sentdm::Internal::Type::ArrayOf[String], nil?: true

#idempotency_key ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


47
 
# File 'lib/sentdm/models/message_send_params.rb', line 47

optional :idempotency_key, String

#sandbox ⇒ Boolean?

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


23
 
# File 'lib/sentdm/models/message_send_params.rb', line 23

optional :sandbox, Sentdm::Internal::Type::Boolean

#template ⇒ Sentdm::Models::MessageSendParams::Template?

SDK-style template reference: resolve by ID or by name, with optional parameters.

Parameters:

  • value (Sentdm::MessageSendParams::Template, nil)

Returns:



30
 
# File 'lib/sentdm/models/message_send_params.rb', line 30

optional :template, -> { Sentdm::MessageSendParams::Template }, nil?: true

#text ⇒ String?

Plain-text (free-form) message body. Provide either Template or this.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


36
 
# File 'lib/sentdm/models/message_send_params.rb', line 36

optional :text, String, nil?: true

#to ⇒ Array<String>?

List of recipient phone numbers in E.164 format (multi-recipient fan-out)

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


42
 
# File 'lib/sentdm/models/message_send_params.rb', line 42

optional :to, Sentdm::Internal::Type::ArrayOf[String]

#x_profile_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


52
 
# File 'lib/sentdm/models/message_send_params.rb', line 52

optional :x_profile_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


52
 
# File 'sig/sentdm/models/message_send_params.rbs', line 52

def to_hash: -> {