Class: Knockapi::Models::Tenant

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

Overview

See Also:

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:, _typename:, name: nil, settings: nil) ⇒ Object

A tenant entity.

Parameters:

  • id (String) —

    The unique identifier for the tenant.

  • _typename (String) —

    The typename of the schema.

  • name (String, nil) (defaults to: nil) —

    An optional name for the tenant.

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

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




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

Instance Attribute Details

#_typename ⇒ String

The typename of the schema.

Returns:

  • (String) 


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

required :_typename, String, api_name: :__typename

#id ⇒ String

The unique identifier for the tenant.

Returns:

  • (String) 


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

required :id, String

#name ⇒ String?

An optional name for the tenant.

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

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

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

Returns:



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

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