@instructure/athena-api-client 1.0.0

package/dist/apis/ServiceTokensApi.js

@@ -0,0 +1,209 @@
+"use strict";
+/* 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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceTokensApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createTokenRequest'] == null) {
+                throw new runtime.RequiredError('createTokenRequest', 'Required parameter "createTokenRequest" was null or undefined when calling createServiceToken().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/tokens`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateTokenRequestToJSON)(requestParameters['createTokenRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateTokenResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createServiceTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Permanently deletes a service token (admin only)
+     * Delete service token
+     */
+    deleteServiceTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteServiceToken().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/tokens/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Permanently deletes a service token (admin only)
+     * Delete service token
+     */
+    deleteServiceToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteServiceTokenRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Retrieves details of a specific service token by its ID (admin only)
+     * Get service token by ID
+     */
+    getServiceTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getServiceToken().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/tokens/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ServiceTokenFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Retrieves details of a specific service token by its ID (admin only)
+     * Get service token by ID
+     */
+    getServiceToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getServiceTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a list of all service tokens (admin only)
+     * List all service tokens
+     */
+    listServiceTokensRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/tokens`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ServiceTokenFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of all service tokens (admin only)
+     * List all service tokens
+     */
+    listServiceTokens(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listServiceTokensRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates the active status of a service token (admin only)
+     * Update service token status
+     */
+    updateServiceTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateServiceToken().');
+            }
+            if (requestParameters['updateTokenRequest'] == null) {
+                throw new runtime.RequiredError('updateTokenRequest', 'Required parameter "updateTokenRequest" was null or undefined when calling updateServiceToken().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/tokens/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateTokenRequestToJSON)(requestParameters['updateTokenRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateTokenResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Updates the active status of a service token (admin only)
+     * Update service token status
+     */
+    updateServiceToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateServiceTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.ServiceTokensApi = ServiceTokensApi;

package/dist/apis/TagsApi.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 { Tag } from '../models/index';
+/**
+ *
+ */
+export declare class TagsApi extends runtime.BaseAPI {
+    /**
+     * Retrieves a list of all available tags
+     * List all tags
+     */
+    listTagsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Tag>>>;
+    /**
+     * Retrieves a list of all available tags
+     * List all tags
+     */
+    listTags(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Tag>>;
+}

package/dist/apis/TagsApi.js

@@ -0,0 +1,61 @@
+"use strict";
+/* 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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class TagsApi extends runtime.BaseAPI {
+    /**
+     * Retrieves a list of all available tags
+     * List all tags
+     */
+    listTagsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/api/v1/tags`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.TagFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of all available tags
+     * List all tags
+     */
+    listTags(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listTagsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.TagsApi = TagsApi;

package/dist/apis/index.d.ts

@@ -0,0 +1,6 @@
+export * from './AccountsApi';
+export * from './ChatsApi';
+export * from './HealthApi';
+export * from './MessagesApi';
+export * from './ServiceTokensApi';
+export * from './TagsApi';

package/dist/apis/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AccountsApi"), exports);
+__exportStar(require("./ChatsApi"), exports);
+__exportStar(require("./HealthApi"), exports);
+__exportStar(require("./MessagesApi"), exports);
+__exportStar(require("./ServiceTokensApi"), exports);
+__exportStar(require("./TagsApi"), exports);

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

@@ -0,0 +1,41 @@
+/**
+ * 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 { Account, CreateAccountRequest } from '../models/index';
+export interface CreateAccountOperationRequest {
+    createAccountRequest: CreateAccountRequest;
+}
+/**
+ *
+ */
+export declare class AccountsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new account (admin only)
+     * Create a new account
+     */
+    createAccountRaw(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Account>>;
+    /**
+     * Creates a new account (admin only)
+     * Create a new account
+     */
+    createAccount(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Account>;
+    /**
+     * Retrieves a list of all accounts (admin only)
+     * List all accounts
+     */
+    listAccountsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Account>>>;
+    /**
+     * Retrieves a list of all accounts (admin only)
+     * List all accounts
+     */
+    listAccounts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Account>>;
+}

package/dist/esm/apis/AccountsApi.js

@@ -0,0 +1,96 @@
+/* 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 { AccountFromJSON, CreateAccountRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class AccountsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new account (admin only)
+     * Create a new account
+     */
+    createAccountRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createAccountRequest'] == null) {
+                throw new runtime.RequiredError('createAccountRequest', 'Required parameter "createAccountRequest" was null or undefined when calling createAccount().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/accounts`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateAccountRequestToJSON(requestParameters['createAccountRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AccountFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a new account (admin only)
+     * Create a new account
+     */
+    createAccount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAccountRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves a list of all accounts (admin only)
+     * List all accounts
+     */
+    listAccountsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/accounts`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AccountFromJSON));
+        });
+    }
+    /**
+     * Retrieves a list of all accounts (admin only)
+     * List all accounts
+     */
+    listAccounts(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listAccountsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,105 @@
+/**
+ * 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 { Chat, ChatRequest, CreateChatRequest, PaginatedChats, UpdateChatRequest } from '../models/index';
+export interface CreateChatOperationRequest {
+    xUserId: string;
+    createChatRequest?: CreateChatRequest;
+}
+export interface DeleteChatRequest {
+    xUserId: string;
+    chatId: string;
+}
+export interface GetChatRequest {
+    xUserId: string;
+    chatId: string;
+}
+export interface ListChatsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface SendChatMessageRequest {
+    xUserId: string;
+    chatRequest: ChatRequest;
+    xCanvasToken?: string;
+}
+export interface UpdateChatOperationRequest {
+    xUserId: string;
+    chatId: string;
+    updateChatRequest?: UpdateChatRequest;
+}
+/**
+ *
+ */
+export declare class ChatsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new chat for the authenticated account user.
+     * Create a chat
+     */
+    createChatRaw(requestParameters: CreateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Chat>>;
+    /**
+     * Creates a new chat for the authenticated account user.
+     * Create a chat
+     */
+    createChat(requestParameters: CreateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
+    /**
+     * Deletes a chat and its messages belonging to the authenticated account user.
+     * Delete a chat
+     */
+    deleteChatRaw(requestParameters: DeleteChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a chat and its messages belonging to the authenticated account user.
+     * Delete a chat
+     */
+    deleteChat(requestParameters: DeleteChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a single chat belonging to the authenticated account user.
+     * Get a chat
+     */
+    getChatRaw(requestParameters: GetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Chat>>;
+    /**
+     * Returns a single chat belonging to the authenticated account user.
+     * Get a chat
+     */
+    getChat(requestParameters: GetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
+    /**
+     * Returns paginated chats belonging to the authenticated account user, ordered by creation date (newest first).
+     * List chats
+     */
+    listChatsRaw(requestParameters: ListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedChats>>;
+    /**
+     * Returns paginated chats belonging to the authenticated account user, ordered by creation date (newest first).
+     * List chats
+     */
+    listChats(requestParameters: ListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedChats>;
+    /**
+     * 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: SendChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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: SendChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Updates a chat belonging to the authenticated account user.
+     * Update a chat
+     */
+    updateChatRaw(requestParameters: UpdateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Chat>>;
+    /**
+     * Updates a chat belonging to the authenticated account user.
+     * Update a chat
+     */
+    updateChat(requestParameters: UpdateChatOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
+}