/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * 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 ID of the directory this link belongs to (UUID). * If not set, the link is at the root level (not in any directory). * @type {string} * @memberof Link */ directoryId?: 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; /** * 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; /** * What the user is trying to achieve with this link, in one or two sentences. * @type {string} * @memberof Link */ purpose?: 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} * @memberof Link */ tags?: Array; /** * 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 | null, ignoreDiscriminator?: boolean): any;