linkbreakers 1.34.0

package/dist/models/ImportQrcodeTemplateResponse.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.instanceOfImportQrcodeTemplateResponse = instanceOfImportQrcodeTemplateResponse;
+exports.ImportQrcodeTemplateResponseFromJSON = ImportQrcodeTemplateResponseFromJSON;
+exports.ImportQrcodeTemplateResponseFromJSONTyped = ImportQrcodeTemplateResponseFromJSONTyped;
+exports.ImportQrcodeTemplateResponseToJSON = ImportQrcodeTemplateResponseToJSON;
+exports.ImportQrcodeTemplateResponseToJSONTyped = ImportQrcodeTemplateResponseToJSONTyped;
+const QrcodeTemplate_1 = require("./QrcodeTemplate");
+/**
+ * Check if a given object implements the ImportQrcodeTemplateResponse interface.
+ */
+function instanceOfImportQrcodeTemplateResponse(value) {
+    return true;
+}
+function ImportQrcodeTemplateResponseFromJSON(json) {
+    return ImportQrcodeTemplateResponseFromJSONTyped(json, false);
+}
+function ImportQrcodeTemplateResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'qrcodeTemplate': json['qrcodeTemplate'] == null ? undefined : (0, QrcodeTemplate_1.QrcodeTemplateFromJSON)(json['qrcodeTemplate']),
+    };
+}
+function ImportQrcodeTemplateResponseToJSON(json) {
+    return ImportQrcodeTemplateResponseToJSONTyped(json, false);
+}
+function ImportQrcodeTemplateResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'qrcodeTemplate': (0, QrcodeTemplate_1.QrcodeTemplateToJSON)(value['qrcodeTemplate']),
+    };
+}

package/dist/models/InviteMemberRequest.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * InviteMemberRequest seeds a new teammate invite email and pending membership.
+ * @export
+ * @interface InviteMemberRequest
+ */
+export interface InviteMemberRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof InviteMemberRequest
+     */
+    email?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InviteMemberRequest
+     */
+    firstName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InviteMemberRequest
+     */
+    lastName?: string;
+}
+/**
+ * Check if a given object implements the InviteMemberRequest interface.
+ */
+export declare function instanceOfInviteMemberRequest(value: object): value is InviteMemberRequest;
+export declare function InviteMemberRequestFromJSON(json: any): InviteMemberRequest;
+export declare function InviteMemberRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteMemberRequest;
+export declare function InviteMemberRequestToJSON(json: any): InviteMemberRequest;
+export declare function InviteMemberRequestToJSONTyped(value?: InviteMemberRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/InviteMemberRequest.js

@@ -0,0 +1,52 @@
+"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.instanceOfInviteMemberRequest = instanceOfInviteMemberRequest;
+exports.InviteMemberRequestFromJSON = InviteMemberRequestFromJSON;
+exports.InviteMemberRequestFromJSONTyped = InviteMemberRequestFromJSONTyped;
+exports.InviteMemberRequestToJSON = InviteMemberRequestToJSON;
+exports.InviteMemberRequestToJSONTyped = InviteMemberRequestToJSONTyped;
+/**
+ * Check if a given object implements the InviteMemberRequest interface.
+ */
+function instanceOfInviteMemberRequest(value) {
+    return true;
+}
+function InviteMemberRequestFromJSON(json) {
+    return InviteMemberRequestFromJSONTyped(json, false);
+}
+function InviteMemberRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'email': json['email'] == null ? undefined : json['email'],
+        'firstName': json['firstName'] == null ? undefined : json['firstName'],
+        'lastName': json['lastName'] == null ? undefined : json['lastName'],
+    };
+}
+function InviteMemberRequestToJSON(json) {
+    return InviteMemberRequestToJSONTyped(json, false);
+}
+function InviteMemberRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'email': value['email'],
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+    };
+}

