Class: Telnyx::Models::Dir::Reference

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

Defined Under Namespace

Modules: RecordType, RefType

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(full_name:, phone_e164:, record_type:, ref_type:, slot:, timezone:, email: nil, job_title: nil, organization: nil, relationship_to_registrant: nil) ⇒ Object

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

A reference (business or financial) on a DIR, in the customer-facing shape. No internal identifiers are exposed.

Parameters:

  • full_name (String) —

    Full name of the reference contact.

  • phone_e164 (String) —

    Reference phone number in E.164 format.

  • record_type (Symbol, Telnyx::Models::Dir::Reference::RecordType) —

    Always dir_reference.

  • ref_type (Symbol, Telnyx::Models::Dir::Reference::RefType) —

    Whether this is a business reference or the financial reference.

  • slot (Integer) —

    Position within the reference type, counting from 1. Business references occupy

  • timezone (String) —

    IANA timezone id for the reference. Calls are only placed within the reference's

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

    Reference contact email address.

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

    Job title of the reference contact.

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

    Organization the reference contact belongs to.

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

    How the reference contact is related to the registering business.




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

Instance Attribute Details

#email ⇒ String?

Reference contact email address.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

#full_name ⇒ String

Full name of the reference contact.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :full_name, String

#job_title ⇒ String?

Job title of the reference contact.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :job_title, String, nil?: true

#organization ⇒ String?

Organization the reference contact belongs to.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :organization, String, nil?: true

#phone_e164 ⇒ String

Reference phone number in E.164 format.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :phone_e164, String

#record_type ⇒ Telnyx::Models::Dir::Reference::record_type

Returns the value of attribute record_type.

Returns:

  • (Telnyx::Models::Dir::Reference::record_type) 


37
38
39
 
# File 'sig/telnyx/models/dir/reference.rbs', line 37

def record_type
  @record_type
end

#ref_type ⇒ Symbol, Telnyx::Models::Dir::Reference::RefType

Whether this is a business reference or the financial reference.

Parameters:

  • value (Telnyx::Models::Dir::Reference::ref_type)

Returns:



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

required :ref_type, enum: -> { Telnyx::Dir::Reference::RefType }

#relationship_to_registrant ⇒ String?

How the reference contact is related to the registering business.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :relationship_to_registrant, String, nil?: true

#slot ⇒ Integer

Position within the reference type, counting from 1. Business references occupy slots 1 and 2, in the order they were sent in the business_references array; the financial reference occupies slot 1. Use this value together with ref_type to address the reference when updating it.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :slot, Integer

#timezone ⇒ String

IANA timezone id for the reference. Calls are only placed within the reference's local 8am-9pm window.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :timezone, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


52
 
# File 'sig/telnyx/models/dir/reference.rbs', line 52

def to_hash: -> {