Class: Telnyx::Models::DirUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/dir_update_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Document

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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?

Contact email of the authorizer. Telnyx may send verification or infringement notices here.

Returns:

  • (String, nil) 


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

optional :authorizer_email, String

#authorizer_name ⇒ String?

Name of the person at your enterprise authorizing this DIR. Must be a real individual.

Returns:

  • (String, nil) 


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

optional :authorizer_name, String

#call_reasons ⇒ Array<String>?

1–10 reasons your business calls customers. Validate phrasing against ‘POST /call_reasons/validate`.

Returns:

  • (Array<String>, nil) 


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

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

#certify_brand_is_accurate ⇒ Boolean?

Certification that the DIR information is accurate. Must be ‘true` for the DIR to be submitted for vetting.

Returns:

  • (Boolean, nil) 


41
 
# File 'lib/telnyx/models/dir_update_params.rb', line 41

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

#certify_ip_ownership ⇒ Boolean?

Certification of ownership of any logos/trademarks shown. Must be ‘true` for the DIR to be submitted for vetting.

Returns:

  • (Boolean, nil) 


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

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

#certify_no_shaft_content ⇒ Boolean?

Certification that this DIR is not used for SHAFT content (Sex, Hate, Alcohol, Firearms, Tobacco) where prohibited. Must be ‘true` for the DIR to be submitted for vetting.

Returns:

  • (Boolean, nil) 


56
 
# File 'lib/telnyx/models/dir_update_params.rb', line 56

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

#dir_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/telnyx/models/dir_update_params.rb', line 13

required :dir_id, String

#display_name ⇒ String?

Name shown to call recipients. 1–35 characters, no emoji, not whitespace-only.

Returns:

  • (String, nil) 


62
 
# File 'lib/telnyx/models/dir_update_params.rb', line 62

optional :display_name, String

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

Additional supporting documents to attach. Append-only: existing documents are never removed or replaced, and an empty or omitted list is a no-op. Each ‘document_id` may appear at most once on a DIR.

Returns:



70
 
# File 'lib/telnyx/models/dir_update_params.rb', line 70

optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DirUpdateParams::Document] }

#logo_url ⇒ String?

Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).

Returns:

  • (String, nil) 


76
 
# File 'lib/telnyx/models/dir_update_params.rb', line 76

optional :logo_url, String

#reselling ⇒ Boolean?

Set to true if your organization places calls on behalf of other enterprises (BPO/reseller). Updating this triggers re-vetting on next submit.

Returns:

  • (Boolean, nil) 


83
 
# File 'lib/telnyx/models/dir_update_params.rb', line 83

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