linkbreakers 1.144.0 → 1.148.0

package/dist/apis/WorkspacesApi.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -59,9 +59,13 @@ class WorkspacesApi extends runtime.BaseAPI {
     async workspacesServiceDeleteRequestOpts() {
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workspace:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -75,7 +79,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support.
+     * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support.  Requires the `workspace:write` scope.
      * Delete workspace
      */
     async workspacesServiceDeleteRaw(initOverrides) {
@@ -84,7 +88,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support.
+     * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support.  Requires the `workspace:write` scope.
      * Delete workspace
      */
     async workspacesServiceDelete(initOverrides) {
@@ -97,9 +101,13 @@ class WorkspacesApi extends runtime.BaseAPI {
     async workspacesServiceGetMyWorkspaceRequestOpts() {
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workspace:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -113,7 +121,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Return the workspace associated with the authenticated member\'s current session.
+     * Return the workspace associated with the authenticated member\'s current session.  Requires the `workspace:read` scope.
      * Get my workspace
      */
     async workspacesServiceGetMyWorkspaceRaw(initOverrides) {
@@ -122,7 +130,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkspaceFromJSON)(jsonValue));
     }
     /**
-     * Return the workspace associated with the authenticated member\'s current session.
+     * Return the workspace associated with the authenticated member\'s current session.  Requires the `workspace:read` scope.
      * Get my workspace
      */
     async workspacesServiceGetMyWorkspace(initOverrides) {
@@ -138,9 +146,13 @@ class WorkspacesApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["workspace:read"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:read"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -155,7 +167,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Retrieve workspace details for the provided identifier, typically for internal tooling.
+     * Retrieve workspace details for the provided identifier, typically for internal tooling.  Requires the `workspace:read` scope.
      * Get a workspace by ID
      */
     async workspacesServiceGetWorkspaceRaw(requestParameters, initOverrides) {
@@ -164,7 +176,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkspaceFromJSON)(jsonValue));
     }
     /**
-     * Retrieve workspace details for the provided identifier, typically for internal tooling.
+     * Retrieve workspace details for the provided identifier, typically for internal tooling.  Requires the `workspace:read` scope.
      * Get a workspace by ID
      */
     async workspacesServiceGetWorkspace(requestParameters, initOverrides) {
@@ -180,13 +192,6 @@ class WorkspacesApi extends runtime.BaseAPI {
         }
         const queryParameters = {};
         const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
         let urlPath = `/v1/public/workspaces/{slug}`;
         urlPath = urlPath.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug'])));
         return {
@@ -223,9 +228,13 @@ class WorkspacesApi 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", ["workspace:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -240,7 +249,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp.
+     * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp.  Requires the `workspace:write` scope.
      * Request workspace enrollment
      */
     async workspacesServiceRequestEnrollmentRaw(requestParameters, initOverrides) {
@@ -249,7 +258,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp.
+     * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp.  Requires the `workspace:write` scope.
      * Request workspace enrollment
      */
     async workspacesServiceRequestEnrollment(requestParameters, initOverrides) {
@@ -266,9 +275,13 @@ class WorkspacesApi 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", ["workspace:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -283,7 +296,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Modify workspace settings such as the display name and MFA enforcement policy.
+     * Modify workspace settings such as the display name and MFA enforcement policy.  Requires the `workspace:write` scope.
      * Update a workspace
      */
     async workspacesServiceUpdateRaw(requestParameters, initOverrides) {
@@ -292,7 +305,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkspaceFromJSON)(jsonValue));
     }
     /**
-     * Modify workspace settings such as the display name and MFA enforcement policy.
+     * Modify workspace settings such as the display name and MFA enforcement policy.  Requires the `workspace:write` scope.
      * Update a workspace
      */
     async workspacesServiceUpdate(requestParameters, initOverrides) {
@@ -309,9 +322,13 @@ class WorkspacesApi 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", ["workspace:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -326,7 +343,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs.
+     * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs.  Requires the `workspace:write` scope.
      * Update workspace origin inquiry
      */
     async workspacesServiceUpdateOriginInquiryRaw(requestParameters, initOverrides) {
@@ -335,7 +352,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs.
+     * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs.  Requires the `workspace:write` scope.
      * Update workspace origin inquiry
      */
     async workspacesServiceUpdateOriginInquiry(requestParameters, initOverrides) {
@@ -352,9 +369,13 @@ class WorkspacesApi 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", ["workspace:write"]);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
+            const tokenString = await token("bearerAuth", ["workspace:write"]);
             if (tokenString) {
                 headerParameters["Authorization"] = `Bearer ${tokenString}`;
             }
@@ -369,7 +390,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs.
+     * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs.  Requires the `workspace:write` scope.
      * Update workspace origin purpose
      */
     async workspacesServiceUpdateOriginPurposeRaw(requestParameters, initOverrides) {
@@ -378,7 +399,7 @@ class WorkspacesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs.
+     * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs.  Requires the `workspace:write` scope.
      * Update workspace origin purpose
      */
     async workspacesServiceUpdateOriginPurpose(requestParameters, initOverrides) {

package/dist/apis/index.d.ts

@@ -1,3 +1,4 @@
+export * from './APIScopesApi';
 export * from './AnalyticsDashboardApi';
 export * from './AnalyticsDataApi';
 export * from './AssistantApi';
@@ -12,6 +13,7 @@ export * from './MediaApi';
 export * from './MembersApi';
 export * from './PageThemeTemplatesApi';
 export * from './PageThemesApi';
+export * from './PricingApi';
 export * from './QRCodeDesignsApi';
 export * from './QRCodeTemplatesApi';
 export * from './SlackIntegrationsApi';

package/dist/apis/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./APIScopesApi"), exports);
 __exportStar(require("./AnalyticsDashboardApi"), exports);
 __exportStar(require("./AnalyticsDataApi"), exports);
 __exportStar(require("./AssistantApi"), exports);
@@ -30,6 +31,7 @@ __exportStar(require("./MediaApi"), exports);
 __exportStar(require("./MembersApi"), exports);
 __exportStar(require("./PageThemeTemplatesApi"), exports);
 __exportStar(require("./PageThemesApi"), exports);
+__exportStar(require("./PricingApi"), exports);
 __exportStar(require("./QRCodeDesignsApi"), exports);
 __exportStar(require("./QRCodeTemplatesApi"), exports);
 __exportStar(require("./SlackIntegrationsApi"), exports);

package/dist/models/Action.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/Action.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsDashboard.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsDashboard.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsDashboardServiceGenerateWidgetSummaryBody.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsDashboardServiceUpdateDashboardBody.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsWidgetResult.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/AnalyticsWidgetResult.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.148.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ApiScope.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.148.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * ApiScope is one permission an API token or OAuth grant can hold.
+ *
+ * A write scope also grants the read scope of the same resource.
+ *
+ *  - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected.
+ *  - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings.
+ *  - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings.
+ *  - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them.
+ *  - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps.
+ *  - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates.
+ *  - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates.
+ *  - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates.
+ *  - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates.
+ *  - API_SCOPE_MEDIA_READ: Read uploaded media.
+ *  - API_SCOPE_MEDIA_WRITE: Upload and delete media.
+ *  - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions.
+ *  - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains.
+ *  - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes.
+ *  - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes.
+ *  - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards.
+ *  - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries.
+ *  - API_SCOPE_WEBHOOKS_READ: Read webhooks.
+ *  - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks.
+ *  - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations.
+ *  - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations.
+ *  - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings.
+ *  - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace.
+ *  - API_SCOPE_MEMBERS_READ: Read workspace members.
+ *  - API_SCOPE_MEMBERS_WRITE: Invite, update, revoke, sign out and remove members.
+ *  - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets.
+ *  - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds.
+ *  - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions.
+ *  - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation.
+ *  - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support.
+ * @export
+ */
+export declare const ApiScope: {
+    readonly ApiScopeUnspecified: "API_SCOPE_UNSPECIFIED";
+    readonly ApiScopeLinksRead: "API_SCOPE_LINKS_READ";
+    readonly ApiScopeLinksWrite: "API_SCOPE_LINKS_WRITE";
+    readonly ApiScopeWorkflowsRead: "API_SCOPE_WORKFLOWS_READ";
+    readonly ApiScopeWorkflowsWrite: "API_SCOPE_WORKFLOWS_WRITE";
+    readonly ApiScopeQrcodesRead: "API_SCOPE_QRCODES_READ";
+    readonly ApiScopeQrcodesWrite: "API_SCOPE_QRCODES_WRITE";
+    readonly ApiScopePageThemesRead: "API_SCOPE_PAGE_THEMES_READ";
+    readonly ApiScopePageThemesWrite: "API_SCOPE_PAGE_THEMES_WRITE";
+    readonly ApiScopeMediaRead: "API_SCOPE_MEDIA_READ";
+    readonly ApiScopeMediaWrite: "API_SCOPE_MEDIA_WRITE";
+    readonly ApiScopeDomainsRead: "API_SCOPE_DOMAINS_READ";
+    readonly ApiScopeDomainsWrite: "API_SCOPE_DOMAINS_WRITE";
+    readonly ApiScopeVisitorsRead: "API_SCOPE_VISITORS_READ";
+    readonly ApiScopeVisitorsWrite: "API_SCOPE_VISITORS_WRITE";
+    readonly ApiScopeAnalyticsRead: "API_SCOPE_ANALYTICS_READ";
+    readonly ApiScopeAnalyticsWrite: "API_SCOPE_ANALYTICS_WRITE";
+    readonly ApiScopeWebhooksRead: "API_SCOPE_WEBHOOKS_READ";
+    readonly ApiScopeWebhooksWrite: "API_SCOPE_WEBHOOKS_WRITE";
+    readonly ApiScopeIntegrationsRead: "API_SCOPE_INTEGRATIONS_READ";
+    readonly ApiScopeIntegrationsWrite: "API_SCOPE_INTEGRATIONS_WRITE";
+    readonly ApiScopeWorkspaceRead: "API_SCOPE_WORKSPACE_READ";
+    readonly ApiScopeWorkspaceWrite: "API_SCOPE_WORKSPACE_WRITE";
+    readonly ApiScopeMembersRead: "API_SCOPE_MEMBERS_READ";
+    readonly ApiScopeMembersWrite: "API_SCOPE_MEMBERS_WRITE";
+    readonly ApiScopeTokensRead: "API_SCOPE_TOKENS_READ";
+    readonly ApiScopeTokensWrite: "API_SCOPE_TOKENS_WRITE";
+    readonly ApiScopeBillingWrite: "API_SCOPE_BILLING_WRITE";
+    readonly ApiScopeAssistantRead: "API_SCOPE_ASSISTANT_READ";
+    readonly ApiScopeAssistantWrite: "API_SCOPE_ASSISTANT_WRITE";
+};
+export type ApiScope = typeof ApiScope[keyof typeof ApiScope];
+export declare function instanceOfApiScope(value: any): boolean;
+export declare function ApiScopeFromJSON(json: any): ApiScope;
+export declare function ApiScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiScope;
+export declare function ApiScopeToJSON(value?: ApiScope | null): any;
+export declare function ApiScopeToJSONTyped(value: any, ignoreDiscriminator: boolean): ApiScope;

package/dist/models/ApiScope.js

@@ -0,0 +1,112 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.148.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiScope = void 0;
+exports.instanceOfApiScope = instanceOfApiScope;
+exports.ApiScopeFromJSON = ApiScopeFromJSON;
+exports.ApiScopeFromJSONTyped = ApiScopeFromJSONTyped;
+exports.ApiScopeToJSON = ApiScopeToJSON;
+exports.ApiScopeToJSONTyped = ApiScopeToJSONTyped;
+/**
+ * ApiScope is one permission an API token or OAuth grant can hold.
+ *
+ * A write scope also grants the read scope of the same resource.
+ *
+ *  - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected.
+ *  - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings.
+ *  - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings.
+ *  - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them.
+ *  - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps.
+ *  - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates.
+ *  - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates.
+ *  - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates.
+ *  - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates.
+ *  - API_SCOPE_MEDIA_READ: Read uploaded media.
+ *  - API_SCOPE_MEDIA_WRITE: Upload and delete media.
+ *  - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions.
+ *  - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains.
+ *  - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes.
+ *  - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes.
+ *  - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards.
+ *  - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries.
+ *  - API_SCOPE_WEBHOOKS_READ: Read webhooks.
+ *  - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks.
+ *  - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations.
+ *  - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations.
+ *  - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings.
+ *  - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace.
+ *  - API_SCOPE_MEMBERS_READ: Read workspace members.
+ *  - API_SCOPE_MEMBERS_WRITE: Invite, update, revoke, sign out and remove members.
+ *  - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets.
+ *  - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds.
+ *  - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions.
+ *  - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation.
+ *  - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support.
+ * @export
+ */
+exports.ApiScope = {
+    ApiScopeUnspecified: 'API_SCOPE_UNSPECIFIED',
+    ApiScopeLinksRead: 'API_SCOPE_LINKS_READ',
+    ApiScopeLinksWrite: 'API_SCOPE_LINKS_WRITE',
+    ApiScopeWorkflowsRead: 'API_SCOPE_WORKFLOWS_READ',
+    ApiScopeWorkflowsWrite: 'API_SCOPE_WORKFLOWS_WRITE',
+    ApiScopeQrcodesRead: 'API_SCOPE_QRCODES_READ',
+    ApiScopeQrcodesWrite: 'API_SCOPE_QRCODES_WRITE',
+    ApiScopePageThemesRead: 'API_SCOPE_PAGE_THEMES_READ',
+    ApiScopePageThemesWrite: 'API_SCOPE_PAGE_THEMES_WRITE',
+    ApiScopeMediaRead: 'API_SCOPE_MEDIA_READ',
+    ApiScopeMediaWrite: 'API_SCOPE_MEDIA_WRITE',
+    ApiScopeDomainsRead: 'API_SCOPE_DOMAINS_READ',
+    ApiScopeDomainsWrite: 'API_SCOPE_DOMAINS_WRITE',
+    ApiScopeVisitorsRead: 'API_SCOPE_VISITORS_READ',
+    ApiScopeVisitorsWrite: 'API_SCOPE_VISITORS_WRITE',
+    ApiScopeAnalyticsRead: 'API_SCOPE_ANALYTICS_READ',
+    ApiScopeAnalyticsWrite: 'API_SCOPE_ANALYTICS_WRITE',
+    ApiScopeWebhooksRead: 'API_SCOPE_WEBHOOKS_READ',
+    ApiScopeWebhooksWrite: 'API_SCOPE_WEBHOOKS_WRITE',
+    ApiScopeIntegrationsRead: 'API_SCOPE_INTEGRATIONS_READ',
+    ApiScopeIntegrationsWrite: 'API_SCOPE_INTEGRATIONS_WRITE',
+    ApiScopeWorkspaceRead: 'API_SCOPE_WORKSPACE_READ',
+    ApiScopeWorkspaceWrite: 'API_SCOPE_WORKSPACE_WRITE',
+    ApiScopeMembersRead: 'API_SCOPE_MEMBERS_READ',
+    ApiScopeMembersWrite: 'API_SCOPE_MEMBERS_WRITE',
+    ApiScopeTokensRead: 'API_SCOPE_TOKENS_READ',
+    ApiScopeTokensWrite: 'API_SCOPE_TOKENS_WRITE',
+    ApiScopeBillingWrite: 'API_SCOPE_BILLING_WRITE',
+    ApiScopeAssistantRead: 'API_SCOPE_ASSISTANT_READ',
+    ApiScopeAssistantWrite: 'API_SCOPE_ASSISTANT_WRITE'
+};
+function instanceOfApiScope(value) {
+    for (const key in exports.ApiScope) {
+        if (Object.prototype.hasOwnProperty.call(exports.ApiScope, key)) {
+            if (exports.ApiScope[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ApiScopeFromJSON(json) {
+    return ApiScopeFromJSONTyped(json, false);
+}
+function ApiScopeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ApiScopeToJSON(value) {
+    return value;
+}
+function ApiScopeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/ApiScopeAccess.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.148.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * ApiScopeAccess is what a scope allows on its resource.
+ *
+ *  - API_SCOPE_ACCESS_UNSPECIFIED: Not set.
+ *  - API_SCOPE_ACCESS_READ: Reads only.
+ *  - API_SCOPE_ACCESS_WRITE: Reads and writes.
+ * @export
+ */
+export declare const ApiScopeAccess: {
+    readonly ApiScopeAccessUnspecified: "API_SCOPE_ACCESS_UNSPECIFIED";
+    readonly ApiScopeAccessRead: "API_SCOPE_ACCESS_READ";
+    readonly ApiScopeAccessWrite: "API_SCOPE_ACCESS_WRITE";
+};
+export type ApiScopeAccess = typeof ApiScopeAccess[keyof typeof ApiScopeAccess];
+export declare function instanceOfApiScopeAccess(value: any): boolean;
+export declare function ApiScopeAccessFromJSON(json: any): ApiScopeAccess;
+export declare function ApiScopeAccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiScopeAccess;
+export declare function ApiScopeAccessToJSON(value?: ApiScopeAccess | null): any;
+export declare function ApiScopeAccessToJSONTyped(value: any, ignoreDiscriminator: boolean): ApiScopeAccess;