Class: Telnyx::Models::EnterpriseCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: Industry, NumberOfEmployees, OrganizationLegalType, OrganizationType, RoleType

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(billing_address:, billing_contact:, country_code:, doing_business_as:, fein:, industry:, jurisdiction_of_incorporation:, legal_name:, number_of_employees:, organization_contact:, organization_legal_type:, organization_physical_address:, organization_type:, website:, corporate_registration_number: nil, customer_reference: nil, dun_bradstreet_number: nil, primary_business_domain_sic_code: nil, professional_license_number: nil, role_type: nil, request_options: {}) ⇒ Object

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

Parameters:




# File 'lib/telnyx/models/enterprise_create_params.rb', line 140

Instance Attribute Details

#billing_address ⇒ Telnyx::Models::BillingAddress

Returns:



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

required :billing_address, -> { Telnyx::BillingAddress }

#billing_contact ⇒ Telnyx::Models::BillingContact

Returns:



18
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 18

required :billing_contact, -> { Telnyx::BillingContact }

#corporate_registration_number ⇒ String?

Optional corporate-registration / company-number identifier.

Returns:

  • (String, nil) 


106
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 106

optional :corporate_registration_number, String, nil?: true

#country_code ⇒ String

ISO 3166-1 alpha-2 country code. Currently ‘US` and `CA` are supported.

Returns:

  • (String) 


24
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 24

required :country_code, String

#customer_reference ⇒ String?

Optional free-form string the caller can attach for their own bookkeeping. Telnyx does not interpret it.

Returns:

  • (String, nil) 


113
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 113

optional :customer_reference, String

#doing_business_as ⇒ String

Returns:

  • (String) 


29
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 29

required :doing_business_as, String

#dun_bradstreet_number ⇒ String?

Optional D-U-N-S Number.

Returns:

  • (String, nil) 


119
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 119

optional :dun_bradstreet_number, String, nil?: true

#fein ⇒ String

US Federal Employer Identification Number (‘NN-NNNNNNN`) or Canadian equivalent.

Returns:

  • (String) 


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

required :fein, String

#industry ⇒ Symbol, Telnyx::Models::EnterpriseCreateParams::Industry

Industry classification.

Returns:



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

required :industry, enum: -> { Telnyx::EnterpriseCreateParams::Industry }

#jurisdiction_of_incorporation ⇒ String

Returns:

  • (String) 


46
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 46

required :jurisdiction_of_incorporation, String

#legal_name ⇒ String

Legal name of the enterprise.

Returns:

  • (String) 


52
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 52

required :legal_name, String

#number_of_employees ⇒ Symbol, Telnyx::Models::EnterpriseCreateParams::NumberOfEmployees

Approximate headcount range. Used for vetting heuristics; pick the bucket that contains your current employee count.

Returns:



59
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 59

required :number_of_employees, enum: -> { Telnyx::EnterpriseCreateParams::NumberOfEmployees }

#organization_contact ⇒ Telnyx::Models::OrganizationContact

Returns:



64
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 64

required :organization_contact, -> { Telnyx::OrganizationContact }

#organization_legal_type ⇒ Symbol, Telnyx::Models::EnterpriseCreateParams::OrganizationLegalType

Legal-entity form. Pick the form that matches your incorporation documents:

  • ‘corporation` - C-corp or S-corp.

  • ‘llc` - limited liability company.

  • ‘partnership` - general/limited partnership.

  • ‘nonprofit` - non-profit corporation, charitable trust, or 501©(3)/equivalent.

  • ‘other` - anything else (sole proprietorships, government bodies, DBAs, etc.). You may be asked for additional documents during vetting.

Returns:



78
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 78

required :organization_legal_type, enum: -> { Telnyx::EnterpriseCreateParams::OrganizationLegalType }

#organization_physical_address ⇒ Telnyx::Models::PhysicalAddress

Returns:



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

required :organization_physical_address, -> { Telnyx::PhysicalAddress }

#organization_type ⇒ Symbol, Telnyx::Models::EnterpriseCreateParams::OrganizationType

Organization category for vetting purposes:

  • ‘commercial` - for-profit business entities (LLC, corp, partnership, sole proprietorship). Most callers fall here.

  • ‘government` - federal/state/local government bodies.

  • ‘non_profit` - registered 501©(3)/equivalent (incl. educational institutions, charities, religious organisations).

Returns:



95
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 95

required :organization_type, enum: -> { Telnyx::EnterpriseCreateParams::OrganizationType }

#primary_business_domain_sic_code ⇒ String?

Optional SIC code for the primary line of business.

Returns:

  • (String, nil) 


125
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 125

optional :primary_business_domain_sic_code, String, nil?: true

#professional_license_number ⇒ String?

Optional professional-license number for regulated industries.

Returns:

  • (String, nil) 


131
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 131

optional :professional_license_number, String, nil?: true

#role_type ⇒ Symbol, ...

‘enterprise` for an organization registering its own DIRs; `bpo` for a Business Process Outsourcer placing calls on behalf of one or more enterprises.

Returns:



138
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 138

optional :role_type, enum: -> { Telnyx::EnterpriseCreateParams::RoleType }

#website ⇒ String

Returns:

  • (String) 


100
 
# File 'lib/telnyx/models/enterprise_create_params.rb', line 100

required :website, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/enterprise_create_params.rb', line 234