@webzaytsev/support-sdk 0.1.1 → 0.1.3

package/dist/types.gen-Bkafu1bx.d.ts

@@ -0,0 +1,356 @@
+type ClientOptions = {
+    baseUrl: string;
+};
+type WebProfileDto = {
+    /**
+     * Display name (≤120 chars)
+     */
+    name: string;
+    /**
+     * User email
+     */
+    email?: string;
+    /**
+     * URL to user profile in admin panel
+     */
+    profileUrl?: string;
+    /**
+     * Key-value pairs (≤32 keys, key ≤64, value ≤512). Read by plugins (e.g. Remnawave reads userId).
+     */
+    extra?: {
+        [key: string]: string;
+    };
+};
+type IssueTokenDto = {
+    /**
+     * External user ID from your backend database
+     */
+    userId: string;
+    /**
+     * User profile snapshot passed from your backend
+     */
+    userProfile: WebProfileDto;
+    /**
+     * JWT TTL in seconds (max 3600, default 900)
+     */
+    ttlSec?: number;
+};
+type IssueTokenResponseDto = {
+    /**
+     * Short-lived JWT for widget authentication
+     */
+    token: string;
+    /**
+     * ISO timestamp when the token expires
+     */
+    expiresAt: string;
+};
+type WebSseEventDataDto = {
+    /**
+     * Message ID (for 'message' events)
+     */
+    messageId?: number;
+    /**
+     * Message text
+     */
+    text?: string;
+    /**
+     * Attachment upload IDs
+     */
+    attachmentIds?: Array<string>;
+    /**
+     * Message ID that triggered escalation ('escalation_ack' event)
+     */
+    escalatableMessageId?: number;
+    /**
+     * Escalation source
+     */
+    source?: string;
+    /**
+     * ISO timestamp of the event
+     */
+    createdAt?: string;
+    /**
+     * Human-readable message for system events
+     */
+    message?: string;
+};
+type WebSseEventDto = {
+    /**
+     * Event type
+     */
+    type: 'message' | 'resolved' | 'closed' | 'escalation_ack' | 'reopened' | 'heartbeat';
+    /**
+     * Ticket ID this event belongs to
+     */
+    ticketId: number;
+    /**
+     * Event payload (absent for heartbeat)
+     */
+    data?: WebSseEventDataDto;
+};
+type SendMessageDto = {
+    /**
+     * Message text
+     */
+    text: string;
+    /**
+     * Upload IDs returned by POST /web/uploads
+     */
+    attachmentIds?: Array<string>;
+};
+type SendMessageResponseDto = {
+    /**
+     * Ticket ID (created or existing)
+     */
+    ticketId: number;
+    /**
+     * ID of the recorded message
+     */
+    messageId: number;
+    /**
+     * ISO timestamp when the message was created
+     */
+    createdAt: string;
+};
+type TicketInfoDto = {
+    /**
+     * Ticket ID
+     */
+    id: number;
+    /**
+     * Ticket status
+     */
+    status: 'open' | 'closed';
+    /**
+     * ISO timestamp when ticket was created
+     */
+    createdAt: string;
+    /**
+     * ISO timestamp of last update
+     */
+    updatedAt: string;
+};
+type MessageDto = {
+    /**
+     * Message ID
+     */
+    id: number;
+    /**
+     * Message author role
+     */
+    role: 'user' | 'moderator' | 'bot' | 'system';
+    /**
+     * Text content of the message
+     */
+    content: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Upload IDs of attached images
+     */
+    webAttachmentIds: Array<string> | null;
+    /**
+     * ISO timestamp when the message was created
+     */
+    createdAt: string;
+};
+type CurrentTicketResponseDto = {
+    /**
+     * Current open ticket, null if none
+     */
+    ticket: TicketInfoDto | null;
+    /**
+     * Messages in chronological order (oldest first, max 50)
+     */
+    messages: Array<MessageDto>;
+};
+type MessagesResponseDto = {
+    /**
+     * Messages in chronological order (oldest first)
+     */
+    messages: Array<MessageDto>;
+    /**
+     * Pass as ?since= in the next poll request. Null when no messages returned.
+     */
+    nextCursor: {
+        [key: string]: unknown;
+    } | null;
+};
+type UploadResponseDto = {
+    /**
+     * Upload ID to use in attachmentIds when sending a message
+     */
+    uploadId: string;
+    /**
+     * MIME type of the uploaded file
+     */
+    mimeType: string;
+    /**
+     * File size in bytes
+     */
+    sizeBytes: number;
+};
+type WebAuthControllerIssueTokenData = {
+    body: IssueTokenDto;
+    path?: never;
+    query?: never;
+    url: '/web/auth/token';
+};
+type WebAuthControllerIssueTokenResponses = {
+    /**
+     * Short-lived JWT issued
+     */
+    200: IssueTokenResponseDto;
+};
+type WebAuthControllerIssueTokenResponse = WebAuthControllerIssueTokenResponses[keyof WebAuthControllerIssueTokenResponses];
+type WebTicketsControllerSendMessageData = {
+    body: SendMessageDto;
+    path?: never;
+    query?: never;
+    url: '/web/messages';
+};
+type WebTicketsControllerSendMessageResponses = {
+    /**
+     * Message recorded
+     */
+    200: SendMessageResponseDto;
+};
+type WebTicketsControllerSendMessageResponse = WebTicketsControllerSendMessageResponses[keyof WebTicketsControllerSendMessageResponses];
+type WebTicketsControllerGetCurrentTicketData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/web/tickets/current';
+};
+type WebTicketsControllerGetCurrentTicketResponses = {
+    /**
+     * Current ticket state
+     */
+    200: CurrentTicketResponseDto;
+};
+type WebTicketsControllerGetCurrentTicketResponse = WebTicketsControllerGetCurrentTicketResponses[keyof WebTicketsControllerGetCurrentTicketResponses];
+type WebTicketsControllerGetMessagesData = {
+    body?: never;
+    path: {
+        /**
+         * Ticket ID
+         */
+        id: number;
+    };
+    query?: {
+        /**
+         * ISO timestamp cursor from previous response nextCursor
+         */
+        since?: string;
+        /**
+         * Max messages to return (1–100, default 50)
+         */
+        limit?: string;
+    };
+    url: '/web/tickets/{id}/messages';
+};
+type WebTicketsControllerGetMessagesResponses = {
+    /**
+     * Messages since cursor
+     */
+    200: MessagesResponseDto;
+};
+type WebTicketsControllerGetMessagesResponse = WebTicketsControllerGetMessagesResponses[keyof WebTicketsControllerGetMessagesResponses];
+type WebTicketsControllerSseStreamData = {
+    body?: never;
+    path: {
+        /**
+         * Ticket ID
+         */
+        id: number;
+    };
+    query?: {
+        /**
+         * JWT token (alternative to Authorization header, required for native EventSource)
+         */
+        access_token?: unknown;
+    };
+    url: '/web/tickets/{id}/stream';
+};
+type WebTicketsControllerSseStreamResponses = {
+    /**
+     * Server-Sent Events stream
+     */
+    200: WebSseEventDto;
+};
+type WebTicketsControllerSseStreamResponse = WebTicketsControllerSseStreamResponses[keyof WebTicketsControllerSseStreamResponses];
+type WebTicketsControllerEscalateData = {
+    body?: never;
+    path: {
+        /**
+         * Ticket ID
+         */
+        id: number;
+    };
+    query?: never;
+    url: '/web/tickets/{id}/escalate';
+};
+type WebTicketsControllerEscalateResponses = {
+    /**
+     * Escalation request submitted
+     */
+    204: void;
+};
+type WebTicketsControllerEscalateResponse = WebTicketsControllerEscalateResponses[keyof WebTicketsControllerEscalateResponses];
+type WebTicketsControllerResolveByUserData = {
+    body?: never;
+    path: {
+        /**
+         * Ticket ID
+         */
+        id: number;
+    };
+    query?: never;
+    url: '/web/tickets/{id}/resolve';
+};
+type WebTicketsControllerResolveByUserResponses = {
+    /**
+     * Ticket resolved
+     */
+    204: void;
+};
+type WebTicketsControllerResolveByUserResponse = WebTicketsControllerResolveByUserResponses[keyof WebTicketsControllerResolveByUserResponses];
+type WebUploadsControllerUploadData = {
+    body: {
+        /**
+         * Image file (jpeg/png/webp, max 10 MB)
+         */
+        file: Blob | File;
+    };
+    path?: never;
+    query?: never;
+    url: '/web/uploads';
+};
+type WebUploadsControllerUploadResponses = {
+    /**
+     * File uploaded successfully
+     */
+    200: UploadResponseDto;
+};
+type WebUploadsControllerUploadResponse = WebUploadsControllerUploadResponses[keyof WebUploadsControllerUploadResponses];
+type WebUploadsControllerGetUploadData = {
+    body?: never;
+    path: {
+        /**
+         * Upload ID returned by POST /web/uploads
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/web/uploads/{id}';
+};
+type WebUploadsControllerGetUploadResponses = {
+    /**
+     * Image file stream
+     */
+    200: Blob | File;
+};
+type WebUploadsControllerGetUploadResponse = WebUploadsControllerGetUploadResponses[keyof WebUploadsControllerGetUploadResponses];
+
+export type { WebTicketsControllerSseStreamResponses as A, WebUploadsControllerGetUploadData as B, ClientOptions as C, WebUploadsControllerGetUploadResponse as D, WebUploadsControllerGetUploadResponses as E, WebUploadsControllerUploadData as F, WebUploadsControllerUploadResponse as G, WebUploadsControllerUploadResponses as H, IssueTokenDto as I, MessageDto as M, SendMessageDto as S, TicketInfoDto as T, UploadResponseDto as U, WebAuthControllerIssueTokenData as W, CurrentTicketResponseDto as a, IssueTokenResponseDto as b, MessagesResponseDto as c, SendMessageResponseDto as d, WebAuthControllerIssueTokenResponse as e, WebAuthControllerIssueTokenResponses as f, WebProfileDto as g, WebSseEventDataDto as h, WebSseEventDto as i, WebTicketsControllerEscalateData as j, WebTicketsControllerEscalateResponse as k, WebTicketsControllerEscalateResponses as l, WebTicketsControllerGetCurrentTicketData as m, WebTicketsControllerGetCurrentTicketResponse as n, WebTicketsControllerGetCurrentTicketResponses as o, WebTicketsControllerGetMessagesData as p, WebTicketsControllerGetMessagesResponse as q, WebTicketsControllerGetMessagesResponses as r, WebTicketsControllerResolveByUserData as s, WebTicketsControllerResolveByUserResponse as t, WebTicketsControllerResolveByUserResponses as u, WebTicketsControllerSendMessageData as v, WebTicketsControllerSendMessageResponse as w, WebTicketsControllerSendMessageResponses as x, WebTicketsControllerSseStreamData as y, WebTicketsControllerSseStreamResponse as z };