@instructure/athena-api-client 2.26.0 → 2.28.0

package/dist/esm/models/PracticeQuiz.js

@@ -0,0 +1,47 @@
+/* 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 PracticeQuiz interface.
+ */
+export function instanceOfPracticeQuiz(value) {
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('isNew' in value) || value['isNew'] === undefined)
+        return false;
+    return true;
+}
+export function PracticeQuizFromJSON(json) {
+    return PracticeQuizFromJSONTyped(json, false);
+}
+export function PracticeQuizFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chatId': json['chatId'],
+        'isNew': json['isNew'],
+    };
+}
+export function PracticeQuizToJSON(json) {
+    return PracticeQuizToJSONTyped(json, false);
+}
+export function PracticeQuizToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chatId': value['chatId'],
+        'isNew': value['isNew'],
+    };
+}

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

@@ -0,0 +1,67 @@
+/**
+ * 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 PracticeQuizStatus
+ */
+export interface PracticeQuizStatus {
+    /**
+     * Canvas object id ('{type}:{local_id}') the row refers to.
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    canvasObjectId: string;
+    /**
+     * Quiz mode for this slot.
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    mode: PracticeQuizStatusModeEnum;
+    /**
+     * Chat id associated with this practice-quiz slot, or null when no practice quiz exists yet for this (course, object, mode).
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    chatId: string | null;
+    /**
+     * Latest quiz session status for the associated chat, or null when no chat exists or no session has been started.
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    sessionStatus: PracticeQuizStatusSessionStatusEnum | null;
+}
+/**
+ * @export
+ */
+export declare const PracticeQuizStatusModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type PracticeQuizStatusModeEnum = typeof PracticeQuizStatusModeEnum[keyof typeof PracticeQuizStatusModeEnum];
+/**
+ * @export
+ */
+export declare const PracticeQuizStatusSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type PracticeQuizStatusSessionStatusEnum = typeof PracticeQuizStatusSessionStatusEnum[keyof typeof PracticeQuizStatusSessionStatusEnum];
+/**
+ * Check if a given object implements the PracticeQuizStatus interface.
+ */
+export declare function instanceOfPracticeQuizStatus(value: object): value is PracticeQuizStatus;
+export declare function PracticeQuizStatusFromJSON(json: any): PracticeQuizStatus;
+export declare function PracticeQuizStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PracticeQuizStatus;
+export declare function PracticeQuizStatusToJSON(json: any): PracticeQuizStatus;
+export declare function PracticeQuizStatusToJSONTyped(value?: PracticeQuizStatus | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PracticeQuizStatus.js

@@ -0,0 +1,70 @@
+/* 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 PracticeQuizStatusModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+export const PracticeQuizStatusSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the PracticeQuizStatus interface.
+ */
+export function instanceOfPracticeQuizStatus(value) {
+    if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('sessionStatus' in value) || value['sessionStatus'] === undefined)
+        return false;
+    return true;
+}
+export function PracticeQuizStatusFromJSON(json) {
+    return PracticeQuizStatusFromJSONTyped(json, false);
+}
+export function PracticeQuizStatusFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'canvasObjectId': json['canvasObjectId'],
+        'mode': json['mode'],
+        'chatId': json['chatId'],
+        'sessionStatus': json['sessionStatus'],
+    };
+}
+export function PracticeQuizStatusToJSON(json) {
+    return PracticeQuizStatusToJSONTyped(json, false);
+}
+export function PracticeQuizStatusToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'canvasObjectId': value['canvasObjectId'],
+        'mode': value['mode'],
+        'chatId': value['chatId'],
+        'sessionStatus': value['sessionStatus'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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 type { PracticeQuizStatus } from './PracticeQuizStatus';
+/**
+ *
+ * @export
+ * @interface PracticeQuizStatusList
+ */
+export interface PracticeQuizStatusList {
+    /**
+     * One entry per requested (canvasObjectId, mode) pair within the supplied globalCourseId, including nulls for pairs with no row.
+     * @type {Array<PracticeQuizStatus>}
+     * @memberof PracticeQuizStatusList
+     */
+    items: Array<PracticeQuizStatus>;
+}
+/**
+ * Check if a given object implements the PracticeQuizStatusList interface.
+ */
+export declare function instanceOfPracticeQuizStatusList(value: object): value is PracticeQuizStatusList;
+export declare function PracticeQuizStatusListFromJSON(json: any): PracticeQuizStatusList;
+export declare function PracticeQuizStatusListFromJSONTyped(json: any, ignoreDiscriminator: boolean): PracticeQuizStatusList;
+export declare function PracticeQuizStatusListToJSON(json: any): PracticeQuizStatusList;
+export declare function PracticeQuizStatusListToJSONTyped(value?: PracticeQuizStatusList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PracticeQuizStatusList.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+import { PracticeQuizStatusFromJSON, PracticeQuizStatusToJSON, } from './PracticeQuizStatus';
+/**
+ * Check if a given object implements the PracticeQuizStatusList interface.
+ */
+export function instanceOfPracticeQuizStatusList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function PracticeQuizStatusListFromJSON(json) {
+    return PracticeQuizStatusListFromJSONTyped(json, false);
+}
+export function PracticeQuizStatusListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(PracticeQuizStatusFromJSON)),
+    };
+}
+export function PracticeQuizStatusListToJSON(json) {
+    return PracticeQuizStatusListToJSONTyped(json, false);
+}
+export function PracticeQuizStatusListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(PracticeQuizStatusToJSON)),
+    };
+}

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