package/dist/models/LeadScore.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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.
+ */
+/**
+ * Stores the AI-generated assessment Linkbreakers produces for a visitor's engagement with a link, including reasoning signals
+ * and user feedback to continuously refine scoring.
+ * @export
+ * @interface LeadScore
+ */
+export interface LeadScore {
+    /**
+     *
+     * @type {string}
+     * @memberof LeadScore
+     */
+    analysisText?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    brandSupportiveness?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof LeadScore
+     */
+    createdAt?: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    engagementLevel?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof LeadScore
+     */
+    id?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    leadScore?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof LeadScore
+     */
+    linkId?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    profileFit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    recurringInterest?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    recurringScans?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScore
+     */
+    technologicalAptitude?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof LeadScore
+     */
+    updatedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof LeadScore
+     */
+    visitorId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LeadScore
+     */
+    workspaceId?: string;
+}
+/**
+ * Check if a given object implements the LeadScore interface.
+ */
+export declare function instanceOfLeadScore(value: object): value is LeadScore;
+export declare function LeadScoreFromJSON(json: any): LeadScore;
+export declare function LeadScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadScore;
+export declare function LeadScoreToJSON(json: any): LeadScore;
+export declare function LeadScoreToJSONTyped(value?: LeadScore | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LeadScore.js

@@ -0,0 +1,74 @@
+"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.instanceOfLeadScore = instanceOfLeadScore;
+exports.LeadScoreFromJSON = LeadScoreFromJSON;
+exports.LeadScoreFromJSONTyped = LeadScoreFromJSONTyped;
+exports.LeadScoreToJSON = LeadScoreToJSON;
+exports.LeadScoreToJSONTyped = LeadScoreToJSONTyped;
+/**
+ * Check if a given object implements the LeadScore interface.
+ */
+function instanceOfLeadScore(value) {
+    return true;
+}
+function LeadScoreFromJSON(json) {
+    return LeadScoreFromJSONTyped(json, false);
+}
+function LeadScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'analysisText': json['analysisText'] == null ? undefined : json['analysisText'],
+        'brandSupportiveness': json['brandSupportiveness'] == null ? undefined : json['brandSupportiveness'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'engagementLevel': json['engagementLevel'] == null ? undefined : json['engagementLevel'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'leadScore': json['leadScore'] == null ? undefined : json['leadScore'],
+        'linkId': json['linkId'] == null ? undefined : json['linkId'],
+        'profileFit': json['profileFit'] == null ? undefined : json['profileFit'],
+        'recurringInterest': json['recurringInterest'] == null ? undefined : json['recurringInterest'],
+        'recurringScans': json['recurringScans'] == null ? undefined : json['recurringScans'],
+        'technologicalAptitude': json['technologicalAptitude'] == null ? undefined : json['technologicalAptitude'],
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+        'visitorId': json['visitorId'] == null ? undefined : json['visitorId'],
+        'workspaceId': json['workspaceId'] == null ? undefined : json['workspaceId'],
+    };
+}
+function LeadScoreToJSON(json) {
+    return LeadScoreToJSONTyped(json, false);
+}
+function LeadScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'analysisText': value['analysisText'],
+        'brandSupportiveness': value['brandSupportiveness'],
+        'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+        'engagementLevel': value['engagementLevel'],
+        'id': value['id'],
+        'leadScore': value['leadScore'],
+        'linkId': value['linkId'],
+        'profileFit': value['profileFit'],
+        'recurringInterest': value['recurringInterest'],
+        'recurringScans': value['recurringScans'],
+        'technologicalAptitude': value['technologicalAptitude'],
+        'updatedAt': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'visitorId': value['visitorId'],
+        'workspaceId': value['workspaceId'],
+    };
+}

package/dist/models/LeadScoreBreakdown.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface LeadScoreBreakdown
+ */
+export interface LeadScoreBreakdown {
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScoreBreakdown
+     */
+    brandSupportiveness?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScoreBreakdown
+     */
+    engagementLevel?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScoreBreakdown
+     */
+    profileFit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScoreBreakdown
+     */
+    recurringInterest?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LeadScoreBreakdown
+     */
+    technologicalAptitude?: number;
+}
+/**
+ * Check if a given object implements the LeadScoreBreakdown interface.
+ */
+export declare function instanceOfLeadScoreBreakdown(value: object): value is LeadScoreBreakdown;
+export declare function LeadScoreBreakdownFromJSON(json: any): LeadScoreBreakdown;
+export declare function LeadScoreBreakdownFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadScoreBreakdown;
+export declare function LeadScoreBreakdownToJSON(json: any): LeadScoreBreakdown;
+export declare function LeadScoreBreakdownToJSONTyped(value?: LeadScoreBreakdown | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LeadScoreBreakdown.js

@@ -0,0 +1,56 @@
+"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.instanceOfLeadScoreBreakdown = instanceOfLeadScoreBreakdown;
+exports.LeadScoreBreakdownFromJSON = LeadScoreBreakdownFromJSON;
+exports.LeadScoreBreakdownFromJSONTyped = LeadScoreBreakdownFromJSONTyped;
+exports.LeadScoreBreakdownToJSON = LeadScoreBreakdownToJSON;
+exports.LeadScoreBreakdownToJSONTyped = LeadScoreBreakdownToJSONTyped;
+/**
+ * Check if a given object implements the LeadScoreBreakdown interface.
+ */
+function instanceOfLeadScoreBreakdown(value) {
+    return true;
+}
+function LeadScoreBreakdownFromJSON(json) {
+    return LeadScoreBreakdownFromJSONTyped(json, false);
+}
+function LeadScoreBreakdownFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'brandSupportiveness': json['brandSupportiveness'] == null ? undefined : json['brandSupportiveness'],
+        'engagementLevel': json['engagementLevel'] == null ? undefined : json['engagementLevel'],
+        'profileFit': json['profileFit'] == null ? undefined : json['profileFit'],
+        'recurringInterest': json['recurringInterest'] == null ? undefined : json['recurringInterest'],
+        'technologicalAptitude': json['technologicalAptitude'] == null ? undefined : json['technologicalAptitude'],
+    };
+}
+function LeadScoreBreakdownToJSON(json) {
+    return LeadScoreBreakdownToJSONTyped(json, false);
+}
+function LeadScoreBreakdownToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'brandSupportiveness': value['brandSupportiveness'],
+        'engagementLevel': value['engagementLevel'],
+        'profileFit': value['profileFit'],
+        'recurringInterest': value['recurringInterest'],
+        'technologicalAptitude': value['technologicalAptitude'],
+    };
+}

