Class TenantsManager

Hierarchy

BaseAPI
- TenantsManager

Index

Constructors

Properties

Methods

getSettings request updateSettings

Constructors

constructor

new TenantsManager(configuration): TenantsManager
Parameters
- configuration: Configuration
Returns TenantsManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

getSettings

getSettings(requestParameters?, initOverrides?): Promise<ApiResponse<TenantSettings>>
Retrieve tenant settings. A list of fields to include or exclude may also be specified. Get tenant settings

Throws
Parameters
- requestParameters: TenantSettingsRouteRequest = {}
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<TenantSettings>>
- Defined in src/management/__generated/managers/tenants-manager.ts:48

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

updateSettings

updateSettings(bodyParameters, initOverrides?): Promise<ApiResponse<TenantSettings>>
Update settings for a tenant. Update tenant settings

Throws
Parameters
- bodyParameters: TenantSettingsUpdate
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<TenantSettings>>
- Defined in src/management/__generated/managers/tenants-manager.ts:21