Class: Knockapi::Models::TenantRequest

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

Defined Under Namespace

Classes: Settings

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(id:, channel_data: nil, name: nil, preferences: nil, settings: nil) ⇒ Object

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

A tenant to be set in the system. You can supply any additional properties on the tenant object.

Parameters:




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

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.

Returns:



16
17
18
19
20
 
# File 'lib/knockapi/models/tenant_request.rb', line 16

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

#id ⇒ String

The unique identifier for the tenant.

Returns:

  • (String) 


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

required :id, String

#name ⇒ String?

An optional name for the tenant.

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#preferences ⇒ Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}?

Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences rather than replacing them.

Returns:



34
35
36
 
# File 'lib/knockapi/models/tenant_request.rb', line 34

optional :preferences,
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
nil?: true

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

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

Returns:



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

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