@instructure/athena-api-client 3.42.1 → 3.43.0

package/README.md

@@ -354,6 +354,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/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(),
     };

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

@@ -0,0 +1,141 @@
+/**
+ * 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 StudyObjectiveAccess
+ */
+export interface StudyObjectiveAccess {
+    /**
+     * What the Canvas item's course gives Athena to go on: 'grounded' (some material Athena can read: a syllabus, the item's own text, or readable course files), '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 Athena could read 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.
+     * @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).
+     * @type {string}
+     * @memberof StudyObjectiveAccess
+     */
+    scopeKnownReason: StudyObjectiveAccessScopeKnownReasonEnum | null;
+    /**
+     * Where a syllabus long enough to count as material came from; 'none' when no syllabus counted (absent, or a stub).
+     * @type {string}
+     * @memberof StudyObjectiveAccess
+     */
+    syllabusSource: StudyObjectiveAccessSyllabusSourceEnum;
+    /**
+     * Course files Athena could read (supported types, visible and unlocked), from the course files list. Null when the files list could not be read.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    readableFileCount: number | null;
+    /**
+     * Course files of a supported type that are locked for the learner. Null when the files list could not be read.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    lockedFileCount: number | null;
+    /**
+     * Published module items of type Page. Counted from the module listing; pages are not opened. Null when modules could not be listed.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    modulePageCount: number | null;
+    /**
+     * Published module items that open in an external tool Athena cannot read. Null when modules could not be listed.
+     * @type {number}
+     * @memberof 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.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleSiblingFileCount: number | null;
+    /**
+     * Published pages in the module that holds this item (counted, not opened). Null when the item is in no module, is another kind of item, or modules could not be listed; a files list that could not be read leaves it set.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleSiblingPageCount: number | null;
+    /**
+     * Version of the rule that produced `state`, for joining client analytics to the rule that was live.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    ruleVersion: number;
+    /**
+     * When these facts were read from Canvas.
+     * @type {Date}
+     * @memberof StudyObjectiveAccess
+     */
+    readAt: Date;
+}
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+    readonly Unknown: "unknown";
+};
+export type StudyObjectiveAccessStateEnum = typeof StudyObjectiveAccessStateEnum[keyof typeof StudyObjectiveAccessStateEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessUnknownReasonEnum: {
+    readonly PagesOnly: "pages-only";
+    readonly ListingDenied: "listing-denied";
+};
+export type StudyObjectiveAccessUnknownReasonEnum = typeof StudyObjectiveAccessUnknownReasonEnum[keyof typeof StudyObjectiveAccessUnknownReasonEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessScopeKnownReasonEnum: {
+    readonly ItemText: "item-text";
+    readonly SyllabusTopics: "syllabus-topics";
+    readonly SyllabusLegacy: "syllabus-legacy";
+};
+export type StudyObjectiveAccessScopeKnownReasonEnum = typeof StudyObjectiveAccessScopeKnownReasonEnum[keyof typeof StudyObjectiveAccessScopeKnownReasonEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessSyllabusSourceEnum: {
+    readonly Inline: "inline";
+    readonly Stored: "stored";
+    readonly Native: "native";
+    readonly None: "none";
+};
+export type StudyObjectiveAccessSyllabusSourceEnum = typeof StudyObjectiveAccessSyllabusSourceEnum[keyof typeof StudyObjectiveAccessSyllabusSourceEnum];
+/**
+ * Check if a given object implements the StudyObjectiveAccess interface.
+ */
+export declare function instanceOfStudyObjectiveAccess(value: object): value is StudyObjectiveAccess;
+export declare function StudyObjectiveAccessFromJSON(json: any): StudyObjectiveAccess;
+export declare function StudyObjectiveAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveAccess;
+export declare function StudyObjectiveAccessToJSON(json: any): StudyObjectiveAccess;
+export declare function StudyObjectiveAccessToJSONTyped(value?: StudyObjectiveAccess | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyObjectiveAccess.js

@@ -0,0 +1,124 @@
+/* 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 StudyObjectiveAccessStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable',
+    Unknown: 'unknown'
+};
+/**
+ * @export
+ */
+export const StudyObjectiveAccessUnknownReasonEnum = {
+    PagesOnly: 'pages-only',
+    ListingDenied: 'listing-denied'
+};
+/**
+ * @export
+ */
+export const StudyObjectiveAccessScopeKnownReasonEnum = {
+    ItemText: 'item-text',
+    SyllabusTopics: 'syllabus-topics',
+    SyllabusLegacy: 'syllabus-legacy'
+};
+/**
+ * @export
+ */
+export const StudyObjectiveAccessSyllabusSourceEnum = {
+    Inline: 'inline',
+    Stored: 'stored',
+    Native: 'native',
+    None: 'none'
+};
+/**
+ * Check if a given object implements the StudyObjectiveAccess interface.
+ */
+export function instanceOfStudyObjectiveAccess(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('unknownReason' in value) || value['unknownReason'] === undefined)
+        return false;
+    if (!('scopeKnown' in value) || value['scopeKnown'] === undefined)
+        return false;
+    if (!('scopeKnownReason' in value) || value['scopeKnownReason'] === undefined)
+        return false;
+    if (!('syllabusSource' in value) || value['syllabusSource'] === undefined)
+        return false;
+    if (!('readableFileCount' in value) || value['readableFileCount'] === undefined)
+        return false;
+    if (!('lockedFileCount' in value) || value['lockedFileCount'] === undefined)
+        return false;
+    if (!('modulePageCount' in value) || value['modulePageCount'] === undefined)
+        return false;
+    if (!('externalToolItemCount' in value) || value['externalToolItemCount'] === undefined)
+        return false;
+    if (!('moduleSiblingFileCount' in value) || value['moduleSiblingFileCount'] === undefined)
+        return false;
+    if (!('moduleSiblingPageCount' in value) || value['moduleSiblingPageCount'] === undefined)
+        return false;
+    if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
+        return false;
+    if (!('readAt' in value) || value['readAt'] === undefined)
+        return false;
+    return true;
+}
+export function StudyObjectiveAccessFromJSON(json) {
+    return StudyObjectiveAccessFromJSONTyped(json, false);
+}
+export function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': json['state'],
+        'unknownReason': json['unknownReason'],
+        'scopeKnown': json['scopeKnown'],
+        'scopeKnownReason': json['scopeKnownReason'],
+        'syllabusSource': json['syllabusSource'],
+        'readableFileCount': json['readableFileCount'],
+        'lockedFileCount': json['lockedFileCount'],
+        'modulePageCount': json['modulePageCount'],
+        'externalToolItemCount': json['externalToolItemCount'],
+        'moduleSiblingFileCount': json['moduleSiblingFileCount'],
+        'moduleSiblingPageCount': json['moduleSiblingPageCount'],
+        'ruleVersion': json['ruleVersion'],
+        'readAt': (new Date(json['readAt'])),
+    };
+}
+export function StudyObjectiveAccessToJSON(json) {
+    return StudyObjectiveAccessToJSONTyped(json, false);
+}
+export function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': value['state'],
+        'unknownReason': value['unknownReason'],
+        'scopeKnown': value['scopeKnown'],
+        'scopeKnownReason': value['scopeKnownReason'],
+        'syllabusSource': value['syllabusSource'],
+        'readableFileCount': value['readableFileCount'],
+        'lockedFileCount': value['lockedFileCount'],
+        'modulePageCount': value['modulePageCount'],
+        'externalToolItemCount': value['externalToolItemCount'],
+        'moduleSiblingFileCount': value['moduleSiblingFileCount'],
+        'moduleSiblingPageCount': value['moduleSiblingPageCount'],
+        'ruleVersion': value['ruleVersion'],
+        'readAt': value['readAt'].toISOString(),
+    };
+}

