@instructure/athena-api-client 3.38.9 → 3.39.0

package/dist/models/ResourceListItem.d.ts

@@ -0,0 +1,145 @@
+/**
+ * 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 { ResourceStudyObjective } from './ResourceStudyObjective';
+import type { ResourceChat } from './ResourceChat';
+import type { ResourceStudySpace } from './ResourceStudySpace';
+import type { ResourceActivity } from './ResourceActivity';
+/**
+ *
+ * @export
+ * @interface ResourceListItem
+ */
+export interface ResourceListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceListItem
+     */
+    id: string;
+    /**
+     * What kind of generated resource this is.
+     * @type {string}
+     * @memberof ResourceListItem
+     */
+    type: ResourceListItemTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceListItem
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceListItem
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceListItem
+     */
+    generationStatus: ResourceListItemGenerationStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceListItem
+     */
+    expectedQuestionCount: number | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourceListItem
+     */
+    createdAt: Date;
+    /**
+     * Questions (or cards) persisted so far.
+     * @type {number}
+     * @memberof ResourceListItem
+     */
+    questionCount: number;
+    /**
+     * Question count per question type, e.g. {"mcq": 4, "fill-blank": 1}.
+     * @type {{ [key: string]: number; }}
+     * @memberof ResourceListItem
+     */
+    questionTypeCounts: {
+        [key: string]: number;
+    };
+    /**
+     * Distinct question topics, sorted. Empty when none recorded.
+     * @type {Array<string>}
+     * @memberof ResourceListItem
+     */
+    topics: Array<string>;
+    /**
+     * Distinct knowledge concepts the questions are tagged with.
+     * @type {number}
+     * @memberof ResourceListItem
+     */
+    conceptCount: number;
+    /**
+     * External Canvas course this resource is attributed to, resolved through the chat, its study objective, or its practice slot. Null when no source knows a course.
+     * @type {string}
+     * @memberof ResourceListItem
+     */
+    courseId: string | null;
+    /**
+     * The chat this resource was generated in. Null when that chat has been deleted.
+     * @type {ResourceChat}
+     * @memberof ResourceListItem
+     */
+    chat: ResourceChat | null;
+    /**
+     * The study objective the originating chat was filed under.
+     * @type {ResourceStudyObjective}
+     * @memberof ResourceListItem
+     */
+    studyObjective: ResourceStudyObjective | null;
+    /**
+     * The study space this resource belongs to: the objective's space when it has one, else the learner's space for the attributed course.
+     * @type {ResourceStudySpace}
+     * @memberof ResourceListItem
+     */
+    studySpace: ResourceStudySpace | null;
+    /**
+     *
+     * @type {ResourceActivity}
+     * @memberof ResourceListItem
+     */
+    activity: ResourceActivity;
+}
+/**
+ * @export
+ */
+export declare const ResourceListItemTypeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ResourceListItemTypeEnum = typeof ResourceListItemTypeEnum[keyof typeof ResourceListItemTypeEnum];
+/**
+ * @export
+ */
+export declare const ResourceListItemGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type ResourceListItemGenerationStatusEnum = typeof ResourceListItemGenerationStatusEnum[keyof typeof ResourceListItemGenerationStatusEnum];
+/**
+ * Check if a given object implements the ResourceListItem interface.
+ */
+export declare function instanceOfResourceListItem(value: object): value is ResourceListItem;
+export declare function ResourceListItemFromJSON(json: any): ResourceListItem;
+export declare function ResourceListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceListItem;
+export declare function ResourceListItemToJSON(json: any): ResourceListItem;
+export declare function ResourceListItemToJSONTyped(value?: ResourceListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ResourceListItem.js

@@ -0,0 +1,130 @@
+"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.ResourceListItemGenerationStatusEnum = exports.ResourceListItemTypeEnum = void 0;
+exports.instanceOfResourceListItem = instanceOfResourceListItem;
+exports.ResourceListItemFromJSON = ResourceListItemFromJSON;
+exports.ResourceListItemFromJSONTyped = ResourceListItemFromJSONTyped;
+exports.ResourceListItemToJSON = ResourceListItemToJSON;
+exports.ResourceListItemToJSONTyped = ResourceListItemToJSONTyped;
+const ResourceStudyObjective_1 = require("./ResourceStudyObjective");
+const ResourceChat_1 = require("./ResourceChat");
+const ResourceStudySpace_1 = require("./ResourceStudySpace");
+const ResourceActivity_1 = require("./ResourceActivity");
+/**
+ * @export
+ */
+exports.ResourceListItemTypeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+exports.ResourceListItemGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the ResourceListItem interface.
+ */
+function instanceOfResourceListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined)
+        return false;
+    if (!('questionTypeCounts' in value) || value['questionTypeCounts'] === undefined)
+        return false;
+    if (!('topics' in value) || value['topics'] === undefined)
+        return false;
+    if (!('conceptCount' in value) || value['conceptCount'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('chat' in value) || value['chat'] === undefined)
+        return false;
+    if (!('studyObjective' in value) || value['studyObjective'] === undefined)
+        return false;
+    if (!('studySpace' in value) || value['studySpace'] === undefined)
+        return false;
+    if (!('activity' in value) || value['activity'] === undefined)
+        return false;
+    return true;
+}
+function ResourceListItemFromJSON(json) {
+    return ResourceListItemFromJSONTyped(json, false);
+}
+function ResourceListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'type': json['type'],
+        'title': json['title'],
+        'topic': json['topic'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
+        'createdAt': (new Date(json['createdAt'])),
+        'questionCount': json['questionCount'],
+        'questionTypeCounts': json['questionTypeCounts'],
+        'topics': json['topics'],
+        'conceptCount': json['conceptCount'],
+        'courseId': json['courseId'],
+        'chat': (0, ResourceChat_1.ResourceChatFromJSON)(json['chat']),
+        'studyObjective': (0, ResourceStudyObjective_1.ResourceStudyObjectiveFromJSON)(json['studyObjective']),
+        'studySpace': (0, ResourceStudySpace_1.ResourceStudySpaceFromJSON)(json['studySpace']),
+        'activity': (0, ResourceActivity_1.ResourceActivityFromJSON)(json['activity']),
+    };
+}
+function ResourceListItemToJSON(json) {
+    return ResourceListItemToJSONTyped(json, false);
+}
+function ResourceListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': value['type'],
+        'title': value['title'],
+        'topic': value['topic'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
+        'createdAt': value['createdAt'].toISOString(),
+        'questionCount': value['questionCount'],
+        'questionTypeCounts': value['questionTypeCounts'],
+        'topics': value['topics'],
+        'conceptCount': value['conceptCount'],
+        'courseId': value['courseId'],
+        'chat': (0, ResourceChat_1.ResourceChatToJSON)(value['chat']),
+        'studyObjective': (0, ResourceStudyObjective_1.ResourceStudyObjectiveToJSON)(value['studyObjective']),
+        'studySpace': (0, ResourceStudySpace_1.ResourceStudySpaceToJSON)(value['studySpace']),
+        'activity': (0, ResourceActivity_1.ResourceActivityToJSON)(value['activity']),
+    };
+}

