Class: Telnyx::Models::PhoneNumbers::UpdateVoiceSettings

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::PhoneNumbers::UpdateVoiceSettings

Defined in:

lib/telnyx/models/phone_numbers/update_voice_settings.rb

Direct Known Subclasses

VoiceUpdateParams

Defined Under Namespace

Modules: InboundCallScreening, UsagePaymentMethod

Instance Attribute Summary

• #call_forwarding ⇒ Telnyx::Models::PhoneNumbers::CallForwarding^?

  The call forwarding settings for a phone number.

• #call_recording ⇒ Telnyx::Models::PhoneNumbers::CallRecording^?

  The call recording settings for a phone number.

• #caller_id_name_enabled ⇒ Boolean^?

  Controls whether the caller ID name is enabled for this phone number.

• #cnam_listing ⇒ Telnyx::Models::PhoneNumbers::CnamListing^?

  The CNAM listing settings for a phone number.

• #inbound_call_screening ⇒ Symbol, ...

  The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls.

• #media_features ⇒ Telnyx::Models::PhoneNumbers::MediaFeatures^?

  The media features settings for a phone number.

• #tech_prefix_enabled ⇒ Boolean^?

  Controls whether a tech prefix is enabled for this phone number.

• #translated_number ⇒ String^?

  This field allows you to rewrite the destination number of an inbound call before the call is routed to you.

• #usage_payment_method ⇒ Symbol, ...

  Controls whether a number is billed per minute or uses your concurrent channels.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(call_forwarding: nil, call_recording: nil, caller_id_name_enabled: nil, cnam_listing: nil, inbound_call_screening: nil, media_features: nil, tech_prefix_enabled: nil, translated_number: nil, usage_payment_method: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see UpdateVoiceSettings for more details.

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(call_forwarding: nil, call_recording: nil, caller_id_name_enabled: nil, cnam_listing: nil, inbound_call_screening: nil, media_features: nil, tech_prefix_enabled: nil, translated_number: nil, usage_payment_method: nil) ⇒ Object

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

Parameters:

• call_forwarding (Telnyx::Models::PhoneNumbers::CallForwarding) (defaults to: nil) —

  The call forwarding settings for a phone number.

• call_recording (Telnyx::Models::PhoneNumbers::CallRecording) (defaults to: nil) —

  The call recording settings for a phone number.

• caller_id_name_enabled (Boolean) (defaults to: nil) —

  Controls whether the caller ID name is enabled for this phone number.

• cnam_listing (Telnyx::Models::PhoneNumbers::CnamListing) (defaults to: nil) —

  The CNAM listing settings for a phone number.

• inbound_call_screening (Symbol, Telnyx::Models::PhoneNumbers::UpdateVoiceSettings::InboundCallScreening) (defaults to: nil) —

  The inbound_call_screening setting is a phone number configuration option variab

• media_features (Telnyx::Models::PhoneNumbers::MediaFeatures) (defaults to: nil) —

  The media features settings for a phone number.

• tech_prefix_enabled (Boolean) (defaults to: nil) —

  Controls whether a tech prefix is enabled for this phone number.

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

  This field allows you to rewrite the destination number of an inbound call befor

• usage_payment_method (Symbol, Telnyx::Models::PhoneNumbers::UpdateVoiceSettings::UsagePaymentMethod) (defaults to: nil) —

  Controls whether a number is billed per minute or uses your concurrent channels.

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 67

Instance Attribute Details

#call_forwarding ⇒ Telnyx::Models::PhoneNumbers::CallForwarding^?

The call forwarding settings for a phone number.

Returns:

• (Telnyx::Models::PhoneNumbers::CallForwarding, nil)

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

optional :call_forwarding, -> { Telnyx::PhoneNumbers::CallForwarding }

#call_recording ⇒ Telnyx::Models::PhoneNumbers::CallRecording^?

The call recording settings for a phone number.

Returns:

• (Telnyx::Models::PhoneNumbers::CallRecording, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 17

optional :call_recording, -> { Telnyx::PhoneNumbers::CallRecording }

#caller_id_name_enabled ⇒ Boolean^?

Controls whether the caller ID name is enabled for this phone number.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 23

optional :caller_id_name_enabled, Telnyx::Internal::Type::Boolean

#cnam_listing ⇒ Telnyx::Models::PhoneNumbers::CnamListing^?

The CNAM listing settings for a phone number.

Returns:

• (Telnyx::Models::PhoneNumbers::CnamListing, nil)

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

optional :cnam_listing, -> { Telnyx::PhoneNumbers::CnamListing }

#inbound_call_screening ⇒ Symbol, ...

The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it.

Returns:

• (Symbol, Telnyx::Models::PhoneNumbers::UpdateVoiceSettings::InboundCallScreening, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 38

optional :inbound_call_screening,
enum: -> { Telnyx::PhoneNumbers::UpdateVoiceSettings::InboundCallScreening }

#media_features ⇒ Telnyx::Models::PhoneNumbers::MediaFeatures^?

The media features settings for a phone number.

Returns:

• (Telnyx::Models::PhoneNumbers::MediaFeatures, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 45

optional :media_features, -> { Telnyx::PhoneNumbers::MediaFeatures }

#tech_prefix_enabled ⇒ Boolean^?

Controls whether a tech prefix is enabled for this phone number.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 51

optional :tech_prefix_enabled, Telnyx::Internal::Type::Boolean

#translated_number ⇒ String^?

This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed.

Returns:

• (String, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 59

optional :translated_number, String

#usage_payment_method ⇒ Symbol, ...

Controls whether a number is billed per minute or uses your concurrent channels.

Returns:

• (Symbol, Telnyx::Models::PhoneNumbers::UpdateVoiceSettings::UsagePaymentMethod, nil)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 65

optional :usage_payment_method, enum: -> { Telnyx::PhoneNumbers::UpdateVoiceSettings::UsagePaymentMethod }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/phone_numbers/update_voice_settings.rb', line 102