@epam/ai-dial-chat-api-client 1.3.0-dev.16 → 1.3.0-dev.160

package/generated/src/apis/ShareApi.js

@@ -90,6 +90,40 @@ class ShareApi extends runtime.BaseAPI {
         const response = await this.createShareLinkRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Withdraws one invitation the caller created, by proxying DIAL Core (DELETE /v1/invitations/{id}). Access already accepted from it stays; only the link stops working. Withdrawing an invitation that is already gone succeeds. Unlike POST /api/v1/share/revoke, which revokes every share of a resource at once.
+     * Withdraw a share invitation
+     */
+    async deleteInvitationRaw(requestParameters, initOverrides) {
+        if (requestParameters['invitationId'] == null) {
+            throw new runtime.RequiredError('invitationId', 'Required parameter "invitationId" was null or undefined when calling deleteInvitation().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token('bearer', []);
+            if (tokenString) {
+                headerParameters['Authorization'] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/share/invitations/{invitationId}`;
+        urlPath = urlPath.replace(`{${'invitationId'}}`, encodeURIComponent(String(requestParameters['invitationId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Withdraws one invitation the caller created, by proxying DIAL Core (DELETE /v1/invitations/{id}). Access already accepted from it stays; only the link stops working. Withdrawing an invitation that is already gone succeeds. Unlike POST /api/v1/share/revoke, which revokes every share of a resource at once.
+     * Withdraw a share invitation
+     */
+    async deleteInvitation(requestParameters, initOverrides) {
+        await this.deleteInvitationRaw(requestParameters, initOverrides);
+    }
     /**
      * Discards the authenticated user\'s own access to a shared catalog entity (application or toolset), a skill, a conversation, or a prompt, via DIAL Core\'s discardSharedResources operation. Only affects the caller\'s own access — removing access for everyone else is a separate operation.
      * Discard a shared catalog resource, conversation, or prompt

package/generated/src/models/index.d.ts

@@ -1,3 +1,40 @@
+/**
+ *
+ * @export
+ * @interface AcceptInvitationErrorDto
+ */
+export interface AcceptInvitationErrorDto {
+    /**
+     *
+     * @type {number}
+     * @memberof AcceptInvitationErrorDto
+     */
+    statusCode: number;
+    /**
+     *
+     * @type {string}
+     * @memberof AcceptInvitationErrorDto
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AcceptInvitationErrorDto
+     */
+    message: string;
+    /**
+     * Why DIAL Core refused the invitation. `shareInvitationNotFound`: the link expired, was revoked, or never existed. `shareInvitationAcceptedUsersLimitReached`: the shared resource has already been accepted by its maximum number of users.
+     * @type {ShareInvitationErrorCode}
+     * @memberof AcceptInvitationErrorDto
+     */
+    code?: ShareInvitationErrorCode;
+    /**
+     * Title of the shared conversation, present with `shareInvitationAcceptedUsersLimitReached` when the invitation shares a conversation.
+     * @type {string}
+     * @memberof AcceptInvitationErrorDto
+     */
+    itemName?: string;
+}
 /**
  *
  * @export
@@ -1153,6 +1190,18 @@ export interface ClientConfigDto {
      * @memberof ClientConfigDto
      */
     maxAttachmentFileSizeBytes: number;
+    /**
+     * Percentage (1–99) of a capped day/week/month usage limit at which the composer shows its usage banner. Sourced from USAGE_LIMITS_WARNING_THRESHOLD_PERCENT; governs the banner only, not the usage dial.
+     * @type {number}
+     * @memberof ClientConfigDto
+     */
+    usageLimitsWarningThresholdPercent: number;
+    /**
+     * Operator default for the seasonal-celebrations switch, applied to users who have not saved a choice of their own; a saved choice overrides it. Sourced from UI_EVENT_ENABLED_BY_DEFAULT; true unless it is false, 0 or no. Has no visible effect while activeEventId is null.
+     * @type {boolean}
+     * @memberof ClientConfigDto
+     */
+    celebrationsEnabledByDefault: boolean;
 }
 /**
  * @export
@@ -1212,6 +1261,43 @@ export interface ClientConfigResponseDto {
      */
     metadata?: ClientConfigMetadataDto;
 }
+/**
+ *
+ * @export
+ * @interface ConversationAttachmentMissingErrorDto
+ */
+export interface ConversationAttachmentMissingErrorDto {
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationAttachmentMissingErrorDto
+     */
+    statusCode: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationAttachmentMissingErrorDto
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationAttachmentMissingErrorDto
+     */
+    message: string;
+    /**
+     *
+     * @type {ConversationErrorCode}
+     * @memberof ConversationAttachmentMissingErrorDto
+     */
+    code: ConversationErrorCode;
+    /**
+     * Urls of the attachment files that no longer exist
+     * @type {Array<string>}
+     * @memberof ConversationAttachmentMissingErrorDto
+     */
+    missingFiles: Array<string>;
+}
 /**
  *
  * @export
@@ -1273,11 +1359,13 @@ export interface ConversationDeletionResultDto {
     failed: Array<ConversationDeletionFailureDto>;
 }
 /**
- * Present when the duplicate was refused by a chat-api rule rather than by DIAL Core. `conversationDuplicateModelHidden`: the conversation's current model is hidden through `HIDDEN_ENTITY_TAGS`.
+ * Present when the request was refused by a chat-api rule rather than by DIAL Core. `conversationDuplicateModelHidden`: the conversation's current model is hidden through `HIDDEN_ENTITY_TAGS`, so it cannot be duplicated. `conversationModelHidden`: the model a completion, share or publish would use is hidden through `HIDDEN_ENTITY_TAGS`.
  * @export
  */
 export declare const ConversationErrorCode: {
     readonly ConversationDuplicateModelHidden: "conversationDuplicateModelHidden";
+    readonly ConversationModelHidden: "conversationModelHidden";
+    readonly ConversationAttachmentMissing: "conversationAttachmentMissing";
 };
 export type ConversationErrorCode = (typeof ConversationErrorCode)[keyof typeof ConversationErrorCode];
 /**
@@ -1335,7 +1423,7 @@ export interface ConversationListItemDto {
      */
     isReadonly: boolean;
     /**
-     * True when this conversation was created by a DIAL Scheduler run (its resource path matches the `.scheduler/{scheduleId}/{filename}` reserved segment, with `{filename}` shaped `{deploymentId}__{title}__{runId}`).
+     * True when this conversation is a DIAL Scheduler run in the caller's own bucket (its resource path matches the `.scheduler/{scheduleId}/{filename}` reserved segment, with `{filename}` shaped `{deploymentId}__{title}__{runId}`). Always false for published and shared conversations, even when their path has that shape.
      * @type {boolean}
      * @memberof ConversationListItemDto
      */
@@ -1614,6 +1702,37 @@ export interface ConversationModelDto {
      */
     id: string;
 }
+/**
+ *
+ * @export
+ * @interface ConversationModelHiddenErrorDto
+ */
+export interface ConversationModelHiddenErrorDto {
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationModelHiddenErrorDto
+     */
+    statusCode: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationModelHiddenErrorDto
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationModelHiddenErrorDto
+     */
+    message: string;
+    /**
+     * Present when the request was refused by a chat-api rule rather than by DIAL Core. `conversationDuplicateModelHidden`: the conversation's current model is hidden through `HIDDEN_ENTITY_TAGS`, so it cannot be duplicated. `conversationModelHidden`: the model a completion, share or publish would use is hidden through `HIDDEN_ENTITY_TAGS`.
+     * @type {ConversationErrorCode}
+     * @memberof ConversationModelHiddenErrorDto
+     */
+    code?: ConversationErrorCode;
+}
 /**
  *
  * @export
@@ -1941,7 +2060,7 @@ export interface CreateApplicationBodyDto {
      */
     applicationProperties?: object;
     /**
-     * Reject with 409 if the name/version already exists; checked atomically by DIAL Core.
+     * Never overwrite an existing application: when the name/version path is taken, create at the next free path (name-2, name-3, ...), checked atomically by DIAL Core; 409 only when every candidate is taken.
      * @type {boolean}
      * @memberof CreateApplicationBodyDto
      */
@@ -1952,6 +2071,12 @@ export interface CreateApplicationBodyDto {
      * @memberof CreateApplicationBodyDto
      */
     preserveApplicationProperties?: boolean;
+    /**
+     * Top-level DIAL Core application features, stored as supplied. Takes precedence over features hoisted from applicationProperties and turns off the Quick App system_prompt_supported default.
+     * @type {object}
+     * @memberof CreateApplicationBodyDto
+     */
+    features?: object;
     /**
      *
      * @type {Array<string>}
@@ -2913,6 +3038,12 @@ export interface DeploymentItemDto {
      * @memberof DeploymentItemDto
      */
     applicationTypeSchemaId?: string;
+    /**
+     * Custom Viewer URL from DIAL Core viewer_url (present only for application deployments that configure one)
+     * @type {string}
+     * @memberof DeploymentItemDto
+     */
+    viewerUrl?: string;
     /**
      * Accepted MIME types for input attachments from DIAL Core (e.g. ["audio/*", "image/*"])
      * @type {Array<string>}
@@ -4076,7 +4207,7 @@ export interface DuplicateConversationErrorDto {
      */
     message: string;
     /**
-     * Present when the duplicate was refused by a chat-api rule rather than by DIAL Core. `conversationDuplicateModelHidden`: the conversation's current model is hidden through `HIDDEN_ENTITY_TAGS`.
+     * Present when the request was refused by a chat-api rule rather than by DIAL Core. `conversationDuplicateModelHidden`: the conversation's current model is hidden through `HIDDEN_ENTITY_TAGS`, so it cannot be duplicated. `conversationModelHidden`: the model a completion, share or publish would use is hidden through `HIDDEN_ENTITY_TAGS`.
      * @type {ConversationErrorCode}
      * @memberof DuplicateConversationErrorDto
      */
@@ -4108,6 +4239,88 @@ export interface ExternalServiceAuthResultDto {
      */
     success: boolean;
 }
+/**
+ *
+ * @export
+ * @interface ExternalServiceAuthSettingsBodyDto
+ */
+export interface ExternalServiceAuthSettingsBodyDto {
+    /**
+     *
+     * @type {string}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    authenticationType: ExternalServiceAuthSettingsBodyDtoAuthenticationTypeEnum;
+    /**
+     * API_KEY: the header the stored key is sent under. The key itself is never part of the definition.
+     * @type {string}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    apiKeyHeader?: string;
+    /**
+     * OAUTH: the client id.
+     * @type {string}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    clientId?: string;
+    /**
+     * OAUTH: the client secret. Write-only: never returned, never logged.
+     * @type {string}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    clientSecret?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    authorizationEndpoint?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    tokenEndpoint?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ExternalServiceAuthSettingsBodyDto
+     */
+    scopesSupported?: Array<string>;
+}
+/**
+ * @export
+ */
+export declare const ExternalServiceAuthSettingsBodyDtoAuthenticationTypeEnum: {
+    readonly ApiKey: "API_KEY";
+    readonly Oauth: "OAUTH";
+};
+export type ExternalServiceAuthSettingsBodyDtoAuthenticationTypeEnum = (typeof ExternalServiceAuthSettingsBodyDtoAuthenticationTypeEnum)[keyof typeof ExternalServiceAuthSettingsBodyDtoAuthenticationTypeEnum];
+/**
+ *
+ * @export
+ * @interface ExternalServiceDefinitionBodyDto
+ */
+export interface ExternalServiceDefinitionBodyDto {
+    /**
+     *
+     * @type {string}
+     * @memberof ExternalServiceDefinitionBodyDto
+     */
+    displayName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExternalServiceDefinitionBodyDto
+     */
+    description?: string;
+    /**
+     *
+     * @type {ExternalServiceAuthSettingsBodyDto}
+     * @memberof ExternalServiceDefinitionBodyDto
+     */
+    authSettings: ExternalServiceAuthSettingsBodyDto;
+}
 /**
  *
  * @export
@@ -5797,7 +6010,7 @@ export interface RefineTextRequestDto {
      */
     purpose: TextRefinementPurpose;
     /**
-     * Exact nonblank draft. Unicode code point limits: skill Description 4000, task Description 500, application/toolset/prompt Description 2000, either Instructions 32000.
+     * Exact nonblank draft. Unicode code point limits: skill Description 4000, task Description 500, application/toolset/prompt Description 2000, skill/task/prompt Instructions 32000.
      * @type {string}
      * @memberof RefineTextRequestDto
      */
@@ -6297,6 +6510,12 @@ export interface ScheduledTaskRunDto {
      * @memberof ScheduledTaskRunDto
      */
     resultStage?: string;
+    /**
+     * Failure details reported by DIAL Scheduler (result.error_text) for a failed run. Only a non-blank string is exposed; the rest of the upstream result is not.
+     * @type {string}
+     * @memberof ScheduledTaskRunDto
+     */
+    errorText?: string;
 }
 /**
  * @export
@@ -6428,6 +6647,15 @@ export declare const SendCompletionDtoModeEnum: {
     readonly Edit: "edit";
 };
 export type SendCompletionDtoModeEnum = (typeof SendCompletionDtoModeEnum)[keyof typeof SendCompletionDtoModeEnum];
+/**
+ * Why DIAL Core refused the invitation. `shareInvitationNotFound`: the link expired, was revoked, or never existed. `shareInvitationAcceptedUsersLimitReached`: the shared resource has already been accepted by its maximum number of users.
+ * @export
+ */
+export declare const ShareInvitationErrorCode: {
+    readonly ShareInvitationNotFound: "shareInvitationNotFound";
+    readonly ShareInvitationAcceptedUsersLimitReached: "shareInvitationAcceptedUsersLimitReached";
+};
+export type ShareInvitationErrorCode = (typeof ShareInvitationErrorCode)[keyof typeof ShareInvitationErrorCode];
 /**
  *
  * @export
@@ -6446,6 +6674,12 @@ export interface ShareLinkResponseDto {
      * @memberof ShareLinkResponseDto
      */
     expiresInDays?: number;
+    /**
+     * Hours until the DIAL Core invitation expires, rounded up. Lets a client describe a TTL shorter than a day, which `expiresInDays` rounds up to 1. Omitted together with `expiresInDays`.
+     * @type {number}
+     * @memberof ShareLinkResponseDto
+     */
+    expiresInHours?: number;
     /**
      * Access levels granted to holders of the share link. Edit access implies view access, so this is `[View, Edit]` rather than `[Edit]` alone.
      * @type {Array<string>}
@@ -6900,6 +7134,7 @@ export declare const TextRefinementPurpose: {
     readonly ApplicationDescription: "application-description";
     readonly ToolsetDescription: "toolset-description";
     readonly PromptDescription: "prompt-description";
+    readonly PromptInstructions: "prompt-instructions";
 };
 export type TextRefinementPurpose = (typeof TextRefinementPurpose)[keyof typeof TextRefinementPurpose];
 /**
@@ -7507,6 +7742,19 @@ export interface TranscribeAudioDto {
      */
     mimeType: string;
 }
+/**
+ *
+ * @export
+ * @interface UnpublishAccessDto
+ */
+export interface UnpublishAccessDto {
+    /**
+     * Whether the caller may request removal of this entity: true for an administrator or the publisher of the copy
+     * @type {boolean}
+     * @memberof UnpublishAccessDto
+     */
+    canUnpublish: boolean;
+}
 /**
  *
  * @export