@instructure/athena-api-client 1.0.0

package/dist/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/models/Account.js

@@ -0,0 +1,62 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfAccount = instanceOfAccount;
+exports.AccountFromJSON = AccountFromJSON;
+exports.AccountFromJSONTyped = AccountFromJSONTyped;
+exports.AccountToJSON = AccountToJSON;
+exports.AccountToJSONTyped = AccountToJSONTyped;
+/**
+ * Check if a given object implements the Account interface.
+ */
+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;
+}
+function AccountFromJSON(json) {
+    return AccountFromJSONTyped(json, false);
+}
+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'])),
+    };
+}
+function AccountToJSON(json) {
+    return AccountToJSONTyped(json, false);
+}
+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/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/models/Chat.js

@@ -0,0 +1,92 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatVisibilityEnum = void 0;
+exports.instanceOfChat = instanceOfChat;
+exports.ChatFromJSON = ChatFromJSON;
+exports.ChatFromJSONTyped = ChatFromJSONTyped;
+exports.ChatToJSON = ChatToJSON;
+exports.ChatToJSONTyped = ChatToJSONTyped;
+/**
+ * @export
+ */
+exports.ChatVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
+/**
+ * Check if a given object implements the Chat interface.
+ */
+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;
+}
+function ChatFromJSON(json) {
+    return ChatFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function ChatToJSON(json) {
+    return ChatToJSONTyped(json, false);
+}
+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/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;

package/dist/models/ChatRequest.js

@@ -0,0 +1,52 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfChatRequest = instanceOfChatRequest;
+exports.ChatRequestFromJSON = ChatRequestFromJSON;
+exports.ChatRequestFromJSONTyped = ChatRequestFromJSONTyped;
+exports.ChatRequestToJSON = ChatRequestToJSON;
+exports.ChatRequestToJSONTyped = ChatRequestToJSONTyped;
+/**
+ * Check if a given object implements the ChatRequest interface.
+ */
+function instanceOfChatRequest(value) {
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestFromJSON(json) {
+    return ChatRequestFromJSONTyped(json, false);
+}
+function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+    };
+}
+function ChatRequestToJSON(json) {
+    return ChatRequestToJSONTyped(json, false);
+}
+function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'message': value['message'],
+        'chatId': value['chatId'],
+    };
+}

package/dist/models/CreateAccountRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 CreateAccountRequest
+ */
+export interface CreateAccountRequest {
+    /**
+     * Name of the account
+     * @type {string}
+     * @memberof CreateAccountRequest
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the CreateAccountRequest interface.
+ */
+export declare function instanceOfCreateAccountRequest(value: object): value is CreateAccountRequest;
+export declare function CreateAccountRequestFromJSON(json: any): CreateAccountRequest;
+export declare function CreateAccountRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAccountRequest;
+export declare function CreateAccountRequestToJSON(json: any): CreateAccountRequest;
+export declare function CreateAccountRequestToJSONTyped(value?: CreateAccountRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateAccountRequest.js

@@ -0,0 +1,50 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateAccountRequest = instanceOfCreateAccountRequest;
+exports.CreateAccountRequestFromJSON = CreateAccountRequestFromJSON;
+exports.CreateAccountRequestFromJSONTyped = CreateAccountRequestFromJSONTyped;
+exports.CreateAccountRequestToJSON = CreateAccountRequestToJSON;
+exports.CreateAccountRequestToJSONTyped = CreateAccountRequestToJSONTyped;
+/**
+ * Check if a given object implements the CreateAccountRequest interface.
+ */
+function instanceOfCreateAccountRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function CreateAccountRequestFromJSON(json) {
+    return CreateAccountRequestFromJSONTyped(json, false);
+}
+function CreateAccountRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+    };
+}
+function CreateAccountRequestToJSON(json) {
+    return CreateAccountRequestToJSONTyped(json, false);
+}
+function CreateAccountRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+    };
+}

