@instructure/athena-api-client 3.38.8 → 3.39.0

package/dist/esm/models/ResourceActivity.js

@@ -0,0 +1,100 @@
+/* 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 { ResourceSessionFromJSON, ResourceSessionToJSON, } from './ResourceSession';
+/**
+ * @export
+ */
+export const ResourceActivityProgressStatusEnum = {
+    NotStarted: 'not-started',
+    InProgress: 'in-progress',
+    Completed: 'completed'
+};
+/**
+ * Check if a given object implements the ResourceActivity interface.
+ */
+export function instanceOfResourceActivity(value) {
+    if (!('progressStatus' in value) || value['progressStatus'] === undefined)
+        return false;
+    if (!('sessionCount' in value) || value['sessionCount'] === undefined)
+        return false;
+    if (!('activeSessionCount' in value) || value['activeSessionCount'] === undefined)
+        return false;
+    if (!('completedSessionCount' in value) || value['completedSessionCount'] === undefined)
+        return false;
+    if (!('abandonedSessionCount' in value) || value['abandonedSessionCount'] === undefined)
+        return false;
+    if (!('firstStartedAt' in value) || value['firstStartedAt'] === undefined)
+        return false;
+    if (!('lastActivityAt' in value) || value['lastActivityAt'] === undefined)
+        return false;
+    if (!('latestSession' in value) || value['latestSession'] === undefined)
+        return false;
+    if (!('bestSession' in value) || value['bestSession'] === undefined)
+        return false;
+    if (!('totalAnsweredCount' in value) || value['totalAnsweredCount'] === undefined)
+        return false;
+    if (!('totalCorrectCount' in value) || value['totalCorrectCount'] === undefined)
+        return false;
+    if (!('viewedQuestionCount' in value) || value['viewedQuestionCount'] === undefined)
+        return false;
+    if (!('totalViewCount' in value) || value['totalViewCount'] === undefined)
+        return false;
+    return true;
+}
+export function ResourceActivityFromJSON(json) {
+    return ResourceActivityFromJSONTyped(json, false);
+}
+export function ResourceActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'progressStatus': json['progressStatus'],
+        'sessionCount': json['sessionCount'],
+        'activeSessionCount': json['activeSessionCount'],
+        'completedSessionCount': json['completedSessionCount'],
+        'abandonedSessionCount': json['abandonedSessionCount'],
+        'firstStartedAt': (json['firstStartedAt'] == null ? null : new Date(json['firstStartedAt'])),
+        'lastActivityAt': (json['lastActivityAt'] == null ? null : new Date(json['lastActivityAt'])),
+        'latestSession': ResourceSessionFromJSON(json['latestSession']),
+        'bestSession': ResourceSessionFromJSON(json['bestSession']),
+        'totalAnsweredCount': json['totalAnsweredCount'],
+        'totalCorrectCount': json['totalCorrectCount'],
+        'viewedQuestionCount': json['viewedQuestionCount'],
+        'totalViewCount': json['totalViewCount'],
+    };
+}
+export function ResourceActivityToJSON(json) {
+    return ResourceActivityToJSONTyped(json, false);
+}
+export function ResourceActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'progressStatus': value['progressStatus'],
+        'sessionCount': value['sessionCount'],
+        'activeSessionCount': value['activeSessionCount'],
+        'completedSessionCount': value['completedSessionCount'],
+        'abandonedSessionCount': value['abandonedSessionCount'],
+        'firstStartedAt': value['firstStartedAt'] == null ? value['firstStartedAt'] : value['firstStartedAt'].toISOString(),
+        'lastActivityAt': value['lastActivityAt'] == null ? value['lastActivityAt'] : value['lastActivityAt'].toISOString(),
+        'latestSession': ResourceSessionToJSON(value['latestSession']),
+        'bestSession': ResourceSessionToJSON(value['bestSession']),
+        'totalAnsweredCount': value['totalAnsweredCount'],
+        'totalCorrectCount': value['totalCorrectCount'],
+        'viewedQuestionCount': value['viewedQuestionCount'],
+        'totalViewCount': value['totalViewCount'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 ResourceChat
+ */
+export interface ResourceChat {
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceChat
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceChat
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceChat
+     */
+    chatType: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourceChat
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof ResourceChat
+     */
+    lastViewedAt: Date | null;
+}
+/**
+ * Check if a given object implements the ResourceChat interface.
+ */
+export declare function instanceOfResourceChat(value: object): value is ResourceChat;
+export declare function ResourceChatFromJSON(json: any): ResourceChat;
+export declare function ResourceChatFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceChat;
+export declare function ResourceChatToJSON(json: any): ResourceChat;
+export declare function ResourceChatToJSONTyped(value?: ResourceChat | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ResourceChat.js

@@ -0,0 +1,59 @@
+/* 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 ResourceChat interface.
+ */
+export function instanceOfResourceChat(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('chatType' in value) || value['chatType'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('lastViewedAt' in value) || value['lastViewedAt'] === undefined)
+        return false;
+    return true;
+}
+export function ResourceChatFromJSON(json) {
+    return ResourceChatFromJSONTyped(json, false);
+}
+export function ResourceChatFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'chatType': json['chatType'],
+        'createdAt': (new Date(json['createdAt'])),
+        'lastViewedAt': (json['lastViewedAt'] == null ? null : new Date(json['lastViewedAt'])),
+    };
+}
+export function ResourceChatToJSON(json) {
+    return ResourceChatToJSONTyped(json, false);
+}
+export function ResourceChatToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'chatType': value['chatType'],
+        'createdAt': value['createdAt'].toISOString(),
+        'lastViewedAt': value['lastViewedAt'] == null ? value['lastViewedAt'] : value['lastViewedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,122 @@
+/* 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 { ResourceStudyObjectiveFromJSON, ResourceStudyObjectiveToJSON, } from './ResourceStudyObjective';
+import { ResourceChatFromJSON, ResourceChatToJSON, } from './ResourceChat';
+import { ResourceStudySpaceFromJSON, ResourceStudySpaceToJSON, } from './ResourceStudySpace';
+import { ResourceActivityFromJSON, ResourceActivityToJSON, } from './ResourceActivity';
+/**
+ * @export
+ */
+export const ResourceListItemTypeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+export const ResourceListItemGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the ResourceListItem interface.
+ */
+export 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;
+}
+export function ResourceListItemFromJSON(json) {
+    return ResourceListItemFromJSONTyped(json, false);
+}
+export 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': ResourceChatFromJSON(json['chat']),
+        'studyObjective': ResourceStudyObjectiveFromJSON(json['studyObjective']),
+        'studySpace': ResourceStudySpaceFromJSON(json['studySpace']),
+        'activity': ResourceActivityFromJSON(json['activity']),
+    };
+}
+export function ResourceListItemToJSON(json) {
+    return ResourceListItemToJSONTyped(json, false);
+}
+export 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': ResourceChatToJSON(value['chat']),
+        'studyObjective': ResourceStudyObjectiveToJSON(value['studyObjective']),
+        'studySpace': ResourceStudySpaceToJSON(value['studySpace']),
+        'activity': ResourceActivityToJSON(value['activity']),
+    };
+}

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

@@ -0,0 +1,87 @@
+/* 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 ResourceSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the ResourceSession interface.
+ */
+export 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;
+}
+export function ResourceSessionFromJSON(json) {
+    return ResourceSessionFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function ResourceSessionToJSON(json) {
+    return ResourceSessionToJSONTyped(json, false);
+}
+export 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'],
+    };
+}