@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/esm/apis/HealthApi.js

@@ -0,0 +1,76 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+import { Ping200ResponseFromJSON, } from '../models/Ping200Response';
+/**
+ *
+ */
+export class HealthApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for ping without sending the request
+     */
+    pingRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = `/ping`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id.
+     * Health check
+     */
+    pingRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.pingRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => Ping200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Validates the API key and optionally pings a project. Returns the authenticated user_id, project (if project_id is supplied), and a request_id.
+     * Health check
+     */
+    ping() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.pingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,580 @@
+/**
+ * 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 CitationsResponse } from '../models/CitationsResponse';
+import { type CompetitorMentionsResponse } from '../models/CompetitorMentionsResponse';
+import { type MentionsResponse } from '../models/MentionsResponse';
+export interface ListAllCitationsRequest {
+    projectId: number;
+    competitors?: string;
+    page?: number;
+    perPage?: number;
+    model?: ListAllCitationsModelEnum;
+    collectionId?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListAllCitationsOutputEnum;
+}
+export interface ListAllMentionsRequest {
+    projectId: number;
+    competitors?: string;
+    page?: number;
+    perPage?: number;
+    model?: ListAllMentionsModelEnum;
+    collectionId?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListAllMentionsOutputEnum;
+}
+export interface ListCitationsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    model?: ListCitationsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListCitationsOutputEnum;
+}
+export interface ListCompetitorCitationsRequest {
+    projectId: number;
+    competitors?: string;
+    page?: number;
+    perPage?: number;
+    model?: ListCompetitorCitationsModelEnum;
+    collectionId?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListCompetitorCitationsOutputEnum;
+}
+export interface ListCompetitorMentionsRequest {
+    projectId: number;
+    competitors?: string;
+    page?: number;
+    perPage?: number;
+    model?: ListCompetitorMentionsModelEnum;
+    collectionId?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListCompetitorMentionsOutputEnum;
+}
+export interface ListMentionsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    model?: ListMentionsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListMentionsOutputEnum;
+}
+/**
+ * MentionsCitationsApi - interface
+ *
+ * @export
+ * @interface MentionsCitationsApiInterface
+ */
+export interface MentionsCitationsApiInterface {
+    /**
+     * Creates request options for listAllCitations without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\'s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof MentionsCitationsApiInterface
+     */
+    listAllCitationsRequestOpts(requestParameters: ListAllCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
+     * @summary List all citations (brand + competitor)
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listAllCitationsRaw(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
+     * List all citations (brand + competitor)
+     */
+    listAllCitations(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listAllMentions without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listAllMentionsRequestOpts(requestParameters: ListAllMentionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
+     * @summary List all mentions (brand + competitor)
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listAllMentionsRaw(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
+     * List all mentions (brand + competitor)
+     */
+    listAllMentions(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCitations without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listCitationsRequestOpts(requestParameters: ListCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * @summary List brand citations
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listCitationsRaw(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CitationsResponse>>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * List brand citations
+     */
+    listCitations(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CitationsResponse>;
+    /**
+     * Creates request options for listCompetitorCitations without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listCompetitorCitationsRequestOpts(requestParameters: ListCompetitorCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * @summary List competitor citations
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listCompetitorCitationsRaw(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * List competitor citations
+     */
+    listCompetitorCitations(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCompetitorMentions without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listCompetitorMentionsRequestOpts(requestParameters: ListCompetitorMentionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary List competitor mentions
+     * @param {number} projectId Project ID
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listCompetitorMentionsRaw(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorMentionsResponse>>;
+    /**
+     * List competitor mentions
+     */
+    listCompetitorMentions(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorMentionsResponse>;
+    /**
+     * Creates request options for listMentions without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listMentionsRequestOpts(requestParameters: ListMentionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary List brand mentions
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {Date} [from]
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @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 MentionsCitationsApiInterface
+     */
+    listMentionsRaw(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MentionsResponse>>;
+    /**
+     * List brand mentions
+     */
+    listMentions(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MentionsResponse>;
+}
+/**
+ *
+ */
+export declare class MentionsCitationsApi extends runtime.BaseAPI implements MentionsCitationsApiInterface {
+    /**
+     * Creates request options for listAllCitations without sending the request
+     */
+    listAllCitationsRequestOpts(requestParameters: ListAllCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
+     * List all citations (brand + competitor)
+     */
+    listAllCitationsRaw(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
+     * List all citations (brand + competitor)
+     */
+    listAllCitations(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listAllMentions without sending the request
+     */
+    listAllMentionsRequestOpts(requestParameters: ListAllMentionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
+     * List all mentions (brand + competitor)
+     */
+    listAllMentionsRaw(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
+     * List all mentions (brand + competitor)
+     */
+    listAllMentions(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCitations without sending the request
+     */
+    listCitationsRequestOpts(requestParameters: ListCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * List brand citations
+     */
+    listCitationsRaw(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CitationsResponse>>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * List brand citations
+     */
+    listCitations(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CitationsResponse>;
+    /**
+     * Creates request options for listCompetitorCitations without sending the request
+     */
+    listCompetitorCitationsRequestOpts(requestParameters: ListCompetitorCitationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * List competitor citations
+     */
+    listCompetitorCitationsRaw(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
+     * List competitor citations
+     */
+    listCompetitorCitations(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCompetitorMentions without sending the request
+     */
+    listCompetitorMentionsRequestOpts(requestParameters: ListCompetitorMentionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List competitor mentions
+     */
+    listCompetitorMentionsRaw(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorMentionsResponse>>;
+    /**
+     * List competitor mentions
+     */
+    listCompetitorMentions(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorMentionsResponse>;
+    /**
+     * Creates request options for listMentions without sending the request
+     */
+    listMentionsRequestOpts(requestParameters: ListMentionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List brand mentions
+     */
+    listMentionsRaw(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MentionsResponse>>;
+    /**
+     * List brand mentions
+     */
+    listMentions(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MentionsResponse>;
+}
+/**
+ * @export
+ */
+export declare const ListAllCitationsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListAllCitationsModelEnum = typeof ListAllCitationsModelEnum[keyof typeof ListAllCitationsModelEnum];
+/**
+ * @export
+ */
+export declare const ListAllCitationsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListAllCitationsOutputEnum = typeof ListAllCitationsOutputEnum[keyof typeof ListAllCitationsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListAllMentionsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListAllMentionsModelEnum = typeof ListAllMentionsModelEnum[keyof typeof ListAllMentionsModelEnum];
+/**
+ * @export
+ */
+export declare const ListAllMentionsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListAllMentionsOutputEnum = typeof ListAllMentionsOutputEnum[keyof typeof ListAllMentionsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListCitationsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListCitationsModelEnum = typeof ListCitationsModelEnum[keyof typeof ListCitationsModelEnum];
+/**
+ * @export
+ */
+export declare const ListCitationsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListCitationsOutputEnum = typeof ListCitationsOutputEnum[keyof typeof ListCitationsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorCitationsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListCompetitorCitationsModelEnum = typeof ListCompetitorCitationsModelEnum[keyof typeof ListCompetitorCitationsModelEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorCitationsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListCompetitorCitationsOutputEnum = typeof ListCompetitorCitationsOutputEnum[keyof typeof ListCompetitorCitationsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorMentionsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListCompetitorMentionsModelEnum = typeof ListCompetitorMentionsModelEnum[keyof typeof ListCompetitorMentionsModelEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorMentionsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListCompetitorMentionsOutputEnum = typeof ListCompetitorMentionsOutputEnum[keyof typeof ListCompetitorMentionsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListMentionsModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type ListMentionsModelEnum = typeof ListMentionsModelEnum[keyof typeof ListMentionsModelEnum];
+/**
+ * @export
+ */
+export declare const ListMentionsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListMentionsOutputEnum = typeof ListMentionsOutputEnum[keyof typeof ListMentionsOutputEnum];