@instructure/athena-api-client 3.42.2 → 3.44.0

package/README.md

@@ -329,6 +329,7 @@ All URIs are relative to *http://localhost:3000*
 - [PracticeQuizStatus](docs/PracticeQuizStatus.md)
 - [PracticeQuizStatusList](docs/PracticeQuizStatusList.md)
 - [Quiz](docs/Quiz.md)
+- [QuizBasisSnapshot](docs/QuizBasisSnapshot.md)
 - [QuizConceptSummary](docs/QuizConceptSummary.md)
 - [QuizListItem](docs/QuizListItem.md)
 - [QuizQuestion](docs/QuizQuestion.md)
@@ -354,6 +355,7 @@ All URIs are relative to *http://localhost:3000*
 - [ServiceToken](docs/ServiceToken.md)
 - [SharedQuiz](docs/SharedQuiz.md)
 - [StudyObjective](docs/StudyObjective.md)
+- [StudyObjectiveAccess](docs/StudyObjectiveAccess.md)
 - [StudyObjectiveCanvasDocument](docs/StudyObjectiveCanvasDocument.md)
 - [StudyObjectiveConceptAttachment](docs/StudyObjectiveConceptAttachment.md)
 - [StudyObjectiveConceptAttachmentList](docs/StudyObjectiveConceptAttachmentList.md)

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Optional metadata attached to the user message. Used by learning session chats to bind an answer to its inline question (`inlineQuestionId` + `questionType` + `structuredAnswer`) and to mark client-auto-fired kickoff turns (`synthetic`). All fields are optional; callers supply whichever subset applies to the message being sent.
+ * Optional metadata attached to the user message. Used by learning session chats to bind an answer to its inline question (`inlineQuestionId` + `questionType` + `structuredAnswer`), to mark client-auto-fired kickoff turns (`synthetic`), and to mark a first turn the client wrote for the learner (`seeded`). All fields are optional; callers supply whichever subset applies to the message being sent.
  * @export
  * @interface ChatRequestMessageMetadata
  */
@@ -39,7 +39,20 @@ export interface ChatRequestMessageMetadata {
      * @memberof ChatRequestMessageMetadata
      */
     synthetic?: boolean;
+    /**
+     * Set when the client wrote this message for the learner and sent it as their first turn: 'objective-nudge' is the study-objective email nudge's opening query. The learner never typed it, so its words are never read as their account of what an assessment covers. Unlike `synthetic`, the message is shown in the transcript.
+     * @type {string}
+     * @memberof ChatRequestMessageMetadata
+     */
+    seeded?: ChatRequestMessageMetadataSeededEnum;
 }
+/**
+ * @export
+ */
+export declare const ChatRequestMessageMetadataSeededEnum: {
+    readonly ObjectiveNudge: "objective-nudge";
+};
+export type ChatRequestMessageMetadataSeededEnum = typeof ChatRequestMessageMetadataSeededEnum[keyof typeof ChatRequestMessageMetadataSeededEnum];
 /**
  * Check if a given object implements the ChatRequestMessageMetadata interface.
  */

package/dist/esm/models/ChatRequestMessageMetadata.js

@@ -11,6 +11,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const ChatRequestMessageMetadataSeededEnum = {
+    ObjectiveNudge: 'objective-nudge'
+};
 /**
  * Check if a given object implements the ChatRequestMessageMetadata interface.
  */
@@ -29,6 +35,7 @@ export function ChatRequestMessageMetadataFromJSONTyped(json, ignoreDiscriminato
         'questionType': json['questionType'] == null ? undefined : json['questionType'],
         'structuredAnswer': json['structuredAnswer'] == null ? undefined : json['structuredAnswer'],
         'synthetic': json['synthetic'] == null ? undefined : json['synthetic'],
+        'seeded': json['seeded'] == null ? undefined : json['seeded'],
     };
 }
 export function ChatRequestMessageMetadataToJSON(json) {
@@ -43,5 +50,6 @@ export function ChatRequestMessageMetadataToJSONTyped(value, ignoreDiscriminator
         'questionType': value['questionType'],
         'structuredAnswer': value['structuredAnswer'],
         'synthetic': value['synthetic'],
+        'seeded': value['seeded'],
     };
 }

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

