• management
• SDK
• RenderingClient

Class RenderingClient

Index

Constructors

constructor

Methods

listbulkUpdategetupdate

Properties

_options

Constructors

constructor

new RenderingClient(options: BaseClientOptions): RenderingClient

Parameters

• options: BaseClientOptions

Returns RenderingClient

Methods

list

list(
request?: ListAculsRequestParameters,
requestOptions?: RenderingClient.RequestOptions,
): Promise<
Page<
ListAculsResponseContentItem,
ListAculsOffsetPaginatedResponseContent,
>,
>

Get render setting configurations for all screens.

Parameters

• request: ListAculsRequestParameters = {}
• OptionalrequestOptions: RenderingClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< ListAculsResponseContentItem, ListAculsOffsetPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.prompts.rendering.list({ fields: "fields", include_fields: true, page: 1, per_page: 1, include_totals: true, prompt: "prompt", screen: "screen", rendering_mode: "advanced" })Copy

bulkUpdate

bulkUpdate(
request: BulkUpdateAculRequestContent,
requestOptions?: RenderingClient.RequestOptions,
): HttpResponsePromise<BulkUpdateAculResponseContent>

Learn more about configuring render settings for advanced customization.

Parameters

• request: BulkUpdateAculRequestContent
• OptionalrequestOptions: RenderingClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<BulkUpdateAculResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.prompts.rendering.bulkUpdate({ configs: [{ prompt: "login", screen: "login" }] })Copy

get

get(
prompt: Management.PromptGroupNameEnum,
screen: Management.ScreenGroupNameEnum,
requestOptions?: RenderingClient.RequestOptions,
): HttpResponsePromise<GetAculResponseContent>

Get render settings for a screen.

Parameters

• prompt: Management.PromptGroupNameEnum

Name of the prompt

• screen: Management.ScreenGroupNameEnum

Name of the screen

• OptionalrequestOptions: RenderingClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetAculResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.prompts.rendering.get("login", "login")Copy

update

update(
prompt: Management.PromptGroupNameEnum,
screen: Management.ScreenGroupNameEnum,
request?: UpdateAculRequestContent,
requestOptions?: RenderingClient.RequestOptions,
): HttpResponsePromise<UpdateAculResponseContent>

Learn more about configuring render settings for advanced customization.

Parameters

• prompt: Management.PromptGroupNameEnum

Name of the prompt

• screen: Management.ScreenGroupNameEnum

Name of the screen

• request: UpdateAculRequestContent = {}
• OptionalrequestOptions: RenderingClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateAculResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.PaymentRequiredError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.prompts.rendering.update("login", "login")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listbulkUpdategetupdate Properties _options