/** * 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'; /** * UpdateQrcodeDesignRequest updates colors, shapes, and media used when regenerating QR assets. * @export * @interface QrcodeDesignServiceUpdateBody */ export interface QrcodeDesignServiceUpdateBody { /** * * @type {BackgroundOptions} * @memberof QrcodeDesignServiceUpdateBody */ 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 QrcodeDesignServiceUpdateBody */ centralImageData?: string; /** * Set this to true to delete the central image. It can't be used at the same time as transmitting a central image. * @type {boolean} * @memberof QrcodeDesignServiceUpdateBody */ centralImageDelete?: boolean; /** * * @type {number} * @memberof QrcodeDesignServiceUpdateBody */ centralImageMargin?: number; /** * * @type {number} * @memberof QrcodeDesignServiceUpdateBody */ centralImageSize?: number; /** * * @type {CornersDotOptions} * @memberof QrcodeDesignServiceUpdateBody */ cornersDotOptions?: CornersDotOptions; /** * * @type {CornersSquareOptions} * @memberof QrcodeDesignServiceUpdateBody */ cornersSquareOptions?: CornersSquareOptions; /** * * @type {DotsOptions} * @memberof QrcodeDesignServiceUpdateBody */ dotsOptions?: DotsOptions; /** * * @type {string} * @memberof QrcodeDesignServiceUpdateBody */ errorCorrectionLevel?: string; /** * * @type {number} * @memberof QrcodeDesignServiceUpdateBody */ height?: number; /** * * @type {boolean} * @memberof QrcodeDesignServiceUpdateBody */ 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 {QrcodeDesignServiceUpdateBodyOutputFileFormatEnum} * @memberof QrcodeDesignServiceUpdateBody */ outputFileFormat?: QrcodeDesignServiceUpdateBodyOutputFileFormatEnum; /** * - 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 {QrcodeDesignServiceUpdateBodyShapeEnum} * @memberof QrcodeDesignServiceUpdateBody */ shape?: QrcodeDesignServiceUpdateBodyShapeEnum; /** * * @type {number} * @memberof QrcodeDesignServiceUpdateBody */ width?: number; } /** * @export */ export declare const QrcodeDesignServiceUpdateBodyOutputFileFormatEnum: { 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 QrcodeDesignServiceUpdateBodyOutputFileFormatEnum = typeof QrcodeDesignServiceUpdateBodyOutputFileFormatEnum[keyof typeof QrcodeDesignServiceUpdateBodyOutputFileFormatEnum]; /** * @export */ export declare const QrcodeDesignServiceUpdateBodyShapeEnum: { readonly ShapeUnspecified: "SHAPE_UNSPECIFIED"; readonly ShapeSquare: "SHAPE_SQUARE"; readonly ShapeCircle: "SHAPE_CIRCLE"; }; export type QrcodeDesignServiceUpdateBodyShapeEnum = typeof QrcodeDesignServiceUpdateBodyShapeEnum[keyof typeof QrcodeDesignServiceUpdateBodyShapeEnum]; /** * Check if a given object implements the QrcodeDesignServiceUpdateBody interface. */ export declare function instanceOfQrcodeDesignServiceUpdateBody(value: object): value is QrcodeDesignServiceUpdateBody; export declare function QrcodeDesignServiceUpdateBodyFromJSON(json: any): QrcodeDesignServiceUpdateBody; export declare function QrcodeDesignServiceUpdateBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): QrcodeDesignServiceUpdateBody; export declare function QrcodeDesignServiceUpdateBodyToJSON(json: any): QrcodeDesignServiceUpdateBody; export declare function QrcodeDesignServiceUpdateBodyToJSONTyped(value?: QrcodeDesignServiceUpdateBody | null, ignoreDiscriminator?: boolean): any;