@instructure/athena-api-client 3.27.1 → 3.28.0

package/README.md

@@ -74,6 +74,7 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminResetUserLearningData**](docs/AdminApi.md#adminresetuserlearningdata) | **POST** /api/v1/admin/users/{externalId}/reset-learning-data | Reset a user\'s Athena learning data to a blank slate
 *AdminApi* | [**adminTriggerChatAnalysis**](docs/AdminApi.md#admintriggerchatanalysis) | **POST** /api/v1/admin/chats/{chatId}/analyze | Trigger re-analysis for a chat
 *AdminApi* | [**adminUpdateChat**](docs/AdminApi.md#adminupdatechatoperation) | **PATCH** /api/v1/admin/chats/{chatId} | Update a chat (admin)
+*CanvasCourseAccessApi* | [**getCanvasCourseAccess**](docs/CanvasCourseAccessApi.md#getcanvascourseaccess) | **GET** /api/v1/canvas/course-access | Read the Canvas course-access map Athena is enforcing
 *CanvasDomainSearchApi* | [**searchCanvasDomain**](docs/CanvasDomainSearchApi.md#searchcanvasdomain) | **POST** /api/v1/canvas/domain-search | AI-ranked Canvas domain search
 *ChatAnalysisApi* | [**getChatAnalysis**](docs/ChatAnalysisApi.md#getchatanalysis) | **GET** /api/v1/chats/{chatId}/analysis | Get chat analysis
 *ChatsApi* | [**createChat**](docs/ChatsApi.md#createchatoperation) | **POST** /api/v1/chats | Create a chat
@@ -207,6 +208,7 @@ All URIs are relative to *http://localhost:3000*
 - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
 - [AdminUserEngagement](docs/AdminUserEngagement.md)
 - [AssociateUserFileRequest](docs/AssociateUserFileRequest.md)
+- [CanvasCourseAccess](docs/CanvasCourseAccess.md)
 - [CanvasDomainMatch](docs/CanvasDomainMatch.md)
 - [CanvasDomainSearchDto](docs/CanvasDomainSearchDto.md)
 - [CanvasDomainSearchResponse](docs/CanvasDomainSearchResponse.md)

package/dist/apis/CanvasCourseAccessApi.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { CanvasCourseAccess } from '../models/index';
+export interface GetCanvasCourseAccessRequest {
+    xCanvasDomain: string;
+    xCanvasToken: string;
+    xUserId: string;
+    force?: boolean;
+}
+/**
+ *
+ */
+export declare class CanvasCourseAccessApi extends runtime.BaseAPI {
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccessRaw(requestParameters: GetCanvasCourseAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasCourseAccess>>;
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccess(requestParameters: GetCanvasCourseAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasCourseAccess>;
+}

package/dist/apis/CanvasCourseAccessApi.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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanvasCourseAccessApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class CanvasCourseAccessApi extends runtime.BaseAPI {
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling getCanvasCourseAccess().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling getCanvasCourseAccess().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getCanvasCourseAccess().');
+            }
+            const queryParameters = {};
+            if (requestParameters['force'] != null) {
+                queryParameters['force'] = requestParameters['force'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            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/canvas/course-access`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasCourseAccessFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCanvasCourseAccessRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.CanvasCourseAccessApi = CanvasCourseAccessApi;

package/dist/apis/index.d.ts

@@ -1,5 +1,6 @@
 export * from './AccountsApi';
 export * from './AdminApi';
+export * from './CanvasCourseAccessApi';
 export * from './CanvasDomainSearchApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';

package/dist/apis/index.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable */
 __exportStar(require("./AccountsApi"), exports);
 __exportStar(require("./AdminApi"), exports);
+__exportStar(require("./CanvasCourseAccessApi"), exports);
 __exportStar(require("./CanvasDomainSearchApi"), exports);
 __exportStar(require("./ChatAnalysisApi"), exports);
 __exportStar(require("./ChatsApi"), exports);

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

@@ -0,0 +1,34 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { CanvasCourseAccess } from '../models/index';
+export interface GetCanvasCourseAccessRequest {
+    xCanvasDomain: string;
+    xCanvasToken: string;
+    xUserId: string;
+    force?: boolean;
+}
+/**
+ *
+ */
+export declare class CanvasCourseAccessApi extends runtime.BaseAPI {
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccessRaw(requestParameters: GetCanvasCourseAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasCourseAccess>>;
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccess(requestParameters: GetCanvasCourseAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasCourseAccess>;
+}

package/dist/esm/apis/CanvasCourseAccessApi.js

@@ -0,0 +1,81 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CanvasCourseAccessFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class CanvasCourseAccessApi extends runtime.BaseAPI {
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling getCanvasCourseAccess().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling getCanvasCourseAccess().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getCanvasCourseAccess().');
+            }
+            const queryParameters = {};
+            if (requestParameters['force'] != null) {
+                queryParameters['force'] = requestParameters['force'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            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/canvas/course-access`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CanvasCourseAccessFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns which of the learner\'s Canvas courses Athena may read, as resolved from Canvas and interpreted by this service, along with where the map came from and when Canvas resolved it. Pass `force=true` to skip this service\'s cache and ask Canvas to skip its own, which is how a feature-flag change is confirmed without waiting out both cache windows.
+     * Read the Canvas course-access map Athena is enforcing
+     */
+    getCanvasCourseAccess(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCanvasCourseAccessRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -1,5 +1,6 @@
 export * from './AccountsApi';
 export * from './AdminApi';
+export * from './CanvasCourseAccessApi';
 export * from './CanvasDomainSearchApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';

package/dist/esm/apis/index.js

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './AccountsApi';
 export * from './AdminApi';
+export * from './CanvasCourseAccessApi';
 export * from './CanvasDomainSearchApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';

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

@@ -0,0 +1,56 @@
+/**
+ * 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 CanvasCourseAccess
+ */
+export interface CanvasCourseAccess {
+    /**
+     * Canvas course id → whether Athena may read that course, exactly as Canvas resolved it. Null when no map has ever been resolved for this learner and domain, in which case every course is treated as enabled. A course absent from a non-null map is also treated as enabled.
+     * @type {{ [key: string]: boolean; }}
+     * @memberof CanvasCourseAccess
+     */
+    courses: {
+        [key: string]: boolean;
+    } | null;
+    /**
+     * Where this map came from: freshly fetched from Canvas, served from cache, the last known state after a failed refresh (a true entry is honored only as default-on), or never fetched at all.
+     * @type {string}
+     * @memberof CanvasCourseAccess
+     */
+    source: CanvasCourseAccessSourceEnum;
+    /**
+     * When Canvas resolved this map. Null when no map has ever been resolved.
+     * @type {Date}
+     * @memberof CanvasCourseAccess
+     */
+    fetchedAt: Date | null;
+}
+/**
+ * @export
+ */
+export declare const CanvasCourseAccessSourceEnum: {
+    readonly Fresh: "fresh";
+    readonly Cached: "cached";
+    readonly Stale: "stale";
+    readonly Unknown: "unknown";
+};
+export type CanvasCourseAccessSourceEnum = typeof CanvasCourseAccessSourceEnum[keyof typeof CanvasCourseAccessSourceEnum];
+/**
+ * Check if a given object implements the CanvasCourseAccess interface.
+ */
+export declare function instanceOfCanvasCourseAccess(value: object): value is CanvasCourseAccess;
+export declare function CanvasCourseAccessFromJSON(json: any): CanvasCourseAccess;
+export declare function CanvasCourseAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasCourseAccess;
+export declare function CanvasCourseAccessToJSON(json: any): CanvasCourseAccess;
+export declare function CanvasCourseAccessToJSONTyped(value?: CanvasCourseAccess | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CanvasCourseAccess.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.
+ */
+/**
+ * @export
+ */
+export const CanvasCourseAccessSourceEnum = {
+    Fresh: 'fresh',
+    Cached: 'cached',
+    Stale: 'stale',
+    Unknown: 'unknown'
+};
+/**
+ * Check if a given object implements the CanvasCourseAccess interface.
+ */
+export function instanceOfCanvasCourseAccess(value) {
+    if (!('courses' in value) || value['courses'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('fetchedAt' in value) || value['fetchedAt'] === undefined)
+        return false;
+    return true;
+}
+export function CanvasCourseAccessFromJSON(json) {
+    return CanvasCourseAccessFromJSONTyped(json, false);
+}
+export function CanvasCourseAccessFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courses': json['courses'],
+        'source': json['source'],
+        'fetchedAt': (json['fetchedAt'] == null ? null : new Date(json['fetchedAt'])),
+    };
+}
+export function CanvasCourseAccessToJSON(json) {
+    return CanvasCourseAccessToJSONTyped(json, false);
+}
+export function CanvasCourseAccessToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'courses': value['courses'],
+        'source': value['source'],
+        'fetchedAt': value['fetchedAt'] == null ? value['fetchedAt'] : value['fetchedAt'].toISOString(),
+    };
+}

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

@@ -25,6 +25,7 @@ export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
 export * from './AssociateUserFileRequest';
+export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';
 export * from './CanvasDomainSearchDto';
 export * from './CanvasDomainSearchResponse';

package/dist/esm/models/index.js

@@ -27,6 +27,7 @@ export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
 export * from './AssociateUserFileRequest';
+export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';
 export * from './CanvasDomainSearchDto';
 export * from './CanvasDomainSearchResponse';

package/dist/models/CanvasCourseAccess.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 CanvasCourseAccess
+ */
+export interface CanvasCourseAccess {
+    /**
+     * Canvas course id → whether Athena may read that course, exactly as Canvas resolved it. Null when no map has ever been resolved for this learner and domain, in which case every course is treated as enabled. A course absent from a non-null map is also treated as enabled.
+     * @type {{ [key: string]: boolean; }}
+     * @memberof CanvasCourseAccess
+     */
+    courses: {
+        [key: string]: boolean;
+    } | null;
+    /**
+     * Where this map came from: freshly fetched from Canvas, served from cache, the last known state after a failed refresh (a true entry is honored only as default-on), or never fetched at all.
+     * @type {string}
+     * @memberof CanvasCourseAccess
+     */
+    source: CanvasCourseAccessSourceEnum;
+    /**
+     * When Canvas resolved this map. Null when no map has ever been resolved.
+     * @type {Date}
+     * @memberof CanvasCourseAccess
+     */
+    fetchedAt: Date | null;
+}
+/**
+ * @export
+ */
+export declare const CanvasCourseAccessSourceEnum: {
+    readonly Fresh: "fresh";
+    readonly Cached: "cached";
+    readonly Stale: "stale";
+    readonly Unknown: "unknown";
+};
+export type CanvasCourseAccessSourceEnum = typeof CanvasCourseAccessSourceEnum[keyof typeof CanvasCourseAccessSourceEnum];
+/**
+ * Check if a given object implements the CanvasCourseAccess interface.
+ */
+export declare function instanceOfCanvasCourseAccess(value: object): value is CanvasCourseAccess;
+export declare function CanvasCourseAccessFromJSON(json: any): CanvasCourseAccess;
+export declare function CanvasCourseAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasCourseAccess;
+export declare function CanvasCourseAccessToJSON(json: any): CanvasCourseAccess;
+export declare function CanvasCourseAccessToJSONTyped(value?: CanvasCourseAccess | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CanvasCourseAccess.js

@@ -0,0 +1,68 @@
+"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.CanvasCourseAccessSourceEnum = void 0;
+exports.instanceOfCanvasCourseAccess = instanceOfCanvasCourseAccess;
+exports.CanvasCourseAccessFromJSON = CanvasCourseAccessFromJSON;
+exports.CanvasCourseAccessFromJSONTyped = CanvasCourseAccessFromJSONTyped;
+exports.CanvasCourseAccessToJSON = CanvasCourseAccessToJSON;
+exports.CanvasCourseAccessToJSONTyped = CanvasCourseAccessToJSONTyped;
+/**
+ * @export
+ */
+exports.CanvasCourseAccessSourceEnum = {
+    Fresh: 'fresh',
+    Cached: 'cached',
+    Stale: 'stale',
+    Unknown: 'unknown'
+};
+/**
+ * Check if a given object implements the CanvasCourseAccess interface.
+ */
+function instanceOfCanvasCourseAccess(value) {
+    if (!('courses' in value) || value['courses'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('fetchedAt' in value) || value['fetchedAt'] === undefined)
+        return false;
+    return true;
+}
+function CanvasCourseAccessFromJSON(json) {
+    return CanvasCourseAccessFromJSONTyped(json, false);
+}
+function CanvasCourseAccessFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courses': json['courses'],
+        'source': json['source'],
+        'fetchedAt': (json['fetchedAt'] == null ? null : new Date(json['fetchedAt'])),
+    };
+}
+function CanvasCourseAccessToJSON(json) {
+    return CanvasCourseAccessToJSONTyped(json, false);
+}
+function CanvasCourseAccessToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'courses': value['courses'],
+        'source': value['source'],
+        'fetchedAt': value['fetchedAt'] == null ? value['fetchedAt'] : value['fetchedAt'].toISOString(),
+    };
+}

package/dist/models/index.d.ts

@@ -25,6 +25,7 @@ export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
 export * from './AssociateUserFileRequest';
+export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';
 export * from './CanvasDomainSearchDto';
 export * from './CanvasDomainSearchResponse';

package/dist/models/index.js

@@ -43,6 +43,7 @@ __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
 __exportStar(require("./AdminUpdateChatRequest"), exports);
 __exportStar(require("./AdminUserEngagement"), exports);
 __exportStar(require("./AssociateUserFileRequest"), exports);
+__exportStar(require("./CanvasCourseAccess"), exports);
 __exportStar(require("./CanvasDomainMatch"), exports);
 __exportStar(require("./CanvasDomainSearchDto"), exports);
 __exportStar(require("./CanvasDomainSearchResponse"), exports);

package/package.json

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