@llmpulse/sdk 0.0.0-stage → 1.60.0

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

@@ -0,0 +1,201 @@
+/**
+ * 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 AnnotationCreateResponse } from '../models/AnnotationCreateResponse';
+import { type CreateAnnotationRequest } from '../models/CreateAnnotationRequest';
+import { type UpdateAnnotationRequest } from '../models/UpdateAnnotationRequest';
+export interface CreateAnnotationOperationRequest {
+    createAnnotationRequest: CreateAnnotationRequest;
+}
+export interface DeleteAnnotationRequest {
+    projectId: number;
+    id: number;
+}
+export interface ListAnnotationsRequest {
+    projectId: number;
+    from?: Date;
+    to?: Date;
+    annotationCategoryId?: number;
+    page?: number;
+    perPage?: number;
+}
+export interface UpdateAnnotationOperationRequest {
+    id: number;
+    updateAnnotationRequest: UpdateAnnotationRequest;
+}
+/**
+ * AnnotationsApi - interface
+ *
+ * @export
+ * @interface AnnotationsApiInterface
+ */
+export interface AnnotationsApiInterface {
+    /**
+     * Creates request options for createAnnotation without sending the request
+     * @param {CreateAnnotationRequest} createAnnotationRequest
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    createAnnotationRequestOpts(requestParameters: CreateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * @summary Create a timeline annotation
+     * @param {CreateAnnotationRequest} createAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    createAnnotationRaw(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnnotationCreateResponse>>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotation(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnnotationCreateResponse>;
+    /**
+     * Creates request options for deleteAnnotation without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    deleteAnnotationRequestOpts(requestParameters: DeleteAnnotationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * @summary Delete a timeline annotation
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    deleteAnnotationRaw(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotation(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listAnnotations without sending the request
+     * @param {number} projectId Project ID
+     * @param {Date} [from]
+     * @param {Date} [to]
+     * @param {number} [annotationCategoryId]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    listAnnotationsRequestOpts(requestParameters: ListAnnotationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * @summary List timeline annotations
+     * @param {number} projectId Project ID
+     * @param {Date} [from]
+     * @param {Date} [to]
+     * @param {number} [annotationCategoryId]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    listAnnotationsRaw(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotations(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateAnnotation without sending the request
+     * @param {number} id
+     * @param {UpdateAnnotationRequest} updateAnnotationRequest
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    updateAnnotationRequestOpts(requestParameters: UpdateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * @summary Update a timeline annotation
+     * @param {number} id
+     * @param {UpdateAnnotationRequest} updateAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    updateAnnotationRaw(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotation(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class AnnotationsApi extends runtime.BaseAPI implements AnnotationsApiInterface {
+    /**
+     * Creates request options for createAnnotation without sending the request
+     */
+    createAnnotationRequestOpts(requestParameters: CreateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotationRaw(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnnotationCreateResponse>>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotation(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnnotationCreateResponse>;
+    /**
+     * Creates request options for deleteAnnotation without sending the request
+     */
+    deleteAnnotationRequestOpts(requestParameters: DeleteAnnotationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotationRaw(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotation(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listAnnotations without sending the request
+     */
+    listAnnotationsRequestOpts(requestParameters: ListAnnotationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotationsRaw(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotations(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateAnnotation without sending the request
+     */
+    updateAnnotationRequestOpts(requestParameters: UpdateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotationRaw(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotation(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/esm/apis/AnnotationsApi.js

@@ -0,0 +1,249 @@
+/* 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 { AnnotationCreateResponseFromJSON, } from '../models/AnnotationCreateResponse';
+import { CreateAnnotationRequestToJSON, } from '../models/CreateAnnotationRequest';
+import { UpdateAnnotationRequestToJSON, } from '../models/UpdateAnnotationRequest';
+/**
+ *
+ */
+export class AnnotationsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createAnnotation without sending the request
+     */
+    createAnnotationRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createAnnotationRequest'] == null) {
+                throw new runtime.RequiredError('createAnnotationRequest', 'Required parameter "createAnnotationRequest" was null or undefined when calling createAnnotation().');
+            }
+            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 = `/annotations`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateAnnotationRequestToJSON(requestParameters['createAnnotationRequest']),
+            };
+        });
+    }
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createAnnotationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AnnotationCreateResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAnnotationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteAnnotation without sending the request
+     */
+    deleteAnnotationRequestOpts(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 deleteAnnotation().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteAnnotation().');
+            }
+            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 = `/annotations/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteAnnotationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteAnnotationRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for listAnnotations without sending the request
+     */
+    listAnnotationsRequestOpts(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 listAnnotations().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['from'] != null) {
+                queryParameters['from'] = requestParameters['from'].toISOString().substring(0, 10);
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString().substring(0, 10);
+            }
+            if (requestParameters['annotationCategoryId'] != null) {
+                queryParameters['annotation_category_id'] = requestParameters['annotationCategoryId'];
+            }
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['perPage'] != null) {
+                queryParameters['per_page'] = requestParameters['perPage'];
+            }
+            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 = `/annotations`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotationsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listAnnotationsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotations(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.listAnnotationsRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for updateAnnotation without sending the request
+     */
+    updateAnnotationRequestOpts(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 updateAnnotation().');
+            }
+            if (requestParameters['updateAnnotationRequest'] == null) {
+                throw new runtime.RequiredError('updateAnnotationRequest', 'Required parameter "updateAnnotationRequest" was null or undefined when calling updateAnnotation().');
+            }
+            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 = `/annotations/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateAnnotationRequestToJSON(requestParameters['updateAnnotationRequest']),
+            };
+        });
+    }
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateAnnotationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateAnnotationRaw(requestParameters, initOverrides);
+        });
+    }
+}

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

