linkbreakers 1.34.0

package/dist/models/Workspace.d.ts

@@ -0,0 +1,158 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Serves as the tenant boundary in Linkbreakers, grouping links, members, settings, billing state,
+ * and analytics under a single organization's environment.
+ * @export
+ * @interface Workspace
+ */
+export interface Workspace {
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    country?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    createdAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    description?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Workspace
+     */
+    enforceMfa?: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    enrollRequestedAt?: Date;
+    /**
+     * Frequently Asked Questions about this workspace stored as JSON
+     * @type {string}
+     * @memberof Workspace
+     */
+    faq?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    id?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    inactiveSince?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    linkSettingId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    name?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    publishedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    shortDescription?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    slug?: string;
+    /**
+     * - SUBSCRIPTION_TYPE_UNSPECIFIED: Subscription plan not yet assigned
+     *  - SUBSCRIPTION_TYPE_FREE_TRIAL: Workspace is currently in the free trial period
+     *  - SUBSCRIPTION_TYPE_SPONSORED_PRO: Workspace is on the sponsored pro plan with full pro features
+     *  - SUBSCRIPTION_TYPE_PRO_PLAN: Workspace has an active Pro plan subscription
+     *  - SUBSCRIPTION_TYPE_ENTERPRISE_PLAN: Workspace is managed under an Enterprise contract
+     *  - SUBSCRIPTION_TYPE_LIGHT_PLAN: Workspace has an active Light plan subscription
+     * @type {WorkspaceSubscriptionTypeEnum}
+     * @memberof Workspace
+     */
+    subscriptionType?: WorkspaceSubscriptionTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    tags?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    timezone?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Workspace
+     */
+    verifiedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    website?: string;
+}
+/**
+ * @export
+ */
+export declare const WorkspaceSubscriptionTypeEnum: {
+    readonly SubscriptionTypeUnspecified: "SUBSCRIPTION_TYPE_UNSPECIFIED";
+    readonly SubscriptionTypeFreeTrial: "SUBSCRIPTION_TYPE_FREE_TRIAL";
+    readonly SubscriptionTypeSponsoredPro: "SUBSCRIPTION_TYPE_SPONSORED_PRO";
+    readonly SubscriptionTypeProPlan: "SUBSCRIPTION_TYPE_PRO_PLAN";
+    readonly SubscriptionTypeEnterprisePlan: "SUBSCRIPTION_TYPE_ENTERPRISE_PLAN";
+    readonly SubscriptionTypeLightPlan: "SUBSCRIPTION_TYPE_LIGHT_PLAN";
+};
+export type WorkspaceSubscriptionTypeEnum = typeof WorkspaceSubscriptionTypeEnum[keyof typeof WorkspaceSubscriptionTypeEnum];
+/**
+ * Check if a given object implements the Workspace interface.
+ */
+export declare function instanceOfWorkspace(value: object): value is Workspace;
+export declare function WorkspaceFromJSON(json: any): Workspace;
+export declare function WorkspaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Workspace;
+export declare function WorkspaceToJSON(json: any): Workspace;
+export declare function WorkspaceToJSONTyped(value?: Workspace | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Workspace.js

@@ -0,0 +1,96 @@
+"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.34.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.WorkspaceSubscriptionTypeEnum = void 0;
+exports.instanceOfWorkspace = instanceOfWorkspace;
+exports.WorkspaceFromJSON = WorkspaceFromJSON;
+exports.WorkspaceFromJSONTyped = WorkspaceFromJSONTyped;
+exports.WorkspaceToJSON = WorkspaceToJSON;
+exports.WorkspaceToJSONTyped = WorkspaceToJSONTyped;
+/**
+ * @export
+ */
+exports.WorkspaceSubscriptionTypeEnum = {
+    SubscriptionTypeUnspecified: 'SUBSCRIPTION_TYPE_UNSPECIFIED',
+    SubscriptionTypeFreeTrial: 'SUBSCRIPTION_TYPE_FREE_TRIAL',
+    SubscriptionTypeSponsoredPro: 'SUBSCRIPTION_TYPE_SPONSORED_PRO',
+    SubscriptionTypeProPlan: 'SUBSCRIPTION_TYPE_PRO_PLAN',
+    SubscriptionTypeEnterprisePlan: 'SUBSCRIPTION_TYPE_ENTERPRISE_PLAN',
+    SubscriptionTypeLightPlan: 'SUBSCRIPTION_TYPE_LIGHT_PLAN'
+};
+/**
+ * Check if a given object implements the Workspace interface.
+ */
+function instanceOfWorkspace(value) {
+    return true;
+}
+function WorkspaceFromJSON(json) {
+    return WorkspaceFromJSONTyped(json, false);
+}
+function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'country': json['country'] == null ? undefined : json['country'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'description': json['description'] == null ? undefined : json['description'],
+        'enforceMfa': json['enforceMfa'] == null ? undefined : json['enforceMfa'],
+        'enrollRequestedAt': json['enrollRequestedAt'] == null ? undefined : (new Date(json['enrollRequestedAt'])),
+        'faq': json['faq'] == null ? undefined : json['faq'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'inactiveSince': json['inactiveSince'] == null ? undefined : (new Date(json['inactiveSince'])),
+        'linkSettingId': json['linkSettingId'] == null ? undefined : json['linkSettingId'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'publishedAt': json['publishedAt'] == null ? undefined : (new Date(json['publishedAt'])),
+        'shortDescription': json['shortDescription'] == null ? undefined : json['shortDescription'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'subscriptionType': json['subscriptionType'] == null ? undefined : json['subscriptionType'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'timezone': json['timezone'] == null ? undefined : json['timezone'],
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+        'verifiedAt': json['verifiedAt'] == null ? undefined : (new Date(json['verifiedAt'])),
+        'website': json['website'] == null ? undefined : json['website'],
+    };
+}
+function WorkspaceToJSON(json) {
+    return WorkspaceToJSONTyped(json, false);
+}
+function WorkspaceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'country': value['country'],
+        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'description': value['description'],
+        'enforceMfa': value['enforceMfa'],
+        'enrollRequestedAt': value['enrollRequestedAt'] == null ? value['enrollRequestedAt'] : value['enrollRequestedAt'].toISOString(),
+        'faq': value['faq'],
+        'id': value['id'],
+        'inactiveSince': value['inactiveSince'] == null ? value['inactiveSince'] : value['inactiveSince'].toISOString(),
+        'linkSettingId': value['linkSettingId'],
+        'name': value['name'],
+        'publishedAt': value['publishedAt'] == null ? value['publishedAt'] : value['publishedAt'].toISOString(),
+        'shortDescription': value['shortDescription'],
+        'slug': value['slug'],
+        'subscriptionType': value['subscriptionType'],
+        'tags': value['tags'],
+        'timezone': value['timezone'],
+        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'verifiedAt': value['verifiedAt'] == null ? value['verifiedAt'] : value['verifiedAt'].toISOString(),
+        'website': value['website'],
+    };
+}

package/dist/models/WorkspaceInsight.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PreferredLinkType } from './PreferredLinkType';
+/**
+ * Derived workspace usage insight that helps the UI pre-select the right link type when creating new links.
+ * Results are cached in Redis and refreshed on every successful link creation.
+ * @export
+ * @interface WorkspaceInsight
+ */
+export interface WorkspaceInsight {
+    /**
+     *
+     * @type {PreferredLinkType}
+     * @memberof WorkspaceInsight
+     */
+    preferredLinkType?: PreferredLinkType;
+}
+/**
+ * Check if a given object implements the WorkspaceInsight interface.
+ */
+export declare function instanceOfWorkspaceInsight(value: object): value is WorkspaceInsight;
+export declare function WorkspaceInsightFromJSON(json: any): WorkspaceInsight;
+export declare function WorkspaceInsightFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceInsight;
+export declare function WorkspaceInsightToJSON(json: any): WorkspaceInsight;
+export declare function WorkspaceInsightToJSONTyped(value?: WorkspaceInsight | null, ignoreDiscriminator?: boolean): any;

package/dist/models/WorkspaceInsight.js

@@ -0,0 +1,49 @@
+"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.34.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.instanceOfWorkspaceInsight = instanceOfWorkspaceInsight;
+exports.WorkspaceInsightFromJSON = WorkspaceInsightFromJSON;
+exports.WorkspaceInsightFromJSONTyped = WorkspaceInsightFromJSONTyped;
+exports.WorkspaceInsightToJSON = WorkspaceInsightToJSON;
+exports.WorkspaceInsightToJSONTyped = WorkspaceInsightToJSONTyped;
+const PreferredLinkType_1 = require("./PreferredLinkType");
+/**
+ * Check if a given object implements the WorkspaceInsight interface.
+ */
+function instanceOfWorkspaceInsight(value) {
+    return true;
+}
+function WorkspaceInsightFromJSON(json) {
+    return WorkspaceInsightFromJSONTyped(json, false);
+}
+function WorkspaceInsightFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'preferredLinkType': json['preferredLinkType'] == null ? undefined : (0, PreferredLinkType_1.PreferredLinkTypeFromJSON)(json['preferredLinkType']),
+    };
+}
+function WorkspaceInsightToJSON(json) {
+    return WorkspaceInsightToJSONTyped(json, false);
+}
+function WorkspaceInsightToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'preferredLinkType': (0, PreferredLinkType_1.PreferredLinkTypeToJSON)(value['preferredLinkType']),
+    };
+}

