Module: SurgeAPI::Models::MessageParams

Extended by:

Internal::Type::Union

Defined in:

lib/surge_api/models/message_params.rb

Overview

Payload for creating a message. Either an attachment or the body must be given. You can specify the recipient either using the ‘conversation’ parameter or the ‘to’/‘from’ parameters, but not both.

Defined Under Namespace

Classes: MessageParamsWithConversation, SimpleMessageParams

Class Method Summary

• .variants ⇒ Array(SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams)

Instance Method Summary

• #initialize(url:) ⇒ Object

  Params for creating an attachment.

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams)

Returns:

• (Array(SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams))

# File 'lib/surge_api/models/message_params.rb', line 228

Instance Method Details

#initialize(url:) ⇒ Object

Params for creating an attachment

Parameters:

• url (String) —

  The URL of the attachment.

# File 'lib/surge_api/models/message_params.rb', line 149