@@ -33,6 +33,18 @@ export interface ChatRequestQuizSettings {
      * @memberof ChatRequestQuizSettings
      */
     instructions?: string;
+    /**
+     * What the learner says the assessment covers, typed into the study panel's scope box (sent instead of `instructions` when the box asks what the assessment covers). The quiz is built on it, and on an objective chat it is kept as the learner's scope for that objective. An empty string means the learner cleared the box: their kept scope is cleared too.
+     * @type {string}
+     * @memberof ChatRequestQuizSettings
+     */
+    scope?: string;
+    /**
+     * `suggested` when `scope` is Athena's suggested topics (`StudyObjective.access.suggestedScope`) used unedited ("Use these topics"). Omit for anything the learner typed or edited: that scope is their own.
+     * @type {string}
+     * @memberof ChatRequestQuizSettings
+     */
+    scopeSource?: ChatRequestQuizSettingsScopeSourceEnum;
 }
 /**
  * @export
@@ -44,6 +56,13 @@ export declare const ChatRequestQuizSettingsQuestionTypesEnum: {
     readonly TeachBack: "teach-back";
 };
 export type ChatRequestQuizSettingsQuestionTypesEnum = typeof ChatRequestQuizSettingsQuestionTypesEnum[keyof typeof ChatRequestQuizSettingsQuestionTypesEnum];
+/**
+ * @export
+ */
+export declare const ChatRequestQuizSettingsScopeSourceEnum: {
+    readonly Suggested: "suggested";
+};
+export type ChatRequestQuizSettingsScopeSourceEnum = typeof ChatRequestQuizSettingsScopeSourceEnum[keyof typeof ChatRequestQuizSettingsScopeSourceEnum];
 /**
  * Check if a given object implements the ChatRequestQuizSettings interface.
  */

package/dist/esm/models/ChatRequestQuizSettings.js

@@ -20,6 +20,12 @@ export const ChatRequestQuizSettingsQuestionTypesEnum = {
     SpotError: 'spot-error',
     TeachBack: 'teach-back'
 };
+/**
+ * @export
+ */
+export const ChatRequestQuizSettingsScopeSourceEnum = {
+    Suggested: 'suggested'
+};
 /**
  * Check if a given object implements the ChatRequestQuizSettings interface.
  */
@@ -37,6 +43,8 @@ export function ChatRequestQuizSettingsFromJSONTyped(json, ignoreDiscriminator)
         'questionTypes': json['questionTypes'] == null ? undefined : json['questionTypes'],
         'questionCount': json['questionCount'] == null ? undefined : json['questionCount'],
         'instructions': json['instructions'] == null ? undefined : json['instructions'],
+        'scope': json['scope'] == null ? undefined : json['scope'],
+        'scopeSource': json['scopeSource'] == null ? undefined : json['scopeSource'],
     };
 }
 export function ChatRequestQuizSettingsToJSON(json) {
@@ -50,5 +58,7 @@ export function ChatRequestQuizSettingsToJSONTyped(value, ignoreDiscriminator =
         'questionTypes': value['questionTypes'],
         'questionCount': value['questionCount'],
         'instructions': value['instructions'],
+        'scope': value['scope'],
+        'scopeSource': value['scopeSource'],
     };
 }

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { QuizBasisSnapshot } from './QuizBasisSnapshot';
 /**
  *
  * @export
@@ -63,6 +64,12 @@ export interface Quiz {
      * @memberof Quiz
      */
     expectedQuestionCount: number | null;
+    /**
+     * What this quiz was built from, recorded once with the quiz so a reload or a retake reads the same. Null for quizzes generated before it was recorded.
+     * @type {QuizBasisSnapshot}
+     * @memberof Quiz
+     */
+    basisSnapshot?: QuizBasisSnapshot | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/Quiz.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { QuizBasisSnapshotFromJSON, QuizBasisSnapshotToJSON, } from './QuizBasisSnapshot';
 /**
  * @export
  */
@@ -66,6 +67,7 @@ export function QuizFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : QuizBasisSnapshotFromJSON(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
     };
 }
@@ -85,6 +87,7 @@ export function QuizToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': QuizBasisSnapshotToJSON(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
     };
 }

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

