@instructure/athena-api-client 4.10.10 → 4.11.0

package/README.md

@@ -366,6 +366,7 @@ All URIs are relative to *http://localhost:3000*
 - [DailyQuizStatus](docs/DailyQuizStatus.md)
 - [DeleteCurrentUserResponse](docs/DeleteCurrentUserResponse.md)
 - [EnrollmentTaxonomy](docs/EnrollmentTaxonomy.md)
+- [ExamPageAttachment](docs/ExamPageAttachment.md)
 - [FeatureEntity](docs/FeatureEntity.md)
 - [FeatureOverrideEntity](docs/FeatureOverrideEntity.md)
 - [HealthCheck](docs/HealthCheck.md)

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

@@ -0,0 +1,54 @@
+/**
+ * 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 ExamPageAttachment
+ */
+export interface ExamPageAttachment {
+    /**
+     * Whether the exam-information pages built this Canvas item's concept list.
+     * @type {boolean}
+     * @memberof ExamPageAttachment
+     */
+    builtList: boolean;
+    /**
+     * Titles of the exam-information pages that built the list, ordered by their Canvas locator. Empty when the list was built from other course information.
+     * @type {Array<string>}
+     * @memberof ExamPageAttachment
+     */
+    titles: Array<string>;
+    /**
+     * A note about the exam-information page step: a source says its topic list is not complete, the pages could not be read, their coverage could not be reconciled, or their coverage conflicts with the assessment details. Null when there is no note.
+     * @type {string}
+     * @memberof ExamPageAttachment
+     */
+    note: ExamPageAttachmentNoteEnum | null;
+}
+/**
+ * @export
+ */
+export declare const ExamPageAttachmentNoteEnum: {
+    readonly NotExhaustive: "not-exhaustive";
+    readonly Unread: "unread";
+    readonly Unresolved: "unresolved";
+    readonly Conflict: "conflict";
+};
+export type ExamPageAttachmentNoteEnum = typeof ExamPageAttachmentNoteEnum[keyof typeof ExamPageAttachmentNoteEnum];
+/**
+ * Check if a given object implements the ExamPageAttachment interface.
+ */
+export declare function instanceOfExamPageAttachment(value: object): value is ExamPageAttachment;
+export declare function ExamPageAttachmentFromJSON(json: any): ExamPageAttachment;
+export declare function ExamPageAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExamPageAttachment;
+export declare function ExamPageAttachmentToJSON(json: any): ExamPageAttachment;
+export declare function ExamPageAttachmentToJSONTyped(value?: ExamPageAttachment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ExamPageAttachment.js

@@ -0,0 +1,60 @@
+/* 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 ExamPageAttachmentNoteEnum = {
+    NotExhaustive: 'not-exhaustive',
+    Unread: 'unread',
+    Unresolved: 'unresolved',
+    Conflict: 'conflict'
+};
+/**
+ * Check if a given object implements the ExamPageAttachment interface.
+ */
+export function instanceOfExamPageAttachment(value) {
+    if (!('builtList' in value) || value['builtList'] === undefined)
+        return false;
+    if (!('titles' in value) || value['titles'] === undefined)
+        return false;
+    if (!('note' in value) || value['note'] === undefined)
+        return false;
+    return true;
+}
+export function ExamPageAttachmentFromJSON(json) {
+    return ExamPageAttachmentFromJSONTyped(json, false);
+}
+export function ExamPageAttachmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'builtList': json['builtList'],
+        'titles': json['titles'],
+        'note': json['note'],
+    };
+}
+export function ExamPageAttachmentToJSON(json) {
+    return ExamPageAttachmentToJSONTyped(json, false);
+}
+export function ExamPageAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'builtList': value['builtList'],
+        'titles': value['titles'],
+        'note': value['note'],
+    };
+}

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