package/dist/models/WorkspaceMetric.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Snapshot of high-level counters Linkbreakers surfaces on the dashboard so teams can track workspace growth at a glance.
+ * @export
+ * @interface WorkspaceMetric
+ */
+export interface WorkspaceMetric {
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    tokenCreditsLimit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    tokenCreditsUsed?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    totalEvents?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    totalLinks?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    totalMembers?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    totalMonthlyEvents?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkspaceMetric
+     */
+    totalQrcodeTemplates?: number;
+}
+/**
+ * Check if a given object implements the WorkspaceMetric interface.
+ */
+export declare function instanceOfWorkspaceMetric(value: object): value is WorkspaceMetric;
+export declare function WorkspaceMetricFromJSON(json: any): WorkspaceMetric;
+export declare function WorkspaceMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceMetric;
+export declare function WorkspaceMetricToJSON(json: any): WorkspaceMetric;
+export declare function WorkspaceMetricToJSONTyped(value?: WorkspaceMetric | null, ignoreDiscriminator?: boolean): any;

package/dist/models/WorkspaceMetric.js

@@ -0,0 +1,60 @@
+"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.34.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.instanceOfWorkspaceMetric = instanceOfWorkspaceMetric;
+exports.WorkspaceMetricFromJSON = WorkspaceMetricFromJSON;
+exports.WorkspaceMetricFromJSONTyped = WorkspaceMetricFromJSONTyped;
+exports.WorkspaceMetricToJSON = WorkspaceMetricToJSON;
+exports.WorkspaceMetricToJSONTyped = WorkspaceMetricToJSONTyped;
+/**
+ * Check if a given object implements the WorkspaceMetric interface.
+ */
+function instanceOfWorkspaceMetric(value) {
+    return true;
+}
+function WorkspaceMetricFromJSON(json) {
+    return WorkspaceMetricFromJSONTyped(json, false);
+}
+function WorkspaceMetricFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tokenCreditsLimit': json['tokenCreditsLimit'] == null ? undefined : json['tokenCreditsLimit'],
+        'tokenCreditsUsed': json['tokenCreditsUsed'] == null ? undefined : json['tokenCreditsUsed'],
+        'totalEvents': json['totalEvents'] == null ? undefined : json['totalEvents'],
+        'totalLinks': json['totalLinks'] == null ? undefined : json['totalLinks'],
+        'totalMembers': json['totalMembers'] == null ? undefined : json['totalMembers'],
+        'totalMonthlyEvents': json['totalMonthlyEvents'] == null ? undefined : json['totalMonthlyEvents'],
+        'totalQrcodeTemplates': json['totalQrcodeTemplates'] == null ? undefined : json['totalQrcodeTemplates'],
+    };
+}
+function WorkspaceMetricToJSON(json) {
+    return WorkspaceMetricToJSONTyped(json, false);
+}
+function WorkspaceMetricToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tokenCreditsLimit': value['tokenCreditsLimit'],
+        'tokenCreditsUsed': value['tokenCreditsUsed'],
+        'totalEvents': value['totalEvents'],
+        'totalLinks': value['totalLinks'],
+        'totalMembers': value['totalMembers'],
+        'totalMonthlyEvents': value['totalMonthlyEvents'],
+        'totalQrcodeTemplates': value['totalQrcodeTemplates'],
+    };
+}

