@instructure/athena-api-client 3.38.3 → 3.38.5

package/dist/esm/models/AdminQuizSourceFile.js

@@ -0,0 +1,82 @@
+/* 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 AdminQuizSourceFileOriginEnum = {
+    StudyObjective: 'study-objective',
+    ChatAttachment: 'chat-attachment'
+};
+/**
+ * @export
+ */
+export const AdminQuizSourceFileDropReasonEnum = {
+    UnsupportedMediaType: 'unsupported-media-type',
+    Unreadable: 'unreadable',
+    IndeterminateSize: 'indeterminate-size',
+    PerFileBytes: 'per-file-bytes',
+    PerFileTokens: 'per-file-tokens',
+    MaxFiles: 'max-files',
+    TotalTokens: 'total-tokens'
+};
+/**
+ * Check if a given object implements the AdminQuizSourceFile interface.
+ */
+export function instanceOfAdminQuizSourceFile(value) {
+    if (!('origin' in value) || value['origin'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('mediaType' in value) || value['mediaType'] === undefined)
+        return false;
+    if (!('sizeBytes' in value) || value['sizeBytes'] === undefined)
+        return false;
+    if (!('included' in value) || value['included'] === undefined)
+        return false;
+    if (!('dropReason' in value) || value['dropReason'] === undefined)
+        return false;
+    return true;
+}
+export function AdminQuizSourceFileFromJSON(json) {
+    return AdminQuizSourceFileFromJSONTyped(json, false);
+}
+export function AdminQuizSourceFileFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'origin': json['origin'],
+        'name': json['name'],
+        'mediaType': json['mediaType'],
+        'sizeBytes': json['sizeBytes'],
+        'included': json['included'],
+        'dropReason': json['dropReason'],
+    };
+}
+export function AdminQuizSourceFileToJSON(json) {
+    return AdminQuizSourceFileToJSONTyped(json, false);
+}
+export function AdminQuizSourceFileToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'origin': value['origin'],
+        'name': value['name'],
+        'mediaType': value['mediaType'],
+        'sizeBytes': value['sizeBytes'],
+        'included': value['included'],
+        'dropReason': value['dropReason'],
+    };
+}

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

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ */
+import type { AdminQuizSourceFile } from './AdminQuizSourceFile';
+/**
+ *
+ * @export
+ * @interface AdminQuizSourceMaterial
+ */
+export interface AdminQuizSourceMaterial {
+    /**
+     * Always true: the selection is recomputed, not stored
+     * @type {boolean}
+     * @memberof AdminQuizSourceMaterial
+     */
+    reconstructed: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminQuizSourceMaterial
+     */
+    reconstructedAt: Date;
+    /**
+     *
+     * @type {Array<AdminQuizSourceFile>}
+     * @memberof AdminQuizSourceMaterial
+     */
+    files: Array<AdminQuizSourceFile>;
+}
+/**
+ * Check if a given object implements the AdminQuizSourceMaterial interface.
+ */
+export declare function instanceOfAdminQuizSourceMaterial(value: object): value is AdminQuizSourceMaterial;
+export declare function AdminQuizSourceMaterialFromJSON(json: any): AdminQuizSourceMaterial;
+export declare function AdminQuizSourceMaterialFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminQuizSourceMaterial;
+export declare function AdminQuizSourceMaterialToJSON(json: any): AdminQuizSourceMaterial;
+export declare function AdminQuizSourceMaterialToJSONTyped(value?: AdminQuizSourceMaterial | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminQuizSourceMaterial.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+import { AdminQuizSourceFileFromJSON, AdminQuizSourceFileToJSON, } from './AdminQuizSourceFile';
+/**
+ * Check if a given object implements the AdminQuizSourceMaterial interface.
+ */
+export function instanceOfAdminQuizSourceMaterial(value) {
+    if (!('reconstructed' in value) || value['reconstructed'] === undefined)
+        return false;
+    if (!('reconstructedAt' in value) || value['reconstructedAt'] === undefined)
+        return false;
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    return true;
+}
+export function AdminQuizSourceMaterialFromJSON(json) {
+    return AdminQuizSourceMaterialFromJSONTyped(json, false);
+}
+export function AdminQuizSourceMaterialFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reconstructed': json['reconstructed'],
+        'reconstructedAt': (new Date(json['reconstructedAt'])),
+        'files': (json['files'].map(AdminQuizSourceFileFromJSON)),
+    };
+}
+export function AdminQuizSourceMaterialToJSON(json) {
+    return AdminQuizSourceMaterialToJSONTyped(json, false);
+}
+export function AdminQuizSourceMaterialToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reconstructed': value['reconstructed'],
+        'reconstructedAt': value['reconstructedAt'].toISOString(),
+        'files': (value['files'].map(AdminQuizSourceFileToJSON)),
+    };
+}

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