@@ -16,25 +16,25 @@
  */
 export interface StudyObjectiveAccess {
     /**
-     * What the Canvas item's course gives Athena to go on: 'grounded' (the course has material: a syllabus, the item's own text, readable course files, or, when Canvas refused the course files list, files it publishes through Modules, locked for this learner or not), 'unknown' (Athena can't tell; see unknownReason), 'unreadable' (nothing readable, but locked files or external-tool items exist that Athena cannot open), or 'thin' (the item's title and dates only).
+     * What the Canvas item's course gives Athena to go on: 'grounded' (the course has material: a syllabus, the item's own text, readable course files, or, when Canvas refused the course files list, files it publishes through Modules, locked for this learner or not; always, too, when the item's topic list was built from its exam information page), 'unknown' (Athena can't tell; see unknownReason), 'unreadable' (nothing readable, but locked files or external-tool items exist that Athena cannot open), or 'thin' (the item's title and dates only).
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
     state: StudyObjectiveAccessStateEnum;
     /**
-     * Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open. 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing else grounds the course, so it can't say what that listing holds.
+     * Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open as course material (an exam information page it reads for one item builds that item's list instead; see rosterSource 'page'). 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing else grounds the course, so it can't say what that listing holds.
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
     unknownReason: StudyObjectiveAccessUnknownReasonEnum | null;
     /**
-     * Whether anything says what this item covers, for this learner: the item's own text (description or page body), or topics this learner's syllabus analysis found for the assessment with the same title. A syllabus that only names the item does not count.
+     * Whether anything says what this item covers, for this learner: the item's own text (description or page body), topics this learner's syllabus analysis found for the assessment with the same title, or the exam information page whose stated coverage built the item's topic list. A syllabus that only names the item does not count.
      * @type {boolean}
      * @memberof StudyObjectiveAccess
      */
     scopeKnown: boolean;
     /**
-     * Why scopeKnown is true; null when it is false. 'item-text', 'syllabus-topics', or 'syllabus-legacy' (the paired syllabus assessment was analysed before topic counts were stored, so its scope is presumed known).
+     * Why scopeKnown is true; null when it is false. 'item-text', 'syllabus-topics', 'syllabus-legacy' (the paired syllabus assessment was analysed before topic counts were stored, so its scope is presumed known), or 'exam-page' (the item's topic list was built from an exam information page beside it that names this assessment and states what it covers).
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
@@ -118,7 +118,7 @@ export interface StudyObjectiveAccess {
      */
     suggestedScope: Array<string> | null;
     /**
-     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'module' (no item text that says what it covers, so the list was suggested from the name of the course module the item sits in and the names of the other items there), 'syllabus' (neither, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus, subject-naming module or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'module' list as Athena's best guess from its module, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. A 'module' list never makes the scope known: only a syllabus assessment whose title pairs exactly (or nearly) with the item's can. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
+     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'page' (an exam information page beside the item that names this assessment and states its coverage: the list is that stated scope, and the attachment's examPage names the page or pages), 'module' (no item text that says what it covers, so the list was suggested from the name of the course module the item sits in and the names of the other items there), 'syllabus' (neither, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus, subject-naming module or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'module' list as Athena's best guess from its module, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. A 'module' list never makes the scope known: only a syllabus assessment whose title pairs exactly (or nearly) with the item's, or a 'page' list, can. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
@@ -155,6 +155,7 @@ export declare const StudyObjectiveAccessScopeKnownReasonEnum: {
     readonly ItemText: "item-text";
     readonly SyllabusTopics: "syllabus-topics";
     readonly SyllabusLegacy: "syllabus-legacy";
+    readonly ExamPage: "exam-page";
 };
 export type StudyObjectiveAccessScopeKnownReasonEnum = typeof StudyObjectiveAccessScopeKnownReasonEnum[keyof typeof StudyObjectiveAccessScopeKnownReasonEnum];
 /**
@@ -175,6 +176,7 @@ export declare const StudyObjectiveAccessRosterSourceEnum: {
     readonly Text: "text";
     readonly Syllabus: "syllabus";
     readonly Module: "module";
+    readonly Page: "page";
 };
 export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**

package/dist/esm/models/StudyObjectiveAccess.js

@@ -33,7 +33,8 @@ export const StudyObjectiveAccessUnknownReasonEnum = {
 export const StudyObjectiveAccessScopeKnownReasonEnum = {
     ItemText: 'item-text',
     SyllabusTopics: 'syllabus-topics',
-    SyllabusLegacy: 'syllabus-legacy'
+    SyllabusLegacy: 'syllabus-legacy',
+    ExamPage: 'exam-page'
 };
 /**
  * @export
@@ -51,7 +52,8 @@ export const StudyObjectiveAccessRosterSourceEnum = {
     Title: 'title',
     Text: 'text',
     Syllabus: 'syllabus',
-    Module: 'module'
+    Module: 'module',
+    Page: 'page'
 };
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ExamPageAttachment } from './ExamPageAttachment';
 import type { StudyObjectiveConceptSummary } from './StudyObjectiveConceptSummary';
 /**
  *
@@ -46,6 +47,12 @@ export interface StudyObjectiveConceptAttachment {
      * @memberof StudyObjectiveConceptAttachment
      */
     emptyReason: StudyObjectiveConceptAttachmentEmptyReasonEnum | null;
+    /**
+     * The exam-information pages that built this Canvas item's list and any note about that step. Null when no page built the list and there is no note, and for custom objectives.
+     * @type {ExamPageAttachment}
+     * @memberof StudyObjectiveConceptAttachment
+     */
+    examPage: ExamPageAttachment | null;
     /**
      * When a Canvas read made with a learner's own token last stored this Canvas item's facts: the access read a routine trigger runs (a Study Space visit, or staff refreshing a course for that learner). Null for an item never read and for custom objectives. Operational metadata about the Canvas item, returned to any authorized caller; learner surfaces omit it in athena-poc (`attachmentOf`). The item's row is shared by every learner on it, so a read for any of them moves it.
      * @type {Date}

package/dist/esm/models/StudyObjectiveConceptAttachment.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ExamPageAttachmentFromJSON, ExamPageAttachmentToJSON, } from './ExamPageAttachment';
 import { StudyObjectiveConceptSummaryFromJSON, StudyObjectiveConceptSummaryToJSON, } from './StudyObjectiveConceptSummary';
 /**
  * @export
@@ -50,6 +51,8 @@ export function instanceOfStudyObjectiveConceptAttachment(value) {
         return false;
     if (!('emptyReason' in value) || value['emptyReason'] === undefined)
         return false;
+    if (!('examPage' in value) || value['examPage'] === undefined)
+        return false;
     if (!('accessReadAt' in value) || value['accessReadAt'] === undefined)
         return false;
     if (!('structureReaderVersion' in value) || value['structureReaderVersion'] === undefined)
@@ -71,6 +74,7 @@ export function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscrim
         'status': json['status'],
         'lastError': json['lastError'],
         'emptyReason': json['emptyReason'],
+        'examPage': ExamPageAttachmentFromJSON(json['examPage']),
         'accessReadAt': (json['accessReadAt'] == null ? null : new Date(json['accessReadAt'])),
         'structureReaderVersion': json['structureReaderVersion'],
         'concepts': (json['concepts'].map(StudyObjectiveConceptSummaryFromJSON)),
@@ -89,6 +93,7 @@ export function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscrimi
         'status': value['status'],
         'lastError': value['lastError'],
         'emptyReason': value['emptyReason'],
+        'examPage': ExamPageAttachmentToJSON(value['examPage']),
         'accessReadAt': value['accessReadAt'] == null ? value['accessReadAt'] : value['accessReadAt'].toISOString(),
         'structureReaderVersion': value['structureReaderVersion'],
         'concepts': (value['concepts'].map(StudyObjectiveConceptSummaryToJSON)),

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

@@ -29,6 +29,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
     syllabusHtmlByCanvasCourseId?: {
         [key: string]: string;
     };
+    /**
+     * Retry the exam-information page read of an objective whose list could not be built because that read failed; sent only from the card's Refresh in that state
+     * @type {boolean}
+     * @memberof TriggerStudyObjectiveConceptExtractionRequest
+     */
+    retryExamPage?: boolean;
     /**
      * When true, re-extract canvas-sourced objectives whose concepts are already active (bypassing the failed-only/arrival-only re-pend guard). No effect on custom objectives or in-flight extractions.
      * @type {boolean}

package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js

@@ -29,6 +29,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json,
     return {
         'studyObjectiveIds': json['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
+        'retryExamPage': json['retryExamPage'] == null ? undefined : json['retryExamPage'],
         'forceReextract': json['forceReextract'] == null ? undefined : json['forceReextract'],
     };
 }
@@ -42,6 +43,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value,
     return {
         'studyObjectiveIds': value['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
+        'retryExamPage': value['retryExamPage'],
         'forceReextract': value['forceReextract'],
     };
 }

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

@@ -132,6 +132,7 @@ export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
 export * from './DeleteCurrentUserResponse';
 export * from './EnrollmentTaxonomy';
+export * from './ExamPageAttachment';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';
 export * from './HealthCheck';

package/dist/esm/models/index.js

@@ -134,6 +134,7 @@ export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
 export * from './DeleteCurrentUserResponse';
 export * from './EnrollmentTaxonomy';
+export * from './ExamPageAttachment';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';
 export * from './HealthCheck';

package/dist/models/ExamPageAttachment.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 ExamPageAttachment
+ */
+export interface ExamPageAttachment {
+    /**
+     * Whether the exam-information pages built this Canvas item's concept list.
+     * @type {boolean}
+     * @memberof ExamPageAttachment
+     */
+    builtList: boolean;
+    /**
+     * Titles of the exam-information pages that built the list, ordered by their Canvas locator. Empty when the list was built from other course information.
+     * @type {Array<string>}
+     * @memberof ExamPageAttachment
+     */
+    titles: Array<string>;
+    /**
+     * A note about the exam-information page step: a source says its topic list is not complete, the pages could not be read, their coverage could not be reconciled, or their coverage conflicts with the assessment details. Null when there is no note.
+     * @type {string}
+     * @memberof ExamPageAttachment
+     */
+    note: ExamPageAttachmentNoteEnum | null;
+}
+/**
+ * @export
+ */
+export declare const ExamPageAttachmentNoteEnum: {
+    readonly NotExhaustive: "not-exhaustive";
+    readonly Unread: "unread";
+    readonly Unresolved: "unresolved";
+    readonly Conflict: "conflict";
+};
+export type ExamPageAttachmentNoteEnum = typeof ExamPageAttachmentNoteEnum[keyof typeof ExamPageAttachmentNoteEnum];
+/**
+ * Check if a given object implements the ExamPageAttachment interface.
+ */
+export declare function instanceOfExamPageAttachment(value: object): value is ExamPageAttachment;
+export declare function ExamPageAttachmentFromJSON(json: any): ExamPageAttachment;
+export declare function ExamPageAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExamPageAttachment;
+export declare function ExamPageAttachmentToJSON(json: any): ExamPageAttachment;
+export declare function ExamPageAttachmentToJSONTyped(value?: ExamPageAttachment | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ExamPageAttachment.js

@@ -0,0 +1,68 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExamPageAttachmentNoteEnum = void 0;
+exports.instanceOfExamPageAttachment = instanceOfExamPageAttachment;
+exports.ExamPageAttachmentFromJSON = ExamPageAttachmentFromJSON;
+exports.ExamPageAttachmentFromJSONTyped = ExamPageAttachmentFromJSONTyped;
+exports.ExamPageAttachmentToJSON = ExamPageAttachmentToJSON;
+exports.ExamPageAttachmentToJSONTyped = ExamPageAttachmentToJSONTyped;
+/**
+ * @export
+ */
+exports.ExamPageAttachmentNoteEnum = {
+    NotExhaustive: 'not-exhaustive',
+    Unread: 'unread',
+    Unresolved: 'unresolved',
+    Conflict: 'conflict'
+};
+/**
+ * Check if a given object implements the ExamPageAttachment interface.
+ */
+function instanceOfExamPageAttachment(value) {
+    if (!('builtList' in value) || value['builtList'] === undefined)
+        return false;
+    if (!('titles' in value) || value['titles'] === undefined)
+        return false;
+    if (!('note' in value) || value['note'] === undefined)
+        return false;
+    return true;
+}
+function ExamPageAttachmentFromJSON(json) {
+    return ExamPageAttachmentFromJSONTyped(json, false);
+}
+function ExamPageAttachmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'builtList': json['builtList'],
+        'titles': json['titles'],
+        'note': json['note'],
+    };
+}
+function ExamPageAttachmentToJSON(json) {
+    return ExamPageAttachmentToJSONTyped(json, false);
+}
+function ExamPageAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'builtList': value['builtList'],
+        'titles': value['titles'],
+        'note': value['note'],
+    };
+}

