@instructure/athena-api-client 1.0.0

package/dist/esm/apis/ServiceTokensApi.js

@@ -0,0 +1,205 @@
+/* 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 { CreateTokenRequestToJSON, CreateTokenResponseFromJSON, ServiceTokenFromJSON, UpdateTokenRequestToJSON, UpdateTokenResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export 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: CreateTokenRequestToJSON(requestParameters['createTokenRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => 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) => 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(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: UpdateTokenRequestToJSON(requestParameters['updateTokenRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => 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();
+        });
+    }
+}

package/dist/esm/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/esm/apis/TagsApi.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 { TagFromJSON, } from '../models/index';
+/**
+ *
+ */
+export 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(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();
+        });
+    }
+}

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

@@ -0,0 +1,8 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AccountsApi';
+export * from './ChatsApi';
+export * from './HealthApi';
+export * from './MessagesApi';
+export * from './ServiceTokensApi';
+export * from './TagsApi';

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/dist/esm/models/Account.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface Account
+ */
+export interface Account {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof Account
+     */
+    id: string;
+    /**
+     * Name of the account
+     * @type {string}
+     * @memberof Account
+     */
+    name: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof Account
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof Account
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the Account interface.
+ */
+export declare function instanceOfAccount(value: object): value is Account;
+export declare function AccountFromJSON(json: any): Account;
+export declare function AccountFromJSONTyped(json: any, ignoreDiscriminator: boolean): Account;
+export declare function AccountToJSON(json: any): Account;
+export declare function AccountToJSONTyped(value?: Account | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Account.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the Account interface.
+ */
+export function instanceOfAccount(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function AccountFromJSON(json) {
+    return AccountFromJSONTyped(json, false);
+}
+export function AccountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function AccountToJSON(json) {
+    return AccountToJSONTyped(json, false);
+}
+export function AccountToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

package/dist/esm/models/Chat.d.ts

@@ -0,0 +1,112 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface Chat
+ */
+export interface Chat {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof Chat
+     */
+    id: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof Chat
+     */
+    createdAt: Date;
+    /**
+     * Chat title
+     * @type {string}
+     * @memberof Chat
+     */
+    title: string;
+    /**
+     * Type of chat
+     * @type {string}
+     * @memberof Chat
+     */
+    chatType?: string | null;
+    /**
+     * Last viewed timestamp
+     * @type {Date}
+     * @memberof Chat
+     */
+    lastViewedAt?: Date | null;
+    /**
+     * ID of the account user who owns this chat
+     * @type {string}
+     * @memberof Chat
+     */
+    accountUserId: string;
+    /**
+     * Chat visibility
+     * @type {string}
+     * @memberof Chat
+     */
+    visibility: ChatVisibilityEnum;
+    /**
+     * Optional subject ID
+     * @type {string}
+     * @memberof Chat
+     */
+    subjectId?: string | null;
+    /**
+     * Latest job ID
+     * @type {string}
+     * @memberof Chat
+     */
+    latestJobId?: string | null;
+    /**
+     * Scheduled analysis timestamp
+     * @type {Date}
+     * @memberof Chat
+     */
+    analysisScheduledFor?: Date | null;
+    /**
+     * Chat goal
+     * @type {string}
+     * @memberof Chat
+     */
+    goal?: string | null;
+    /**
+     * Whether the goal has been achieved
+     * @type {boolean}
+     * @memberof Chat
+     */
+    goalAchieved?: boolean | null;
+    /**
+     * Whether the chat is marked for review
+     * @type {boolean}
+     * @memberof Chat
+     */
+    forReview: boolean;
+}
+/**
+ * @export
+ */
+export declare const ChatVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type ChatVisibilityEnum = typeof ChatVisibilityEnum[keyof typeof ChatVisibilityEnum];
+/**
+ * Check if a given object implements the Chat interface.
+ */
+export declare function instanceOfChat(value: object): value is Chat;
+export declare function ChatFromJSON(json: any): Chat;
+export declare function ChatFromJSONTyped(json: any, ignoreDiscriminator: boolean): Chat;
+export declare function ChatToJSON(json: any): Chat;
+export declare function ChatToJSONTyped(value?: Chat | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Chat.js

@@ -0,0 +1,84 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ChatVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
+/**
+ * Check if a given object implements the Chat interface.
+ */
+export function instanceOfChat(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('visibility' in value) || value['visibility'] === undefined)
+        return false;
+    if (!('forReview' in value) || value['forReview'] === undefined)
+        return false;
+    return true;
+}
+export function ChatFromJSON(json) {
+    return ChatFromJSONTyped(json, false);
+}
+export function ChatFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'createdAt': (new Date(json['createdAt'])),
+        'title': json['title'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
+        'lastViewedAt': json['lastViewedAt'] == null ? undefined : (new Date(json['lastViewedAt'])),
+        'accountUserId': json['accountUserId'],
+        'visibility': json['visibility'],
+        'subjectId': json['subjectId'] == null ? undefined : json['subjectId'],
+        'latestJobId': json['latestJobId'] == null ? undefined : json['latestJobId'],
+        'analysisScheduledFor': json['analysisScheduledFor'] == null ? undefined : (new Date(json['analysisScheduledFor'])),
+        'goal': json['goal'] == null ? undefined : json['goal'],
+        'goalAchieved': json['goalAchieved'] == null ? undefined : json['goalAchieved'],
+        'forReview': json['forReview'],
+    };
+}
+export function ChatToJSON(json) {
+    return ChatToJSONTyped(json, false);
+}
+export function ChatToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'createdAt': value['createdAt'].toISOString(),
+        'title': value['title'],
+        'chatType': value['chatType'],
+        'lastViewedAt': value['lastViewedAt'] == null ? value['lastViewedAt'] : value['lastViewedAt'].toISOString(),
+        'accountUserId': value['accountUserId'],
+        'visibility': value['visibility'],
+        'subjectId': value['subjectId'],
+        'latestJobId': value['latestJobId'],
+        'analysisScheduledFor': value['analysisScheduledFor'] == null ? value['analysisScheduledFor'] : value['analysisScheduledFor'].toISOString(),
+        'goal': value['goal'],
+        'goalAchieved': value['goalAchieved'],
+        'forReview': value['forReview'],
+    };
+}

package/dist/esm/models/ChatRequest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ChatRequest
+ */
+export interface ChatRequest {
+    /**
+     * The user's message to send to the AI assistant
+     * @type {string}
+     * @memberof ChatRequest
+     */
+    message: string;
+    /**
+     * Optional ID of an existing chat to continue. If omitted, a new chat will be created.
+     * @type {string}
+     * @memberof ChatRequest
+     */
+    chatId?: string;
+}
+/**
+ * Check if a given object implements the ChatRequest interface.
+ */
+export declare function instanceOfChatRequest(value: object): value is ChatRequest;
+export declare function ChatRequestFromJSON(json: any): ChatRequest;
+export declare function ChatRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequest;
+export declare function ChatRequestToJSON(json: any): ChatRequest;
+export declare function ChatRequestToJSONTyped(value?: ChatRequest | null, ignoreDiscriminator?: boolean): any;