From a3443293b454db3afcc0d6e0bdbcfe4bc3c5b214 Mon Sep 17 00:00:00 2001 From: Ivan Kamkin Date: Thu, 25 Jun 2026 00:22:24 +0500 Subject: [PATCH] Code regenerate with new templates. Build and tests fixed. --- Examples/GenerateAndScan/main.swift | 12 +- README.md | 12 +- .../AsposeBarcodeCloud/APIs/GenerateAPI.swift | 228 +++++++++--------- .../APIs/RecognizeAPI.swift | 18 +- .../AsposeBarcodeCloud/Models/ApiError.swift | 1 + .../Models/ApiErrorResponse.swift | 1 + .../Models/BarcodeImageParams.swift | 3 + .../Models/Code128Params.swift | 1 + .../Models/EncodeData.swift | 1 + .../Models/GenerateParams.swift | 6 + .../Models/Pdf417Params.swift | 4 + .../AsposeBarcodeCloud/Models/QrParams.swift | 6 + .../Models/RecognizeBase64Request.swift | 2 + .../AsposeBarcodeCloudTests.swift | 4 +- .../RequestBuilderTests.swift | 6 +- docs/ApiError.md | 2 +- docs/ApiErrorResponse.md | 2 +- docs/BarcodeImageParams.md | 6 +- docs/Code128Params.md | 2 +- docs/EncodeData.md | 2 +- docs/GenerateAPI.md | 64 ++--- docs/GenerateParams.md | 12 +- docs/Pdf417Params.md | 8 +- docs/QrParams.md | 12 +- docs/RecognizeAPI.md | 12 +- docs/RecognizeBase64Request.md | 4 +- 26 files changed, 229 insertions(+), 202 deletions(-) diff --git a/Examples/GenerateAndScan/main.swift b/Examples/GenerateAndScan/main.swift index 20d85e3..6768551 100644 --- a/Examples/GenerateAndScan/main.swift +++ b/Examples/GenerateAndScan/main.swift @@ -137,11 +137,13 @@ print("Generating QR barcode...") let imageData = try await GenerateAPI.generate( barcodeType: .qr, data: barcodeValue, - imageFormat: .png, - qrEncodeMode: .auto, - qrErrorLevel: .levelM, - qrVersion: .auto, - qrAspectRatio: 0.75, + barcodeImageParams: BarcodeImageParams(imageFormat: .png), + qrParams: QrParams( + qrEncodeMode: .auto, + qrErrorLevel: .levelM, + qrVersion: .auto, + qrAspectRatio: 0.75 + ), apiConfiguration: client.apiConfiguration ) try imageData.write(to: URL(fileURLWithPath: "QR.png")) diff --git a/README.md b/README.md index 21a8f05..5c85ca1 100644 --- a/README.md +++ b/README.md @@ -248,11 +248,13 @@ print("Generating QR barcode...") let imageData = try await GenerateAPI.generate( barcodeType: .qr, data: barcodeValue, - imageFormat: .png, - qrEncodeMode: .auto, - qrErrorLevel: .levelM, - qrVersion: .auto, - qrAspectRatio: 0.75, + barcodeImageParams: BarcodeImageParams(imageFormat: .png), + qrParams: QrParams( + qrEncodeMode: .auto, + qrErrorLevel: .levelM, + qrVersion: .auto, + qrAspectRatio: 0.75 + ), apiConfiguration: client.apiConfiguration ) try imageData.write(to: URL(fileURLWithPath: "QR.png")) diff --git a/Sources/AsposeBarcodeCloud/APIs/GenerateAPI.swift b/Sources/AsposeBarcodeCloud/APIs/GenerateAPI.swift index 8885eba..f85d2bb 100644 --- a/Sources/AsposeBarcodeCloud/APIs/GenerateAPI.swift +++ b/Sources/AsposeBarcodeCloud/APIs/GenerateAPI.swift @@ -46,8 +46,8 @@ open class GenerateAPI { - parameter completion: completion handler to receive the data and the error objects */ @discardableResult - open class func generate(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, imageFormat: BarcodeImageFormat? = nil, textLocation: CodeLocation? = nil, foregroundColor: String? = nil, backgroundColor: String? = nil, units: GraphicsUnit? = nil, resolution: Float? = nil, imageHeight: Float? = nil, imageWidth: Float? = nil, rotationAngle: Int? = nil, qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil, code128EncodeMode: Code128EncodeMode? = nil, pdf417EncodeMode: Pdf417EncodeMode? = nil, pdf417ErrorLevel: Pdf417ErrorLevel? = nil, pdf417Truncate: Bool? = nil, pdf417Columns: Int? = nil, pdf417Rows: Int? = nil, pdf417AspectRatio: Float? = nil, pdf417ECIEncoding: ECIEncodings? = nil, pdf417IsReaderInitialization: Bool? = nil, pdf417MacroCharacters: MacroCharacter? = nil, pdf417IsLinked: Bool? = nil, pdf417IsCode128Emulation: Bool? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared, completion: @Sendable @escaping (_ data: Data?, _ error: Error?) -> Void) -> RequestTask { - generateWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, imageFormat: imageFormat, textLocation: textLocation, foregroundColor: foregroundColor, backgroundColor: backgroundColor, units: units, resolution: resolution, imageHeight: imageHeight, imageWidth: imageWidth, rotationAngle: rotationAngle, qrEncodeMode: qrEncodeMode, qrErrorLevel: qrErrorLevel, qrVersion: qrVersion, qrECIEncoding: qrECIEncoding, qrAspectRatio: qrAspectRatio, microQRVersion: microQRVersion, rectMicroQrVersion: rectMicroQrVersion, code128EncodeMode: code128EncodeMode, pdf417EncodeMode: pdf417EncodeMode, pdf417ErrorLevel: pdf417ErrorLevel, pdf417Truncate: pdf417Truncate, pdf417Columns: pdf417Columns, pdf417Rows: pdf417Rows, pdf417AspectRatio: pdf417AspectRatio, pdf417ECIEncoding: pdf417ECIEncoding, pdf417IsReaderInitialization: pdf417IsReaderInitialization, pdf417MacroCharacters: pdf417MacroCharacters, pdf417IsLinked: pdf417IsLinked, pdf417IsCode128Emulation: pdf417IsCode128Emulation, apiConfiguration: apiConfiguration).execute { result in + open class func generate(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared, completion: @Sendable @escaping (_ data: Data?, _ error: Error?) -> Void) -> RequestTask { + generateWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, barcodeImageParams: barcodeImageParams, qrParams: qrParams, code128Params: code128Params, pdf417Params: pdf417Params, apiConfiguration: apiConfiguration).execute { result in switch result { case let .success(response): completion(response.body, nil) @@ -94,8 +94,8 @@ open class GenerateAPI { - parameter apiConfiguration: The configuration for the http request. - returns: Data */ - open class func generate(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, imageFormat: BarcodeImageFormat? = nil, textLocation: CodeLocation? = nil, foregroundColor: String? = nil, backgroundColor: String? = nil, units: GraphicsUnit? = nil, resolution: Float? = nil, imageHeight: Float? = nil, imageWidth: Float? = nil, rotationAngle: Int? = nil, qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil, code128EncodeMode: Code128EncodeMode? = nil, pdf417EncodeMode: Pdf417EncodeMode? = nil, pdf417ErrorLevel: Pdf417ErrorLevel? = nil, pdf417Truncate: Bool? = nil, pdf417Columns: Int? = nil, pdf417Rows: Int? = nil, pdf417AspectRatio: Float? = nil, pdf417ECIEncoding: ECIEncodings? = nil, pdf417IsReaderInitialization: Bool? = nil, pdf417MacroCharacters: MacroCharacter? = nil, pdf417IsLinked: Bool? = nil, pdf417IsCode128Emulation: Bool? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) async throws(ErrorResponse) -> Data { - try await generateWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, imageFormat: imageFormat, textLocation: textLocation, foregroundColor: foregroundColor, backgroundColor: backgroundColor, units: units, resolution: resolution, imageHeight: imageHeight, imageWidth: imageWidth, rotationAngle: rotationAngle, qrEncodeMode: qrEncodeMode, qrErrorLevel: qrErrorLevel, qrVersion: qrVersion, qrECIEncoding: qrECIEncoding, qrAspectRatio: qrAspectRatio, microQRVersion: microQRVersion, rectMicroQrVersion: rectMicroQrVersion, code128EncodeMode: code128EncodeMode, pdf417EncodeMode: pdf417EncodeMode, pdf417ErrorLevel: pdf417ErrorLevel, pdf417Truncate: pdf417Truncate, pdf417Columns: pdf417Columns, pdf417Rows: pdf417Rows, pdf417AspectRatio: pdf417AspectRatio, pdf417ECIEncoding: pdf417ECIEncoding, pdf417IsReaderInitialization: pdf417IsReaderInitialization, pdf417MacroCharacters: pdf417MacroCharacters, pdf417IsLinked: pdf417IsLinked, pdf417IsCode128Emulation: pdf417IsCode128Emulation, apiConfiguration: apiConfiguration).execute().body + open class func generate(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) async throws(ErrorResponse) -> Data { + try await generateWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, barcodeImageParams: barcodeImageParams, qrParams: qrParams, code128Params: code128Params, pdf417Params: pdf417Params, apiConfiguration: apiConfiguration).execute().body } /** @@ -138,7 +138,7 @@ open class GenerateAPI { - parameter apiConfiguration: The configuration for the http request. - returns: RequestBuilder */ - open class func generateWithRequestBuilder(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, imageFormat: BarcodeImageFormat? = nil, textLocation: CodeLocation? = nil, foregroundColor: String? = nil, backgroundColor: String? = nil, units: GraphicsUnit? = nil, resolution: Float? = nil, imageHeight: Float? = nil, imageWidth: Float? = nil, rotationAngle: Int? = nil, qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil, code128EncodeMode: Code128EncodeMode? = nil, pdf417EncodeMode: Pdf417EncodeMode? = nil, pdf417ErrorLevel: Pdf417ErrorLevel? = nil, pdf417Truncate: Bool? = nil, pdf417Columns: Int? = nil, pdf417Rows: Int? = nil, pdf417AspectRatio: Float? = nil, pdf417ECIEncoding: ECIEncodings? = nil, pdf417IsReaderInitialization: Bool? = nil, pdf417MacroCharacters: MacroCharacter? = nil, pdf417IsLinked: Bool? = nil, pdf417IsCode128Emulation: Bool? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) -> RequestBuilder { + open class func generateWithRequestBuilder(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) -> RequestBuilder { var localVariablePath = "/barcode/generate/{barcodeType}" let barcodeTypePreEscape = "\(APIHelper.mapValueToPathItem(barcodeType))" let barcodeTypePostEscape = barcodeTypePreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" @@ -150,34 +150,34 @@ open class GenerateAPI { localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([ "dataType": (wrappedValue: dataType?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), "data": (wrappedValue: data.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "imageFormat": (wrappedValue: imageFormat?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "textLocation": (wrappedValue: textLocation?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "foregroundColor": (wrappedValue: foregroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "backgroundColor": (wrappedValue: backgroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "units": (wrappedValue: units?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "resolution": (wrappedValue: resolution?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "imageHeight": (wrappedValue: imageHeight?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "imageWidth": (wrappedValue: imageWidth?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "rotationAngle": (wrappedValue: rotationAngle?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "qrEncodeMode": (wrappedValue: qrEncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "qrErrorLevel": (wrappedValue: qrErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "qrVersion": (wrappedValue: qrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "qrECIEncoding": (wrappedValue: qrECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "qrAspectRatio": (wrappedValue: qrAspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "microQRVersion": (wrappedValue: microQRVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "rectMicroQrVersion": (wrappedValue: rectMicroQrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "code128EncodeMode": (wrappedValue: code128EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417EncodeMode": (wrappedValue: pdf417EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417ErrorLevel": (wrappedValue: pdf417ErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417Truncate": (wrappedValue: pdf417Truncate?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417Columns": (wrappedValue: pdf417Columns?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417Rows": (wrappedValue: pdf417Rows?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417AspectRatio": (wrappedValue: pdf417AspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417ECIEncoding": (wrappedValue: pdf417ECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417IsReaderInitialization": (wrappedValue: pdf417IsReaderInitialization?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417MacroCharacters": (wrappedValue: pdf417MacroCharacters?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417IsLinked": (wrappedValue: pdf417IsLinked?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), - "pdf417IsCode128Emulation": (wrappedValue: pdf417IsCode128Emulation?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "imageFormat": (wrappedValue: barcodeImageParams?.imageFormat?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "textLocation": (wrappedValue: barcodeImageParams?.textLocation?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "foregroundColor": (wrappedValue: barcodeImageParams?.foregroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "backgroundColor": (wrappedValue: barcodeImageParams?.backgroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "units": (wrappedValue: barcodeImageParams?.units?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "resolution": (wrappedValue: barcodeImageParams?.resolution?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "imageHeight": (wrappedValue: barcodeImageParams?.imageHeight?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "imageWidth": (wrappedValue: barcodeImageParams?.imageWidth?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "rotationAngle": (wrappedValue: barcodeImageParams?.rotationAngle?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "qrEncodeMode": (wrappedValue: qrParams?.qrEncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "qrErrorLevel": (wrappedValue: qrParams?.qrErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "qrVersion": (wrappedValue: qrParams?.qrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "qrECIEncoding": (wrappedValue: qrParams?.qrECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "qrAspectRatio": (wrappedValue: qrParams?.qrAspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "microQRVersion": (wrappedValue: qrParams?.microQRVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "rectMicroQrVersion": (wrappedValue: qrParams?.rectMicroQrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "code128EncodeMode": (wrappedValue: code128Params?.code128EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417EncodeMode": (wrappedValue: pdf417Params?.pdf417EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417ErrorLevel": (wrappedValue: pdf417Params?.pdf417ErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417Truncate": (wrappedValue: pdf417Params?.pdf417Truncate?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417Columns": (wrappedValue: pdf417Params?.pdf417Columns?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417Rows": (wrappedValue: pdf417Params?.pdf417Rows?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417AspectRatio": (wrappedValue: pdf417Params?.pdf417AspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417ECIEncoding": (wrappedValue: pdf417Params?.pdf417ECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417IsReaderInitialization": (wrappedValue: pdf417Params?.pdf417IsReaderInitialization?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417MacroCharacters": (wrappedValue: pdf417Params?.pdf417MacroCharacters?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417IsLinked": (wrappedValue: pdf417Params?.pdf417IsLinked?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), + "pdf417IsCode128Emulation": (wrappedValue: pdf417Params?.pdf417IsCode128Emulation?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true), ]) let localVariableNillableHeaders: [String: (any Sendable)?] = [:] @@ -250,43 +250,43 @@ open class GenerateAPI { /** Generate a barcode using a POST request with parameters in a multipart form. - - parameter barcodeType: (form) + - parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ - parameter data: (form) String that represents the data to encode. - - parameter dataType: (form) (optional) - - parameter imageFormat: (form) (optional) - - parameter textLocation: (form) (optional) + - parameter dataType: (form) Type of data to encode. Default value: StringData. (optional) + - parameter imageFormat: (form) Barcode output image format. Default value: png. (optional) + - parameter textLocation: (form) Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. (optional) - parameter foregroundColor: (form) Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. (optional, default to "Black") - parameter backgroundColor: (form) Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. (optional, default to "White") - - parameter units: (form) (optional) + - parameter units: (form) Common units for all measurements. Default units: pixels. (optional) - parameter resolution: (form) Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) - parameter imageHeight: (form) Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) - parameter imageWidth: (form) Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) - parameter rotationAngle: (form) Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. (optional) - - parameter qrEncodeMode: (form) (optional) - - parameter qrErrorLevel: (form) (optional) - - parameter qrVersion: (form) (optional) - - parameter qrECIEncoding: (form) (optional) + - parameter qrEncodeMode: (form) QR barcode encode mode. (optional) + - parameter qrErrorLevel: (form) QR barcode error correction level. (optional) + - parameter qrVersion: (form) QR barcode version. Automatically selects the smallest version that fits the data. (optional) + - parameter qrECIEncoding: (form) ECI encoding for QR barcode data. (optional) - parameter qrAspectRatio: (form) QR barcode aspect ratio. Values: 0 to 1. (optional) - - parameter microQRVersion: (form) (optional) - - parameter rectMicroQrVersion: (form) (optional) - - parameter code128EncodeMode: (form) (optional) - - parameter pdf417EncodeMode: (form) (optional) - - parameter pdf417ErrorLevel: (form) (optional) + - parameter microQRVersion: (form) MicroQR barcode version. Used when BarcodeType is MicroQR. (optional) + - parameter rectMicroQrVersion: (form) RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional) + - parameter code128EncodeMode: (form) Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional) + - parameter pdf417EncodeMode: (form) PDF417 barcode encode mode. (optional) + - parameter pdf417ErrorLevel: (form) PDF417 barcode error correction level. (optional) - parameter pdf417Truncate: (form) Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) - parameter pdf417Columns: (form) Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) - parameter pdf417Rows: (form) Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) - parameter pdf417AspectRatio: (form) PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. (optional) - - parameter pdf417ECIEncoding: (form) (optional) + - parameter pdf417ECIEncoding: (form) ECI encoding for PDF417 barcode data. (optional) - parameter pdf417IsReaderInitialization: (form) Whether the barcode is used for reader initialization (programming). (optional) - - parameter pdf417MacroCharacters: (form) (optional) + - parameter pdf417MacroCharacters: (form) Macro character to prepend (structured append). (optional) - parameter pdf417IsLinked: (form) Whether to use linked mode (for MicroPdf417). (optional) - parameter pdf417IsCode128Emulation: (form) Whether to use Code128 emulation for MicroPdf417. (optional) - parameter apiConfiguration: The configuration for the http request. - parameter completion: completion handler to receive the data and the error objects */ @discardableResult - open class func generateMultipart(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, imageFormat: BarcodeImageFormat? = nil, textLocation: CodeLocation? = nil, foregroundColor: String? = nil, backgroundColor: String? = nil, units: GraphicsUnit? = nil, resolution: Float? = nil, imageHeight: Float? = nil, imageWidth: Float? = nil, rotationAngle: Int? = nil, qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil, code128EncodeMode: Code128EncodeMode? = nil, pdf417EncodeMode: Pdf417EncodeMode? = nil, pdf417ErrorLevel: Pdf417ErrorLevel? = nil, pdf417Truncate: Bool? = nil, pdf417Columns: Int? = nil, pdf417Rows: Int? = nil, pdf417AspectRatio: Float? = nil, pdf417ECIEncoding: ECIEncodings? = nil, pdf417IsReaderInitialization: Bool? = nil, pdf417MacroCharacters: MacroCharacter? = nil, pdf417IsLinked: Bool? = nil, pdf417IsCode128Emulation: Bool? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared, completion: @Sendable @escaping (_ data: Data?, _ error: Error?) -> Void) -> RequestTask { - generateMultipartWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, imageFormat: imageFormat, textLocation: textLocation, foregroundColor: foregroundColor, backgroundColor: backgroundColor, units: units, resolution: resolution, imageHeight: imageHeight, imageWidth: imageWidth, rotationAngle: rotationAngle, qrEncodeMode: qrEncodeMode, qrErrorLevel: qrErrorLevel, qrVersion: qrVersion, qrECIEncoding: qrECIEncoding, qrAspectRatio: qrAspectRatio, microQRVersion: microQRVersion, rectMicroQrVersion: rectMicroQrVersion, code128EncodeMode: code128EncodeMode, pdf417EncodeMode: pdf417EncodeMode, pdf417ErrorLevel: pdf417ErrorLevel, pdf417Truncate: pdf417Truncate, pdf417Columns: pdf417Columns, pdf417Rows: pdf417Rows, pdf417AspectRatio: pdf417AspectRatio, pdf417ECIEncoding: pdf417ECIEncoding, pdf417IsReaderInitialization: pdf417IsReaderInitialization, pdf417MacroCharacters: pdf417MacroCharacters, pdf417IsLinked: pdf417IsLinked, pdf417IsCode128Emulation: pdf417IsCode128Emulation, apiConfiguration: apiConfiguration).execute { result in + open class func generateMultipart(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared, completion: @Sendable @escaping (_ data: Data?, _ error: Error?) -> Void) -> RequestTask { + generateMultipartWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, barcodeImageParams: barcodeImageParams, qrParams: qrParams, code128Params: code128Params, pdf417Params: pdf417Params, apiConfiguration: apiConfiguration).execute { result in switch result { case let .success(response): completion(response.body, nil) @@ -299,42 +299,42 @@ open class GenerateAPI { /** Generate a barcode using a POST request with parameters in a multipart form. - - parameter barcodeType: (form) + - parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ - parameter data: (form) String that represents the data to encode. - - parameter dataType: (form) (optional) - - parameter imageFormat: (form) (optional) - - parameter textLocation: (form) (optional) + - parameter dataType: (form) Type of data to encode. Default value: StringData. (optional) + - parameter imageFormat: (form) Barcode output image format. Default value: png. (optional) + - parameter textLocation: (form) Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. (optional) - parameter foregroundColor: (form) Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. (optional, default to "Black") - parameter backgroundColor: (form) Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. (optional, default to "White") - - parameter units: (form) (optional) + - parameter units: (form) Common units for all measurements. Default units: pixels. (optional) - parameter resolution: (form) Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) - parameter imageHeight: (form) Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) - parameter imageWidth: (form) Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) - parameter rotationAngle: (form) Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. (optional) - - parameter qrEncodeMode: (form) (optional) - - parameter qrErrorLevel: (form) (optional) - - parameter qrVersion: (form) (optional) - - parameter qrECIEncoding: (form) (optional) + - parameter qrEncodeMode: (form) QR barcode encode mode. (optional) + - parameter qrErrorLevel: (form) QR barcode error correction level. (optional) + - parameter qrVersion: (form) QR barcode version. Automatically selects the smallest version that fits the data. (optional) + - parameter qrECIEncoding: (form) ECI encoding for QR barcode data. (optional) - parameter qrAspectRatio: (form) QR barcode aspect ratio. Values: 0 to 1. (optional) - - parameter microQRVersion: (form) (optional) - - parameter rectMicroQrVersion: (form) (optional) - - parameter code128EncodeMode: (form) (optional) - - parameter pdf417EncodeMode: (form) (optional) - - parameter pdf417ErrorLevel: (form) (optional) + - parameter microQRVersion: (form) MicroQR barcode version. Used when BarcodeType is MicroQR. (optional) + - parameter rectMicroQrVersion: (form) RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional) + - parameter code128EncodeMode: (form) Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional) + - parameter pdf417EncodeMode: (form) PDF417 barcode encode mode. (optional) + - parameter pdf417ErrorLevel: (form) PDF417 barcode error correction level. (optional) - parameter pdf417Truncate: (form) Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) - parameter pdf417Columns: (form) Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) - parameter pdf417Rows: (form) Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) - parameter pdf417AspectRatio: (form) PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. (optional) - - parameter pdf417ECIEncoding: (form) (optional) + - parameter pdf417ECIEncoding: (form) ECI encoding for PDF417 barcode data. (optional) - parameter pdf417IsReaderInitialization: (form) Whether the barcode is used for reader initialization (programming). (optional) - - parameter pdf417MacroCharacters: (form) (optional) + - parameter pdf417MacroCharacters: (form) Macro character to prepend (structured append). (optional) - parameter pdf417IsLinked: (form) Whether to use linked mode (for MicroPdf417). (optional) - parameter pdf417IsCode128Emulation: (form) Whether to use Code128 emulation for MicroPdf417. (optional) - parameter apiConfiguration: The configuration for the http request. - returns: Data */ - open class func generateMultipart(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, imageFormat: BarcodeImageFormat? = nil, textLocation: CodeLocation? = nil, foregroundColor: String? = nil, backgroundColor: String? = nil, units: GraphicsUnit? = nil, resolution: Float? = nil, imageHeight: Float? = nil, imageWidth: Float? = nil, rotationAngle: Int? = nil, qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil, code128EncodeMode: Code128EncodeMode? = nil, pdf417EncodeMode: Pdf417EncodeMode? = nil, pdf417ErrorLevel: Pdf417ErrorLevel? = nil, pdf417Truncate: Bool? = nil, pdf417Columns: Int? = nil, pdf417Rows: Int? = nil, pdf417AspectRatio: Float? = nil, pdf417ECIEncoding: ECIEncodings? = nil, pdf417IsReaderInitialization: Bool? = nil, pdf417MacroCharacters: MacroCharacter? = nil, pdf417IsLinked: Bool? = nil, pdf417IsCode128Emulation: Bool? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) async throws(ErrorResponse) -> Data { - try await generateMultipartWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, imageFormat: imageFormat, textLocation: textLocation, foregroundColor: foregroundColor, backgroundColor: backgroundColor, units: units, resolution: resolution, imageHeight: imageHeight, imageWidth: imageWidth, rotationAngle: rotationAngle, qrEncodeMode: qrEncodeMode, qrErrorLevel: qrErrorLevel, qrVersion: qrVersion, qrECIEncoding: qrECIEncoding, qrAspectRatio: qrAspectRatio, microQRVersion: microQRVersion, rectMicroQrVersion: rectMicroQrVersion, code128EncodeMode: code128EncodeMode, pdf417EncodeMode: pdf417EncodeMode, pdf417ErrorLevel: pdf417ErrorLevel, pdf417Truncate: pdf417Truncate, pdf417Columns: pdf417Columns, pdf417Rows: pdf417Rows, pdf417AspectRatio: pdf417AspectRatio, pdf417ECIEncoding: pdf417ECIEncoding, pdf417IsReaderInitialization: pdf417IsReaderInitialization, pdf417MacroCharacters: pdf417MacroCharacters, pdf417IsLinked: pdf417IsLinked, pdf417IsCode128Emulation: pdf417IsCode128Emulation, apiConfiguration: apiConfiguration).execute().body + open class func generateMultipart(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) async throws(ErrorResponse) -> Data { + try await generateMultipartWithRequestBuilder(barcodeType: barcodeType, data: data, dataType: dataType, barcodeImageParams: barcodeImageParams, qrParams: qrParams, code128Params: code128Params, pdf417Params: pdf417Params, apiConfiguration: apiConfiguration).execute().body } /** @@ -343,75 +343,75 @@ open class GenerateAPI { - OAuth: - type: oauth2 - name: JWT - - parameter barcodeType: (form) + - parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ - parameter data: (form) String that represents the data to encode. - - parameter dataType: (form) (optional) - - parameter imageFormat: (form) (optional) - - parameter textLocation: (form) (optional) + - parameter dataType: (form) Type of data to encode. Default value: StringData. (optional) + - parameter imageFormat: (form) Barcode output image format. Default value: png. (optional) + - parameter textLocation: (form) Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. (optional) - parameter foregroundColor: (form) Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. (optional, default to "Black") - parameter backgroundColor: (form) Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. (optional, default to "White") - - parameter units: (form) (optional) + - parameter units: (form) Common units for all measurements. Default units: pixels. (optional) - parameter resolution: (form) Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) - parameter imageHeight: (form) Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) - parameter imageWidth: (form) Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) - parameter rotationAngle: (form) Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. (optional) - - parameter qrEncodeMode: (form) (optional) - - parameter qrErrorLevel: (form) (optional) - - parameter qrVersion: (form) (optional) - - parameter qrECIEncoding: (form) (optional) + - parameter qrEncodeMode: (form) QR barcode encode mode. (optional) + - parameter qrErrorLevel: (form) QR barcode error correction level. (optional) + - parameter qrVersion: (form) QR barcode version. Automatically selects the smallest version that fits the data. (optional) + - parameter qrECIEncoding: (form) ECI encoding for QR barcode data. (optional) - parameter qrAspectRatio: (form) QR barcode aspect ratio. Values: 0 to 1. (optional) - - parameter microQRVersion: (form) (optional) - - parameter rectMicroQrVersion: (form) (optional) - - parameter code128EncodeMode: (form) (optional) - - parameter pdf417EncodeMode: (form) (optional) - - parameter pdf417ErrorLevel: (form) (optional) + - parameter microQRVersion: (form) MicroQR barcode version. Used when BarcodeType is MicroQR. (optional) + - parameter rectMicroQrVersion: (form) RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional) + - parameter code128EncodeMode: (form) Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional) + - parameter pdf417EncodeMode: (form) PDF417 barcode encode mode. (optional) + - parameter pdf417ErrorLevel: (form) PDF417 barcode error correction level. (optional) - parameter pdf417Truncate: (form) Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) - parameter pdf417Columns: (form) Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) - parameter pdf417Rows: (form) Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) - parameter pdf417AspectRatio: (form) PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. (optional) - - parameter pdf417ECIEncoding: (form) (optional) + - parameter pdf417ECIEncoding: (form) ECI encoding for PDF417 barcode data. (optional) - parameter pdf417IsReaderInitialization: (form) Whether the barcode is used for reader initialization (programming). (optional) - - parameter pdf417MacroCharacters: (form) (optional) + - parameter pdf417MacroCharacters: (form) Macro character to prepend (structured append). (optional) - parameter pdf417IsLinked: (form) Whether to use linked mode (for MicroPdf417). (optional) - parameter pdf417IsCode128Emulation: (form) Whether to use Code128 emulation for MicroPdf417. (optional) - parameter apiConfiguration: The configuration for the http request. - returns: RequestBuilder */ - open class func generateMultipartWithRequestBuilder(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, imageFormat: BarcodeImageFormat? = nil, textLocation: CodeLocation? = nil, foregroundColor: String? = nil, backgroundColor: String? = nil, units: GraphicsUnit? = nil, resolution: Float? = nil, imageHeight: Float? = nil, imageWidth: Float? = nil, rotationAngle: Int? = nil, qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil, code128EncodeMode: Code128EncodeMode? = nil, pdf417EncodeMode: Pdf417EncodeMode? = nil, pdf417ErrorLevel: Pdf417ErrorLevel? = nil, pdf417Truncate: Bool? = nil, pdf417Columns: Int? = nil, pdf417Rows: Int? = nil, pdf417AspectRatio: Float? = nil, pdf417ECIEncoding: ECIEncodings? = nil, pdf417IsReaderInitialization: Bool? = nil, pdf417MacroCharacters: MacroCharacter? = nil, pdf417IsLinked: Bool? = nil, pdf417IsCode128Emulation: Bool? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) -> RequestBuilder { + open class func generateMultipartWithRequestBuilder(barcodeType: EncodeBarcodeType, data: String, dataType: EncodeDataType? = nil, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil, apiConfiguration: AsposeBarcodeCloudAPIConfiguration = AsposeBarcodeCloudAPIConfiguration.shared) -> RequestBuilder { let localVariablePath = "/barcode/generate-multipart" let localVariableURLString = apiConfiguration.basePath + localVariablePath let localVariableFormParams: [String: (any Sendable)?] = [ "barcodeType": barcodeType.asParameter(codableHelper: apiConfiguration.codableHelper), "dataType": dataType?.asParameter(codableHelper: apiConfiguration.codableHelper), "data": data.asParameter(codableHelper: apiConfiguration.codableHelper), - "imageFormat": imageFormat?.asParameter(codableHelper: apiConfiguration.codableHelper), - "textLocation": textLocation?.asParameter(codableHelper: apiConfiguration.codableHelper), - "foregroundColor": foregroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), - "backgroundColor": backgroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), - "units": units?.asParameter(codableHelper: apiConfiguration.codableHelper), - "resolution": resolution?.asParameter(codableHelper: apiConfiguration.codableHelper), - "imageHeight": imageHeight?.asParameter(codableHelper: apiConfiguration.codableHelper), - "imageWidth": imageWidth?.asParameter(codableHelper: apiConfiguration.codableHelper), - "rotationAngle": rotationAngle?.asParameter(codableHelper: apiConfiguration.codableHelper), - "qrEncodeMode": qrEncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), - "qrErrorLevel": qrErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), - "qrVersion": qrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), - "qrECIEncoding": qrECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), - "qrAspectRatio": qrAspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), - "microQRVersion": microQRVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), - "rectMicroQrVersion": rectMicroQrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), - "code128EncodeMode": code128EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417EncodeMode": pdf417EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417ErrorLevel": pdf417ErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417Truncate": pdf417Truncate?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417Columns": pdf417Columns?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417Rows": pdf417Rows?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417AspectRatio": pdf417AspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417ECIEncoding": pdf417ECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417IsReaderInitialization": pdf417IsReaderInitialization?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417MacroCharacters": pdf417MacroCharacters?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417IsLinked": pdf417IsLinked?.asParameter(codableHelper: apiConfiguration.codableHelper), - "pdf417IsCode128Emulation": pdf417IsCode128Emulation?.asParameter(codableHelper: apiConfiguration.codableHelper), + "imageFormat": barcodeImageParams?.imageFormat?.asParameter(codableHelper: apiConfiguration.codableHelper), + "textLocation": barcodeImageParams?.textLocation?.asParameter(codableHelper: apiConfiguration.codableHelper), + "foregroundColor": barcodeImageParams?.foregroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), + "backgroundColor": barcodeImageParams?.backgroundColor?.asParameter(codableHelper: apiConfiguration.codableHelper), + "units": barcodeImageParams?.units?.asParameter(codableHelper: apiConfiguration.codableHelper), + "resolution": barcodeImageParams?.resolution?.asParameter(codableHelper: apiConfiguration.codableHelper), + "imageHeight": barcodeImageParams?.imageHeight?.asParameter(codableHelper: apiConfiguration.codableHelper), + "imageWidth": barcodeImageParams?.imageWidth?.asParameter(codableHelper: apiConfiguration.codableHelper), + "rotationAngle": barcodeImageParams?.rotationAngle?.asParameter(codableHelper: apiConfiguration.codableHelper), + "qrEncodeMode": qrParams?.qrEncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), + "qrErrorLevel": qrParams?.qrErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), + "qrVersion": qrParams?.qrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), + "qrECIEncoding": qrParams?.qrECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), + "qrAspectRatio": qrParams?.qrAspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), + "microQRVersion": qrParams?.microQRVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), + "rectMicroQrVersion": qrParams?.rectMicroQrVersion?.asParameter(codableHelper: apiConfiguration.codableHelper), + "code128EncodeMode": code128Params?.code128EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417EncodeMode": pdf417Params?.pdf417EncodeMode?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417ErrorLevel": pdf417Params?.pdf417ErrorLevel?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417Truncate": pdf417Params?.pdf417Truncate?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417Columns": pdf417Params?.pdf417Columns?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417Rows": pdf417Params?.pdf417Rows?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417AspectRatio": pdf417Params?.pdf417AspectRatio?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417ECIEncoding": pdf417Params?.pdf417ECIEncoding?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417IsReaderInitialization": pdf417Params?.pdf417IsReaderInitialization?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417MacroCharacters": pdf417Params?.pdf417MacroCharacters?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417IsLinked": pdf417Params?.pdf417IsLinked?.asParameter(codableHelper: apiConfiguration.codableHelper), + "pdf417IsCode128Emulation": pdf417Params?.pdf417IsCode128Emulation?.asParameter(codableHelper: apiConfiguration.codableHelper), ] let localVariableNonNullParameters = APIHelper.rejectNil(localVariableFormParams) diff --git a/Sources/AsposeBarcodeCloud/APIs/RecognizeAPI.swift b/Sources/AsposeBarcodeCloud/APIs/RecognizeAPI.swift index 553d1a5..7bc41fb 100644 --- a/Sources/AsposeBarcodeCloud/APIs/RecognizeAPI.swift +++ b/Sources/AsposeBarcodeCloud/APIs/RecognizeAPI.swift @@ -140,10 +140,10 @@ open class RecognizeAPI { /** Recognize a barcode from a file in the request body using a POST request with multipart form parameters. - - parameter barcodeType: (form) + - parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ - parameter file: (form) Barcode image file. - - parameter recognitionMode: (form) (optional) - - parameter recognitionImageKind: (form) (optional) + - parameter recognitionMode: (form) Recognition mode. (optional) + - parameter recognitionImageKind: (form) Image kind for recognition. (optional) - parameter apiConfiguration: The configuration for the http request. - parameter completion: completion handler to receive the data and the error objects */ @@ -162,10 +162,10 @@ open class RecognizeAPI { /** Recognize a barcode from a file in the request body using a POST request with multipart form parameters. - - parameter barcodeType: (form) + - parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ - parameter file: (form) Barcode image file. - - parameter recognitionMode: (form) (optional) - - parameter recognitionImageKind: (form) (optional) + - parameter recognitionMode: (form) Recognition mode. (optional) + - parameter recognitionImageKind: (form) Image kind for recognition. (optional) - parameter apiConfiguration: The configuration for the http request. - returns: BarcodeResponseList */ @@ -179,10 +179,10 @@ open class RecognizeAPI { - OAuth: - type: oauth2 - name: JWT - - parameter barcodeType: (form) + - parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ - parameter file: (form) Barcode image file. - - parameter recognitionMode: (form) (optional) - - parameter recognitionImageKind: (form) (optional) + - parameter recognitionMode: (form) Recognition mode. (optional) + - parameter recognitionImageKind: (form) Image kind for recognition. (optional) - parameter apiConfiguration: The configuration for the http request. - returns: RequestBuilder */ diff --git a/Sources/AsposeBarcodeCloud/Models/ApiError.swift b/Sources/AsposeBarcodeCloud/Models/ApiError.swift index 12826f4..0c36dad 100644 --- a/Sources/AsposeBarcodeCloud/Models/ApiError.swift +++ b/Sources/AsposeBarcodeCloud/Models/ApiError.swift @@ -17,6 +17,7 @@ public final class ApiError: @unchecked Sendable, Codable, Hashable { public var description: String? /** Gets or sets server datetime. */ public var dateTime: Date? + /** Gets or sets inner error. */ public var innerError: ApiError? public init(code: String?, message: String?, description: String? = nil, dateTime: Date? = nil, innerError: ApiError? = nil) { diff --git a/Sources/AsposeBarcodeCloud/Models/ApiErrorResponse.swift b/Sources/AsposeBarcodeCloud/Models/ApiErrorResponse.swift index 0157180..bbbf281 100644 --- a/Sources/AsposeBarcodeCloud/Models/ApiErrorResponse.swift +++ b/Sources/AsposeBarcodeCloud/Models/ApiErrorResponse.swift @@ -11,6 +11,7 @@ import Foundation public final class ApiErrorResponse: @unchecked Sendable, Codable, Hashable { /** Gets or sets request Id. */ public var requestId: String? + /** Gets or sets error. */ public var error: ApiError public init(requestId: String?, error: ApiError) { diff --git a/Sources/AsposeBarcodeCloud/Models/BarcodeImageParams.swift b/Sources/AsposeBarcodeCloud/Models/BarcodeImageParams.swift index 418af6b..d2c0152 100644 --- a/Sources/AsposeBarcodeCloud/Models/BarcodeImageParams.swift +++ b/Sources/AsposeBarcodeCloud/Models/BarcodeImageParams.swift @@ -10,12 +10,15 @@ import Foundation /** Optional barcode image parameters. */ public final class BarcodeImageParams: @unchecked Sendable, Codable, Hashable { public static let resolutionRule = NumericRule(minimum: 1, exclusiveMinimum: false, maximum: 100_000, exclusiveMaximum: false, multipleOf: nil) + /** Barcode output image format. Default value: png. */ public var imageFormat: BarcodeImageFormat? + /** Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. */ public var textLocation: CodeLocation? /** Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. */ public var foregroundColor: String? = "Black" /** Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. */ public var backgroundColor: String? = "White" + /** Common units for all measurements. Default units: pixels. */ public var units: GraphicsUnit? /** Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. */ public var resolution: Float? diff --git a/Sources/AsposeBarcodeCloud/Models/Code128Params.swift b/Sources/AsposeBarcodeCloud/Models/Code128Params.swift index 46b2e16..c153127 100644 --- a/Sources/AsposeBarcodeCloud/Models/Code128Params.swift +++ b/Sources/AsposeBarcodeCloud/Models/Code128Params.swift @@ -9,6 +9,7 @@ import Foundation /** Optional Code128 barcode generation parameters. */ public final class Code128Params: @unchecked Sendable, Codable, Hashable { + /** Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. */ public var code128EncodeMode: Code128EncodeMode? public init(code128EncodeMode: Code128EncodeMode? = nil) { diff --git a/Sources/AsposeBarcodeCloud/Models/EncodeData.swift b/Sources/AsposeBarcodeCloud/Models/EncodeData.swift index f7415d0..472c020 100644 --- a/Sources/AsposeBarcodeCloud/Models/EncodeData.swift +++ b/Sources/AsposeBarcodeCloud/Models/EncodeData.swift @@ -10,6 +10,7 @@ import Foundation /** Data to encode in a barcode. */ public final class EncodeData: @unchecked Sendable, Codable, Hashable { public static let dataRule = StringRule(minLength: 1, maxLength: nil, pattern: nil) + /** Type of data to encode. Default value: StringData. */ public var dataType: EncodeDataType? /** String that represents the data to encode. */ public var data: String diff --git a/Sources/AsposeBarcodeCloud/Models/GenerateParams.swift b/Sources/AsposeBarcodeCloud/Models/GenerateParams.swift index 102fd14..4378275 100644 --- a/Sources/AsposeBarcodeCloud/Models/GenerateParams.swift +++ b/Sources/AsposeBarcodeCloud/Models/GenerateParams.swift @@ -9,11 +9,17 @@ import Foundation /** Barcode generation parameters. */ public final class GenerateParams: @unchecked Sendable, Codable, Hashable { + /** Barcode type. */ public var barcodeType: EncodeBarcodeType + /** Data to encode into a barcode. */ public var encodeData: EncodeData + /** Optional barcode image parameters. */ public var barcodeImageParams: BarcodeImageParams? + /** Optional QR barcode generation parameters. */ public var qrParams: QrParams? + /** Optional Code128 barcode generation parameters. */ public var code128Params: Code128Params? + /** Optional PDF417 barcode generation parameters. */ public var pdf417Params: Pdf417Params? public init(barcodeType: EncodeBarcodeType, encodeData: EncodeData, barcodeImageParams: BarcodeImageParams? = nil, qrParams: QrParams? = nil, code128Params: Code128Params? = nil, pdf417Params: Pdf417Params? = nil) { diff --git a/Sources/AsposeBarcodeCloud/Models/Pdf417Params.swift b/Sources/AsposeBarcodeCloud/Models/Pdf417Params.swift index 46ca749..cfa9de2 100644 --- a/Sources/AsposeBarcodeCloud/Models/Pdf417Params.swift +++ b/Sources/AsposeBarcodeCloud/Models/Pdf417Params.swift @@ -12,7 +12,9 @@ public final class Pdf417Params: @unchecked Sendable, Codable, Hashable { public static let pdf417ColumnsRule = NumericRule(minimum: 0, exclusiveMinimum: false, maximum: 30, exclusiveMaximum: false, multipleOf: nil) public static let pdf417RowsRule = NumericRule(minimum: 0, exclusiveMinimum: false, maximum: 90, exclusiveMaximum: false, multipleOf: nil) public static let pdf417AspectRatioRule = NumericRule(minimum: 2, exclusiveMinimum: false, maximum: 10, exclusiveMaximum: false, multipleOf: nil) + /** PDF417 barcode encode mode. */ public var pdf417EncodeMode: Pdf417EncodeMode? + /** PDF417 barcode error correction level. */ public var pdf417ErrorLevel: Pdf417ErrorLevel? /** Whether to use truncated PDF417 format (removes right-side stop pattern). */ public var pdf417Truncate: Bool? @@ -22,9 +24,11 @@ public final class Pdf417Params: @unchecked Sendable, Codable, Hashable { public var pdf417Rows: Int? /** PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. */ public var pdf417AspectRatio: Float? + /** ECI encoding for PDF417 barcode data. */ public var pdf417ECIEncoding: ECIEncodings? /** Whether the barcode is used for reader initialization (programming). */ public var pdf417IsReaderInitialization: Bool? + /** Macro character to prepend (structured append). */ public var pdf417MacroCharacters: MacroCharacter? /** Whether to use linked mode (for MicroPdf417). */ public var pdf417IsLinked: Bool? diff --git a/Sources/AsposeBarcodeCloud/Models/QrParams.swift b/Sources/AsposeBarcodeCloud/Models/QrParams.swift index c15f21a..1c5de94 100644 --- a/Sources/AsposeBarcodeCloud/Models/QrParams.swift +++ b/Sources/AsposeBarcodeCloud/Models/QrParams.swift @@ -10,13 +10,19 @@ import Foundation /** Optional QR barcode generation parameters. Applies to QR, GS1QR, MicroQR, and RectMicroQR barcode types. */ public final class QrParams: @unchecked Sendable, Codable, Hashable { public static let qrAspectRatioRule = NumericRule(minimum: 0.001, exclusiveMinimum: false, maximum: 1, exclusiveMaximum: false, multipleOf: nil) + /** QR barcode encode mode. */ public var qrEncodeMode: QREncodeMode? + /** QR barcode error correction level. */ public var qrErrorLevel: QRErrorLevel? + /** QR barcode version. Automatically selects the smallest version that fits the data. */ public var qrVersion: QRVersion? + /** ECI encoding for QR barcode data. */ public var qrECIEncoding: ECIEncodings? /** QR barcode aspect ratio. Values: 0 to 1. */ public var qrAspectRatio: Float? + /** MicroQR barcode version. Used when BarcodeType is MicroQR. */ public var microQRVersion: MicroQRVersion? + /** RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. */ public var rectMicroQrVersion: RectMicroQRVersion? public init(qrEncodeMode: QREncodeMode? = nil, qrErrorLevel: QRErrorLevel? = nil, qrVersion: QRVersion? = nil, qrECIEncoding: ECIEncodings? = nil, qrAspectRatio: Float? = nil, microQRVersion: MicroQRVersion? = nil, rectMicroQrVersion: RectMicroQRVersion? = nil) { diff --git a/Sources/AsposeBarcodeCloud/Models/RecognizeBase64Request.swift b/Sources/AsposeBarcodeCloud/Models/RecognizeBase64Request.swift index 65489f0..33e2b12 100644 --- a/Sources/AsposeBarcodeCloud/Models/RecognizeBase64Request.swift +++ b/Sources/AsposeBarcodeCloud/Models/RecognizeBase64Request.swift @@ -14,7 +14,9 @@ public final class RecognizeBase64Request: @unchecked Sendable, Codable, Hashabl public var barcodeTypes: [DecodeBarcodeType] /** Barcode image bytes encoded as base-64. */ public var fileBase64: String + /** Barcode recognition mode. */ public var recognitionMode: RecognitionMode? + /** Image kind for recognition. */ public var recognitionImageKind: RecognitionImageKind? public init(barcodeTypes: [DecodeBarcodeType], fileBase64: String, recognitionMode: RecognitionMode? = nil, recognitionImageKind: RecognitionImageKind? = nil) { diff --git a/Tests/AsposeBarcodeCloudTests/AsposeBarcodeCloudTests.swift b/Tests/AsposeBarcodeCloudTests/AsposeBarcodeCloudTests.swift index 3fe3532..189ef68 100644 --- a/Tests/AsposeBarcodeCloudTests/AsposeBarcodeCloudTests.swift +++ b/Tests/AsposeBarcodeCloudTests/AsposeBarcodeCloudTests.swift @@ -115,7 +115,7 @@ final class AsposeBarcodeCloudTests: XCTestCase { let data = try await GenerateAPI.generate( barcodeType: .qr, data: "Aspose.BarCode Swift SDK", - imageFormat: .png, + barcodeImageParams: BarcodeImageParams(imageFormat: .png), apiConfiguration: client.apiConfiguration ) XCTAssertGreaterThan(data.count, 0) @@ -141,7 +141,7 @@ final class AsposeBarcodeCloudTests: XCTestCase { barcodeType: .qr, data: "54657374", dataType: .hexBytes, - backgroundColor: "0xffe", + barcodeImageParams: BarcodeImageParams(backgroundColor: "0xffe"), apiConfiguration: client.apiConfiguration ) XCTAssertGreaterThan(data.count, 0) diff --git a/Tests/AsposeBarcodeCloudTests/RequestBuilderTests.swift b/Tests/AsposeBarcodeCloudTests/RequestBuilderTests.swift index f158f3f..74176e0 100644 --- a/Tests/AsposeBarcodeCloudTests/RequestBuilderTests.swift +++ b/Tests/AsposeBarcodeCloudTests/RequestBuilderTests.swift @@ -13,8 +13,7 @@ final class RequestBuilderTests: XCTestCase { barcodeType: .qr, data: "hello world", dataType: .stringData, - imageFormat: .png, - textLocation: ._none, + barcodeImageParams: BarcodeImageParams(imageFormat: .png, textLocation: ._none), apiConfiguration: client.apiConfiguration ) @@ -67,8 +66,7 @@ final class RequestBuilderTests: XCTestCase { barcodeType: .qr, data: "payload", dataType: .stringData, - imageFormat: .png, - textLocation: ._none + barcodeImageParams: BarcodeImageParams(imageFormat: .png, textLocation: ._none) ) XCTAssertEqual(builder.method, "POST") diff --git a/docs/ApiError.md b/docs/ApiError.md index 70b9c42..e1b0a61 100644 --- a/docs/ApiError.md +++ b/docs/ApiError.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **message** | **String** | Gets or sets error message. | **description** | **String** | Gets or sets error description. | [optional] **dateTime** | **Date** | Gets or sets server datetime. | [optional] -**innerError** | [**ApiError**](ApiError.md) | | [optional] +**innerError** | [**ApiError**](ApiError.md) | Gets or sets inner error. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ApiErrorResponse.md b/docs/ApiErrorResponse.md index e18e4b6..6ac3bc8 100644 --- a/docs/ApiErrorResponse.md +++ b/docs/ApiErrorResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **requestId** | **String** | Gets or sets request Id. | -**error** | [**ApiError**](ApiError.md) | | +**error** | [**ApiError**](ApiError.md) | Gets or sets error. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BarcodeImageParams.md b/docs/BarcodeImageParams.md index c7b06ff..66370d2 100644 --- a/docs/BarcodeImageParams.md +++ b/docs/BarcodeImageParams.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**imageFormat** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | | [optional] -**textLocation** | [**CodeLocation**](CodeLocation.md) | | [optional] +**imageFormat** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | Barcode output image format. Default value: png. | [optional] +**textLocation** | [**CodeLocation**](CodeLocation.md) | Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. | [optional] **foregroundColor** | **String** | Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. | [optional] [default to "Black"] **backgroundColor** | **String** | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. | [optional] [default to "White"] -**units** | [**GraphicsUnit**](GraphicsUnit.md) | | [optional] +**units** | [**GraphicsUnit**](GraphicsUnit.md) | Common units for all measurements. Default units: pixels. | [optional] **resolution** | **Float** | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional] **imageHeight** | **Float** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] **imageWidth** | **Float** | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] diff --git a/docs/Code128Params.md b/docs/Code128Params.md index d8bd421..2cb5379 100644 --- a/docs/Code128Params.md +++ b/docs/Code128Params.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code128EncodeMode** | [**Code128EncodeMode**](Code128EncodeMode.md) | | [optional] +**code128EncodeMode** | [**Code128EncodeMode**](Code128EncodeMode.md) | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/EncodeData.md b/docs/EncodeData.md index ecc4e41..2d870c2 100644 --- a/docs/EncodeData.md +++ b/docs/EncodeData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dataType** | [**EncodeDataType**](EncodeDataType.md) | | [optional] +**dataType** | [**EncodeDataType**](EncodeDataType.md) | Type of data to encode. Default value: StringData. | [optional] **data** | **String** | String that represents the data to encode. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GenerateAPI.md b/docs/GenerateAPI.md index 3506841..6b8890c 100644 --- a/docs/GenerateAPI.md +++ b/docs/GenerateAPI.md @@ -177,35 +177,35 @@ Generate a barcode using a POST request with parameters in a multipart form. // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new import AsposeBarcodeCloud -let barcodeType = EncodeBarcodeType() // EncodeBarcodeType | +let barcodeType = EncodeBarcodeType() // EncodeBarcodeType | See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ let data = "data_example" // String | String that represents the data to encode. -let dataType = EncodeDataType() // EncodeDataType | (optional) -let imageFormat = BarcodeImageFormat() // BarcodeImageFormat | (optional) -let textLocation = CodeLocation() // CodeLocation | (optional) +let dataType = EncodeDataType() // EncodeDataType | Type of data to encode. Default value: StringData. (optional) +let imageFormat = BarcodeImageFormat() // BarcodeImageFormat | Barcode output image format. Default value: png. (optional) +let textLocation = CodeLocation() // CodeLocation | Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. (optional) let foregroundColor = "foregroundColor_example" // String | Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. (optional) (default to "Black") let backgroundColor = "backgroundColor_example" // String | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. (optional) (default to "White") -let units = GraphicsUnit() // GraphicsUnit | (optional) +let units = GraphicsUnit() // GraphicsUnit | Common units for all measurements. Default units: pixels. (optional) let resolution = 987 // Float | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) let imageHeight = 987 // Float | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) let imageWidth = 987 // Float | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) let rotationAngle = 987 // Int | Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. (optional) -let qrEncodeMode = QREncodeMode() // QREncodeMode | (optional) -let qrErrorLevel = QRErrorLevel() // QRErrorLevel | (optional) -let qrVersion = QRVersion() // QRVersion | (optional) -let qrECIEncoding = ECIEncodings() // ECIEncodings | (optional) +let qrEncodeMode = QREncodeMode() // QREncodeMode | QR barcode encode mode. (optional) +let qrErrorLevel = QRErrorLevel() // QRErrorLevel | QR barcode error correction level. (optional) +let qrVersion = QRVersion() // QRVersion | QR barcode version. Automatically selects the smallest version that fits the data. (optional) +let qrECIEncoding = ECIEncodings() // ECIEncodings | ECI encoding for QR barcode data. (optional) let qrAspectRatio = 987 // Float | QR barcode aspect ratio. Values: 0 to 1. (optional) -let microQRVersion = MicroQRVersion() // MicroQRVersion | (optional) -let rectMicroQrVersion = RectMicroQRVersion() // RectMicroQRVersion | (optional) -let code128EncodeMode = Code128EncodeMode() // Code128EncodeMode | (optional) -let pdf417EncodeMode = Pdf417EncodeMode() // Pdf417EncodeMode | (optional) -let pdf417ErrorLevel = Pdf417ErrorLevel() // Pdf417ErrorLevel | (optional) +let microQRVersion = MicroQRVersion() // MicroQRVersion | MicroQR barcode version. Used when BarcodeType is MicroQR. (optional) +let rectMicroQrVersion = RectMicroQRVersion() // RectMicroQRVersion | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional) +let code128EncodeMode = Code128EncodeMode() // Code128EncodeMode | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional) +let pdf417EncodeMode = Pdf417EncodeMode() // Pdf417EncodeMode | PDF417 barcode encode mode. (optional) +let pdf417ErrorLevel = Pdf417ErrorLevel() // Pdf417ErrorLevel | PDF417 barcode error correction level. (optional) let pdf417Truncate = true // Bool | Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) let pdf417Columns = 987 // Int | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) let pdf417Rows = 987 // Int | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) let pdf417AspectRatio = 987 // Float | PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. (optional) -let pdf417ECIEncoding = ECIEncodings() // ECIEncodings | (optional) +let pdf417ECIEncoding = ECIEncodings() // ECIEncodings | ECI encoding for PDF417 barcode data. (optional) let pdf417IsReaderInitialization = true // Bool | Whether the barcode is used for reader initialization (programming). (optional) -let pdf417MacroCharacters = MacroCharacter() // MacroCharacter | (optional) +let pdf417MacroCharacters = MacroCharacter() // MacroCharacter | Macro character to prepend (structured append). (optional) let pdf417IsLinked = true // Bool | Whether to use linked mode (for MicroPdf417). (optional) let pdf417IsCode128Emulation = true // Bool | Whether to use Code128 emulation for MicroPdf417. (optional) @@ -226,35 +226,35 @@ GenerateAPI.generateMultipart(barcodeType: barcodeType, data: data, dataType: da Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **barcodeType** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | | + **barcodeType** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ | **data** | **String** | String that represents the data to encode. | - **dataType** | [**EncodeDataType**](EncodeDataType.md) | | [optional] - **imageFormat** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | | [optional] - **textLocation** | [**CodeLocation**](CodeLocation.md) | | [optional] + **dataType** | [**EncodeDataType**](EncodeDataType.md) | Type of data to encode. Default value: StringData. | [optional] + **imageFormat** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | Barcode output image format. Default value: png. | [optional] + **textLocation** | [**CodeLocation**](CodeLocation.md) | Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. | [optional] **foregroundColor** | **String** | Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. | [optional] [default to "Black"] **backgroundColor** | **String** | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. | [optional] [default to "White"] - **units** | [**GraphicsUnit**](GraphicsUnit.md) | | [optional] + **units** | [**GraphicsUnit**](GraphicsUnit.md) | Common units for all measurements. Default units: pixels. | [optional] **resolution** | **Float** | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional] **imageHeight** | **Float** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] **imageWidth** | **Float** | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] **rotationAngle** | **Int** | Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional] - **qrEncodeMode** | [**QREncodeMode**](QREncodeMode.md) | | [optional] - **qrErrorLevel** | [**QRErrorLevel**](QRErrorLevel.md) | | [optional] - **qrVersion** | [**QRVersion**](QRVersion.md) | | [optional] - **qrECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] + **qrEncodeMode** | [**QREncodeMode**](QREncodeMode.md) | QR barcode encode mode. | [optional] + **qrErrorLevel** | [**QRErrorLevel**](QRErrorLevel.md) | QR barcode error correction level. | [optional] + **qrVersion** | [**QRVersion**](QRVersion.md) | QR barcode version. Automatically selects the smallest version that fits the data. | [optional] + **qrECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | ECI encoding for QR barcode data. | [optional] **qrAspectRatio** | **Float** | QR barcode aspect ratio. Values: 0 to 1. | [optional] - **microQRVersion** | [**MicroQRVersion**](MicroQRVersion.md) | | [optional] - **rectMicroQrVersion** | [**RectMicroQRVersion**](RectMicroQRVersion.md) | | [optional] - **code128EncodeMode** | [**Code128EncodeMode**](Code128EncodeMode.md) | | [optional] - **pdf417EncodeMode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | | [optional] - **pdf417ErrorLevel** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | | [optional] + **microQRVersion** | [**MicroQRVersion**](MicroQRVersion.md) | MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional] + **rectMicroQrVersion** | [**RectMicroQRVersion**](RectMicroQRVersion.md) | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional] + **code128EncodeMode** | [**Code128EncodeMode**](Code128EncodeMode.md) | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional] + **pdf417EncodeMode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | PDF417 barcode encode mode. | [optional] + **pdf417ErrorLevel** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | PDF417 barcode error correction level. | [optional] **pdf417Truncate** | **Bool** | Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] **pdf417Columns** | **Int** | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] **pdf417Rows** | **Int** | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] **pdf417AspectRatio** | **Float** | PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. | [optional] - **pdf417ECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] + **pdf417ECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | ECI encoding for PDF417 barcode data. | [optional] **pdf417IsReaderInitialization** | **Bool** | Whether the barcode is used for reader initialization (programming). | [optional] - **pdf417MacroCharacters** | [**MacroCharacter**](MacroCharacter.md) | | [optional] + **pdf417MacroCharacters** | [**MacroCharacter**](MacroCharacter.md) | Macro character to prepend (structured append). | [optional] **pdf417IsLinked** | **Bool** | Whether to use linked mode (for MicroPdf417). | [optional] **pdf417IsCode128Emulation** | **Bool** | Whether to use Code128 emulation for MicroPdf417. | [optional] diff --git a/docs/GenerateParams.md b/docs/GenerateParams.md index 82c1817..437d351 100644 --- a/docs/GenerateParams.md +++ b/docs/GenerateParams.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**barcodeType** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | | -**encodeData** | [**EncodeData**](EncodeData.md) | | -**barcodeImageParams** | [**BarcodeImageParams**](BarcodeImageParams.md) | | [optional] -**qrParams** | [**QrParams**](QrParams.md) | | [optional] -**code128Params** | [**Code128Params**](Code128Params.md) | | [optional] -**pdf417Params** | [**Pdf417Params**](Pdf417Params.md) | | [optional] +**barcodeType** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | Barcode type. | +**encodeData** | [**EncodeData**](EncodeData.md) | Data to encode into a barcode. | +**barcodeImageParams** | [**BarcodeImageParams**](BarcodeImageParams.md) | Optional barcode image parameters. | [optional] +**qrParams** | [**QrParams**](QrParams.md) | Optional QR barcode generation parameters. | [optional] +**code128Params** | [**Code128Params**](Code128Params.md) | Optional Code128 barcode generation parameters. | [optional] +**pdf417Params** | [**Pdf417Params**](Pdf417Params.md) | Optional PDF417 barcode generation parameters. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Pdf417Params.md b/docs/Pdf417Params.md index caabf52..64057a0 100644 --- a/docs/Pdf417Params.md +++ b/docs/Pdf417Params.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pdf417EncodeMode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | | [optional] -**pdf417ErrorLevel** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | | [optional] +**pdf417EncodeMode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | PDF417 barcode encode mode. | [optional] +**pdf417ErrorLevel** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | PDF417 barcode error correction level. | [optional] **pdf417Truncate** | **Bool** | Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] **pdf417Columns** | **Int** | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] **pdf417Rows** | **Int** | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] **pdf417AspectRatio** | **Float** | PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. | [optional] -**pdf417ECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] +**pdf417ECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | ECI encoding for PDF417 barcode data. | [optional] **pdf417IsReaderInitialization** | **Bool** | Whether the barcode is used for reader initialization (programming). | [optional] -**pdf417MacroCharacters** | [**MacroCharacter**](MacroCharacter.md) | | [optional] +**pdf417MacroCharacters** | [**MacroCharacter**](MacroCharacter.md) | Macro character to prepend (structured append). | [optional] **pdf417IsLinked** | **Bool** | Whether to use linked mode (for MicroPdf417). | [optional] **pdf417IsCode128Emulation** | **Bool** | Whether to use Code128 emulation for MicroPdf417. | [optional] diff --git a/docs/QrParams.md b/docs/QrParams.md index 7367c42..ee27aaa 100644 --- a/docs/QrParams.md +++ b/docs/QrParams.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**qrEncodeMode** | [**QREncodeMode**](QREncodeMode.md) | | [optional] -**qrErrorLevel** | [**QRErrorLevel**](QRErrorLevel.md) | | [optional] -**qrVersion** | [**QRVersion**](QRVersion.md) | | [optional] -**qrECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] +**qrEncodeMode** | [**QREncodeMode**](QREncodeMode.md) | QR barcode encode mode. | [optional] +**qrErrorLevel** | [**QRErrorLevel**](QRErrorLevel.md) | QR barcode error correction level. | [optional] +**qrVersion** | [**QRVersion**](QRVersion.md) | QR barcode version. Automatically selects the smallest version that fits the data. | [optional] +**qrECIEncoding** | [**ECIEncodings**](ECIEncodings.md) | ECI encoding for QR barcode data. | [optional] **qrAspectRatio** | **Float** | QR barcode aspect ratio. Values: 0 to 1. | [optional] -**microQRVersion** | [**MicroQRVersion**](MicroQRVersion.md) | | [optional] -**rectMicroQrVersion** | [**RectMicroQRVersion**](RectMicroQRVersion.md) | | [optional] +**microQRVersion** | [**MicroQRVersion**](MicroQRVersion.md) | MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional] +**rectMicroQrVersion** | [**RectMicroQRVersion**](RectMicroQRVersion.md) | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RecognizeAPI.md b/docs/RecognizeAPI.md index 3031193..ac3d652 100644 --- a/docs/RecognizeAPI.md +++ b/docs/RecognizeAPI.md @@ -123,10 +123,10 @@ Recognize a barcode from a file in the request body using a POST request with mu // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new import AsposeBarcodeCloud -let barcodeType = DecodeBarcodeType() // DecodeBarcodeType | +let barcodeType = DecodeBarcodeType() // DecodeBarcodeType | See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ let file = Data([9, 8, 7]) // Data | Barcode image file. -let recognitionMode = RecognitionMode() // RecognitionMode | (optional) -let recognitionImageKind = RecognitionImageKind() // RecognitionImageKind | (optional) +let recognitionMode = RecognitionMode() // RecognitionMode | Recognition mode. (optional) +let recognitionImageKind = RecognitionImageKind() // RecognitionImageKind | Image kind for recognition. (optional) // Recognize a barcode from a file in the request body using a POST request with multipart form parameters. RecognizeAPI.recognizeMultipart(barcodeType: barcodeType, file: file, recognitionMode: recognitionMode, recognitionImageKind: recognitionImageKind) { (response, error) in @@ -145,10 +145,10 @@ RecognizeAPI.recognizeMultipart(barcodeType: barcodeType, file: file, recognitio Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **barcodeType** | [**DecodeBarcodeType**](DecodeBarcodeType.md) | | + **barcodeType** | [**DecodeBarcodeType**](DecodeBarcodeType.md) | See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ | **file** | **Data** | Barcode image file. | - **recognitionMode** | [**RecognitionMode**](RecognitionMode.md) | | [optional] - **recognitionImageKind** | [**RecognitionImageKind**](RecognitionImageKind.md) | | [optional] + **recognitionMode** | [**RecognitionMode**](RecognitionMode.md) | Recognition mode. | [optional] + **recognitionImageKind** | [**RecognitionImageKind**](RecognitionImageKind.md) | Image kind for recognition. | [optional] ### Return type diff --git a/docs/RecognizeBase64Request.md b/docs/RecognizeBase64Request.md index 5eb9eb5..a7ce846 100644 --- a/docs/RecognizeBase64Request.md +++ b/docs/RecognizeBase64Request.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **barcodeTypes** | [DecodeBarcodeType] | Array of barcode decode types to find. | **fileBase64** | **String** | Barcode image bytes encoded as base-64. | -**recognitionMode** | [**RecognitionMode**](RecognitionMode.md) | | [optional] -**recognitionImageKind** | [**RecognitionImageKind**](RecognitionImageKind.md) | | [optional] +**recognitionMode** | [**RecognitionMode**](RecognitionMode.md) | Barcode recognition mode. | [optional] +**recognitionImageKind** | [**RecognitionImageKind**](RecognitionImageKind.md) | Image kind for recognition. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)