@instructure/athena-api-client 3.38.3 → 3.38.5

package/README.md

@@ -59,6 +59,7 @@ All URIs are relative to *http://localhost:3000*
 *AccountsApi* | [**updateAccount**](docs/AccountsApi.md#updateaccount) | **PATCH** /api/v1/accounts/{id} | Update an account
 *AdminApi* | [**adminGetChat**](docs/AdminApi.md#admingetchat) | **GET** /api/v1/admin/chats/{chatId} | Get any chat by ID within the account
 *AdminApi* | [**adminGetChatAnalysis**](docs/AdminApi.md#admingetchatanalysis) | **GET** /api/v1/admin/chats/{chatId}/analysis | Get chat analysis for any chat within the account
+*AdminApi* | [**adminGetChatCanvasUsage**](docs/AdminApi.md#admingetchatcanvasusage) | **GET** /api/v1/admin/chats/{chatId}/canvas-usage | Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
 *AdminApi* | [**adminGetCohortStats**](docs/AdminApi.md#admingetcohortstats) | **GET** /api/v1/admin/cohort-stats | Get cohort statistics for users created within a date range
 *AdminApi* | [**adminGetQuizSessionSummary**](docs/AdminApi.md#admingetquizsessionsummary) | **GET** /api/v1/admin/quiz-sessions/{sessionId}/summary | Get quiz session summary for any session within the account
 *AdminApi* | [**adminGetStudyObjectiveSummary**](docs/AdminApi.md#admingetstudyobjectivesummary) | **GET** /api/v1/admin/study-objectives/summary | Aggregate study-objective statistics across all account users
@@ -188,8 +189,21 @@ All URIs are relative to *http://localhost:3000*
 
 - [Account](docs/Account.md)
 - [AdminActiveStreak](docs/AdminActiveStreak.md)
+- [AdminCanvasCall](docs/AdminCanvasCall.md)
+- [AdminCanvasCourse](docs/AdminCanvasCourse.md)
+- [AdminCanvasFile](docs/AdminCanvasFile.md)
+- [AdminCanvasFileAnalysis](docs/AdminCanvasFileAnalysis.md)
+- [AdminCanvasFileInContext](docs/AdminCanvasFileInContext.md)
+- [AdminCanvasFileModuleRef](docs/AdminCanvasFileModuleRef.md)
+- [AdminCanvasItem](docs/AdminCanvasItem.md)
+- [AdminCanvasItemId](docs/AdminCanvasItemId.md)
+- [AdminCanvasModule](docs/AdminCanvasModule.md)
+- [AdminCanvasModuleItem](docs/AdminCanvasModuleItem.md)
+- [AdminCanvasUsageFirstSeen](docs/AdminCanvasUsageFirstSeen.md)
+- [AdminCanvasUsageSummary](docs/AdminCanvasUsageSummary.md)
 - [AdminChat](docs/AdminChat.md)
 - [AdminChatAnalysis](docs/AdminChatAnalysis.md)
+- [AdminChatCanvasUsage](docs/AdminChatCanvasUsage.md)
 - [AdminChatWithStats](docs/AdminChatWithStats.md)
 - [AdminCohortStats](docs/AdminCohortStats.md)
 - [AdminExchangeChat](docs/AdminExchangeChat.md)
@@ -202,8 +216,12 @@ All URIs are relative to *http://localhost:3000*
 - [AdminPaginatedStudyObjectiveUserCounts](docs/AdminPaginatedStudyObjectiveUserCounts.md)
 - [AdminPaginatedStudyObjectives](docs/AdminPaginatedStudyObjectives.md)
 - [AdminPaginatedTaxonomyEnrollments](docs/AdminPaginatedTaxonomyEnrollments.md)
+- [AdminQuizGeneration](docs/AdminQuizGeneration.md)
+- [AdminQuizGenerationInput](docs/AdminQuizGenerationInput.md)
 - [AdminQuizSessionListItem](docs/AdminQuizSessionListItem.md)
 - [AdminQuizSessionScore](docs/AdminQuizSessionScore.md)
+- [AdminQuizSourceFile](docs/AdminQuizSourceFile.md)
+- [AdminQuizSourceMaterial](docs/AdminQuizSourceMaterial.md)
 - [AdminResetLearningDataResponse](docs/AdminResetLearningDataResponse.md)
 - [AdminStreak](docs/AdminStreak.md)
 - [AdminStudyObjectiveCanvasTypeCount](docs/AdminStudyObjectiveCanvasTypeCount.md)

package/dist/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -19,6 +19,10 @@ export interface AdminGetChatAnalysisRequest {
     xUserId: string;
     chatId: string;
 }
+export interface AdminGetChatCanvasUsageRequest {
+    xUserId: string;
+    chatId: string;
+}
 export interface AdminGetCohortStatsRequest {
     xUserId: string;
     since: Date;
@@ -137,6 +141,14 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get chat analysis for any chat within the account
      */
     adminGetChatAnalysis(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChatAnalysis>;
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsageRaw(requestParameters: AdminGetChatCanvasUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminChatCanvasUsage>>;
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsage(requestParameters: AdminGetChatCanvasUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChatCanvasUsage>;
     /**
      * Get cohort statistics for users created within a date range
      */

package/dist/apis/AdminApi.js

@@ -107,6 +107,45 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetChatCanvasUsage().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling adminGetChatCanvasUsage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/chats/{chatId}/canvas-usage`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminChatCanvasUsageFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetChatCanvasUsageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Get cohort statistics for users created within a date range
      */

package/dist/esm/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -19,6 +19,10 @@ export interface AdminGetChatAnalysisRequest {
     xUserId: string;
     chatId: string;
 }
+export interface AdminGetChatCanvasUsageRequest {
+    xUserId: string;
+    chatId: string;
+}
 export interface AdminGetCohortStatsRequest {
     xUserId: string;
     since: Date;
@@ -137,6 +141,14 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get chat analysis for any chat within the account
      */
     adminGetChatAnalysis(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChatAnalysis>;
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsageRaw(requestParameters: AdminGetChatCanvasUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminChatCanvasUsage>>;
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsage(requestParameters: AdminGetChatCanvasUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChatCanvasUsage>;
     /**
      * Get cohort statistics for users created within a date range
      */

package/dist/esm/apis/AdminApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -104,6 +104,45 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling adminGetChatCanvasUsage().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling adminGetChatCanvasUsage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/admin/chats/{chatId}/canvas-usage`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminChatCanvasUsageFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get the Canvas courses, modules, files, and items a chat read, and the files in play for each quiz generation
+     */
+    adminGetChatCanvasUsage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetChatCanvasUsageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Get cohort statistics for users created within a date range
      */

package/dist/esm/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/esm/models/AdminCanvasCall.js

@@ -0,0 +1,117 @@
+/* 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 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
+ */
+export const AdminCanvasCallStatusEnum = {
+    Success: 'success',
+    Error: 'error',
+    Incomplete: 'incomplete'
+};
+/**
+ * Check if a given object implements the AdminCanvasCall interface.
+ */
+export 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;
+}
+export function AdminCanvasCallFromJSON(json) {
+    return AdminCanvasCallFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function AdminCanvasCallToJSON(json) {
+    return AdminCanvasCallToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/AdminCanvasCourse.js

@@ -0,0 +1,60 @@
+/* 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 { AdminCanvasUsageFirstSeenFromJSON, AdminCanvasUsageFirstSeenToJSON, } from './AdminCanvasUsageFirstSeen';
+/**
+ * Check if a given object implements the AdminCanvasCourse interface.
+ */
+export 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;
+}
+export function AdminCanvasCourseFromJSON(json) {
+    return AdminCanvasCourseFromJSONTyped(json, false);
+}
+export function AdminCanvasCourseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseId': json['courseId'],
+        'name': json['name'],
+        'courseCode': json['courseCode'],
+        'firstSeen': AdminCanvasUsageFirstSeenFromJSON(json['firstSeen']),
+        'canvas': json['canvas'],
+    };
+}
+export function AdminCanvasCourseToJSON(json) {
+    return AdminCanvasCourseToJSONTyped(json, false);
+}
+export function AdminCanvasCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'courseId': value['courseId'],
+        'name': value['name'],
+        'courseCode': value['courseCode'],
+        'firstSeen': AdminCanvasUsageFirstSeenToJSON(value['firstSeen']),
+        'canvas': value['canvas'],
+    };
+}