Class: PreludeSDK::Models::LookupLookupParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• PreludeSDK::Models::LookupLookupParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/prelude_sdk/models/lookup_lookup_params.rb

Overview

See Also:

• Resources::Lookup#lookup

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #phone_number ⇒ String

  An E.164 formatted phone number to look up.

• #type ⇒ Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>^?

  Optional features.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from PreludeSDK::Internal::Type::BaseModel

Instance Attribute Details

#phone_number ⇒ String

An E.164 formatted phone number to look up.

Returns:

• (String)

# File 'lib/prelude_sdk/models/lookup_lookup_params.rb', line 14

required :phone_number, String

#type ⇒ Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>^?

Optional features. Possible values are:

• ‘cnam` - Retrieve CNAM (Caller ID Name) along with other information. Contact us if you need to use this functionality.

Returns:

• (Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>, nil)

# File 'lib/prelude_sdk/models/lookup_lookup_params.rb', line 23

optional :type, -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::LookupLookupParams::Type] }