Class: Knockapi::Models::TenantSetParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/knockapi/models/tenant_set_params.rb,
sig/knockapi/models/tenant_set_params.rbs

Overview

See Also:

  • Knockapi::Resources::Tenants#set

Defined Under Namespace

Classes: Settings

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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 ⇒ Object 



33
 
# File 'sig/knockapi/models/tenant_set_params.rbs', line 33

def initialize: (

Instance Attribute Details

#channel_data ⇒ Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}?

A request to set channel data for a type of channel inline.

Parameters:

  • value (Knockapi::Models::Recipients::inline_channel_data_request, nil)

Returns:



27
28
29
30
31
 
# File 'lib/knockapi/models/tenant_set_params.rb', line 27

optional :channel_data,
-> {
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
},
nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#name ⇒ String?

An optional name for the tenant.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#resolve_full_preference_settings ⇒ Boolean?

When true, merges environment-level default preferences into the tenant's settings.preference_set field before returning the response. Defaults to false.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :resolve_full_preference_settings, Knockapi::Internal::Type::Boolean

#settings ⇒ Knockapi::Models::TenantSetParams::Settings?

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

Returns:



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

optional :settings, -> { Knockapi::TenantSetParams::Settings }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


42
 
# File 'sig/knockapi/models/tenant_set_params.rbs', line 42

def to_hash: -> {