Class: ContextDev::Models::BrandRetrieveSimplifiedParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::BrandRetrieveSimplifiedParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/context_dev/models/brand_retrieve_simplified_params.rb

Overview

See Also:

• Resources::Brand#retrieve_simplified

Instance Attribute Summary

• #domain ⇒ String

  Domain name to retrieve simplified brand data for.

• #timeout_ms ⇒ Integer^?

  Optional timeout in milliseconds for the request.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(domain:, timeout_ms: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see BrandRetrieveSimplifiedParams for more details.

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

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

Parameters:

• domain (String) —

  Domain name to retrieve simplified brand data for

• 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_simplified_params.rb', line 24

Instance Attribute Details

#domain ⇒ String

Domain name to retrieve simplified brand data for

Returns:

• (String)

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

required :domain, 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).

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/brand_retrieve_simplified_params.rb', line 22

optional :timeout_ms, Integer