Class: ContextDev::Models::PersonEnrichParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/context_dev/models/person_enrich_params.rb,
sig/context_dev/models/person_enrich_params.rbs

Overview

See Also:

  • ContextDev::Resources::People#enrich

Defined Under Namespace

Classes: Company, Education, Location, Name

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ContextDev

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(city: nil, country: nil, region: nil) ⇒ Object

Parameters:

  • city (String) (defaults to: nil)
  • country (String) (defaults to: nil)
  • region (String) (defaults to: nil) 



# File 'lib/context_dev/models/person_enrich_params.rb', line 87

Instance Attribute Details

#company ⇒ ContextDev::Models::PersonEnrichParams::Company?

Returns:



13
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 13

optional :company, -> { ContextDev::PersonEnrichParams::Company }

#education ⇒ Array<ContextDev::Models::PersonEnrichParams::Education>?

Returns:



18
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 18

optional :education, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::PersonEnrichParams::Education] }

#email ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 23

optional :email, String

#location ⇒ ContextDev::Models::PersonEnrichParams::Location?

Returns:



28
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 28

optional :location, -> { ContextDev::PersonEnrichParams::Location }

#name ⇒ ContextDev::Models::PersonEnrichParams::Name?

Returns:



33
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 33

optional :name, -> { ContextDev::PersonEnrichParams::Name }

#social_urls ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


38
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 38

optional :social_urls, ContextDev::Internal::Type::ArrayOf[String]

#tags ⇒ Array<String>?

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


44
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 44

optional :tags, ContextDev::Internal::Type::ArrayOf[String]

#timeout_ms ⇒ Integer?

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


52
 
# File 'lib/context_dev/models/person_enrich_params.rb', line 52

optional :timeout_ms, Integer, api_name: :timeoutMS

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


72
 
# File 'sig/context_dev/models/person_enrich_params.rbs', line 72

def to_hash: -> {