Class RenderingClient

Index

Constructors

constructor

new RenderingClient(options: BaseClientOptions): RenderingClient
Parameters
- options: BaseClientOptions
Returns RenderingClient

Methods

list

list(
    request?: ListAculsRequestParameters,
    requestOptions?: RenderingClient.RequestOptions,
): Promise<
    Page<AculResponseContent, ListAculsOffsetPaginatedResponseContent>,
>
Get render setting configurations for all screens.
Parameters
- request: ListAculsRequestParameters = {}
- OptionalrequestOptions: RenderingClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<AculResponseContent, 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"
    })
```

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"
            }]
    })
```

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")
```

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")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class RenderingClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns RenderingClient

Methods

list

Parameters

Returns Promise<Page<AculResponseContent, ListAculsOffsetPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Throws

Example

bulkUpdate

Parameters

Returns HttpResponsePromise<BulkUpdateAculResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetAculResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateAculResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options