@llmpulse/sdk 0.0.0-stage → 1.59.0

package/dist/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/apis/AccountApi.js

@@ -0,0 +1,77 @@
+"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.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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountApi = void 0;
+const runtime = require("../runtime");
+const GetAccount200Response_1 = require("../models/GetAccount200Response");
+/**
+ *
+ */
+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) => (0, GetAccount200Response_1.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();
+        });
+    }
+}
+exports.AccountApi = AccountApi;

package/dist/apis/AnnotationsApi.d.ts

@@ -0,0 +1,201 @@
+/**
+ * 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 AnnotationCreateResponse } from '../models/AnnotationCreateResponse';
+import { type CreateAnnotationRequest } from '../models/CreateAnnotationRequest';
+import { type UpdateAnnotationRequest } from '../models/UpdateAnnotationRequest';
+export interface CreateAnnotationOperationRequest {
+    createAnnotationRequest: CreateAnnotationRequest;
+}
+export interface DeleteAnnotationRequest {
+    projectId: number;
+    id: number;
+}
+export interface ListAnnotationsRequest {
+    projectId: number;
+    from?: Date;
+    to?: Date;
+    annotationCategoryId?: number;
+    page?: number;
+    perPage?: number;
+}
+export interface UpdateAnnotationOperationRequest {
+    id: number;
+    updateAnnotationRequest: UpdateAnnotationRequest;
+}
+/**
+ * AnnotationsApi - interface
+ *
+ * @export
+ * @interface AnnotationsApiInterface
+ */
+export interface AnnotationsApiInterface {
+    /**
+     * Creates request options for createAnnotation without sending the request
+     * @param {CreateAnnotationRequest} createAnnotationRequest
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    createAnnotationRequestOpts(requestParameters: CreateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * @summary Create a timeline annotation
+     * @param {CreateAnnotationRequest} createAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    createAnnotationRaw(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnnotationCreateResponse>>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotation(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnnotationCreateResponse>;
+    /**
+     * Creates request options for deleteAnnotation without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    deleteAnnotationRequestOpts(requestParameters: DeleteAnnotationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * @summary Delete a timeline annotation
+     * @param {number} projectId Project ID
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    deleteAnnotationRaw(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotation(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listAnnotations without sending the request
+     * @param {number} projectId Project ID
+     * @param {Date} [from]
+     * @param {Date} [to]
+     * @param {number} [annotationCategoryId]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    listAnnotationsRequestOpts(requestParameters: ListAnnotationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * @summary List timeline annotations
+     * @param {number} projectId Project ID
+     * @param {Date} [from]
+     * @param {Date} [to]
+     * @param {number} [annotationCategoryId]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    listAnnotationsRaw(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotations(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateAnnotation without sending the request
+     * @param {number} id
+     * @param {UpdateAnnotationRequest} updateAnnotationRequest
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    updateAnnotationRequestOpts(requestParameters: UpdateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * @summary Update a timeline annotation
+     * @param {number} id
+     * @param {UpdateAnnotationRequest} updateAnnotationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationsApiInterface
+     */
+    updateAnnotationRaw(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotation(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class AnnotationsApi extends runtime.BaseAPI implements AnnotationsApiInterface {
+    /**
+     * Creates request options for createAnnotation without sending the request
+     */
+    createAnnotationRequestOpts(requestParameters: CreateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotationRaw(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AnnotationCreateResponse>>;
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotation(requestParameters: CreateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AnnotationCreateResponse>;
+    /**
+     * Creates request options for deleteAnnotation without sending the request
+     */
+    deleteAnnotationRequestOpts(requestParameters: DeleteAnnotationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotationRaw(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotation(requestParameters: DeleteAnnotationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listAnnotations without sending the request
+     */
+    listAnnotationsRequestOpts(requestParameters: ListAnnotationsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotationsRaw(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotations(requestParameters: ListAnnotationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateAnnotation without sending the request
+     */
+    updateAnnotationRequestOpts(requestParameters: UpdateAnnotationOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotationRaw(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotation(requestParameters: UpdateAnnotationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/apis/AnnotationsApi.js

@@ -0,0 +1,253 @@
+"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.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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnnotationsApi = void 0;
+const runtime = require("../runtime");
+const AnnotationCreateResponse_1 = require("../models/AnnotationCreateResponse");
+const CreateAnnotationRequest_1 = require("../models/CreateAnnotationRequest");
+const UpdateAnnotationRequest_1 = require("../models/UpdateAnnotationRequest");
+/**
+ *
+ */
+class AnnotationsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createAnnotation without sending the request
+     */
+    createAnnotationRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createAnnotationRequest'] == null) {
+                throw new runtime.RequiredError('createAnnotationRequest', 'Required parameter "createAnnotationRequest" was null or undefined when calling createAnnotation().');
+            }
+            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 = `/annotations`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, CreateAnnotationRequest_1.CreateAnnotationRequestToJSON)(requestParameters['createAnnotationRequest']),
+            };
+        });
+    }
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createAnnotationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AnnotationCreateResponse_1.AnnotationCreateResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Marks a date in the project timeseries with a title + description. Available on every plan. Requires a `read_write` scope API key.
+     * Create a timeline annotation
+     */
+    createAnnotation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAnnotationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteAnnotation without sending the request
+     */
+    deleteAnnotationRequestOpts(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 deleteAnnotation().');
+            }
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteAnnotation().');
+            }
+            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 = `/annotations/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteAnnotationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes an annotation. Same ownership rule as PATCH. Available on every plan and requires a `read_write` scope API key.
+     * Delete a timeline annotation
+     */
+    deleteAnnotation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteAnnotationRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for listAnnotations without sending the request
+     */
+    listAnnotationsRequestOpts(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 listAnnotations().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['from'] != null) {
+                queryParameters['from'] = requestParameters['from'].toISOString().substring(0, 10);
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString().substring(0, 10);
+            }
+            if (requestParameters['annotationCategoryId'] != null) {
+                queryParameters['annotation_category_id'] = requestParameters['annotationCategoryId'];
+            }
+            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 = `/annotations`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotationsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listAnnotationsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Lists project timeline annotations, newest first. Rows can come from manual notes, project automations, GEO tests, or platform events. The origin field distinguishes them; editable says whether the requesting user may modify the row. Available on every plan.
+     * List timeline annotations
+     */
+    listAnnotations(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.listAnnotationsRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for updateAnnotation without sending the request
+     */
+    updateAnnotationRequestOpts(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 updateAnnotation().');
+            }
+            if (requestParameters['updateAnnotationRequest'] == null) {
+                throw new runtime.RequiredError('updateAnnotationRequest', 'Required parameter "updateAnnotationRequest" was null or undefined when calling updateAnnotation().');
+            }
+            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 = `/annotations/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, UpdateAnnotationRequest_1.UpdateAnnotationRequestToJSON)(requestParameters['updateAnnotationRequest']),
+            };
+        });
+    }
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateAnnotationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Updates title, description, annotation_date, color and/or annotation_category_id. Only user-created annotations belonging to the requesting user can be updated (system annotations never). Available on every plan and requires a `read_write` scope API key.
+     * Update a timeline annotation
+     */
+    updateAnnotation(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateAnnotationRaw(requestParameters, initOverrides);
+        });
+    }
+}
+exports.AnnotationsApi = AnnotationsApi;