Class: Telnyx::Models::Enterprises::Reputation::NumberRetrieveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Enterprises::Reputation::NumberRetrieveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb

Overview

See Also:

• Resources::Enterprises::Reputation::Numbers#retrieve

Instance Attribute Summary

• #enterprise_id ⇒ String
• #fresh ⇒ Boolean^?

  When true, fetches fresh reputation data (incurs API cost).

• #phone_number ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(enterprise_id:, phone_number:, fresh: nil, request_options: {}) ⇒ Object constructor

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

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:, phone_number:, fresh: nil, request_options: {}) ⇒ Object

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

Parameters:

• enterprise_id (String)
• phone_number (String)
• fresh (Boolean) (defaults to: nil) —

  When true, fetches fresh reputation data (incurs API cost). When false, returns

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

# File 'lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb', line 29

Instance Attribute Details

#enterprise_id ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb', line 15

required :enterprise_id, String

#fresh ⇒ Boolean^?

When true, fetches fresh reputation data (incurs API cost). When false, returns cached data.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb', line 27

optional :fresh, Telnyx::Internal::Type::Boolean

#phone_number ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb', line 20

required :phone_number, String