Class: Telnyx::Models::Enterprises::DirCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/enterprises/dir_create_params.rb,
sig/telnyx/models/enterprises/dir_create_params.rbs

Overview

See Also:

  • Telnyx::Resources::Enterprises::Dir#create

Defined Under Namespace

Modules: CertifyBrandIsAccurate, CertifyIPOwnership, CertifyNoShaftContent

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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, 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(enterprise_id:, authorizer_email:, authorizer_name:, call_reasons:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, documents: nil, logo_url: nil, reselling: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Enterprises::DirCreateParams for more details.

Parameters:

  • enterprise_id (String)
  • authorizer_email (String) —

    Contact email of the authorizer. Telnyx may send verification or infringement-no

  • authorizer_name (String) —

    Name of the person at your enterprise who is authorizing this DIR registration.

  • call_reasons (Array<String>) —

    1–10 reasons your business calls customers. Validate phrasing against `POST /cal

  • certify_brand_is_accurate (Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate) —

    Must be true.

  • certify_ip_ownership (Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyIPOwnership) —

    Must be true. Confirms ownership of any logos/trademarks shown.

  • certify_no_shaft_content (Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyNoShaftContent) —

    Must be true. Confirms this DIR is not used for SHAFT content (Sex, Hate, Alco

  • display_name (String) —

    Name shown to call recipients. No emoji; not whitespace-only.

  • documents (Array<Telnyx::Models::Document>) (defaults to: nil) —

    Supporting documents. Each document_id may appear at most once on a DIR.

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

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

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

    Set to true if your organization places calls on behalf of other enterprises (BP

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#authorizer_email ⇒ String

Contact email of the authorizer. Telnyx may send verification or infringement-notice email here; use a monitored mailbox.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :authorizer_email, String

#authorizer_name ⇒ String

Name of the person at your enterprise who is authorizing this DIR registration. Must be a real individual (used for audit and trademark-claim contests).

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 28

required :authorizer_name, String

#call_reasons ⇒ Array<String>

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

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

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

#certify_brand_is_accurate ⇒ Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate

Must be true.

Parameters:

  • value (Telnyx::Models::Enterprises::DirCreateParams::certify_brand_is_accurate)

Returns:



41
42
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 41

required :certify_brand_is_accurate,
enum: -> { Telnyx::Enterprises::DirCreateParams::CertifyBrandIsAccurate }

#certify_ip_ownership ⇒ Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyIPOwnership

Must be true. Confirms ownership of any logos/trademarks shown.

Parameters:

  • value (Telnyx::Models::Enterprises::DirCreateParams::certify_ip_ownership)

Returns:



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

required :certify_ip_ownership, enum: -> { Telnyx::Enterprises::DirCreateParams::CertifyIPOwnership }

#certify_no_shaft_content ⇒ Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyNoShaftContent

Must be true. Confirms this DIR is not used for SHAFT content (Sex, Hate, Alcohol, Firearms, Tobacco) where prohibited.

Parameters:

  • value (Telnyx::Models::Enterprises::DirCreateParams::certify_no_shaft_content)

Returns:



55
56
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 55

required :certify_no_shaft_content,
enum: -> { Telnyx::Enterprises::DirCreateParams::CertifyNoShaftContent }

#display_name ⇒ String

Name shown to call recipients. No emoji; not whitespace-only.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :display_name, String

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

Supporting documents. Each document_id may appear at most once on a DIR.

Parameters:

Returns:



68
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 68

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

#enterprise_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 14

required :enterprise_id, String

#logo_url ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


74
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 74

optional :logo_url, String

#reselling ⇒ Boolean?

Set to true if your organization places calls on behalf of other enterprises (BPO/reseller).

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


81
 
# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 81

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

Class Method Details

.values ⇒ Array<Boolean>

Returns:

  • (Array<Boolean>) 



# File 'lib/telnyx/models/enterprises/dir_create_params.rb', line 117

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


67
 
# File 'sig/telnyx/models/enterprises/dir_create_params.rbs', line 67

def to_hash: -> {