@llmpulse/sdk 1.62.0 → 1.64.0

package/dist/apis/CollectionsTagsApi.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.62.0
+ * The version of the OpenAPI document: 1.64.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,6 +15,8 @@ import { type CollectionCreateResponse } from '../models/CollectionCreateRespons
 import { type CollectionsResponse } from '../models/CollectionsResponse';
 import { type CreateCollectionRequest } from '../models/CreateCollectionRequest';
 import { type PromptTagsAssignResponse } from '../models/PromptTagsAssignResponse';
+import { type PromptTagsRemoveResponse } from '../models/PromptTagsRemoveResponse';
+import { type RemovePromptTagsRequest } from '../models/RemovePromptTagsRequest';
 import { type UpdateCollectionRequest } from '../models/UpdateCollectionRequest';
 export interface AssignPromptTagsOperationRequest {
     assignPromptTagsRequest: AssignPromptTagsRequest;
@@ -34,6 +36,9 @@ export interface ListTagsRequest {
     projectId: number;
     output?: ListTagsOutputEnum;
 }
+export interface RemovePromptTagsOperationRequest {
+    removePromptTagsRequest: RemovePromptTagsRequest;
+}
 export interface UpdateCollectionOperationRequest {
     id: number;
     updateCollectionRequest: UpdateCollectionRequest;
@@ -154,6 +159,27 @@ export interface CollectionsTagsApiInterface {
      * List tags (alias for /collections)
      */
     listTags(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CollectionsResponse>;
+    /**
+     * Creates request options for removePromptTags without sending the request
+     * @param {RemovePromptTagsRequest} removePromptTagsRequest
+     * @throws {RequiredError}
+     * @memberof CollectionsTagsApiInterface
+     */
+    removePromptTagsRequestOpts(requestParameters: RemovePromptTagsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+     * @summary Bulk-detach tags from prompts
+     * @param {RemovePromptTagsRequest} removePromptTagsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsTagsApiInterface
+     */
+    removePromptTagsRaw(requestParameters: RemovePromptTagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptTagsRemoveResponse>>;
+    /**
+     * Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+     * Bulk-detach tags from prompts
+     */
+    removePromptTags(requestParameters: RemovePromptTagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptTagsRemoveResponse>;
     /**
      * Creates request options for updateCollection without sending the request
      * @param {number} id
@@ -248,6 +274,20 @@ export declare class CollectionsTagsApi extends runtime.BaseAPI implements Colle
      * List tags (alias for /collections)
      */
     listTags(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CollectionsResponse>;
+    /**
+     * Creates request options for removePromptTags without sending the request
+     */
+    removePromptTagsRequestOpts(requestParameters: RemovePromptTagsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+     * Bulk-detach tags from prompts
+     */
+    removePromptTagsRaw(requestParameters: RemovePromptTagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptTagsRemoveResponse>>;
+    /**
+     * Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+     * Bulk-detach tags from prompts
+     */
+    removePromptTags(requestParameters: RemovePromptTagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptTagsRemoveResponse>;
     /**
      * Creates request options for updateCollection without sending the request
      */

package/dist/apis/CollectionsTagsApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.64.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,6 +29,8 @@ const CollectionCreateResponse_1 = require("../models/CollectionCreateResponse")
 const CollectionsResponse_1 = require("../models/CollectionsResponse");
 const CreateCollectionRequest_1 = require("../models/CreateCollectionRequest");
 const PromptTagsAssignResponse_1 = require("../models/PromptTagsAssignResponse");
+const PromptTagsRemoveResponse_1 = require("../models/PromptTagsRemoveResponse");
+const RemovePromptTagsRequest_1 = require("../models/RemovePromptTagsRequest");
 const UpdateCollectionRequest_1 = require("../models/UpdateCollectionRequest");
 /**
  *
@@ -287,6 +289,55 @@ class CollectionsTagsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for removePromptTags without sending the request
+     */
+    removePromptTagsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['removePromptTagsRequest'] == null) {
+                throw new runtime.RequiredError('removePromptTagsRequest', 'Required parameter "removePromptTagsRequest" was null or undefined when calling removePromptTags().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/prompts/remove_tags`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, RemovePromptTagsRequest_1.RemovePromptTagsRequestToJSON)(requestParameters['removePromptTagsRequest']),
+            };
+        });
+    }
+    /**
+     * Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+     * Bulk-detach tags from prompts
+     */
+    removePromptTagsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.removePromptTagsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PromptTagsRemoveResponse_1.PromptTagsRemoveResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Idempotent bulk removal of tags (Collections) from existing prompts: up to 500 prompt_ids and 50 tags, resolved by id or by name (case-insensitive). Only the prompt-tag links are removed; tags and prompts stay. Links that did not exist are counted in skipped_not_linked. Requires a `read_write` scope API key and, for team members, update access to Prompts.
+     * Bulk-detach tags from prompts
+     */
+    removePromptTags(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.removePromptTagsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for updateCollection without sending the request
      */

package/dist/apis/CompetitorsApi.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.62.0
+ * The version of the OpenAPI document: 1.64.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,6 +12,7 @@
 import * as runtime from '../runtime';
 import { type CompetitorCreateResponse } from '../models/CompetitorCreateResponse';
 import { type CompetitorDetails } from '../models/CompetitorDetails';
+import { type CompetitorSuggestionsResponse } from '../models/CompetitorSuggestionsResponse';
 import { type CreateCompetitorRequest } from '../models/CreateCompetitorRequest';
 import { type ListCompetitors200Response } from '../models/ListCompetitors200Response';
 import { type UpdateCompetitorRequest } from '../models/UpdateCompetitorRequest';
@@ -26,6 +27,14 @@ export interface GetCompetitorDetailsRequest {
     projectId: number;
     id: number;
 }
+export interface ListCompetitorSuggestionsRequest {
+    projectId: number;
+    basis?: ListCompetitorSuggestionsBasisEnum;
+    query?: string;
+    page?: number;
+    perPage?: number;
+    output?: ListCompetitorSuggestionsOutputEnum;
+}
 export interface ListCompetitorsRequest {
     projectId: number;
     includeProjectBrand?: boolean;
@@ -108,6 +117,37 @@ export interface CompetitorsApiInterface {
      * Competitor details
      */
     getCompetitorDetails(requestParameters: GetCompetitorDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorDetails>;
+    /**
+     * Creates request options for listCompetitorSuggestions without sending the request
+     * @param {number} projectId Project ID
+     * @param {'brands' | 'citations'} [basis]
+     * @param {string} [query] Only suggestions whose brand name or domain contains this text
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    listCompetitorSuggestionsRequestOpts(requestParameters: ListCompetitorSuggestionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+     * @summary List competitor suggestions
+     * @param {number} projectId Project ID
+     * @param {'brands' | 'citations'} [basis]
+     * @param {string} [query] Only suggestions whose brand name or domain contains this text
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompetitorsApiInterface
+     */
+    listCompetitorSuggestionsRaw(requestParameters: ListCompetitorSuggestionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorSuggestionsResponse>>;
+    /**
+     * The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+     * List competitor suggestions
+     */
+    listCompetitorSuggestions(requestParameters: ListCompetitorSuggestionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorSuggestionsResponse>;
     /**
      * Creates request options for listCompetitors without sending the request
      * @param {number} projectId Project ID
@@ -200,6 +240,20 @@ export declare class CompetitorsApi extends runtime.BaseAPI implements Competito
      * Competitor details
      */
     getCompetitorDetails(requestParameters: GetCompetitorDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorDetails>;
+    /**
+     * Creates request options for listCompetitorSuggestions without sending the request
+     */
+    listCompetitorSuggestionsRequestOpts(requestParameters: ListCompetitorSuggestionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+     * List competitor suggestions
+     */
+    listCompetitorSuggestionsRaw(requestParameters: ListCompetitorSuggestionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorSuggestionsResponse>>;
+    /**
+     * The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+     * List competitor suggestions
+     */
+    listCompetitorSuggestions(requestParameters: ListCompetitorSuggestionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorSuggestionsResponse>;
     /**
      * Creates request options for listCompetitors without sending the request
      */
@@ -227,6 +281,22 @@ export declare class CompetitorsApi extends runtime.BaseAPI implements Competito
      */
     updateCompetitor(requestParameters: UpdateCompetitorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const ListCompetitorSuggestionsBasisEnum: {
+    readonly Brands: "brands";
+    readonly Citations: "citations";
+};
+export type ListCompetitorSuggestionsBasisEnum = typeof ListCompetitorSuggestionsBasisEnum[keyof typeof ListCompetitorSuggestionsBasisEnum];
+/**
+ * @export
+ */
+export declare const ListCompetitorSuggestionsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListCompetitorSuggestionsOutputEnum = typeof ListCompetitorSuggestionsOutputEnum[keyof typeof ListCompetitorSuggestionsOutputEnum];
 /**
  * @export
  */

package/dist/apis/CompetitorsApi.js

@@ -5,7 +5,7 @@
  * LLM Pulse API
  * REST API client for LLM Pulse AI visibility analytics.
  *
- * The version of the OpenAPI document: 1.62.0
+ * The version of the OpenAPI document: 1.64.0
  * Contact: info@llmpulse.ai
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,10 +22,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListCompetitorsOutputEnum = exports.CompetitorsApi = void 0;
+exports.ListCompetitorsOutputEnum = exports.ListCompetitorSuggestionsOutputEnum = exports.ListCompetitorSuggestionsBasisEnum = exports.CompetitorsApi = void 0;
 const runtime = require("../runtime");
 const CompetitorCreateResponse_1 = require("../models/CompetitorCreateResponse");
 const CompetitorDetails_1 = require("../models/CompetitorDetails");
+const CompetitorSuggestionsResponse_1 = require("../models/CompetitorSuggestionsResponse");
 const CreateCompetitorRequest_1 = require("../models/CreateCompetitorRequest");
 const ListCompetitors200Response_1 = require("../models/ListCompetitors200Response");
 const UpdateCompetitorRequest_1 = require("../models/UpdateCompetitorRequest");
@@ -187,6 +188,71 @@ class CompetitorsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for listCompetitorSuggestions without sending the request
+     */
+    listCompetitorSuggestionsRequestOpts(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 listCompetitorSuggestions().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['basis'] != null) {
+                queryParameters['basis'] = requestParameters['basis'];
+            }
+            if (requestParameters['query'] != null) {
+                queryParameters['query'] = requestParameters['query'];
+            }
+            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 = `/competitors/suggestions`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+     * List competitor suggestions
+     */
+    listCompetitorSuggestionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listCompetitorSuggestionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CompetitorSuggestionsResponse_1.CompetitorSuggestionsResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * The two lists of the Suggested tab of the Competitors page. `basis=brands` (default) returns the competing brands the AI discovery proposed that are not tracked or rejected yet, with the names it would match and, when counted, how many answers name it (`mentions`). `basis=citations` returns the domains AI answers cite most that are not your own or tracked yet, with how many answers cite each (`citations`). `discovery` tells whether a discovery run is still loading. Read-only: it never starts a discovery run, which the page starts from its Discover button. Add a suggestion with POST /competitors.
+     * List competitor suggestions
+     */
+    listCompetitorSuggestions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listCompetitorSuggestionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for listCompetitors without sending the request
      */
@@ -295,6 +361,20 @@ class CompetitorsApi extends runtime.BaseAPI {
     }
 }
 exports.CompetitorsApi = CompetitorsApi;
+/**
+ * @export
+ */
+exports.ListCompetitorSuggestionsBasisEnum = {
+    Brands: 'brands',
+    Citations: 'citations'
+};
+/**
+ * @export
+ */
+exports.ListCompetitorSuggestionsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};
 /**
  * @export
  */

package/dist/apis/CustomReportsApi.d.ts

@@ -0,0 +1,166 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.64.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 CustomReportDetailResponse } from '../models/CustomReportDetailResponse';
+import { type CustomReportSendResponse } from '../models/CustomReportSendResponse';
+import { type CustomReportsResponse } from '../models/CustomReportsResponse';
+import { type SendCustomReportRequest } from '../models/SendCustomReportRequest';
+export interface GetCustomReportRequest {
+    projectId: number;
+    id: number;
+}
+export interface ListCustomReportsRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    output?: ListCustomReportsOutputEnum;
+}
+export interface SendCustomReportOperationRequest {
+    id: number;
+    sendCustomReportRequest: SendCustomReportRequest;
+}
+/**
+ * CustomReportsApi - interface
+ *
+ * @export
+ * @interface CustomReportsApiInterface
+ */
+export interface CustomReportsApiInterface {
+    /**
+     * Creates request options for getCustomReport without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} id Custom report id, from GET /custom_reports
+     * @throws {RequiredError}
+     * @memberof CustomReportsApiInterface
+     */
+    getCustomReportRequestOpts(requestParameters: GetCustomReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Get a custom report with its widget data
+     * @param {number} projectId Project ID
+     * @param {number} id Custom report id, from GET /custom_reports
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomReportsApiInterface
+     */
+    getCustomReportRaw(requestParameters: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportDetailResponse>>;
+    /**
+     * 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: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportDetailResponse>;
+    /**
+     * Creates request options for listCustomReports without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof CustomReportsApiInterface
+     */
+    listCustomReportsRequestOpts(requestParameters: ListCustomReportsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary List custom reports
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomReportsApiInterface
+     */
+    listCustomReportsRaw(requestParameters: ListCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportsResponse>>;
+    /**
+     * 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: ListCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportsResponse>;
+    /**
+     * Creates request options for sendCustomReport without sending the request
+     * @param {number} id Custom report id, from GET /custom_reports
+     * @param {SendCustomReportRequest} sendCustomReportRequest
+     * @throws {RequiredError}
+     * @memberof CustomReportsApiInterface
+     */
+    sendCustomReportRequestOpts(requestParameters: SendCustomReportOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Send a custom report now
+     * @param {number} id Custom report id, from GET /custom_reports
+     * @param {SendCustomReportRequest} sendCustomReportRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomReportsApiInterface
+     */
+    sendCustomReportRaw(requestParameters: SendCustomReportOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportSendResponse>>;
+    /**
+     * 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: SendCustomReportOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportSendResponse>;
+}
+/**
+ *
+ */
+export declare class CustomReportsApi extends runtime.BaseAPI implements CustomReportsApiInterface {
+    /**
+     * Creates request options for getCustomReport without sending the request
+     */
+    getCustomReportRequestOpts(requestParameters: GetCustomReportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportDetailResponse>>;
+    /**
+     * 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: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportDetailResponse>;
+    /**
+     * Creates request options for listCustomReports without sending the request
+     */
+    listCustomReportsRequestOpts(requestParameters: ListCustomReportsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: ListCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportsResponse>>;
+    /**
+     * 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: ListCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportsResponse>;
+    /**
+     * Creates request options for sendCustomReport without sending the request
+     */
+    sendCustomReportRequestOpts(requestParameters: SendCustomReportOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: SendCustomReportOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportSendResponse>>;
+    /**
+     * 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: SendCustomReportOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportSendResponse>;
+}
+/**
+ * @export
+ */
+export declare const ListCustomReportsOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListCustomReportsOutputEnum = typeof ListCustomReportsOutputEnum[keyof typeof ListCustomReportsOutputEnum];