@@ -0,0 +1,76 @@
+/**
+ * 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 QuizBasisSnapshot
+ */
+export interface QuizBasisSnapshot {
+    /**
+     * What the questions were actually built from: 'learner-materials' (the learner's own files, which the generator reports using), 'course-material' (course files read from Canvas, same test), 'learner-scope' (what the learner said the assessment covers), or 'general' (practice on the subject).
+     * @type {string}
+     * @memberof QuizBasisSnapshot
+     */
+    basis: QuizBasisSnapshotBasisEnum;
+    /**
+     * A learner file was in play but never reached the generator (it could not be read, or generation retried without it).
+     * @type {boolean}
+     * @memberof QuizBasisSnapshot
+     */
+    droppedFile: boolean;
+    /**
+     * Whether anything said what the assessment covers when the quiz was generated.
+     * @type {boolean}
+     * @memberof QuizBasisSnapshot
+     */
+    scopeKnown: boolean;
+    /**
+     * The course's access state at generation time; null when none was read.
+     * @type {string}
+     * @memberof QuizBasisSnapshot
+     */
+    accessState: QuizBasisSnapshotAccessStateEnum | null;
+    /**
+     * The access rule version behind accessState; null with it.
+     * @type {number}
+     * @memberof QuizBasisSnapshot
+     */
+    ruleVersion: number | null;
+}
+/**
+ * @export
+ */
+export declare const QuizBasisSnapshotBasisEnum: {
+    readonly CourseMaterial: "course-material";
+    readonly LearnerMaterials: "learner-materials";
+    readonly LearnerScope: "learner-scope";
+    readonly General: "general";
+};
+export type QuizBasisSnapshotBasisEnum = typeof QuizBasisSnapshotBasisEnum[keyof typeof QuizBasisSnapshotBasisEnum];
+/**
+ * @export
+ */
+export declare const QuizBasisSnapshotAccessStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+    readonly Unknown: "unknown";
+};
+export type QuizBasisSnapshotAccessStateEnum = typeof QuizBasisSnapshotAccessStateEnum[keyof typeof QuizBasisSnapshotAccessStateEnum];
+/**
+ * Check if a given object implements the QuizBasisSnapshot interface.
+ */
+export declare function instanceOfQuizBasisSnapshot(value: object): value is QuizBasisSnapshot;
+export declare function QuizBasisSnapshotFromJSON(json: any): QuizBasisSnapshot;
+export declare function QuizBasisSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizBasisSnapshot;
+export declare function QuizBasisSnapshotToJSON(json: any): QuizBasisSnapshot;
+export declare function QuizBasisSnapshotToJSONTyped(value?: QuizBasisSnapshot | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizBasisSnapshot.js

@@ -0,0 +1,77 @@
+/* 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 QuizBasisSnapshotBasisEnum = {
+    CourseMaterial: 'course-material',
+    LearnerMaterials: 'learner-materials',
+    LearnerScope: 'learner-scope',
+    General: 'general'
+};
+/**
+ * @export
+ */
+export const QuizBasisSnapshotAccessStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable',
+    Unknown: 'unknown'
+};
+/**
+ * Check if a given object implements the QuizBasisSnapshot interface.
+ */
+export function instanceOfQuizBasisSnapshot(value) {
+    if (!('basis' in value) || value['basis'] === undefined)
+        return false;
+    if (!('droppedFile' in value) || value['droppedFile'] === undefined)
+        return false;
+    if (!('scopeKnown' in value) || value['scopeKnown'] === undefined)
+        return false;
+    if (!('accessState' in value) || value['accessState'] === undefined)
+        return false;
+    if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
+        return false;
+    return true;
+}
+export function QuizBasisSnapshotFromJSON(json) {
+    return QuizBasisSnapshotFromJSONTyped(json, false);
+}
+export function QuizBasisSnapshotFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'basis': json['basis'],
+        'droppedFile': json['droppedFile'],
+        'scopeKnown': json['scopeKnown'],
+        'accessState': json['accessState'],
+        'ruleVersion': json['ruleVersion'],
+    };
+}
+export function QuizBasisSnapshotToJSON(json) {
+    return QuizBasisSnapshotToJSONTyped(json, false);
+}
+export function QuizBasisSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'basis': value['basis'],
+        'droppedFile': value['droppedFile'],
+        'scopeKnown': value['scopeKnown'],
+        'accessState': value['accessState'],
+        'ruleVersion': value['ruleVersion'],
+    };
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { QuizBasisSnapshot } from './QuizBasisSnapshot';
 /**
  *
  * @export
@@ -63,6 +64,12 @@ export interface QuizListItem {
      * @memberof QuizListItem
      */
     expectedQuestionCount: number | null;
+    /**
+     * What this quiz was built from, recorded once with the quiz so a reload or a retake reads the same. Null for quizzes generated before it was recorded.
+     * @type {QuizBasisSnapshot}
+     * @memberof QuizListItem
+     */
+    basisSnapshot?: QuizBasisSnapshot | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/QuizListItem.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { QuizBasisSnapshotFromJSON, QuizBasisSnapshotToJSON, } from './QuizBasisSnapshot';
 /**
  * @export
  */
@@ -68,6 +69,7 @@ export function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : QuizBasisSnapshotFromJSON(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
         'questionCount': json['questionCount'],
     };
