@instructure/athena-api-client 4.1.1 → 4.2.0

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

@@ -118,7 +118,7 @@ export interface 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.
+     * 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), 'syllabus' (no such item text, so the list was inferred from the course syllabus) 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 an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'syllabus' list as suggested from the syllabus; 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 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
      */
@@ -167,6 +167,7 @@ export type StudyObjectiveAccessSyllabusSourceEnum = typeof StudyObjectiveAccess
 export declare const StudyObjectiveAccessRosterSourceEnum: {
     readonly Title: "title";
     readonly Text: "text";
+    readonly Syllabus: "syllabus";
 };
 export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**

package/dist/esm/models/StudyObjectiveAccess.js

@@ -49,7 +49,8 @@ export const StudyObjectiveAccessSyllabusSourceEnum = {
  */
 export const StudyObjectiveAccessRosterSourceEnum = {
     Title: 'title',
-    Text: 'text'
+    Text: 'text',
+    Syllabus: 'syllabus'
 };
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.

package/dist/models/StudyObjectiveAccess.d.ts

@@ -118,7 +118,7 @@ export interface 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.
+     * 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), 'syllabus' (no such item text, so the list was inferred from the course syllabus) 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 an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'syllabus' list as suggested from the syllabus; 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 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
      */
@@ -167,6 +167,7 @@ export type StudyObjectiveAccessSyllabusSourceEnum = typeof StudyObjectiveAccess
 export declare const StudyObjectiveAccessRosterSourceEnum: {
     readonly Title: "title";
     readonly Text: "text";
+    readonly Syllabus: "syllabus";
 };
 export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**

package/dist/models/StudyObjectiveAccess.js

@@ -57,7 +57,8 @@ exports.StudyObjectiveAccessSyllabusSourceEnum = {
  */
 exports.StudyObjectiveAccessRosterSourceEnum = {
     Title: 'title',
-    Text: 'text'
+    Text: 'text',
+    Syllabus: 'syllabus'
 };
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.

package/package.json

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