@llmpulse/sdk 0.0.0-stage → 1.59.0

package/dist/esm/apis/CollectionsTagsApi.js

@@ -0,0 +1,353 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.0
+ * Contact: info@llmpulse.ai
+ *
+ * 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 { AssignPromptTagsRequestToJSON, } from '../models/AssignPromptTagsRequest';
+import { CollectionCreateResponseFromJSON, } from '../models/CollectionCreateResponse';
+import { CollectionsResponseFromJSON, } from '../models/CollectionsResponse';
+import { CreateCollectionRequestToJSON, } from '../models/CreateCollectionRequest';
+import { PromptTagsAssignResponseFromJSON, } from '../models/PromptTagsAssignResponse';
+import { UpdateCollectionRequestToJSON, } from '../models/UpdateCollectionRequest';
+/**
+ *
+ */
+export class CollectionsTagsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for assignPromptTags without sending the request
+     */
+    assignPromptTagsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['assignPromptTagsRequest'] == null) {
+                throw new runtime.RequiredError('assignPromptTagsRequest', 'Required parameter "assignPromptTagsRequest" was null or undefined when calling assignPromptTags().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/prompts/assign_tags`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AssignPromptTagsRequestToJSON(requestParameters['assignPromptTagsRequest']),
+            };
+        });
+    }
+    /**
+     * Idempotent bulk assignment of tags (Collections) to existing prompts. Tags can be resolved by id or by name (case-insensitive). Use `create_missing: true` to auto-create unknown tag names. Requires a `read_write` scope API key.
+     * Bulk-attach tags to prompts
+     */
+    assignPromptTagsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.assignPromptTagsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PromptTagsAssignResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Idempotent bulk assignment of tags (Collections) to existing prompts. Tags can be resolved by id or by name (case-insensitive). Use `create_missing: true` to auto-create unknown tag names. Requires a `read_write` scope API key.
+     * Bulk-attach tags to prompts
+     */
+    assignPromptTags(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.assignPromptTagsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for createCollection without sending the request
+     */
+    createCollectionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createCollectionRequest'] == null) {
+                throw new runtime.RequiredError('createCollectionRequest', 'Required parameter "createCollectionRequest" was null or undefined when calling createCollection().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/collections`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateCollectionRequestToJSON(requestParameters['createCollectionRequest']),
+            };
+        });
+    }
+    /**
+     * Creates a tag (Collection) in a project. Optional `prompt_ids` attaches existing prompts in the same call. Tag name must be unique per project (case-insensitive). Requires a `read_write` scope API key.
+     * Create a tag
+     */
+    createCollectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createCollectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CollectionCreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a tag (Collection) in a project. Optional `prompt_ids` attaches existing prompts in the same call. Tag name must be unique per project (case-insensitive). Requires a `read_write` scope API key.
+     * Create a tag
+     */
+    createCollection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createCollectionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteCollection without sending the request
+     */
+    deleteCollectionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling deleteCollection().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteCollection().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/collections/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes a tag/collection. The prompts inside it are NOT deleted; only the grouping disappears. Requires a `read_write` scope API key.
+     * Delete a tag
+     */
+    deleteCollectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteCollectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a tag/collection. The prompts inside it are NOT deleted; only the grouping disappears. Requires a `read_write` scope API key.
+     * Delete a tag
+     */
+    deleteCollection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteCollectionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for listCollections without sending the request
+     */
+    listCollectionsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling listCollections().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['output'] != null) {
+                queryParameters['output'] = requestParameters['output'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/collections`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List tags/collections
+     */
+    listCollectionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listCollectionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CollectionsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List tags/collections
+     */
+    listCollections(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listCollectionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listTags without sending the request
+     */
+    listTagsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling listTags().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['output'] != null) {
+                queryParameters['output'] = requestParameters['output'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/tags`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List tags (alias for /collections)
+     */
+    listTagsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listTagsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CollectionsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List tags (alias for /collections)
+     */
+    listTags(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listTagsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateCollection without sending the request
+     */
+    updateCollectionRequestOpts(requestParameters) {
+        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 updateCollection().');
+            }
+            if (requestParameters['updateCollectionRequest'] == null) {
+                throw new runtime.RequiredError('updateCollectionRequest', 'Required parameter "updateCollectionRequest" was null or undefined when calling updateCollection().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/collections/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateCollectionRequestToJSON(requestParameters['updateCollectionRequest']),
+            };
+        });
+    }
+    /**
+     * Renames a tag/collection or changes its description. Prompt membership is managed via POST /prompts/assign_tags, not here. Requires a `read_write` scope API key.
+     * Update a tag
+     */
+    updateCollectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateCollectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Renames a tag/collection or changes its description. Prompt membership is managed via POST /prompts/assign_tags, not here. Requires a `read_write` scope API key.
+     * Update a tag
+     */
+    updateCollection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateCollectionRaw(requestParameters, initOverrides);
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ListCollectionsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};
+/**
+ * @export
+ */
+export const ListTagsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};

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

