@instructure/athena-api-client 3.43.0 → 3.45.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)

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/StudyObjectiveAccess.d.ts

@@ -70,7 +70,7 @@ export interface StudyObjectiveAccess {
      */
     externalToolItemCount: number | null;
     /**
-     * Readable files in the module that holds this item (a quiz or assignment), checked against the course files list. Null when the item is in no module, is another kind of item, or either listing could not be read.
+     * Readable files in the module that holds this item (a quiz or assignment): checked against the course files list, or, when Canvas refused that list (rule 4 on), counted from the module's own File items. Null when the item is in no module, is another kind of item, or modules could not be listed.
      * @type {number}
      * @memberof StudyObjectiveAccess
      */
@@ -82,7 +82,19 @@ export interface StudyObjectiveAccess {
      */
     moduleSiblingPageCount: number | null;
     /**
-     * Version of the rule that produced `state`, for joining client analytics to the rule that was live.
+     * Readable files the course publishes through Modules (File items of a supported type, not locked for the learner; one per file). The file count to name only when readableFileCount is null (Canvas refused the course files list, e.g. a hidden Files tab); never add it to readableFileCount, since module links point at listed files. Null when modules could not be listed, and on facts read before rule 4.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleReadableFileCount: number | null;
+    /**
+     * Files of a supported type published through Modules that Canvas reported locked for the learner whose read stored these facts (one per file). For analytics only: a module lock follows each learner's progress, so it never decides `state` and copy never names it. Null when modules could not be listed, and on facts read before rule 4.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleLockedFileCount: number | null;
+    /**
+     * Version of the rule that stored these facts, for joining client analytics to the rule that was live. A course stored as 'unreadable' on module File locks alone (rule 4) is returned as 'unknown' / 'listing-denied', as rule 5 reads it, with its stored version.
      * @type {number}
      * @memberof StudyObjectiveAccess
      */
@@ -93,6 +105,18 @@ export interface StudyObjectiveAccess {
      * @memberof StudyObjectiveAccess
      */
     readAt: Date;
+    /**
+     * Topics the learner's syllabus schedule suggests this item covers, inferred by syllabus analysis, for the scope box to offer as Athena's best guess. Null while `scopeKnown` is true, when the learner has given a scope of their own, or when their syllabus suggests nothing. A suggestion is not evidence: it never sets `scopeKnown`.
+     * @type {Array<string>}
+     * @memberof StudyObjectiveAccess
+     */
+    suggestedScope: Array<string> | null;
+    /**
+     * What built this item's topic list: 'text' (the course syllabus or the item's own text, long enough to count as material) or 'title' (the course and item names, with no syllabus or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label a 'title' list as suggested from the course name; key that label on this field, not on `state`. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts (no syllabus counted and no item text means 'title'), which can read 'text' for a course that gained text after its list was built.
+     * @type {string}
+     * @memberof StudyObjectiveAccess
+     */
+    rosterSource: StudyObjectiveAccessRosterSourceEnum;
 }
 /**
  * @export
@@ -131,6 +155,14 @@ export declare const StudyObjectiveAccessSyllabusSourceEnum: {
     readonly None: "none";
 };
 export type StudyObjectiveAccessSyllabusSourceEnum = typeof StudyObjectiveAccessSyllabusSourceEnum[keyof typeof StudyObjectiveAccessSyllabusSourceEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessRosterSourceEnum: {
+    readonly Title: "title";
+    readonly Text: "text";
+};
+export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.
  */

package/dist/esm/models/StudyObjectiveAccess.js

@@ -44,6 +44,13 @@ export const StudyObjectiveAccessSyllabusSourceEnum = {
     Native: 'native',
     None: 'none'
 };
+/**
+ * @export
+ */
+export const StudyObjectiveAccessRosterSourceEnum = {
+    Title: 'title',
+    Text: 'text'
+};
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.
  */
@@ -70,10 +77,18 @@ export function instanceOfStudyObjectiveAccess(value) {
         return false;
     if (!('moduleSiblingPageCount' in value) || value['moduleSiblingPageCount'] === undefined)
         return false;
+    if (!('moduleReadableFileCount' in value) || value['moduleReadableFileCount'] === undefined)
+        return false;
+    if (!('moduleLockedFileCount' in value) || value['moduleLockedFileCount'] === undefined)
+        return false;
     if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
         return false;
     if (!('readAt' in value) || value['readAt'] === undefined)
         return false;
+    if (!('suggestedScope' in value) || value['suggestedScope'] === undefined)
+        return false;
+    if (!('rosterSource' in value) || value['rosterSource'] === undefined)
+        return false;
     return true;
 }
 export function StudyObjectiveAccessFromJSON(json) {
@@ -95,8 +110,12 @@ export function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
         'externalToolItemCount': json['externalToolItemCount'],
         'moduleSiblingFileCount': json['moduleSiblingFileCount'],
         'moduleSiblingPageCount': json['moduleSiblingPageCount'],
+        'moduleReadableFileCount': json['moduleReadableFileCount'],
+        'moduleLockedFileCount': json['moduleLockedFileCount'],
         'ruleVersion': json['ruleVersion'],
         'readAt': (new Date(json['readAt'])),
+        'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
+        'rosterSource': json['rosterSource'],
     };
 }
 export function StudyObjectiveAccessToJSON(json) {
@@ -118,7 +137,11 @@ export function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = fal
         'externalToolItemCount': value['externalToolItemCount'],
         'moduleSiblingFileCount': value['moduleSiblingFileCount'],
         'moduleSiblingPageCount': value['moduleSiblingPageCount'],
+        'moduleReadableFileCount': value['moduleReadableFileCount'],
+        'moduleLockedFileCount': value['moduleLockedFileCount'],
         'ruleVersion': value['ruleVersion'],
         'readAt': value['readAt'].toISOString(),
+        'suggestedScope': value['suggestedScope'],
+        'rosterSource': value['rosterSource'],
     };
 }

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

