Class: ContextDev::Models::BrandRetrieveParams

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

Overview

See Also:

Defined Under Namespace

Modules: ForceLanguage

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(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::BrandRetrieveParams for more details.

Parameters:

  • domain (String) —

    Domain name to retrieve brand data for (e.g., ‘example.com’, ‘google.com’). Cann

  • force_language (Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage) (defaults to: nil) —

    Optional parameter to force the language of the retrieved brand data.

  • max_speed (Boolean) (defaults to: nil) —

    Optional parameter to optimize the API call for maximum speed. When set to true,

  • timeout_ms (Integer) (defaults to: nil) —

    Optional timeout in milliseconds for the request. If the request takes longer th

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



# File 'lib/context_dev/models/brand_retrieve_params.rb', line 39

Instance Attribute Details

#domain ⇒ String

Domain name to retrieve brand data for (e.g., ‘example.com’, ‘google.com’). Cannot be used with name or ticker parameters.

Returns:

  • (String) 


15
 
# File 'lib/context_dev/models/brand_retrieve_params.rb', line 15

required :domain, String

#force_language ⇒ Symbol, ...

Optional parameter to force the language of the retrieved brand data.

Returns:



21
 
# File 'lib/context_dev/models/brand_retrieve_params.rb', line 21

optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::ForceLanguage }

#max_speed ⇒ Boolean?

Optional parameter to optimize the API call for maximum speed. When set to true, the API will skip time-consuming operations for faster response at the cost of less comprehensive data. Works with all three lookup methods.

Returns:

  • (Boolean, nil) 


29
 
# File 'lib/context_dev/models/brand_retrieve_params.rb', line 29

optional :max_speed, ContextDev::Internal::Type::Boolean

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

Returns:

  • (Integer, nil) 


37
 
# File 'lib/context_dev/models/brand_retrieve_params.rb', line 37

optional :timeout_ms, Integer