Class TenantUpdateParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class TenantUpdateParams implements Params
Create or Replace a Tenant
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTenantUpdateParams.BuilderA builder for TenantUpdateParams.
public final classTenantUpdateParams.Bodypublic final classTenantUpdateParams.PropertiesArbitrary properties accessible to a template.
public final classTenantUpdateParams.UserProfileA user profile object merged with user profile on send.
-
Method Summary
Modifier and Type Method Description final Optional<String>tenantId()final Stringname()Name of the tenant. final Optional<String>brandId()Brand to be used for the account when one is not specified by the send call. final Optional<DefaultPreferences>defaultPreferences()Defines the preferences used for the tenant when the user hasn't specified their own. final Optional<String>parentTenantId()Tenant's parent id (if any). final Optional<TenantUpdateParams.Properties>properties()Arbitrary properties accessible to a template. final Optional<TenantUpdateParams.UserProfile>userProfile()A user profile object merged with user profile on send. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_brandId()Returns the raw JSON value of brandId. final JsonField<DefaultPreferences>_defaultPreferences()Returns the raw JSON value of defaultPreferences. final JsonField<String>_parentTenantId()Returns the raw JSON value of parentTenantId. final JsonField<TenantUpdateParams.Properties>_properties()Returns the raw JSON value of properties. final JsonField<TenantUpdateParams.UserProfile>_userProfile()Returns the raw JSON value of userProfile. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final TenantUpdateParams.BuildertoBuilder()final TenantUpdateParams.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 TenantUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of TenantUpdateParams. -
-
Method Detail
-
brandId
final Optional<String> brandId()
Brand to be used for the account when one is not specified by the send call.
-
defaultPreferences
final Optional<DefaultPreferences> defaultPreferences()
Defines the preferences used for the tenant when the user hasn't specified their own.
-
parentTenantId
final Optional<String> parentTenantId()
Tenant's parent id (if any).
-
properties
final Optional<TenantUpdateParams.Properties> properties()
Arbitrary properties accessible to a template.
-
userProfile
final Optional<TenantUpdateParams.UserProfile> userProfile()
A user profile object merged with user profile on send.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_brandId
final JsonField<String> _brandId()
Returns the raw JSON value of brandId.
Unlike brandId, this method doesn't throw if the JSON field has an unexpected type.
-
_defaultPreferences
final JsonField<DefaultPreferences> _defaultPreferences()
Returns the raw JSON value of defaultPreferences.
Unlike defaultPreferences, this method doesn't throw if the JSON field has an unexpected type.
-
_parentTenantId
final JsonField<String> _parentTenantId()
Returns the raw JSON value of parentTenantId.
Unlike parentTenantId, this method doesn't throw if the JSON field has an unexpected type.
-
_properties
final JsonField<TenantUpdateParams.Properties> _properties()
Returns the raw JSON value of properties.
Unlike properties, this method doesn't throw if the JSON field has an unexpected type.
-
_userProfile
final JsonField<TenantUpdateParams.UserProfile> _userProfile()
Returns the raw JSON value of userProfile.
Unlike userProfile, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final TenantUpdateParams.Builder toBuilder()
-
_body
final TenantUpdateParams.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.
-
builder
final static TenantUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of TenantUpdateParams.
The following fields are required:
.name()
-
-
-
-