Class: Courier::Models::SendMessageResponse

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

Overview

See Also:

  • Courier::Resources::Send#message

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(request_id:) ⇒ SendMessageResponse

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

Parameters:

  • request_id (String)

    A successful call to POST /send returns a 202 status code along with a `requ

  • request_id: (String)


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

Instance Attribute Details

#request_idString

A successful call to POST /send returns a 202 status code along with a requestId in the response body. For single-recipient requests, the requestId is the derived message_id. For multiple recipients, Courier assigns a unique message_id to each derived message.

Parameters:

  • value (String)

Returns:

  • (String)


14
# File 'lib/courier/models/send_message_response.rb', line 14

required :request_id, String, api_name: :requestId

Instance Method Details

#to_hash{ request_id: String }

Returns:

  • ({ request_id: String })


10
# File 'sig/courier/models/send_message_response.rbs', line 10

def to_hash: -> { request_id: String }