@@ -0,0 +1,237 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.0
+ * Contact: info@llmpulse.ai
+ *
+ * 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 CompetitorCreateResponse } from '../models/CompetitorCreateResponse';
+import { type CompetitorDetails } from '../models/CompetitorDetails';
+import { type CreateCompetitorRequest } from '../models/CreateCompetitorRequest';
+import { type ListCompetitors200Response } from '../models/ListCompetitors200Response';
+import { type UpdateCompetitorRequest } from '../models/UpdateCompetitorRequest';
+export interface CreateCompetitorOperationRequest {
+    createCompetitorRequest: CreateCompetitorRequest;
+}
+export interface DeleteCompetitorRequest {
+    projectId: number;
+    id: number;
+}
+export interface GetCompetitorDetailsRequest {
+    projectId: number;
+    id: number;
+}
+export interface ListCompetitorsRequest {
+    projectId: number;
+    includeProjectBrand?: boolean;
+    output?: ListCompetitorsOutputEnum;
+}
+export interface UpdateCompetitorOperationRequest {
+    id: number;
+    updateCompetitorRequest: UpdateCompetitorRequest;
+}
+/**
+ * CompetitorsApi - interface
+ *
+ * @export
+ * @interface CompetitorsApiInterface
+ */
+export interface CompetitorsApiInterface {
+    /**
+     * Creates request options for createCompetitor without sending the request
+     * @param {CreateCompetitorRequest} createCompetitorRequest
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    createCompetitorRequestOpts(requestParameters: CreateCompetitorOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Adds a competitor with its own citation URL matching rule. Honours the per-plan max competitors cap. Requires a `read_write` scope API key.
+     * @summary Add a competitor
+     * @param {CreateCompetitorRequest} createCompetitorRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    createCompetitorRaw(requestParameters: CreateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorCreateResponse>>;
+    /**
+     * Adds a competitor with its own citation URL matching rule. Honours the per-plan max competitors cap. Requires a `read_write` scope API key.
+     * Add a competitor
+     */
+    createCompetitor(requestParameters: CreateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorCreateResponse>;
+    /**
+     * Creates request options for deleteCompetitor without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    deleteCompetitorRequestOpts(requestParameters: DeleteCompetitorRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes a competitor (irreversible). It disappears immediately and frees a competitor slot; its tracked data is purged by a background job. Requires a `read_write` scope API key.
+     * @summary Delete a competitor
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    deleteCompetitorRaw(requestParameters: DeleteCompetitorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a competitor (irreversible). It disappears immediately and frees a competitor slot; its tracked data is purged by a background job. Requires a `read_write` scope API key.
+     * Delete a competitor
+     */
+    deleteCompetitor(requestParameters: DeleteCompetitorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCompetitorDetails without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    getCompetitorDetailsRequestOpts(requestParameters: GetCompetitorDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Competitor details
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    getCompetitorDetailsRaw(requestParameters: GetCompetitorDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorDetails>>;
+    /**
+     * Competitor details
+     */
+    getCompetitorDetails(requestParameters: GetCompetitorDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorDetails>;
+    /**
+     * Creates request options for listCompetitors without sending the request
+     * @param {number} projectId Project ID
+     * @param {boolean} [includeProjectBrand] When true, prepends the project brand with actor_type&#x3D;project and is_own&#x3D;true
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    listCompetitorsRequestOpts(requestParameters: ListCompetitorsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary List competitors
+     * @param {number} projectId Project ID
+     * @param {boolean} [includeProjectBrand] When true, prepends the project brand with actor_type&#x3D;project and is_own&#x3D;true
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    listCompetitorsRaw(requestParameters: ListCompetitorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCompetitors200Response>>;
+    /**
+     * List competitors
+     */
+    listCompetitors(requestParameters: ListCompetitorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCompetitors200Response>;
+    /**
+     * Creates request options for updateCompetitor without sending the request
+     * @param {number} id
+     * @param {UpdateCompetitorRequest} updateCompetitorRequest
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    updateCompetitorRequestOpts(requestParameters: UpdateCompetitorOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates brand_name, the competitor website domain or host, matching_names (full replacement list; the brand name is always included automatically), color and/or the citation URL matching rule. Website domain/host and citation-rule changes share one seven-day cooldown per competitor; other fields remain editable during the cooldown. Name, website or citation-rule changes re-run historical matching in the background: the competitor shows processing=true for a few minutes and further edits are rejected meanwhile. Requires a `read_write` scope API key.
+     * @summary Update a competitor
+     * @param {number} id
+     * @param {UpdateCompetitorRequest} updateCompetitorRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    updateCompetitorRaw(requestParameters: UpdateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates brand_name, the competitor website domain or host, matching_names (full replacement list; the brand name is always included automatically), color and/or the citation URL matching rule. Website domain/host and citation-rule changes share one seven-day cooldown per competitor; other fields remain editable during the cooldown. Name, website or citation-rule changes re-run historical matching in the background: the competitor shows processing=true for a few minutes and further edits are rejected meanwhile. Requires a `read_write` scope API key.
+     * Update a competitor
+     */
+    updateCompetitor(requestParameters: UpdateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class CompetitorsApi extends runtime.BaseAPI implements CompetitorsApiInterface {
+    /**
+     * Creates request options for createCompetitor without sending the request
+     */
+    createCompetitorRequestOpts(requestParameters: CreateCompetitorOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Adds a competitor with its own citation URL matching rule. Honours the per-plan max competitors cap. Requires a `read_write` scope API key.
+     * Add a competitor
+     */
+    createCompetitorRaw(requestParameters: CreateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorCreateResponse>>;
+    /**
+     * Adds a competitor with its own citation URL matching rule. Honours the per-plan max competitors cap. Requires a `read_write` scope API key.
+     * Add a competitor
+     */
+    createCompetitor(requestParameters: CreateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorCreateResponse>;
+    /**
+     * Creates request options for deleteCompetitor without sending the request
+     */
+    deleteCompetitorRequestOpts(requestParameters: DeleteCompetitorRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes a competitor (irreversible). It disappears immediately and frees a competitor slot; its tracked data is purged by a background job. Requires a `read_write` scope API key.
+     * Delete a competitor
+     */
+    deleteCompetitorRaw(requestParameters: DeleteCompetitorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a competitor (irreversible). It disappears immediately and frees a competitor slot; its tracked data is purged by a background job. Requires a `read_write` scope API key.
+     * Delete a competitor
+     */
+    deleteCompetitor(requestParameters: DeleteCompetitorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCompetitorDetails without sending the request
+     */
+    getCompetitorDetailsRequestOpts(requestParameters: GetCompetitorDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Competitor details
+     */
+    getCompetitorDetailsRaw(requestParameters: GetCompetitorDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorDetails>>;
+    /**
+     * Competitor details
+     */
+    getCompetitorDetails(requestParameters: GetCompetitorDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorDetails>;
+    /**
+     * Creates request options for listCompetitors without sending the request
+     */
+    listCompetitorsRequestOpts(requestParameters: ListCompetitorsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List competitors
+     */
+    listCompetitorsRaw(requestParameters: ListCompetitorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCompetitors200Response>>;
+    /**
+     * List competitors
+     */
+    listCompetitors(requestParameters: ListCompetitorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCompetitors200Response>;
+    /**
+     * Creates request options for updateCompetitor without sending the request
+     */
+    updateCompetitorRequestOpts(requestParameters: UpdateCompetitorOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates brand_name, the competitor website domain or host, matching_names (full replacement list; the brand name is always included automatically), color and/or the citation URL matching rule. Website domain/host and citation-rule changes share one seven-day cooldown per competitor; other fields remain editable during the cooldown. Name, website or citation-rule changes re-run historical matching in the background: the competitor shows processing=true for a few minutes and further edits are rejected meanwhile. Requires a `read_write` scope API key.
+     * Update a competitor
+     */
+    updateCompetitorRaw(requestParameters: UpdateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates brand_name, the competitor website domain or host, matching_names (full replacement list; the brand name is always included automatically), color and/or the citation URL matching rule. Website domain/host and citation-rule changes share one seven-day cooldown per competitor; other fields remain editable during the cooldown. Name, website or citation-rule changes re-run historical matching in the background: the competitor shows processing=true for a few minutes and further edits are rejected meanwhile. Requires a `read_write` scope API key.
+     * Update a competitor
+     */
+    updateCompetitor(requestParameters: UpdateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const ListCompetitorsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListCompetitorsOutputEnum = typeof ListCompetitorsOutputEnum[keyof typeof ListCompetitorsOutputEnum];