package/dist/models/WorkspaceToken.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Describes a long-lived credential Linkbreakers issues so back-end integrations can call workspace APIs
+ * without a human session, while keeping auditing metadata for security reviews.
+ * @export
+ * @interface WorkspaceToken
+ */
+export interface WorkspaceToken {
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkspaceToken
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceToken
+     */
+    createdBy?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceToken
+     */
+    id?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkspaceToken
+     */
+    readonly lastUsedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceToken
+     */
+    name?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkspaceToken
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkspaceToken
+     */
+    workspaceId?: string;
+}
+/**
+ * Check if a given object implements the WorkspaceToken interface.
+ */
+export declare function instanceOfWorkspaceToken(value: object): value is WorkspaceToken;
+export declare function WorkspaceTokenFromJSON(json: any): WorkspaceToken;
+export declare function WorkspaceTokenFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkspaceToken;
+export declare function WorkspaceTokenToJSON(json: any): WorkspaceToken;
+export declare function WorkspaceTokenToJSONTyped(value?: Omit<WorkspaceToken, 'createdAt' | 'lastUsedAt' | 'updatedAt'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/WorkspaceToken.js

@@ -0,0 +1,57 @@
+"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.34.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.instanceOfWorkspaceToken = instanceOfWorkspaceToken;
+exports.WorkspaceTokenFromJSON = WorkspaceTokenFromJSON;
+exports.WorkspaceTokenFromJSONTyped = WorkspaceTokenFromJSONTyped;
+exports.WorkspaceTokenToJSON = WorkspaceTokenToJSON;
+exports.WorkspaceTokenToJSONTyped = WorkspaceTokenToJSONTyped;
+/**
+ * Check if a given object implements the WorkspaceToken interface.
+ */
+function instanceOfWorkspaceToken(value) {
+    return true;
+}
+function WorkspaceTokenFromJSON(json) {
+    return WorkspaceTokenFromJSONTyped(json, false);
+}
+function WorkspaceTokenFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'lastUsedAt': json['lastUsedAt'] == null ? undefined : (new Date(json['lastUsedAt'])),
+        'name': json['name'] == null ? undefined : json['name'],
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+        'workspaceId': json['workspaceId'] == null ? undefined : json['workspaceId'],
+    };
+}
+function WorkspaceTokenToJSON(json) {
+    return WorkspaceTokenToJSONTyped(json, false);
+}
+function WorkspaceTokenToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'createdBy': value['createdBy'],
+        'id': value['id'],
+        'name': value['name'],
+        'workspaceId': value['workspaceId'],
+    };
+}