Class: Telnyx::Models::Dir::ReferenceCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Dir::ReferenceCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/dir/reference_create_params.rb,
sig/telnyx/models/dir/reference_create_params.rbs

Overview

See Also:

• Telnyx::Resources::Dir::References#create

Instance Attribute Summary

• #business_references ⇒ Array<Telnyx::Models::Dir::ReferenceInput>

  Exactly two business references.

• #dir_id ⇒ String
• #financial_reference ⇒ Telnyx::Models::Dir::ReferenceInput

  One reference supplied at submit.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(dir_id:, business_references:, financial_reference:, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(dir_id:, business_references:, financial_reference:, request_options: {}) ⇒ Object

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

Parameters:

• dir_id (String)
• business_references (Array<Telnyx::Models::Dir::ReferenceInput>) —

  Exactly two business references.

• financial_reference (Telnyx::Models::Dir::ReferenceInput) —

  One reference supplied at submit. The reference type is implied by the field tha

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

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

Instance Attribute Details

#business_references ⇒ Array<Telnyx::Models::Dir::ReferenceInput>

Exactly two business references.

Parameters:

• value (::Array[Telnyx::Dir::ReferenceInput])

Returns:

• (Array<Telnyx::Models::Dir::ReferenceInput>)

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

required :business_references, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::ReferenceInput] }

#dir_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/dir/reference_create_params.rb', line 14

required :dir_id, String

#financial_reference ⇒ Telnyx::Models::Dir::ReferenceInput

One reference supplied at submit. The reference type is implied by the field that carries it (business_references vs financial_reference).

Parameters:

• value (Telnyx::Dir::ReferenceInput)

Returns:

• (Telnyx::Models::Dir::ReferenceInput)

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

required :financial_reference, -> { Telnyx::Dir::ReferenceInput }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/dir/reference_create_params.rbs', line 29

def to_hash: -> {