@@ -88,6 +90,7 @@ export function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': QuizBasisSnapshotToJSON(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
         'questionCount': value['questionCount'],
     };

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { QuizQuestion } from './QuizQuestion';
+import type { QuizBasisSnapshot } from './QuizBasisSnapshot';
 /**
  *
  * @export
@@ -64,6 +65,12 @@ export interface QuizWithQuestions {
      * @memberof QuizWithQuestions
      */
     expectedQuestionCount: number | null;
+    /**
+     * What this quiz was built from, recorded once with the quiz so a reload or a retake reads the same. Null for quizzes generated before it was recorded.
+     * @type {QuizBasisSnapshot}
+     * @memberof QuizWithQuestions
+     */
+    basisSnapshot?: QuizBasisSnapshot | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/QuizWithQuestions.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { QuizQuestionFromJSON, QuizQuestionToJSON, } from './QuizQuestion';
+import { QuizBasisSnapshotFromJSON, QuizBasisSnapshotToJSON, } from './QuizBasisSnapshot';
 /**
  * @export
  */
@@ -69,6 +70,7 @@ export function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : QuizBasisSnapshotFromJSON(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
         'questions': (json['questions'].map(QuizQuestionFromJSON)),
     };
@@ -89,6 +91,7 @@ export function QuizWithQuestionsToJSONTyped(value, ignoreDiscriminator = false)
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': QuizBasisSnapshotToJSON(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
         'questions': (value['questions'].map(QuizQuestionToJSON)),
     };

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { StudyObjectiveFileAttachment } from './StudyObjectiveFileAttachment';
+import type { StudyObjectiveAccess } from './StudyObjectiveAccess';
 import type { StudyObjectiveCanvasDocument } from './StudyObjectiveCanvasDocument';
 /**
  *
@@ -101,6 +102,24 @@ export interface StudyObjective {
      * @memberof StudyObjective
      */
     archivedAt: Date | null;
+    /**
+     * What the Canvas item's course gives Athena to go on, for a Canvas-sourced objective. Null for custom objectives and until Athena has read the course (the read runs with concept extraction and refreshes weekly). Course-level facts shared by every learner on the item, except scopeKnown and scopeKnownReason, which also count this learner's syllabus analysis.
+     * @type {StudyObjectiveAccess}
+     * @memberof StudyObjective
+     */
+    access?: StudyObjectiveAccess | null;
+    /**
+     * What the learner told Athena this assessment covers, in their own words; null when nothing was told. Per-user and never written by a Canvas re-sync.
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    learnerScope?: string | null;
+    /**
+     * The access state Athena last told this learner about for this objective (the thin-context ask, or practice generated from a panel showing it); null when never told. Read-only.
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    accessDisclosedState?: StudyObjectiveAccessDisclosedStateEnum | null;
     /**
      *
      * @type {Date}
@@ -123,6 +142,15 @@ export declare const StudyObjectiveSourceEnum: {
     readonly Template: "template";
 };
 export type StudyObjectiveSourceEnum = typeof StudyObjectiveSourceEnum[keyof typeof StudyObjectiveSourceEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessDisclosedStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+};
+export type StudyObjectiveAccessDisclosedStateEnum = typeof StudyObjectiveAccessDisclosedStateEnum[keyof typeof StudyObjectiveAccessDisclosedStateEnum];
 /**
  * Check if a given object implements the StudyObjective interface.
  */

package/dist/esm/models/StudyObjective.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { StudyObjectiveFileAttachmentFromJSON, StudyObjectiveFileAttachmentToJSON, } from './StudyObjectiveFileAttachment';
+import { StudyObjectiveAccessFromJSON, StudyObjectiveAccessToJSON, } from './StudyObjectiveAccess';
 import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSON, } from './StudyObjectiveCanvasDocument';
 /**
  * @export
@@ -21,6 +22,14 @@ export const StudyObjectiveSourceEnum = {
     Syllabus: 'syllabus',
     Template: 'template'
 };
+/**
+ * @export
+ */
+export const StudyObjectiveAccessDisclosedStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable'
+};
 /**
  * Check if a given object implements the StudyObjective interface.
  */
@@ -81,6 +90,9 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
         'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
         'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
+        'access': json['access'] == null ? undefined : StudyObjectiveAccessFromJSON(json['access']),
+        'learnerScope': json['learnerScope'] == null ? undefined : json['learnerScope'],
+        'accessDisclosedState': json['accessDisclosedState'] == null ? undefined : json['accessDisclosedState'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -107,6 +119,9 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
+        'access': StudyObjectiveAccessToJSON(value['access']),
+        'learnerScope': value['learnerScope'],
+        'accessDisclosedState': value['accessDisclosedState'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
     };