Class CustomTextClient

Index

Constructors

Methods

Properties

Constructors

constructor

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

Methods

get

get(
    prompt: Management.PromptGroupNameEnum,
    language: Management.PromptLanguageEnum,
    requestOptions?: CustomTextClient.RequestOptions,
): HttpResponsePromise<GetCustomTextsByLanguageResponseContent>
Retrieve custom text for a specific prompt and language.
Parameters
- prompt: Management.PromptGroupNameEnum
  Name of the prompt.
- language: Management.PromptLanguageEnum
  Language to update.
- OptionalrequestOptions: CustomTextClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetCustomTextsByLanguageResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.prompts.customText.get("login", "am")
```

set

set(
    prompt: Management.PromptGroupNameEnum,
    language: Management.PromptLanguageEnum,
    request: SetsCustomTextsByLanguageRequestContent,
    requestOptions?: CustomTextClient.RequestOptions,
): HttpResponsePromise<void>
Set custom text for a specific prompt. Existing texts will be overwritten.
Parameters
- prompt: Management.PromptGroupNameEnum
  Name of the prompt.
- language: Management.PromptLanguageEnum
  Language to update.
- request: SetsCustomTextsByLanguageRequestContent
- OptionalrequestOptions: CustomTextClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.prompts.customText.set("login", "am", {
        "key": "value"
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>