@instructure/athena-api-client 2.15.2 → 2.16.0

package/README.md

@@ -64,6 +64,7 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminGetUserEngagement**](docs/AdminApi.md#admingetuserengagement) | **GET** /api/v1/admin/users/{externalId}/engagement | Get engagement dates for a user
 *AdminApi* | [**adminListActiveStreaks**](docs/AdminApi.md#adminlistactivestreaks) | **GET** /api/v1/admin/streaks/active | List all active streaks (currentDays > 0) across the account, paginated
 *AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users
+*AdminApi* | [**adminListTaxonomyEnrollments**](docs/AdminApi.md#adminlisttaxonomyenrollments) | **GET** /api/v1/admin/taxonomy-enrollments | List all taxonomy enrollments across the account
 *AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
 *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)
@@ -141,7 +142,10 @@ All URIs are relative to *http://localhost:3000*
 - [AdminCohortStats](docs/AdminCohortStats.md)
 - [AdminPaginatedActiveStreaks](docs/AdminPaginatedActiveStreaks.md)
 - [AdminPaginatedChats](docs/AdminPaginatedChats.md)
+- [AdminPaginatedTaxonomyEnrollments](docs/AdminPaginatedTaxonomyEnrollments.md)
 - [AdminStreak](docs/AdminStreak.md)
+- [AdminTaxonomyEnrollment](docs/AdminTaxonomyEnrollment.md)
+- [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md)
 - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
 - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
 - [AdminUserEngagement](docs/AdminUserEngagement.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, AdminStreak, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -44,6 +44,11 @@ export interface AdminListChatsRequest {
     chatType?: string;
     forReview?: boolean;
 }
+export interface AdminListTaxonomyEnrollmentsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+}
 export interface AdminListTopStreaksRequest {
     xUserId: string;
     limit?: number;
@@ -117,6 +122,14 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List recent chats across all account users
      */
     adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedChats>;
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollmentsRaw(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedTaxonomyEnrollments>>;
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollments(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedTaxonomyEnrollments>;
     /**
      * List top N streaks across the account
      */

package/dist/apis/AdminApi.js

@@ -320,6 +320,47 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollmentsRaw(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 adminListTaxonomyEnrollments().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            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/taxonomy-enrollments`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminPaginatedTaxonomyEnrollmentsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollments(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListTaxonomyEnrollmentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List top N streaks across the account
      */

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, AdminStreak, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedTaxonomyEnrollments, AdminStreak, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -44,6 +44,11 @@ export interface AdminListChatsRequest {
     chatType?: string;
     forReview?: boolean;
 }
+export interface AdminListTaxonomyEnrollmentsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+}
 export interface AdminListTopStreaksRequest {
     xUserId: string;
     limit?: number;
@@ -117,6 +122,14 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List recent chats across all account users
      */
     adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedChats>;
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollmentsRaw(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedTaxonomyEnrollments>>;
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollments(requestParameters: AdminListTaxonomyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedTaxonomyEnrollments>;
     /**
      * List top N streaks across the account
      */

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, AdminStreakFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminStreakFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, } from '../models/index';
 /**
  *
  */
@@ -317,6 +317,47 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollmentsRaw(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 adminListTaxonomyEnrollments().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            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/taxonomy-enrollments`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminPaginatedTaxonomyEnrollmentsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List all taxonomy enrollments across the account
+     */
+    adminListTaxonomyEnrollments(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListTaxonomyEnrollmentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List top N streaks across the account
      */

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { AdminTaxonomyEnrollment } from './AdminTaxonomyEnrollment';
+/**
+ *
+ * @export
+ * @interface AdminPaginatedTaxonomyEnrollments
+ */
+export interface AdminPaginatedTaxonomyEnrollments {
+    /**
+     *
+     * @type {Array<AdminTaxonomyEnrollment>}
+     * @memberof AdminPaginatedTaxonomyEnrollments
+     */
+    data: Array<AdminTaxonomyEnrollment>;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminPaginatedTaxonomyEnrollments
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the AdminPaginatedTaxonomyEnrollments interface.
+ */
+export declare function instanceOfAdminPaginatedTaxonomyEnrollments(value: object): value is AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsFromJSON(json: any): AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsToJSON(json: any): AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsToJSONTyped(value?: AdminPaginatedTaxonomyEnrollments | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminPaginatedTaxonomyEnrollments.js

@@ -0,0 +1,48 @@
+/* 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 { AdminTaxonomyEnrollmentFromJSON, AdminTaxonomyEnrollmentToJSON, } from './AdminTaxonomyEnrollment';
+/**
+ * Check if a given object implements the AdminPaginatedTaxonomyEnrollments interface.
+ */
+export function instanceOfAdminPaginatedTaxonomyEnrollments(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function AdminPaginatedTaxonomyEnrollmentsFromJSON(json) {
+    return AdminPaginatedTaxonomyEnrollmentsFromJSONTyped(json, false);
+}
+export function AdminPaginatedTaxonomyEnrollmentsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminTaxonomyEnrollmentFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function AdminPaginatedTaxonomyEnrollmentsToJSON(json) {
+    return AdminPaginatedTaxonomyEnrollmentsToJSONTyped(json, false);
+}
+export function AdminPaginatedTaxonomyEnrollmentsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminTaxonomyEnrollmentToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -0,0 +1,71 @@
+/**
+ * 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 { AdminTaxonomyEnrollmentTaxonomy } from './AdminTaxonomyEnrollmentTaxonomy';
+/**
+ *
+ * @export
+ * @interface AdminTaxonomyEnrollment
+ */
+export interface AdminTaxonomyEnrollment {
+    /**
+     * Enrollment ID
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    id: string;
+    /**
+     * External user ID (externalId), null if not set
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    userId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    taxonomyId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    enrolledAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    status: AdminTaxonomyEnrollmentStatusEnum;
+    /**
+     *
+     * @type {AdminTaxonomyEnrollmentTaxonomy}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    taxonomy: AdminTaxonomyEnrollmentTaxonomy;
+}
+/**
+ * @export
+ */
+export declare const AdminTaxonomyEnrollmentStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+};
+export type AdminTaxonomyEnrollmentStatusEnum = typeof AdminTaxonomyEnrollmentStatusEnum[keyof typeof AdminTaxonomyEnrollmentStatusEnum];
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollment interface.
+ */
+export declare function instanceOfAdminTaxonomyEnrollment(value: object): value is AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentFromJSON(json: any): AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentToJSON(json: any): AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentToJSONTyped(value?: AdminTaxonomyEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminTaxonomyEnrollment.js

@@ -0,0 +1,71 @@
+/* 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 { AdminTaxonomyEnrollmentTaxonomyFromJSON, AdminTaxonomyEnrollmentTaxonomyToJSON, } from './AdminTaxonomyEnrollmentTaxonomy';
+/**
+ * @export
+ */
+export const AdminTaxonomyEnrollmentStatusEnum = {
+    Active: 'active',
+    Paused: 'paused'
+};
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollment interface.
+ */
+export function instanceOfAdminTaxonomyEnrollment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
+        return false;
+    if (!('enrolledAt' in value) || value['enrolledAt'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('taxonomy' in value) || value['taxonomy'] === undefined)
+        return false;
+    return true;
+}
+export function AdminTaxonomyEnrollmentFromJSON(json) {
+    return AdminTaxonomyEnrollmentFromJSONTyped(json, false);
+}
+export function AdminTaxonomyEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'userId': json['userId'],
+        'taxonomyId': json['taxonomyId'],
+        'enrolledAt': (new Date(json['enrolledAt'])),
+        'status': json['status'],
+        'taxonomy': AdminTaxonomyEnrollmentTaxonomyFromJSON(json['taxonomy']),
+    };
+}
+export function AdminTaxonomyEnrollmentToJSON(json) {
+    return AdminTaxonomyEnrollmentToJSONTyped(json, false);
+}
+export function AdminTaxonomyEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'userId': value['userId'],
+        'taxonomyId': value['taxonomyId'],
+        'enrolledAt': value['enrolledAt'].toISOString(),
+        'status': value['status'],
+        'taxonomy': AdminTaxonomyEnrollmentTaxonomyToJSON(value['taxonomy']),
+    };
+}

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

@@ -0,0 +1,58 @@
+/**
+ * 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 AdminTaxonomyEnrollmentTaxonomy
+ */
+export interface AdminTaxonomyEnrollmentTaxonomy {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    slug: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    status: AdminTaxonomyEnrollmentTaxonomyStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const AdminTaxonomyEnrollmentTaxonomyStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type AdminTaxonomyEnrollmentTaxonomyStatusEnum = typeof AdminTaxonomyEnrollmentTaxonomyStatusEnum[keyof typeof AdminTaxonomyEnrollmentTaxonomyStatusEnum];
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollmentTaxonomy interface.
+ */
+export declare function instanceOfAdminTaxonomyEnrollmentTaxonomy(value: object): value is AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyFromJSON(json: any): AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyToJSON(json: any): AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyToJSONTyped(value?: AdminTaxonomyEnrollmentTaxonomy | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminTaxonomyEnrollmentTaxonomy.js

@@ -0,0 +1,62 @@
+/* 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 AdminTaxonomyEnrollmentTaxonomyStatusEnum = {
+    Draft: 'draft',
+    Active: 'active'
+};
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollmentTaxonomy interface.
+ */
+export function instanceOfAdminTaxonomyEnrollmentTaxonomy(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function AdminTaxonomyEnrollmentTaxonomyFromJSON(json) {
+    return AdminTaxonomyEnrollmentTaxonomyFromJSONTyped(json, false);
+}
+export function AdminTaxonomyEnrollmentTaxonomyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'slug': json['slug'],
+        'name': json['name'],
+        'status': json['status'],
+    };
+}
+export function AdminTaxonomyEnrollmentTaxonomyToJSON(json) {
+    return AdminTaxonomyEnrollmentTaxonomyToJSONTyped(json, false);
+}
+export function AdminTaxonomyEnrollmentTaxonomyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'slug': value['slug'],
+        'name': value['name'],
+        'status': value['status'],
+    };
+}

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

@@ -6,7 +6,10 @@ export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
 export * from './AdminPaginatedActiveStreaks';
 export * from './AdminPaginatedChats';
+export * from './AdminPaginatedTaxonomyEnrollments';
 export * from './AdminStreak';
+export * from './AdminTaxonomyEnrollment';
+export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';

package/dist/esm/models/index.js

@@ -8,7 +8,10 @@ export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
 export * from './AdminPaginatedActiveStreaks';
 export * from './AdminPaginatedChats';
+export * from './AdminPaginatedTaxonomyEnrollments';
 export * from './AdminStreak';
+export * from './AdminTaxonomyEnrollment';
+export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';

package/dist/models/AdminPaginatedTaxonomyEnrollments.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { AdminTaxonomyEnrollment } from './AdminTaxonomyEnrollment';
+/**
+ *
+ * @export
+ * @interface AdminPaginatedTaxonomyEnrollments
+ */
+export interface AdminPaginatedTaxonomyEnrollments {
+    /**
+     *
+     * @type {Array<AdminTaxonomyEnrollment>}
+     * @memberof AdminPaginatedTaxonomyEnrollments
+     */
+    data: Array<AdminTaxonomyEnrollment>;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminPaginatedTaxonomyEnrollments
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the AdminPaginatedTaxonomyEnrollments interface.
+ */
+export declare function instanceOfAdminPaginatedTaxonomyEnrollments(value: object): value is AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsFromJSON(json: any): AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsToJSON(json: any): AdminPaginatedTaxonomyEnrollments;
+export declare function AdminPaginatedTaxonomyEnrollmentsToJSONTyped(value?: AdminPaginatedTaxonomyEnrollments | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminPaginatedTaxonomyEnrollments.js

@@ -0,0 +1,55 @@
+"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.instanceOfAdminPaginatedTaxonomyEnrollments = instanceOfAdminPaginatedTaxonomyEnrollments;
+exports.AdminPaginatedTaxonomyEnrollmentsFromJSON = AdminPaginatedTaxonomyEnrollmentsFromJSON;
+exports.AdminPaginatedTaxonomyEnrollmentsFromJSONTyped = AdminPaginatedTaxonomyEnrollmentsFromJSONTyped;
+exports.AdminPaginatedTaxonomyEnrollmentsToJSON = AdminPaginatedTaxonomyEnrollmentsToJSON;
+exports.AdminPaginatedTaxonomyEnrollmentsToJSONTyped = AdminPaginatedTaxonomyEnrollmentsToJSONTyped;
+const AdminTaxonomyEnrollment_1 = require("./AdminTaxonomyEnrollment");
+/**
+ * Check if a given object implements the AdminPaginatedTaxonomyEnrollments interface.
+ */
+function instanceOfAdminPaginatedTaxonomyEnrollments(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function AdminPaginatedTaxonomyEnrollmentsFromJSON(json) {
+    return AdminPaginatedTaxonomyEnrollmentsFromJSONTyped(json, false);
+}
+function AdminPaginatedTaxonomyEnrollmentsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminTaxonomyEnrollment_1.AdminTaxonomyEnrollmentFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function AdminPaginatedTaxonomyEnrollmentsToJSON(json) {
+    return AdminPaginatedTaxonomyEnrollmentsToJSONTyped(json, false);
+}
+function AdminPaginatedTaxonomyEnrollmentsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminTaxonomyEnrollment_1.AdminTaxonomyEnrollmentToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/AdminTaxonomyEnrollment.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { AdminTaxonomyEnrollmentTaxonomy } from './AdminTaxonomyEnrollmentTaxonomy';
+/**
+ *
+ * @export
+ * @interface AdminTaxonomyEnrollment
+ */
+export interface AdminTaxonomyEnrollment {
+    /**
+     * Enrollment ID
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    id: string;
+    /**
+     * External user ID (externalId), null if not set
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    userId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    taxonomyId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    enrolledAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    status: AdminTaxonomyEnrollmentStatusEnum;
+    /**
+     *
+     * @type {AdminTaxonomyEnrollmentTaxonomy}
+     * @memberof AdminTaxonomyEnrollment
+     */
+    taxonomy: AdminTaxonomyEnrollmentTaxonomy;
+}
+/**
+ * @export
+ */
+export declare const AdminTaxonomyEnrollmentStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+};
+export type AdminTaxonomyEnrollmentStatusEnum = typeof AdminTaxonomyEnrollmentStatusEnum[keyof typeof AdminTaxonomyEnrollmentStatusEnum];
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollment interface.
+ */
+export declare function instanceOfAdminTaxonomyEnrollment(value: object): value is AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentFromJSON(json: any): AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentToJSON(json: any): AdminTaxonomyEnrollment;
+export declare function AdminTaxonomyEnrollmentToJSONTyped(value?: AdminTaxonomyEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminTaxonomyEnrollment.js

@@ -0,0 +1,79 @@
+"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.AdminTaxonomyEnrollmentStatusEnum = void 0;
+exports.instanceOfAdminTaxonomyEnrollment = instanceOfAdminTaxonomyEnrollment;
+exports.AdminTaxonomyEnrollmentFromJSON = AdminTaxonomyEnrollmentFromJSON;
+exports.AdminTaxonomyEnrollmentFromJSONTyped = AdminTaxonomyEnrollmentFromJSONTyped;
+exports.AdminTaxonomyEnrollmentToJSON = AdminTaxonomyEnrollmentToJSON;
+exports.AdminTaxonomyEnrollmentToJSONTyped = AdminTaxonomyEnrollmentToJSONTyped;
+const AdminTaxonomyEnrollmentTaxonomy_1 = require("./AdminTaxonomyEnrollmentTaxonomy");
+/**
+ * @export
+ */
+exports.AdminTaxonomyEnrollmentStatusEnum = {
+    Active: 'active',
+    Paused: 'paused'
+};
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollment interface.
+ */
+function instanceOfAdminTaxonomyEnrollment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
+        return false;
+    if (!('enrolledAt' in value) || value['enrolledAt'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('taxonomy' in value) || value['taxonomy'] === undefined)
+        return false;
+    return true;
+}
+function AdminTaxonomyEnrollmentFromJSON(json) {
+    return AdminTaxonomyEnrollmentFromJSONTyped(json, false);
+}
+function AdminTaxonomyEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'userId': json['userId'],
+        'taxonomyId': json['taxonomyId'],
+        'enrolledAt': (new Date(json['enrolledAt'])),
+        'status': json['status'],
+        'taxonomy': (0, AdminTaxonomyEnrollmentTaxonomy_1.AdminTaxonomyEnrollmentTaxonomyFromJSON)(json['taxonomy']),
+    };
+}
+function AdminTaxonomyEnrollmentToJSON(json) {
+    return AdminTaxonomyEnrollmentToJSONTyped(json, false);
+}
+function AdminTaxonomyEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'userId': value['userId'],
+        'taxonomyId': value['taxonomyId'],
+        'enrolledAt': value['enrolledAt'].toISOString(),
+        'status': value['status'],
+        'taxonomy': (0, AdminTaxonomyEnrollmentTaxonomy_1.AdminTaxonomyEnrollmentTaxonomyToJSON)(value['taxonomy']),
+    };
+}

package/dist/models/AdminTaxonomyEnrollmentTaxonomy.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 AdminTaxonomyEnrollmentTaxonomy
+ */
+export interface AdminTaxonomyEnrollmentTaxonomy {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    slug: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminTaxonomyEnrollmentTaxonomy
+     */
+    status: AdminTaxonomyEnrollmentTaxonomyStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const AdminTaxonomyEnrollmentTaxonomyStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type AdminTaxonomyEnrollmentTaxonomyStatusEnum = typeof AdminTaxonomyEnrollmentTaxonomyStatusEnum[keyof typeof AdminTaxonomyEnrollmentTaxonomyStatusEnum];
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollmentTaxonomy interface.
+ */
+export declare function instanceOfAdminTaxonomyEnrollmentTaxonomy(value: object): value is AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyFromJSON(json: any): AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyToJSON(json: any): AdminTaxonomyEnrollmentTaxonomy;
+export declare function AdminTaxonomyEnrollmentTaxonomyToJSONTyped(value?: AdminTaxonomyEnrollmentTaxonomy | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminTaxonomyEnrollmentTaxonomy.js

@@ -0,0 +1,70 @@
+"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.AdminTaxonomyEnrollmentTaxonomyStatusEnum = void 0;
+exports.instanceOfAdminTaxonomyEnrollmentTaxonomy = instanceOfAdminTaxonomyEnrollmentTaxonomy;
+exports.AdminTaxonomyEnrollmentTaxonomyFromJSON = AdminTaxonomyEnrollmentTaxonomyFromJSON;
+exports.AdminTaxonomyEnrollmentTaxonomyFromJSONTyped = AdminTaxonomyEnrollmentTaxonomyFromJSONTyped;
+exports.AdminTaxonomyEnrollmentTaxonomyToJSON = AdminTaxonomyEnrollmentTaxonomyToJSON;
+exports.AdminTaxonomyEnrollmentTaxonomyToJSONTyped = AdminTaxonomyEnrollmentTaxonomyToJSONTyped;
+/**
+ * @export
+ */
+exports.AdminTaxonomyEnrollmentTaxonomyStatusEnum = {
+    Draft: 'draft',
+    Active: 'active'
+};
+/**
+ * Check if a given object implements the AdminTaxonomyEnrollmentTaxonomy interface.
+ */
+function instanceOfAdminTaxonomyEnrollmentTaxonomy(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+function AdminTaxonomyEnrollmentTaxonomyFromJSON(json) {
+    return AdminTaxonomyEnrollmentTaxonomyFromJSONTyped(json, false);
+}
+function AdminTaxonomyEnrollmentTaxonomyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'slug': json['slug'],
+        'name': json['name'],
+        'status': json['status'],
+    };
+}
+function AdminTaxonomyEnrollmentTaxonomyToJSON(json) {
+    return AdminTaxonomyEnrollmentTaxonomyToJSONTyped(json, false);
+}
+function AdminTaxonomyEnrollmentTaxonomyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'slug': value['slug'],
+        'name': value['name'],
+        'status': value['status'],
+    };
+}

package/dist/models/index.d.ts

@@ -6,7 +6,10 @@ export * from './AdminChatWithStats';
 export * from './AdminCohortStats';
 export * from './AdminPaginatedActiveStreaks';
 export * from './AdminPaginatedChats';
+export * from './AdminPaginatedTaxonomyEnrollments';
 export * from './AdminStreak';
+export * from './AdminTaxonomyEnrollment';
+export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';

package/dist/models/index.js

@@ -24,7 +24,10 @@ __exportStar(require("./AdminChatWithStats"), exports);
 __exportStar(require("./AdminCohortStats"), exports);
 __exportStar(require("./AdminPaginatedActiveStreaks"), exports);
 __exportStar(require("./AdminPaginatedChats"), exports);
+__exportStar(require("./AdminPaginatedTaxonomyEnrollments"), exports);
 __exportStar(require("./AdminStreak"), exports);
+__exportStar(require("./AdminTaxonomyEnrollment"), exports);
+__exportStar(require("./AdminTaxonomyEnrollmentTaxonomy"), exports);
 __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
 __exportStar(require("./AdminUpdateChatRequest"), exports);
 __exportStar(require("./AdminUserEngagement"), exports);

package/package.json

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