package/dist/esm/models/UpcomingStudyObjective.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 UpcomingStudyObjective {
      * @memberof UpcomingStudyObjective
      */
     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 UpcomingStudyObjective
+     */
+    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 UpcomingStudyObjective
+     */
+    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 UpcomingStudyObjective
+     */
+    accessDisclosedState?: UpcomingStudyObjectiveAccessDisclosedStateEnum | null;
     /**
      *
      * @type {Date}
@@ -129,6 +148,15 @@ export declare const UpcomingStudyObjectiveSourceEnum: {
     readonly Template: "template";
 };
 export type UpcomingStudyObjectiveSourceEnum = typeof UpcomingStudyObjectiveSourceEnum[keyof typeof UpcomingStudyObjectiveSourceEnum];
+/**
+ * @export
+ */
+export declare const UpcomingStudyObjectiveAccessDisclosedStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+};
+export type UpcomingStudyObjectiveAccessDisclosedStateEnum = typeof UpcomingStudyObjectiveAccessDisclosedStateEnum[keyof typeof UpcomingStudyObjectiveAccessDisclosedStateEnum];
 /**
  * Check if a given object implements the UpcomingStudyObjective interface.
  */

package/dist/esm/models/UpcomingStudyObjective.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 UpcomingStudyObjectiveSourceEnum = {
     Syllabus: 'syllabus',
     Template: 'template'
 };
+/**
+ * @export
+ */
+export const UpcomingStudyObjectiveAccessDisclosedStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable'
+};
 /**
  * Check if a given object implements the UpcomingStudyObjective interface.
  */
@@ -83,6 +92,9 @@ export function UpcomingStudyObjectiveFromJSONTyped(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'])),
         'studySpaceTitle': json['studySpaceTitle'],
@@ -110,6 +122,9 @@ export function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = f
         '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(),
         'studySpaceTitle': value['studySpaceTitle'],

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

@@ -153,6 +153,7 @@ export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SharedQuiz';
 export * from './StudyObjective';
+export * from './StudyObjectiveAccess';
 export * from './StudyObjectiveCanvasDocument';
 export * from './StudyObjectiveConceptAttachment';
 export * from './StudyObjectiveConceptAttachmentList';

package/dist/esm/models/index.js

@@ -155,6 +155,7 @@ export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SharedQuiz';
 export * from './StudyObjective';
+export * from './StudyObjectiveAccess';
 export * from './StudyObjectiveCanvasDocument';
 export * from './StudyObjectiveConceptAttachment';
 export * from './StudyObjectiveConceptAttachmentList';

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

@@ -13,13 +13,14 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StudyObjectiveSourceEnum = void 0;
+exports.StudyObjectiveAccessDisclosedStateEnum = exports.StudyObjectiveSourceEnum = void 0;
 exports.instanceOfStudyObjective = instanceOfStudyObjective;
 exports.StudyObjectiveFromJSON = StudyObjectiveFromJSON;
 exports.StudyObjectiveFromJSONTyped = StudyObjectiveFromJSONTyped;
 exports.StudyObjectiveToJSON = StudyObjectiveToJSON;
 exports.StudyObjectiveToJSONTyped = StudyObjectiveToJSONTyped;
 const StudyObjectiveFileAttachment_1 = require("./StudyObjectiveFileAttachment");
+const StudyObjectiveAccess_1 = require("./StudyObjectiveAccess");
 const StudyObjectiveCanvasDocument_1 = require("./StudyObjectiveCanvasDocument");
 /**
  * @export
@@ -29,6 +30,14 @@ exports.StudyObjectiveSourceEnum = {
     Syllabus: 'syllabus',
     Template: 'template'
 };
+/**
+ * @export
+ */
+exports.StudyObjectiveAccessDisclosedStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable'
+};
 /**
  * Check if a given object implements the StudyObjective interface.
  */
@@ -89,6 +98,9 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
         'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
         'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
+        'access': json['access'] == null ? undefined : (0, StudyObjectiveAccess_1.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'])),
     };
@@ -115,6 +127,9 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
+        'access': (0, StudyObjectiveAccess_1.StudyObjectiveAccessToJSON)(value['access']),
+        'learnerScope': value['learnerScope'],
+        'accessDisclosedState': value['accessDisclosedState'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
     };

package/dist/models/StudyObjectiveAccess.d.ts

@@ -0,0 +1,141 @@
+/**
+ * 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 StudyObjectiveAccess
+ */
+export interface StudyObjectiveAccess {
+    /**
+     * What the Canvas item's course gives Athena to go on: 'grounded' (some material Athena can read: a syllabus, the item's own text, or readable course files), '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 Athena could read 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.
+     * @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).
+     * @type {string}
+     * @memberof StudyObjectiveAccess
+     */
+    scopeKnownReason: StudyObjectiveAccessScopeKnownReasonEnum | null;
+    /**
+     * Where a syllabus long enough to count as material came from; 'none' when no syllabus counted (absent, or a stub).
+     * @type {string}
+     * @memberof StudyObjectiveAccess
+     */
+    syllabusSource: StudyObjectiveAccessSyllabusSourceEnum;
+    /**
+     * Course files Athena could read (supported types, visible and unlocked), from the course files list. Null when the files list could not be read.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    readableFileCount: number | null;
+    /**
+     * Course files of a supported type that are locked for the learner. Null when the files list could not be read.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    lockedFileCount: number | null;
+    /**
+     * Published module items of type Page. Counted from the module listing; pages are not opened. Null when modules could not be listed.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    modulePageCount: number | null;
+    /**
+     * Published module items that open in an external tool Athena cannot read. Null when modules could not be listed.
+     * @type {number}
+     * @memberof 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.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleSiblingFileCount: number | null;
+    /**
+     * Published pages in the module that holds this item (counted, not opened). Null when the item is in no module, is another kind of item, or modules could not be listed; a files list that could not be read leaves it set.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleSiblingPageCount: number | null;
+    /**
+     * Version of the rule that produced `state`, for joining client analytics to the rule that was live.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    ruleVersion: number;
+    /**
+     * When these facts were read from Canvas.
+     * @type {Date}
+     * @memberof StudyObjectiveAccess
+     */
+    readAt: Date;
+}
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+    readonly Unknown: "unknown";
+};
+export type StudyObjectiveAccessStateEnum = typeof StudyObjectiveAccessStateEnum[keyof typeof StudyObjectiveAccessStateEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessUnknownReasonEnum: {
+    readonly PagesOnly: "pages-only";
+    readonly ListingDenied: "listing-denied";
+};
+export type StudyObjectiveAccessUnknownReasonEnum = typeof StudyObjectiveAccessUnknownReasonEnum[keyof typeof StudyObjectiveAccessUnknownReasonEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessScopeKnownReasonEnum: {
+    readonly ItemText: "item-text";
+    readonly SyllabusTopics: "syllabus-topics";
+    readonly SyllabusLegacy: "syllabus-legacy";
+};
+export type StudyObjectiveAccessScopeKnownReasonEnum = typeof StudyObjectiveAccessScopeKnownReasonEnum[keyof typeof StudyObjectiveAccessScopeKnownReasonEnum];
+/**
+ * @export
+ */
+export declare const StudyObjectiveAccessSyllabusSourceEnum: {
+    readonly Inline: "inline";
+    readonly Stored: "stored";
+    readonly Native: "native";
+    readonly None: "none";
+};
+export type StudyObjectiveAccessSyllabusSourceEnum = typeof StudyObjectiveAccessSyllabusSourceEnum[keyof typeof StudyObjectiveAccessSyllabusSourceEnum];
+/**
+ * Check if a given object implements the StudyObjectiveAccess interface.
+ */
+export declare function instanceOfStudyObjectiveAccess(value: object): value is StudyObjectiveAccess;
+export declare function StudyObjectiveAccessFromJSON(json: any): StudyObjectiveAccess;
+export declare function StudyObjectiveAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveAccess;
+export declare function StudyObjectiveAccessToJSON(json: any): StudyObjectiveAccess;
+export declare function StudyObjectiveAccessToJSONTyped(value?: StudyObjectiveAccess | null, ignoreDiscriminator?: boolean): any;

package/dist/models/StudyObjectiveAccess.js

@@ -0,0 +1,132 @@
+"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.StudyObjectiveAccessSyllabusSourceEnum = exports.StudyObjectiveAccessScopeKnownReasonEnum = exports.StudyObjectiveAccessUnknownReasonEnum = exports.StudyObjectiveAccessStateEnum = void 0;
+exports.instanceOfStudyObjectiveAccess = instanceOfStudyObjectiveAccess;
+exports.StudyObjectiveAccessFromJSON = StudyObjectiveAccessFromJSON;
+exports.StudyObjectiveAccessFromJSONTyped = StudyObjectiveAccessFromJSONTyped;
+exports.StudyObjectiveAccessToJSON = StudyObjectiveAccessToJSON;
+exports.StudyObjectiveAccessToJSONTyped = StudyObjectiveAccessToJSONTyped;
+/**
+ * @export
+ */
+exports.StudyObjectiveAccessStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable',
+    Unknown: 'unknown'
+};
+/**
+ * @export
+ */
+exports.StudyObjectiveAccessUnknownReasonEnum = {
+    PagesOnly: 'pages-only',
+    ListingDenied: 'listing-denied'
+};
+/**
+ * @export
+ */
+exports.StudyObjectiveAccessScopeKnownReasonEnum = {
+    ItemText: 'item-text',
+    SyllabusTopics: 'syllabus-topics',
+    SyllabusLegacy: 'syllabus-legacy'
+};
+/**
+ * @export
+ */
+exports.StudyObjectiveAccessSyllabusSourceEnum = {
+    Inline: 'inline',
+    Stored: 'stored',
+    Native: 'native',
+    None: 'none'
+};
+/**
+ * Check if a given object implements the StudyObjectiveAccess interface.
+ */
+function instanceOfStudyObjectiveAccess(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('unknownReason' in value) || value['unknownReason'] === undefined)
+        return false;
+    if (!('scopeKnown' in value) || value['scopeKnown'] === undefined)
+        return false;
+    if (!('scopeKnownReason' in value) || value['scopeKnownReason'] === undefined)
+        return false;
+    if (!('syllabusSource' in value) || value['syllabusSource'] === undefined)
+        return false;
+    if (!('readableFileCount' in value) || value['readableFileCount'] === undefined)
+        return false;
+    if (!('lockedFileCount' in value) || value['lockedFileCount'] === undefined)
+        return false;
+    if (!('modulePageCount' in value) || value['modulePageCount'] === undefined)
+        return false;
+    if (!('externalToolItemCount' in value) || value['externalToolItemCount'] === undefined)
+        return false;
+    if (!('moduleSiblingFileCount' in value) || value['moduleSiblingFileCount'] === undefined)
+        return false;
+    if (!('moduleSiblingPageCount' in value) || value['moduleSiblingPageCount'] === undefined)
+        return false;
+    if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
+        return false;
+    if (!('readAt' in value) || value['readAt'] === undefined)
+        return false;
+    return true;
+}
+function StudyObjectiveAccessFromJSON(json) {
+    return StudyObjectiveAccessFromJSONTyped(json, false);
+}
+function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': json['state'],
+        'unknownReason': json['unknownReason'],
+        'scopeKnown': json['scopeKnown'],
+        'scopeKnownReason': json['scopeKnownReason'],
+        'syllabusSource': json['syllabusSource'],
+        'readableFileCount': json['readableFileCount'],
+        'lockedFileCount': json['lockedFileCount'],
+        'modulePageCount': json['modulePageCount'],
+        'externalToolItemCount': json['externalToolItemCount'],
+        'moduleSiblingFileCount': json['moduleSiblingFileCount'],
+        'moduleSiblingPageCount': json['moduleSiblingPageCount'],
+        'ruleVersion': json['ruleVersion'],
+        'readAt': (new Date(json['readAt'])),
+    };
+}
+function StudyObjectiveAccessToJSON(json) {
+    return StudyObjectiveAccessToJSONTyped(json, false);
+}
+function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': value['state'],
+        'unknownReason': value['unknownReason'],
+        'scopeKnown': value['scopeKnown'],
+        'scopeKnownReason': value['scopeKnownReason'],
+        'syllabusSource': value['syllabusSource'],
+        'readableFileCount': value['readableFileCount'],
+        'lockedFileCount': value['lockedFileCount'],
+        'modulePageCount': value['modulePageCount'],
+        'externalToolItemCount': value['externalToolItemCount'],
+        'moduleSiblingFileCount': value['moduleSiblingFileCount'],
+        'moduleSiblingPageCount': value['moduleSiblingPageCount'],
+        'ruleVersion': value['ruleVersion'],
+        'readAt': value['readAt'].toISOString(),
+    };
+}

package/dist/models/UpcomingStudyObjective.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 UpcomingStudyObjective {
      * @memberof UpcomingStudyObjective
      */
     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 UpcomingStudyObjective
+     */
+    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 UpcomingStudyObjective
+     */
+    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 UpcomingStudyObjective
+     */
+    accessDisclosedState?: UpcomingStudyObjectiveAccessDisclosedStateEnum | null;
     /**
      *
      * @type {Date}
@@ -129,6 +148,15 @@ export declare const UpcomingStudyObjectiveSourceEnum: {
     readonly Template: "template";
 };
 export type UpcomingStudyObjectiveSourceEnum = typeof UpcomingStudyObjectiveSourceEnum[keyof typeof UpcomingStudyObjectiveSourceEnum];
+/**
+ * @export
+ */
+export declare const UpcomingStudyObjectiveAccessDisclosedStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+};
+export type UpcomingStudyObjectiveAccessDisclosedStateEnum = typeof UpcomingStudyObjectiveAccessDisclosedStateEnum[keyof typeof UpcomingStudyObjectiveAccessDisclosedStateEnum];
 /**
  * Check if a given object implements the UpcomingStudyObjective interface.
  */

package/dist/models/UpcomingStudyObjective.js

@@ -13,13 +13,14 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpcomingStudyObjectiveSourceEnum = void 0;
+exports.UpcomingStudyObjectiveAccessDisclosedStateEnum = exports.UpcomingStudyObjectiveSourceEnum = void 0;
 exports.instanceOfUpcomingStudyObjective = instanceOfUpcomingStudyObjective;
 exports.UpcomingStudyObjectiveFromJSON = UpcomingStudyObjectiveFromJSON;
 exports.UpcomingStudyObjectiveFromJSONTyped = UpcomingStudyObjectiveFromJSONTyped;
 exports.UpcomingStudyObjectiveToJSON = UpcomingStudyObjectiveToJSON;
 exports.UpcomingStudyObjectiveToJSONTyped = UpcomingStudyObjectiveToJSONTyped;
 const StudyObjectiveFileAttachment_1 = require("./StudyObjectiveFileAttachment");