@@ -35,6 +35,7 @@ export * from './CreateMessagesRequest';
 export * from './CreateMessagesRequestMessagesInner';
 export * from './CreateMessagesResponse';
 export * from './CreatePlanDto';
+export * from './CreatePracticeQuizRequest';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
@@ -60,6 +61,9 @@ export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './PaginatedUserConcepts';
 export * from './Plan';
+export * from './PracticeQuiz';
+export * from './PracticeQuizStatus';
+export * from './PracticeQuizStatusList';
 export * from './Quiz';
 export * from './QuizListItem';
 export * from './QuizQuestion';

package/dist/esm/models/index.js

@@ -37,6 +37,7 @@ export * from './CreateMessagesRequest';
 export * from './CreateMessagesRequestMessagesInner';
 export * from './CreateMessagesResponse';
 export * from './CreatePlanDto';
+export * from './CreatePracticeQuizRequest';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
@@ -62,6 +63,9 @@ export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './PaginatedUserConcepts';
 export * from './Plan';
+export * from './PracticeQuiz';
+export * from './PracticeQuizStatus';
+export * from './PracticeQuizStatusList';
 export * from './Quiz';
 export * from './QuizListItem';
 export * from './QuizQuestion';

package/dist/models/CreateChatRequest.d.ts