@@ -1,7 +1,20 @@
 export * from './Account';
 export * from './AdminActiveStreak';
+export * from './AdminCanvasCall';
+export * from './AdminCanvasCourse';
+export * from './AdminCanvasFile';
+export * from './AdminCanvasFileAnalysis';
+export * from './AdminCanvasFileInContext';
+export * from './AdminCanvasFileModuleRef';
+export * from './AdminCanvasItem';
+export * from './AdminCanvasItemId';
+export * from './AdminCanvasModule';
+export * from './AdminCanvasModuleItem';
+export * from './AdminCanvasUsageFirstSeen';
+export * from './AdminCanvasUsageSummary';
 export * from './AdminChat';
 export * from './AdminChatAnalysis';
+export * from './AdminChatCanvasUsage';
 export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
 export * from './AdminExchangeChat';
@@ -14,8 +27,12 @@ export * from './AdminPaginatedQuizSessions';
 export * from './AdminPaginatedStudyObjectiveUserCounts';
 export * from './AdminPaginatedStudyObjectives';
 export * from './AdminPaginatedTaxonomyEnrollments';
+export * from './AdminQuizGeneration';
+export * from './AdminQuizGenerationInput';
 export * from './AdminQuizSessionListItem';
 export * from './AdminQuizSessionScore';
+export * from './AdminQuizSourceFile';
+export * from './AdminQuizSourceMaterial';
 export * from './AdminResetLearningDataResponse';
 export * from './AdminStreak';
 export * from './AdminStudyObjectiveCanvasTypeCount';

package/dist/esm/models/index.js

@@ -2,8 +2,21 @@
 /* eslint-disable */
 export * from './Account';
 export * from './AdminActiveStreak';
+export * from './AdminCanvasCall';
+export * from './AdminCanvasCourse';
+export * from './AdminCanvasFile';
+export * from './AdminCanvasFileAnalysis';
+export * from './AdminCanvasFileInContext';
+export * from './AdminCanvasFileModuleRef';
+export * from './AdminCanvasItem';
+export * from './AdminCanvasItemId';
+export * from './AdminCanvasModule';
+export * from './AdminCanvasModuleItem';
+export * from './AdminCanvasUsageFirstSeen';
+export * from './AdminCanvasUsageSummary';
 export * from './AdminChat';
 export * from './AdminChatAnalysis';
+export * from './AdminChatCanvasUsage';
 export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
 export * from './AdminExchangeChat';
@@ -16,8 +29,12 @@ export * from './AdminPaginatedQuizSessions';
 export * from './AdminPaginatedStudyObjectiveUserCounts';
 export * from './AdminPaginatedStudyObjectives';
 export * from './AdminPaginatedTaxonomyEnrollments';
+export * from './AdminQuizGeneration';
+export * from './AdminQuizGenerationInput';
 export * from './AdminQuizSessionListItem';
 export * from './AdminQuizSessionScore';
+export * from './AdminQuizSourceFile';
+export * from './AdminQuizSourceMaterial';
 export * from './AdminResetLearningDataResponse';
 export * from './AdminStreak';
 export * from './AdminStudyObjectiveCanvasTypeCount';

package/dist/models/AdminCanvasCall.d.ts

