@instructure/athena-api-client 2.5.0 → 2.7.0

package/dist/esm/apis/TaxonomiesApi.js

@@ -0,0 +1,143 @@
+/* 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 { PaginatedTaxonomiesFromJSON, TaxonomyDetailFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class TaxonomiesApi extends runtime.BaseAPI {
+    /**
+     * Get taxonomy by ID with full tree
+     */
+    getTaxonomyRaw(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 getTaxonomy().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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}`;
+            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) => TaxonomyDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get taxonomy by ID with full tree
+     */
+    getTaxonomy(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaxonomyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get taxonomy by slug
+     */
+    getTaxonomyBySlugRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['slug'] == null) {
+                throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getTaxonomyBySlug().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/taxonomies/by-slug/{slug}`;
+            urlPath = urlPath.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => TaxonomyDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get taxonomy by slug
+     */
+    getTaxonomyBySlug(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getTaxonomyBySlugRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List available taxonomies
+     */
+    listTaxonomiesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['accountId'] != null) {
+                queryParameters['accountId'] = requestParameters['accountId'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/taxonomies`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedTaxonomiesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List available taxonomies
+     */
+    listTaxonomies() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listTaxonomiesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ListTaxonomiesStatusEnum = {
+    Draft: 'draft',
+    Active: 'active'
+};

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

@@ -0,0 +1,59 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { TaxonomyEnrollment, TaxonomyEnrollmentWithTaxonomy } from '../models/index';
+export interface EnrollInTaxonomyRequest {
+    id: string;
+    xUserId: string;
+}
+export interface ListMyEnrollmentsRequest {
+    xUserId: string;
+}
+export interface UnenrollFromTaxonomyRequest {
+    id: string;
+    xUserId: string;
+}
+/**
+ *
+ */
+export declare class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
+    /**
+     * Enroll the current user in a taxonomy. Idempotent — re-enrolling a paused enrollment reactivates it.
+     * Enroll in a taxonomy
+     */
+    enrollInTaxonomyRaw(requestParameters: EnrollInTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyEnrollment>>;
+    /**
+     * Enroll the current user in a taxonomy. Idempotent — re-enrolling a paused enrollment reactivates it.
+     * Enroll in a taxonomy
+     */
+    enrollInTaxonomy(requestParameters: EnrollInTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyEnrollment>;
+    /**
+     * Returns active enrollment records with taxonomy metadata.
+     * List current user\'s active enrollments
+     */
+    listMyEnrollmentsRaw(requestParameters: ListMyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TaxonomyEnrollmentWithTaxonomy>>>;
+    /**
+     * Returns active enrollment records with taxonomy metadata.
+     * List current user\'s active enrollments
+     */
+    listMyEnrollments(requestParameters: ListMyEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TaxonomyEnrollmentWithTaxonomy>>;
+    /**
+     * Sets enrollment status to paused. Does not delete the enrollment record.
+     * Unenroll from a taxonomy
+     */
+    unenrollFromTaxonomyRaw(requestParameters: UnenrollFromTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyEnrollment>>;
+    /**
+     * Sets enrollment status to paused. Does not delete the enrollment record.
+     * Unenroll from a taxonomy
+     */
+    unenrollFromTaxonomy(requestParameters: UnenrollFromTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyEnrollment>;
+}

package/dist/esm/apis/TaxonomyEnrollmentsApi.js

@@ -0,0 +1,148 @@
+/* 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 { TaxonomyEnrollmentFromJSON, TaxonomyEnrollmentWithTaxonomyFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
+    /**
+     * Enroll the current user in a taxonomy. Idempotent — re-enrolling a paused enrollment reactivates it.
+     * Enroll in a taxonomy
+     */
+    enrollInTaxonomyRaw(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 enrollInTaxonomy().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling enrollInTaxonomy().');
+            }
+            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}/enroll`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => TaxonomyEnrollmentFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Enroll the current user in a taxonomy. Idempotent — re-enrolling a paused enrollment reactivates it.
+     * Enroll in a taxonomy
+     */
+    enrollInTaxonomy(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.enrollInTaxonomyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns active enrollment records with taxonomy metadata.
+     * List current user\'s active enrollments
+     */
+    listMyEnrollmentsRaw(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 listMyEnrollments().');
+            }
+            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/enrollments`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(TaxonomyEnrollmentWithTaxonomyFromJSON));
+        });
+    }
+    /**
+     * Returns active enrollment records with taxonomy metadata.
+     * List current user\'s active enrollments
+     */
+    listMyEnrollments(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listMyEnrollmentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Sets enrollment status to paused. Does not delete the enrollment record.
+     * Unenroll from a taxonomy
+     */
+    unenrollFromTaxonomyRaw(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 unenrollFromTaxonomy().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling unenrollFromTaxonomy().');
+            }
+            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}/enroll`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => TaxonomyEnrollmentFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Sets enrollment status to paused. Does not delete the enrollment record.
+     * Unenroll from a taxonomy
+     */
+    unenrollFromTaxonomy(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.unenrollFromTaxonomyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -16,5 +16,7 @@ export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';
+export * from './TaxonomiesApi';
+export * from './TaxonomyEnrollmentsApi';
 export * from './UserContextApi';
 export * from './VotesApi';

package/dist/esm/apis/index.js

@@ -18,5 +18,7 @@ export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';
+export * from './TaxonomiesApi';
+export * from './TaxonomyEnrollmentsApi';
 export * from './UserContextApi';
 export * from './VotesApi';

package/dist/esm/models/EnrollmentTaxonomy.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 EnrollmentTaxonomy
+ */
+export interface EnrollmentTaxonomy {
+    /**
+     * Taxonomy ID
+     * @type {string}
+     * @memberof EnrollmentTaxonomy
+     */
+    id: string;
+    /**
+     * Taxonomy slug
+     * @type {string}
+     * @memberof EnrollmentTaxonomy
+     */
+    slug: string;
+    /**
+     * Taxonomy name
+     * @type {string}
+     * @memberof EnrollmentTaxonomy
+     */
+    name: string;
+    /**
+     * Taxonomy status
+     * @type {string}
+     * @memberof EnrollmentTaxonomy
+     */
+    status: EnrollmentTaxonomyStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const EnrollmentTaxonomyStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type EnrollmentTaxonomyStatusEnum = typeof EnrollmentTaxonomyStatusEnum[keyof typeof EnrollmentTaxonomyStatusEnum];
+/**
+ * Check if a given object implements the EnrollmentTaxonomy interface.
+ */
+export declare function instanceOfEnrollmentTaxonomy(value: object): value is EnrollmentTaxonomy;
+export declare function EnrollmentTaxonomyFromJSON(json: any): EnrollmentTaxonomy;
+export declare function EnrollmentTaxonomyFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnrollmentTaxonomy;
+export declare function EnrollmentTaxonomyToJSON(json: any): EnrollmentTaxonomy;
+export declare function EnrollmentTaxonomyToJSONTyped(value?: EnrollmentTaxonomy | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EnrollmentTaxonomy.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 EnrollmentTaxonomyStatusEnum = {
+    Draft: 'draft',
+    Active: 'active'
+};
+/**
+ * Check if a given object implements the EnrollmentTaxonomy interface.
+ */
+export function instanceOfEnrollmentTaxonomy(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 EnrollmentTaxonomyFromJSON(json) {
+    return EnrollmentTaxonomyFromJSONTyped(json, false);
+}
+export function EnrollmentTaxonomyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'slug': json['slug'],
+        'name': json['name'],
+        'status': json['status'],
+    };
+}
+export function EnrollmentTaxonomyToJSON(json) {
+    return EnrollmentTaxonomyToJSONTyped(json, false);
+}
+export function EnrollmentTaxonomyToJSONTyped(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/PaginatedTaxonomies.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 { TaxonomySummary } from './TaxonomySummary';
+/**
+ *
+ * @export
+ * @interface PaginatedTaxonomies
+ */
+export interface PaginatedTaxonomies {
+    /**
+     * Array of taxonomy summaries
+     * @type {Array<TaxonomySummary>}
+     * @memberof PaginatedTaxonomies
+     */
+    data: Array<TaxonomySummary>;
+    /**
+     * Total count of matching taxonomies
+     * @type {number}
+     * @memberof PaginatedTaxonomies
+     */
+    total: number;
+}
+/**
+ * Check if a given object implements the PaginatedTaxonomies interface.
+ */
+export declare function instanceOfPaginatedTaxonomies(value: object): value is PaginatedTaxonomies;
+export declare function PaginatedTaxonomiesFromJSON(json: any): PaginatedTaxonomies;
+export declare function PaginatedTaxonomiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedTaxonomies;
+export declare function PaginatedTaxonomiesToJSON(json: any): PaginatedTaxonomies;
+export declare function PaginatedTaxonomiesToJSONTyped(value?: PaginatedTaxonomies | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedTaxonomies.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 { TaxonomySummaryFromJSON, TaxonomySummaryToJSON, } from './TaxonomySummary';
+/**
+ * Check if a given object implements the PaginatedTaxonomies interface.
+ */
+export function instanceOfPaginatedTaxonomies(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedTaxonomiesFromJSON(json) {
+    return PaginatedTaxonomiesFromJSONTyped(json, false);
+}
+export function PaginatedTaxonomiesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(TaxonomySummaryFromJSON)),
+        'total': json['total'],
+    };
+}
+export function PaginatedTaxonomiesToJSON(json) {
+    return PaginatedTaxonomiesToJSONTyped(json, false);
+}
+export function PaginatedTaxonomiesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(TaxonomySummaryToJSON)),
+        'total': value['total'],
+    };
+}

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

@@ -0,0 +1,89 @@
+/**
+ * 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 { TaxonomyNode } from './TaxonomyNode';
+/**
+ *
+ * @export
+ * @interface TaxonomyDetail
+ */
+export interface TaxonomyDetail {
+    /**
+     * Taxonomy ID
+     * @type {string}
+     * @memberof TaxonomyDetail
+     */
+    id: string;
+    /**
+     * URL slug
+     * @type {string}
+     * @memberof TaxonomyDetail
+     */
+    slug: string;
+    /**
+     * Taxonomy name
+     * @type {string}
+     * @memberof TaxonomyDetail
+     */
+    name: string;
+    /**
+     * Taxonomy description
+     * @type {string}
+     * @memberof TaxonomyDetail
+     */
+    description: string;
+    /**
+     * Taxonomy status
+     * @type {string}
+     * @memberof TaxonomyDetail
+     */
+    status: TaxonomyDetailStatusEnum;
+    /**
+     * Mastery threshold (decimal)
+     * @type {string}
+     * @memberof TaxonomyDetail
+     */
+    masteryThreshold: string | null;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof TaxonomyDetail
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof TaxonomyDetail
+     */
+    updatedAt: Date;
+    /**
+     * Root-level nodes of the taxonomy tree
+     * @type {Array<TaxonomyNode>}
+     * @memberof TaxonomyDetail
+     */
+    nodes: Array<TaxonomyNode>;
+}
+/**
+ * @export
+ */
+export declare const TaxonomyDetailStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type TaxonomyDetailStatusEnum = typeof TaxonomyDetailStatusEnum[keyof typeof TaxonomyDetailStatusEnum];
+/**
+ * Check if a given object implements the TaxonomyDetail interface.
+ */
+export declare function instanceOfTaxonomyDetail(value: object): value is TaxonomyDetail;
+export declare function TaxonomyDetailFromJSON(json: any): TaxonomyDetail;
+export declare function TaxonomyDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyDetail;
+export declare function TaxonomyDetailToJSON(json: any): TaxonomyDetail;
+export declare function TaxonomyDetailToJSONTyped(value?: TaxonomyDetail | null, ignoreDiscriminator?: boolean): any;