Class: ContextDev::Models::PersonEnrichResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/person_enrich_response.rb,
sig/context_dev/models/person_enrich_response.rbs

Overview

See Also:

  • ContextDev::Resources::People#enrich

Defined Under Namespace

Modules: Match Classes: KeyMetadata

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(person:, score:, status: :not_found) ⇒ Object

No usable person candidate was found.

Parameters:

  • person (nil)
  • score (nil)
  • status (Symbol, :not_found) (defaults to: :not_found) 



# File 'lib/context_dev/models/person_enrich_response.rb', line 20

Instance Attribute Details

#key_metadata ⇒ ContextDev::Models::PersonEnrichResponse::KeyMetadata?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:



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

optional :key_metadata, -> { ContextDev::Models::PersonEnrichResponse::KeyMetadata }

#match ⇒ ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound

The highest-scoring person candidate.

Parameters:

  • value (ContextDev::Models::PersonEnrichResponse::match)

Returns:



11
 
# File 'lib/context_dev/models/person_enrich_response.rb', line 11

required :match, union: -> { ContextDev::Models::PersonEnrichResponse::Match }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


23
 
# File 'sig/context_dev/models/person_enrich_response.rbs', line 23

def to_hash: -> {