• management
• SDK
• SettingsClient

Class SettingsClient

Index

Constructors

constructor

Methods

getupdate

Properties

_options

Constructors

constructor

new SettingsClient(options: BaseClientOptions): SettingsClient

Parameters

• options: BaseClientOptions

Returns SettingsClient

Methods

get

get(
request?: GetTenantSettingsRequestParameters,
requestOptions?: SettingsClient.RequestOptions,
): HttpResponsePromise<GetTenantSettingsResponseContent>

Retrieve tenant settings. A list of fields to include or exclude may also be specified.

Parameters

• request: GetTenantSettingsRequestParameters = {}
• OptionalrequestOptions: SettingsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetTenantSettingsResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.tenants.settings.get({ fields: "fields", include_fields: true })Copy

update

update(
request?: UpdateTenantSettingsRequestContent,
requestOptions?: SettingsClient.RequestOptions,
): HttpResponsePromise<UpdateTenantSettingsResponseContent>

Update settings for a tenant.

Parameters

• request: UpdateTenantSettingsRequestContent = {}
• OptionalrequestOptions: SettingsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateTenantSettingsResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.tenants.settings.update()Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getupdate Properties _options