Class: Sentdm::Models::MessageSendResponse::Data::Recipient

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/message_send_response.rb

Instance Attribute 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(body: nil, channel: nil, message_id: nil, to: nil) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::MessageSendResponse::Data::Recipient for more details.

Per-recipient result in the send message response

Parameters:

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

    Resolved template body text for this recipient’s channel, or null for auto-detec

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

    Channel this message will be sent on (e.g. “sms”, “whatsapp”), or null for auto-

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

    Unique message identifier for tracking this recipient’s message

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

    Phone number in E.164 format



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/sentdm/models/message_send_response.rb', line 84

class Recipient < Sentdm::Internal::Type::BaseModel
  # @!attribute body
  #   Resolved template body text for this recipient's channel, or null for
  #   auto-detect
  #
  #   @return [String, nil]
  optional :body, String, nil?: true

  # @!attribute channel
  #   Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for
  #   auto-detect
  #
  #   @return [String, nil]
  optional :channel, String, nil?: true

  # @!attribute message_id
  #   Unique message identifier for tracking this recipient's message
  #
  #   @return [String, nil]
  optional :message_id, String

  # @!attribute to
  #   Phone number in E.164 format
  #
  #   @return [String, nil]
  optional :to, String

  # @!method initialize(body: nil, channel: nil, message_id: nil, to: nil)
  #   Some parameter documentations has been truncated, see
  #   {Sentdm::Models::MessageSendResponse::Data::Recipient} for more details.
  #
  #   Per-recipient result in the send message response
  #
  #   @param body [String, nil] Resolved template body text for this recipient's channel, or null for auto-detec
  #
  #   @param channel [String, nil] Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for auto-
  #
  #   @param message_id [String] Unique message identifier for tracking this recipient's message
  #
  #   @param to [String] Phone number in E.164 format
end

Instance Attribute Details

#body ⇒ String?

Resolved template body text for this recipient’s channel, or null for auto-detect

Returns:

  • (String, nil) 


90
 
# File 'lib/sentdm/models/message_send_response.rb', line 90

optional :body, String, nil?: true

#channel ⇒ String?

Channel this message will be sent on (e.g. “sms”, “whatsapp”), or null for auto-detect

Returns:

  • (String, nil) 


97
 
# File 'lib/sentdm/models/message_send_response.rb', line 97

optional :channel, String, nil?: true

#message_id ⇒ String?

Unique message identifier for tracking this recipient’s message

Returns:

  • (String, nil) 


103
 
# File 'lib/sentdm/models/message_send_response.rb', line 103

optional :message_id, String

#to ⇒ String?

Phone number in E.164 format

Returns:

  • (String, nil) 


109
 
# File 'lib/sentdm/models/message_send_response.rb', line 109

optional :to, String