@instructure/athena-api-client 3.42.2 → 3.44.0

package/dist/models/QuizBasisSnapshot.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 QuizBasisSnapshot
+ */
+export interface QuizBasisSnapshot {
+    /**
+     * What the questions were actually built from: 'learner-materials' (the learner's own files, which the generator reports using), 'course-material' (course files read from Canvas, same test), 'learner-scope' (what the learner said the assessment covers), or 'general' (practice on the subject).
+     * @type {string}
+     * @memberof QuizBasisSnapshot
+     */
+    basis: QuizBasisSnapshotBasisEnum;
+    /**
+     * A learner file was in play but never reached the generator (it could not be read, or generation retried without it).
+     * @type {boolean}
+     * @memberof QuizBasisSnapshot
+     */
+    droppedFile: boolean;
+    /**
+     * Whether anything said what the assessment covers when the quiz was generated.
+     * @type {boolean}
+     * @memberof QuizBasisSnapshot
+     */
+    scopeKnown: boolean;
+    /**
+     * The course's access state at generation time; null when none was read.
+     * @type {string}
+     * @memberof QuizBasisSnapshot
+     */
+    accessState: QuizBasisSnapshotAccessStateEnum | null;
+    /**
+     * The access rule version behind accessState; null with it.
+     * @type {number}
+     * @memberof QuizBasisSnapshot
+     */
+    ruleVersion: number | null;
+}
+/**
+ * @export
+ */
+export declare const QuizBasisSnapshotBasisEnum: {
+    readonly CourseMaterial: "course-material";
+    readonly LearnerMaterials: "learner-materials";
+    readonly LearnerScope: "learner-scope";
+    readonly General: "general";
+};
+export type QuizBasisSnapshotBasisEnum = typeof QuizBasisSnapshotBasisEnum[keyof typeof QuizBasisSnapshotBasisEnum];
+/**
+ * @export
+ */
+export declare const QuizBasisSnapshotAccessStateEnum: {
+    readonly Grounded: "grounded";
+    readonly Thin: "thin";
+    readonly Unreadable: "unreadable";
+    readonly Unknown: "unknown";
+};
+export type QuizBasisSnapshotAccessStateEnum = typeof QuizBasisSnapshotAccessStateEnum[keyof typeof QuizBasisSnapshotAccessStateEnum];
+/**
+ * Check if a given object implements the QuizBasisSnapshot interface.
+ */
+export declare function instanceOfQuizBasisSnapshot(value: object): value is QuizBasisSnapshot;
+export declare function QuizBasisSnapshotFromJSON(json: any): QuizBasisSnapshot;
+export declare function QuizBasisSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizBasisSnapshot;
+export declare function QuizBasisSnapshotToJSON(json: any): QuizBasisSnapshot;
+export declare function QuizBasisSnapshotToJSONTyped(value?: QuizBasisSnapshot | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizBasisSnapshot.js

@@ -0,0 +1,85 @@
+"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.QuizBasisSnapshotAccessStateEnum = exports.QuizBasisSnapshotBasisEnum = void 0;
+exports.instanceOfQuizBasisSnapshot = instanceOfQuizBasisSnapshot;
+exports.QuizBasisSnapshotFromJSON = QuizBasisSnapshotFromJSON;
+exports.QuizBasisSnapshotFromJSONTyped = QuizBasisSnapshotFromJSONTyped;
+exports.QuizBasisSnapshotToJSON = QuizBasisSnapshotToJSON;
+exports.QuizBasisSnapshotToJSONTyped = QuizBasisSnapshotToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizBasisSnapshotBasisEnum = {
+    CourseMaterial: 'course-material',
+    LearnerMaterials: 'learner-materials',
+    LearnerScope: 'learner-scope',
+    General: 'general'
+};
+/**
+ * @export
+ */
+exports.QuizBasisSnapshotAccessStateEnum = {
+    Grounded: 'grounded',
+    Thin: 'thin',
+    Unreadable: 'unreadable',
+    Unknown: 'unknown'
+};
+/**
+ * Check if a given object implements the QuizBasisSnapshot interface.
+ */
+function instanceOfQuizBasisSnapshot(value) {
+    if (!('basis' in value) || value['basis'] === undefined)
+        return false;
+    if (!('droppedFile' in value) || value['droppedFile'] === undefined)
+        return false;
+    if (!('scopeKnown' in value) || value['scopeKnown'] === undefined)
+        return false;
+    if (!('accessState' in value) || value['accessState'] === undefined)
+        return false;
+    if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
+        return false;
+    return true;
+}
+function QuizBasisSnapshotFromJSON(json) {
+    return QuizBasisSnapshotFromJSONTyped(json, false);
+}
+function QuizBasisSnapshotFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'basis': json['basis'],
+        'droppedFile': json['droppedFile'],
+        'scopeKnown': json['scopeKnown'],
+        'accessState': json['accessState'],
+        'ruleVersion': json['ruleVersion'],
+    };
+}
+function QuizBasisSnapshotToJSON(json) {
+    return QuizBasisSnapshotToJSONTyped(json, false);
+}
+function QuizBasisSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'basis': value['basis'],
+        'droppedFile': value['droppedFile'],
+        'scopeKnown': value['scopeKnown'],
+        'accessState': value['accessState'],
+        'ruleVersion': value['ruleVersion'],
+    };
+}

package/dist/models/QuizListItem.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { QuizBasisSnapshot } from './QuizBasisSnapshot';
 /**
  *
  * @export
@@ -63,6 +64,12 @@ export interface QuizListItem {
      * @memberof QuizListItem
      */
     expectedQuestionCount: number | null;
