@instructure/athena-api-client 2.5.0 → 2.7.0

package/README.md

@@ -113,6 +113,12 @@ All URIs are relative to *http://localhost:3000*
 *ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens
 *ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
 *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* | [**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
+*TaxonomyEnrollmentsApi* | [**unenrollFromTaxonomy**](docs/TaxonomyEnrollmentsApi.md#unenrollfromtaxonomy) | **DELETE** /api/v1/taxonomies/{id}/enroll | Unenroll from a taxonomy
 *UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context
 *UserContextApi* | [**upsertUserContext**](docs/UserContextApi.md#upsertusercontextoperation) | **PUT** /api/v1/user-context | Create or update user context
 *VotesApi* | [**listChatVotes**](docs/VotesApi.md#listchatvotes) | **GET** /api/v1/chats/{chatId}/votes | List votes for a chat
@@ -151,6 +157,7 @@ All URIs are relative to *http://localhost:3000*
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [DailyQuizStatus](docs/DailyQuizStatus.md)
+- [EnrollmentTaxonomy](docs/EnrollmentTaxonomy.md)
 - [FeatureEntity](docs/FeatureEntity.md)
 - [FeatureOverrideEntity](docs/FeatureOverrideEntity.md)
 - [HealthCheck](docs/HealthCheck.md)
@@ -165,6 +172,7 @@ All URIs are relative to *http://localhost:3000*
 - [PaginatedChats](docs/PaginatedChats.md)
 - [PaginatedLearningMoments](docs/PaginatedLearningMoments.md)
 - [PaginatedMessages](docs/PaginatedMessages.md)
+- [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
 - [Plan](docs/Plan.md)
 - [Quiz](docs/Quiz.md)
 - [QuizQuestion](docs/QuizQuestion.md)
@@ -177,6 +185,12 @@ All URIs are relative to *http://localhost:3000*
 - [ServiceToken](docs/ServiceToken.md)
 - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md)
 - [Tag](docs/Tag.md)
+- [TaxonomyDetail](docs/TaxonomyDetail.md)
+- [TaxonomyEnrollment](docs/TaxonomyEnrollment.md)
+- [TaxonomyEnrollmentWithTaxonomy](docs/TaxonomyEnrollmentWithTaxonomy.md)
+- [TaxonomyNode](docs/TaxonomyNode.md)
+- [TaxonomyNodeConcept](docs/TaxonomyNodeConcept.md)
+- [TaxonomySummary](docs/TaxonomySummary.md)
 - [UpdateAccountDto](docs/UpdateAccountDto.md)
 - [UpdateChatRequest](docs/UpdateChatRequest.md)
 - [UpdateFeatureDto](docs/UpdateFeatureDto.md)

package/dist/apis/TaxonomiesApi.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
+export interface GetTaxonomyRequest {
+    id: string;
+}
+export interface GetTaxonomyBySlugRequest {
+    slug: string;
+}
+export interface ListTaxonomiesRequest {
+    accountId?: string;
+    status?: ListTaxonomiesStatusEnum;
+    limit?: number;
+    offset?: number;
+}
+/**
+ *
+ */
+export declare class TaxonomiesApi extends runtime.BaseAPI {
+    /**
+     * Get taxonomy by ID with full tree
+     */
+    getTaxonomyRaw(requestParameters: GetTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyDetail>>;
+    /**
+     * Get taxonomy by ID with full tree
+     */
+    getTaxonomy(requestParameters: GetTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
+    /**
+     * Get taxonomy by slug
+     */
+    getTaxonomyBySlugRaw(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyDetail>>;
+    /**
+     * Get taxonomy by slug
+     */
+    getTaxonomyBySlug(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
+    /**
+     * List available taxonomies
+     */
+    listTaxonomiesRaw(requestParameters: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedTaxonomies>>;
+    /**
+     * List available taxonomies
+     */
+    listTaxonomies(requestParameters?: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
+}
+/**
+ * @export
+ */
+export declare const ListTaxonomiesStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type ListTaxonomiesStatusEnum = typeof ListTaxonomiesStatusEnum[keyof typeof ListTaxonomiesStatusEnum];

package/dist/apis/TaxonomiesApi.js

@@ -0,0 +1,147 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListTaxonomiesStatusEnum = exports.TaxonomiesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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) => (0, index_1.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) => (0, index_1.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) => (0, index_1.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();
+        });
+    }
+}
+exports.TaxonomiesApi = TaxonomiesApi;
+/**
+ * @export
+ */
+exports.ListTaxonomiesStatusEnum = {
+    Draft: 'draft',
+    Active: 'active'
+};

package/dist/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/apis/TaxonomyEnrollmentsApi.js

@@ -0,0 +1,152 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxonomyEnrollmentsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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) => (0, index_1.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(index_1.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) => (0, index_1.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();
+        });
+    }
+}
+exports.TaxonomyEnrollmentsApi = TaxonomyEnrollmentsApi;

package/dist/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/apis/index.js

@@ -34,5 +34,7 @@ __exportStar(require("./QuizSessionsApi"), exports);
 __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
 __exportStar(require("./TagsApi"), exports);
+__exportStar(require("./TaxonomiesApi"), exports);
+__exportStar(require("./TaxonomyEnrollmentsApi"), exports);
 __exportStar(require("./UserContextApi"), exports);
 __exportStar(require("./VotesApi"), exports);

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

@@ -0,0 +1,62 @@
+/**
+ * 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 { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
+export interface GetTaxonomyRequest {
+    id: string;
+}
+export interface GetTaxonomyBySlugRequest {
+    slug: string;
+}
+export interface ListTaxonomiesRequest {
+    accountId?: string;
+    status?: ListTaxonomiesStatusEnum;
+    limit?: number;
+    offset?: number;
+}
+/**
+ *
+ */
+export declare class TaxonomiesApi extends runtime.BaseAPI {
+    /**
+     * Get taxonomy by ID with full tree
+     */
+    getTaxonomyRaw(requestParameters: GetTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyDetail>>;
+    /**
+     * Get taxonomy by ID with full tree
+     */
+    getTaxonomy(requestParameters: GetTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
+    /**
+     * Get taxonomy by slug
+     */
+    getTaxonomyBySlugRaw(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyDetail>>;
+    /**
+     * Get taxonomy by slug
+     */
+    getTaxonomyBySlug(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
+    /**
+     * List available taxonomies
+     */
+    listTaxonomiesRaw(requestParameters: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedTaxonomies>>;
+    /**
+     * List available taxonomies
+     */
+    listTaxonomies(requestParameters?: ListTaxonomiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTaxonomies>;
+}
+/**
+ * @export
+ */
+export declare const ListTaxonomiesStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type ListTaxonomiesStatusEnum = typeof ListTaxonomiesStatusEnum[keyof typeof ListTaxonomiesStatusEnum];