Class: Knockapi::Models::TenantSetParams::Settings::Branding

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::TenantSetParams::Settings::Branding

Defined in:

lib/knockapi/models/tenant_set_params.rb

Overview

See Also:

• #branding

Instance Attribute Summary

• #icon_url ⇒ String^?

  The icon URL for the tenant.

• #logo_url ⇒ String^?

  The logo URL for the tenant.

• #primary_color ⇒ String^?

  The primary color for the tenant, provided as a hex value.

• #primary_color_contrast ⇒ String^?

  The primary color contrast for the tenant, provided as a hex value.

Instance Method Summary

• #initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil) ⇒ Object constructor

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

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(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::TenantSetParams::Settings::Branding for more details.

The branding for the tenant.

# File 'lib/knockapi/models/tenant_set_params.rb', line 102

Instance Attribute Details

#icon_url ⇒ String^?

The icon URL for the tenant. Must point to a valid image with an image MIME type.

# File 'lib/knockapi/models/tenant_set_params.rb', line 81

optional :icon_url, String, nil?: true

#logo_url ⇒ String^?

The logo URL for the tenant. Must point to a valid image with an image MIME type.

# File 'lib/knockapi/models/tenant_set_params.rb', line 88

optional :logo_url, String, nil?: true

#primary_color ⇒ String^?

The primary color for the tenant, provided as a hex value.

# File 'lib/knockapi/models/tenant_set_params.rb', line 94

optional :primary_color, String, nil?: true

#primary_color_contrast ⇒ String^?

The primary color contrast for the tenant, provided as a hex value.

# File 'lib/knockapi/models/tenant_set_params.rb', line 100

optional :primary_color_contrast, String, nil?: true