@@ -0,0 +1,197 @@
+/**
+ * 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 AnswerDetails } from '../models/AnswerDetails';
+export interface GetAnswerRequest {
+    projectId: number;
+    id: number;
+    includeSourcePageDetails?: boolean;
+}
+export interface ListAnswersRequest {
+    projectId: number;
+    model?: ListAnswersModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    mentionFilter?: ListAnswersMentionFilterEnum;
+    citationFilter?: ListAnswersCitationFilterEnum;
+    competitors?: string;
+    from?: Date;
+    to?: Date;
+    page?: number;
+    perPage?: number;
+    query?: string;
+    noResult?: boolean;
+}
+/**
+ * AnswersApi - interface
+ *
+ * @export
+ * @interface AnswersApiInterface
+ */
+export interface AnswersApiInterface {
+    /**
+     * Creates request options for getAnswer without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @param {boolean} [includeSourcePageDetails]
+     * @throws {RequiredError}
+     * @memberof AnswersApiInterface
+     */
+    getAnswerRequestOpts(requestParameters: GetAnswerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Full answer with mentions, citations, sentiments, sources, shopping_products, brand_entities, fan_out_queries. Pass `include_source_page_details=true` to nest page-cache metadata under each source.
+     * @summary Get one AI response
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @param {boolean} [includeSourcePageDetails]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnswersApiInterface
+     */
+    getAnswerRaw(requestParameters: GetAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnswerDetails>>;
+    /**
+     * Full answer with mentions, citations, sentiments, sources, shopping_products, brand_entities, fan_out_queries. Pass `include_source_page_details=true` to nest page-cache metadata under each source.
+     * Get one AI response
+     */
+    getAnswer(requestParameters: GetAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnswerDetails>;
+    /**
+     * Creates request options for listAnswers without sending the request
+     * @param {number} projectId Project ID
+     * @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 {'mentions_you' | 'not_mentions_you' | 'mentions_competitor' | 'not_mentions_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'no_brands'} [mentionFilter] Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space). Combine with \&#39;competitors\&#39; to narrow the competitor side to specific rivals; on a negative cell that reads \&#39;none of these\&#39;. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value \&#39;competitors_only\&#39; is still accepted as an alias of competitor_not_you.
+     * @param {'cites_you' | 'not_cites_you' | 'cites_competitor' | 'not_cites_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'cites_no_brands'} [citationFilter] Same two-axis matrix applied to the domains cited in the answer instead of the brands named in it. Independent of mention_filter; pass both to intersect them (e.g. mentions_you + not_cites_you finds answers that talk about you without linking to you).
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @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 {number} [page]
+     * @param {number} [perPage]
+     * @param {string} [query] Case-insensitive full-text search inside AI response texts. Switches items to snippet + match_count mode.
+     * @param {boolean} [noResult] Filter sentinel non-answers (provider returned nothing after retries; excluded from platform metrics). false &#x3D; only real answers, true &#x3D; only sentinels, omit &#x3D; both. Every item carries its own no_result flag.
+     * @throws {RequiredError}
+     * @memberof AnswersApiInterface
+     */
+    listAnswersRequestOpts(requestParameters: ListAnswersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Successful prompt-execution responses with truncated content (max 10,000 chars). Pass `query` for case-insensitive full-text search inside response texts: `total` becomes the exact count of matching responses and each item returns `snippet` + `match_count` instead of `response`/`response_truncated`.
+     * @summary List AI responses
+     * @param {number} projectId Project ID
+     * @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 {'mentions_you' | 'not_mentions_you' | 'mentions_competitor' | 'not_mentions_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'no_brands'} [mentionFilter] Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space). Combine with \&#39;competitors\&#39; to narrow the competitor side to specific rivals; on a negative cell that reads \&#39;none of these\&#39;. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value \&#39;competitors_only\&#39; is still accepted as an alias of competitor_not_you.
+     * @param {'cites_you' | 'not_cites_you' | 'cites_competitor' | 'not_cites_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'cites_no_brands'} [citationFilter] Same two-axis matrix applied to the domains cited in the answer instead of the brands named in it. Independent of mention_filter; pass both to intersect them (e.g. mentions_you + not_cites_you finds answers that talk about you without linking to you).
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @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 {number} [page]
+     * @param {number} [perPage]
+     * @param {string} [query] Case-insensitive full-text search inside AI response texts. Switches items to snippet + match_count mode.
+     * @param {boolean} [noResult] Filter sentinel non-answers (provider returned nothing after retries; excluded from platform metrics). false &#x3D; only real answers, true &#x3D; only sentinels, omit &#x3D; both. Every item carries its own no_result flag.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnswersApiInterface
+     */
+    listAnswersRaw(requestParameters: ListAnswersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Successful prompt-execution responses with truncated content (max 10,000 chars). Pass `query` for case-insensitive full-text search inside response texts: `total` becomes the exact count of matching responses and each item returns `snippet` + `match_count` instead of `response`/`response_truncated`.
+     * List AI responses
+     */
+    listAnswers(requestParameters: ListAnswersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class AnswersApi extends runtime.BaseAPI implements AnswersApiInterface {
+    /**
+     * Creates request options for getAnswer without sending the request
+     */
+    getAnswerRequestOpts(requestParameters: GetAnswerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Full answer with mentions, citations, sentiments, sources, shopping_products, brand_entities, fan_out_queries. Pass `include_source_page_details=true` to nest page-cache metadata under each source.
+     * Get one AI response
+     */
+    getAnswerRaw(requestParameters: GetAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnswerDetails>>;
+    /**
+     * Full answer with mentions, citations, sentiments, sources, shopping_products, brand_entities, fan_out_queries. Pass `include_source_page_details=true` to nest page-cache metadata under each source.
+     * Get one AI response
+     */
+    getAnswer(requestParameters: GetAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnswerDetails>;
+    /**
+     * Creates request options for listAnswers without sending the request
+     */
+    listAnswersRequestOpts(requestParameters: ListAnswersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Successful prompt-execution responses with truncated content (max 10,000 chars). Pass `query` for case-insensitive full-text search inside response texts: `total` becomes the exact count of matching responses and each item returns `snippet` + `match_count` instead of `response`/`response_truncated`.
+     * List AI responses
+     */
+    listAnswersRaw(requestParameters: ListAnswersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Successful prompt-execution responses with truncated content (max 10,000 chars). Pass `query` for case-insensitive full-text search inside response texts: `total` becomes the exact count of matching responses and each item returns `snippet` + `match_count` instead of `response`/`response_truncated`.
+     * List AI responses
+     */
+    listAnswers(requestParameters: ListAnswersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const ListAnswersModelEnum: {
+    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 ListAnswersModelEnum = typeof ListAnswersModelEnum[keyof typeof ListAnswersModelEnum];
+/**
+ * @export
+ */
+export declare const ListAnswersMentionFilterEnum: {
+    readonly MentionsYou: "mentions_you";
+    readonly NotMentionsYou: "not_mentions_you";
+    readonly MentionsCompetitor: "mentions_competitor";
+    readonly NotMentionsCompetitor: "not_mentions_competitor";
+    readonly YouAndCompetitor: "you_and_competitor";
+    readonly CompetitorNotYou: "competitor_not_you";
+    readonly YouNotCompetitor: "you_not_competitor";
+    readonly NoBrands: "no_brands";
+};
+export type ListAnswersMentionFilterEnum = typeof ListAnswersMentionFilterEnum[keyof typeof ListAnswersMentionFilterEnum];
+/**
+ * @export
+ */
+export declare const ListAnswersCitationFilterEnum: {
+    readonly CitesYou: "cites_you";
+    readonly NotCitesYou: "not_cites_you";
+    readonly CitesCompetitor: "cites_competitor";
+    readonly NotCitesCompetitor: "not_cites_competitor";
+    readonly YouAndCompetitor: "you_and_competitor";
+    readonly CompetitorNotYou: "competitor_not_you";
+    readonly YouNotCompetitor: "you_not_competitor";
+    readonly CitesNoBrands: "cites_no_brands";
+};
+export type ListAnswersCitationFilterEnum = typeof ListAnswersCitationFilterEnum[keyof typeof ListAnswersCitationFilterEnum];