package/dist/models/ResourceSession.d.ts

@@ -0,0 +1,95 @@
+/**
+ * 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 ResourceSession
+ */
+export interface ResourceSession {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSession
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceSession
+     */
+    status: ResourceSessionStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourceSession
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourceSession
+     */
+    completedAt: Date | null;
+    /**
+     * When the learner last answered a question in this session.
+     * @type {Date}
+     * @memberof ResourceSession
+     */
+    lastResponseAt: Date | null;
+    /**
+     * Questions the learner answered or rated in this session.
+     * @type {number}
+     * @memberof ResourceSession
+     */
+    answeredCount: number;
+    /**
+     * Answers marked correct, plus flashcards the learner rated as known.
+     * @type {number}
+     * @memberof ResourceSession
+     */
+    correctCount: number;
+    /**
+     * Answers marked incorrect. Flashcard ratings never count here.
+     * @type {number}
+     * @memberof ResourceSession
+     */
+    incorrectCount: number;
+    /**
+     * Flashcards the learner rated as "need practice".
+     * @type {number}
+     * @memberof ResourceSession
+     */
+    needPracticeCount: number;
+    /**
+     * Questions in the quiz the learner has not answered in this session.
+     * @type {number}
+     * @memberof ResourceSession
+     */
+    remainingCount: number;
+}
+/**
+ * @export
+ */
+export declare const ResourceSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type ResourceSessionStatusEnum = typeof ResourceSessionStatusEnum[keyof typeof ResourceSessionStatusEnum];
+/**
+ * Check if a given object implements the ResourceSession interface.
+ */
+export declare function instanceOfResourceSession(value: object): value is ResourceSession;
+export declare function ResourceSessionFromJSON(json: any): ResourceSession;
+export declare function ResourceSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceSession;
+export declare function ResourceSessionToJSON(json: any): ResourceSession;
+export declare function ResourceSessionToJSONTyped(value?: ResourceSession | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ResourceSession.js

@@ -0,0 +1,95 @@
+"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.ResourceSessionStatusEnum = void 0;
+exports.instanceOfResourceSession = instanceOfResourceSession;
+exports.ResourceSessionFromJSON = ResourceSessionFromJSON;
+exports.ResourceSessionFromJSONTyped = ResourceSessionFromJSONTyped;
+exports.ResourceSessionToJSON = ResourceSessionToJSON;
+exports.ResourceSessionToJSONTyped = ResourceSessionToJSONTyped;
+/**
+ * @export
+ */
+exports.ResourceSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the ResourceSession interface.
+ */
+function instanceOfResourceSession(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    if (!('lastResponseAt' in value) || value['lastResponseAt'] === undefined)
+        return false;
+    if (!('answeredCount' in value) || value['answeredCount'] === undefined)
+        return false;
+    if (!('correctCount' in value) || value['correctCount'] === undefined)
+        return false;
+    if (!('incorrectCount' in value) || value['incorrectCount'] === undefined)
+        return false;
+    if (!('needPracticeCount' in value) || value['needPracticeCount'] === undefined)
+        return false;
+    if (!('remainingCount' in value) || value['remainingCount'] === undefined)
+        return false;
+    return true;
+}
+function ResourceSessionFromJSON(json) {
+    return ResourceSessionFromJSONTyped(json, false);
+}
+function ResourceSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'startedAt': (new Date(json['startedAt'])),
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'lastResponseAt': (json['lastResponseAt'] == null ? null : new Date(json['lastResponseAt'])),
+        'answeredCount': json['answeredCount'],
+        'correctCount': json['correctCount'],
+        'incorrectCount': json['incorrectCount'],
+        'needPracticeCount': json['needPracticeCount'],
+        'remainingCount': json['remainingCount'],
+    };
+}
+function ResourceSessionToJSON(json) {
+    return ResourceSessionToJSONTyped(json, false);
+}
+function ResourceSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'startedAt': value['startedAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'lastResponseAt': value['lastResponseAt'] == null ? value['lastResponseAt'] : value['lastResponseAt'].toISOString(),
+        'answeredCount': value['answeredCount'],
+        'correctCount': value['correctCount'],
+        'incorrectCount': value['incorrectCount'],
+        'needPracticeCount': value['needPracticeCount'],
+        'remainingCount': value['remainingCount'],
+    };
+}

