@instructure/athena-api-client 1.0.0

package/README.md

@@ -0,0 +1,155 @@
+# athena-api-client@1.0.0
+
+A TypeScript SDK client for the localhost API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install athena-api-client --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  AccountsApi,
+} from 'athena-api-client';
+import type { CreateAccountOperationRequest } from 'athena-api-client';
+
+async function example() {
+  console.log("🚀 Testing athena-api-client SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: AuthToken
+    apiKey: "YOUR API KEY",
+  });
+  const api = new AccountsApi(config);
+
+  const body = {
+    // CreateAccountRequest
+    createAccountRequest: ...,
+  } satisfies CreateAccountOperationRequest;
+
+  try {
+    const data = await api.createAccount(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *http://localhost:3000*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*AccountsApi* | [**createAccount**](docs/AccountsApi.md#createaccountoperation) | **POST** /api/v1/accounts | Create a new account
+*AccountsApi* | [**listAccounts**](docs/AccountsApi.md#listaccounts) | **GET** /api/v1/accounts | List all accounts
+*ChatsApi* | [**createChat**](docs/ChatsApi.md#createchatoperation) | **POST** /api/v1/chats | Create a chat
+*ChatsApi* | [**deleteChat**](docs/ChatsApi.md#deletechat) | **DELETE** /api/v1/chats/{chatId} | Delete a chat
+*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* | [**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
+*HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health | Health check endpoint
+*MessagesApi* | [**getChatMessages**](docs/MessagesApi.md#getchatmessages) | **GET** /api/v1/chats/{chatId}/messages | List chat messages
+*ServiceTokensApi* | [**createServiceToken**](docs/ServiceTokensApi.md#createservicetoken) | **POST** /api/v1/tokens | Create a new service token
+*ServiceTokensApi* | [**deleteServiceToken**](docs/ServiceTokensApi.md#deleteservicetoken) | **DELETE** /api/v1/tokens/{id} | Delete service token
+*ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
+*ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens
+*ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
+*TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
+
+
+### Models
+
+- [Account](docs/Account.md)
+- [Chat](docs/Chat.md)
+- [ChatRequest](docs/ChatRequest.md)
+- [CreateAccountRequest](docs/CreateAccountRequest.md)
+- [CreateChatRequest](docs/CreateChatRequest.md)
+- [CreateTokenRequest](docs/CreateTokenRequest.md)
+- [CreateTokenResponse](docs/CreateTokenResponse.md)
+- [HealthCheck](docs/HealthCheck.md)
+- [Message](docs/Message.md)
+- [MessagePartsInner](docs/MessagePartsInner.md)
+- [ModelError](docs/ModelError.md)
+- [PaginatedChats](docs/PaginatedChats.md)
+- [PaginatedMessages](docs/PaginatedMessages.md)
+- [ServiceToken](docs/ServiceToken.md)
+- [Tag](docs/Tag.md)
+- [UpdateChatRequest](docs/UpdateChatRequest.md)
+- [UpdateTokenRequest](docs/UpdateTokenRequest.md)
+- [UpdateTokenResponse](docs/UpdateTokenResponse.md)
+
+### Authorization
+
+
+Authentication schemes defined for the API:
+<a id="AuthToken"></a>
+#### AuthToken
+
+
+- **Type**: API key
+- **API key parameter name**: `X-Auth-Token`
+- **Location**: HTTP header
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `1.0.0`
+- Package version: `1.0.0`
+- Generator version: `7.19.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[]()

package/dist/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/apis/AccountsApi.js

@@ -0,0 +1,100 @@
+"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.AccountsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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: (0, index_1.CreateAccountRequestToJSON)(requestParameters['createAccountRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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(index_1.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();
+        });
+    }
+}
+exports.AccountsApi = AccountsApi;

package/dist/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>;
+}