Class: Telnyx::Models::DirAPI

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

Overview

See Also:

  • Telnyx::Resources::Dir#list

Defined Under Namespace

Classes: CallReason

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 



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

def initialize: (

Instance Attribute Details

#authorizer_email ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :authorizer_email, String, nil?: true

#authorizer_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :authorizer_name, String, nil?: true

#call_reasons ⇒ Array<Telnyx::Models::DirAPI::CallReason>?

Returns:



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

optional :call_reasons, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DirAPI::CallReason] }

#certify_brand_is_accurate ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :certify_brand_is_accurate, Telnyx::Internal::Type::Boolean

#certify_ip_ownership ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :certify_ip_ownership, Telnyx::Internal::Type::Boolean

#certify_no_shaft_content ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :certify_no_shaft_content, Telnyx::Internal::Type::Boolean

#created_at ⇒ Time? (readonly)

Returns the value of attribute created_at.

Returns:

  • (Time, nil) 


76
77
78
 
# File 'sig/telnyx/models/dir.rbs', line 76

def created_at
  @created_at
end

#display_name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :display_name, String

#documents ⇒ Array<Telnyx::Models::Document>?

Parameters:

Returns:



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

optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }, nil?: true

#enterprise_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :enterprise_id, String

#expiring_at ⇒ Time?

Returns the value of attribute expiring_at.

Returns:

  • (Time, nil) 


80
81
82
 
# File 'sig/telnyx/models/dir.rbs', line 80

def expiring_at
  @expiring_at
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


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

def id
  @id
end

#logo_url ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :logo_url, String, nil?: true

#rejected_at ⇒ Time?

Returns the value of attribute rejected_at.

Returns:

  • (Time, nil) 


82
83
84
 
# File 'sig/telnyx/models/dir.rbs', line 82

def rejected_at
  @rejected_at
end

#rejection_reasons ⇒ Array<Telnyx::Models::Dir::RejectionReason>?

Populated when status is rejected; cleared on /submit or successful approval.

Parameters:

  • value (::Array[Telnyx::Dir::RejectionReason], nil)

Returns:



62
63
64
 
# File 'lib/telnyx/models/dir.rb', line 62

optional :rejection_reasons,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::RejectionReason] },
nil?: true

#reselling ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :reselling, Telnyx::Internal::Type::Boolean

#status ⇒ Symbol, ...

DIR lifecycle status.

  • draft - newly created; editable; not yet submitted.
  • submitted / in_review - Telnyx is reviewing.
  • verified - approved; phone numbers may be attached.
  • rejected - Telnyx rejected this submission; rejection_reasons is populated; customer can edit and resubmit.
  • unsuccessful - system-side error during processing; customer can edit and resubmit.
  • suspended - temporarily disabled (e.g. by an active infringement claim).
  • expired - verification expired; customer must resubmit.
  • infringement_claimed - a trademark/impersonation claim is open against this DIR.
  • permanently_rejected - terminal; cannot be resubmitted.

Parameters:

  • (Telnyx::Models::dir_status)

Returns:



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

optional :status, enum: -> { Telnyx::DirStatus }

#submitted_at ⇒ Time?

Returns the value of attribute submitted_at.

Returns:

  • (Time, nil) 


84
85
86
 
# File 'sig/telnyx/models/dir.rbs', line 84

def submitted_at
  @submitted_at
end

#updated_at ⇒ Time? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (Time, nil) 


86
87
88
 
# File 'sig/telnyx/models/dir.rbs', line 86

def updated_at
  @updated_at
end

#verified_at ⇒ Time?

Returns the value of attribute verified_at.

Returns:

  • (Time, nil) 


90
91
92
 
# File 'sig/telnyx/models/dir.rbs', line 90

def verified_at
  @verified_at
end

Instance Method Details

#created_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


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

def created_at=: (Time) -> Time

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


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

def id=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {

#updated_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


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

def updated_at=: (Time) -> Time