@instructure/athena-api-client 2.7.1 → 2.8.0

package/README.md

@@ -115,6 +115,7 @@ All URIs are relative to *http://localhost:3000*
 *TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
 *TaxonomiesApi* | [**getTaxonomy**](docs/TaxonomiesApi.md#gettaxonomy) | **GET** /api/v1/taxonomies/{id} | Get taxonomy by ID with full tree
 *TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug
+*TaxonomiesApi* | [**getTaxonomyProgress**](docs/TaxonomiesApi.md#gettaxonomyprogress) | **GET** /api/v1/taxonomies/{id}/progress | Get progress and readiness for a taxonomy
 *TaxonomiesApi* | [**listTaxonomies**](docs/TaxonomiesApi.md#listtaxonomies) | **GET** /api/v1/taxonomies | List available taxonomies
 *TaxonomyEnrollmentsApi* | [**enrollInTaxonomy**](docs/TaxonomyEnrollmentsApi.md#enrollintaxonomy) | **POST** /api/v1/taxonomies/{id}/enroll | Enroll in a taxonomy
 *TaxonomyEnrollmentsApi* | [**listMyEnrollments**](docs/TaxonomyEnrollmentsApi.md#listmyenrollments) | **GET** /api/v1/taxonomies/enrollments | List current user\'s active enrollments
@@ -190,6 +191,8 @@ All URIs are relative to *http://localhost:3000*
 - [TaxonomyEnrollmentWithTaxonomy](docs/TaxonomyEnrollmentWithTaxonomy.md)
 - [TaxonomyNode](docs/TaxonomyNode.md)
 - [TaxonomyNodeConcept](docs/TaxonomyNodeConcept.md)
+- [TaxonomyProgress](docs/TaxonomyProgress.md)
+- [TaxonomyProgressNode](docs/TaxonomyProgressNode.md)
 - [TaxonomySummary](docs/TaxonomySummary.md)
 - [UpdateAccountDto](docs/UpdateAccountDto.md)
 - [UpdateChatRequest](docs/UpdateChatRequest.md)

package/dist/apis/TaxonomiesApi.d.ts

@@ -10,14 +10,21 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
+import type { PaginatedTaxonomies, TaxonomyDetail, TaxonomyProgress } from '../models/index';
 export interface GetTaxonomyRequest {
     id: string;
+    xUserId: string;
 }
 export interface GetTaxonomyBySlugRequest {
     slug: string;
+    xUserId: string;
+}
+export interface GetTaxonomyProgressRequest {
+    id: string;
+    xUserId: string;
 }
 export interface ListTaxonomiesRequest {
+    xUserId: string;
     status?: ListTaxonomiesStatusEnum;
     limit?: number;
     offset?: number;
@@ -42,6 +49,16 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
      * Get taxonomy by slug
      */
     getTaxonomyBySlug(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgressRaw(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyProgress>>;
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgress(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyProgress>;
     /**
      * List available taxonomies
      */
@@ -49,7 +66,7 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
     /**
      * List available taxonomies
      */
-    listTaxonomies(requestParameters?: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
+    listTaxonomies(requestParameters: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
 }
 /**
  * @export

package/dist/apis/TaxonomiesApi.js

@@ -37,8 +37,14 @@ class TaxonomiesApi extends runtime.BaseAPI {
             if (requestParameters['id'] == null) {
                 throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomy().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomy().');
+            }
             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
             }
@@ -70,8 +76,14 @@ class TaxonomiesApi extends runtime.BaseAPI {
             if (requestParameters['slug'] == null) {
                 throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getTaxonomyBySlug().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyBySlug().');
+            }
             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
             }
@@ -95,11 +107,55 @@ class TaxonomiesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgressRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomyProgress().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyProgress().');
+            }
+            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/taxonomies/{id}/progress`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TaxonomyProgressFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgress(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaxonomyProgressRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List available taxonomies
      */
     listTaxonomiesRaw(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 listTaxonomies().');
+            }
             const queryParameters = {};
             if (requestParameters['status'] != null) {
                 queryParameters['status'] = requestParameters['status'];
@@ -111,6 +167,9 @@ class TaxonomiesApi extends runtime.BaseAPI {
                 queryParameters['offset'] = requestParameters['offset'];
             }
             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
             }
@@ -127,8 +186,8 @@ class TaxonomiesApi extends runtime.BaseAPI {
     /**
      * List available taxonomies
      */
-    listTaxonomies() {
-        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+    listTaxonomies(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.listTaxonomiesRaw(requestParameters, initOverrides);
             return yield response.value();
         });

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

@@ -10,14 +10,21 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
+import type { PaginatedTaxonomies, TaxonomyDetail, TaxonomyProgress } from '../models/index';
 export interface GetTaxonomyRequest {
     id: string;
+    xUserId: string;
 }
 export interface GetTaxonomyBySlugRequest {
     slug: string;
+    xUserId: string;
+}
+export interface GetTaxonomyProgressRequest {
+    id: string;
+    xUserId: string;
 }
 export interface ListTaxonomiesRequest {
+    xUserId: string;
     status?: ListTaxonomiesStatusEnum;
     limit?: number;
     offset?: number;
@@ -42,6 +49,16 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
      * Get taxonomy by slug
      */
     getTaxonomyBySlug(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgressRaw(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyProgress>>;
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgress(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyProgress>;
     /**
      * List available taxonomies
      */
@@ -49,7 +66,7 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
     /**
      * List available taxonomies
      */
-    listTaxonomies(requestParameters?: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
+    listTaxonomies(requestParameters: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
 }
 /**
  * @export

package/dist/esm/apis/TaxonomiesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedTaxonomiesFromJSON, TaxonomyDetailFromJSON, } from '../models/index';
+import { PaginatedTaxonomiesFromJSON, TaxonomyDetailFromJSON, TaxonomyProgressFromJSON, } from '../models/index';
 /**
  *
  */
@@ -34,8 +34,14 @@ export class TaxonomiesApi extends runtime.BaseAPI {
             if (requestParameters['id'] == null) {
                 throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomy().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomy().');
+            }
             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
             }
@@ -67,8 +73,14 @@ export class TaxonomiesApi extends runtime.BaseAPI {
             if (requestParameters['slug'] == null) {
                 throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getTaxonomyBySlug().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyBySlug().');
+            }
             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
             }
@@ -92,11 +104,55 @@ export class TaxonomiesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgressRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomyProgress().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyProgress().');
+            }
+            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/taxonomies/{id}/progress`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => TaxonomyProgressFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
+     * Get progress and readiness for a taxonomy
+     */
+    getTaxonomyProgress(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaxonomyProgressRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List available taxonomies
      */
     listTaxonomiesRaw(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 listTaxonomies().');
+            }
             const queryParameters = {};
             if (requestParameters['status'] != null) {
                 queryParameters['status'] = requestParameters['status'];
@@ -108,6 +164,9 @@ export class TaxonomiesApi extends runtime.BaseAPI {
                 queryParameters['offset'] = requestParameters['offset'];
             }
             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
             }
@@ -124,8 +183,8 @@ export class TaxonomiesApi extends runtime.BaseAPI {
     /**
      * List available taxonomies
      */
-    listTaxonomies() {
-        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+    listTaxonomies(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.listTaxonomiesRaw(requestParameters, initOverrides);
             return yield response.value();
         });

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { TaxonomyProgressNode } from './TaxonomyProgressNode';
+/**
+ *
+ * @export
+ * @interface TaxonomyProgress
+ */
+export interface TaxonomyProgress {
+    /**
+     * Root-level weighted average of strength (0–1)
+     * @type {number}
+     * @memberof TaxonomyProgress
+     */
+    readinessScore: number;
+    /**
+     * Total concepts in the taxonomy
+     * @type {number}
+     * @memberof TaxonomyProgress
+     */
+    totalConcepts: number;
+    /**
+     * Number of concepts with a user_concepts row
+     * @type {number}
+     * @memberof TaxonomyProgress
+     */
+    assessedConcepts: number;
+    /**
+     * Root-level progress nodes
+     * @type {Array<TaxonomyProgressNode>}
+     * @memberof TaxonomyProgress
+     */
+    nodes: Array<TaxonomyProgressNode>;
+}
+/**
+ * Check if a given object implements the TaxonomyProgress interface.
+ */
+export declare function instanceOfTaxonomyProgress(value: object): value is TaxonomyProgress;
+export declare function TaxonomyProgressFromJSON(json: any): TaxonomyProgress;
+export declare function TaxonomyProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgress;
+export declare function TaxonomyProgressToJSON(json: any): TaxonomyProgress;
+export declare function TaxonomyProgressToJSONTyped(value?: TaxonomyProgress | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TaxonomyProgress.js

@@ -0,0 +1,56 @@
+/* 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 { TaxonomyProgressNodeFromJSON, TaxonomyProgressNodeToJSON, } from './TaxonomyProgressNode';
+/**
+ * Check if a given object implements the TaxonomyProgress interface.
+ */
+export function instanceOfTaxonomyProgress(value) {
+    if (!('readinessScore' in value) || value['readinessScore'] === undefined)
+        return false;
+    if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
+        return false;
+    if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
+        return false;
+    if (!('nodes' in value) || value['nodes'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyProgressFromJSON(json) {
+    return TaxonomyProgressFromJSONTyped(json, false);
+}
+export function TaxonomyProgressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'readinessScore': json['readinessScore'],
+        'totalConcepts': json['totalConcepts'],
+        'assessedConcepts': json['assessedConcepts'],
+        'nodes': (json['nodes'].map(TaxonomyProgressNodeFromJSON)),
+    };
+}
+export function TaxonomyProgressToJSON(json) {
+    return TaxonomyProgressToJSONTyped(json, false);
+}
+export function TaxonomyProgressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'readinessScore': value['readinessScore'],
+        'totalConcepts': value['totalConcepts'],
+        'assessedConcepts': value['assessedConcepts'],
+        'nodes': (value['nodes'].map(TaxonomyProgressNodeToJSON)),
+    };
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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 TaxonomyProgressNode
+ */
+export interface TaxonomyProgressNode {
+    /**
+     * Node ID
+     * @type {string}
+     * @memberof TaxonomyProgressNode
+     */
+    id: string;
+    /**
+     * Node name
+     * @type {string}
+     * @memberof TaxonomyProgressNode
+     */
+    name: string;
+    /**
+     * Node weight (normalized among siblings)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    weight: number | null;
+    /**
+     * Average strength of concepts (0–1)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    strength: number;
+    /**
+     * Average confidence of concepts (0–1)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    confidence: number;
+    /**
+     * Total concepts under this node (including descendants)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    totalConcepts: number;
+    /**
+     * Number of concepts with a user_concepts row (including descendants)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    assessedConcepts: number;
+    /**
+     * Child nodes
+     * @type {Array<TaxonomyProgressNode>}
+     * @memberof TaxonomyProgressNode
+     */
+    children: Array<TaxonomyProgressNode>;
+}
+/**
+ * Check if a given object implements the TaxonomyProgressNode interface.
+ */
+export declare function instanceOfTaxonomyProgressNode(value: object): value is TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeFromJSON(json: any): TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeToJSON(json: any): TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeToJSONTyped(value?: TaxonomyProgressNode | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TaxonomyProgressNode.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.
+ */
+/**
+ * Check if a given object implements the TaxonomyProgressNode interface.
+ */
+export function instanceOfTaxonomyProgressNode(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('weight' in value) || value['weight'] === undefined)
+        return false;
+    if (!('strength' in value) || value['strength'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
+        return false;
+    if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
+        return false;
+    if (!('children' in value) || value['children'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyProgressNodeFromJSON(json) {
+    return TaxonomyProgressNodeFromJSONTyped(json, false);
+}
+export function TaxonomyProgressNodeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'weight': json['weight'],
+        'strength': json['strength'],
+        'confidence': json['confidence'],
+        'totalConcepts': json['totalConcepts'],
+        'assessedConcepts': json['assessedConcepts'],
+        'children': (json['children'].map(TaxonomyProgressNodeFromJSON)),
+    };
+}
+export function TaxonomyProgressNodeToJSON(json) {
+    return TaxonomyProgressNodeToJSONTyped(json, false);
+}
+export function TaxonomyProgressNodeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'weight': value['weight'],
+        'strength': value['strength'],
+        'confidence': value['confidence'],
+        'totalConcepts': value['totalConcepts'],
+        'assessedConcepts': value['assessedConcepts'],
+        'children': (value['children'].map(TaxonomyProgressNodeToJSON)),
+    };
+}

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

@@ -61,6 +61,8 @@ export * from './TaxonomyEnrollment';
 export * from './TaxonomyEnrollmentWithTaxonomy';
 export * from './TaxonomyNode';
 export * from './TaxonomyNodeConcept';
+export * from './TaxonomyProgress';
+export * from './TaxonomyProgressNode';
 export * from './TaxonomySummary';
 export * from './UpdateAccountDto';
 export * from './UpdateChatRequest';

package/dist/esm/models/index.js

@@ -63,6 +63,8 @@ export * from './TaxonomyEnrollment';
 export * from './TaxonomyEnrollmentWithTaxonomy';
 export * from './TaxonomyNode';
 export * from './TaxonomyNodeConcept';
+export * from './TaxonomyProgress';
+export * from './TaxonomyProgressNode';
 export * from './TaxonomySummary';
 export * from './UpdateAccountDto';
 export * from './UpdateChatRequest';

package/dist/models/TaxonomyProgress.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { TaxonomyProgressNode } from './TaxonomyProgressNode';
+/**
+ *
+ * @export
+ * @interface TaxonomyProgress
+ */
+export interface TaxonomyProgress {
+    /**
+     * Root-level weighted average of strength (0–1)
+     * @type {number}
+     * @memberof TaxonomyProgress
+     */
+    readinessScore: number;
+    /**
+     * Total concepts in the taxonomy
+     * @type {number}
+     * @memberof TaxonomyProgress
+     */
+    totalConcepts: number;
+    /**
+     * Number of concepts with a user_concepts row
+     * @type {number}
+     * @memberof TaxonomyProgress
+     */
+    assessedConcepts: number;
+    /**
+     * Root-level progress nodes
+     * @type {Array<TaxonomyProgressNode>}
+     * @memberof TaxonomyProgress
+     */
+    nodes: Array<TaxonomyProgressNode>;
+}
+/**
+ * Check if a given object implements the TaxonomyProgress interface.
+ */
+export declare function instanceOfTaxonomyProgress(value: object): value is TaxonomyProgress;
+export declare function TaxonomyProgressFromJSON(json: any): TaxonomyProgress;
+export declare function TaxonomyProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgress;
+export declare function TaxonomyProgressToJSON(json: any): TaxonomyProgress;
+export declare function TaxonomyProgressToJSONTyped(value?: TaxonomyProgress | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TaxonomyProgress.js

@@ -0,0 +1,63 @@
+"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.instanceOfTaxonomyProgress = instanceOfTaxonomyProgress;
+exports.TaxonomyProgressFromJSON = TaxonomyProgressFromJSON;
+exports.TaxonomyProgressFromJSONTyped = TaxonomyProgressFromJSONTyped;
+exports.TaxonomyProgressToJSON = TaxonomyProgressToJSON;
+exports.TaxonomyProgressToJSONTyped = TaxonomyProgressToJSONTyped;
+const TaxonomyProgressNode_1 = require("./TaxonomyProgressNode");
+/**
+ * Check if a given object implements the TaxonomyProgress interface.
+ */
+function instanceOfTaxonomyProgress(value) {
+    if (!('readinessScore' in value) || value['readinessScore'] === undefined)
+        return false;
+    if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
+        return false;
+    if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
+        return false;
+    if (!('nodes' in value) || value['nodes'] === undefined)
+        return false;
+    return true;
+}
+function TaxonomyProgressFromJSON(json) {
+    return TaxonomyProgressFromJSONTyped(json, false);
+}
+function TaxonomyProgressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'readinessScore': json['readinessScore'],
+        'totalConcepts': json['totalConcepts'],
+        'assessedConcepts': json['assessedConcepts'],
+        'nodes': (json['nodes'].map(TaxonomyProgressNode_1.TaxonomyProgressNodeFromJSON)),
+    };
+}
+function TaxonomyProgressToJSON(json) {
+    return TaxonomyProgressToJSONTyped(json, false);
+}
+function TaxonomyProgressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'readinessScore': value['readinessScore'],
+        'totalConcepts': value['totalConcepts'],
+        'assessedConcepts': value['assessedConcepts'],
+        'nodes': (value['nodes'].map(TaxonomyProgressNode_1.TaxonomyProgressNodeToJSON)),
+    };
+}

package/dist/models/TaxonomyProgressNode.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 TaxonomyProgressNode
+ */
+export interface TaxonomyProgressNode {
+    /**
+     * Node ID
+     * @type {string}
+     * @memberof TaxonomyProgressNode
+     */
+    id: string;
+    /**
+     * Node name
+     * @type {string}
+     * @memberof TaxonomyProgressNode
+     */
+    name: string;
+    /**
+     * Node weight (normalized among siblings)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    weight: number | null;
+    /**
+     * Average strength of concepts (0–1)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    strength: number;
+    /**
+     * Average confidence of concepts (0–1)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    confidence: number;
+    /**
+     * Total concepts under this node (including descendants)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    totalConcepts: number;
+    /**
+     * Number of concepts with a user_concepts row (including descendants)
+     * @type {number}
+     * @memberof TaxonomyProgressNode
+     */
+    assessedConcepts: number;
+    /**
+     * Child nodes
+     * @type {Array<TaxonomyProgressNode>}
+     * @memberof TaxonomyProgressNode
+     */
+    children: Array<TaxonomyProgressNode>;
+}
+/**
+ * Check if a given object implements the TaxonomyProgressNode interface.
+ */
+export declare function instanceOfTaxonomyProgressNode(value: object): value is TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeFromJSON(json: any): TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeToJSON(json: any): TaxonomyProgressNode;
+export declare function TaxonomyProgressNodeToJSONTyped(value?: TaxonomyProgressNode | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TaxonomyProgressNode.js

@@ -0,0 +1,78 @@
+"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.instanceOfTaxonomyProgressNode = instanceOfTaxonomyProgressNode;
+exports.TaxonomyProgressNodeFromJSON = TaxonomyProgressNodeFromJSON;
+exports.TaxonomyProgressNodeFromJSONTyped = TaxonomyProgressNodeFromJSONTyped;
+exports.TaxonomyProgressNodeToJSON = TaxonomyProgressNodeToJSON;
+exports.TaxonomyProgressNodeToJSONTyped = TaxonomyProgressNodeToJSONTyped;
+/**
+ * Check if a given object implements the TaxonomyProgressNode interface.
+ */
+function instanceOfTaxonomyProgressNode(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('weight' in value) || value['weight'] === undefined)
+        return false;
+    if (!('strength' in value) || value['strength'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
+        return false;
+    if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
+        return false;
+    if (!('children' in value) || value['children'] === undefined)
+        return false;
+    return true;
+}
+function TaxonomyProgressNodeFromJSON(json) {
+    return TaxonomyProgressNodeFromJSONTyped(json, false);
+}
+function TaxonomyProgressNodeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'weight': json['weight'],
+        'strength': json['strength'],
+        'confidence': json['confidence'],
+        'totalConcepts': json['totalConcepts'],
+        'assessedConcepts': json['assessedConcepts'],
+        'children': (json['children'].map(TaxonomyProgressNodeFromJSON)),
+    };
+}
+function TaxonomyProgressNodeToJSON(json) {
+    return TaxonomyProgressNodeToJSONTyped(json, false);
+}
+function TaxonomyProgressNodeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'weight': value['weight'],
+        'strength': value['strength'],
+        'confidence': value['confidence'],
+        'totalConcepts': value['totalConcepts'],
+        'assessedConcepts': value['assessedConcepts'],
+        'children': (value['children'].map(TaxonomyProgressNodeToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -61,6 +61,8 @@ export * from './TaxonomyEnrollment';
 export * from './TaxonomyEnrollmentWithTaxonomy';
 export * from './TaxonomyNode';
 export * from './TaxonomyNodeConcept';
+export * from './TaxonomyProgress';
+export * from './TaxonomyProgressNode';
 export * from './TaxonomySummary';
 export * from './UpdateAccountDto';
 export * from './UpdateChatRequest';

package/dist/models/index.js

@@ -79,6 +79,8 @@ __exportStar(require("./TaxonomyEnrollment"), exports);
 __exportStar(require("./TaxonomyEnrollmentWithTaxonomy"), exports);
 __exportStar(require("./TaxonomyNode"), exports);
 __exportStar(require("./TaxonomyNodeConcept"), exports);
+__exportStar(require("./TaxonomyProgress"), exports);
+__exportStar(require("./TaxonomyProgressNode"), exports);
 __exportStar(require("./TaxonomySummary"), exports);
 __exportStar(require("./UpdateAccountDto"), exports);
 __exportStar(require("./UpdateChatRequest"), exports);

package/package.json

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