@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/apis/PromptsApi.js

@@ -0,0 +1,551 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListQueryFanOutsOutputEnum = exports.ListQueryFanOutsBrandKindEnum = exports.ListQueryFanOutsModelEnum = exports.ListQueryFanOutsDirectionEnum = exports.ListQueryFanOutsOrderEnum = exports.ListQueryFanOutsViewEnum = exports.ListPromptsOutputEnum = exports.ListPromptsBrandKindEnum = exports.ListPromptsModelEnum = exports.ListPromptExecutionsOutputEnum = exports.ListPromptExecutionsCitationFilterEnum = exports.ListPromptExecutionsMentionFilterEnum = exports.ListPromptExecutionsModelEnum = exports.PromptsApi = void 0;
+const runtime = require("../runtime");
+const PromptExecutionsResponse_1 = require("../models/PromptExecutionsResponse");
+const PromptsCreateRequest_1 = require("../models/PromptsCreateRequest");
+const PromptsCreateResponse_1 = require("../models/PromptsCreateResponse");
+const PromptsResponse_1 = require("../models/PromptsResponse");
+/**
+ *
+ */
+class PromptsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createPrompts without sending the request
+     */
+    createPromptsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['promptsCreateRequest'] == null) {
+                throw new runtime.RequiredError('promptsCreateRequest', 'Required parameter "promptsCreateRequest" was null or undefined when calling createPrompts().');
+            }
+            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 = `/prompts`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, PromptsCreateRequest_1.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
+     */
+    createPromptsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createPromptsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PromptsCreateResponse_1.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
+     */
+    createPrompts(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createPromptsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deletePrompt without sending the request
+     */
+    deletePromptRequestOpts(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 deletePrompt().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deletePrompt().');
+            }
+            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 = `/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
+     */
+    deletePromptRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deletePromptRequestOpts(requestParameters);
+            const response = yield 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
+     */
+    deletePrompt(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deletePromptRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for listPromptExecutions without sending the request
+     */
+    listPromptExecutionsRequestOpts(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 listPromptExecutions().');
+            }
+            const queryParameters = {};
+            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'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].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 = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/prompt_executions`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List prompt executions
+     */
+    listPromptExecutionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listPromptExecutionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PromptExecutionsResponse_1.PromptExecutionsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List prompt executions
+     */
+    listPromptExecutions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listPromptExecutionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listPrompts without sending the request
+     */
+    listPromptsRequestOpts(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 listPrompts().');
+            }
+            const queryParameters = {};
+            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'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString();
+            }
+            if (requestParameters['output'] != null) {
+                queryParameters['output'] = requestParameters['output'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/prompts`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List prompts
+     */
+    listPromptsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listPromptsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PromptsResponse_1.PromptsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List prompts
+     */
+    listPrompts(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listPromptsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listQueryFanOuts without sending the request
+     */
+    listQueryFanOutsRequestOpts(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 listQueryFanOuts().');
+            }
+            const queryParameters = {};
+            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'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString();
+            }
+            if (requestParameters['output'] != null) {
+                queryParameters['output'] = requestParameters['output'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/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
+     */
+    listQueryFanOutsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listQueryFanOutsRequestOpts(requestParameters);
+            const response = yield 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
+     */
+    listQueryFanOuts(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.listQueryFanOutsRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.PromptsApi = PromptsApi;
+/**
+ * @export
+ */
+exports.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'
+};
+/**
+ * @export
+ */
+exports.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'
+};
+/**
+ * @export
+ */
+exports.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'
+};
+/**
+ * @export
+ */
+exports.ListPromptExecutionsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};
+/**
+ * @export
+ */
+exports.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'
+};
+/**
+ * @export
+ */
+exports.ListPromptsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
+/**
+ * @export
+ */
+exports.ListPromptsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};
+/**
+ * @export
+ */
+exports.ListQueryFanOutsViewEnum = {
+    Query: 'query',
+    Prompt: 'prompt'
+};
+/**
+ * @export
+ */
+exports.ListQueryFanOutsOrderEnum = {
+    Count: 'count',
+    Share: 'share',
+    QueryText: 'query_text',
+    TotalCount: 'total_count',
+    VariationsCount: 'variations_count',
+    PromptText: 'prompt_text'
+};
+/**
+ * @export
+ */
+exports.ListQueryFanOutsDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+};
+/**
+ * @export
+ */
+exports.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'
+};
+/**
+ * @export
+ */
+exports.ListQueryFanOutsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
+/**
+ * @export
+ */
+exports.ListQueryFanOutsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};