Class: ContextDev::Models::UtilityPrefetchParams

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

Overview

See Also:

  • ContextDev::Resources::Utility#prefetch

Defined Under Namespace

Modules: Identifier, Type

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ContextDev

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(email:) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier for more details.

Prefetch brand data by email. The domain will be extracted and validated.

Parameters:

  • email (String) —

    Email address to prefetch brand data for. The domain will be extracted from the




# File 'lib/context_dev/models/utility_prefetch_params.rb', line 30

Instance Attribute Details

#identifier ⇒ ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier

Identifier of the brand to prefetch. Provide exactly one of domain or email.

Parameters:

  • value (ContextDev::Models::UtilityPrefetchParams::identifier)

Returns:



14
 
# File 'lib/context_dev/models/utility_prefetch_params.rb', line 14

required :identifier, union: -> { ContextDev::UtilityPrefetchParams::Identifier }

#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) 


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

optional :timeout_ms, Integer, api_name: :timeoutMS

#type ⇒ Symbol, ContextDev::Models::UtilityPrefetchParams::Type

What to prefetch. Currently only 'brand' is supported.

Parameters:

  • value (ContextDev::Models::UtilityPrefetchParams::type_)

Returns:



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

required :type, enum: -> { ContextDev::UtilityPrefetchParams::Type }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


30
 
# File 'sig/context_dev/models/utility_prefetch_params.rbs', line 30

def to_hash: -> {