@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/apis/PromptsApi.d.ts

@@ -0,0 +1,497 @@
+/**
+ * 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 PromptExecutionsResponse } from '../models/PromptExecutionsResponse';
+import { type PromptsCreateRequest } from '../models/PromptsCreateRequest';
+import { type PromptsCreateResponse } from '../models/PromptsCreateResponse';
+import { type PromptsResponse } 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 declare class PromptsApi extends runtime.BaseAPI implements PromptsApiInterface {
+    /**
+     * Creates request options for createPrompts without sending the request
+     */
+    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.
+     * Bulk-create prompts
+     */
+    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
+     */
+    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.
+     * Delete a prompt
+     */
+    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
+     */
+    listPromptExecutionsRequestOpts(requestParameters: ListPromptExecutionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List prompt executions
+     */
+    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
+     */
+    listPromptsRequestOpts(requestParameters: ListPromptsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List prompts
+     */
+    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
+     */
+    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.
+     * List query fan-out
+     */
+    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
+ */
+export declare const ListPromptExecutionsModelEnum: {
+    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 ListPromptExecutionsModelEnum = typeof ListPromptExecutionsModelEnum[keyof typeof ListPromptExecutionsModelEnum];
+/**
+ * @export
+ */
+export declare const ListPromptExecutionsMentionFilterEnum: {
+    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 ListPromptExecutionsMentionFilterEnum = typeof ListPromptExecutionsMentionFilterEnum[keyof typeof ListPromptExecutionsMentionFilterEnum];
+/**
+ * @export
+ */
+export declare const ListPromptExecutionsCitationFilterEnum: {
+    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 ListPromptExecutionsCitationFilterEnum = typeof ListPromptExecutionsCitationFilterEnum[keyof typeof ListPromptExecutionsCitationFilterEnum];
+/**
+ * @export
+ */
+export declare const ListPromptExecutionsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListPromptExecutionsOutputEnum = typeof ListPromptExecutionsOutputEnum[keyof typeof ListPromptExecutionsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListPromptsModelEnum: {
+    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 ListPromptsModelEnum = typeof ListPromptsModelEnum[keyof typeof ListPromptsModelEnum];
+/**
+ * @export
+ */
+export declare const ListPromptsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListPromptsBrandKindEnum = typeof ListPromptsBrandKindEnum[keyof typeof ListPromptsBrandKindEnum];
+/**
+ * @export
+ */
+export declare const ListPromptsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListPromptsOutputEnum = typeof ListPromptsOutputEnum[keyof typeof ListPromptsOutputEnum];
+/**
+ * @export
+ */
+export declare const ListQueryFanOutsViewEnum: {
+    readonly Query: "query";
+    readonly Prompt: "prompt";
+};
+export type ListQueryFanOutsViewEnum = typeof ListQueryFanOutsViewEnum[keyof typeof ListQueryFanOutsViewEnum];
+/**
+ * @export
+ */
+export declare const ListQueryFanOutsOrderEnum: {
+    readonly Count: "count";
+    readonly Share: "share";
+    readonly QueryText: "query_text";
+    readonly TotalCount: "total_count";
+    readonly VariationsCount: "variations_count";
+    readonly PromptText: "prompt_text";
+};
+export type ListQueryFanOutsOrderEnum = typeof ListQueryFanOutsOrderEnum[keyof typeof ListQueryFanOutsOrderEnum];
+/**
+ * @export
+ */
+export declare const ListQueryFanOutsDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListQueryFanOutsDirectionEnum = typeof ListQueryFanOutsDirectionEnum[keyof typeof ListQueryFanOutsDirectionEnum];
+/**
+ * @export
+ */
+export declare const ListQueryFanOutsModelEnum: {
+    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 ListQueryFanOutsModelEnum = typeof ListQueryFanOutsModelEnum[keyof typeof ListQueryFanOutsModelEnum];
+/**
+ * @export
+ */
+export declare const ListQueryFanOutsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type ListQueryFanOutsBrandKindEnum = typeof ListQueryFanOutsBrandKindEnum[keyof typeof ListQueryFanOutsBrandKindEnum];
+/**
+ * @export
+ */
+export declare const ListQueryFanOutsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListQueryFanOutsOutputEnum = typeof ListQueryFanOutsOutputEnum[keyof typeof ListQueryFanOutsOutputEnum];