mixpeek 0.81.1

package/dist/api/taxonomies-api.d.ts

@@ -0,0 +1,766 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * 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 { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CloneTaxonomyRequest } from '../models';
+import type { CloneTaxonomyResponse } from '../models';
+import type { CreateTaxonomyRequest } from '../models';
+import type { JoinResponse } from '../models';
+import type { ListTaxonomiesRequest } from '../models';
+import type { ListTaxonomiesResponse } from '../models';
+import type { PatchTaxonomyRequest } from '../models';
+import type { Payload } from '../models';
+import type { TaxonomyResponse } from '../models';
+/**
+ * TaxonomiesApi - axios parameter creator
+ * @export
+ */
+export declare const TaxonomiesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Clone a taxonomy with optional modifications.      **Purpose:**     Creates a NEW taxonomy (with new ID) based on an existing one. This is the     recommended way to iterate on taxonomy designs when you need to modify core     logic that PATCH doesn\'t allow (config, retriever_id, input_mappings).      **Clone vs PATCH vs Template:**     - **PATCH**: Update metadata only (name, description, metadata)     - **Clone**: Copy and modify core logic (config, retriever, collections)     - **Template**: Start from a pre-configured pattern (for new projects)      **Common Use Cases:**     - Fix configuration errors without losing join history     - Change retriever or input mappings     - Modify enrichment fields or collection configuration     - Test modifications before replacing production taxonomy     - Create variants for different datasets      **How it works:**     1. Source taxonomy is copied     2. You provide a new name (REQUIRED)     3. Optionally override any other fields (description, config)     4. A new taxonomy is created with a new ID     5. Original taxonomy remains unchanged
+     * @summary Clone Taxonomy
+     * @param {string} taxonomyIdentifier Source taxonomy ID or name to clone.
+     * @param {CloneTaxonomyRequest} cloneTaxonomyRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \'Bearer sk_xxxxxxxxxxxxx\'. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \'my-namespace\'
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cloneTaxonomyTaxonomies: (taxonomyIdentifier: string, cloneTaxonomyRequest: CloneTaxonomyRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a taxonomy and return the created resource.
+     * @summary Create Taxonomy
+     * @param {CreateTaxonomyRequest} createTaxonomyRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTaxonomyTaxonomies: (createTaxonomyRequest: CreateTaxonomyRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new version for a taxonomy with a new config snapshot.
+     * @summary Create Taxonomy Version
+     * @param {string} taxonomyId Taxonomy ID (tax_...)
+     * @param {{ [key: string]: any; }} requestBody
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTaxonomyVersionTaxonomies: (taxonomyId: string, requestBody: {
+        [key: string]: any;
+    }, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint deletes a taxonomy and all its resources including:     - Taxonomy versions (version snapshots)     - Taxonomy metadata from MongoDB      The deletion is performed synchronously and returns when complete.
+     * @summary Delete Taxonomy
+     * @param {string} taxonomyIdentifier Taxonomy ID or name
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTaxonomyTaxonomies: (taxonomyIdentifier: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * ⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment!  This endpoint validates taxonomy configuration with 1-5 sample documents. Results are returned immediately and NOT persisted to any collection.  ❌ DO NOT USE FOR: - Enriching entire collections (use taxonomy_applications instead) - Batch processing documents (automatic during ingestion) - Persisting enriched documents (use retriever pipelines instead)  ✅ USE THIS FOR: - Testing taxonomy configuration is correct - Validating retriever finds matching taxonomy nodes - Checking enrichment fields are properly applied - Development/debugging taxonomy setup  📚 FOR PRODUCTION ENRICHMENT:  Automatic (during ingestion):   1. Create taxonomy: POST /taxonomies   2. Attach to collection: PUT /collections/{id} with taxonomy_applications field   3. Ingest documents: Documents are automatically enriched by engine  On-the-fly (during retrieval):   1. Add taxonomy_join stage to retriever pipeline   2. Execute retriever: GET /retrievers/{id}/execute   3. Results include enriched documents (not persisted)  See API documentation for Collections and Retrievers for details.
+     * @summary Test taxonomy configuration (validation only)
+     * @param {string} taxonomyIdentifier Taxonomy ID or name to validate
+     * @param {Payload} payload
+     * @param {number} [version] Optional taxonomy version (defaults to latest)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeTaxonomyTaxonomies: (taxonomyIdentifier: string, payload: Payload, version?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a taxonomy by ID or name.
+     * @summary Get Taxonomy
+     * @param {string} taxonomyIdentifier Taxonomy ID or name
+     * @param {number} [version] Optional taxonomy version to fetch
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTaxonomyTaxonomies: (taxonomyIdentifier: string, version?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List taxonomies with optional filters and pagination.
+     * @summary List Taxonomies
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {ListTaxonomiesRequest} [listTaxonomiesRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTaxonomies: (limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listTaxonomiesRequest?: ListTaxonomiesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all versions for a taxonomy (head included as latest).
+     * @summary List Taxonomy Versions
+     * @param {string} taxonomyId Taxonomy ID (tax_...)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTaxonomyVersionsTaxonomies: (taxonomyId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a taxonomy\'s metadata.      **Metadata Only Updates:**     This endpoint allows updating ONLY metadata fields. Core taxonomy logic is immutable     to ensure consistency for join history and dependent resources.      **Fields You CAN Update:**     - taxonomy_name: Rename the taxonomy     - description: Update documentation     - metadata: Update custom metadata      **Fields You CANNOT Update:**     - config: Taxonomy configuration (retriever_id, input_mappings, collections)     - taxonomy_type: Type (flat vs hierarchical)      **Need to Modify Core Logic?**     Use POST /{taxonomy_identifier}/clone instead to modify configuration,     retriever_id, input_mappings, or collections.
+     * @summary Partially Update Taxonomy
+     * @param {string} taxonomyIdentifier Taxonomy ID or name
+     * @param {PatchTaxonomyRequest} patchTaxonomyRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchTaxonomyTaxonomies: (taxonomyIdentifier: string, patchTaxonomyRequest: PatchTaxonomyRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TaxonomiesApi - functional programming interface
+ * @export
+ */
+export declare const TaxonomiesApiFp: (configuration?: Configuration) => {
+    /**
+     * Clone a taxonomy with optional modifications.      **Purpose:**     Creates a NEW taxonomy (with new ID) based on an existing one. This is the     recommended way to iterate on taxonomy designs when you need to modify core     logic that PATCH doesn\'t allow (config, retriever_id, input_mappings).      **Clone vs PATCH vs Template:**     - **PATCH**: Update metadata only (name, description, metadata)     - **Clone**: Copy and modify core logic (config, retriever, collections)     - **Template**: Start from a pre-configured pattern (for new projects)      **Common Use Cases:**     - Fix configuration errors without losing join history     - Change retriever or input mappings     - Modify enrichment fields or collection configuration     - Test modifications before replacing production taxonomy     - Create variants for different datasets      **How it works:**     1. Source taxonomy is copied     2. You provide a new name (REQUIRED)     3. Optionally override any other fields (description, config)     4. A new taxonomy is created with a new ID     5. Original taxonomy remains unchanged
+     * @summary Clone Taxonomy
+     * @param {string} taxonomyIdentifier Source taxonomy ID or name to clone.
+     * @param {CloneTaxonomyRequest} cloneTaxonomyRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cloneTaxonomyTaxonomies(taxonomyIdentifier: string, cloneTaxonomyRequest: CloneTaxonomyRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CloneTaxonomyResponse>>;
+    /**
+     * Create a taxonomy and return the created resource.
+     * @summary Create Taxonomy
+     * @param {CreateTaxonomyRequest} createTaxonomyRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTaxonomyTaxonomies(createTaxonomyRequest: CreateTaxonomyRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxonomyResponse>>;
+    /**
+     * Create a new version for a taxonomy with a new config snapshot.
+     * @summary Create Taxonomy Version
+     * @param {string} taxonomyId Taxonomy ID (tax_...)
+     * @param {{ [key: string]: any; }} requestBody
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTaxonomyVersionTaxonomies(taxonomyId: string, requestBody: {
+        [key: string]: any;
+    }, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxonomyResponse>>;
+    /**
+     * This endpoint deletes a taxonomy and all its resources including:     - Taxonomy versions (version snapshots)     - Taxonomy metadata from MongoDB      The deletion is performed synchronously and returns when complete.
+     * @summary Delete Taxonomy
+     * @param {string} taxonomyIdentifier Taxonomy ID or name
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTaxonomyTaxonomies(taxonomyIdentifier: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * ⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment!  This endpoint validates taxonomy configuration with 1-5 sample documents. Results are returned immediately and NOT persisted to any collection.  ❌ DO NOT USE FOR: - Enriching entire collections (use taxonomy_applications instead) - Batch processing documents (automatic during ingestion) - Persisting enriched documents (use retriever pipelines instead)  ✅ USE THIS FOR: - Testing taxonomy configuration is correct - Validating retriever finds matching taxonomy nodes - Checking enrichment fields are properly applied - Development/debugging taxonomy setup  📚 FOR PRODUCTION ENRICHMENT:  Automatic (during ingestion):   1. Create taxonomy: POST /taxonomies   2. Attach to collection: PUT /collections/{id} with taxonomy_applications field   3. Ingest documents: Documents are automatically enriched by engine  On-the-fly (during retrieval):   1. Add taxonomy_join stage to retriever pipeline   2. Execute retriever: GET /retrievers/{id}/execute   3. Results include enriched documents (not persisted)  See API documentation for Collections and Retrievers for details.
+     * @summary Test taxonomy configuration (validation only)
+     * @param {string} taxonomyIdentifier Taxonomy ID or name to validate
+     * @param {Payload} payload
+     * @param {number} [version] Optional taxonomy version (defaults to latest)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeTaxonomyTaxonomies(taxonomyIdentifier: string, payload: Payload, version?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JoinResponse>>;
+    /**
+     * Get a taxonomy by ID or name.
+     * @summary Get Taxonomy
+     * @param {string} taxonomyIdentifier Taxonomy ID or name
+     * @param {number} [version] Optional taxonomy version to fetch
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTaxonomyTaxonomies(taxonomyIdentifier: string, version?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxonomyResponse>>;
+    /**
+     * List taxonomies with optional filters and pagination.
+     * @summary List Taxonomies
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {ListTaxonomiesRequest} [listTaxonomiesRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTaxonomies(limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listTaxonomiesRequest?: ListTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTaxonomiesResponse>>;
+    /**
+     * List all versions for a taxonomy (head included as latest).
+     * @summary List Taxonomy Versions
+     * @param {string} taxonomyId Taxonomy ID (tax_...)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTaxonomyVersionsTaxonomies(taxonomyId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTaxonomiesResponse>>;
+    /**
+     * Update a taxonomy\'s metadata.      **Metadata Only Updates:**     This endpoint allows updating ONLY metadata fields. Core taxonomy logic is immutable     to ensure consistency for join history and dependent resources.      **Fields You CAN Update:**     - taxonomy_name: Rename the taxonomy     - description: Update documentation     - metadata: Update custom metadata      **Fields You CANNOT Update:**     - config: Taxonomy configuration (retriever_id, input_mappings, collections)     - taxonomy_type: Type (flat vs hierarchical)      **Need to Modify Core Logic?**     Use POST /{taxonomy_identifier}/clone instead to modify configuration,     retriever_id, input_mappings, or collections.
+     * @summary Partially Update Taxonomy
+     * @param {string} taxonomyIdentifier Taxonomy ID or name
+     * @param {PatchTaxonomyRequest} patchTaxonomyRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchTaxonomyTaxonomies(taxonomyIdentifier: string, patchTaxonomyRequest: PatchTaxonomyRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxonomyResponse>>;
+};
+/**
+ * TaxonomiesApi - factory interface
+ * @export
+ */
+export declare const TaxonomiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Clone a taxonomy with optional modifications.      **Purpose:**     Creates a NEW taxonomy (with new ID) based on an existing one. This is the     recommended way to iterate on taxonomy designs when you need to modify core     logic that PATCH doesn\'t allow (config, retriever_id, input_mappings).      **Clone vs PATCH vs Template:**     - **PATCH**: Update metadata only (name, description, metadata)     - **Clone**: Copy and modify core logic (config, retriever, collections)     - **Template**: Start from a pre-configured pattern (for new projects)      **Common Use Cases:**     - Fix configuration errors without losing join history     - Change retriever or input mappings     - Modify enrichment fields or collection configuration     - Test modifications before replacing production taxonomy     - Create variants for different datasets      **How it works:**     1. Source taxonomy is copied     2. You provide a new name (REQUIRED)     3. Optionally override any other fields (description, config)     4. A new taxonomy is created with a new ID     5. Original taxonomy remains unchanged
+     * @summary Clone Taxonomy
+     * @param {TaxonomiesApiCloneTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cloneTaxonomyTaxonomies(requestParameters: TaxonomiesApiCloneTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<CloneTaxonomyResponse>;
+    /**
+     * Create a taxonomy and return the created resource.
+     * @summary Create Taxonomy
+     * @param {TaxonomiesApiCreateTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTaxonomyTaxonomies(requestParameters: TaxonomiesApiCreateTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<TaxonomyResponse>;
+    /**
+     * Create a new version for a taxonomy with a new config snapshot.
+     * @summary Create Taxonomy Version
+     * @param {TaxonomiesApiCreateTaxonomyVersionTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTaxonomyVersionTaxonomies(requestParameters: TaxonomiesApiCreateTaxonomyVersionTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<TaxonomyResponse>;
+    /**
+     * This endpoint deletes a taxonomy and all its resources including:     - Taxonomy versions (version snapshots)     - Taxonomy metadata from MongoDB      The deletion is performed synchronously and returns when complete.
+     * @summary Delete Taxonomy
+     * @param {TaxonomiesApiDeleteTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTaxonomyTaxonomies(requestParameters: TaxonomiesApiDeleteTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * ⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment!  This endpoint validates taxonomy configuration with 1-5 sample documents. Results are returned immediately and NOT persisted to any collection.  ❌ DO NOT USE FOR: - Enriching entire collections (use taxonomy_applications instead) - Batch processing documents (automatic during ingestion) - Persisting enriched documents (use retriever pipelines instead)  ✅ USE THIS FOR: - Testing taxonomy configuration is correct - Validating retriever finds matching taxonomy nodes - Checking enrichment fields are properly applied - Development/debugging taxonomy setup  📚 FOR PRODUCTION ENRICHMENT:  Automatic (during ingestion):   1. Create taxonomy: POST /taxonomies   2. Attach to collection: PUT /collections/{id} with taxonomy_applications field   3. Ingest documents: Documents are automatically enriched by engine  On-the-fly (during retrieval):   1. Add taxonomy_join stage to retriever pipeline   2. Execute retriever: GET /retrievers/{id}/execute   3. Results include enriched documents (not persisted)  See API documentation for Collections and Retrievers for details.
+     * @summary Test taxonomy configuration (validation only)
+     * @param {TaxonomiesApiExecuteTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeTaxonomyTaxonomies(requestParameters: TaxonomiesApiExecuteTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<JoinResponse>;
+    /**
+     * Get a taxonomy by ID or name.
+     * @summary Get Taxonomy
+     * @param {TaxonomiesApiGetTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTaxonomyTaxonomies(requestParameters: TaxonomiesApiGetTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<TaxonomyResponse>;
+    /**
+     * List taxonomies with optional filters and pagination.
+     * @summary List Taxonomies
+     * @param {TaxonomiesApiListTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTaxonomies(requestParameters?: TaxonomiesApiListTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTaxonomiesResponse>;
+    /**
+     * List all versions for a taxonomy (head included as latest).
+     * @summary List Taxonomy Versions
+     * @param {TaxonomiesApiListTaxonomyVersionsTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTaxonomyVersionsTaxonomies(requestParameters: TaxonomiesApiListTaxonomyVersionsTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTaxonomiesResponse>;
+    /**
+     * Update a taxonomy\'s metadata.      **Metadata Only Updates:**     This endpoint allows updating ONLY metadata fields. Core taxonomy logic is immutable     to ensure consistency for join history and dependent resources.      **Fields You CAN Update:**     - taxonomy_name: Rename the taxonomy     - description: Update documentation     - metadata: Update custom metadata      **Fields You CANNOT Update:**     - config: Taxonomy configuration (retriever_id, input_mappings, collections)     - taxonomy_type: Type (flat vs hierarchical)      **Need to Modify Core Logic?**     Use POST /{taxonomy_identifier}/clone instead to modify configuration,     retriever_id, input_mappings, or collections.
+     * @summary Partially Update Taxonomy
+     * @param {TaxonomiesApiPatchTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchTaxonomyTaxonomies(requestParameters: TaxonomiesApiPatchTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<TaxonomyResponse>;
+};
+/**
+ * Request parameters for cloneTaxonomyTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiCloneTaxonomyTaxonomiesRequest
+ */
+export interface TaxonomiesApiCloneTaxonomyTaxonomiesRequest {
+    /**
+     * Source taxonomy ID or name to clone.
+     * @type {string}
+     * @memberof TaxonomiesApiCloneTaxonomyTaxonomies
+     */
+    readonly taxonomyIdentifier: string;
+    /**
+     *
+     * @type {CloneTaxonomyRequest}
+     * @memberof TaxonomiesApiCloneTaxonomyTaxonomies
+     */
+    readonly cloneTaxonomyRequest: CloneTaxonomyRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiCloneTaxonomyTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiCloneTaxonomyTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiCloneTaxonomyTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createTaxonomyTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiCreateTaxonomyTaxonomiesRequest
+ */
+export interface TaxonomiesApiCreateTaxonomyTaxonomiesRequest {
+    /**
+     *
+     * @type {CreateTaxonomyRequest}
+     * @memberof TaxonomiesApiCreateTaxonomyTaxonomies
+     */
+    readonly createTaxonomyRequest: CreateTaxonomyRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createTaxonomyVersionTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiCreateTaxonomyVersionTaxonomiesRequest
+ */
+export interface TaxonomiesApiCreateTaxonomyVersionTaxonomiesRequest {
+    /**
+     * Taxonomy ID (tax_...)
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyVersionTaxonomies
+     */
+    readonly taxonomyId: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof TaxonomiesApiCreateTaxonomyVersionTaxonomies
+     */
+    readonly requestBody: {
+        [key: string]: any;
+    };
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyVersionTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyVersionTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiCreateTaxonomyVersionTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for deleteTaxonomyTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiDeleteTaxonomyTaxonomiesRequest
+ */
+export interface TaxonomiesApiDeleteTaxonomyTaxonomiesRequest {
+    /**
+     * Taxonomy ID or name
+     * @type {string}
+     * @memberof TaxonomiesApiDeleteTaxonomyTaxonomies
+     */
+    readonly taxonomyIdentifier: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiDeleteTaxonomyTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiDeleteTaxonomyTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiDeleteTaxonomyTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for executeTaxonomyTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiExecuteTaxonomyTaxonomiesRequest
+ */
+export interface TaxonomiesApiExecuteTaxonomyTaxonomiesRequest {
+    /**
+     * Taxonomy ID or name to validate
+     * @type {string}
+     * @memberof TaxonomiesApiExecuteTaxonomyTaxonomies
+     */
+    readonly taxonomyIdentifier: string;
+    /**
+     *
+     * @type {Payload}
+     * @memberof TaxonomiesApiExecuteTaxonomyTaxonomies
+     */
+    readonly payload: Payload;
+    /**
+     * Optional taxonomy version (defaults to latest)
+     * @type {number}
+     * @memberof TaxonomiesApiExecuteTaxonomyTaxonomies
+     */
+    readonly version?: number;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiExecuteTaxonomyTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiExecuteTaxonomyTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiExecuteTaxonomyTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getTaxonomyTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiGetTaxonomyTaxonomiesRequest
+ */
+export interface TaxonomiesApiGetTaxonomyTaxonomiesRequest {
+    /**
+     * Taxonomy ID or name
+     * @type {string}
+     * @memberof TaxonomiesApiGetTaxonomyTaxonomies
+     */
+    readonly taxonomyIdentifier: string;
+    /**
+     * Optional taxonomy version to fetch
+     * @type {number}
+     * @memberof TaxonomiesApiGetTaxonomyTaxonomies
+     */
+    readonly version?: number;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiGetTaxonomyTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiGetTaxonomyTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiGetTaxonomyTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiListTaxonomiesRequest
+ */
+export interface TaxonomiesApiListTaxonomiesRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly includeTotal?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly xNamespace?: string;
+    /**
+     *
+     * @type {ListTaxonomiesRequest}
+     * @memberof TaxonomiesApiListTaxonomies
+     */
+    readonly listTaxonomiesRequest?: ListTaxonomiesRequest;
+}
+/**
+ * Request parameters for listTaxonomyVersionsTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiListTaxonomyVersionsTaxonomiesRequest
+ */
+export interface TaxonomiesApiListTaxonomyVersionsTaxonomiesRequest {
+    /**
+     * Taxonomy ID (tax_...)
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomyVersionsTaxonomies
+     */
+    readonly taxonomyId: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomyVersionsTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomyVersionsTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiListTaxonomyVersionsTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for patchTaxonomyTaxonomies operation in TaxonomiesApi.
+ * @export
+ * @interface TaxonomiesApiPatchTaxonomyTaxonomiesRequest
+ */
+export interface TaxonomiesApiPatchTaxonomyTaxonomiesRequest {
+    /**
+     * Taxonomy ID or name
+     * @type {string}
+     * @memberof TaxonomiesApiPatchTaxonomyTaxonomies
+     */
+    readonly taxonomyIdentifier: string;
+    /**
+     *
+     * @type {PatchTaxonomyRequest}
+     * @memberof TaxonomiesApiPatchTaxonomyTaxonomies
+     */
+    readonly patchTaxonomyRequest: PatchTaxonomyRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof TaxonomiesApiPatchTaxonomyTaxonomies
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TaxonomiesApiPatchTaxonomyTaxonomies
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof TaxonomiesApiPatchTaxonomyTaxonomies
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * TaxonomiesApi - object-oriented interface
+ * @export
+ * @class TaxonomiesApi
+ * @extends {BaseAPI}
+ */
+export declare class TaxonomiesApi extends BaseAPI {
+    /**
+     * Clone a taxonomy with optional modifications.      **Purpose:**     Creates a NEW taxonomy (with new ID) based on an existing one. This is the     recommended way to iterate on taxonomy designs when you need to modify core     logic that PATCH doesn\'t allow (config, retriever_id, input_mappings).      **Clone vs PATCH vs Template:**     - **PATCH**: Update metadata only (name, description, metadata)     - **Clone**: Copy and modify core logic (config, retriever, collections)     - **Template**: Start from a pre-configured pattern (for new projects)      **Common Use Cases:**     - Fix configuration errors without losing join history     - Change retriever or input mappings     - Modify enrichment fields or collection configuration     - Test modifications before replacing production taxonomy     - Create variants for different datasets      **How it works:**     1. Source taxonomy is copied     2. You provide a new name (REQUIRED)     3. Optionally override any other fields (description, config)     4. A new taxonomy is created with a new ID     5. Original taxonomy remains unchanged
+     * @summary Clone Taxonomy
+     * @param {TaxonomiesApiCloneTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    cloneTaxonomyTaxonomies(requestParameters: TaxonomiesApiCloneTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CloneTaxonomyResponse, any, {}>>;
+    /**
+     * Create a taxonomy and return the created resource.
+     * @summary Create Taxonomy
+     * @param {TaxonomiesApiCreateTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    createTaxonomyTaxonomies(requestParameters: TaxonomiesApiCreateTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaxonomyResponse, any, {}>>;
+    /**
+     * Create a new version for a taxonomy with a new config snapshot.
+     * @summary Create Taxonomy Version
+     * @param {TaxonomiesApiCreateTaxonomyVersionTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    createTaxonomyVersionTaxonomies(requestParameters: TaxonomiesApiCreateTaxonomyVersionTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaxonomyResponse, any, {}>>;
+    /**
+     * This endpoint deletes a taxonomy and all its resources including:     - Taxonomy versions (version snapshots)     - Taxonomy metadata from MongoDB      The deletion is performed synchronously and returns when complete.
+     * @summary Delete Taxonomy
+     * @param {TaxonomiesApiDeleteTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    deleteTaxonomyTaxonomies(requestParameters: TaxonomiesApiDeleteTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * ⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment!  This endpoint validates taxonomy configuration with 1-5 sample documents. Results are returned immediately and NOT persisted to any collection.  ❌ DO NOT USE FOR: - Enriching entire collections (use taxonomy_applications instead) - Batch processing documents (automatic during ingestion) - Persisting enriched documents (use retriever pipelines instead)  ✅ USE THIS FOR: - Testing taxonomy configuration is correct - Validating retriever finds matching taxonomy nodes - Checking enrichment fields are properly applied - Development/debugging taxonomy setup  📚 FOR PRODUCTION ENRICHMENT:  Automatic (during ingestion):   1. Create taxonomy: POST /taxonomies   2. Attach to collection: PUT /collections/{id} with taxonomy_applications field   3. Ingest documents: Documents are automatically enriched by engine  On-the-fly (during retrieval):   1. Add taxonomy_join stage to retriever pipeline   2. Execute retriever: GET /retrievers/{id}/execute   3. Results include enriched documents (not persisted)  See API documentation for Collections and Retrievers for details.
+     * @summary Test taxonomy configuration (validation only)
+     * @param {TaxonomiesApiExecuteTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    executeTaxonomyTaxonomies(requestParameters: TaxonomiesApiExecuteTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JoinResponse, any, {}>>;
+    /**
+     * Get a taxonomy by ID or name.
+     * @summary Get Taxonomy
+     * @param {TaxonomiesApiGetTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    getTaxonomyTaxonomies(requestParameters: TaxonomiesApiGetTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaxonomyResponse, any, {}>>;
+    /**
+     * List taxonomies with optional filters and pagination.
+     * @summary List Taxonomies
+     * @param {TaxonomiesApiListTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    listTaxonomies(requestParameters?: TaxonomiesApiListTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTaxonomiesResponse, any, {}>>;
+    /**
+     * List all versions for a taxonomy (head included as latest).
+     * @summary List Taxonomy Versions
+     * @param {TaxonomiesApiListTaxonomyVersionsTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    listTaxonomyVersionsTaxonomies(requestParameters: TaxonomiesApiListTaxonomyVersionsTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTaxonomiesResponse, any, {}>>;
+    /**
+     * Update a taxonomy\'s metadata.      **Metadata Only Updates:**     This endpoint allows updating ONLY metadata fields. Core taxonomy logic is immutable     to ensure consistency for join history and dependent resources.      **Fields You CAN Update:**     - taxonomy_name: Rename the taxonomy     - description: Update documentation     - metadata: Update custom metadata      **Fields You CANNOT Update:**     - config: Taxonomy configuration (retriever_id, input_mappings, collections)     - taxonomy_type: Type (flat vs hierarchical)      **Need to Modify Core Logic?**     Use POST /{taxonomy_identifier}/clone instead to modify configuration,     retriever_id, input_mappings, or collections.
+     * @summary Partially Update Taxonomy
+     * @param {TaxonomiesApiPatchTaxonomyTaxonomiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TaxonomiesApi
+     */
+    patchTaxonomyTaxonomies(requestParameters: TaxonomiesApiPatchTaxonomyTaxonomiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaxonomyResponse, any, {}>>;
+}
+//# sourceMappingURL=taxonomies-api.d.ts.map