@instructure/athena-api-client 2.3.4 → 2.4.0

package/README.md

@@ -73,6 +73,7 @@ All URIs are relative to *http://localhost:3000*
 *ChatsApi* | [**getChat**](docs/ChatsApi.md#getchat) | **GET** /api/v1/chats/{chatId} | Get a chat
 *ChatsApi* | [**listChats**](docs/ChatsApi.md#listchats) | **GET** /api/v1/chats | List chats
 *ChatsApi* | [**markChatAsViewed**](docs/ChatsApi.md#markchatasviewed) | **PATCH** /api/v1/chats/{chatId}/viewed | Mark chat as viewed
+*ChatsApi* | [**resumeChatStream**](docs/ChatsApi.md#resumechatstream) | **GET** /api/v1/chat/{chatId}/stream | Resume a chat stream
 *ChatsApi* | [**sendChatMessage**](docs/ChatsApi.md#sendchatmessage) | **POST** /api/v1/chat | Send a message to a chat
 *ChatsApi* | [**updateChat**](docs/ChatsApi.md#updatechatoperation) | **PATCH** /api/v1/chats/{chatId} | Update a chat
 *DailyQuizApi* | [**createDailyQuiz**](docs/DailyQuizApi.md#createdailyquiz) | **POST** /api/v1/daily-quiz | Get or create today\'s daily quiz

package/dist/apis/ChatsApi.d.ts

@@ -33,6 +33,10 @@ export interface MarkChatAsViewedRequest {
     chatId: string;
     xUserId: string;
 }
+export interface ResumeChatStreamRequest {
+    chatId: string;
+    xUserId: string;
+}
 export interface SendChatMessageRequest {
     xUserId: string;
     chatRequest: ChatRequest;
@@ -99,6 +103,16 @@ export declare class ChatsApi extends runtime.BaseAPI {
      * Mark chat as viewed
      */
     markChatAsViewed(requestParameters: MarkChatAsViewedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStreamRaw(requestParameters: ResumeChatStreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStream(requestParameters: ResumeChatStreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string | null | undefined>;
     /**
      * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat

package/dist/apis/ChatsApi.js

@@ -239,6 +239,59 @@ class ChatsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStreamRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling resumeChatStream().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling resumeChatStream().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/chat/{chatId}/stream`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStream(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.resumeChatStreamRaw(requestParameters, initOverrides);
+            switch (response.raw.status) {
+                case 200:
+                    return yield response.value();
+                case 204:
+                    return null;
+                default:
+                    return yield response.value();
+            }
+        });
+    }
     /**
      * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat

package/dist/esm/apis/ChatsApi.d.ts

@@ -33,6 +33,10 @@ export interface MarkChatAsViewedRequest {
     chatId: string;
     xUserId: string;
 }
+export interface ResumeChatStreamRequest {
+    chatId: string;
+    xUserId: string;
+}
 export interface SendChatMessageRequest {
     xUserId: string;
     chatRequest: ChatRequest;
@@ -99,6 +103,16 @@ export declare class ChatsApi extends runtime.BaseAPI {
      * Mark chat as viewed
      */
     markChatAsViewed(requestParameters: MarkChatAsViewedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStreamRaw(requestParameters: ResumeChatStreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStream(requestParameters: ResumeChatStreamRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string | null | undefined>;
     /**
      * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat

package/dist/esm/apis/ChatsApi.js

@@ -236,6 +236,59 @@ export class ChatsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStreamRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling resumeChatStream().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling resumeChatStream().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/chat/{chatId}/stream`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Reconnects to an active or recently completed chat stream. Returns 200 with an SSE body if a stream is available, or 204 No Content if no stream exists.
+     * Resume a chat stream
+     */
+    resumeChatStream(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.resumeChatStreamRaw(requestParameters, initOverrides);
+            switch (response.raw.status) {
+                case 200:
+                    return yield response.value();
+                case 204:
+                    return null;
+                default:
+                    return yield response.value();
+            }
+        });
+    }
     /**
      * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "2.3.4",
+  "version": "2.4.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {