Class: Knockapi::Models::TenantGetParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::TenantGetParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/knockapi/models/tenant_get_params.rb

Overview

See Also:

• Resources::Tenants#get

Instance Attribute Summary

• #resolve_full_preference_settings ⇒ Boolean^?

  When true, merges environment-level default preferences into the tenant’s ‘settings.preference_set` field before returning the response.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(resolve_full_preference_settings: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see TenantGetParams for more details.

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(resolve_full_preference_settings: nil, request_options: {}) ⇒ Object

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

Parameters:

• resolve_full_preference_settings (Boolean) (defaults to: nil) —

  When true, merges environment-level default preferences into the tenant’s ‘setti

• request_options (Knockapi::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/knockapi/models/tenant_get_params.rb', line 18

Instance Attribute Details

#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.

Returns:

• (Boolean, nil)

# File 'lib/knockapi/models/tenant_get_params.rb', line 16

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