linkbreakers 1.144.0 → 1.146.0

package/dist/apis/WorkflowStepsApi.js

@@ -5,7 +5,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).
@@ -66,9 +66,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -84,7 +88,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch.
+     * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch.  Requires the `workflows:write` scope.
      * Auto-layout workflow
      */
     async workflowStepsServiceAutoLayoutWorkflowRaw(requestParameters, initOverrides) {
@@ -93,7 +97,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AutoLayoutWorkflowResponseFromJSON)(jsonValue));
     }
     /**
-     * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch.
+     * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch.  Requires the `workflows:write` scope.
      * Auto-layout workflow
      */
     async workflowStepsServiceAutoLayoutWorkflow(requestParameters, initOverrides) {
@@ -119,9 +123,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -139,7 +147,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to.  Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all.  Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op.
+     * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to.  Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all.  Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op.  Requires the `workflows:write` scope.
      * Connect one exit of a workflow step to another step
      */
     async workflowStepsServiceConnectStepRaw(requestParameters, initOverrides) {
@@ -148,7 +156,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ConnectWorkflowStepResponseFromJSON)(jsonValue));
     }
     /**
-     * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to.  Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all.  Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op.
+     * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to.  Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all.  Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op.  Requires the `workflows:write` scope.
      * Connect one exit of a workflow step to another step
      */
     async workflowStepsServiceConnectStep(requestParameters, initOverrides) {
@@ -168,9 +176,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -186,7 +198,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations.
+     * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations.  Requires the `workflows:write` scope.
      * Create a new workflow step
      */
     async workflowStepsServiceCreateRaw(requestParameters, initOverrides) {
@@ -195,7 +207,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateWorkflowStepResponseFromJSON)(jsonValue));
     }
     /**
-     * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations.
+     * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations.  Requires the `workflows:write` scope.
      * Create a new workflow step
      */
     async workflowStepsServiceCreate(requestParameters, initOverrides) {
@@ -214,9 +226,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -232,7 +248,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Removes a workflow step from the link. This operation cannot be undone.
+     * Removes a workflow step from the link. This operation cannot be undone.  Requires the `workflows:write` scope.
      * Delete a workflow step
      */
     async workflowStepsServiceDeleteRaw(requestParameters, initOverrides) {
@@ -241,7 +257,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Removes a workflow step from the link. This operation cannot be undone.
+     * Removes a workflow step from the link. This operation cannot be undone.  Requires the `workflows:write` scope.
      * Delete a workflow step
      */
     async workflowStepsServiceDelete(requestParameters, initOverrides) {
@@ -263,9 +279,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -282,7 +302,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is.
+     * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is.  Requires the `workflows:write` scope.
      * Clear one exit of a workflow step
      */
     async workflowStepsServiceDisconnectStepRaw(requestParameters, initOverrides) {
@@ -291,7 +311,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DisconnectWorkflowStepResponseFromJSON)(jsonValue));
     }
     /**
-     * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is.
+     * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is.  Requires the `workflows:write` scope.
      * Clear one exit of a workflow step
      */
     async workflowStepsServiceDisconnectStep(requestParameters, initOverrides) {
@@ -310,9 +330,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -328,7 +352,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Retrieves information about a specific workflow step.
+     * Retrieves information about a specific workflow step.  Requires the `workflows:read` scope.
      * Get workflow step details
      */
     async workflowStepsServiceGetRaw(requestParameters, initOverrides) {
@@ -337,7 +361,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetWorkflowStepResponseFromJSON)(jsonValue));
     }
     /**
-     * Retrieves information about a specific workflow step.
+     * Retrieves information about a specific workflow step.  Requires the `workflows:read` scope.
      * Get workflow step details
      */
     async workflowStepsServiceGet(requestParameters, initOverrides) {
@@ -359,9 +383,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
             queryParameters['pageToken'] = requestParameters['pageToken'];
         }
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -376,7 +404,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Retrieves all workflow steps for a specific link
+     * Retrieves all workflow steps for a specific link  Requires the `workflows:read` scope.
      * List workflow steps for a link
      */
     async workflowStepsServiceListRaw(requestParameters, initOverrides) {
@@ -385,7 +413,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListWorkflowStepsResponseFromJSON)(jsonValue));
     }
     /**
-     * Retrieves all workflow steps for a specific link
+     * Retrieves all workflow steps for a specific link  Requires the `workflows:read` scope.
      * List workflow steps for a link
      */
     async workflowStepsServiceList(requestParameters, initOverrides) {
@@ -408,9 +436,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -427,7 +459,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout.
+     * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout.  Requires the `workflows:write` scope.
      * Resolve step collisions
      */
     async workflowStepsServiceResolveStepCollisionsRaw(requestParameters, initOverrides) {
@@ -436,7 +468,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ResolveStepCollisionsResponseFromJSON)(jsonValue));
     }
     /**
-     * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout.
+     * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout.  Requires the `workflows:write` scope.
      * Resolve step collisions
      */
     async workflowStepsServiceResolveStepCollisions(requestParameters, initOverrides) {
@@ -459,9 +491,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         const queryParameters = {};
         const headerParameters = {};
         headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -478,7 +514,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Updates an existing workflow step for a link.
+     * Updates an existing workflow step for a link.  Requires the `workflows:write` scope.
      * Update a workflow step
      */
     async workflowStepsServiceUpdateRaw(requestParameters, initOverrides) {
@@ -487,7 +523,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateWorkflowStepResponseFromJSON)(jsonValue));
     }
     /**
-     * Updates an existing workflow step for a link.
+     * Updates an existing workflow step for a link.  Requires the `workflows:write` scope.
      * Update a workflow step
      */
     async workflowStepsServiceUpdate(requestParameters, initOverrides) {
@@ -503,9 +539,13 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workflows:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workflows:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -520,6 +560,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         };
     }
     /**
+     * Requires the `workflows:read` scope.
      */
     async workflowStepsServiceValidateWorkflowRaw(requestParameters, initOverrides) {
         const requestOptions = await this.workflowStepsServiceValidateWorkflowRequestOpts(requestParameters);
@@ -527,6 +568,7 @@ class WorkflowStepsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ValidateWorkflowResponseFromJSON)(jsonValue));
     }
     /**
+     * Requires the `workflows:read` scope.
      */
     async workflowStepsServiceValidateWorkflow(requestParameters, initOverrides) {
         const response = await this.workflowStepsServiceValidateWorkflowRaw(requestParameters, initOverrides);

package/dist/apis/WorkspaceMetricsApi.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).
@@ -33,7 +33,7 @@ export interface WorkspaceMetricsApiInterface {
      */
     metricsServiceGetEventsMetricRequestOpts(requestParameters: MetricsServiceGetEventsMetricRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve aggregated event analytics for the provided time window and optional link filter.
+     * Retrieve aggregated event analytics for the provided time window and optional link filter.  Requires the `analytics:read` scope.
      * @summary Get events metric
      * @param {Date} [startDate] Inclusive start timestamp for the aggregation
      * @param {Date} [endDate] Inclusive end timestamp for the aggregation
@@ -44,7 +44,7 @@ export interface WorkspaceMetricsApiInterface {
      */
     metricsServiceGetEventsMetricRaw(requestParameters: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EventsMetric>>;
     /**
-     * Retrieve aggregated event analytics for the provided time window and optional link filter.
+     * Retrieve aggregated event analytics for the provided time window and optional link filter.  Requires the `analytics:read` scope.
      * Get events metric
      */
     metricsServiceGetEventsMetric(requestParameters: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EventsMetric>;
@@ -55,7 +55,7 @@ export interface WorkspaceMetricsApiInterface {
      */
     metricsServiceGetWorkspaceInsightRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Return workspace usage insights including the preferred link type based on historical link creation patterns.
+     * Return workspace usage insights including the preferred link type based on historical link creation patterns.  Requires the `analytics:read` scope.
      * @summary Get workspace insight
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -63,7 +63,7 @@ export interface WorkspaceMetricsApiInterface {
      */
     metricsServiceGetWorkspaceInsightRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceInsight>>;
     /**
-     * Return workspace usage insights including the preferred link type based on historical link creation patterns.
+     * Return workspace usage insights including the preferred link type based on historical link creation patterns.  Requires the `analytics:read` scope.
      * Get workspace insight
      */
     metricsServiceGetWorkspaceInsight(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceInsight>;
@@ -74,7 +74,7 @@ export interface WorkspaceMetricsApiInterface {
      */
     metricsServiceGetWorkspaceMetricRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Return high-level workspace totals covering members, links, and activity volume.
+     * Return high-level workspace totals covering members, links, and activity volume.  Requires the `analytics:read` scope.
      * @summary Get workspace metric
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -82,7 +82,7 @@ export interface WorkspaceMetricsApiInterface {
      */
     metricsServiceGetWorkspaceMetricRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceMetric>>;
     /**
-     * Return high-level workspace totals covering members, links, and activity volume.
+     * Return high-level workspace totals covering members, links, and activity volume.  Requires the `analytics:read` scope.
      * Get workspace metric
      */
     metricsServiceGetWorkspaceMetric(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceMetric>;
@@ -96,12 +96,12 @@ export declare class WorkspaceMetricsApi extends runtime.BaseAPI implements Work
      */
     metricsServiceGetEventsMetricRequestOpts(requestParameters: MetricsServiceGetEventsMetricRequest): Promise<runtime.RequestOpts>;
     /**
-     * Retrieve aggregated event analytics for the provided time window and optional link filter.
+     * Retrieve aggregated event analytics for the provided time window and optional link filter.  Requires the `analytics:read` scope.
      * Get events metric
      */
     metricsServiceGetEventsMetricRaw(requestParameters: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EventsMetric>>;
     /**
-     * Retrieve aggregated event analytics for the provided time window and optional link filter.
+     * Retrieve aggregated event analytics for the provided time window and optional link filter.  Requires the `analytics:read` scope.
      * Get events metric
      */
     metricsServiceGetEventsMetric(requestParameters?: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EventsMetric>;
@@ -110,12 +110,12 @@ export declare class WorkspaceMetricsApi extends runtime.BaseAPI implements Work
      */
     metricsServiceGetWorkspaceInsightRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Return workspace usage insights including the preferred link type based on historical link creation patterns.
+     * Return workspace usage insights including the preferred link type based on historical link creation patterns.  Requires the `analytics:read` scope.
      * Get workspace insight
      */
     metricsServiceGetWorkspaceInsightRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceInsight>>;
     /**
-     * Return workspace usage insights including the preferred link type based on historical link creation patterns.
+     * Return workspace usage insights including the preferred link type based on historical link creation patterns.  Requires the `analytics:read` scope.
      * Get workspace insight
      */
     metricsServiceGetWorkspaceInsight(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceInsight>;
@@ -124,12 +124,12 @@ export declare class WorkspaceMetricsApi extends runtime.BaseAPI implements Work
      */
     metricsServiceGetWorkspaceMetricRequestOpts(): Promise<runtime.RequestOpts>;
     /**
-     * Return high-level workspace totals covering members, links, and activity volume.
+     * Return high-level workspace totals covering members, links, and activity volume.  Requires the `analytics:read` scope.
      * Get workspace metric
      */
     metricsServiceGetWorkspaceMetricRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkspaceMetric>>;
     /**
-     * Return high-level workspace totals covering members, links, and activity volume.
+     * Return high-level workspace totals covering members, links, and activity volume.  Requires the `analytics:read` scope.
      * Get workspace metric
      */
     metricsServiceGetWorkspaceMetric(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkspaceMetric>;

package/dist/apis/WorkspaceMetricsApi.js

@@ -5,7 +5,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).
@@ -68,9 +68,13 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
             queryParameters['linkId'] = requestParameters['linkId'];
         }
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["analytics:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -84,7 +88,7 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Retrieve aggregated event analytics for the provided time window and optional link filter.
+     * Retrieve aggregated event analytics for the provided time window and optional link filter.  Requires the `analytics:read` scope.
      * Get events metric
      */
     async metricsServiceGetEventsMetricRaw(requestParameters, initOverrides) {
@@ -93,7 +97,7 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EventsMetricFromJSON)(jsonValue));
     }
     /**
-     * Retrieve aggregated event analytics for the provided time window and optional link filter.
+     * Retrieve aggregated event analytics for the provided time window and optional link filter.  Requires the `analytics:read` scope.
      * Get events metric
      */
     async metricsServiceGetEventsMetric(requestParameters = {}, initOverrides) {
@@ -106,9 +110,13 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
     async metricsServiceGetWorkspaceInsightRequestOpts() {
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["analytics:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -122,7 +130,7 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Return workspace usage insights including the preferred link type based on historical link creation patterns.
+     * Return workspace usage insights including the preferred link type based on historical link creation patterns.  Requires the `analytics:read` scope.
      * Get workspace insight
      */
     async metricsServiceGetWorkspaceInsightRaw(initOverrides) {
@@ -131,7 +139,7 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkspaceInsightFromJSON)(jsonValue));
     }
     /**
-     * Return workspace usage insights including the preferred link type based on historical link creation patterns.
+     * Return workspace usage insights including the preferred link type based on historical link creation patterns.  Requires the `analytics:read` scope.
      * Get workspace insight
      */
     async metricsServiceGetWorkspaceInsight(initOverrides) {
@@ -144,9 +152,13 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
     async metricsServiceGetWorkspaceMetricRequestOpts() {
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["analytics:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["analytics:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -160,7 +172,7 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Return high-level workspace totals covering members, links, and activity volume.
+     * Return high-level workspace totals covering members, links, and activity volume.  Requires the `analytics:read` scope.
      * Get workspace metric
      */
     async metricsServiceGetWorkspaceMetricRaw(initOverrides) {
@@ -169,7 +181,7 @@ class WorkspaceMetricsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkspaceMetricFromJSON)(jsonValue));
     }
     /**
-     * Return high-level workspace totals covering members, links, and activity volume.
+     * Return high-level workspace totals covering members, links, and activity volume.  Requires the `analytics:read` scope.
      * Get workspace metric
      */
     async metricsServiceGetWorkspaceMetric(initOverrides) {