Class: Telnyx::Models::DirAPI

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

Overview

See Also:

Defined Under Namespace

Classes: CallReason

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Telnyx::Internal::Type::BaseModel

Instance Attribute Details

#authorizer_email ⇒ String?

Returns:

  • (String, nil) 


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

optional :authorizer_email, String, nil?: true

#authorizer_name ⇒ String?

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?

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?

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?

Returns:

  • (Boolean, nil) 


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

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

#display_name ⇒ String?

Returns:

  • (String, nil) 


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

optional :display_name, String

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

Returns:



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

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

#enterprise_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :enterprise_id, String

#logo_url ⇒ String?

Returns:

  • (String, nil) 


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

optional :logo_url, String, nil?: true

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

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

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?

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.

Returns:



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

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