/** * 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 { CornersSquareOptions } from './CornersSquareOptions'; import type { DotsOptions } from './DotsOptions'; import type { CornersDotOptions } from './CornersDotOptions'; import type { BackgroundOptions } from './BackgroundOptions'; /** * Captures the visual recipe Linkbreakers uses when rendering downloadable QR codes, including colors, shapes, * export options, and center media. * * QR Code Designs are the visual representation of a link. * They can be attached to QR Code Templates for reusability. * They can only be attached to one record at a time. * @export * @interface QrcodeDesign */ export interface QrcodeDesign { /** * * @type {BackgroundOptions} * @memberof QrcodeDesign */ backgroundOptions?: BackgroundOptions; /** * * @type {number} * @memberof QrcodeDesign */ centralImageMargin?: number; /** * * @type {string} * @memberof QrcodeDesign */ readonly centralImageSignedUrl?: string; /** * * @type {number} * @memberof QrcodeDesign */ centralImageSize?: number; /** * * @type {CornersDotOptions} * @memberof QrcodeDesign */ cornersDotOptions?: CornersDotOptions; /** * * @type {CornersSquareOptions} * @memberof QrcodeDesign */ cornersSquareOptions?: CornersSquareOptions; /** * * @type {Date} * @memberof QrcodeDesign */ readonly createdAt?: Date; /** * * @type {DotsOptions} * @memberof QrcodeDesign */ dotsOptions?: DotsOptions; /** * * @type {string} * @memberof QrcodeDesign */ errorCorrectionLevel?: string; /** * * @type {number} * @memberof QrcodeDesign */ height?: number; /** * * @type {boolean} * @memberof QrcodeDesign */ hideBackgroundDots?: boolean; /** * * @type {string} * @memberof QrcodeDesign */ id?: string; /** * - OUTPUT_FILE_FORMAT_UNSPECIFIED: Output format not specified (defaults to PNG server-side) * - OUTPUT_FILE_FORMAT_SVG: Scalable Vector Graphics format for infinite resolution * - OUTPUT_FILE_FORMAT_PNG: Portable Network Graphics format with transparency support * - OUTPUT_FILE_FORMAT_JPEG: Joint Photographic Experts Group format for compressed images * - OUTPUT_FILE_FORMAT_WEBP: WebP format for modern web-optimized compression * @type {QrcodeDesignOutputFileFormatEnum} * @memberof QrcodeDesign */ outputFileFormat?: QrcodeDesignOutputFileFormatEnum; /** * - SHAPE_UNSPECIFIED: Shape not specified (defaults to square modules) * - SHAPE_SQUARE: Traditional square modules for QR code data points * - SHAPE_CIRCLE: Circular modules for a rounded visual appearance * @type {QrcodeDesignShapeEnum} * @memberof QrcodeDesign */ shape?: QrcodeDesignShapeEnum; /** * * @type {Date} * @memberof QrcodeDesign */ readonly updatedAt?: Date; /** * * @type {number} * @memberof QrcodeDesign */ width?: number; } /** * @export */ export declare const QrcodeDesignOutputFileFormatEnum: { readonly OutputFileFormatUnspecified: "OUTPUT_FILE_FORMAT_UNSPECIFIED"; readonly OutputFileFormatSvg: "OUTPUT_FILE_FORMAT_SVG"; readonly OutputFileFormatPng: "OUTPUT_FILE_FORMAT_PNG"; readonly OutputFileFormatJpeg: "OUTPUT_FILE_FORMAT_JPEG"; readonly OutputFileFormatWebp: "OUTPUT_FILE_FORMAT_WEBP"; }; export type QrcodeDesignOutputFileFormatEnum = typeof QrcodeDesignOutputFileFormatEnum[keyof typeof QrcodeDesignOutputFileFormatEnum]; /** * @export */ export declare const QrcodeDesignShapeEnum: { readonly ShapeUnspecified: "SHAPE_UNSPECIFIED"; readonly ShapeSquare: "SHAPE_SQUARE"; readonly ShapeCircle: "SHAPE_CIRCLE"; }; export type QrcodeDesignShapeEnum = typeof QrcodeDesignShapeEnum[keyof typeof QrcodeDesignShapeEnum]; /** * Check if a given object implements the QrcodeDesign interface. */ export declare function instanceOfQrcodeDesign(value: object): value is QrcodeDesign; export declare function QrcodeDesignFromJSON(json: any): QrcodeDesign; export declare function QrcodeDesignFromJSONTyped(json: any, ignoreDiscriminator: boolean): QrcodeDesign; export declare function QrcodeDesignToJSON(json: any): QrcodeDesign; export declare function QrcodeDesignToJSONTyped(value?: Omit | null, ignoreDiscriminator?: boolean): any;