/** * 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 { VCardData } from './VCardData'; /** * Request to create a new contact card link. * @export * @interface CreateContactLinkRequest */ export interface CreateContactLinkRequest { /** * Optional custom domain ID (UUID). Leave empty to use the default domain. * Only provide if the user explicitly asks for a specific custom domain. * @type {string} * @memberof CreateContactLinkRequest */ customDomainId?: string; /** * Directory to organize this link into. If empty, link is created at root level. * @type {string} * @memberof CreateContactLinkRequest */ directoryId?: string; /** * Optional fallback URL if vCard download fails or is not supported. * @type {string} * @memberof CreateContactLinkRequest */ fallbackDestination?: string; /** * Optional pre-generated link ID (UUID). * The create wizard generates the id up front and navigates to it, so the * link has to be created with that id or the page waits on a link that never * arrives. Skipped from the AI tool schema for the same reason as on * CreateLinkRequest: on a create there is nothing to alias, and exposing it * only invites the model to invent a UUID. * @type {string} * @memberof CreateContactLinkRequest */ 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 CreateContactLinkRequest */ metadata?: { [key: string]: string; }; /** * * @type {string} * @memberof CreateContactLinkRequest */ name?: string; /** * What the user is trying to achieve with this link, in one or two sentences. * Lead scoring weights the link from this, and the link's assistant * conversations read it as context, so it is restated whenever the workflow * changes shape. * @type {string} * @memberof CreateContactLinkRequest */ purpose?: string; /** * The QR Code design ID (UUID). * If you include this value, the specified design will be associated to this link only. * A design can belong to one record at a time (Link or QR Code Template). * Trying to use a design that's already assigned will cause an error. * @type {string} * @memberof CreateContactLinkRequest */ qrcodeDesignId?: string; /** * The ID of the QR Code template (UUID) * If not given, the default QR Code template will be used to generate the QR Code design. * @type {string} * @memberof CreateContactLinkRequest */ qrcodeTemplateId?: string; /** * The shortlink for the link * If not given, the shortlink will be generated by the system. * @type {string} * @memberof CreateContactLinkRequest */ shortlink?: string; /** * List of tags to associate with the link. If a tag doesn't exist, it will be created. * @type {Array} * @memberof CreateContactLinkRequest */ tags?: Array; /** * Contact information for the vCard link. This field is required. * @type {VCardData} * @memberof CreateContactLinkRequest */ vcardData: VCardData; /** * Wait for QR code generation to complete. Note: This makes the request slower compared to asynchronous generation. * @type {boolean} * @memberof CreateContactLinkRequest */ waitForQrcode?: boolean; } /** * Check if a given object implements the CreateContactLinkRequest interface. */ export declare function instanceOfCreateContactLinkRequest(value: object): value is CreateContactLinkRequest; export declare function CreateContactLinkRequestFromJSON(json: any): CreateContactLinkRequest; export declare function CreateContactLinkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateContactLinkRequest; export declare function CreateContactLinkRequestToJSON(json: any): CreateContactLinkRequest; export declare function CreateContactLinkRequestToJSONTyped(value?: CreateContactLinkRequest | null, ignoreDiscriminator?: boolean): any;