package/dist/models/ResourceStudyObjective.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 ResourceStudyObjective
+ */
+export interface ResourceStudyObjective {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceStudyObjective
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceStudyObjective
+     */
+    title: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourceStudyObjective
+     */
+    dueAt: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceStudyObjective
+     */
+    studySpaceId: string | null;
+}
+/**
+ * Check if a given object implements the ResourceStudyObjective interface.
+ */
+export declare function instanceOfResourceStudyObjective(value: object): value is ResourceStudyObjective;
+export declare function ResourceStudyObjectiveFromJSON(json: any): ResourceStudyObjective;
+export declare function ResourceStudyObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceStudyObjective;
+export declare function ResourceStudyObjectiveToJSON(json: any): ResourceStudyObjective;
+export declare function ResourceStudyObjectiveToJSONTyped(value?: ResourceStudyObjective | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ResourceStudyObjective.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.instanceOfResourceStudyObjective = instanceOfResourceStudyObjective;
+exports.ResourceStudyObjectiveFromJSON = ResourceStudyObjectiveFromJSON;
+exports.ResourceStudyObjectiveFromJSONTyped = ResourceStudyObjectiveFromJSONTyped;
+exports.ResourceStudyObjectiveToJSON = ResourceStudyObjectiveToJSON;
+exports.ResourceStudyObjectiveToJSONTyped = ResourceStudyObjectiveToJSONTyped;
+/**
+ * Check if a given object implements the ResourceStudyObjective interface.
+ */
+function instanceOfResourceStudyObjective(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('dueAt' in value) || value['dueAt'] === undefined)
+        return false;
+    if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
+        return false;
+    return true;
+}
+function ResourceStudyObjectiveFromJSON(json) {
+    return ResourceStudyObjectiveFromJSONTyped(json, false);
+}
+function ResourceStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
+        'studySpaceId': json['studySpaceId'],
+    };
+}
+function ResourceStudyObjectiveToJSON(json) {
+    return ResourceStudyObjectiveToJSONTyped(json, false);
+}
+function ResourceStudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+        'studySpaceId': value['studySpaceId'],
+    };
+}