@@ -51,6 +51,12 @@ export interface CreateChatRequest {
      * @memberof CreateChatRequest
      */
     initialStrength?: number;
+    /**
+     * Optional study guide (taxonomy) this chat is scoped to. Persists on `chats.taxonomyId` for any chatType — the existing AI tooling (`getTaxonomy` + `getUserTaxonomyProgress` tool registration, study-guide-scoped system prompt) keys off the row regardless of chatType. The level-up prompt additionally injects the study guide name + description as anchoring context in the prompt body. Caller must be actively enrolled in the supplied taxonomy or the request is rejected with 403, matching the message-stream path's enrollment check.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    taxonomyId?: string;
 }
 /**
  * @export

package/dist/models/CreateChatRequest.js

@@ -46,6 +46,7 @@ function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'visibility': json['visibility'] == null ? undefined : json['visibility'],
         'primaryConceptId': json['primaryConceptId'] == null ? undefined : json['primaryConceptId'],
         'initialStrength': json['initialStrength'] == null ? undefined : json['initialStrength'],
+        'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
     };
 }
 function CreateChatRequestToJSON(json) {
@@ -62,5 +63,6 @@ function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'visibility': value['visibility'],
         'primaryConceptId': value['primaryConceptId'],
         'initialStrength': value['initialStrength'],
+        'taxonomyId': value['taxonomyId'],
     };
 }

package/dist/models/CreatePracticeQuizRequest.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 CreatePracticeQuizRequest
+ */
+export interface CreatePracticeQuizRequest {
+    /**
+     * Canvas global course id. Together with canvasObjectId + mode it identifies the per-exam slot for this learner.
+     * @type {string}
+     * @memberof CreatePracticeQuizRequest
+     */
+    globalCourseId: string;
+    /**
+     * Canvas object identifier formatted '{type}:{local_id}' — e.g. 'assignment:67890' or 'quiz:99999'. The type prefix is required because Canvas namespaces local ids by type.
+     * @type {string}
+     * @memberof CreatePracticeQuizRequest
+     */
+    canvasObjectId: string;
+    /**
+     * Quiz mode: 'quiz' for a graded practice quiz, 'flashcards' for a flashcard set.
+     * @type {string}
+     * @memberof CreatePracticeQuizRequest
+     */
+    mode: CreatePracticeQuizRequestModeEnum;
+    /**
+     * When true, abandon the existing association (if any) and create a new chat. The old chat remains in the learner's history.
+     * @type {boolean}
+     * @memberof CreatePracticeQuizRequest
+     */
+    forceNew?: boolean;
+}
+/**
+ * @export
+ */
+export declare const CreatePracticeQuizRequestModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type CreatePracticeQuizRequestModeEnum = typeof CreatePracticeQuizRequestModeEnum[keyof typeof CreatePracticeQuizRequestModeEnum];
+/**
+ * Check if a given object implements the CreatePracticeQuizRequest interface.
+ */
+export declare function instanceOfCreatePracticeQuizRequest(value: object): value is CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestFromJSON(json: any): CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestToJSON(json: any): CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestToJSONTyped(value?: CreatePracticeQuizRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreatePracticeQuizRequest.js

@@ -0,0 +1,68 @@
+"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.CreatePracticeQuizRequestModeEnum = void 0;
+exports.instanceOfCreatePracticeQuizRequest = instanceOfCreatePracticeQuizRequest;
+exports.CreatePracticeQuizRequestFromJSON = CreatePracticeQuizRequestFromJSON;
+exports.CreatePracticeQuizRequestFromJSONTyped = CreatePracticeQuizRequestFromJSONTyped;
+exports.CreatePracticeQuizRequestToJSON = CreatePracticeQuizRequestToJSON;
+exports.CreatePracticeQuizRequestToJSONTyped = CreatePracticeQuizRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.CreatePracticeQuizRequestModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the CreatePracticeQuizRequest interface.
+ */
+function instanceOfCreatePracticeQuizRequest(value) {
+    if (!('globalCourseId' in value) || value['globalCourseId'] === undefined)
+        return false;
+    if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    return true;
+}
+function CreatePracticeQuizRequestFromJSON(json) {
+    return CreatePracticeQuizRequestFromJSONTyped(json, false);
+}
+function CreatePracticeQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'globalCourseId': json['globalCourseId'],
+        'canvasObjectId': json['canvasObjectId'],
+        'mode': json['mode'],
+        'forceNew': json['forceNew'] == null ? undefined : json['forceNew'],
+    };
+}
+function CreatePracticeQuizRequestToJSON(json) {
+    return CreatePracticeQuizRequestToJSONTyped(json, false);
+}
+function CreatePracticeQuizRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'globalCourseId': value['globalCourseId'],
+        'canvasObjectId': value['canvasObjectId'],
+        'mode': value['mode'],
+        'forceNew': value['forceNew'],
+    };
+}