package/dist/models/Link.d.ts

@@ -0,0 +1,182 @@
+/**
+ * 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 { CustomDomain } from './CustomDomain';
+import type { QrcodeDesign } from './QrcodeDesign';
+import type { ApiTag } from './ApiTag';
+import type { PageTheme } from './PageTheme';
+/**
+ * Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata,
+ * letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.
+ * @export
+ * @interface Link
+ */
+export interface Link {
+    /**
+     * When the link was created.
+     * @type {Date}
+     * @memberof Link
+     */
+    readonly createdAt?: Date;
+    /**
+     * The custom domain that is used to access the link.
+     * Use the include parameter when available to include the custom domain in the response.
+     * @type {CustomDomain}
+     * @memberof Link
+     */
+    customDomain?: CustomDomain;
+    /**
+     * The ID of the custom domain (UUID).
+     * This is the custom domain that is used to access the link.
+     * If not defined, the link will be accessed using the default domain.
+     * @type {string}
+     * @memberof Link
+     */
+    customDomainId?: string;
+    /**
+     * The entrypoint URL
+     * This is the URL that is available to be redirected to the destination.
+     * @type {string}
+     * @memberof Link
+     */
+    readonly entrypoint?: string;
+    /**
+     * The number of time the link has been scanned.
+     * This number isn't refreshed instantly but will update itself within a few seconds.
+     * @type {string}
+     * @memberof Link
+     */
+    readonly eventCount?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Link
+     */
+    fallbackDestination?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Link
+     */
+    id?: string;
+    /**
+     * The lead goal definition for the link.
+     * This is a text field that can be used to describe the lead goal or purpose of the link.
+     * @type {string}
+     * @memberof Link
+     */
+    leadGoalDefinition?: string;
+    /**
+     * The lead target definition for the link.
+     * This is a text field that can be used to describe the target lead criteria for the link.
+     * @type {string}
+     * @memberof Link
+     */
+    leadTargetDefinition?: string;
+    /**
+     * A map of string key-value pairs. All values must be strings. Nested objects or arrays are not supported. Maximum of 50 keys.
+     * @type {{ [key: string]: string; }}
+     * @memberof Link
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof Link
+     */
+    name?: string;
+    /**
+     * The page theme configuration for this link.
+     * Use the include parameter with "pageTheme" to include page theme data in the response.
+     * @type {PageTheme}
+     * @memberof Link
+     */
+    pageTheme?: PageTheme;
+    /**
+     * The ID of the page theme for this link (UUID).
+     * @type {string}
+     * @memberof Link
+     */
+    pageThemeId?: string;
+    /**
+     * The custom domain that is used to access the link.
+     * Use the include parameter when available to include the custom domain in the response.
+     * @type {QrcodeDesign}
+     * @memberof Link
+     */
+    qrcodeDesign?: QrcodeDesign;
+    /**
+     * The ID of the link design (UUID).
+     * This is the ID of the design that is used to generate the QR Code.
+     * If not defined, the design from the QR Code template will be used.
+     * @type {string}
+     * @memberof Link
+     */
+    qrcodeDesignId?: string;
+    /**
+     * When the link is pending QR Code update.
+     * This happens when the QR Code Design is updated and the QR Code image is still being processed.
+     * @type {Date}
+     * @memberof Link
+     */
+    readonly qrcodePendingUpdateSince?: Date;
+    /**
+     * The signed URL for the QR Code image.
+     * This URL eventually expires.
+     * @type {string}
+     * @memberof Link
+     */
+    readonly qrcodeSignedUrl?: string;
+    /**
+     * The ID of the design template (UUID).
+     * This is the template that is used to generate the first QR Code Design assigned to the link.
+     * If not defined, a default QR Code Design will be generated.
+     * @type {string}
+     * @memberof Link
+     */
+    qrcodeTemplateId?: string;
+    /**
+     * The short link for the link.
+     * This is the path segment that is attached to the URL. It can be defined by the client or generated by the system but is never null.
+     * It is unique within a custom domain or Linkbreakers default domain.
+     * @type {string}
+     * @memberof Link
+     */
+    shortlink?: string;
+    /**
+     * The tags associated with the link.
+     * @type {Array<ApiTag>}
+     * @memberof Link
+     */
+    tags?: Array<ApiTag>;
+    /**
+     * When the link was last updated.
+     * @type {Date}
+     * @memberof Link
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof Link
+     */
+    workspaceId?: string;
+}
+/**
+ * Check if a given object implements the Link interface.
+ */
+export declare function instanceOfLink(value: object): value is Link;
+export declare function LinkFromJSON(json: any): Link;
+export declare function LinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): Link;
+export declare function LinkToJSON(json: any): Link;
+export declare function LinkToJSONTyped(value?: Omit<Link, 'createdAt' | 'entrypoint' | 'eventCount' | 'qrcodePendingUpdateSince' | 'qrcodeSignedUrl' | 'updatedAt'> | null, ignoreDiscriminator?: boolean): any;