@llmpulse/sdk 1.61.0 → 1.63.0

package/dist/apis/CustomReportsApi.js

@@ -0,0 +1,209 @@
+"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.63.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.ListCustomReportsOutputEnum = exports.CustomReportsApi = void 0;
+const runtime = require("../runtime");
+const CustomReportDetailResponse_1 = require("../models/CustomReportDetailResponse");
+const CustomReportSendResponse_1 = require("../models/CustomReportSendResponse");
+const CustomReportsResponse_1 = require("../models/CustomReportsResponse");
+const SendCustomReportRequest_1 = require("../models/SendCustomReportRequest");
+/**
+ *
+ */
+class CustomReportsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getCustomReport without sending the request
+     */
+    getCustomReportRequestOpts(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 getCustomReport().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getCustomReport().');
+            }
+            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 = `/custom_reports/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * The configuration of one custom report (date range, filters, schedule, layout) and the data of every widget computed for today, the same numbers the report page, its shared link and its PDF show. Each widget carries its `kind` and a `data` object shaped by it: `series` for `timeseries`, `slices` for `donut`, `bars` for `bar`, `values` and `changes` for `kpi_grid`, `rows` for `table`. A widget whose data source is not connected has `available: false` and `data: null`. Nothing is saved or sent. Requires the Scale plan or above.
+     * Get a custom report with its widget data
+     */
+    getCustomReportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCustomReportRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CustomReportDetailResponse_1.CustomReportDetailResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * The configuration of one custom report (date range, filters, schedule, layout) and the data of every widget computed for today, the same numbers the report page, its shared link and its PDF show. Each widget carries its `kind` and a `data` object shaped by it: `series` for `timeseries`, `slices` for `donut`, `bars` for `bar`, `values` and `changes` for `kpi_grid`, `rows` for `table`. A widget whose data source is not connected has `available: false` and `data: null`. Nothing is saved or sent. Requires the Scale plan or above.
+     * Get a custom report with its widget data
+     */
+    getCustomReport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCustomReportRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listCustomReports without sending the request
+     */
+    listCustomReportsRequestOpts(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 listCustomReports().');
+            }
+            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['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 = `/custom_reports`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * The custom reports of the project, newest first, as the Reports > Custom Reports list shows them. Recipient addresses, the shared-link token and the password are never returned. Requires the Scale plan or above.
+     * List custom reports
+     */
+    listCustomReportsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listCustomReportsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CustomReportsResponse_1.CustomReportsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * The custom reports of the project, newest first, as the Reports > Custom Reports list shows them. Recipient addresses, the shared-link token and the password are never returned. Requires the Scale plan or above.
+     * List custom reports
+     */
+    listCustomReports(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listCustomReportsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for sendCustomReport without sending the request
+     */
+    sendCustomReportRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling sendCustomReport().');
+            }
+            if (requestParameters['sendCustomReportRequest'] == null) {
+                throw new runtime.RequiredError('sendCustomReportRequest', 'Required parameter "sendCustomReportRequest" was null or undefined when calling sendCustomReport().');
+            }
+            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 = `/custom_reports/{id}/send`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, SendCustomReportRequest_1.SendCustomReportRequestToJSON)(requestParameters['sendCustomReportRequest']),
+            };
+        });
+    }
+    /**
+     * Queues the report\'s PDF for its recipients, like the Send now button on the report page: the report must be published and have at least one recipient (ERR_INVALID_PARAM otherwise), and each report can be sent once every 10 minutes (429 ERR_RATE_LIMITED with Retry-After). Not available from a white-label portal or for a report made inside one (ERR_INTEGRATION_UNAVAILABLE). Requires the Scale plan or above, a `read_write` scope API key and, for team members, update permission on Custom Reports.
+     * Send a custom report now
+     */
+    sendCustomReportRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.sendCustomReportRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CustomReportSendResponse_1.CustomReportSendResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Queues the report\'s PDF for its recipients, like the Send now button on the report page: the report must be published and have at least one recipient (ERR_INVALID_PARAM otherwise), and each report can be sent once every 10 minutes (429 ERR_RATE_LIMITED with Retry-After). Not available from a white-label portal or for a report made inside one (ERR_INTEGRATION_UNAVAILABLE). Requires the Scale plan or above, a `read_write` scope API key and, for team members, update permission on Custom Reports.
+     * Send a custom report now
+     */
+    sendCustomReport(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.sendCustomReportRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.CustomReportsApi = CustomReportsApi;
+/**
+ * @export
+ */
+exports.ListCustomReportsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};

package/dist/apis/GEOAuditsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/GEOAuditsApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/GEOWriterApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -124,7 +124,7 @@ export interface GEOWriterApiInterface {
      */
     revertIntelligenceTaskContentRequestOpts(requestParameters: RevertIntelligenceTaskContentRequest): Promise<runtime.RequestOpts>;
     /**
-     * Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
      * @summary Revert GEO Writer task content
      * @param {number} projectId Project ID
      * @param {string} id Numeric task ID or public_id string token
@@ -134,7 +134,7 @@ export interface GEOWriterApiInterface {
      */
     revertIntelligenceTaskContentRaw(requestParameters: RevertIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntelligenceTask>>;
     /**
-     * Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
      * Revert GEO Writer task content
      */
     revertIntelligenceTaskContent(requestParameters: RevertIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntelligenceTask>;
@@ -147,7 +147,7 @@ export interface GEOWriterApiInterface {
      */
     updateIntelligenceTaskContentRequestOpts(requestParameters: UpdateIntelligenceTaskContentRequest): Promise<runtime.RequestOpts>;
     /**
-     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
      * @summary Edit GEO Writer task content
      * @param {string} id Numeric task ID or public_id string token
      * @param {IntelligenceTaskUpdateRequest} intelligenceTaskUpdateRequest
@@ -157,7 +157,7 @@ export interface GEOWriterApiInterface {
      */
     updateIntelligenceTaskContentRaw(requestParameters: UpdateIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntelligenceTaskUpdateResponse>>;
     /**
-     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
      * Edit GEO Writer task content
      */
     updateIntelligenceTaskContent(requestParameters: UpdateIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntelligenceTaskUpdateResponse>;
@@ -209,12 +209,12 @@ export declare class GEOWriterApi extends runtime.BaseAPI implements GEOWriterAp
      */
     revertIntelligenceTaskContentRequestOpts(requestParameters: RevertIntelligenceTaskContentRequest): Promise<runtime.RequestOpts>;
     /**
-     * Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
      * Revert GEO Writer task content
      */
     revertIntelligenceTaskContentRaw(requestParameters: RevertIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntelligenceTask>>;
     /**
-     * Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
      * Revert GEO Writer task content
      */
     revertIntelligenceTaskContent(requestParameters: RevertIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntelligenceTask>;
@@ -223,12 +223,12 @@ export declare class GEOWriterApi extends runtime.BaseAPI implements GEOWriterAp
      */
     updateIntelligenceTaskContentRequestOpts(requestParameters: UpdateIntelligenceTaskContentRequest): Promise<runtime.RequestOpts>;
     /**
-     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
      * Edit GEO Writer task content
      */
     updateIntelligenceTaskContentRaw(requestParameters: UpdateIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IntelligenceTaskUpdateResponse>>;
     /**
-     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
      * Edit GEO Writer task content
      */
     updateIntelligenceTaskContent(requestParameters: UpdateIntelligenceTaskContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IntelligenceTaskUpdateResponse>;

package/dist/apis/GEOWriterApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -228,7 +228,7 @@ class GEOWriterApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
      * Revert GEO Writer task content
      */
     revertIntelligenceTaskContentRaw(requestParameters, initOverrides) {
@@ -239,7 +239,7 @@ class GEOWriterApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Discards every manual edit on the task and restores the output exactly as it was generated. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Discards every manual edit on the task and restores the output as it was generated. On a product_listing task, description_html comes back with only p, ul, ol, li, strong, em, h3 and br and no attributes, cleaned like an edit. Returns ERR_INVALID_PARAM when the task has no manual edits. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
      * Revert GEO Writer task content
      */
     revertIntelligenceTaskContent(requestParameters, initOverrides) {
@@ -281,7 +281,7 @@ class GEOWriterApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
      * Edit GEO Writer task content
      */
     updateIntelligenceTaskContentRaw(requestParameters, initOverrides) {
@@ -292,7 +292,7 @@ class GEOWriterApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer.
+     * Edits the text of a completed task in place. `edits` maps dotted paths into result_data (for example `title` or `sections.0.content`) to replacement text. Only string fields that already exist can change: a path that does not resolve to text, a blank `title`, a value over 20,000 characters or an empty `edits` object is rejected with ERR_INVALID_PARAM and nothing is written. Send the `result_version` you last read with the edits: when the task was regenerated since, the request is refused with ERR_STALE_CONTENT (409), nothing is written and `error.meta.result_version` holds the current token. Without `result_version` the edits apply to whatever the task holds now. Values identical to the stored text are ignored, and the response lists the paths that actually changed. The first edit keeps a copy of the generated output so POST /intelligence_tasks/{id}/revert can restore it; regenerating the task replaces the edited content. Requires a `read_write` scope API key and, for team members, update permission on GEO Writer. On a product_listing task, description_html keeps only p, ul, ol, li, strong, em, h3 and br, with no attributes: other markup is stripped, not refused, so read the stored value from the response. A revert restores the generated description cleaned the same way.
      * Edit GEO Writer task content
      */
     updateIntelligenceTaskContent(requestParameters, initOverrides) {

package/dist/apis/HealthApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/HealthApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MentionsCitationsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MentionsCitationsApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MetricsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MetricsApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.61.0
+ * The version of the OpenAPI document: 1.63.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).