@llmpulse/sdk 0.0.0-stage → 1.60.0

package/src/apis/PromptsApi.ts

@@ -0,0 +1,938 @@
+/* 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.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type ApiError,
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+} from '../models/ApiError';
+import {
+    type PromptExecutionsResponse,
+    PromptExecutionsResponseFromJSON,
+    PromptExecutionsResponseToJSON,
+} from '../models/PromptExecutionsResponse';
+import {
+    type PromptsCreateRequest,
+    PromptsCreateRequestFromJSON,
+    PromptsCreateRequestToJSON,
+} from '../models/PromptsCreateRequest';
+import {
+    type PromptsCreateResponse,
+    PromptsCreateResponseFromJSON,
+    PromptsCreateResponseToJSON,
+} from '../models/PromptsCreateResponse';
+import {
+    type PromptsResponse,
+    PromptsResponseFromJSON,
+    PromptsResponseToJSON,
+} from '../models/PromptsResponse';
+
+export interface CreatePromptsRequest {
+    promptsCreateRequest: PromptsCreateRequest;
+}
+
+export interface DeletePromptRequest {
+    projectId: number;
+    id: number;
+}
+
+export interface ListPromptExecutionsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    model?: ListPromptExecutionsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    mentionFilter?: ListPromptExecutionsMentionFilterEnum;
+    citationFilter?: ListPromptExecutionsCitationFilterEnum;
+    competitors?: string;
+    output?: ListPromptExecutionsOutputEnum;
+}
+
+export interface ListPromptsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    model?: ListPromptsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: ListPromptsBrandKindEnum;
+    from?: Date;
+    to?: Date;
+    output?: ListPromptsOutputEnum;
+}
+
+export interface ListQueryFanOutsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    view?: ListQueryFanOutsViewEnum;
+    order?: ListQueryFanOutsOrderEnum;
+    direction?: ListQueryFanOutsDirectionEnum;
+    query?: string;
+    model?: ListQueryFanOutsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: ListQueryFanOutsBrandKindEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    output?: ListQueryFanOutsOutputEnum;
+}
+
+/**
+ * PromptsApi - interface
+ * 
+ * @export
+ * @interface PromptsApiInterface
+ */
+export interface PromptsApiInterface {
+    /**
+     * Creates request options for createPrompts without sending the request
+     * @param {PromptsCreateRequest} promptsCreateRequest 
+     * @throws {RequiredError}
+     * @memberof PromptsApiInterface
+     */
+    createPromptsRequestOpts(requestParameters: CreatePromptsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Add prompts to a project in bulk (up to 100 per request). Validates the account prompt quota and skips duplicates. Requires a `read_write` scope API key.
+     * @summary Bulk-create prompts
+     * @param {PromptsCreateRequest} promptsCreateRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PromptsApiInterface
+     */
+    createPromptsRaw(requestParameters: CreatePromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptsCreateResponse>>;
+
+    /**
+     * Add prompts to a project in bulk (up to 100 per request). Validates the account prompt quota and skips duplicates. Requires a `read_write` scope API key.
+     * Bulk-create prompts
+     */
+    createPrompts(requestParameters: CreatePromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptsCreateResponse>;
+
+    /**
+     * Creates request options for deletePrompt without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id 
+     * @throws {RequiredError}
+     * @memberof PromptsApiInterface
+     */
+    deletePromptRequestOpts(requestParameters: DeletePromptRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Deletes a prompt (irreversible). The prompt disappears immediately and frees a prompt slot; its historical data (executions, mentions, citations, sentiment) is purged by a background job. Requires a `read_write` scope API key.
+     * @summary Delete a prompt
+     * @param {number} projectId Project ID
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PromptsApiInterface
+     */
+    deletePromptRaw(requestParameters: DeletePromptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Deletes a prompt (irreversible). The prompt disappears immediately and frees a prompt slot; its historical data (executions, mentions, citations, sentiment) is purged by a background job. Requires a `read_write` scope API key.
+     * Delete a prompt
+     */
+    deletePrompt(requestParameters: DeletePromptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for listPromptExecutions 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 {'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 {'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 PromptsApiInterface
+     */
+    listPromptExecutionsRequestOpts(requestParameters: ListPromptExecutionsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List prompt executions
+     * @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 {'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 {'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 PromptsApiInterface
+     */
+    listPromptExecutionsRaw(requestParameters: ListPromptExecutionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptExecutionsResponse>>;
+
+    /**
+     * List prompt executions
+     */
+    listPromptExecutions(requestParameters: ListPromptExecutionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptExecutionsResponse>;
+
+    /**
+     * Creates request options for listPrompts 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] Keep only the prompts with at least one execution on this AI model, of any outcome and date (the prompts /dimensions/prompt_executions lists for the same model). Prompts have no model of their own, so a prompt with no execution on this model yet (a newly enabled model, or a locale the model does not cover) is left out. An unknown value, or a model the API key\&#39;s user has not enabled, returns 422 ERR_INVALID_PARAM. from and to still filter prompt creation.
+     * @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 {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @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 PromptsApiInterface
+     */
+    listPromptsRequestOpts(requestParameters: ListPromptsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List prompts
+     * @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] Keep only the prompts with at least one execution on this AI model, of any outcome and date (the prompts /dimensions/prompt_executions lists for the same model). Prompts have no model of their own, so a prompt with no execution on this model yet (a newly enabled model, or a locale the model does not cover) is left out. An unknown value, or a model the API key\&#39;s user has not enabled, returns 422 ERR_INVALID_PARAM. from and to still filter prompt creation.
+     * @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 {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @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 PromptsApiInterface
+     */
+    listPromptsRaw(requestParameters: ListPromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptsResponse>>;
+
+    /**
+     * List prompts
+     */
+    listPrompts(requestParameters: ListPromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptsResponse>;
+
+    /**
+     * Creates request options for listQueryFanOuts without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'query' | 'prompt'} [view] Row shape: one per distinct sub-query, or one per prompt
+     * @param {'count' | 'share' | 'query_text' | 'total_count' | 'variations_count' | 'prompt_text'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction] 
+     * @param {string} [query] Case-insensitive substring filter on the sub-query text
+     * @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 {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @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 PromptsApiInterface
+     */
+    listQueryFanOutsRequestOpts(requestParameters: ListQueryFanOutsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * The sub-queries a model actually issued when answering your tracked prompts. view=query (default) returns one row per distinct sub-query with count and share of all occurrences; view=prompt returns one row per prompt with how many distinct sub-queries it produced. Fan-out is reported mainly by ChatGPT, so an empty result usually means the models in scope do not expose it. The API returns the aggregation only: for a period-over-period delta, call it twice with explicit from/to.
+     * @summary List query fan-out
+     * @param {number} projectId Project ID
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'query' | 'prompt'} [view] Row shape: one per distinct sub-query, or one per prompt
+     * @param {'count' | 'share' | 'query_text' | 'total_count' | 'variations_count' | 'prompt_text'} [order] Sort field; the allowed set depends on view
+     * @param {'asc' | 'desc'} [direction] 
+     * @param {string} [query] Case-insensitive substring filter on the sub-query text
+     * @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 {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @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 PromptsApiInterface
+     */
+    listQueryFanOutsRaw(requestParameters: ListQueryFanOutsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * The sub-queries a model actually issued when answering your tracked prompts. view=query (default) returns one row per distinct sub-query with count and share of all occurrences; view=prompt returns one row per prompt with how many distinct sub-queries it produced. Fan-out is reported mainly by ChatGPT, so an empty result usually means the models in scope do not expose it. The API returns the aggregation only: for a period-over-period delta, call it twice with explicit from/to.
+     * List query fan-out
+     */
+    listQueryFanOuts(requestParameters: ListQueryFanOutsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class PromptsApi extends runtime.BaseAPI implements PromptsApiInterface {
+
+    /**
+     * Creates request options for createPrompts without sending the request
+     */
+    async createPromptsRequestOpts(requestParameters: CreatePromptsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['promptsCreateRequest'] == null) {
+            throw new runtime.RequiredError(
+                'promptsCreateRequest',
+                'Required parameter "promptsCreateRequest" was null or undefined when calling createPrompts().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/prompts`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PromptsCreateRequestToJSON(requestParameters['promptsCreateRequest']),
+        };
+    }
+
+    /**
+     * Add prompts to a project in bulk (up to 100 per request). Validates the account prompt quota and skips duplicates. Requires a `read_write` scope API key.
+     * Bulk-create prompts
+     */
+    async createPromptsRaw(requestParameters: CreatePromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptsCreateResponse>> {
+        const requestOptions = await this.createPromptsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PromptsCreateResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Add prompts to a project in bulk (up to 100 per request). Validates the account prompt quota and skips duplicates. Requires a `read_write` scope API key.
+     * Bulk-create prompts
+     */
+    async createPrompts(requestParameters: CreatePromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptsCreateResponse> {
+        const response = await this.createPromptsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deletePrompt without sending the request
+     */
+    async deletePromptRequestOpts(requestParameters: DeletePromptRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling deletePrompt().'
+            );
+        }
+
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deletePrompt().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/prompts/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Deletes a prompt (irreversible). The prompt disappears immediately and frees a prompt slot; its historical data (executions, mentions, citations, sentiment) is purged by a background job. Requires a `read_write` scope API key.
+     * Delete a prompt
+     */
+    async deletePromptRaw(requestParameters: DeletePromptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deletePromptRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Deletes a prompt (irreversible). The prompt disappears immediately and frees a prompt slot; its historical data (executions, mentions, citations, sentiment) is purged by a background job. Requires a `read_write` scope API key.
+     * Delete a prompt
+     */
+    async deletePrompt(requestParameters: DeletePromptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deletePromptRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for listPromptExecutions without sending the request
+     */
+    async listPromptExecutionsRequestOpts(requestParameters: ListPromptExecutionsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listPromptExecutions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['mentionFilter'] != null) {
+            queryParameters['mention_filter'] = requestParameters['mentionFilter'];
+        }
+
+        if (requestParameters['citationFilter'] != null) {
+            queryParameters['citation_filter'] = requestParameters['citationFilter'];
+        }
+
+        if (requestParameters['competitors'] != null) {
+            queryParameters['competitors'] = requestParameters['competitors'];
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dimensions/prompt_executions`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List prompt executions
+     */
+    async listPromptExecutionsRaw(requestParameters: ListPromptExecutionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptExecutionsResponse>> {
+        const requestOptions = await this.listPromptExecutionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PromptExecutionsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List prompt executions
+     */
+    async listPromptExecutions(requestParameters: ListPromptExecutionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptExecutionsResponse> {
+        const response = await this.listPromptExecutionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listPrompts without sending the request
+     */
+    async listPromptsRequestOpts(requestParameters: ListPromptsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listPrompts().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dimensions/prompts`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List prompts
+     */
+    async listPromptsRaw(requestParameters: ListPromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptsResponse>> {
+        const requestOptions = await this.listPromptsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PromptsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List prompts
+     */
+    async listPrompts(requestParameters: ListPromptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptsResponse> {
+        const response = await this.listPromptsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listQueryFanOuts without sending the request
+     */
+    async listQueryFanOutsRequestOpts(requestParameters: ListQueryFanOutsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling listQueryFanOuts().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['view'] != null) {
+            queryParameters['view'] = requestParameters['view'];
+        }
+
+        if (requestParameters['order'] != null) {
+            queryParameters['order'] = requestParameters['order'];
+        }
+
+        if (requestParameters['direction'] != null) {
+            queryParameters['direction'] = requestParameters['direction'];
+        }
+
+        if (requestParameters['query'] != null) {
+            queryParameters['query'] = requestParameters['query'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['range'] != null) {
+            queryParameters['range'] = requestParameters['range'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dimensions/query_fan_outs`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * The sub-queries a model actually issued when answering your tracked prompts. view=query (default) returns one row per distinct sub-query with count and share of all occurrences; view=prompt returns one row per prompt with how many distinct sub-queries it produced. Fan-out is reported mainly by ChatGPT, so an empty result usually means the models in scope do not expose it. The API returns the aggregation only: for a period-over-period delta, call it twice with explicit from/to.
+     * List query fan-out
+     */
+    async listQueryFanOutsRaw(requestParameters: ListQueryFanOutsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.listQueryFanOutsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * The sub-queries a model actually issued when answering your tracked prompts. view=query (default) returns one row per distinct sub-query with count and share of all occurrences; view=prompt returns one row per prompt with how many distinct sub-queries it produced. Fan-out is reported mainly by ChatGPT, so an empty result usually means the models in scope do not expose it. The API returns the aggregation only: for a period-over-period delta, call it twice with explicit from/to.
+     * List query fan-out
+     */
+    async listQueryFanOuts(requestParameters: ListQueryFanOutsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.listQueryFanOutsRaw(requestParameters, initOverrides);
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListPromptExecutionsModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type ListPromptExecutionsModelEnum = typeof ListPromptExecutionsModelEnum[keyof typeof ListPromptExecutionsModelEnum];
+/**
+ * @export
+ */
+export const ListPromptExecutionsMentionFilterEnum = {
+    MentionsYou: 'mentions_you',
+    NotMentionsYou: 'not_mentions_you',
+    MentionsCompetitor: 'mentions_competitor',
+    NotMentionsCompetitor: 'not_mentions_competitor',
+    YouAndCompetitor: 'you_and_competitor',
+    CompetitorNotYou: 'competitor_not_you',
+    YouNotCompetitor: 'you_not_competitor',
+    NoBrands: 'no_brands'
+} as const;
+export type ListPromptExecutionsMentionFilterEnum = typeof ListPromptExecutionsMentionFilterEnum[keyof typeof ListPromptExecutionsMentionFilterEnum];
+/**
+ * @export
+ */
+export const ListPromptExecutionsCitationFilterEnum = {
+    CitesYou: 'cites_you',
+    NotCitesYou: 'not_cites_you',
+    CitesCompetitor: 'cites_competitor',
+    NotCitesCompetitor: 'not_cites_competitor',
+    YouAndCompetitor: 'you_and_competitor',
+    CompetitorNotYou: 'competitor_not_you',
+    YouNotCompetitor: 'you_not_competitor',
+    CitesNoBrands: 'cites_no_brands'
+} as const;
+export type ListPromptExecutionsCitationFilterEnum = typeof ListPromptExecutionsCitationFilterEnum[keyof typeof ListPromptExecutionsCitationFilterEnum];
+/**
+ * @export
+ */
+export const ListPromptExecutionsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type ListPromptExecutionsOutputEnum = typeof ListPromptExecutionsOutputEnum[keyof typeof ListPromptExecutionsOutputEnum];
+/**
+ * @export
+ */
+export const ListPromptsModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type ListPromptsModelEnum = typeof ListPromptsModelEnum[keyof typeof ListPromptsModelEnum];
+/**
+ * @export
+ */
+export const ListPromptsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type ListPromptsBrandKindEnum = typeof ListPromptsBrandKindEnum[keyof typeof ListPromptsBrandKindEnum];
+/**
+ * @export
+ */
+export const ListPromptsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type ListPromptsOutputEnum = typeof ListPromptsOutputEnum[keyof typeof ListPromptsOutputEnum];
+/**
+ * @export
+ */
+export const ListQueryFanOutsViewEnum = {
+    Query: 'query',
+    Prompt: 'prompt'
+} as const;
+export type ListQueryFanOutsViewEnum = typeof ListQueryFanOutsViewEnum[keyof typeof ListQueryFanOutsViewEnum];
+/**
+ * @export
+ */
+export const ListQueryFanOutsOrderEnum = {
+    Count: 'count',
+    Share: 'share',
+    QueryText: 'query_text',
+    TotalCount: 'total_count',
+    VariationsCount: 'variations_count',
+    PromptText: 'prompt_text'
+} as const;
+export type ListQueryFanOutsOrderEnum = typeof ListQueryFanOutsOrderEnum[keyof typeof ListQueryFanOutsOrderEnum];
+/**
+ * @export
+ */
+export const ListQueryFanOutsDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type ListQueryFanOutsDirectionEnum = typeof ListQueryFanOutsDirectionEnum[keyof typeof ListQueryFanOutsDirectionEnum];
+/**
+ * @export
+ */
+export const ListQueryFanOutsModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type ListQueryFanOutsModelEnum = typeof ListQueryFanOutsModelEnum[keyof typeof ListQueryFanOutsModelEnum];
+/**
+ * @export
+ */
+export const ListQueryFanOutsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type ListQueryFanOutsBrandKindEnum = typeof ListQueryFanOutsBrandKindEnum[keyof typeof ListQueryFanOutsBrandKindEnum];
+/**
+ * @export
+ */
+export const ListQueryFanOutsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type ListQueryFanOutsOutputEnum = typeof ListQueryFanOutsOutputEnum[keyof typeof ListQueryFanOutsOutputEnum];