Class: Telnyx::Models::PhoneNumbers::VoicemailRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/phone_numbers/voicemail_request.rb,
sig/telnyx/models/phone_numbers/voicemail_request.rbs

Direct Known Subclasses

VoicemailCreateParams, VoicemailUpdateParams

Defined Under Namespace

Classes: Greeting

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(enabled: nil, greeting: nil, pin: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::PhoneNumbers::VoicemailRequest for more details.

Parameters:

  • enabled (Boolean) (defaults to: nil)

    Whether voicemail is enabled.

  • greeting (Telnyx::Models::PhoneNumbers::VoicemailRequest::Greeting) (defaults to: nil)

    Controls the greeting a caller hears before leaving a voicemail. Set mode to `

  • pin (String) (defaults to: nil)

    The pin used for voicemail



# File 'lib/telnyx/models/phone_numbers/voicemail_request.rb', line 29

Instance Attribute Details

#enabledBoolean?

Whether voicemail is enabled.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


11
# File 'lib/telnyx/models/phone_numbers/voicemail_request.rb', line 11

optional :enabled, Telnyx::Internal::Type::Boolean

#greetingTelnyx::Models::PhoneNumbers::VoicemailRequest::Greeting?

Controls the greeting a caller hears before leaving a voicemail. Set mode to default to play the standard system greeting, or to custom_greeting to play your own audio. When mode is custom_greeting, media_name is required and must reference an audio file already uploaded to your account through the Media Storage API.



21
# File 'lib/telnyx/models/phone_numbers/voicemail_request.rb', line 21

optional :greeting, -> { Telnyx::PhoneNumbers::VoicemailRequest::Greeting }

#pinString?

The pin used for voicemail

Parameters:

  • (String)

Returns:

  • (String, nil)


27
# File 'lib/telnyx/models/phone_numbers/voicemail_request.rb', line 27

optional :pin, String

Instance Method Details

#to_hash{

Returns:

  • ({)


32
# File 'sig/telnyx/models/phone_numbers/voicemail_request.rbs', line 32

def to_hash: -> {