@@ -128,6 +128,7 @@ export * from './PracticeQuiz';
 export * from './PracticeQuizStatus';
 export * from './PracticeQuizStatusList';
 export * from './Quiz';
+export * from './QuizBasisSnapshot';
 export * from './QuizConceptSummary';
 export * from './QuizListItem';
 export * from './QuizQuestion';

package/dist/esm/models/index.js

@@ -130,6 +130,7 @@ export * from './PracticeQuiz';
 export * from './PracticeQuizStatus';
 export * from './PracticeQuizStatusList';
 export * from './Quiz';
+export * from './QuizBasisSnapshot';
 export * from './QuizConceptSummary';
 export * from './QuizListItem';
 export * from './QuizQuestion';

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

@@ -13,11 +13,18 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatRequestMessageMetadataSeededEnum = void 0;
 exports.instanceOfChatRequestMessageMetadata = instanceOfChatRequestMessageMetadata;
 exports.ChatRequestMessageMetadataFromJSON = ChatRequestMessageMetadataFromJSON;
 exports.ChatRequestMessageMetadataFromJSONTyped = ChatRequestMessageMetadataFromJSONTyped;
 exports.ChatRequestMessageMetadataToJSON = ChatRequestMessageMetadataToJSON;
 exports.ChatRequestMessageMetadataToJSONTyped = ChatRequestMessageMetadataToJSONTyped;
+/**
+ * @export
+ */
+exports.ChatRequestMessageMetadataSeededEnum = {
+    ObjectiveNudge: 'objective-nudge'
+};
 /**
  * Check if a given object implements the ChatRequestMessageMetadata interface.
  */
@@ -36,6 +43,7 @@ function ChatRequestMessageMetadataFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
 }
 function ChatRequestMessageMetadataToJSON(json) {
@@ -50,5 +58,6 @@ function ChatRequestMessageMetadataToJSONTyped(value, ignoreDiscriminator = fals
         'questionType': value['questionType'],
         'structuredAnswer': value['structuredAnswer'],
         'synthetic': value['synthetic'],
+        'seeded': value['seeded'],
     };
 }

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

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatRequestQuizSettingsQuestionTypesEnum = void 0;
+exports.ChatRequestQuizSettingsScopeSourceEnum = exports.ChatRequestQuizSettingsQuestionTypesEnum = void 0;
 exports.instanceOfChatRequestQuizSettings = instanceOfChatRequestQuizSettings;
 exports.ChatRequestQuizSettingsFromJSON = ChatRequestQuizSettingsFromJSON;
 exports.ChatRequestQuizSettingsFromJSONTyped = ChatRequestQuizSettingsFromJSONTyped;