package/dist/models/StudyObjectiveAccess.d.ts

@@ -16,25 +16,25 @@
  */
 export interface StudyObjectiveAccess {
     /**
-     * What the Canvas item's course gives Athena to go on: 'grounded' (the course has material: a syllabus, the item's own text, readable course files, or, when Canvas refused the course files list, files it publishes through Modules, locked for this learner or not), 'unknown' (Athena can't tell; see unknownReason), 'unreadable' (nothing readable, but locked files or external-tool items exist that Athena cannot open), or 'thin' (the item's title and dates only).
+     * What the Canvas item's course gives Athena to go on: 'grounded' (the course has material: a syllabus, the item's own text, readable course files, or, when Canvas refused the course files list, files it publishes through Modules, locked for this learner or not; always, too, when the item's topic list was built from its exam information page), 'unknown' (Athena can't tell; see unknownReason), 'unreadable' (nothing readable, but locked files or external-tool items exist that Athena cannot open), or 'thin' (the item's title and dates only).
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
     state: StudyObjectiveAccessStateEnum;
     /**
-     * Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open. 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing else grounds the course, so it can't say what that listing holds.
+     * Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open as course material (an exam information page it reads for one item builds that item's list instead; see rosterSource 'page'). 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing else grounds the course, so it can't say what that listing holds.
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
     unknownReason: StudyObjectiveAccessUnknownReasonEnum | null;
     /**
-     * Whether anything says what this item covers, for this learner: the item's own text (description or page body), or topics this learner's syllabus analysis found for the assessment with the same title. A syllabus that only names the item does not count.
+     * Whether anything says what this item covers, for this learner: the item's own text (description or page body), topics this learner's syllabus analysis found for the assessment with the same title, or the exam information page whose stated coverage built the item's topic list. A syllabus that only names the item does not count.
      * @type {boolean}
      * @memberof StudyObjectiveAccess
      */
     scopeKnown: boolean;
     /**
-     * Why scopeKnown is true; null when it is false. 'item-text', 'syllabus-topics', or 'syllabus-legacy' (the paired syllabus assessment was analysed before topic counts were stored, so its scope is presumed known).
+     * Why scopeKnown is true; null when it is false. 'item-text', 'syllabus-topics', 'syllabus-legacy' (the paired syllabus assessment was analysed before topic counts were stored, so its scope is presumed known), or 'exam-page' (the item's topic list was built from an exam information page beside it that names this assessment and states what it covers).
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
@@ -118,7 +118,7 @@ export interface StudyObjectiveAccess {
      */
     suggestedScope: Array<string> | null;
     /**
-     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'module' (no item text that says what it covers, so the list was suggested from the name of the course module the item sits in and the names of the other items there), 'syllabus' (neither, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus, subject-naming module or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'module' list as Athena's best guess from its module, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. A 'module' list never makes the scope known: only a syllabus assessment whose title pairs exactly (or nearly) with the item's can. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
+     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'page' (an exam information page beside the item that names this assessment and states its coverage: the list is that stated scope, and the attachment's examPage names the page or pages), 'module' (no item text that says what it covers, so the list was suggested from the name of the course module the item sits in and the names of the other items there), 'syllabus' (neither, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus, subject-naming module or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'module' list as Athena's best guess from its module, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. A 'module' list never makes the scope known: only a syllabus assessment whose title pairs exactly (or nearly) with the item's, or a 'page' list, can. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
@@ -155,6 +155,7 @@ export declare const StudyObjectiveAccessScopeKnownReasonEnum: {
     readonly ItemText: "item-text";
     readonly SyllabusTopics: "syllabus-topics";
     readonly SyllabusLegacy: "syllabus-legacy";
+    readonly ExamPage: "exam-page";
 };
 export type StudyObjectiveAccessScopeKnownReasonEnum = typeof StudyObjectiveAccessScopeKnownReasonEnum[keyof typeof StudyObjectiveAccessScopeKnownReasonEnum];
 /**
@@ -175,6 +176,7 @@ export declare const StudyObjectiveAccessRosterSourceEnum: {
     readonly Text: "text";
     readonly Syllabus: "syllabus";
     readonly Module: "module";
+    readonly Page: "page";
 };
 export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**

package/dist/models/StudyObjectiveAccess.js

@@ -41,7 +41,8 @@ exports.StudyObjectiveAccessUnknownReasonEnum = {
 exports.StudyObjectiveAccessScopeKnownReasonEnum = {
     ItemText: 'item-text',
     SyllabusTopics: 'syllabus-topics',
-    SyllabusLegacy: 'syllabus-legacy'
+    SyllabusLegacy: 'syllabus-legacy',
+    ExamPage: 'exam-page'
 };
 /**
  * @export
@@ -59,7 +60,8 @@ exports.StudyObjectiveAccessRosterSourceEnum = {
     Title: 'title',
     Text: 'text',
     Syllabus: 'syllabus',
-    Module: 'module'
+    Module: 'module',
+    Page: 'page'
 };
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.

package/dist/models/StudyObjectiveConceptAttachment.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ExamPageAttachment } from './ExamPageAttachment';
 import type { StudyObjectiveConceptSummary } from './StudyObjectiveConceptSummary';
 /**
  *
@@ -46,6 +47,12 @@ export interface StudyObjectiveConceptAttachment {
      * @memberof StudyObjectiveConceptAttachment
      */
     emptyReason: StudyObjectiveConceptAttachmentEmptyReasonEnum | null;
+    /**
+     * The exam-information pages that built this Canvas item's list and any note about that step. Null when no page built the list and there is no note, and for custom objectives.
+     * @type {ExamPageAttachment}
+     * @memberof StudyObjectiveConceptAttachment
+     */
+    examPage: ExamPageAttachment | null;
     /**
      * When a Canvas read made with a learner's own token last stored this Canvas item's facts: the access read a routine trigger runs (a Study Space visit, or staff refreshing a course for that learner). Null for an item never read and for custom objectives. Operational metadata about the Canvas item, returned to any authorized caller; learner surfaces omit it in athena-poc (`attachmentOf`). The item's row is shared by every learner on it, so a read for any of them moves it.
      * @type {Date}

package/dist/models/StudyObjectiveConceptAttachment.js

@@ -19,6 +19,7 @@ exports.StudyObjectiveConceptAttachmentFromJSON = StudyObjectiveConceptAttachmen
 exports.StudyObjectiveConceptAttachmentFromJSONTyped = StudyObjectiveConceptAttachmentFromJSONTyped;
 exports.StudyObjectiveConceptAttachmentToJSON = StudyObjectiveConceptAttachmentToJSON;
 exports.StudyObjectiveConceptAttachmentToJSONTyped = StudyObjectiveConceptAttachmentToJSONTyped;
+const ExamPageAttachment_1 = require("./ExamPageAttachment");
 const StudyObjectiveConceptSummary_1 = require("./StudyObjectiveConceptSummary");
 /**
  * @export
@@ -58,6 +59,8 @@ function instanceOfStudyObjectiveConceptAttachment(value) {
         return false;
     if (!('emptyReason' in value) || value['emptyReason'] === undefined)
         return false;
+    if (!('examPage' in value) || value['examPage'] === undefined)
+        return false;
     if (!('accessReadAt' in value) || value['accessReadAt'] === undefined)
         return false;
     if (!('structureReaderVersion' in value) || value['structureReaderVersion'] === undefined)
@@ -79,6 +82,7 @@ function StudyObjectiveConceptAttachmentFromJSONTyped(json, ignoreDiscriminator)
         'status': json['status'],
         'lastError': json['lastError'],
         'emptyReason': json['emptyReason'],
+        'examPage': (0, ExamPageAttachment_1.ExamPageAttachmentFromJSON)(json['examPage']),
         'accessReadAt': (json['accessReadAt'] == null ? null : new Date(json['accessReadAt'])),
         'structureReaderVersion': json['structureReaderVersion'],
         'concepts': (json['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryFromJSON)),
@@ -97,6 +101,7 @@ function StudyObjectiveConceptAttachmentToJSONTyped(value, ignoreDiscriminator =
         'status': value['status'],
         'lastError': value['lastError'],
         'emptyReason': value['emptyReason'],
+        'examPage': (0, ExamPageAttachment_1.ExamPageAttachmentToJSON)(value['examPage']),
         'accessReadAt': value['accessReadAt'] == null ? value['accessReadAt'] : value['accessReadAt'].toISOString(),
         'structureReaderVersion': value['structureReaderVersion'],
         'concepts': (value['concepts'].map(StudyObjectiveConceptSummary_1.StudyObjectiveConceptSummaryToJSON)),

package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts

@@ -29,6 +29,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
     syllabusHtmlByCanvasCourseId?: {
         [key: string]: string;
     };
+    /**
+     * Retry the exam-information page read of an objective whose list could not be built because that read failed; sent only from the card's Refresh in that state
+     * @type {boolean}
+     * @memberof TriggerStudyObjectiveConceptExtractionRequest
+     */
+    retryExamPage?: boolean;
     /**
      * When true, re-extract canvas-sourced objectives whose concepts are already active (bypassing the failed-only/arrival-only re-pend guard). No effect on custom objectives or in-flight extractions.
      * @type {boolean}

package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js

@@ -36,6 +36,7 @@ function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignore
     return {
         'studyObjectiveIds': json['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
+        'retryExamPage': json['retryExamPage'] == null ? undefined : json['retryExamPage'],
         'forceReextract': json['forceReextract'] == null ? undefined : json['forceReextract'],
     };
 }
@@ -49,6 +50,7 @@ function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value, ignoreD
     return {
         'studyObjectiveIds': value['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
+        'retryExamPage': value['retryExamPage'],
         'forceReextract': value['forceReextract'],
     };
 }

package/dist/models/index.d.ts

@@ -132,6 +132,7 @@ export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
 export * from './DeleteCurrentUserResponse';
 export * from './EnrollmentTaxonomy';
+export * from './ExamPageAttachment';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';
 export * from './HealthCheck';

package/dist/models/index.js

@@ -150,6 +150,7 @@ __exportStar(require("./CreateTokenResponse"), exports);
 __exportStar(require("./DailyQuizStatus"), exports);
 __exportStar(require("./DeleteCurrentUserResponse"), exports);
 __exportStar(require("./EnrollmentTaxonomy"), exports);
+__exportStar(require("./ExamPageAttachment"), exports);
 __exportStar(require("./FeatureEntity"), exports);
 __exportStar(require("./FeatureOverrideEntity"), exports);
 __exportStar(require("./HealthCheck"), exports);

package/package.json

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