@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/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.60.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; a background job then deletes its mentions, citations, sentiment and share of voice history. Its ads, shopping products, local businesses and brand entities are kept and move to the project or another competitor they match, or stay unattributed. 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; a background job then deletes its mentions, citations, sentiment and share of voice history. Its ads, shopping products, local businesses and brand entities are kept and move to the project or another competitor they match, or stay unattributed. 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; a background job then deletes its mentions, citations, sentiment and share of voice history. Its ads, shopping products, local businesses and brand entities are kept and move to the project or another competitor they match, or stay unattributed. 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; a background job then deletes its mentions, citations, sentiment and share of voice history. Its ads, shopping products, local businesses and brand entities are kept and move to the project or another competitor they match, or stay unattributed. 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];

package/dist/apis/CompetitorsApi.js

@@ -0,0 +1,304 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListCompetitorsOutputEnum = exports.CompetitorsApi = void 0;
+const runtime = require("../runtime");
+const CompetitorCreateResponse_1 = require("../models/CompetitorCreateResponse");
+const CompetitorDetails_1 = require("../models/CompetitorDetails");
+const CreateCompetitorRequest_1 = require("../models/CreateCompetitorRequest");
+const ListCompetitors200Response_1 = require("../models/ListCompetitors200Response");
+const UpdateCompetitorRequest_1 = require("../models/UpdateCompetitorRequest");
+/**
+ *
+ */
+class CompetitorsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createCompetitor without sending the request
+     */
+    createCompetitorRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createCompetitorRequest'] == null) {
+                throw new runtime.RequiredError('createCompetitorRequest', 'Required parameter "createCompetitorRequest" was null or undefined when calling createCompetitor().');
+            }
+            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 = `/competitors`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, CreateCompetitorRequest_1.CreateCompetitorRequestToJSON)(requestParameters['createCompetitorRequest']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createCompetitorRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CompetitorCreateResponse_1.CompetitorCreateResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createCompetitorRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteCompetitor without sending the request
+     */
+    deleteCompetitorRequestOpts(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 deleteCompetitor().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteCompetitor().');
+            }
+            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 = `/competitors/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes a competitor (irreversible). It disappears immediately and frees a competitor slot; a background job then deletes its mentions, citations, sentiment and share of voice history. Its ads, shopping products, local businesses and brand entities are kept and move to the project or another competitor they match, or stay unattributed. Requires a `read_write` scope API key.
+     * Delete a competitor
+     */
+    deleteCompetitorRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteCompetitorRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a competitor (irreversible). It disappears immediately and frees a competitor slot; a background job then deletes its mentions, citations, sentiment and share of voice history. Its ads, shopping products, local businesses and brand entities are kept and move to the project or another competitor they match, or stay unattributed. Requires a `read_write` scope API key.
+     * Delete a competitor
+     */
+    deleteCompetitor(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteCompetitorRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getCompetitorDetails without sending the request
+     */
+    getCompetitorDetailsRequestOpts(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 getCompetitorDetails().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getCompetitorDetails().');
+            }
+            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 = `/dimensions/competitors/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Competitor details
+     */
+    getCompetitorDetailsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCompetitorDetailsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CompetitorDetails_1.CompetitorDetailsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Competitor details
+     */
+    getCompetitorDetails(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCompetitorDetailsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listCompetitors without sending the request
+     */
+    listCompetitorsRequestOpts(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 listCompetitors().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['includeProjectBrand'] != null) {
+                queryParameters['include_project_brand'] = requestParameters['includeProjectBrand'];
+            }
+            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/competitors`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List competitors
+     */
+    listCompetitorsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listCompetitorsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListCompetitors200Response_1.ListCompetitors200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List competitors
+     */
+    listCompetitors(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listCompetitorsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateCompetitor without sending the request
+     */
+    updateCompetitorRequestOpts(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 updateCompetitor().');
+            }
+            if (requestParameters['updateCompetitorRequest'] == null) {
+                throw new runtime.RequiredError('updateCompetitorRequest', 'Required parameter "updateCompetitorRequest" was null or undefined when calling updateCompetitor().');
+            }
+            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 = `/competitors/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, UpdateCompetitorRequest_1.UpdateCompetitorRequestToJSON)(requestParameters['updateCompetitorRequest']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateCompetitorRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateCompetitorRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.CompetitorsApi = CompetitorsApi;
+/**
+ * @export
+ */
+exports.ListCompetitorsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};