@@ -28,6 +28,12 @@ exports.ChatRequestQuizSettingsQuestionTypesEnum = {
     SpotError: 'spot-error',
     TeachBack: 'teach-back'
 };
+/**
+ * @export
+ */
+exports.ChatRequestQuizSettingsScopeSourceEnum = {
+    Suggested: 'suggested'
+};
 /**
  * Check if a given object implements the ChatRequestQuizSettings interface.
  */
@@ -45,6 +51,8 @@ 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'],
     };
 }
 function ChatRequestQuizSettingsToJSON(json) {
@@ -58,5 +66,7 @@ function ChatRequestQuizSettingsToJSONTyped(value, ignoreDiscriminator = false)
         'questionTypes': value['questionTypes'],
         'questionCount': value['questionCount'],
         'instructions': value['instructions'],
+        'scope': value['scope'],
+        'scopeSource': value['scopeSource'],
     };
 }

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

@@ -19,6 +19,7 @@ exports.QuizFromJSON = QuizFromJSON;
 exports.QuizFromJSONTyped = QuizFromJSONTyped;
 exports.QuizToJSON = QuizToJSON;
 exports.QuizToJSONTyped = QuizToJSONTyped;
+const QuizBasisSnapshot_1 = require("./QuizBasisSnapshot");
 /**
  * @export
  */
@@ -74,6 +75,7 @@ function QuizFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : (0, QuizBasisSnapshot_1.QuizBasisSnapshotFromJSON)(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
     };
 }
@@ -93,6 +95,7 @@ function QuizToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': (0, QuizBasisSnapshot_1.QuizBasisSnapshotToJSON)(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
     };
 }

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

@@ -0,0 +1,85 @@
+"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.QuizBasisSnapshotAccessStateEnum = exports.QuizBasisSnapshotBasisEnum = void 0;
+exports.instanceOfQuizBasisSnapshot = instanceOfQuizBasisSnapshot;
+exports.QuizBasisSnapshotFromJSON = QuizBasisSnapshotFromJSON;
+exports.QuizBasisSnapshotFromJSONTyped = QuizBasisSnapshotFromJSONTyped;
+exports.QuizBasisSnapshotToJSON = QuizBasisSnapshotToJSON;
+exports.QuizBasisSnapshotToJSONTyped = QuizBasisSnapshotToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizBasisSnapshotBasisEnum = {
+    CourseMaterial: 'course-material',
+    LearnerMaterials: 'learner-materials',
+    LearnerScope: 'learner-scope',
+    General: 'general'
+};
+/**
+ * @export
+ */
+exports.QuizBasisSnapshotAccessStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable',
+    Unknown: 'unknown'
+};
+/**
+ * Check if a given object implements the QuizBasisSnapshot interface.
+ */
+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;
+}
+function QuizBasisSnapshotFromJSON(json) {
+    return QuizBasisSnapshotFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function QuizBasisSnapshotToJSON(json) {
+    return QuizBasisSnapshotToJSONTyped(json, false);
+}
+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/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/models/QuizListItem.js

@@ -19,6 +19,7 @@ exports.QuizListItemFromJSON = QuizListItemFromJSON;
 exports.QuizListItemFromJSONTyped = QuizListItemFromJSONTyped;
 exports.QuizListItemToJSON = QuizListItemToJSON;
 exports.QuizListItemToJSONTyped = QuizListItemToJSONTyped;
+const QuizBasisSnapshot_1 = require("./QuizBasisSnapshot");
 /**
  * @export
  */
@@ -76,6 +77,7 @@ function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : (0, QuizBasisSnapshot_1.QuizBasisSnapshotFromJSON)(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
         'questionCount': json['questionCount'],
     };
@@ -96,6 +98,7 @@ function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': (0, QuizBasisSnapshot_1.QuizBasisSnapshotToJSON)(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
         'questionCount': value['questionCount'],
     };

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

@@ -20,6 +20,7 @@ exports.QuizWithQuestionsFromJSONTyped = QuizWithQuestionsFromJSONTyped;
 exports.QuizWithQuestionsToJSON = QuizWithQuestionsToJSON;
 exports.QuizWithQuestionsToJSONTyped = QuizWithQuestionsToJSONTyped;
 const QuizQuestion_1 = require("./QuizQuestion");
