Class: Telnyx::Models::Dir::DirPhoneNumber

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

Overview

See Also:

  • Telnyx::Resources::Dir::PhoneNumbers#list

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 ⇒ Object 



60
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 60

def initialize: (

Instance Attribute Details

#batch_id ⇒ String?

Id of the batch this number was vetted as part of.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


12
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 12

optional :batch_id, String, nil?: true

#created_at ⇒ Time? (readonly)

Returns the value of attribute created_at.

Returns:

  • (Time, nil) 


50
51
52
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 50

def created_at
  @created_at
end

#dir_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 17

optional :dir_id, String

#enterprise_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


22
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 22

optional :enterprise_id, String

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


46
47
48
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 46

def id
  @id
end

#loa_document_id ⇒ String?

Id of the Letter of Authorization document attached to this number's batch.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


28
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 28

optional :loa_document_id, String, nil?: true

#phone_number ⇒ String?

E.164 with leading +.

Parameters:

  • (String)

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 34

optional :phone_number, String

#rejection_reason ⇒ Telnyx::Models::Dir::RejectionReason?

Populated when status is unsuccessful or permanently_rejected.

Parameters:

  • value (Telnyx::Dir::RejectionReason, nil)

Returns:



40
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 40

optional :rejection_reason, -> { Telnyx::Dir::RejectionReason }, nil?: true

#status ⇒ Symbol, ...

Phone-number lifecycle status.

  • submitted / in_review - Telnyx is reviewing the batch this number belongs to.
  • verified - approved; the DIR's display identity will be shown on outbound calls from this number.
  • unsuccessful - Telnyx rejected this submission; the customer may re-add to retry.
  • suspended - temporarily disabled (e.g. by an active infringement claim on the DIR).
  • expired - verification expired; re-add to renew.
  • permanently_rejected - terminal; cannot be re-added on this or any other DIR you own.

Returns:



58
 
# File 'lib/telnyx/models/dir/dir_phone_number.rb', line 58

optional :status, enum: -> { Telnyx::Dir::DirPhoneNumberStatus }

#updated_at ⇒ Time? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (Time, nil) 


54
55
56
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 54

def updated_at
  @updated_at
end

#verified_at ⇒ Time?

Returns the value of attribute verified_at.

Returns:

  • (Time, nil) 


58
59
60
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 58

def verified_at
  @verified_at
end

Instance Method Details

#created_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


52
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 52

def created_at=: (Time) -> Time

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


48
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 48

def id=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


74
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 74

def to_hash: -> {

#updated_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


56
 
# File 'sig/telnyx/models/dir/dir_phone_number.rbs', line 56

def updated_at=: (Time) -> Time