@@ -0,0 +1,134 @@
+/**
+ * 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 AdminCanvasCall
+ */
+export interface AdminCanvasCall {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCall
+     */
+    messageId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminCanvasCall
+     */
+    messageCreatedAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCall
+     */
+    toolCallId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCall
+     */
+    path: string;
+    /**
+     * Query params the model passed with the request
+     * @type {{ [key: string]: any; }}
+     * @memberof AdminCanvasCall
+     */
+    params: {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCall
+     */
+    resourceKind: AdminCanvasCallResourceKindEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasCall
+     */
+    courseId: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCall
+     */
+    status: AdminCanvasCallStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasCall
+     */
+    httpStatus: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCall
+     */
+    errorMessage: string | null;
+    /**
+     * The course Files index was refused and module file candidates were returned instead
+     * @type {boolean}
+     * @memberof AdminCanvasCall
+     */
+    filesTabHiddenRecovery: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdminCanvasCall
+     */
+    hasMore: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasCall
+     */
+    resultItemCount: number | null;
+}
+/**
+ * @export
+ */
+export declare const AdminCanvasCallResourceKindEnum: {
+    readonly Courses: "courses";
+    readonly Course: "course";
+    readonly Modules: "modules";
+    readonly ModuleItems: "module-items";
+    readonly Files: "files";
+    readonly File: "file";
+    readonly Pages: "pages";
+    readonly Page: "page";
+    readonly Assignments: "assignments";
+    readonly Assignment: "assignment";
+    readonly Quizzes: "quizzes";
+    readonly Quiz: "quiz";
+    readonly Other: "other";
+};
+export type AdminCanvasCallResourceKindEnum = typeof AdminCanvasCallResourceKindEnum[keyof typeof AdminCanvasCallResourceKindEnum];
+/**
+ * @export
+ */
+export declare const AdminCanvasCallStatusEnum: {
+    readonly Success: "success";
+    readonly Error: "error";
+    readonly Incomplete: "incomplete";
+};
+export type AdminCanvasCallStatusEnum = typeof AdminCanvasCallStatusEnum[keyof typeof AdminCanvasCallStatusEnum];
+/**
+ * Check if a given object implements the AdminCanvasCall interface.
+ */
+export declare function instanceOfAdminCanvasCall(value: object): value is AdminCanvasCall;
+export declare function AdminCanvasCallFromJSON(json: any): AdminCanvasCall;
+export declare function AdminCanvasCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasCall;
+export declare function AdminCanvasCallToJSON(json: any): AdminCanvasCall;
+export declare function AdminCanvasCallToJSONTyped(value?: AdminCanvasCall | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminCanvasCall.js

@@ -0,0 +1,125 @@
+"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.AdminCanvasCallStatusEnum = exports.AdminCanvasCallResourceKindEnum = void 0;
+exports.instanceOfAdminCanvasCall = instanceOfAdminCanvasCall;
+exports.AdminCanvasCallFromJSON = AdminCanvasCallFromJSON;
+exports.AdminCanvasCallFromJSONTyped = AdminCanvasCallFromJSONTyped;
+exports.AdminCanvasCallToJSON = AdminCanvasCallToJSON;
+exports.AdminCanvasCallToJSONTyped = AdminCanvasCallToJSONTyped;
+/**
+ * @export
+ */
+exports.AdminCanvasCallResourceKindEnum = {
+    Courses: 'courses',
+    Course: 'course',
+    Modules: 'modules',
+    ModuleItems: 'module-items',
+    Files: 'files',
+    File: 'file',
+    Pages: 'pages',
+    Page: 'page',
+    Assignments: 'assignments',
+    Assignment: 'assignment',
+    Quizzes: 'quizzes',
+    Quiz: 'quiz',
+    Other: 'other'
+};
+/**
+ * @export
+ */
+exports.AdminCanvasCallStatusEnum = {
+    Success: 'success',
+    Error: 'error',
+    Incomplete: 'incomplete'
+};
+/**
+ * Check if a given object implements the AdminCanvasCall interface.
+ */
+function instanceOfAdminCanvasCall(value) {
+    if (!('messageId' in value) || value['messageId'] === undefined)
+        return false;
+    if (!('messageCreatedAt' in value) || value['messageCreatedAt'] === undefined)
+        return false;
+    if (!('toolCallId' in value) || value['toolCallId'] === undefined)
+        return false;
+    if (!('path' in value) || value['path'] === undefined)
+        return false;
+    if (!('params' in value) || value['params'] === undefined)
+        return false;
+    if (!('resourceKind' in value) || value['resourceKind'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('httpStatus' in value) || value['httpStatus'] === undefined)
+        return false;
+    if (!('errorMessage' in value) || value['errorMessage'] === undefined)
+        return false;
+    if (!('filesTabHiddenRecovery' in value) || value['filesTabHiddenRecovery'] === undefined)
+        return false;
+    if (!('hasMore' in value) || value['hasMore'] === undefined)
+        return false;
+    if (!('resultItemCount' in value) || value['resultItemCount'] === undefined)
+        return false;
+    return true;
+}
+function AdminCanvasCallFromJSON(json) {
+    return AdminCanvasCallFromJSONTyped(json, false);
+}
+function AdminCanvasCallFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'messageId': json['messageId'],
+        'messageCreatedAt': (new Date(json['messageCreatedAt'])),
+        'toolCallId': json['toolCallId'],
+        'path': json['path'],
+        'params': json['params'],
+        'resourceKind': json['resourceKind'],
+        'courseId': json['courseId'],
+        'status': json['status'],
+        'httpStatus': json['httpStatus'],
+        'errorMessage': json['errorMessage'],
+        'filesTabHiddenRecovery': json['filesTabHiddenRecovery'],
+        'hasMore': json['hasMore'],
+        'resultItemCount': json['resultItemCount'],
+    };
+}
+function AdminCanvasCallToJSON(json) {
+    return AdminCanvasCallToJSONTyped(json, false);
+}
+function AdminCanvasCallToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'messageId': value['messageId'],
+        'messageCreatedAt': value['messageCreatedAt'].toISOString(),
+        'toolCallId': value['toolCallId'],
+        'path': value['path'],
+        'params': value['params'],
+        'resourceKind': value['resourceKind'],
+        'courseId': value['courseId'],
+        'status': value['status'],
+        'httpStatus': value['httpStatus'],
+        'errorMessage': value['errorMessage'],
+        'filesTabHiddenRecovery': value['filesTabHiddenRecovery'],
+        'hasMore': value['hasMore'],
+        'resultItemCount': value['resultItemCount'],
+    };
+}

