Class: ContextDev::Models::BrandSearchResponse::Result

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

Instance Attribute 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(results:, key_metadata: nil) ⇒ Result

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

Parameters:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/context_dev/models/brand_search_response.rb', line 29

class Result < ContextDev::Internal::Type::BaseModel
  # @!attribute domain
  #   The brand's domain.
  #
  #   @return [String]
  required :domain, String

  # @!attribute logo
  #   Logo link URL that serves the brand's logo, generated per request for the
  #   calling organization.
  #
  #   @return [String]
  required :logo, String

  # @!attribute name
  #   The brand's name. Empty string when unknown.
  #
  #   @return [String]
  required :name, String

  # @!method initialize(domain:, logo:, name:)
  #   Some parameter documentations has been truncated, see
  #   {ContextDev::Models::BrandSearchResponse::Result} for more details.
  #
  #   @param domain [String] The brand's domain.
  #
  #   @param logo [String] Logo link URL that serves the brand's logo, generated per request for the callin
  #
  #   @param name [String] The brand's name. Empty string when unknown.
end

Instance Attribute Details

#domainString

The brand's domain.

Parameters:

  • value (String)

Returns:

  • (String)


34
# File 'lib/context_dev/models/brand_search_response.rb', line 34

required :domain, String

#logoString

Logo link URL that serves the brand's logo, generated per request for the calling organization.

Parameters:

  • value (String)

Returns:

  • (String)


41
# File 'lib/context_dev/models/brand_search_response.rb', line 41

required :logo, String

#nameString

The brand's name. Empty string when unknown.

Parameters:

  • value (String)

Returns:

  • (String)


47
# File 'lib/context_dev/models/brand_search_response.rb', line 47

required :name, String

Instance Method Details

#to_hash{ domain: String, logo: String, name: String }

Returns:

  • ({ domain: String, logo: String, name: String })


39
# File 'sig/context_dev/models/brand_search_response.rbs', line 39

def to_hash: -> { domain: String, logo: String, name: String }