Class PromptsManager

Hierarchy

BaseAPI
- PromptsManager

Index

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration

Methods

get

get(initOverrides?): Promise<ApiResponse<PromptsSettings>>
Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features. Get prompt settings

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PromptsSettings>>
- Defined in src/management/__generated/managers/prompts-manager.ts:75

getCustomTextByLanguage

getCustomTextByLanguage(requestParameters, initOverrides?): Promise<ApiResponse<{
[key: string]: any;
}>>
Retrieve custom text for a specific prompt and language. Get custom text for a prompt

Throws
Parameters
- requestParameters: GetCustomTextByLanguageRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<{
[key: string]: any;
}>>
- Defined in src/management/__generated/managers/prompts-manager.ts:24

getPartials

getPartials(requestParameters, initOverrides?): Promise<ApiResponse<{
[key: string]: any;
}>>
Get template partials for a prompt - In Early Access Get partials for a prompt

Throws
Parameters
- requestParameters: GetPartialsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<{
[key: string]: any;
}>>
- Defined in src/management/__generated/managers/prompts-manager.ts:49

`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

update

update(bodyParameters, initOverrides?): Promise<ApiResponse<PromptsSettings>>
Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features. Update prompt settings

Throws
Parameters
- bodyParameters: PromptsSettingsUpdate
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PromptsSettings>>
- Defined in src/management/__generated/managers/prompts-manager.ts:93

updateCustomTextByLanguage

updateCustomTextByLanguage(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<void>>
Set custom text for a specific prompt. Existing texts will be overwritten. Set custom text for a specific prompt

Throws
Parameters
- requestParameters: PutCustomTextByLanguageRequest
- bodyParameters: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/prompts-manager.ts:120

updatePartials

updatePartials(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<void>>
Set template partials for a prompt - In Early Access Set partials for a prompt

Throws
Parameters
- requestParameters: PutPartialsRequest
- bodyParameters: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/prompts-manager.ts:152

Class PromptsManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns PromptsManager

Properties

Protected configuration

Methods

get

Throws

Parameters

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PromptsSettings>>

getCustomTextByLanguage

Throws

Parameters

requestParameters: GetCustomTextByLanguageRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<{ [key: string]: any; }>>

getPartials

Throws

Parameters

requestParameters: GetPartialsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<{ [key: string]: any; }>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

update

Throws

Parameters

bodyParameters: PromptsSettingsUpdate

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PromptsSettings>>

updateCustomTextByLanguage

Throws

Parameters

requestParameters: PutCustomTextByLanguageRequest

bodyParameters: { [key: string]: any; }

[key: string]: any

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

updatePartials

Throws

Parameters

requestParameters: PutPartialsRequest

bodyParameters: { [key: string]: any; }

[key: string]: any

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

Returns Promise<ApiResponse<{
[key: string]: any;
}>>

`Optional` initOverrides: InitOverride

Returns Promise<ApiResponse<{
[key: string]: any;
}>>

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: InitOverride

bodyParameters: {
[key: string]: any;
}

`Optional` initOverrides: InitOverride

bodyParameters: {
[key: string]: any;
}

`Optional` initOverrides: InitOverride