linkbreakers 1.150.0 → 1.157.1

package/dist/apis/AnalyticsDataApi.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.157.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,36 +13,47 @@ import * as runtime from '../runtime';
 import type { GetAttributeDistributionRequest, GetAttributeDistributionResponse, GetAttributeMetricRequest, GetAttributeMetricResponse, GetAttributeValuesRequest, GetAttributeValuesResponse, GetBreakdownRequest, GetBreakdownResponse, GetDeviceDistributionRequest, GetDeviceDistributionResponse, GetGeoBreakdownRequest, GetGeoBreakdownResponse, GetGroupedTimeSeriesRequest, GetGroupedTimeSeriesResponse, GetHourOfDayDistributionRequest, GetHourOfDayDistributionResponse, GetStepFunnelRequest, GetStepFunnelResponse, GetTopLinksRequest, GetTopLinksResponse, GetVisitorTrendsRequest, GetVisitorTrendsResponse } from '../models/index';
 export interface AnalyticsDataServiceGetAttributeDistributionRequest {
     getAttributeDistributionRequest: GetAttributeDistributionRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetAttributeMetricRequest {
     getAttributeMetricRequest: GetAttributeMetricRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetAttributeValuesRequest {
     getAttributeValuesRequest: GetAttributeValuesRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetBreakdownRequest {
     getBreakdownRequest: GetBreakdownRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetDeviceDistributionRequest {
     getDeviceDistributionRequest: GetDeviceDistributionRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetGeoBreakdownRequest {
     getGeoBreakdownRequest: GetGeoBreakdownRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetGroupedTimeSeriesRequest {
     getGroupedTimeSeriesRequest: GetGroupedTimeSeriesRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetHourOfDayDistributionRequest {
     getHourOfDayDistributionRequest: GetHourOfDayDistributionRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetStepFunnelRequest {
     getStepFunnelRequest: GetStepFunnelRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetTopLinksRequest {
     getTopLinksRequest: GetTopLinksRequest;
+    idempotencyKey?: string;
 }
 export interface AnalyticsDataServiceGetVisitorTrendsRequest {
     getVisitorTrendsRequest: GetVisitorTrendsRequest;
+    idempotencyKey?: string;
 }
 /**
  * AnalyticsDataApi - interface
@@ -54,231 +65,253 @@ export interface AnalyticsDataApiInterface {
     /**
      * Creates request options for analyticsDataServiceGetAttributeDistribution without sending the request
      * @param {GetAttributeDistributionRequest} getAttributeDistributionRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetAttributeDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetAttributeDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.
      * @summary Get visitor attribute distribution
      * @param {GetAttributeDistributionRequest} getAttributeDistributionRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetAttributeDistributionRaw(requestParameters: AnalyticsDataServiceGetAttributeDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributeDistributionResponse>>;
     /**
-     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.
      * Get visitor attribute distribution
      */
     analyticsDataServiceGetAttributeDistribution(requestParameters: AnalyticsDataServiceGetAttributeDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributeDistributionResponse>;
     /**
      * Creates request options for analyticsDataServiceGetAttributeMetric without sending the request
      * @param {GetAttributeMetricRequest} getAttributeMetricRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetAttributeMetricRequestOpts(requestParameters: AnalyticsDataServiceGetAttributeMetricRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.
      * @summary Get visitor attribute metric
      * @param {GetAttributeMetricRequest} getAttributeMetricRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetAttributeMetricRaw(requestParameters: AnalyticsDataServiceGetAttributeMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributeMetricResponse>>;
     /**
-     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.
      * Get visitor attribute metric
      */
     analyticsDataServiceGetAttributeMetric(requestParameters: AnalyticsDataServiceGetAttributeMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributeMetricResponse>;
     /**
      * Creates request options for analyticsDataServiceGetAttributeValues without sending the request
      * @param {GetAttributeValuesRequest} getAttributeValuesRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetAttributeValuesRequestOpts(requestParameters: AnalyticsDataServiceGetAttributeValuesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.
      * @summary List visitor attribute values
      * @param {GetAttributeValuesRequest} getAttributeValuesRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetAttributeValuesRaw(requestParameters: AnalyticsDataServiceGetAttributeValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributeValuesResponse>>;
     /**
-     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.
      * List visitor attribute values
      */
     analyticsDataServiceGetAttributeValues(requestParameters: AnalyticsDataServiceGetAttributeValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributeValuesResponse>;
     /**
      * Creates request options for analyticsDataServiceGetBreakdown without sending the request
      * @param {GetBreakdownRequest} getBreakdownRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetBreakdownRequestOpts(requestParameters: AnalyticsDataServiceGetBreakdownRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.
      * @summary Get dimension breakdown
      * @param {GetBreakdownRequest} getBreakdownRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetBreakdownRaw(requestParameters: AnalyticsDataServiceGetBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBreakdownResponse>>;
     /**
-     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.
      * Get dimension breakdown
      */
     analyticsDataServiceGetBreakdown(requestParameters: AnalyticsDataServiceGetBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBreakdownResponse>;
     /**
      * Creates request options for analyticsDataServiceGetDeviceDistribution without sending the request
      * @param {GetDeviceDistributionRequest} getDeviceDistributionRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetDeviceDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.
      * @summary Get device distribution
      * @param {GetDeviceDistributionRequest} getDeviceDistributionRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetDeviceDistributionRaw(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDeviceDistributionResponse>>;
     /**
-     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.
      * Get device distribution
      */
     analyticsDataServiceGetDeviceDistribution(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDeviceDistributionResponse>;
     /**
      * Creates request options for analyticsDataServiceGetGeoBreakdown without sending the request
      * @param {GetGeoBreakdownRequest} getGeoBreakdownRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetGeoBreakdownRequestOpts(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.
      * @summary Get geographic breakdown
      * @param {GetGeoBreakdownRequest} getGeoBreakdownRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetGeoBreakdownRaw(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGeoBreakdownResponse>>;
     /**
-     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.
      * Get geographic breakdown
      */
     analyticsDataServiceGetGeoBreakdown(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetGeoBreakdownResponse>;
     /**
      * Creates request options for analyticsDataServiceGetGroupedTimeSeries without sending the request
      * @param {GetGroupedTimeSeriesRequest} getGroupedTimeSeriesRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetGroupedTimeSeriesRequestOpts(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.
      * @summary Get grouped time series
      * @param {GetGroupedTimeSeriesRequest} getGroupedTimeSeriesRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetGroupedTimeSeriesRaw(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGroupedTimeSeriesResponse>>;
     /**
-     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.
      * Get grouped time series
      */
     analyticsDataServiceGetGroupedTimeSeries(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetGroupedTimeSeriesResponse>;
     /**
      * Creates request options for analyticsDataServiceGetHourOfDayDistribution without sending the request
      * @param {GetHourOfDayDistributionRequest} getHourOfDayDistributionRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetHourOfDayDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.
      * @summary Get hour of day distribution
      * @param {GetHourOfDayDistributionRequest} getHourOfDayDistributionRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetHourOfDayDistributionRaw(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetHourOfDayDistributionResponse>>;
     /**
-     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.
      * Get hour of day distribution
      */
     analyticsDataServiceGetHourOfDayDistribution(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetHourOfDayDistributionResponse>;
     /**
      * Creates request options for analyticsDataServiceGetStepFunnel without sending the request
      * @param {GetStepFunnelRequest} getStepFunnelRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetStepFunnelRequestOpts(requestParameters: AnalyticsDataServiceGetStepFunnelRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.
      * @summary Get workflow step funnel
      * @param {GetStepFunnelRequest} getStepFunnelRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetStepFunnelRaw(requestParameters: AnalyticsDataServiceGetStepFunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetStepFunnelResponse>>;
     /**
-     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.
      * Get workflow step funnel
      */
     analyticsDataServiceGetStepFunnel(requestParameters: AnalyticsDataServiceGetStepFunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetStepFunnelResponse>;
     /**
      * Creates request options for analyticsDataServiceGetTopLinks without sending the request
      * @param {GetTopLinksRequest} getTopLinksRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetTopLinksRequestOpts(requestParameters: AnalyticsDataServiceGetTopLinksRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.
      * @summary Get top performing links
      * @param {GetTopLinksRequest} getTopLinksRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetTopLinksRaw(requestParameters: AnalyticsDataServiceGetTopLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTopLinksResponse>>;
     /**
-     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.
      * Get top performing links
      */
     analyticsDataServiceGetTopLinks(requestParameters: AnalyticsDataServiceGetTopLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTopLinksResponse>;
     /**
      * Creates request options for analyticsDataServiceGetVisitorTrends without sending the request
      * @param {GetVisitorTrendsRequest} getVisitorTrendsRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetVisitorTrendsRequestOpts(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.
      * @summary Get visitor trends
      * @param {GetVisitorTrendsRequest} getVisitorTrendsRequest
+     * @param {string} [idempotencyKey] Makes retrying this request safe. See components.parameters.IdempotencyKey.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AnalyticsDataApiInterface
      */
     analyticsDataServiceGetVisitorTrendsRaw(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetVisitorTrendsResponse>>;
     /**
-     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.
      * Get visitor trends
      */
     analyticsDataServiceGetVisitorTrends(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetVisitorTrendsResponse>;
@@ -292,12 +325,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetAttributeDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetAttributeDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.
      * Get visitor attribute distribution
      */
     analyticsDataServiceGetAttributeDistributionRaw(requestParameters: AnalyticsDataServiceGetAttributeDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributeDistributionResponse>>;
     /**
-     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns how visitors are spread across the values of one attribute, for example how many gave each rating.  Requires the `analytics:read` scope.
      * Get visitor attribute distribution
      */
     analyticsDataServiceGetAttributeDistribution(requestParameters: AnalyticsDataServiceGetAttributeDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributeDistributionResponse>;
@@ -306,12 +339,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetAttributeMetricRequestOpts(requestParameters: AnalyticsDataServiceGetAttributeMetricRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.
      * Get visitor attribute metric
      */
     analyticsDataServiceGetAttributeMetricRaw(requestParameters: AnalyticsDataServiceGetAttributeMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributeMetricResponse>>;
     /**
-     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.  Requires the `analytics:read` scope.
      * Get visitor attribute metric
      */
     analyticsDataServiceGetAttributeMetric(requestParameters: AnalyticsDataServiceGetAttributeMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributeMetricResponse>;
@@ -320,12 +353,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetAttributeValuesRequestOpts(requestParameters: AnalyticsDataServiceGetAttributeValuesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.
      * List visitor attribute values
      */
     analyticsDataServiceGetAttributeValuesRaw(requestParameters: AnalyticsDataServiceGetAttributeValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributeValuesResponse>>;
     /**
-     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.  Requires the `analytics:read` scope.
      * List visitor attribute values
      */
     analyticsDataServiceGetAttributeValues(requestParameters: AnalyticsDataServiceGetAttributeValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributeValuesResponse>;
@@ -334,12 +367,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetBreakdownRequestOpts(requestParameters: AnalyticsDataServiceGetBreakdownRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.
      * Get dimension breakdown
      */
     analyticsDataServiceGetBreakdownRaw(requestParameters: AnalyticsDataServiceGetBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBreakdownResponse>>;
     /**
-     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).  Requires the `analytics:read` scope.
      * Get dimension breakdown
      */
     analyticsDataServiceGetBreakdown(requestParameters: AnalyticsDataServiceGetBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBreakdownResponse>;
@@ -348,12 +381,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetDeviceDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.
      * Get device distribution
      */
     analyticsDataServiceGetDeviceDistributionRaw(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDeviceDistributionResponse>>;
     /**
-     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.
      * Get device distribution
      */
     analyticsDataServiceGetDeviceDistribution(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDeviceDistributionResponse>;
@@ -362,12 +395,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetGeoBreakdownRequestOpts(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.
      * Get geographic breakdown
      */
     analyticsDataServiceGetGeoBreakdownRaw(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGeoBreakdownResponse>>;
     /**
-     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.
      * Get geographic breakdown
      */
     analyticsDataServiceGetGeoBreakdown(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetGeoBreakdownResponse>;
@@ -376,12 +409,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetGroupedTimeSeriesRequestOpts(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.
      * Get grouped time series
      */
     analyticsDataServiceGetGroupedTimeSeriesRaw(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGroupedTimeSeriesResponse>>;
     /**
-     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.  Requires the `analytics:read` scope.
      * Get grouped time series
      */
     analyticsDataServiceGetGroupedTimeSeries(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetGroupedTimeSeriesResponse>;
@@ -390,12 +423,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetHourOfDayDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.
      * Get hour of day distribution
      */
     analyticsDataServiceGetHourOfDayDistributionRaw(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetHourOfDayDistributionResponse>>;
     /**
-     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve event counts aggregated by hour of day for identifying peak activity times.  Requires the `analytics:read` scope.
      * Get hour of day distribution
      */
     analyticsDataServiceGetHourOfDayDistribution(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetHourOfDayDistributionResponse>;
@@ -404,12 +437,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetStepFunnelRequestOpts(requestParameters: AnalyticsDataServiceGetStepFunnelRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.
      * Get workflow step funnel
      */
     analyticsDataServiceGetStepFunnelRaw(requestParameters: AnalyticsDataServiceGetStepFunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetStepFunnelResponse>>;
     /**
-     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.  Requires the `analytics:read` scope.
      * Get workflow step funnel
      */
     analyticsDataServiceGetStepFunnel(requestParameters: AnalyticsDataServiceGetStepFunnelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetStepFunnelResponse>;
@@ -418,12 +451,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetTopLinksRequestOpts(requestParameters: AnalyticsDataServiceGetTopLinksRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.
      * Get top performing links
      */
     analyticsDataServiceGetTopLinksRaw(requestParameters: AnalyticsDataServiceGetTopLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTopLinksResponse>>;
     /**
-     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve links ranked by event count for identifying best performing QR codes and links.  Requires the `analytics:read` scope.
      * Get top performing links
      */
     analyticsDataServiceGetTopLinks(requestParameters: AnalyticsDataServiceGetTopLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTopLinksResponse>;
@@ -432,12 +465,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetVisitorTrendsRequestOpts(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.
      * Get visitor trends
      */
     analyticsDataServiceGetVisitorTrendsRaw(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetVisitorTrendsResponse>>;
     /**
-     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.  Requires the `analytics:read` scope.
+     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.
      * Get visitor trends
      */
     analyticsDataServiceGetVisitorTrends(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetVisitorTrendsResponse>;