+const QuizBasisSnapshot_1 = require("./QuizBasisSnapshot");
 /**
  * @export
  */
@@ -77,6 +78,7 @@ function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : (0, QuizBasisSnapshot_1.QuizBasisSnapshotFromJSON)(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
         'questions': (json['questions'].map(QuizQuestion_1.QuizQuestionFromJSON)),
     };
@@ -97,6 +99,7 @@ function QuizWithQuestionsToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': (0, QuizBasisSnapshot_1.QuizBasisSnapshotToJSON)(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
         'questions': (value['questions'].map(QuizQuestion_1.QuizQuestionToJSON)),
     };

package/dist/models/StudyObjectiveAccess.d.ts

@@ -70,7 +70,7 @@ export interface StudyObjectiveAccess {
      */
     externalToolItemCount: number | null;
     /**
-     * Readable files in the module that holds this item (a quiz or assignment), checked against the course files list. Null when the item is in no module, is another kind of item, or either listing could not be read.
+     * Readable files in the module that holds this item (a quiz or assignment): checked against the course files list, or, when Canvas refused that list (rule 4 on), counted from the module's own File items. Null when the item is in no module, is another kind of item, or modules could not be listed.
      * @type {number}
      * @memberof StudyObjectiveAccess
      */
@@ -82,7 +82,19 @@ export interface StudyObjectiveAccess {
      */
     moduleSiblingPageCount: number | null;
     /**
-     * Version of the rule that produced `state`, for joining client analytics to the rule that was live.
+     * Readable files the course publishes through Modules (File items of a supported type, not locked for the learner; one per file). The file count to name only when readableFileCount is null (Canvas refused the course files list, e.g. a hidden Files tab); never add it to readableFileCount, since module links point at listed files. Null when modules could not be listed, and on facts read before rule 4.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleReadableFileCount: number | null;
+    /**
+     * Files of a supported type published through Modules that Canvas reported locked for the learner whose read stored these facts (one per file). For analytics only: a module lock follows each learner's progress, so it never decides `state` and copy never names it. Null when modules could not be listed, and on facts read before rule 4.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleLockedFileCount: number | null;
+    /**
+     * Version of the rule that stored these facts, for joining client analytics to the rule that was live. A course stored as 'unreadable' on module File locks alone (rule 4) is returned as 'unknown' / 'listing-denied', as rule 5 reads it, with its stored version.
      * @type {number}
      * @memberof StudyObjectiveAccess
      */
@@ -93,6 +105,18 @@ export interface StudyObjectiveAccess {
      * @memberof StudyObjectiveAccess
      */
     readAt: Date;
+    /**
+     * Topics the learner's syllabus schedule suggests this item covers, inferred by syllabus analysis, for the scope box to offer as Athena's best guess. Null while `scopeKnown` is true, when the learner has given a scope of their own, or when their syllabus suggests nothing. A suggestion is not evidence: it never sets `scopeKnown`.
+     * @type {Array<string>}
+     * @memberof StudyObjectiveAccess
+     */
+    suggestedScope: Array<string> | null;
+    /**
+     * What built this item's topic list: 'text' (the course syllabus or the item's own text, long enough to count as material) or 'title' (the course and item names, with no syllabus or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label a 'title' list as suggested from the course name; key that label on this field, not on `state`. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts (no syllabus counted and no item text means 'title'), which can read 'text' for a course that gained text after its list was built.
+     * @type {string}
+     * @memberof StudyObjectiveAccess
+     */
+    rosterSource: StudyObjectiveAccessRosterSourceEnum;
 }
 /**
  * @export
@@ -131,6 +155,14 @@ export declare const StudyObjectiveAccessSyllabusSourceEnum: {
     readonly None: "none";
 };
 export type StudyObjectiveAccessSyllabusSourceEnum = typeof StudyObjectiveAccessSyllabusSourceEnum[keyof typeof StudyObjectiveAccessSyllabusSourceEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessRosterSourceEnum: {
+    readonly Title: "title";
+    readonly Text: "text";
+};
+export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.
  */

package/dist/models/StudyObjectiveAccess.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StudyObjectiveAccessSyllabusSourceEnum = exports.StudyObjectiveAccessScopeKnownReasonEnum = exports.StudyObjectiveAccessUnknownReasonEnum = exports.StudyObjectiveAccessStateEnum = void 0;
+exports.StudyObjectiveAccessRosterSourceEnum = exports.StudyObjectiveAccessSyllabusSourceEnum = exports.StudyObjectiveAccessScopeKnownReasonEnum = exports.StudyObjectiveAccessUnknownReasonEnum = exports.StudyObjectiveAccessStateEnum = void 0;
 exports.instanceOfStudyObjectiveAccess = instanceOfStudyObjectiveAccess;
 exports.StudyObjectiveAccessFromJSON = StudyObjectiveAccessFromJSON;
 exports.StudyObjectiveAccessFromJSONTyped = StudyObjectiveAccessFromJSONTyped;
@@ -52,6 +52,13 @@ exports.StudyObjectiveAccessSyllabusSourceEnum = {
     Native: 'native',
     None: 'none'
 };
+/**
+ * @export
+ */
+exports.StudyObjectiveAccessRosterSourceEnum = {
+    Title: 'title',
+    Text: 'text'
+};
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.
  */
@@ -78,10 +85,18 @@ function instanceOfStudyObjectiveAccess(value) {
         return false;
     if (!('moduleSiblingPageCount' in value) || value['moduleSiblingPageCount'] === undefined)
         return false;
+    if (!('moduleReadableFileCount' in value) || value['moduleReadableFileCount'] === undefined)
+        return false;
+    if (!('moduleLockedFileCount' in value) || value['moduleLockedFileCount'] === undefined)
+        return false;
     if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
         return false;
     if (!('readAt' in value) || value['readAt'] === undefined)
         return false;
+    if (!('suggestedScope' in value) || value['suggestedScope'] === undefined)
+        return false;
+    if (!('rosterSource' in value) || value['rosterSource'] === undefined)
+        return false;
     return true;
 }
 function StudyObjectiveAccessFromJSON(json) {
@@ -103,8 +118,12 @@ function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
         'externalToolItemCount': json['externalToolItemCount'],
         'moduleSiblingFileCount': json['moduleSiblingFileCount'],
         'moduleSiblingPageCount': json['moduleSiblingPageCount'],
+        'moduleReadableFileCount': json['moduleReadableFileCount'],
+        'moduleLockedFileCount': json['moduleLockedFileCount'],
         'ruleVersion': json['ruleVersion'],
         'readAt': (new Date(json['readAt'])),
+        'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
+        'rosterSource': json['rosterSource'],
     };
 }
 function StudyObjectiveAccessToJSON(json) {
@@ -126,7 +145,11 @@ function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = false) {
         'externalToolItemCount': value['externalToolItemCount'],
         'moduleSiblingFileCount': value['moduleSiblingFileCount'],
         'moduleSiblingPageCount': value['moduleSiblingPageCount'],
+        'moduleReadableFileCount': value['moduleReadableFileCount'],
+        'moduleLockedFileCount': value['moduleLockedFileCount'],
         'ruleVersion': value['ruleVersion'],
         'readAt': value['readAt'].toISOString(),
+        'suggestedScope': value['suggestedScope'],
+        'rosterSource': value['rosterSource'],
     };
 }

package/dist/models/index.d.ts

@@ -128,6 +128,7 @@ export * from './PracticeQuiz';
 export * from './PracticeQuizStatus';
 export * from './PracticeQuizStatusList';
 export * from './Quiz';
+export * from './QuizBasisSnapshot';
 export * from './QuizConceptSummary';
 export * from './QuizListItem';
 export * from './QuizQuestion';

package/dist/models/index.js

@@ -146,6 +146,7 @@ __exportStar(require("./PracticeQuiz"), exports);
 __exportStar(require("./PracticeQuizStatus"), exports);
 __exportStar(require("./PracticeQuizStatusList"), exports);
 __exportStar(require("./Quiz"), exports);
+__exportStar(require("./QuizBasisSnapshot"), exports);
 __exportStar(require("./QuizConceptSummary"), exports);
 __exportStar(require("./QuizListItem"), exports);
 __exportStar(require("./QuizQuestion"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.43.0",
+  "version": "3.45.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {