@instructure/athena-api-client 3.44.0 → 3.45.0

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

@@ -88,13 +88,13 @@ export interface StudyObjectiveAccess {
      */
     moduleReadableFileCount: number | null;
     /**
-     * Files of a supported type published through Modules that are locked for the learner (one per file). Read only when readableFileCount is null, like moduleReadableFileCount. Null when modules could not be listed, and on facts read before rule 4.
+     * 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 produced `state`, for joining client analytics to the rule that was live.
+     * 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
      */
@@ -111,6 +111,12 @@ export interface StudyObjectiveAccess {
      * @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
@@ -149,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.
  */
@@ -80,6 +87,8 @@ export function instanceOfStudyObjectiveAccess(value) {
         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) {
@@ -106,6 +115,7 @@ export function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
         'ruleVersion': json['ruleVersion'],
         'readAt': (new Date(json['readAt'])),
         'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
+        'rosterSource': json['rosterSource'],
     };
 }
 export function StudyObjectiveAccessToJSON(json) {
@@ -132,5 +142,6 @@ export function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = fal
         'ruleVersion': value['ruleVersion'],
         'readAt': value['readAt'].toISOString(),
         'suggestedScope': value['suggestedScope'],
+        'rosterSource': value['rosterSource'],
     };
 }

package/dist/models/StudyObjectiveAccess.d.ts

@@ -88,13 +88,13 @@ export interface StudyObjectiveAccess {
      */
     moduleReadableFileCount: number | null;
     /**
-     * Files of a supported type published through Modules that are locked for the learner (one per file). Read only when readableFileCount is null, like moduleReadableFileCount. Null when modules could not be listed, and on facts read before rule 4.
+     * 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 produced `state`, for joining client analytics to the rule that was live.
+     * 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
      */
@@ -111,6 +111,12 @@ export interface StudyObjectiveAccess {
      * @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
@@ -149,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.
  */
@@ -88,6 +95,8 @@ function instanceOfStudyObjectiveAccess(value) {
         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) {
@@ -114,6 +123,7 @@ function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
         'ruleVersion': json['ruleVersion'],
         'readAt': (new Date(json['readAt'])),
         'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
+        'rosterSource': json['rosterSource'],
     };
 }
 function StudyObjectiveAccessToJSON(json) {
@@ -140,5 +150,6 @@ function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = false) {
         'ruleVersion': value['ruleVersion'],
         'readAt': value['readAt'].toISOString(),
         'suggestedScope': value['suggestedScope'],
+        'rosterSource': value['rosterSource'],
     };
 }

package/package.json

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