@instructure/athena-api-client 3.42.2 → 3.44.0

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

@@ -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';
@@ -153,6 +154,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

@@ -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);
@@ -171,6 +172,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.2",
+  "version": "3.44.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {