/** * 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'; /** * PublicCreateQrcodeDesignRequest provisions a new reusable QR code styling preset. * @export * @interface PublicCreateQrcodeDesignRequest */ export interface PublicCreateQrcodeDesignRequest { /** * * @type {BackgroundOptions} * @memberof PublicCreateQrcodeDesignRequest */ backgroundOptions?: BackgroundOptions; /** * The image to use as the central image of the QR Code. The file size limit is 3MB. It must be transmitted in a base64 string format when sending it through HTTP. * @type {string} * @memberof PublicCreateQrcodeDesignRequest */ centralImageData?: string; /** * * @type {number} * @memberof PublicCreateQrcodeDesignRequest */ centralImageMargin?: number; /** * * @type {number} * @memberof PublicCreateQrcodeDesignRequest */ centralImageSize?: number; /** * * @type {CornersDotOptions} * @memberof PublicCreateQrcodeDesignRequest */ cornersDotOptions?: CornersDotOptions; /** * * @type {CornersSquareOptions} * @memberof PublicCreateQrcodeDesignRequest */ cornersSquareOptions?: CornersSquareOptions; /** * * @type {DotsOptions} * @memberof PublicCreateQrcodeDesignRequest */ dotsOptions?: DotsOptions; /** * * @type {string} * @memberof PublicCreateQrcodeDesignRequest */ errorCorrectionLevel?: string; /** * * @type {number} * @memberof PublicCreateQrcodeDesignRequest */ height?: number; /** * * @type {boolean} * @memberof PublicCreateQrcodeDesignRequest */ hideBackgroundDots?: boolean; /** * - 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 {PublicCreateQrcodeDesignRequestOutputFileFormatEnum} * @memberof PublicCreateQrcodeDesignRequest */ outputFileFormat?: PublicCreateQrcodeDesignRequestOutputFileFormatEnum; /** * - 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 {PublicCreateQrcodeDesignRequestShapeEnum} * @memberof PublicCreateQrcodeDesignRequest */ shape?: PublicCreateQrcodeDesignRequestShapeEnum; /** * * @type {number} * @memberof PublicCreateQrcodeDesignRequest */ width?: number; } /** * @export */ export declare const PublicCreateQrcodeDesignRequestOutputFileFormatEnum: { 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 PublicCreateQrcodeDesignRequestOutputFileFormatEnum = typeof PublicCreateQrcodeDesignRequestOutputFileFormatEnum[keyof typeof PublicCreateQrcodeDesignRequestOutputFileFormatEnum]; /** * @export */ export declare const PublicCreateQrcodeDesignRequestShapeEnum: { readonly ShapeUnspecified: "SHAPE_UNSPECIFIED"; readonly ShapeSquare: "SHAPE_SQUARE"; readonly ShapeCircle: "SHAPE_CIRCLE"; }; export type PublicCreateQrcodeDesignRequestShapeEnum = typeof PublicCreateQrcodeDesignRequestShapeEnum[keyof typeof PublicCreateQrcodeDesignRequestShapeEnum]; /** * Check if a given object implements the PublicCreateQrcodeDesignRequest interface. */ export declare function instanceOfPublicCreateQrcodeDesignRequest(value: object): value is PublicCreateQrcodeDesignRequest; export declare function PublicCreateQrcodeDesignRequestFromJSON(json: any): PublicCreateQrcodeDesignRequest; export declare function PublicCreateQrcodeDesignRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicCreateQrcodeDesignRequest; export declare function PublicCreateQrcodeDesignRequestToJSON(json: any): PublicCreateQrcodeDesignRequest; export declare function PublicCreateQrcodeDesignRequestToJSONTyped(value?: PublicCreateQrcodeDesignRequest | null, ignoreDiscriminator?: boolean): any;