Class: ContextDev::Models::BrandRetrieveResponse::Brand::Logo

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/brand_retrieve_response.rb

Defined Under Namespace

Modules: Mode, Type Classes: Color, Resolution

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(aspect_ratio: nil, height: nil, width: nil) ⇒ Object

Resolution of the logo image

Parameters:

  • aspect_ratio (Float) (defaults to: nil) —

    Aspect ratio of the image (width/height)

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

    Height of the image in pixels

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

    Width of the image in pixels




# File 'lib/context_dev/models/brand_retrieve_response.rb', line 751

Instance Attribute Details

#colors ⇒ Array<ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Color>?

Array of colors in the logo

Returns:



695
696
 
# File 'lib/context_dev/models/brand_retrieve_response.rb', line 695

optional :colors,
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Color] }

#mode ⇒ Symbol, ...

Indicates when this logo is best used: ‘light’ = best for light mode, ‘dark’ = best for dark mode, ‘has_opaque_background’ = can be used for either as image has its own background

Returns:



704
 
# File 'lib/context_dev/models/brand_retrieve_response.rb', line 704

optional :mode, enum: -> { ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Mode }

#resolution ⇒ ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution?

Resolution of the logo image

Returns:



710
 
# File 'lib/context_dev/models/brand_retrieve_response.rb', line 710

optional :resolution, -> { ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution }

#type ⇒ Symbol, ...

Type of the logo based on resolution (e.g., ‘icon’, ‘logo’)

Returns:



716
 
# File 'lib/context_dev/models/brand_retrieve_response.rb', line 716

optional :type, enum: -> { ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Type }

#url ⇒ String?

CDN hosted url of the logo (ready for display)

Returns:

  • (String, nil) 


722
 
# File 'lib/context_dev/models/brand_retrieve_response.rb', line 722

optional :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/context_dev/models/brand_retrieve_response.rb', line 769