Class Settings

Index

Constructors

Methods

get update _getAuthorizationHeader

Properties

Constructors

constructor

new Settings(_options: Settings.Options): Settings
Parameters
- _options: Settings.Options
Returns Settings

Methods

get

get(
request?: Management.GetTenantSettingsRequestParameters,
requestOptions?: Settings.RequestOptions,
): HttpResponsePromise<GetTenantSettingsResponseContent>
Retrieve tenant settings. A list of fields to include or exclude may also be specified.
Parameters
- request: Management.GetTenantSettingsRequestParameters = {}
- OptionalrequestOptions: Settings.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()
```

update

update(
request?: Management.UpdateTenantSettingsRequestContent,
requestOptions?: Settings.RequestOptions,
): HttpResponsePromise<UpdateTenantSettingsResponseContent>
Update settings for a tenant.
Parameters
- request: Management.UpdateTenantSettingsRequestContent = {}
- OptionalrequestOptions: Settings.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()
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Settings.Options