package/dist/models/CreateChatRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 CreateChatRequest
+ */
+export interface CreateChatRequest {
+    /**
+     * Optional title for the chat. Defaults to 'New Chat' if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    title?: string;
+}
+/**
+ * Check if a given object implements the CreateChatRequest interface.
+ */
+export declare function instanceOfCreateChatRequest(value: object): value is CreateChatRequest;
+export declare function CreateChatRequestFromJSON(json: any): CreateChatRequest;
+export declare function CreateChatRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateChatRequest;
+export declare function CreateChatRequestToJSON(json: any): CreateChatRequest;
+export declare function CreateChatRequestToJSONTyped(value?: CreateChatRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateChatRequest.js

@@ -0,0 +1,48 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateChatRequest = instanceOfCreateChatRequest;
+exports.CreateChatRequestFromJSON = CreateChatRequestFromJSON;
+exports.CreateChatRequestFromJSONTyped = CreateChatRequestFromJSONTyped;
+exports.CreateChatRequestToJSON = CreateChatRequestToJSON;
+exports.CreateChatRequestToJSONTyped = CreateChatRequestToJSONTyped;
+/**
+ * Check if a given object implements the CreateChatRequest interface.
+ */
+function instanceOfCreateChatRequest(value) {
+    return true;
+}
+function CreateChatRequestFromJSON(json) {
+    return CreateChatRequestFromJSONTyped(json, false);
+}
+function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+function CreateChatRequestToJSON(json) {
+    return CreateChatRequestToJSONTyped(json, false);
+}
+function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'title': value['title'],
+    };
+}

package/dist/models/CreateTokenRequest.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 CreateTokenRequest
+ */
+export interface CreateTokenRequest {
+    /**
+     * Name of the service consumer
+     * @type {string}
+     * @memberof CreateTokenRequest
+     */
+    consumerName: string;
+    /**
+     * Role to assign to the token
+     * @type {string}
+     * @memberof CreateTokenRequest
+     */
+    role: CreateTokenRequestRoleEnum;
+    /**
+     * ID of the account to associate with the token
+     * @type {string}
+     * @memberof CreateTokenRequest
+     */
+    accountId: string;
+}
+/**
+ * @export
+ */
+export declare const CreateTokenRequestRoleEnum: {
+    readonly Consumer: "consumer";
+    readonly Admin: "admin";
+};
+export type CreateTokenRequestRoleEnum = typeof CreateTokenRequestRoleEnum[keyof typeof CreateTokenRequestRoleEnum];
+/**
+ * Check if a given object implements the CreateTokenRequest interface.
+ */
+export declare function instanceOfCreateTokenRequest(value: object): value is CreateTokenRequest;
+export declare function CreateTokenRequestFromJSON(json: any): CreateTokenRequest;
+export declare function CreateTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTokenRequest;
+export declare function CreateTokenRequestToJSON(json: any): CreateTokenRequest;
+export declare function CreateTokenRequestToJSONTyped(value?: CreateTokenRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateTokenRequest.js

@@ -0,0 +1,66 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateTokenRequestRoleEnum = void 0;
+exports.instanceOfCreateTokenRequest = instanceOfCreateTokenRequest;
+exports.CreateTokenRequestFromJSON = CreateTokenRequestFromJSON;
+exports.CreateTokenRequestFromJSONTyped = CreateTokenRequestFromJSONTyped;
+exports.CreateTokenRequestToJSON = CreateTokenRequestToJSON;
+exports.CreateTokenRequestToJSONTyped = CreateTokenRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.CreateTokenRequestRoleEnum = {
+    Consumer: 'consumer',
+    Admin: 'admin'
+};
+/**
+ * Check if a given object implements the CreateTokenRequest interface.
+ */
+function instanceOfCreateTokenRequest(value) {
+    if (!('consumerName' in value) || value['consumerName'] === undefined)
+        return false;
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('accountId' in value) || value['accountId'] === undefined)
+        return false;
+    return true;
+}
+function CreateTokenRequestFromJSON(json) {
+    return CreateTokenRequestFromJSONTyped(json, false);
+}
+function CreateTokenRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'consumerName': json['consumerName'],
+        'role': json['role'],
+        'accountId': json['accountId'],
+    };
+}
+function CreateTokenRequestToJSON(json) {
+    return CreateTokenRequestToJSONTyped(json, false);
+}
+function CreateTokenRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'consumerName': value['consumerName'],
+        'role': value['role'],
+        'accountId': value['accountId'],
+    };
+}