+    /**
+     * What this quiz was built from, recorded once with the quiz so a reload or a retake reads the same. Null for quizzes generated before it was recorded.
+     * @type {QuizBasisSnapshot}
+     * @memberof QuizListItem
+     */
+    basisSnapshot?: QuizBasisSnapshot | null;
     /**
      *
      * @type {Date}

package/dist/models/QuizListItem.js

@@ -19,6 +19,7 @@ exports.QuizListItemFromJSON = QuizListItemFromJSON;
 exports.QuizListItemFromJSONTyped = QuizListItemFromJSONTyped;
 exports.QuizListItemToJSON = QuizListItemToJSON;
 exports.QuizListItemToJSONTyped = QuizListItemToJSONTyped;
+const QuizBasisSnapshot_1 = require("./QuizBasisSnapshot");
 /**
  * @export
  */
@@ -76,6 +77,7 @@ function QuizListItemFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : (0, QuizBasisSnapshot_1.QuizBasisSnapshotFromJSON)(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
         'questionCount': json['questionCount'],
     };
@@ -96,6 +98,7 @@ function QuizListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': (0, QuizBasisSnapshot_1.QuizBasisSnapshotToJSON)(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
         'questionCount': value['questionCount'],
     };

package/dist/models/QuizWithQuestions.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { QuizQuestion } from './QuizQuestion';
+import type { QuizBasisSnapshot } from './QuizBasisSnapshot';
 /**
  *
  * @export
@@ -64,6 +65,12 @@ export interface QuizWithQuestions {
      * @memberof QuizWithQuestions
      */
     expectedQuestionCount: number | null;
+    /**
+     * What this quiz was built from, recorded once with the quiz so a reload or a retake reads the same. Null for quizzes generated before it was recorded.
+     * @type {QuizBasisSnapshot}
+     * @memberof QuizWithQuestions
+     */
+    basisSnapshot?: QuizBasisSnapshot | null;
     /**
      *
      * @type {Date}

package/dist/models/QuizWithQuestions.js

@@ -20,6 +20,7 @@ exports.QuizWithQuestionsFromJSONTyped = QuizWithQuestionsFromJSONTyped;
 exports.QuizWithQuestionsToJSON = QuizWithQuestionsToJSON;
 exports.QuizWithQuestionsToJSONTyped = QuizWithQuestionsToJSONTyped;
 const QuizQuestion_1 = require("./QuizQuestion");
+const QuizBasisSnapshot_1 = require("./QuizBasisSnapshot");
 /**
  * @export
  */
@@ -77,6 +78,7 @@ function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
         'mode': json['mode'],
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
+        'basisSnapshot': json['basisSnapshot'] == null ? undefined : (0, QuizBasisSnapshot_1.QuizBasisSnapshotFromJSON)(json['basisSnapshot']),
         'createdAt': (new Date(json['createdAt'])),
         'questions': (json['questions'].map(QuizQuestion_1.QuizQuestionFromJSON)),
     };
@@ -97,6 +99,7 @@ function QuizWithQuestionsToJSONTyped(value, ignoreDiscriminator = false) {
         'mode': value['mode'],
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
+        'basisSnapshot': (0, QuizBasisSnapshot_1.QuizBasisSnapshotToJSON)(value['basisSnapshot']),
         'createdAt': value['createdAt'].toISOString(),
         'questions': (value['questions'].map(QuizQuestion_1.QuizQuestionToJSON)),
     };

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,159 @@
+/**
+ * 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, or, when Canvas refused that list (rule 4 on), counted from the module's own File items. Null when the item is in no module, is another kind of item, or modules could not be listed.
+     * @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;
+    /**
+     * Readable files the course publishes through Modules (File items of a supported type, not locked for the learner; one per file). The file count to name only when readableFileCount is null (Canvas refused the course files list, e.g. a hidden Files tab); never add it to readableFileCount, since module links point at listed files. Null when modules could not be listed, and on facts read before rule 4.
+     * @type {number}
+     * @memberof 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.
+     * @type {number}
+     * @memberof StudyObjectiveAccess
+     */
+    moduleLockedFileCount: 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;
+    /**
+     * Topics the learner's syllabus schedule suggests this item covers, inferred by syllabus analysis, for the scope box to offer as Athena's best guess. Null while `scopeKnown` is true, when the learner has given a scope of their own, or when their syllabus suggests nothing. A suggestion is not evidence: it never sets `scopeKnown`.
+     * @type {Array<string>}
+     * @memberof StudyObjectiveAccess
+     */
+    suggestedScope: Array<string> | null;
+}
+/**
+ * @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,144 @@
+"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 (!('moduleReadableFileCount' in value) || value['moduleReadableFileCount'] === undefined)
+        return false;
+    if (!('moduleLockedFileCount' in value) || value['moduleLockedFileCount'] === undefined)
+        return false;
+    if (!('ruleVersion' in value) || value['ruleVersion'] === undefined)
+        return false;
+    if (!('readAt' in value) || value['readAt'] === undefined)
+        return false;
+    if (!('suggestedScope' in value) || value['suggestedScope'] === 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'],
+        'moduleReadableFileCount': json['moduleReadableFileCount'],
+        'moduleLockedFileCount': json['moduleLockedFileCount'],
+        'ruleVersion': json['ruleVersion'],
+        'readAt': (new Date(json['readAt'])),
+        'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
+    };
+}
+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'],
+        'moduleReadableFileCount': value['moduleReadableFileCount'],
+        'moduleLockedFileCount': value['moduleLockedFileCount'],
+        'ruleVersion': value['ruleVersion'],
+        'readAt': value['readAt'].toISOString(),
+        'suggestedScope': value['suggestedScope'],
+    };
+}