Class: Knockapi::Models::Tenant::Settings

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::Tenant::Settings

Defined in:

lib/knockapi/models/tenant.rb

Overview

See Also:

• #settings

Defined Under Namespace

Classes: Branding

Instance Attribute Summary

• #branding ⇒ Knockapi::Models::Tenant::Settings::Branding^?

  The branding for the tenant.

• #preference_set ⇒ Knockapi::Models::Recipients::PreferenceSet^?

  A preference set represents a specific set of notification preferences for a recipient.

Instance Method Summary

• #initialize(branding: nil, preference_set: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Settings 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(branding: nil, preference_set: nil) ⇒ Object

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

The settings for the tenant. Includes branding and preference set.

Parameters:

• branding (Knockapi::Models::Tenant::Settings::Branding, nil) (defaults to: nil) —

  The branding for the tenant.

• preference_set (Knockapi::Models::Recipients::PreferenceSet, nil) (defaults to: nil) —

  A preference set represents a specific set of notification preferences for a rec

# File 'lib/knockapi/models/tenant.rb', line 57

Instance Attribute Details

#branding ⇒ Knockapi::Models::Tenant::Settings::Branding^?

The branding for the tenant.

Returns:

• (Knockapi::Models::Tenant::Settings::Branding, nil)

# File 'lib/knockapi/models/tenant.rb', line 48

optional :branding, -> { Knockapi::Tenant::Settings::Branding }, nil?: true

#preference_set ⇒ Knockapi::Models::Recipients::PreferenceSet^?

A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.

Returns:

• (Knockapi::Models::Recipients::PreferenceSet, nil)

# File 'lib/knockapi/models/tenant.rb', line 55

optional :preference_set, -> { Knockapi::Recipients::PreferenceSet }, nil?: true