@instructure/athena-api-client 1.0.0

package/dist/esm/apis/ChatsApi.js

@@ -0,0 +1,285 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { ChatFromJSON, ChatRequestToJSON, CreateChatRequestToJSON, PaginatedChatsFromJSON, UpdateChatRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class ChatsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new chat for the authenticated account user.
+     * Create a chat
+     */
+    createChatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createChat().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/chats`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateChatRequestToJSON(requestParameters['createChatRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ChatFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a new chat for the authenticated account user.
+     * Create a chat
+     */
+    createChat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createChatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes a chat and its messages belonging to the authenticated account user.
+     * Delete a chat
+     */
+    deleteChatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteChat().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling deleteChat().');
+            }
+            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/chats/{chatId}`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a chat and its messages belonging to the authenticated account user.
+     * Delete a chat
+     */
+    deleteChat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteChatRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns a single chat belonging to the authenticated account user.
+     * Get a chat
+     */
+    getChatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getChat().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChat().');
+            }
+            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/chats/{chatId}`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ChatFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a single chat belonging to the authenticated account user.
+     * Get a chat
+     */
+    getChat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getChatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns paginated chats belonging to the authenticated account user, ordered by creation date (newest first).
+     * List chats
+     */
+    listChatsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listChats().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            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/chats`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedChatsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns paginated chats belonging to the authenticated account user, ordered by creation date (newest first).
+     * List chats
+     */
+    listChats(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listChatsRaw(requestParameters, initOverrides);
+            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.
+     * Send a message to a chat
+     */
+    sendChatMessageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling sendChatMessage().');
+            }
+            if (requestParameters['chatRequest'] == null) {
+                throw new runtime.RequiredError('chatRequest', 'Required parameter "chatRequest" was null or undefined when calling sendChatMessage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            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`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ChatRequestToJSON(requestParameters['chatRequest']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * 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.
+     * Send a message to a chat
+     */
+    sendChatMessage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.sendChatMessageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates a chat belonging to the authenticated account user.
+     * Update a chat
+     */
+    updateChatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling updateChat().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling updateChat().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/chats/{chatId}`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateChatRequestToJSON(requestParameters['updateChatRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ChatFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates a chat belonging to the authenticated account user.
+     * Update a chat
+     */
+    updateChat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateChatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,28 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { HealthCheck } from '../models/index';
+/**
+ *
+ */
+export declare class HealthApi extends runtime.BaseAPI {
+    /**
+     * Returns the health status of the API server
+     * Health check endpoint
+     */
+    healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HealthCheck>>;
+    /**
+     * Returns the health status of the API server
+     * Health check endpoint
+     */
+    healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HealthCheck>;
+}

package/dist/esm/apis/HealthApi.js

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { HealthCheckFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class HealthApi extends runtime.BaseAPI {
+    /**
+     * Returns the health status of the API server
+     * Health check endpoint
+     */
+    healthCheckRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/health`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => HealthCheckFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the health status of the API server
+     * Health check endpoint
+     */
+    healthCheck(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.healthCheckRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,34 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { PaginatedMessages } from '../models/index';
+export interface GetChatMessagesRequest {
+    xUserId: string;
+    chatId: string;
+    limit?: number;
+    cursor?: string;
+}
+/**
+ *
+ */
+export declare class MessagesApi extends runtime.BaseAPI {
+    /**
+     * Returns paginated messages belonging to the specified chat, ordered by creation date (newest first).
+     * List chat messages
+     */
+    getChatMessagesRaw(requestParameters: GetChatMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedMessages>>;
+    /**
+     * Returns paginated messages belonging to the specified chat, ordered by creation date (newest first).
+     * List chat messages
+     */
+    getChatMessages(requestParameters: GetChatMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedMessages>;
+}

package/dist/esm/apis/MessagesApi.js

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { PaginatedMessagesFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class MessagesApi extends runtime.BaseAPI {
+    /**
+     * Returns paginated messages belonging to the specified chat, ordered by creation date (newest first).
+     * List chat messages
+     */
+    getChatMessagesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getChatMessages().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChatMessages().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            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/chats/{chatId}/messages`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedMessagesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns paginated messages belonging to the specified chat, ordered by creation date (newest first).
+     * List chat messages
+     */
+    getChatMessages(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getChatMessagesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,81 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateTokenRequest, CreateTokenResponse, ServiceToken, UpdateTokenRequest, UpdateTokenResponse } from '../models/index';
+export interface CreateServiceTokenRequest {
+    createTokenRequest: CreateTokenRequest;
+}
+export interface DeleteServiceTokenRequest {
+    id: string;
+}
+export interface GetServiceTokenRequest {
+    id: string;
+}
+export interface UpdateServiceTokenRequest {
+    id: string;
+    updateTokenRequest: UpdateTokenRequest;
+}
+/**
+ *
+ */
+export declare class ServiceTokensApi extends runtime.BaseAPI {
+    /**
+     * Creates a new service token with the specified consumer name, role, and account ID (admin only). The generated token is only shown once.
+     * Create a new service token
+     */
+    createServiceTokenRaw(requestParameters: CreateServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTokenResponse>>;
+    /**
+     * Creates a new service token with the specified consumer name, role, and account ID (admin only). The generated token is only shown once.
+     * Create a new service token
+     */
+    createServiceToken(requestParameters: CreateServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTokenResponse>;
+    /**
+     * Permanently deletes a service token (admin only)
+     * Delete service token
+     */
+    deleteServiceTokenRaw(requestParameters: DeleteServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently deletes a service token (admin only)
+     * Delete service token
+     */
+    deleteServiceToken(requestParameters: DeleteServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves details of a specific service token by its ID (admin only)
+     * Get service token by ID
+     */
+    getServiceTokenRaw(requestParameters: GetServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceToken>>;
+    /**
+     * Retrieves details of a specific service token by its ID (admin only)
+     * Get service token by ID
+     */
+    getServiceToken(requestParameters: GetServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceToken>;
+    /**
+     * Retrieves a list of all service tokens (admin only)
+     * List all service tokens
+     */
+    listServiceTokensRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ServiceToken>>>;
+    /**
+     * Retrieves a list of all service tokens (admin only)
+     * List all service tokens
+     */
+    listServiceTokens(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ServiceToken>>;
+    /**
+     * Updates the active status of a service token (admin only)
+     * Update service token status
+     */
+    updateServiceTokenRaw(requestParameters: UpdateServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateTokenResponse>>;
+    /**
+     * Updates the active status of a service token (admin only)
+     * Update service token status
+     */
+    updateServiceToken(requestParameters: UpdateServiceTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateTokenResponse>;
+}