package/dist/models/PracticeQuiz.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 PracticeQuiz
+ */
+export interface PracticeQuiz {
+    /**
+     * Chat id associated with the practice-quiz slot.
+     * @type {string}
+     * @memberof PracticeQuiz
+     */
+    chatId: string;
+    /**
+     * True when this call created a new chat for the slot. False when an existing chat was returned (find-or-create idempotent path).
+     * @type {boolean}
+     * @memberof PracticeQuiz
+     */
+    isNew: boolean;
+}
+/**
+ * Check if a given object implements the PracticeQuiz interface.
+ */
+export declare function instanceOfPracticeQuiz(value: object): value is PracticeQuiz;
+export declare function PracticeQuizFromJSON(json: any): PracticeQuiz;
+export declare function PracticeQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): PracticeQuiz;
+export declare function PracticeQuizToJSON(json: any): PracticeQuiz;
+export declare function PracticeQuizToJSONTyped(value?: PracticeQuiz | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PracticeQuiz.js

@@ -0,0 +1,54 @@
+"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.instanceOfPracticeQuiz = instanceOfPracticeQuiz;
+exports.PracticeQuizFromJSON = PracticeQuizFromJSON;
+exports.PracticeQuizFromJSONTyped = PracticeQuizFromJSONTyped;
+exports.PracticeQuizToJSON = PracticeQuizToJSON;
+exports.PracticeQuizToJSONTyped = PracticeQuizToJSONTyped;
+/**
+ * Check if a given object implements the PracticeQuiz interface.
+ */
+function instanceOfPracticeQuiz(value) {
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('isNew' in value) || value['isNew'] === undefined)
+        return false;
+    return true;
+}
+function PracticeQuizFromJSON(json) {
+    return PracticeQuizFromJSONTyped(json, false);
+}
+function PracticeQuizFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chatId': json['chatId'],
+        'isNew': json['isNew'],
+    };
+}
+function PracticeQuizToJSON(json) {
+    return PracticeQuizToJSONTyped(json, false);
+}
+function PracticeQuizToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chatId': value['chatId'],
+        'isNew': value['isNew'],
+    };
+}

package/dist/models/PracticeQuizStatus.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 PracticeQuizStatus
+ */
+export interface PracticeQuizStatus {
+    /**
+     * Canvas object id ('{type}:{local_id}') the row refers to.
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    canvasObjectId: string;
+    /**
+     * Quiz mode for this slot.
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    mode: PracticeQuizStatusModeEnum;
+    /**
+     * Chat id associated with this practice-quiz slot, or null when no practice quiz exists yet for this (course, object, mode).
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    chatId: string | null;
+    /**
+     * Latest quiz session status for the associated chat, or null when no chat exists or no session has been started.
+     * @type {string}
+     * @memberof PracticeQuizStatus
+     */
+    sessionStatus: PracticeQuizStatusSessionStatusEnum | null;
+}
+/**
+ * @export
+ */
+export declare const PracticeQuizStatusModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type PracticeQuizStatusModeEnum = typeof PracticeQuizStatusModeEnum[keyof typeof PracticeQuizStatusModeEnum];
+/**
+ * @export
+ */
+export declare const PracticeQuizStatusSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type PracticeQuizStatusSessionStatusEnum = typeof PracticeQuizStatusSessionStatusEnum[keyof typeof PracticeQuizStatusSessionStatusEnum];
+/**
+ * Check if a given object implements the PracticeQuizStatus interface.
+ */
+export declare function instanceOfPracticeQuizStatus(value: object): value is PracticeQuizStatus;
+export declare function PracticeQuizStatusFromJSON(json: any): PracticeQuizStatus;
+export declare function PracticeQuizStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PracticeQuizStatus;
+export declare function PracticeQuizStatusToJSON(json: any): PracticeQuizStatus;
+export declare function PracticeQuizStatusToJSONTyped(value?: PracticeQuizStatus | null, ignoreDiscriminator?: boolean): any;