Class: Knockapi::Models::TenantRequest::Settings

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

Overview

See Also:

  • Knockapi::Models::TenantRequest#settings

Defined Under Namespace

Classes: Branding

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(branding: nil, preference_set: nil) ⇒ Object

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

Parameters:




# File 'lib/knockapi/models/tenant_request.rb', line 75

Instance Attribute Details

#branding ⇒ Knockapi::Models::TenantRequest::Settings::Branding?

The branding for the tenant.

Returns:



67
 
# File 'lib/knockapi/models/tenant_request.rb', line 67

optional :branding, -> { Knockapi::TenantRequest::Settings::Branding }

#preference_set ⇒ Knockapi::Models::Recipients::PreferenceSetRequest?

A request to set a preference set for a recipient.

Parameters:

  • value (Knockapi::Recipients::PreferenceSetRequest, nil)

Returns:



73
 
# File 'lib/knockapi/models/tenant_request.rb', line 73

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/knockapi/models/tenant_request.rbs', line 63

def to_hash: -> {