Class: Telnyx::Models::EnterprisePublic

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EnterprisePublic

Defined in:

lib/telnyx/models/enterprise_public.rb

Overview

See Also:

• Resources::Enterprises#list

Defined Under Namespace

Modules: NumberOfEmployees, OrganizationLegalType, OrganizationType, RoleType

Instance Attribute Summary

• #billing_address ⇒ Telnyx::Models::BillingAddress^?
• #billing_contact ⇒ Telnyx::Models::BillingContact^?
• #corporate_registration_number ⇒ String^?

  Corporate registration number.

• #country_code ⇒ String^?

  ISO 3166-1 alpha-2 country code.

• #created_at ⇒ Time^?

  When the enterprise was created.

• #customer_reference ⇒ String^?

  Customer reference identifier.

• #doing_business_as ⇒ String^?

  DBA name.

• #dun_bradstreet_number ⇒ String^?

  D-U-N-S Number.

• #fein ⇒ String^?

  Federal Employer Identification Number.

• #id ⇒ String^?

  Unique identifier of the enterprise.

• #industry ⇒ String^?

  Industry classification.

• #legal_name ⇒ String^?

  Legal name of the enterprise.

• #number_of_employees ⇒ Symbol, ...

  Employee count range.

• #organization_contact ⇒ Telnyx::Models::OrganizationContact^?

  Organization contact information.

• #organization_legal_type ⇒ Symbol, ...

  Legal structure type.

• #organization_physical_address ⇒ Telnyx::Models::PhysicalAddress^?
• #organization_type ⇒ Symbol, ...

  Type of organization.

• #primary_business_domain_sic_code ⇒ String^?

  SIC Code.

• #professional_license_number ⇒ String^?

  Professional license number.

• #role_type ⇒ Symbol, ...

  Role type in Branded Calling / Number Reputation services.

• #updated_at ⇒ Time^?

  When the enterprise was last updated.

• #website ⇒ String^?

  Company website URL.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id: nil, billing_address: nil, billing_contact: nil, corporate_registration_number: nil, country_code: nil, created_at: nil, customer_reference: nil, doing_business_as: nil, dun_bradstreet_number: nil, fein: nil, industry: nil, legal_name: nil, number_of_employees: nil, organization_contact: nil, organization_legal_type: nil, organization_physical_address: nil, organization_type: nil, primary_business_domain_sic_code: nil, professional_license_number: nil, role_type: nil, updated_at: nil, website: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see EnterprisePublic for more details.

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

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

Parameters:

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

  Unique identifier of the enterprise

• billing_address (Telnyx::Models::BillingAddress) (defaults to: nil)
• billing_contact (Telnyx::Models::BillingContact) (defaults to: nil)
• corporate_registration_number (String, nil) (defaults to: nil) —

  Corporate registration number

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

  ISO 3166-1 alpha-2 country code

• created_at (Time) (defaults to: nil) —

  When the enterprise was created

• customer_reference (String, nil) (defaults to: nil) —

  Customer reference identifier

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

  DBA name

• dun_bradstreet_number (String, nil) (defaults to: nil) —

  D-U-N-S Number

• fein (String, nil) (defaults to: nil) —

  Federal Employer Identification Number

• industry (String, nil) (defaults to: nil) —

  Industry classification

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

  Legal name of the enterprise

• number_of_employees (Symbol, Telnyx::Models::EnterprisePublic::NumberOfEmployees, nil) (defaults to: nil) —

  Employee count range

• organization_contact (Telnyx::Models::OrganizationContact) (defaults to: nil) —

  Organization contact information. Note: the response returns this object with th

• organization_legal_type (Symbol, Telnyx::Models::EnterprisePublic::OrganizationLegalType, nil) (defaults to: nil) —

  Legal structure type

• organization_physical_address (Telnyx::Models::PhysicalAddress) (defaults to: nil)
• organization_type (Symbol, Telnyx::Models::EnterprisePublic::OrganizationType) (defaults to: nil) —

  Type of organization

• primary_business_domain_sic_code (String, nil) (defaults to: nil) —

  SIC Code