+const StudyObjectiveAccess_1 = require("./StudyObjectiveAccess");
 const StudyObjectiveCanvasDocument_1 = require("./StudyObjectiveCanvasDocument");
 /**
  * @export
@@ -29,6 +30,14 @@ exports.UpcomingStudyObjectiveSourceEnum = {
     Syllabus: 'syllabus',
     Template: 'template'
 };
+/**
+ * @export
+ */
+exports.UpcomingStudyObjectiveAccessDisclosedStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable'
+};
 /**
  * Check if a given object implements the UpcomingStudyObjective interface.
  */
@@ -91,6 +100,9 @@ function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
         'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
         'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
+        'access': json['access'] == null ? undefined : (0, StudyObjectiveAccess_1.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'])),
         'studySpaceTitle': json['studySpaceTitle'],
@@ -118,6 +130,9 @@ function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
+        'access': (0, StudyObjectiveAccess_1.StudyObjectiveAccessToJSON)(value['access']),
+        'learnerScope': value['learnerScope'],
+        'accessDisclosedState': value['accessDisclosedState'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
         'studySpaceTitle': value['studySpaceTitle'],

package/dist/models/index.d.ts

@@ -153,6 +153,7 @@ export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SharedQuiz';
 export * from './StudyObjective';
+export * from './StudyObjectiveAccess';
 export * from './StudyObjectiveCanvasDocument';
 export * from './StudyObjectiveConceptAttachment';
 export * from './StudyObjectiveConceptAttachmentList';

package/dist/models/index.js

@@ -171,6 +171,7 @@ __exportStar(require("./ScoreByTypeValue"), exports);
 __exportStar(require("./ServiceToken"), exports);
 __exportStar(require("./SharedQuiz"), exports);
 __exportStar(require("./StudyObjective"), exports);
+__exportStar(require("./StudyObjectiveAccess"), exports);
 __exportStar(require("./StudyObjectiveCanvasDocument"), exports);
 __exportStar(require("./StudyObjectiveConceptAttachment"), exports);
 __exportStar(require("./StudyObjectiveConceptAttachmentList"), exports);

package/package.json

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