package/dist/models/AdminCanvasCourse.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+import type { AdminCanvasUsageFirstSeen } from './AdminCanvasUsageFirstSeen';
+/**
+ *
+ * @export
+ * @interface AdminCanvasCourse
+ */
+export interface AdminCanvasCourse {
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasCourse
+     */
+    courseId: number;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCourse
+     */
+    name: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasCourse
+     */
+    courseCode: string | null;
+    /**
+     *
+     * @type {AdminCanvasUsageFirstSeen}
+     * @memberof AdminCanvasCourse
+     */
+    firstSeen: AdminCanvasUsageFirstSeen;
+    /**
+     * Every field Canvas returned for this object, merged across calls. Signed download URLs are removed or redacted.
+     * @type {{ [key: string]: any; }}
+     * @memberof AdminCanvasCourse
+     */
+    canvas: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the AdminCanvasCourse interface.
+ */
+export declare function instanceOfAdminCanvasCourse(value: object): value is AdminCanvasCourse;
+export declare function AdminCanvasCourseFromJSON(json: any): AdminCanvasCourse;
+export declare function AdminCanvasCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasCourse;
+export declare function AdminCanvasCourseToJSON(json: any): AdminCanvasCourse;
+export declare function AdminCanvasCourseToJSONTyped(value?: AdminCanvasCourse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminCanvasCourse.js

@@ -0,0 +1,67 @@
+"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.instanceOfAdminCanvasCourse = instanceOfAdminCanvasCourse;
+exports.AdminCanvasCourseFromJSON = AdminCanvasCourseFromJSON;
+exports.AdminCanvasCourseFromJSONTyped = AdminCanvasCourseFromJSONTyped;
+exports.AdminCanvasCourseToJSON = AdminCanvasCourseToJSON;
+exports.AdminCanvasCourseToJSONTyped = AdminCanvasCourseToJSONTyped;
+const AdminCanvasUsageFirstSeen_1 = require("./AdminCanvasUsageFirstSeen");
+/**
+ * Check if a given object implements the AdminCanvasCourse interface.
+ */
+function instanceOfAdminCanvasCourse(value) {
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('courseCode' in value) || value['courseCode'] === undefined)
+        return false;
+    if (!('firstSeen' in value) || value['firstSeen'] === undefined)
+        return false;
+    if (!('canvas' in value) || value['canvas'] === undefined)
+        return false;
+    return true;
+}
+function AdminCanvasCourseFromJSON(json) {
+    return AdminCanvasCourseFromJSONTyped(json, false);
+}
+function AdminCanvasCourseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseId': json['courseId'],
+        'name': json['name'],
+        'courseCode': json['courseCode'],
+        'firstSeen': (0, AdminCanvasUsageFirstSeen_1.AdminCanvasUsageFirstSeenFromJSON)(json['firstSeen']),
+        'canvas': json['canvas'],
+    };
+}
+function AdminCanvasCourseToJSON(json) {
+    return AdminCanvasCourseToJSONTyped(json, false);
+}
+function AdminCanvasCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'courseId': value['courseId'],
+        'name': value['name'],
+        'courseCode': value['courseCode'],
+        'firstSeen': (0, AdminCanvasUsageFirstSeen_1.AdminCanvasUsageFirstSeenToJSON)(value['firstSeen']),
+        'canvas': value['canvas'],
+    };
+}