• professional_license_number (String, nil) (defaults to: nil) —

  Professional license number

• role_type (Symbol, Telnyx::Models::EnterprisePublic::RoleType) (defaults to: nil) —

  Role type in Branded Calling / Number Reputation services

• updated_at (Time) (defaults to: nil) —

  When the enterprise was last updated

• website (String, nil) (defaults to: nil) —

  Company website URL

# File 'lib/telnyx/models/enterprise_public.rb', line 139

Instance Attribute Details

#billing_address ⇒ Telnyx::Models::BillingAddress^?

Returns:

• (Telnyx::Models::BillingAddress, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 16

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

#billing_contact ⇒ Telnyx::Models::BillingContact^?

Returns:

• (Telnyx::Models::BillingContact, nil)

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

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

#corporate_registration_number ⇒ String^?

Corporate registration number

Returns:

• (String, nil)

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

optional :corporate_registration_number, String, nil?: true

#country_code ⇒ String^?

ISO 3166-1 alpha-2 country code

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 33

optional :country_code, String

#created_at ⇒ Time^?

When the enterprise was created

Returns:

• (Time, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 39

optional :created_at, Time

#customer_reference ⇒ String^?

Customer reference identifier

Returns:

• (String, nil)

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

optional :customer_reference, String, nil?: true

#doing_business_as ⇒ String^?

DBA name

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 51

optional :doing_business_as, String

#dun_bradstreet_number ⇒ String^?

D-U-N-S Number

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 57

optional :dun_bradstreet_number, String, nil?: true

#fein ⇒ String^?

Federal Employer Identification Number

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 63

optional :fein, String, nil?: true

#id ⇒ String^?

Unique identifier of the enterprise

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 11

optional :id, String

#industry ⇒ String^?

Industry classification

Returns:

• (String, nil)

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

optional :industry, String, nil?: true

#legal_name ⇒ String^?

Legal name of the enterprise

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 75

optional :legal_name, String

#number_of_employees ⇒ Symbol, ...

Employee count range

Returns:

• (Symbol, Telnyx::Models::EnterprisePublic::NumberOfEmployees, nil)

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

optional :number_of_employees, enum: -> { Telnyx::EnterprisePublic::NumberOfEmployees }, nil?: true

#organization_contact ⇒ Telnyx::Models::OrganizationContact^?

Organization contact information. Note: the response returns this object with the phone field as ‘phone’ (not ‘phone_number’).

Returns:

• (Telnyx::Models::OrganizationContact, nil)

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

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

#organization_legal_type ⇒ Symbol, ...

Legal structure type

Returns:

• (Symbol, Telnyx::Models::EnterprisePublic::OrganizationLegalType, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 94

optional :organization_legal_type,
enum: -> { Telnyx::EnterprisePublic::OrganizationLegalType },
nil?: true

#organization_physical_address ⇒ Telnyx::Models::PhysicalAddress^?

Returns:

• (Telnyx::Models::PhysicalAddress, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 101

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

#organization_type ⇒ Symbol, ...

Type of organization

Returns:

• (Symbol, Telnyx::Models::EnterprisePublic::OrganizationType, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 107

optional :organization_type, enum: -> { Telnyx::EnterprisePublic::OrganizationType }

#primary_business_domain_sic_code ⇒ String^?

SIC Code

Returns:

• (String, nil)

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

optional :primary_business_domain_sic_code, String, nil?: true

#professional_license_number ⇒ String^?

Professional license number

Returns:

• (String, nil)

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

optional :professional_license_number, String, nil?: true

#role_type ⇒ Symbol, ...

Role type in Branded Calling / Number Reputation services

Returns:

• (Symbol, Telnyx::Models::EnterprisePublic::RoleType, nil)

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

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

#updated_at ⇒ Time^?

When the enterprise was last updated

Returns:

• (Time, nil)

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

optional :updated_at, Time

#website ⇒ String^?

Company website URL

Returns:

• (String, nil)

# File 'lib/telnyx/models/enterprise_public.rb', line 137

optional :website, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/enterprise_public.rb', line 201