Class TenantSetParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class TenantSetParams implements Params
Sets a tenant within an environment, performing an upsert operation. Any existing properties will be merged with the incoming properties.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTenantSetParams.BuilderA builder for TenantSetParams.
public final classTenantSetParams.BodyA tenant to be set in the system. You can supply any additional properties on the tenant object.
public final classTenantSetParams.SettingsThe settings for the tenant. Includes branding and preference set.
-
Method Summary
Modifier and Type Method Description final Optional<String>id()final Optional<InlineChannelDataRequest>channelData()A request to set channel data for a type of channel inline. final Optional<InlinePreferenceSetRequest>preferences()Inline set preferences for a recipient, where the key is the preference set id. final Optional<TenantSetParams.Settings>settings()The settings for the tenant. final JsonField<InlineChannelDataRequest>_channelData()Returns the raw JSON value of channelData. final JsonField<InlinePreferenceSetRequest>_preferences()Returns the raw JSON value of preferences. final JsonField<TenantSetParams.Settings>_settings()Returns the raw JSON value of settings. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final TenantSetParams.BuildertoBuilder()final TenantSetParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static TenantSetParamsnone()final static TenantSetParams.Builderbuilder()Returns a mutable builder for constructing an instance of TenantSetParams. -
-
Method Detail
-
channelData
final Optional<InlineChannelDataRequest> channelData()
A request to set channel data for a type of channel inline.
-
preferences
final Optional<InlinePreferenceSetRequest> preferences()
Inline set preferences for a recipient, where the key is the preference set id.
-
settings
final Optional<TenantSetParams.Settings> settings()
The settings for the tenant. Includes branding and preference set.
-
_channelData
final JsonField<InlineChannelDataRequest> _channelData()
Returns the raw JSON value of channelData.
Unlike channelData, this method doesn't throw if the JSON field has an unexpected type.
-
_preferences
final JsonField<InlinePreferenceSetRequest> _preferences()
Returns the raw JSON value of preferences.
Unlike preferences, this method doesn't throw if the JSON field has an unexpected type.
-
_settings
final JsonField<TenantSetParams.Settings> _settings()
Returns the raw JSON value of settings.
Unlike settings, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final TenantSetParams.Builder toBuilder()
-
_body
final TenantSetParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static TenantSetParams none()
-
builder
final static TenantSetParams.Builder builder()
Returns a mutable builder for constructing an instance of TenantSetParams.
-
-
-
-