linkbreakers 1.144.0 → 1.146.0

package/dist/apis/AnalyticsDataApi.d.ts

@@ -2,7 +2,7 @@
  * Linkbreakers API
  * This is a documentation of all the APIs of Linkbreakers
  *
- * The version of the OpenAPI document: 1.144.0
+ * The version of the OpenAPI document: 1.146.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -59,7 +59,7 @@ export interface 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.
+     * 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 {*} [options] Override http request option.
@@ -68,7 +68,7 @@ export interface 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.
+     * 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>;
@@ -80,7 +80,7 @@ export interface 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.
+     * 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 {*} [options] Override http request option.
@@ -89,7 +89,7 @@ export interface 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.
+     * 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>;
@@ -101,7 +101,7 @@ export interface 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.
+     * 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 {*} [options] Override http request option.
@@ -110,7 +110,7 @@ export interface 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.
+     * 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>;
@@ -122,7 +122,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetBreakdownRequestOpts(requestParameters: AnalyticsDataServiceGetBreakdownRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).
+     * 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 {*} [options] Override http request option.
@@ -131,7 +131,7 @@ export interface 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).
+     * 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>;
@@ -143,7 +143,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetDeviceDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event distribution across device types.
+     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.
      * @summary Get device distribution
      * @param {GetDeviceDistributionRequest} getDeviceDistributionRequest
      * @param {*} [options] Override http request option.
@@ -152,7 +152,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetDeviceDistributionRaw(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDeviceDistributionResponse>>;
     /**
-     * Retrieve event distribution across device types.
+     * Retrieve event distribution across device types.  Requires the `analytics:read` scope.
      * Get device distribution
      */
     analyticsDataServiceGetDeviceDistribution(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDeviceDistributionResponse>;
@@ -164,7 +164,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetGeoBreakdownRequestOpts(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve geographic distribution of events grouped by country or city.
+     * Retrieve geographic distribution of events grouped by country or city.  Requires the `analytics:read` scope.
      * @summary Get geographic breakdown
      * @param {GetGeoBreakdownRequest} getGeoBreakdownRequest
      * @param {*} [options] Override http request option.
@@ -173,7 +173,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetGeoBreakdownRaw(requestParameters: AnalyticsDataServiceGetGeoBreakdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetGeoBreakdownResponse>>;
     /**
-     * Retrieve geographic distribution of events grouped by country or city.
+     * 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>;
@@ -185,7 +185,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetGroupedTimeSeriesRequestOpts(requestParameters: AnalyticsDataServiceGetGroupedTimeSeriesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.
+     * 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 {*} [options] Override http request option.
@@ -194,7 +194,7 @@ export interface 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.
+     * 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>;
@@ -206,7 +206,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetHourOfDayDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetHourOfDayDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event counts aggregated by hour of day for identifying peak activity times.
+     * 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 {*} [options] Override http request option.
@@ -215,7 +215,7 @@ export interface 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.
+     * 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>;
@@ -227,7 +227,7 @@ export interface 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.
+     * 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 {*} [options] Override http request option.
@@ -236,7 +236,7 @@ export interface 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.
+     * 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>;
@@ -248,7 +248,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetTopLinksRequestOpts(requestParameters: AnalyticsDataServiceGetTopLinksRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve links ranked by event count for identifying best performing QR codes and links.
+     * 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 {*} [options] Override http request option.
@@ -257,7 +257,7 @@ export interface 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.
+     * 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>;
@@ -269,7 +269,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetVisitorTrendsRequestOpts(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve new vs returning visitor counts over time.
+     * Retrieve new vs returning visitor counts over time.  Requires the `analytics:read` scope.
      * @summary Get visitor trends
      * @param {GetVisitorTrendsRequest} getVisitorTrendsRequest
      * @param {*} [options] Override http request option.
@@ -278,7 +278,7 @@ export interface AnalyticsDataApiInterface {
      */
     analyticsDataServiceGetVisitorTrendsRaw(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetVisitorTrendsResponse>>;
     /**
-     * Retrieve new vs returning visitor counts over time.
+     * 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 +292,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.
+     * 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.
+     * 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 +306,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.
+     * 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.
+     * 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 +320,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.
+     * 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.
+     * 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 +334,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).
+     * 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).
+     * 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 +348,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetDeviceDistributionRequestOpts(requestParameters: AnalyticsDataServiceGetDeviceDistributionRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve event distribution across device types.
+     * 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.
+     * 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 +362,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.
+     * 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.
+     * 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 +376,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.
+     * 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.
+     * 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 +390,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.
+     * 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.
+     * 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 +404,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.
+     * 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.
+     * 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 +418,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.
+     * 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.
+     * 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 +432,12 @@ export declare class AnalyticsDataApi extends runtime.BaseAPI implements Analyti
      */
     analyticsDataServiceGetVisitorTrendsRequestOpts(requestParameters: AnalyticsDataServiceGetVisitorTrendsRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve new vs returning visitor counts over time.
+     * 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.
+     * 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>;