Class: Telnyx::Models::PhoneNumberDeleteResponse::Data

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

Overview

See Also:

  • Telnyx::Models::PhoneNumberDeleteResponse#data

Defined Under Namespace

Modules: PhoneNumberType, Status

Instance Attribute Summary collapse

Class Method 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(id: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, created_at: nil, customer_reference: nil, deletion_lock_enabled: nil, emergency_address_id: nil, emergency_enabled: nil, external_pin: nil, hd_voice_enabled: nil, messaging_profile_id: nil, messaging_profile_name: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil, tags: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::PhoneNumberDeleteResponse::Data for more details.

Parameters:

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

    Identifies the resource.

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

    Identifies the billing group associated with the phone number.

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

    Indicates if call forwarding will be enabled for this number if forwards_to and

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

    Indicates whether call recording is enabled for this number.

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

    Indicates whether caller ID is enabled for this number.

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

    Indicates whether a CNAM listing is enabled for this number.

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

    Identifies the connection associated with the phone number.

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

    The user-assigned name of the connection to be associated with this phone number

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

    ISO 8601 formatted date indicating when the time it took to activate after the p

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

    A customer reference string for customer look ups.

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

    Indicates whether deletion lock is enabled for this number. When enabled, this p

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

    Identifies the emergency address associated with the phone number.

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

    Indicates whether emergency services are enabled for this number.

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

    If someone attempts to port your phone number away from Telnyx and your phone nu

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

    Indicates whether HD voice is enabled for this number.

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

    Identifies the messaging profile associated with the phone number.

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

    The name of the messaging profile associated with the phone number.

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

    The +E.164-formatted phone number associated with this record.

  • phone_number_type (Symbol, Telnyx::Models::PhoneNumberDeleteResponse::Data::PhoneNumberType) (defaults to: nil) —

    The phone number's type.

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

    ISO 8601 formatted date indicating the time the request was made to purchase the

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

    Identifies the type of the resource.

  • status (Symbol, Telnyx::Models::PhoneNumberDeleteResponse::Data::Status) (defaults to: nil) —

    The phone number's current status.

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

    Indicates whether T38 Fax Gateway for inbound calls to this number.

  • tags (Array<String>) (defaults to: nil) —

    A list of user-assigned tags to help manage the phone number.

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

    ISO 8601 formatted date indicating when the resource was updated.




# File 'lib/telnyx/models/phone_number_delete_response.rb', line 178

Instance Attribute Details

#billing_group_id ⇒ String?

Identifies the billing group associated with the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :billing_group_id, String

#call_forwarding_enabled ⇒ Boolean? (readonly)

Returns the value of attribute call_forwarding_enabled.

Returns:

  • (Boolean, nil) 


81
82
83
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 81

def call_forwarding_enabled
  @call_forwarding_enabled
end

#call_recording_enabled ⇒ Boolean? (readonly)

Returns the value of attribute call_recording_enabled.

Returns:

  • (Boolean, nil) 


85
86
87
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 85

def call_recording_enabled
  @call_recording_enabled
end

#caller_id_name_enabled ⇒ Boolean? (readonly)

Returns the value of attribute caller_id_name_enabled.

Returns:

  • (Boolean, nil) 


89
90
91
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 89

def caller_id_name_enabled
  @caller_id_name_enabled
end

#cnam_listing_enabled ⇒ Boolean? (readonly)

Returns the value of attribute cnam_listing_enabled.

Returns:

  • (Boolean, nil) 


93
94
95
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 93

def cnam_listing_enabled
  @cnam_listing_enabled
end

#connection_id ⇒ String?

Identifies the connection associated with the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :connection_id, String

#connection_name ⇒ String? (readonly)

Returns the value of attribute connection_name.

Returns:

  • (String, nil) 


97
98
99
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 97

def connection_name
  @connection_name
end

#created_at ⇒ String? (readonly)

Returns the value of attribute created_at.

Returns:

  • (String, nil) 


101
102
103
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 101

def created_at
  @created_at
end

#customer_reference ⇒ String?

A customer reference string for customer look ups.

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/telnyx/models/phone_number_delete_response.rb', line 33

optional :customer_reference, String

#deletion_lock_enabled ⇒ Boolean? (readonly)

Returns the value of attribute deletion_lock_enabled.

Returns:

  • (Boolean, nil) 


105
106
107
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 105

def deletion_lock_enabled
  @deletion_lock_enabled
end

#emergency_address_id ⇒ String? (readonly)

Returns the value of attribute emergency_address_id.

Returns:

  • (String, nil) 


109
110
111
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 109

def emergency_address_id
  @emergency_address_id
end

#emergency_enabled ⇒ Boolean? (readonly)

Returns the value of attribute emergency_enabled.

Returns:

  • (Boolean, nil) 


113
114
115
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 113

def emergency_enabled
  @emergency_enabled
end

#external_pin ⇒ String?

If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.

Parameters:

  • (String)

Returns:

  • (String, nil) 


42
 
# File 'lib/telnyx/models/phone_number_delete_response.rb', line 42

optional :external_pin, String

#hd_voice_enabled ⇒ Boolean? (readonly)

Returns the value of attribute hd_voice_enabled.

Returns:

  • (Boolean, nil) 


117
118
119
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 117

def hd_voice_enabled
  @hd_voice_enabled
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


77
78
79
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 77

def id
  @id
end

#messaging_profile_id ⇒ String?

Identifies the messaging profile associated with the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


48
 
# File 'lib/telnyx/models/phone_number_delete_response.rb', line 48

optional :messaging_profile_id, String

#messaging_profile_name ⇒ String?

The name of the messaging profile associated with the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


54
 
# File 'lib/telnyx/models/phone_number_delete_response.rb', line 54

optional :messaging_profile_name, String

#phone_number ⇒ String? (readonly)

Returns the value of attribute phone_number.

Returns:

  • (String, nil) 


121
122
123
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 121

def phone_number
  @phone_number
end

#phone_number_type ⇒ Telnyx::Models::PhoneNumberDeleteResponse::Data::phone_number_type? (readonly)

Returns the value of attribute phone_number_type.

Returns:

  • (Telnyx::Models::PhoneNumberDeleteResponse::Data::phone_number_type, nil) 


125
126
127
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 125

def phone_number_type
  @phone_number_type
end

#purchased_at ⇒ String? (readonly)

Returns the value of attribute purchased_at.

Returns:

  • (String, nil) 


131
132
133
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 131

def purchased_at
  @purchased_at
end

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


135
136
137
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 135

def record_type
  @record_type
end

#status ⇒ Telnyx::Models::PhoneNumberDeleteResponse::Data::status? (readonly)

Returns the value of attribute status.

Returns:

  • (Telnyx::Models::PhoneNumberDeleteResponse::Data::status, nil) 


139
140
141
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 139

def status
  @status
end

#t38_fax_gateway_enabled ⇒ Boolean? (readonly)

Returns the value of attribute t38_fax_gateway_enabled.

Returns:

  • (Boolean, nil) 


145
146
147
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 145

def t38_fax_gateway_enabled
  @t38_fax_gateway_enabled
end

#tags ⇒ Array<String>?

A list of user-assigned tags to help manage the phone number.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


60
 
# File 'lib/telnyx/models/phone_number_delete_response.rb', line 60

optional :tags, Telnyx::Internal::Type::ArrayOf[String]

#updated_at ⇒ String? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (String, nil) 


149
150
151
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 149

def updated_at
  @updated_at
end

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/phone_number_delete_response.rb', line 245

Instance Method Details

#call_forwarding_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


83
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 83

def call_forwarding_enabled=: (bool) -> bool

#call_recording_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


87
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 87

def call_recording_enabled=: (bool) -> bool

#caller_id_name_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


91
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 91

def caller_id_name_enabled=: (bool) -> bool

#cnam_listing_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


95
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 95

def cnam_listing_enabled=: (bool) -> bool

#connection_name= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


99
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 99

def connection_name=: (String) -> String

#created_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


103
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 103

def created_at=: (String) -> String

#deletion_lock_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


107
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 107

def deletion_lock_enabled=: (bool) -> bool

#emergency_address_id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


111
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 111

def emergency_address_id=: (String) -> String

#emergency_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


115
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 115

def emergency_enabled=: (bool) -> bool

#hd_voice_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


119
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 119

def hd_voice_enabled=: (bool) -> bool

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


79
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 79

def id=: (String) -> String

#phone_number= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


123
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 123

def phone_number=: (String) -> String

#phone_number_type= ⇒ Object (readonly) 



127
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 127

def phone_number_type=: (

#purchased_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


133
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 133

def purchased_at=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


137
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 137

def record_type=: (String) -> String

#status= ⇒ Object (readonly) 



141
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 141

def status=: (

#t38_fax_gateway_enabled= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


147
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 147

def t38_fax_gateway_enabled=: (bool) -> bool

#to_hash ⇒ {

Returns:

  • ({) 


181
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 181

def to_hash: -> {

#updated_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


151
 
# File 'sig/telnyx/models/phone_number_delete_response.rbs', line 151

def updated_at=: (String) -> String