@llmpulse/sdk 0.0.0-stage → 1.59.0

package/dist/esm/apis/AIModelInsightsApi.js

@@ -0,0 +1,336 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+/**
+ *
+ */
+export class AIModelInsightsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getAiModelInsightsSummary without sending the request
+     */
+    getAiModelInsightsSummaryRequestOpts(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 getAiModelInsightsSummary().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            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['granularity'] != null) {
+                queryParameters['granularity'] = requestParameters['granularity'];
+            }
+            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['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['competitors'] != null) {
+                queryParameters['competitors'] = requestParameters['competitors'];
+            }
+            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 = `/reports/ai_model_insights/summary`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Per-model mentions, citations, brand net sentiment with raw counts, weighted visibility totals/shares, plus actor matrices. All actor entries use the standard shape `{ type, id, competitor_id, name, domain }` with bare (scheme-less) domains.
+     * AI Model Insights summary
+     */
+    getAiModelInsightsSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAiModelInsightsSummaryRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Per-model mentions, citations, brand net sentiment with raw counts, weighted visibility totals/shares, plus actor matrices. All actor entries use the standard shape `{ type, id, competitor_id, name, domain }` with bare (scheme-less) domains.
+     * AI Model Insights summary
+     */
+    getAiModelInsightsSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getAiModelInsightsSummaryRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getAiModelPositionDistribution without sending the request
+     */
+    getAiModelPositionDistributionRequestOpts(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 getAiModelPositionDistribution().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            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['granularity'] != null) {
+                queryParameters['granularity'] = requestParameters['granularity'];
+            }
+            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['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['model'] != null) {
+                queryParameters['model'] = requestParameters['model'];
+            }
+            if (requestParameters['brand1'] != null) {
+                queryParameters['brand1'] = requestParameters['brand1'];
+            }
+            if (requestParameters['brand2'] != null) {
+                queryParameters['brand2'] = requestParameters['brand2'];
+            }
+            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 = `/reports/ai_model_insights/position_distribution`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Position distribution comparison
+     */
+    getAiModelPositionDistributionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAiModelPositionDistributionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Position distribution comparison
+     */
+    getAiModelPositionDistribution(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getAiModelPositionDistributionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getAiOverviewResults without sending the request
+     */
+    getAiOverviewResultsRequestOpts(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 getAiOverviewResults().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            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['granularity'] != null) {
+                queryParameters['granularity'] = requestParameters['granularity'];
+            }
+            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['promptType'] != null) {
+                queryParameters['prompt_type'] = requestParameters['promptType'];
+            }
+            if (requestParameters['brandKind'] != null) {
+                queryParameters['brand_kind'] = requestParameters['brandKind'];
+            }
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['perPage'] != null) {
+                queryParameters['per_page'] = requestParameters['perPage'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/reports/ai_model_insights/ai_overview_results`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Google AI Overview result availability
+     */
+    getAiOverviewResultsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAiOverviewResultsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Google AI Overview result availability
+     */
+    getAiOverviewResults(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getAiOverviewResultsRaw(requestParameters, initOverrides);
+        });
+    }
+}
+/**
+ * @export
+ */
+export const GetAiModelInsightsSummaryGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};
+/**
+ * @export
+ */
+export const GetAiModelInsightsSummaryBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
+/**
+ * @export
+ */
+export const GetAiModelPositionDistributionGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};
+/**
+ * @export
+ */
+export const GetAiModelPositionDistributionBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};
+/**
+ * @export
+ */
+export const GetAiModelPositionDistributionModelEnum = {
+    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
+ */
+export const GetAiOverviewResultsGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};
+/**
+ * @export
+ */
+export const GetAiOverviewResultsBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+};

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

@@ -0,0 +1,59 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 GetAccount200Response } from '../models/GetAccount200Response';
+/**
+ * AccountApi - interface
+ *
+ * @export
+ * @interface AccountApiInterface
+ */
+export interface AccountApiInterface {
+    /**
+     * Creates request options for getAccount without sending the request
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    getAccountRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * @summary Account plan, quota usage and rate limits
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    getAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccount200Response>>;
+    /**
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Account plan, quota usage and rate limits
+     */
+    getAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccount200Response>;
+}
+/**
+ *
+ */
+export declare class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
+    /**
+     * Creates request options for getAccount without sending the request
+     */
+    getAccountRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Account plan, quota usage and rate limits
+     */
+    getAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAccount200Response>>;
+    /**
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Account plan, quota usage and rate limits
+     */
+    getAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAccount200Response>;
+}

package/dist/esm/apis/AccountApi.js

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { GetAccount200ResponseFromJSON, } from '../models/GetAccount200Response';
+/**
+ *
+ */
+export class AccountApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getAccount without sending the request
+     */
+    getAccountRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            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 = `/account`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Account plan, quota usage and rate limits
+     */
+    getAccountRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAccountRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetAccount200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits and manual GEO audit runs in the last 24 hours) and the published API rate limits. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null with unlimited set to true, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key\'s projects, limits.prompts.used counts those projects\' prompts, limits.prompts, limits.intelligence_tasks and the two GEO audit quotas show only remaining and unlimited (the capacity the key can still spend, without the account total), and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects\' data is collected at.
+     * Account plan, quota usage and rate limits
+     */
+    getAccount(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getAccountRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+}