package/dist/models/ResourceStudySpace.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 ResourceStudySpace
+ */
+export interface ResourceStudySpace {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceStudySpace
+     */
+    id: string;
+    /**
+     * Display name. Empty when the space has not been named yet; clients fall back to the course name.
+     * @type {string}
+     * @memberof ResourceStudySpace
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceStudySpace
+     */
+    courseId: string | null;
+}
+/**
+ * Check if a given object implements the ResourceStudySpace interface.
+ */
+export declare function instanceOfResourceStudySpace(value: object): value is ResourceStudySpace;
+export declare function ResourceStudySpaceFromJSON(json: any): ResourceStudySpace;
+export declare function ResourceStudySpaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceStudySpace;
+export declare function ResourceStudySpaceToJSON(json: any): ResourceStudySpace;
+export declare function ResourceStudySpaceToJSONTyped(value?: ResourceStudySpace | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ResourceStudySpace.js

@@ -0,0 +1,58 @@
+"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.instanceOfResourceStudySpace = instanceOfResourceStudySpace;
+exports.ResourceStudySpaceFromJSON = ResourceStudySpaceFromJSON;
+exports.ResourceStudySpaceFromJSONTyped = ResourceStudySpaceFromJSONTyped;
+exports.ResourceStudySpaceToJSON = ResourceStudySpaceToJSON;
+exports.ResourceStudySpaceToJSONTyped = ResourceStudySpaceToJSONTyped;
+/**
+ * Check if a given object implements the ResourceStudySpace interface.
+ */
+function instanceOfResourceStudySpace(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    return true;
+}
+function ResourceStudySpaceFromJSON(json) {
+    return ResourceStudySpaceFromJSONTyped(json, false);
+}
+function ResourceStudySpaceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'courseId': json['courseId'],
+    };
+}
+function ResourceStudySpaceToJSON(json) {
+    return ResourceStudySpaceToJSONTyped(json, false);
+}
+function ResourceStudySpaceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'courseId': value['courseId'],
+    };
+}