linkbreakers 1.150.0 → 1.158.0

package/dist/apis/AnalyticsDashboardApi.d.ts

@@ -1,8 +1,8 @@
 /**
  * Linkbreakers API
- * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
+ * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.150.0
+ * The version of the OpenAPI document: 1.158.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,7 @@ import * as runtime from '../runtime';
 import type { AnalyticsDashboardServiceGenerateWidgetSummaryBody, AnalyticsDashboardServiceUpdateDashboardBody, CreateDashboardRequest, CreateDashboardResponse, GenerateWidgetSummaryResponse, GetWidgetSummaryResponse, ListDashboardsResponse, UpdateDashboardResponse } from '../models/index';
 export interface AnalyticsDashboardServiceCreateDashboardRequest {
     createDashboardRequest: CreateDashboardRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDashboardServiceDeleteDashboardRequest {
     id: string;
@@ -21,6 +22,7 @@ export interface AnalyticsDashboardServiceGenerateWidgetSummaryRequest {
     dashboardId: string;
     widgetId: string;
     analyticsDashboardServiceGenerateWidgetSummaryBody: AnalyticsDashboardServiceGenerateWidgetSummaryBody;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDashboardServiceGetWidgetSummaryRequest {
     dashboardId: string;
@@ -31,10 +33,12 @@ export interface AnalyticsDashboardServiceListDashboardsRequest {
     scope?: string;
     pageSize?: number;
     pageToken?: string;
+    cursor?: string;
 }
 export interface AnalyticsDashboardServiceUpdateDashboardRequest {
     id: string;
     analyticsDashboardServiceUpdateDashboardBody: AnalyticsDashboardServiceUpdateDashboardBody;
+    idempotencyKey?: string;
 }
 /**
  * AnalyticsDashboardApi - interface
@@ -46,21 +50,23 @@ export interface AnalyticsDashboardApiInterface {
     /**
      * Creates request options for analyticsDashboardServiceCreateDashboard without sending the request
      * @param {CreateDashboardRequest} createDashboardRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceCreateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest): Promise<runtime.RequestOpts>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * @summary Create analytics dashboard
      * @param {CreateDashboardRequest} createDashboardRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceCreateDashboardRaw(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateDashboardResponse>>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Create analytics dashboard
      */
     analyticsDashboardServiceCreateDashboard(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDashboardResponse>;
@@ -72,7 +78,7 @@ export interface AnalyticsDashboardApiInterface {
      */
     analyticsDashboardServiceDeleteDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest): Promise<runtime.RequestOpts>;
     /**
-     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.
      * @summary Delete analytics dashboard
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -81,7 +87,7 @@ export interface AnalyticsDashboardApiInterface {
      */
     analyticsDashboardServiceDeleteDashboardRaw(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.
      * Delete analytics dashboard
      */
     analyticsDashboardServiceDeleteDashboard(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -90,23 +96,25 @@ export interface AnalyticsDashboardApiInterface {
      * @param {string} dashboardId Dashboard holding the widget
      * @param {string} widgetId Widget whose values should be analysed
      * @param {AnalyticsDashboardServiceGenerateWidgetSummaryBody} analyticsDashboardServiceGenerateWidgetSummaryBody
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceGenerateWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest): Promise<runtime.RequestOpts>;
     /**
-     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.
      * @summary Generate a widget assistant summary
      * @param {string} dashboardId Dashboard holding the widget
      * @param {string} widgetId Widget whose values should be analysed
      * @param {AnalyticsDashboardServiceGenerateWidgetSummaryBody} analyticsDashboardServiceGenerateWidgetSummaryBody
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceGenerateWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateWidgetSummaryResponse>>;
     /**
-     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.
      * Generate a widget assistant summary
      */
     analyticsDashboardServiceGenerateWidgetSummary(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateWidgetSummaryResponse>;
@@ -119,7 +127,7 @@ export interface AnalyticsDashboardApiInterface {
      */
     analyticsDashboardServiceGetWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.
      * @summary Get a stored widget assistant summary
      * @param {string} dashboardId
      * @param {string} widgetId
@@ -129,7 +137,7 @@ export interface AnalyticsDashboardApiInterface {
      */
     analyticsDashboardServiceGetWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWidgetSummaryResponse>>;
     /**
-     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.
      * Get a stored widget assistant summary
      */
     analyticsDashboardServiceGetWidgetSummary(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWidgetSummaryResponse>;
@@ -139,24 +147,26 @@ export interface AnalyticsDashboardApiInterface {
      * @param {string} [scope] Restricts the result by scope. Unset returns every dashboard.   - DASHBOARD_SCOPE_UNSPECIFIED: Every dashboard in the workspace, link-scoped or not.  - DASHBOARD_SCOPE_WORKSPACE: Only the workspace-wide dashboard, the one with no link.  - DASHBOARD_SCOPE_LINK: Only dashboards tied to a link.
      * @param {number} [pageSize] Maximum number to return. Defaults to 100, capped at 1000.
      * @param {string} [pageToken] Cursor from a previous response\&#39;s next_page_token. Empty starts at the first page. Pages are ordered by (created_at, id), which never change, so a record cannot move between pages while a client is walking them.
+     * @param {string} [cursor] Opaque cursor from the previous page\&#39;s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceListDashboardsRequestOpts(requestParameters: AnalyticsDashboardServiceListDashboardsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Requires the `analytics:read` scope.
      * @summary List analytics dashboards
      * @param {string} [linkId] Restricts the result to the dashboard scoped to this link. Takes precedence over scope when both are set.
      * @param {string} [scope] Restricts the result by scope. Unset returns every dashboard.   - DASHBOARD_SCOPE_UNSPECIFIED: Every dashboard in the workspace, link-scoped or not.  - DASHBOARD_SCOPE_WORKSPACE: Only the workspace-wide dashboard, the one with no link.  - DASHBOARD_SCOPE_LINK: Only dashboards tied to a link.
      * @param {number} [pageSize] Maximum number to return. Defaults to 100, capped at 1000.
      * @param {string} [pageToken] Cursor from a previous response\&#39;s next_page_token. Empty starts at the first page. Pages are ordered by (created_at, id), which never change, so a record cannot move between pages while a client is walking them.
+     * @param {string} [cursor] Opaque cursor from the previous page\&#39;s nextPageToken. Same as pageToken; when both are sent, pageToken wins.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceListDashboardsRaw(requestParameters: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDashboardsResponse>>;
     /**
-     * Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Requires the `analytics:read` scope.
      * List analytics dashboards
      */
     analyticsDashboardServiceListDashboards(requestParameters: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDashboardsResponse>;
@@ -164,22 +174,24 @@ export interface AnalyticsDashboardApiInterface {
      * Creates request options for analyticsDashboardServiceUpdateDashboard without sending the request
      * @param {string} id ID of the dashboard to update.
      * @param {AnalyticsDashboardServiceUpdateDashboardBody} analyticsDashboardServiceUpdateDashboardBody
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceUpdateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest): Promise<runtime.RequestOpts>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * @summary Update analytics dashboard
      * @param {string} id ID of the dashboard to update.
      * @param {AnalyticsDashboardServiceUpdateDashboardBody} analyticsDashboardServiceUpdateDashboardBody
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDashboardApiInterface
      */
     analyticsDashboardServiceUpdateDashboardRaw(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDashboardResponse>>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Update analytics dashboard
      */
     analyticsDashboardServiceUpdateDashboard(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDashboardResponse>;
@@ -193,12 +205,12 @@ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements An
      */
     analyticsDashboardServiceCreateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest): Promise<runtime.RequestOpts>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Create analytics dashboard
      */
     analyticsDashboardServiceCreateDashboardRaw(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateDashboardResponse>>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Create analytics dashboard
      */
     analyticsDashboardServiceCreateDashboard(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDashboardResponse>;
@@ -207,12 +219,12 @@ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements An
      */
     analyticsDashboardServiceDeleteDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest): Promise<runtime.RequestOpts>;
     /**
-     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.
      * Delete analytics dashboard
      */
     analyticsDashboardServiceDeleteDashboardRaw(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.
      * Delete analytics dashboard
      */
     analyticsDashboardServiceDeleteDashboard(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -221,12 +233,12 @@ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements An
      */
     analyticsDashboardServiceGenerateWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest): Promise<runtime.RequestOpts>;
     /**
-     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.
      * Generate a widget assistant summary
      */
     analyticsDashboardServiceGenerateWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenerateWidgetSummaryResponse>>;
     /**
-     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.
      * Generate a widget assistant summary
      */
     analyticsDashboardServiceGenerateWidgetSummary(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenerateWidgetSummaryResponse>;
@@ -235,12 +247,12 @@ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements An
      */
     analyticsDashboardServiceGetWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.
      * Get a stored widget assistant summary
      */
     analyticsDashboardServiceGetWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWidgetSummaryResponse>>;
     /**
-     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.
      * Get a stored widget assistant summary
      */
     analyticsDashboardServiceGetWidgetSummary(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWidgetSummaryResponse>;
@@ -249,12 +261,12 @@ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements An
      */
     analyticsDashboardServiceListDashboardsRequestOpts(requestParameters: AnalyticsDashboardServiceListDashboardsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Requires the `analytics:read` scope.
      * List analytics dashboards
      */
     analyticsDashboardServiceListDashboardsRaw(requestParameters: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDashboardsResponse>>;
     /**
-     * Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Requires the `analytics:read` scope.
      * List analytics dashboards
      */
     analyticsDashboardServiceListDashboards(requestParameters?: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDashboardsResponse>;
@@ -263,12 +275,12 @@ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements An
      */
     analyticsDashboardServiceUpdateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest): Promise<runtime.RequestOpts>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Update analytics dashboard
      */
     analyticsDashboardServiceUpdateDashboardRaw(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDashboardResponse>>;
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Update analytics dashboard
      */
     analyticsDashboardServiceUpdateDashboard(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDashboardResponse>;

package/dist/apis/AnalyticsDashboardApi.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Linkbreakers API
- * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
+ * This is a documentation of all the APIs of Linkbreakers  ## Entry points  `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API\'s name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`.  ## Rate limits  Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds.  - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP.  Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.  ## Pagination  Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`.  ## Batches and background jobs  `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish.  ## Versioning and deprecation  The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead.  An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy  ## Idempotent retries  Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again.
  *
- * The version of the OpenAPI document: 1.150.0
+ * The version of the OpenAPI document: 1.158.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -63,6 +63,9 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
         if (this.configuration && this.configuration.accessToken) {
             // oauth required
             headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:write"]);
@@ -84,7 +87,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Create analytics dashboard
      */
     async analyticsDashboardServiceCreateDashboardRaw(requestParameters, initOverrides) {
@@ -93,7 +96,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateDashboardResponseFromJSON)(jsonValue));
     }
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Create analytics dashboard
      */
     async analyticsDashboardServiceCreateDashboard(requestParameters, initOverrides) {
@@ -130,7 +133,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.
      * Delete analytics dashboard
      */
     async analyticsDashboardServiceDeleteDashboardRaw(requestParameters, initOverrides) {
@@ -139,7 +142,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Delete a dashboard and its associated assistant conversation.  Requires the `analytics:write` scope.
      * Delete analytics dashboard
      */
     async analyticsDashboardServiceDeleteDashboard(requestParameters, initOverrides) {
@@ -162,6 +165,9 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
         if (this.configuration && this.configuration.accessToken) {
             // oauth required
             headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:write"]);
@@ -185,7 +191,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.
      * Generate a widget assistant summary
      */
     async analyticsDashboardServiceGenerateWidgetSummaryRaw(requestParameters, initOverrides) {
@@ -194,7 +200,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GenerateWidgetSummaryResponseFromJSON)(jsonValue));
     }
     /**
-     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested.  Requires the `analytics:write` scope.
      * Generate a widget assistant summary
      */
     async analyticsDashboardServiceGenerateWidgetSummary(requestParameters, initOverrides) {
@@ -235,7 +241,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.
      * Get a stored widget assistant summary
      */
     async analyticsDashboardServiceGetWidgetSummaryRaw(requestParameters, initOverrides) {
@@ -244,7 +250,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetWidgetSummaryResponseFromJSON)(jsonValue));
     }
     /**
-     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the last generated analysis, and whether the underlying values have changed since.  Requires the `analytics:read` scope.
      * Get a stored widget assistant summary
      */
     async analyticsDashboardServiceGetWidgetSummary(requestParameters, initOverrides) {
@@ -268,6 +274,9 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         if (requestParameters['pageToken'] != null) {
             queryParameters['pageToken'] = requestParameters['pageToken'];
         }
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
         const headerParameters = {};
         if (this.configuration && this.configuration.accessToken) {
             // oauth required
@@ -289,7 +298,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Requires the `analytics:read` scope.
      * List analytics dashboards
      */
     async analyticsDashboardServiceListDashboardsRaw(requestParameters, initOverrides) {
@@ -298,7 +307,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListDashboardsResponseFromJSON)(jsonValue));
     }
     /**
-     * Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Requires the `analytics:read` scope.
      * List analytics dashboards
      */
     async analyticsDashboardServiceListDashboards(requestParameters = {}, initOverrides) {
@@ -318,6 +327,9 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
         if (this.configuration && this.configuration.accessToken) {
             // oauth required
             headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:write"]);
@@ -340,7 +352,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Update analytics dashboard
      */
     async analyticsDashboardServiceUpdateDashboardRaw(requestParameters, initOverrides) {
@@ -349,7 +361,7 @@ class AnalyticsDashboardApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateDashboardResponseFromJSON)(jsonValue));
     }
     /**
-     * Requires the `analytics:write` scope.  Requires the `analytics:write` scope.
+     * Requires the `analytics:write` scope.
      * Update analytics dashboard
      */
     async analyticsDashboardServiceUpdateDashboard(requestParameters, initOverrides) {