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

Overview

See Also:

Defined Under Namespace

Classes: Template

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Sentdm::Internal::Type::BaseModel

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, “rcs” = reserved (skipped). Defaults to [“sent”] (auto-detect) if omitted.

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?

Returns:

  • (String, nil) 


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

optional :idempotency_key, String

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

Template reference (by id or name, with optional parameters)

Returns:



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

optional :template, -> { Sentdm::MessageSendParams::Template }

#test_mode ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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

optional :test_mode, Sentdm::Internal::Type::Boolean

#to ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


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

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