From 5378b2239e8a46e761a2ac737f6169c3f00a5ea4 Mon Sep 17 00:00:00 2001 From: Timur Baiguskarov Date: Wed, 10 Jun 2026 15:44:37 +0500 Subject: [PATCH 1/3] Update Python SDK for API 26.6 --- README.md | 46 +- aspose_barcode_cloud/__init__.py | 13 + aspose_barcode_cloud/api/generate_api.py | 384 ++++++++++++++-- aspose_barcode_cloud/api/recognize_api.py | 32 +- aspose_barcode_cloud/api/scan_api.py | 24 +- aspose_barcode_cloud/api_client.py | 4 +- aspose_barcode_cloud/configuration.py | 2 +- aspose_barcode_cloud/models/__init__.py | 13 + .../models/barcode_image_params.py | 24 +- .../models/barcode_response.py | 8 +- .../models/barcode_response_list.py | 4 +- .../models/code128_encode_mode.py | 82 ++++ aspose_barcode_cloud/models/code128_params.py | 97 +++++ aspose_barcode_cloud/models/eci_encodings.py | 109 +++++ aspose_barcode_cloud/models/encode_data.py | 4 +- .../models/generate_params.py | 88 +++- .../models/macro_character.py | 78 ++++ .../models/micro_qr_version.py | 80 ++++ .../models/pdf417_encode_mode.py | 79 ++++ .../models/pdf417_error_level.py | 84 ++++ aspose_barcode_cloud/models/pdf417_params.py | 412 ++++++++++++++++++ aspose_barcode_cloud/models/qr_encode_mode.py | 79 ++++ aspose_barcode_cloud/models/qr_error_level.py | 79 ++++ aspose_barcode_cloud/models/qr_params.py | 276 ++++++++++++ aspose_barcode_cloud/models/qr_version.py | 116 +++++ .../models/recognize_base64_request.py | 4 +- .../models/rect_micro_qr_version.py | 108 +++++ docs/BarcodeImageParams.md | 14 +- docs/BarcodeResponse.md | 6 +- docs/BarcodeResponseList.md | 4 +- docs/Code128EncodeMode.md | 14 + docs/Code128Params.md | 11 + docs/DecodeBarcodeType.md | 2 +- docs/ECIEncodings.md | 41 ++ docs/EncodeBarcodeType.md | 2 +- docs/EncodeData.md | 4 +- docs/EncodeDataType.md | 2 +- docs/GenerateApi.md | 174 +++++--- docs/GenerateParams.md | 5 +- docs/GraphicsUnit.md | 2 +- docs/MacroCharacter.md | 10 + docs/MicroQRVersion.md | 12 + docs/Pdf417EncodeMode.md | 11 + docs/Pdf417ErrorLevel.md | 16 + docs/Pdf417Params.md | 21 + docs/QREncodeMode.md | 11 + docs/QRErrorLevel.md | 11 + docs/QRVersion.md | 48 ++ docs/QrParams.md | 17 + docs/RecognizeApi.md | 42 +- docs/RecognizeBase64Request.md | 4 +- docs/RectMicroQRVersion.md | 40 ++ docs/ScanApi.md | 30 +- example.py | 13 +- scripts/insert-example.bash | 7 +- setup.py | 2 +- snippets/generate/appearance/generate_body.py | 14 +- 57 files changed, 2715 insertions(+), 204 deletions(-) create mode 100644 aspose_barcode_cloud/models/code128_encode_mode.py create mode 100644 aspose_barcode_cloud/models/code128_params.py create mode 100644 aspose_barcode_cloud/models/eci_encodings.py create mode 100644 aspose_barcode_cloud/models/macro_character.py create mode 100644 aspose_barcode_cloud/models/micro_qr_version.py create mode 100644 aspose_barcode_cloud/models/pdf417_encode_mode.py create mode 100644 aspose_barcode_cloud/models/pdf417_error_level.py create mode 100644 aspose_barcode_cloud/models/pdf417_params.py create mode 100644 aspose_barcode_cloud/models/qr_encode_mode.py create mode 100644 aspose_barcode_cloud/models/qr_error_level.py create mode 100644 aspose_barcode_cloud/models/qr_params.py create mode 100644 aspose_barcode_cloud/models/qr_version.py create mode 100644 aspose_barcode_cloud/models/rect_micro_qr_version.py create mode 100644 docs/Code128EncodeMode.md create mode 100644 docs/Code128Params.md create mode 100644 docs/ECIEncodings.md create mode 100644 docs/MacroCharacter.md create mode 100644 docs/MicroQRVersion.md create mode 100644 docs/Pdf417EncodeMode.md create mode 100644 docs/Pdf417ErrorLevel.md create mode 100644 docs/Pdf417Params.md create mode 100644 docs/QREncodeMode.md create mode 100644 docs/QRErrorLevel.md create mode 100644 docs/QRVersion.md create mode 100644 docs/QrParams.md create mode 100644 docs/RectMicroQRVersion.md diff --git a/README.md b/README.md index 45a19f6..8bdbd5b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![PyPI](https://img.shields.io/pypi/v/aspose-barcode-cloud)](https://pypi.org/project/aspose-barcode-cloud/) - API version: 4.0 -- Package version: 26.5.0 +- Package version: 26.6.0 ## SDK and API Version Compatibility: @@ -74,6 +74,9 @@ from aspose_barcode_cloud import ( EncodeBarcodeType, CodeLocation, DecodeBarcodeType, + QREncodeMode, + QRErrorLevel, + QRVersion, ) config = Configuration( @@ -84,7 +87,15 @@ config = Configuration( # Generate barcode generateApi = GenerateApi(ApiClient(config)) -response = generateApi.generate(EncodeBarcodeType.QR, "Example", text_location=CodeLocation.NONE) +response = generateApi.generate( + EncodeBarcodeType.QR, + "Example", + text_location=CodeLocation.NONE, + qr_encode_mode=QREncodeMode.AUTO, + qr_error_level=QRErrorLevel.LEVELM, + qr_version=QRVersion.AUTO, + qr_aspect_ratio=0.75, +) with open("example.png", "wb") as f: f.write(response.data) print("Barcode saved to file 'example.png'") @@ -119,15 +130,15 @@ All URIs are relative to ** Class | Method | HTTP request | Description ----- | ------ | ------------ | ----------- -*GenerateApi* | [**generate**](docs/GenerateApi.md#generate) | **GET** /barcode/generate/{barcodeType} | Generate barcode using GET request with parameters in route and query string. -*GenerateApi* | [**generate_body**](docs/GenerateApi.md#generate_body) | **POST** /barcode/generate-body | Generate barcode using POST request with parameters in body in json or xml format. -*GenerateApi* | [**generate_multipart**](docs/GenerateApi.md#generate_multipart) | **POST** /barcode/generate-multipart | Generate barcode using POST request with parameters in multipart form. -*RecognizeApi* | [**recognize**](docs/RecognizeApi.md#recognize) | **GET** /barcode/recognize | Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead. -*RecognizeApi* | [**recognize_base64**](docs/RecognizeApi.md#recognize_base64) | **POST** /barcode/recognize-body | Recognize barcode from file in request body using POST requests with parameters in body in json or xml format. -*RecognizeApi* | [**recognize_multipart**](docs/RecognizeApi.md#recognize_multipart) | **POST** /barcode/recognize-multipart | Recognize barcode from file in request body using POST requests with parameters in multipart form. -*ScanApi* | [**scan**](docs/ScanApi.md#scan) | **GET** /barcode/scan | Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead. -*ScanApi* | [**scan_base64**](docs/ScanApi.md#scan_base64) | **POST** /barcode/scan-body | Scan barcode from file in request body using POST requests with parameter in body in json or xml format. -*ScanApi* | [**scan_multipart**](docs/ScanApi.md#scan_multipart) | **POST** /barcode/scan-multipart | Scan barcode from file in request body using POST requests with parameter in multipart form. +*GenerateApi* | [**generate**](docs/GenerateApi.md#generate) | **GET** /barcode/generate/{barcodeType} | Generate a barcode using a GET request with parameters in the route and query string. +*GenerateApi* | [**generate_body**](docs/GenerateApi.md#generate_body) | **POST** /barcode/generate-body | Generate a barcode using a POST request with parameters in the request body in JSON or XML format. +*GenerateApi* | [**generate_multipart**](docs/GenerateApi.md#generate_multipart) | **POST** /barcode/generate-multipart | Generate a barcode using a POST request with parameters in a multipart form. +*RecognizeApi* | [**recognize**](docs/RecognizeApi.md#recognize) | **GET** /barcode/recognize | Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. +*RecognizeApi* | [**recognize_base64**](docs/RecognizeApi.md#recognize_base64) | **POST** /barcode/recognize-body | Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. +*RecognizeApi* | [**recognize_multipart**](docs/RecognizeApi.md#recognize_multipart) | **POST** /barcode/recognize-multipart | Recognize a barcode from a file in the request body using a POST request with multipart form parameters. +*ScanApi* | [**scan**](docs/ScanApi.md#scan) | **GET** /barcode/scan | Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. +*ScanApi* | [**scan_base64**](docs/ScanApi.md#scan_base64) | **POST** /barcode/scan-body | Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. +*ScanApi* | [**scan_multipart**](docs/ScanApi.md#scan_multipart) | **POST** /barcode/scan-multipart | Scan a barcode from a file in the request body using a POST request with a multipart form parameter. ## Documentation For Models @@ -137,15 +148,28 @@ Class | Method | HTTP request | Description - [BarcodeImageParams](docs/BarcodeImageParams.md) - [BarcodeResponse](docs/BarcodeResponse.md) - [BarcodeResponseList](docs/BarcodeResponseList.md) +- [Code128EncodeMode](docs/Code128EncodeMode.md) +- [Code128Params](docs/Code128Params.md) - [CodeLocation](docs/CodeLocation.md) - [DecodeBarcodeType](docs/DecodeBarcodeType.md) +- [ECIEncodings](docs/ECIEncodings.md) - [EncodeBarcodeType](docs/EncodeBarcodeType.md) - [EncodeData](docs/EncodeData.md) - [EncodeDataType](docs/EncodeDataType.md) - [GenerateParams](docs/GenerateParams.md) - [GraphicsUnit](docs/GraphicsUnit.md) +- [MacroCharacter](docs/MacroCharacter.md) +- [MicroQRVersion](docs/MicroQRVersion.md) +- [Pdf417EncodeMode](docs/Pdf417EncodeMode.md) +- [Pdf417ErrorLevel](docs/Pdf417ErrorLevel.md) +- [Pdf417Params](docs/Pdf417Params.md) +- [QREncodeMode](docs/QREncodeMode.md) +- [QRErrorLevel](docs/QRErrorLevel.md) +- [QRVersion](docs/QRVersion.md) +- [QrParams](docs/QrParams.md) - [RecognitionImageKind](docs/RecognitionImageKind.md) - [RecognitionMode](docs/RecognitionMode.md) - [RecognizeBase64Request](docs/RecognizeBase64Request.md) +- [RectMicroQRVersion](docs/RectMicroQRVersion.md) - [RegionPoint](docs/RegionPoint.md) - [ScanBase64Request](docs/ScanBase64Request.md) diff --git a/aspose_barcode_cloud/__init__.py b/aspose_barcode_cloud/__init__.py index c0b7ef7..a61c7cb 100644 --- a/aspose_barcode_cloud/__init__.py +++ b/aspose_barcode_cloud/__init__.py @@ -20,15 +20,28 @@ from aspose_barcode_cloud.models.barcode_image_params import BarcodeImageParams from aspose_barcode_cloud.models.barcode_response import BarcodeResponse from aspose_barcode_cloud.models.barcode_response_list import BarcodeResponseList +from aspose_barcode_cloud.models.code128_encode_mode import Code128EncodeMode +from aspose_barcode_cloud.models.code128_params import Code128Params from aspose_barcode_cloud.models.code_location import CodeLocation from aspose_barcode_cloud.models.decode_barcode_type import DecodeBarcodeType +from aspose_barcode_cloud.models.eci_encodings import ECIEncodings from aspose_barcode_cloud.models.encode_barcode_type import EncodeBarcodeType from aspose_barcode_cloud.models.encode_data import EncodeData from aspose_barcode_cloud.models.encode_data_type import EncodeDataType from aspose_barcode_cloud.models.generate_params import GenerateParams from aspose_barcode_cloud.models.graphics_unit import GraphicsUnit +from aspose_barcode_cloud.models.macro_character import MacroCharacter +from aspose_barcode_cloud.models.micro_qr_version import MicroQRVersion +from aspose_barcode_cloud.models.pdf417_encode_mode import Pdf417EncodeMode +from aspose_barcode_cloud.models.pdf417_error_level import Pdf417ErrorLevel +from aspose_barcode_cloud.models.pdf417_params import Pdf417Params +from aspose_barcode_cloud.models.qr_encode_mode import QREncodeMode +from aspose_barcode_cloud.models.qr_error_level import QRErrorLevel +from aspose_barcode_cloud.models.qr_version import QRVersion +from aspose_barcode_cloud.models.qr_params import QrParams from aspose_barcode_cloud.models.recognition_image_kind import RecognitionImageKind from aspose_barcode_cloud.models.recognition_mode import RecognitionMode from aspose_barcode_cloud.models.recognize_base64_request import RecognizeBase64Request +from aspose_barcode_cloud.models.rect_micro_qr_version import RectMicroQRVersion from aspose_barcode_cloud.models.region_point import RegionPoint from aspose_barcode_cloud.models.scan_base64_request import ScanBase64Request diff --git a/aspose_barcode_cloud/api/generate_api.py b/aspose_barcode_cloud/api/generate_api.py index 11cce9c..e1a3486 100644 --- a/aspose_barcode_cloud/api/generate_api.py +++ b/aspose_barcode_cloud/api/generate_api.py @@ -34,10 +34,29 @@ def generate( image_height=None, image_width=None, rotation_angle=None, + qr_encode_mode=None, + qr_error_level=None, + qr_version=None, + qr_eci_encoding=None, + qr_aspect_ratio=None, + micro_qr_version=None, + rect_micro_qr_version=None, + code128_encode_mode=None, + pdf417_encode_mode=None, + pdf417_error_level=None, + pdf417_truncate=None, + pdf417_columns=None, + pdf417_rows=None, + pdf417_aspect_ratio=None, + pdf417_eci_encoding=None, + pdf417_is_reader_initialization=None, + pdf417_macro_characters=None, + pdf417_is_linked=None, + pdf417_is_code128_emulation=None, async_req=False, **kwargs ): - """Generate barcode using GET request with parameters in route and query string. + """Generate a barcode using a GET request with parameters in the route and query string. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -45,17 +64,36 @@ def generate( >>> result = thread.get() :param EncodeBarcodeType barcode_type: Type of barcode to generate. # noqa: E501 - :param str data: String represents data to encode # noqa: E501 + :param str data: String that represents the data to encode. # noqa: E501 :param EncodeDataType data_type: Type of data to encode. Default value: StringData. # noqa: E501 - :param BarcodeImageFormat image_format: Barcode output image format. Default value: png # noqa: E501 - :param CodeLocation text_location: Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: Depends on BarcodeType. CodeLocation.Below for 1D Barcodes. CodeLocation.None for 2D Barcodes. # noqa: E501 - :param str foreground_color: Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. # noqa: E501 - :param str background_color: Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. # noqa: E501 - :param GraphicsUnit units: Common Units for all measuring in query. Default units: pixel. # noqa: E501 - :param float resolution: Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. # noqa: E501 - :param float image_height: Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 - :param float image_width: Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 - :param int rotation_angle: BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. # noqa: E501 + :param BarcodeImageFormat image_format: Barcode output image format. Default value: png. # noqa: E501 + :param CodeLocation text_location: 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. # noqa: E501 + :param str foreground_color: 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. # noqa: E501 + :param str background_color: 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. # noqa: E501 + :param GraphicsUnit units: Common units for all measurements. Default units: pixels. # noqa: E501 + :param float resolution: Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. # noqa: E501 + :param float image_height: Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 + :param float image_width: Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 + :param int rotation_angle: 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. # noqa: E501 + :param QREncodeMode qr_encode_mode: QR barcode encode mode. # noqa: E501 + :param QRErrorLevel qr_error_level: QR barcode error correction level. # noqa: E501 + :param QRVersion qr_version: QR barcode version. Automatically selects the smallest version that fits the data. # noqa: E501 + :param ECIEncodings qr_eci_encoding: ECI encoding for QR barcode data. # noqa: E501 + :param float qr_aspect_ratio: QR barcode aspect ratio. Values: 0 to 1. # noqa: E501 + :param MicroQRVersion micro_qr_version: MicroQR barcode version. Used when BarcodeType is MicroQR. # noqa: E501 + :param RectMicroQRVersion rect_micro_qr_version: RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. # noqa: E501 + :param Code128EncodeMode code128_encode_mode: Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. # noqa: E501 + :param Pdf417EncodeMode pdf417_encode_mode: PDF417 barcode encode mode. # noqa: E501 + :param Pdf417ErrorLevel pdf417_error_level: PDF417 barcode error correction level. # noqa: E501 + :param bool pdf417_truncate: Whether to use truncated PDF417 format (removes right-side stop pattern). # noqa: E501 + :param int pdf417_columns: Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. # noqa: E501 + :param int pdf417_rows: Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. # noqa: E501 + :param float pdf417_aspect_ratio: 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. # noqa: E501 + :param ECIEncodings pdf417_eci_encoding: ECI encoding for PDF417 barcode data. # noqa: E501 + :param bool pdf417_is_reader_initialization: Whether the barcode is used for reader initialization (programming). # noqa: E501 + :param MacroCharacter pdf417_macro_characters: Macro character to prepend (structured append). # noqa: E501 + :param bool pdf417_is_linked: Whether to use linked mode (for MicroPdf417). # noqa: E501 + :param bool pdf417_is_code128_emulation: Whether to use Code128 emulation for MicroPdf417. # noqa: E501 :param async_req bool :return: bytearray If the method is called asynchronously, @@ -76,6 +114,25 @@ def generate( image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, + qr_encode_mode=qr_encode_mode, + qr_error_level=qr_error_level, + qr_version=qr_version, + qr_eci_encoding=qr_eci_encoding, + qr_aspect_ratio=qr_aspect_ratio, + micro_qr_version=micro_qr_version, + rect_micro_qr_version=rect_micro_qr_version, + code128_encode_mode=code128_encode_mode, + pdf417_encode_mode=pdf417_encode_mode, + pdf417_error_level=pdf417_error_level, + pdf417_truncate=pdf417_truncate, + pdf417_columns=pdf417_columns, + pdf417_rows=pdf417_rows, + pdf417_aspect_ratio=pdf417_aspect_ratio, + pdf417_eci_encoding=pdf417_eci_encoding, + pdf417_is_reader_initialization=pdf417_is_reader_initialization, + pdf417_macro_characters=pdf417_macro_characters, + pdf417_is_linked=pdf417_is_linked, + pdf417_is_code128_emulation=pdf417_is_code128_emulation, **kwargs ) else: @@ -92,12 +149,31 @@ def generate( image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, + qr_encode_mode=qr_encode_mode, + qr_error_level=qr_error_level, + qr_version=qr_version, + qr_eci_encoding=qr_eci_encoding, + qr_aspect_ratio=qr_aspect_ratio, + micro_qr_version=micro_qr_version, + rect_micro_qr_version=rect_micro_qr_version, + code128_encode_mode=code128_encode_mode, + pdf417_encode_mode=pdf417_encode_mode, + pdf417_error_level=pdf417_error_level, + pdf417_truncate=pdf417_truncate, + pdf417_columns=pdf417_columns, + pdf417_rows=pdf417_rows, + pdf417_aspect_ratio=pdf417_aspect_ratio, + pdf417_eci_encoding=pdf417_eci_encoding, + pdf417_is_reader_initialization=pdf417_is_reader_initialization, + pdf417_macro_characters=pdf417_macro_characters, + pdf417_is_linked=pdf417_is_linked, + pdf417_is_code128_emulation=pdf417_is_code128_emulation, **kwargs ) return data def generate_with_http_info(self, barcode_type, data, **kwargs): - """Generate barcode using GET request with parameters in route and query string. + """Generate a barcode using a GET request with parameters in the route and query string. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -105,7 +181,7 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): >>> result = thread.get() :param EncodeBarcodeType barcode_type: Type of barcode to generate. # noqa: E501 - :param str data: String represents data to encode # noqa: E501 + :param str data: String that represents the data to encode. # noqa: E501 :return: bytearray If the method is called asynchronously, returns the request thread. @@ -124,6 +200,25 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): "image_height", "image_width", "rotation_angle", + "qr_encode_mode", + "qr_error_level", + "qr_version", + "qr_eci_encoding", + "qr_aspect_ratio", + "micro_qr_version", + "rect_micro_qr_version", + "code128_encode_mode", + "pdf417_encode_mode", + "pdf417_error_level", + "pdf417_truncate", + "pdf417_columns", + "pdf417_rows", + "pdf417_aspect_ratio", + "pdf417_eci_encoding", + "pdf417_is_reader_initialization", + "pdf417_macro_characters", + "pdf417_is_linked", + "pdf417_is_code128_emulation", } all_params.add("async_req") all_params.add("_return_http_data_only") @@ -154,6 +249,38 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): raise ValueError( "Invalid value for parameter 'resolution' when calling 'generate', must be a value greater than or equal to '1'" ) + if "qr_aspect_ratio" in params and params["qr_aspect_ratio"] > 1: + raise ValueError( + "Invalid value for parameter 'qr_aspect_ratio' when calling 'generate', must be a value less than or equal to '1'" + ) + if "qr_aspect_ratio" in params and params["qr_aspect_ratio"] < 0.001: + raise ValueError( + "Invalid value for parameter 'qr_aspect_ratio' when calling 'generate', must be a value greater than or equal to '0.001'" + ) + if "pdf417_columns" in params and params["pdf417_columns"] > 30: + raise ValueError( + "Invalid value for parameter 'pdf417_columns' when calling 'generate', must be a value less than or equal to '30'" + ) + if "pdf417_columns" in params and params["pdf417_columns"] < 0: + raise ValueError( + "Invalid value for parameter 'pdf417_columns' when calling 'generate', must be a value greater than or equal to '0'" + ) + if "pdf417_rows" in params and params["pdf417_rows"] > 90: + raise ValueError( + "Invalid value for parameter 'pdf417_rows' when calling 'generate', must be a value less than or equal to '90'" + ) + if "pdf417_rows" in params and params["pdf417_rows"] < 0: + raise ValueError( + "Invalid value for parameter 'pdf417_rows' when calling 'generate', must be a value greater than or equal to '0'" + ) + if "pdf417_aspect_ratio" in params and params["pdf417_aspect_ratio"] > 10: + raise ValueError( + "Invalid value for parameter 'pdf417_aspect_ratio' when calling 'generate', must be a value less than or equal to '10'" + ) + if "pdf417_aspect_ratio" in params and params["pdf417_aspect_ratio"] < 2: + raise ValueError( + "Invalid value for parameter 'pdf417_aspect_ratio' when calling 'generate', must be a value greater than or equal to '2'" + ) collection_formats = {} path_params = {} @@ -183,6 +310,44 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): query_params.append(("imageWidth", params["image_width"])) if "rotation_angle" in params: query_params.append(("rotationAngle", params["rotation_angle"])) + if "qr_encode_mode" in params: + query_params.append(("qrEncodeMode", params["qr_encode_mode"])) + if "qr_error_level" in params: + query_params.append(("qrErrorLevel", params["qr_error_level"])) + if "qr_version" in params: + query_params.append(("qrVersion", params["qr_version"])) + if "qr_eci_encoding" in params: + query_params.append(("qrECIEncoding", params["qr_eci_encoding"])) + if "qr_aspect_ratio" in params: + query_params.append(("qrAspectRatio", params["qr_aspect_ratio"])) + if "micro_qr_version" in params: + query_params.append(("microQRVersion", params["micro_qr_version"])) + if "rect_micro_qr_version" in params: + query_params.append(("rectMicroQrVersion", params["rect_micro_qr_version"])) + if "code128_encode_mode" in params: + query_params.append(("code128EncodeMode", params["code128_encode_mode"])) + if "pdf417_encode_mode" in params: + query_params.append(("pdf417EncodeMode", params["pdf417_encode_mode"])) + if "pdf417_error_level" in params: + query_params.append(("pdf417ErrorLevel", params["pdf417_error_level"])) + if "pdf417_truncate" in params: + query_params.append(("pdf417Truncate", params["pdf417_truncate"])) + if "pdf417_columns" in params: + query_params.append(("pdf417Columns", params["pdf417_columns"])) + if "pdf417_rows" in params: + query_params.append(("pdf417Rows", params["pdf417_rows"])) + if "pdf417_aspect_ratio" in params: + query_params.append(("pdf417AspectRatio", params["pdf417_aspect_ratio"])) + if "pdf417_eci_encoding" in params: + query_params.append(("pdf417ECIEncoding", params["pdf417_eci_encoding"])) + if "pdf417_is_reader_initialization" in params: + query_params.append(("pdf417IsReaderInitialization", params["pdf417_is_reader_initialization"])) + if "pdf417_macro_characters" in params: + query_params.append(("pdf417MacroCharacters", params["pdf417_macro_characters"])) + if "pdf417_is_linked" in params: + query_params.append(("pdf417IsLinked", params["pdf417_is_linked"])) + if "pdf417_is_code128_emulation" in params: + query_params.append(("pdf417IsCode128Emulation", params["pdf417_is_code128_emulation"])) header_params = {} @@ -223,14 +388,14 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): ) def generate_body(self, generate_params, async_req=False, **kwargs): - """Generate barcode using POST request with parameters in body in json or xml format. + """Generate a barcode using a POST request with parameters in the request body in JSON or XML format. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = GenerateApi().generate_body(generate_params, async_req=True) >>> result = thread.get() - :param GenerateParams generate_params: Parameters of generation # noqa: E501 + :param GenerateParams generate_params: Generation parameters. # noqa: E501 :param async_req bool :return: bytearray If the method is called asynchronously, @@ -244,14 +409,14 @@ def generate_body(self, generate_params, async_req=False, **kwargs): return data def generate_body_with_http_info(self, generate_params, **kwargs): - """Generate barcode using POST request with parameters in body in json or xml format. + """Generate a barcode using a POST request with parameters in the request body in JSON or XML format. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = GenerateApi().generate_body_with_http_info(generate_params, async_req=True) >>> result = thread.get() - :param GenerateParams generate_params: Parameters of generation # noqa: E501 + :param GenerateParams generate_params: Generation parameters. # noqa: E501 :return: bytearray If the method is called asynchronously, returns the request thread. @@ -341,10 +506,29 @@ def generate_multipart( image_height=None, image_width=None, rotation_angle=None, + qr_encode_mode=None, + qr_error_level=None, + qr_version=None, + qr_eci_encoding=None, + qr_aspect_ratio=None, + micro_qr_version=None, + rect_micro_qr_version=None, + code128_encode_mode=None, + pdf417_encode_mode=None, + pdf417_error_level=None, + pdf417_truncate=None, + pdf417_columns=None, + pdf417_rows=None, + pdf417_aspect_ratio=None, + pdf417_eci_encoding=None, + pdf417_is_reader_initialization=None, + pdf417_macro_characters=None, + pdf417_is_linked=None, + pdf417_is_code128_emulation=None, async_req=False, **kwargs ): - """Generate barcode using POST request with parameters in multipart form. + """Generate a barcode using a POST request with parameters in a multipart form. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -352,17 +536,36 @@ def generate_multipart( >>> result = thread.get() :param EncodeBarcodeType barcode_type: # noqa: E501 - :param str data: String represents data to encode # noqa: E501 + :param str data: String that represents the data to encode. # noqa: E501 :param EncodeDataType data_type: # noqa: E501 :param BarcodeImageFormat image_format: # noqa: E501 :param CodeLocation text_location: # noqa: E501 - :param str foreground_color: Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. # noqa: E501 - :param str background_color: Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. # noqa: E501 + :param str foreground_color: 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. # noqa: E501 + :param str background_color: 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. # noqa: E501 :param GraphicsUnit units: # noqa: E501 - :param float resolution: Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. # noqa: E501 - :param float image_height: Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 - :param float image_width: Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 - :param int rotation_angle: BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. # noqa: E501 + :param float resolution: Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. # noqa: E501 + :param float image_height: Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 + :param float image_width: Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 + :param int rotation_angle: 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. # noqa: E501 + :param QREncodeMode qr_encode_mode: # noqa: E501 + :param QRErrorLevel qr_error_level: # noqa: E501 + :param QRVersion qr_version: # noqa: E501 + :param ECIEncodings qr_eci_encoding: # noqa: E501 + :param float qr_aspect_ratio: QR barcode aspect ratio. Values: 0 to 1. # noqa: E501 + :param MicroQRVersion micro_qr_version: # noqa: E501 + :param RectMicroQRVersion rect_micro_qr_version: # noqa: E501 + :param Code128EncodeMode code128_encode_mode: # noqa: E501 + :param Pdf417EncodeMode pdf417_encode_mode: # noqa: E501 + :param Pdf417ErrorLevel pdf417_error_level: # noqa: E501 + :param bool pdf417_truncate: Whether to use truncated PDF417 format (removes right-side stop pattern). # noqa: E501 + :param int pdf417_columns: Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. # noqa: E501 + :param int pdf417_rows: Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. # noqa: E501 + :param float pdf417_aspect_ratio: 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. # noqa: E501 + :param ECIEncodings pdf417_eci_encoding: # noqa: E501 + :param bool pdf417_is_reader_initialization: Whether the barcode is used for reader initialization (programming). # noqa: E501 + :param MacroCharacter pdf417_macro_characters: # noqa: E501 + :param bool pdf417_is_linked: Whether to use linked mode (for MicroPdf417). # noqa: E501 + :param bool pdf417_is_code128_emulation: Whether to use Code128 emulation for MicroPdf417. # noqa: E501 :param async_req bool :return: bytearray If the method is called asynchronously, @@ -383,6 +586,25 @@ def generate_multipart( image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, + qr_encode_mode=qr_encode_mode, + qr_error_level=qr_error_level, + qr_version=qr_version, + qr_eci_encoding=qr_eci_encoding, + qr_aspect_ratio=qr_aspect_ratio, + micro_qr_version=micro_qr_version, + rect_micro_qr_version=rect_micro_qr_version, + code128_encode_mode=code128_encode_mode, + pdf417_encode_mode=pdf417_encode_mode, + pdf417_error_level=pdf417_error_level, + pdf417_truncate=pdf417_truncate, + pdf417_columns=pdf417_columns, + pdf417_rows=pdf417_rows, + pdf417_aspect_ratio=pdf417_aspect_ratio, + pdf417_eci_encoding=pdf417_eci_encoding, + pdf417_is_reader_initialization=pdf417_is_reader_initialization, + pdf417_macro_characters=pdf417_macro_characters, + pdf417_is_linked=pdf417_is_linked, + pdf417_is_code128_emulation=pdf417_is_code128_emulation, **kwargs ) else: @@ -399,12 +621,31 @@ def generate_multipart( image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, + qr_encode_mode=qr_encode_mode, + qr_error_level=qr_error_level, + qr_version=qr_version, + qr_eci_encoding=qr_eci_encoding, + qr_aspect_ratio=qr_aspect_ratio, + micro_qr_version=micro_qr_version, + rect_micro_qr_version=rect_micro_qr_version, + code128_encode_mode=code128_encode_mode, + pdf417_encode_mode=pdf417_encode_mode, + pdf417_error_level=pdf417_error_level, + pdf417_truncate=pdf417_truncate, + pdf417_columns=pdf417_columns, + pdf417_rows=pdf417_rows, + pdf417_aspect_ratio=pdf417_aspect_ratio, + pdf417_eci_encoding=pdf417_eci_encoding, + pdf417_is_reader_initialization=pdf417_is_reader_initialization, + pdf417_macro_characters=pdf417_macro_characters, + pdf417_is_linked=pdf417_is_linked, + pdf417_is_code128_emulation=pdf417_is_code128_emulation, **kwargs ) return data def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): - """Generate barcode using POST request with parameters in multipart form. + """Generate a barcode using a POST request with parameters in a multipart form. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -412,7 +653,7 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): >>> result = thread.get() :param EncodeBarcodeType barcode_type: # noqa: E501 - :param str data: String represents data to encode # noqa: E501 + :param str data: String that represents the data to encode. # noqa: E501 :return: bytearray If the method is called asynchronously, returns the request thread. @@ -431,6 +672,25 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): "image_height", "image_width", "rotation_angle", + "qr_encode_mode", + "qr_error_level", + "qr_version", + "qr_eci_encoding", + "qr_aspect_ratio", + "micro_qr_version", + "rect_micro_qr_version", + "code128_encode_mode", + "pdf417_encode_mode", + "pdf417_error_level", + "pdf417_truncate", + "pdf417_columns", + "pdf417_rows", + "pdf417_aspect_ratio", + "pdf417_eci_encoding", + "pdf417_is_reader_initialization", + "pdf417_macro_characters", + "pdf417_is_linked", + "pdf417_is_code128_emulation", } all_params.add("async_req") all_params.add("_return_http_data_only") @@ -461,6 +721,38 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): raise ValueError( "Invalid value for parameter 'resolution' when calling 'generate_multipart', must be a value greater than or equal to '1'" ) + if "qr_aspect_ratio" in params and params["qr_aspect_ratio"] > 1: + raise ValueError( + "Invalid value for parameter 'qr_aspect_ratio' when calling 'generate_multipart', must be a value less than or equal to '1'" + ) + if "qr_aspect_ratio" in params and params["qr_aspect_ratio"] < 0.001: + raise ValueError( + "Invalid value for parameter 'qr_aspect_ratio' when calling 'generate_multipart', must be a value greater than or equal to '0.001'" + ) + if "pdf417_columns" in params and params["pdf417_columns"] > 30: + raise ValueError( + "Invalid value for parameter 'pdf417_columns' when calling 'generate_multipart', must be a value less than or equal to '30'" + ) + if "pdf417_columns" in params and params["pdf417_columns"] < 0: + raise ValueError( + "Invalid value for parameter 'pdf417_columns' when calling 'generate_multipart', must be a value greater than or equal to '0'" + ) + if "pdf417_rows" in params and params["pdf417_rows"] > 90: + raise ValueError( + "Invalid value for parameter 'pdf417_rows' when calling 'generate_multipart', must be a value less than or equal to '90'" + ) + if "pdf417_rows" in params and params["pdf417_rows"] < 0: + raise ValueError( + "Invalid value for parameter 'pdf417_rows' when calling 'generate_multipart', must be a value greater than or equal to '0'" + ) + if "pdf417_aspect_ratio" in params and params["pdf417_aspect_ratio"] > 10: + raise ValueError( + "Invalid value for parameter 'pdf417_aspect_ratio' when calling 'generate_multipart', must be a value less than or equal to '10'" + ) + if "pdf417_aspect_ratio" in params and params["pdf417_aspect_ratio"] < 2: + raise ValueError( + "Invalid value for parameter 'pdf417_aspect_ratio' when calling 'generate_multipart', must be a value greater than or equal to '2'" + ) collection_formats = {} path_params = {} @@ -495,6 +787,44 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): form_params.append(("imageWidth", params["image_width"])) if "rotation_angle" in params: form_params.append(("rotationAngle", params["rotation_angle"])) + if "qr_encode_mode" in params: + form_params.append(("qrEncodeMode", params["qr_encode_mode"])) + if "qr_error_level" in params: + form_params.append(("qrErrorLevel", params["qr_error_level"])) + if "qr_version" in params: + form_params.append(("qrVersion", params["qr_version"])) + if "qr_eci_encoding" in params: + form_params.append(("qrECIEncoding", params["qr_eci_encoding"])) + if "qr_aspect_ratio" in params: + form_params.append(("qrAspectRatio", params["qr_aspect_ratio"])) + if "micro_qr_version" in params: + form_params.append(("microQRVersion", params["micro_qr_version"])) + if "rect_micro_qr_version" in params: + form_params.append(("rectMicroQrVersion", params["rect_micro_qr_version"])) + if "code128_encode_mode" in params: + form_params.append(("code128EncodeMode", params["code128_encode_mode"])) + if "pdf417_encode_mode" in params: + form_params.append(("pdf417EncodeMode", params["pdf417_encode_mode"])) + if "pdf417_error_level" in params: + form_params.append(("pdf417ErrorLevel", params["pdf417_error_level"])) + if "pdf417_truncate" in params: + form_params.append(("pdf417Truncate", params["pdf417_truncate"])) + if "pdf417_columns" in params: + form_params.append(("pdf417Columns", params["pdf417_columns"])) + if "pdf417_rows" in params: + form_params.append(("pdf417Rows", params["pdf417_rows"])) + if "pdf417_aspect_ratio" in params: + form_params.append(("pdf417AspectRatio", params["pdf417_aspect_ratio"])) + if "pdf417_eci_encoding" in params: + form_params.append(("pdf417ECIEncoding", params["pdf417_eci_encoding"])) + if "pdf417_is_reader_initialization" in params: + form_params.append(("pdf417IsReaderInitialization", params["pdf417_is_reader_initialization"])) + if "pdf417_macro_characters" in params: + form_params.append(("pdf417MacroCharacters", params["pdf417_macro_characters"])) + if "pdf417_is_linked" in params: + form_params.append(("pdf417IsLinked", params["pdf417_is_linked"])) + if "pdf417_is_code128_emulation" in params: + form_params.append(("pdf417IsCode128Emulation", params["pdf417_is_code128_emulation"])) body_params = None # HTTP header "Accept" diff --git a/aspose_barcode_cloud/api/recognize_api.py b/aspose_barcode_cloud/api/recognize_api.py index f5a27cf..84f5c56 100644 --- a/aspose_barcode_cloud/api/recognize_api.py +++ b/aspose_barcode_cloud/api/recognize_api.py @@ -23,17 +23,17 @@ def __init__(self, api_client=None): def recognize( self, barcode_type, file_url, recognition_mode=None, recognition_image_kind=None, async_req=False, **kwargs ): - """Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead. + """Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = RecognizeApi().recognize(barcode_type, file_url, async_req=True) >>> result = thread.get() - :param DecodeBarcodeType barcode_type: Type of barcode to recognize # noqa: E501 - :param str file_url: Url to barcode image # noqa: E501 - :param RecognitionMode recognition_mode: Recognition mode # noqa: E501 - :param RecognitionImageKind recognition_image_kind: Image kind for recognition # noqa: E501 + :param DecodeBarcodeType barcode_type: Type of barcode to recognize. # noqa: E501 + :param str file_url: URL to the barcode image. # noqa: E501 + :param RecognitionMode recognition_mode: Recognition mode. # noqa: E501 + :param RecognitionImageKind recognition_image_kind: Image kind for recognition. # noqa: E501 :param async_req bool :return: BarcodeResponseList If the method is called asynchronously, @@ -59,15 +59,15 @@ def recognize( return data def recognize_with_http_info(self, barcode_type, file_url, **kwargs): - """Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead. + """Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = RecognizeApi().recognize_with_http_info(barcode_type, file_url, async_req=True) >>> result = thread.get() - :param DecodeBarcodeType barcode_type: Type of barcode to recognize # noqa: E501 - :param str file_url: Url to barcode image # noqa: E501 + :param DecodeBarcodeType barcode_type: Type of barcode to recognize. # noqa: E501 + :param str file_url: URL to the barcode image. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, returns the request thread. @@ -137,14 +137,14 @@ def recognize_with_http_info(self, barcode_type, file_url, **kwargs): ) def recognize_base64(self, recognize_base64_request, async_req=False, **kwargs): - """Recognize barcode from file in request body using POST requests with parameters in body in json or xml format. + """Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = RecognizeApi().recognize_base64(recognize_base64_request, async_req=True) >>> result = thread.get() - :param RecognizeBase64Request recognize_base64_request: Barcode recognition request # noqa: E501 + :param RecognizeBase64Request recognize_base64_request: Barcode recognition request. # noqa: E501 :param async_req bool :return: BarcodeResponseList If the method is called asynchronously, @@ -158,14 +158,14 @@ def recognize_base64(self, recognize_base64_request, async_req=False, **kwargs): return data def recognize_base64_with_http_info(self, recognize_base64_request, **kwargs): - """Recognize barcode from file in request body using POST requests with parameters in body in json or xml format. + """Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = RecognizeApi().recognize_base64_with_http_info(recognize_base64_request, async_req=True) >>> result = thread.get() - :param RecognizeBase64Request recognize_base64_request: Barcode recognition request # noqa: E501 + :param RecognizeBase64Request recognize_base64_request: Barcode recognition request. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, returns the request thread. @@ -235,7 +235,7 @@ def recognize_base64_with_http_info(self, recognize_base64_request, **kwargs): def recognize_multipart( self, barcode_type, file, recognition_mode=None, recognition_image_kind=None, async_req=False, **kwargs ): - """Recognize barcode from file in request body using POST requests with parameters in multipart form. + """Recognize a barcode from a file in the request body using a POST request with multipart form parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -243,7 +243,7 @@ def recognize_multipart( >>> result = thread.get() :param DecodeBarcodeType barcode_type: # noqa: E501 - :param bytearray file: Barcode image file # noqa: E501 + :param bytearray file: Barcode image file. # noqa: E501 :param RecognitionMode recognition_mode: # noqa: E501 :param RecognitionImageKind recognition_image_kind: # noqa: E501 :param async_req bool @@ -271,7 +271,7 @@ def recognize_multipart( return data def recognize_multipart_with_http_info(self, barcode_type, file, **kwargs): - """Recognize barcode from file in request body using POST requests with parameters in multipart form. + """Recognize a barcode from a file in the request body using a POST request with multipart form parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -279,7 +279,7 @@ def recognize_multipart_with_http_info(self, barcode_type, file, **kwargs): >>> result = thread.get() :param DecodeBarcodeType barcode_type: # noqa: E501 - :param bytearray file: Barcode image file # noqa: E501 + :param bytearray file: Barcode image file. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, returns the request thread. diff --git a/aspose_barcode_cloud/api/scan_api.py b/aspose_barcode_cloud/api/scan_api.py index 8899633..fbe4ec8 100644 --- a/aspose_barcode_cloud/api/scan_api.py +++ b/aspose_barcode_cloud/api/scan_api.py @@ -21,14 +21,14 @@ def __init__(self, api_client=None): self.auth_settings = ["JWT"] def scan(self, file_url, async_req=False, **kwargs): - """Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead. + """Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = ScanApi().scan(file_url, async_req=True) >>> result = thread.get() - :param str file_url: Url to barcode image # noqa: E501 + :param str file_url: URL to the barcode image. # noqa: E501 :param async_req bool :return: BarcodeResponseList If the method is called asynchronously, @@ -42,14 +42,14 @@ def scan(self, file_url, async_req=False, **kwargs): return data def scan_with_http_info(self, file_url, **kwargs): - """Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead. + """Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = ScanApi().scan_with_http_info(file_url, async_req=True) >>> result = thread.get() - :param str file_url: Url to barcode image # noqa: E501 + :param str file_url: URL to the barcode image. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, returns the request thread. @@ -110,14 +110,14 @@ def scan_with_http_info(self, file_url, **kwargs): ) def scan_base64(self, scan_base64_request, async_req=False, **kwargs): - """Scan barcode from file in request body using POST requests with parameter in body in json or xml format. + """Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = ScanApi().scan_base64(scan_base64_request, async_req=True) >>> result = thread.get() - :param ScanBase64Request scan_base64_request: Barcode scan request # noqa: E501 + :param ScanBase64Request scan_base64_request: Barcode scan request. # noqa: E501 :param async_req bool :return: BarcodeResponseList If the method is called asynchronously, @@ -131,14 +131,14 @@ def scan_base64(self, scan_base64_request, async_req=False, **kwargs): return data def scan_base64_with_http_info(self, scan_base64_request, **kwargs): - """Scan barcode from file in request body using POST requests with parameter in body in json or xml format. + """Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = ScanApi().scan_base64_with_http_info(scan_base64_request, async_req=True) >>> result = thread.get() - :param ScanBase64Request scan_base64_request: Barcode scan request # noqa: E501 + :param ScanBase64Request scan_base64_request: Barcode scan request. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, returns the request thread. @@ -204,14 +204,14 @@ def scan_base64_with_http_info(self, scan_base64_request, **kwargs): ) def scan_multipart(self, file, async_req=False, **kwargs): - """Scan barcode from file in request body using POST requests with parameter in multipart form. + """Scan a barcode from a file in the request body using a POST request with a multipart form parameter. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = ScanApi().scan_multipart(file, async_req=True) >>> result = thread.get() - :param bytearray file: Barcode image file # noqa: E501 + :param bytearray file: Barcode image file. # noqa: E501 :param async_req bool :return: BarcodeResponseList If the method is called asynchronously, @@ -225,14 +225,14 @@ def scan_multipart(self, file, async_req=False, **kwargs): return data def scan_multipart_with_http_info(self, file, **kwargs): - """Scan barcode from file in request body using POST requests with parameter in multipart form. + """Scan a barcode from a file in the request body using a POST request with a multipart form parameter. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = ScanApi().scan_multipart_with_http_info(file, async_req=True) >>> result = thread.get() - :param bytearray file: Barcode image file # noqa: E501 + :param bytearray file: Barcode image file. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, returns the request thread. diff --git a/aspose_barcode_cloud/api_client.py b/aspose_barcode_cloud/api_client.py index ec826e7..b025171 100644 --- a/aspose_barcode_cloud/api_client.py +++ b/aspose_barcode_cloud/api_client.py @@ -60,13 +60,13 @@ def __init__(self, configuration=None, header_name=None, header_value=None, cook self.rest_client = RESTClientObject(configuration) self.default_headers = { "x-aspose-client": "python sdk", - "x-aspose-client-version": "26.5.0", + "x-aspose-client-version": "26.6.0", } if header_name is not None: self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "Aspose-Barcode-SDK/26.5.0/python" + self.user_agent = "Aspose-Barcode-SDK/26.6.0/python" def __del__(self): self.rest_client.close() diff --git a/aspose_barcode_cloud/configuration.py b/aspose_barcode_cloud/configuration.py index 8527c1f..58d4cbc 100644 --- a/aspose_barcode_cloud/configuration.py +++ b/aspose_barcode_cloud/configuration.py @@ -258,7 +258,7 @@ def to_debug_report(self): "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 4.0\n" - "SDK Package Version: 26.5.0".format(env=sys.platform, pyversion=sys.version) + "SDK Package Version: 26.6.0".format(env=sys.platform, pyversion=sys.version) ) @staticmethod diff --git a/aspose_barcode_cloud/models/__init__.py b/aspose_barcode_cloud/models/__init__.py index 4ce54d4..1a9643f 100644 --- a/aspose_barcode_cloud/models/__init__.py +++ b/aspose_barcode_cloud/models/__init__.py @@ -9,15 +9,28 @@ from aspose_barcode_cloud.models.barcode_image_params import BarcodeImageParams from aspose_barcode_cloud.models.barcode_response import BarcodeResponse from aspose_barcode_cloud.models.barcode_response_list import BarcodeResponseList +from aspose_barcode_cloud.models.code128_encode_mode import Code128EncodeMode +from aspose_barcode_cloud.models.code128_params import Code128Params from aspose_barcode_cloud.models.code_location import CodeLocation from aspose_barcode_cloud.models.decode_barcode_type import DecodeBarcodeType +from aspose_barcode_cloud.models.eci_encodings import ECIEncodings from aspose_barcode_cloud.models.encode_barcode_type import EncodeBarcodeType from aspose_barcode_cloud.models.encode_data import EncodeData from aspose_barcode_cloud.models.encode_data_type import EncodeDataType from aspose_barcode_cloud.models.generate_params import GenerateParams from aspose_barcode_cloud.models.graphics_unit import GraphicsUnit +from aspose_barcode_cloud.models.macro_character import MacroCharacter +from aspose_barcode_cloud.models.micro_qr_version import MicroQRVersion +from aspose_barcode_cloud.models.pdf417_encode_mode import Pdf417EncodeMode +from aspose_barcode_cloud.models.pdf417_error_level import Pdf417ErrorLevel +from aspose_barcode_cloud.models.pdf417_params import Pdf417Params +from aspose_barcode_cloud.models.qr_encode_mode import QREncodeMode +from aspose_barcode_cloud.models.qr_error_level import QRErrorLevel +from aspose_barcode_cloud.models.qr_version import QRVersion +from aspose_barcode_cloud.models.qr_params import QrParams from aspose_barcode_cloud.models.recognition_image_kind import RecognitionImageKind from aspose_barcode_cloud.models.recognition_mode import RecognitionMode from aspose_barcode_cloud.models.recognize_base64_request import RecognizeBase64Request +from aspose_barcode_cloud.models.rect_micro_qr_version import RectMicroQRVersion from aspose_barcode_cloud.models.region_point import RegionPoint from aspose_barcode_cloud.models.scan_base64_request import ScanBase64Request diff --git a/aspose_barcode_cloud/models/barcode_image_params.py b/aspose_barcode_cloud/models/barcode_image_params.py index 205f569..d09f301 100644 --- a/aspose_barcode_cloud/models/barcode_image_params.py +++ b/aspose_barcode_cloud/models/barcode_image_params.py @@ -132,7 +132,7 @@ def text_location(self, text_location): def foreground_color(self): """Gets the foreground_color of this BarcodeImageParams. # noqa: E501 - Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. # noqa: E501 + 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. # noqa: E501 :return: The foreground_color of this BarcodeImageParams. # noqa: E501 :rtype: str @@ -143,7 +143,7 @@ def foreground_color(self): def foreground_color(self, foreground_color): """Sets the foreground_color of this BarcodeImageParams. - Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. # noqa: E501 + 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. # noqa: E501 :param foreground_color: The foreground_color of this BarcodeImageParams. # noqa: E501 :type: str @@ -155,7 +155,7 @@ def foreground_color(self, foreground_color): def background_color(self): """Gets the background_color of this BarcodeImageParams. # noqa: E501 - Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. # noqa: E501 + 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. # noqa: E501 :return: The background_color of this BarcodeImageParams. # noqa: E501 :rtype: str @@ -166,7 +166,7 @@ def background_color(self): def background_color(self, background_color): """Sets the background_color of this BarcodeImageParams. - Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. # noqa: E501 + 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. # noqa: E501 :param background_color: The background_color of this BarcodeImageParams. # noqa: E501 :type: str @@ -199,7 +199,7 @@ def units(self, units): def resolution(self): """Gets the resolution of this BarcodeImageParams. # noqa: E501 - Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. # noqa: E501 + Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. # noqa: E501 :return: The resolution of this BarcodeImageParams. # noqa: E501 :rtype: float @@ -210,7 +210,7 @@ def resolution(self): def resolution(self, resolution): """Sets the resolution of this BarcodeImageParams. - Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. # noqa: E501 + Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. # noqa: E501 :param resolution: The resolution of this BarcodeImageParams. # noqa: E501 :type: float @@ -230,7 +230,7 @@ def resolution(self, resolution): def image_height(self): """Gets the image_height of this BarcodeImageParams. # noqa: E501 - Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 + Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 :return: The image_height of this BarcodeImageParams. # noqa: E501 :rtype: float @@ -241,7 +241,7 @@ def image_height(self): def image_height(self, image_height): """Sets the image_height of this BarcodeImageParams. - Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 + Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 :param image_height: The image_height of this BarcodeImageParams. # noqa: E501 :type: float @@ -253,7 +253,7 @@ def image_height(self, image_height): def image_width(self): """Gets the image_width of this BarcodeImageParams. # noqa: E501 - Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 + Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 :return: The image_width of this BarcodeImageParams. # noqa: E501 :rtype: float @@ -264,7 +264,7 @@ def image_width(self): def image_width(self, image_width): """Sets the image_width of this BarcodeImageParams. - Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. # noqa: E501 + Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 :param image_width: The image_width of this BarcodeImageParams. # noqa: E501 :type: float @@ -276,7 +276,7 @@ def image_width(self, image_width): def rotation_angle(self): """Gets the rotation_angle of this BarcodeImageParams. # noqa: E501 - BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. # noqa: E501 + 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. # noqa: E501 :return: The rotation_angle of this BarcodeImageParams. # noqa: E501 :rtype: int @@ -287,7 +287,7 @@ def rotation_angle(self): def rotation_angle(self, rotation_angle): """Sets the rotation_angle of this BarcodeImageParams. - BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. # noqa: E501 + 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. # noqa: E501 :param rotation_angle: The rotation_angle of this BarcodeImageParams. # noqa: E501 :type: int diff --git a/aspose_barcode_cloud/models/barcode_response.py b/aspose_barcode_cloud/models/barcode_response.py index e623070..ad77003 100644 --- a/aspose_barcode_cloud/models/barcode_response.py +++ b/aspose_barcode_cloud/models/barcode_response.py @@ -90,7 +90,7 @@ def type(self, type): def region(self): """Gets the region of this BarcodeResponse. # noqa: E501 - Region with barcode. # noqa: E501 + Region with the barcode. # noqa: E501 :return: The region of this BarcodeResponse. # noqa: E501 :rtype: List[RegionPoint] @@ -101,7 +101,7 @@ def region(self): def region(self, region): """Sets the region of this BarcodeResponse. - Region with barcode. # noqa: E501 + Region with the barcode. # noqa: E501 :param region: The region of this BarcodeResponse. # noqa: E501 :type: List[RegionPoint] @@ -113,7 +113,7 @@ def region(self, region): def checksum(self): """Gets the checksum of this BarcodeResponse. # noqa: E501 - Checksum of barcode. # noqa: E501 + Checksum of the barcode. # noqa: E501 :return: The checksum of this BarcodeResponse. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def checksum(self): def checksum(self, checksum): """Sets the checksum of this BarcodeResponse. - Checksum of barcode. # noqa: E501 + Checksum of the barcode. # noqa: E501 :param checksum: The checksum of this BarcodeResponse. # noqa: E501 :type: str diff --git a/aspose_barcode_cloud/models/barcode_response_list.py b/aspose_barcode_cloud/models/barcode_response_list.py index b4d8c04..4f5e9fa 100644 --- a/aspose_barcode_cloud/models/barcode_response_list.py +++ b/aspose_barcode_cloud/models/barcode_response_list.py @@ -34,7 +34,7 @@ def __init__(self, barcodes=None): # noqa: E501 def barcodes(self): """Gets the barcodes of this BarcodeResponseList. # noqa: E501 - List of barcodes which are present in image. # noqa: E501 + List of barcodes that are present in the image. # noqa: E501 :return: The barcodes of this BarcodeResponseList. # noqa: E501 :rtype: List[BarcodeResponse] @@ -45,7 +45,7 @@ def barcodes(self): def barcodes(self, barcodes): """Sets the barcodes of this BarcodeResponseList. - List of barcodes which are present in image. # noqa: E501 + List of barcodes that are present in the image. # noqa: E501 :param barcodes: The barcodes of this BarcodeResponseList. # noqa: E501 :type: List[BarcodeResponse] diff --git a/aspose_barcode_cloud/models/code128_encode_mode.py b/aspose_barcode_cloud/models/code128_encode_mode.py new file mode 100644 index 0000000..0e9caad --- /dev/null +++ b/aspose_barcode_cloud/models/code128_encode_mode.py @@ -0,0 +1,82 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class Code128EncodeMode(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + AUTO = "Auto" + CODEA = "CodeA" + CODEB = "CodeB" + CODEAB = "CodeAB" + CODEC = "CodeC" + CODEAC = "CodeAC" + CODEBC = "CodeBC" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """Code128EncodeMode - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(Code128EncodeMode, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Code128EncodeMode): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/code128_params.py b/aspose_barcode_cloud/models/code128_params.py new file mode 100644 index 0000000..f795337 --- /dev/null +++ b/aspose_barcode_cloud/models/code128_params.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class Code128Params(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {"code128_encode_mode": "Code128EncodeMode"} + + attribute_map = {"code128_encode_mode": "code128EncodeMode"} + + def __init__(self, code128_encode_mode=None): # noqa: E501 + """Code128Params - a model defined in Swagger""" # noqa: E501 + + self._code128_encode_mode = None + self.discriminator = None + + if code128_encode_mode is not None: + self.code128_encode_mode = code128_encode_mode + + @property + def code128_encode_mode(self): + """Gets the code128_encode_mode of this Code128Params. # noqa: E501 + + + :return: The code128_encode_mode of this Code128Params. # noqa: E501 + :rtype: Code128EncodeMode + """ + return self._code128_encode_mode + + @code128_encode_mode.setter + def code128_encode_mode(self, code128_encode_mode): + """Sets the code128_encode_mode of this Code128Params. + + + :param code128_encode_mode: The code128_encode_mode of this Code128Params. # noqa: E501 + :type: Code128EncodeMode + """ + + self._code128_encode_mode = code128_encode_mode + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(Code128Params, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Code128Params): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/eci_encodings.py b/aspose_barcode_cloud/models/eci_encodings.py new file mode 100644 index 0000000..289d63e --- /dev/null +++ b/aspose_barcode_cloud/models/eci_encodings.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class ECIEncodings(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + NONE = "NONE" + ISO_8859_1 = "ISO_8859_1" + ISO_8859_2 = "ISO_8859_2" + ISO_8859_3 = "ISO_8859_3" + ISO_8859_4 = "ISO_8859_4" + ISO_8859_5 = "ISO_8859_5" + ISO_8859_6 = "ISO_8859_6" + ISO_8859_7 = "ISO_8859_7" + ISO_8859_8 = "ISO_8859_8" + ISO_8859_9 = "ISO_8859_9" + ISO_8859_10 = "ISO_8859_10" + ISO_8859_11 = "ISO_8859_11" + ISO_8859_13 = "ISO_8859_13" + ISO_8859_14 = "ISO_8859_14" + ISO_8859_15 = "ISO_8859_15" + ISO_8859_16 = "ISO_8859_16" + SHIFT_JIS = "Shift_JIS" + WIN1250 = "Win1250" + WIN1251 = "Win1251" + WIN1252 = "Win1252" + WIN1256 = "Win1256" + UTF16BE = "UTF16BE" + UTF8 = "UTF8" + US_ASCII = "US_ASCII" + BIG5 = "Big5" + GB2312 = "GB2312" + EUC_KR = "EUC_KR" + GBK = "GBK" + GB18030 = "GB18030" + UTF16LE = "UTF16LE" + UTF32BE = "UTF32BE" + UTF32LE = "UTF32LE" + INVARIANT = "INVARIANT" + BINARY = "BINARY" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """ECIEncodings - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(ECIEncodings, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ECIEncodings): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/encode_data.py b/aspose_barcode_cloud/models/encode_data.py index 9a26679..98e1a87 100644 --- a/aspose_barcode_cloud/models/encode_data.py +++ b/aspose_barcode_cloud/models/encode_data.py @@ -58,7 +58,7 @@ def data_type(self, data_type): def data(self): """Gets the data of this EncodeData. # noqa: E501 - String represents data to encode # noqa: E501 + String that represents the data to encode. # noqa: E501 :return: The data of this EncodeData. # noqa: E501 :rtype: str @@ -69,7 +69,7 @@ def data(self): def data(self, data): """Sets the data of this EncodeData. - String represents data to encode # noqa: E501 + String that represents the data to encode. # noqa: E501 :param data: The data of this EncodeData. # noqa: E501 :type: str diff --git a/aspose_barcode_cloud/models/generate_params.py b/aspose_barcode_cloud/models/generate_params.py index c70b505..deb012f 100644 --- a/aspose_barcode_cloud/models/generate_params.py +++ b/aspose_barcode_cloud/models/generate_params.py @@ -22,26 +22,49 @@ class GenerateParams(object): "barcode_type": "EncodeBarcodeType", "encode_data": "EncodeData", "barcode_image_params": "BarcodeImageParams", + "qr_params": "QrParams", + "code128_params": "Code128Params", + "pdf417_params": "Pdf417Params", } attribute_map = { "barcode_type": "barcodeType", "encode_data": "encodeData", "barcode_image_params": "barcodeImageParams", + "qr_params": "qrParams", + "code128_params": "code128Params", + "pdf417_params": "pdf417Params", } - def __init__(self, barcode_type=None, encode_data=None, barcode_image_params=None): # noqa: E501 + def __init__( + self, + barcode_type=None, + encode_data=None, + barcode_image_params=None, + qr_params=None, + code128_params=None, + pdf417_params=None, + ): # noqa: E501 """GenerateParams - a model defined in Swagger""" # noqa: E501 self._barcode_type = None self._encode_data = None self._barcode_image_params = None + self._qr_params = None + self._code128_params = None + self._pdf417_params = None self.discriminator = None self.barcode_type = barcode_type self.encode_data = encode_data if barcode_image_params is not None: self.barcode_image_params = barcode_image_params + if qr_params is not None: + self.qr_params = qr_params + if code128_params is not None: + self.code128_params = code128_params + if pdf417_params is not None: + self.pdf417_params = pdf417_params @property def barcode_type(self): @@ -110,6 +133,69 @@ def barcode_image_params(self, barcode_image_params): self._barcode_image_params = barcode_image_params + @property + def qr_params(self): + """Gets the qr_params of this GenerateParams. # noqa: E501 + + + :return: The qr_params of this GenerateParams. # noqa: E501 + :rtype: QrParams + """ + return self._qr_params + + @qr_params.setter + def qr_params(self, qr_params): + """Sets the qr_params of this GenerateParams. + + + :param qr_params: The qr_params of this GenerateParams. # noqa: E501 + :type: QrParams + """ + + self._qr_params = qr_params + + @property + def code128_params(self): + """Gets the code128_params of this GenerateParams. # noqa: E501 + + + :return: The code128_params of this GenerateParams. # noqa: E501 + :rtype: Code128Params + """ + return self._code128_params + + @code128_params.setter + def code128_params(self, code128_params): + """Sets the code128_params of this GenerateParams. + + + :param code128_params: The code128_params of this GenerateParams. # noqa: E501 + :type: Code128Params + """ + + self._code128_params = code128_params + + @property + def pdf417_params(self): + """Gets the pdf417_params of this GenerateParams. # noqa: E501 + + + :return: The pdf417_params of this GenerateParams. # noqa: E501 + :rtype: Pdf417Params + """ + return self._pdf417_params + + @pdf417_params.setter + def pdf417_params(self, pdf417_params): + """Sets the pdf417_params of this GenerateParams. + + + :param pdf417_params: The pdf417_params of this GenerateParams. # noqa: E501 + :type: Pdf417Params + """ + + self._pdf417_params = pdf417_params + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/aspose_barcode_cloud/models/macro_character.py b/aspose_barcode_cloud/models/macro_character.py new file mode 100644 index 0000000..8f40c03 --- /dev/null +++ b/aspose_barcode_cloud/models/macro_character.py @@ -0,0 +1,78 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class MacroCharacter(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + NONE = "None" + MACRO05 = "Macro05" + MACRO06 = "Macro06" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """MacroCharacter - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(MacroCharacter, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, MacroCharacter): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/micro_qr_version.py b/aspose_barcode_cloud/models/micro_qr_version.py new file mode 100644 index 0000000..143198d --- /dev/null +++ b/aspose_barcode_cloud/models/micro_qr_version.py @@ -0,0 +1,80 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class MicroQRVersion(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + AUTO = "Auto" + M1 = "M1" + M2 = "M2" + M3 = "M3" + M4 = "M4" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """MicroQRVersion - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(MicroQRVersion, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, MicroQRVersion): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/pdf417_encode_mode.py b/aspose_barcode_cloud/models/pdf417_encode_mode.py new file mode 100644 index 0000000..ffe9313 --- /dev/null +++ b/aspose_barcode_cloud/models/pdf417_encode_mode.py @@ -0,0 +1,79 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class Pdf417EncodeMode(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + AUTO = "Auto" + BINARY = "Binary" + ECI = "ECI" + EXTENDED = "Extended" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """Pdf417EncodeMode - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(Pdf417EncodeMode, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Pdf417EncodeMode): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/pdf417_error_level.py b/aspose_barcode_cloud/models/pdf417_error_level.py new file mode 100644 index 0000000..531943c --- /dev/null +++ b/aspose_barcode_cloud/models/pdf417_error_level.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class Pdf417ErrorLevel(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + LEVEL0 = "Level0" + LEVEL1 = "Level1" + LEVEL2 = "Level2" + LEVEL3 = "Level3" + LEVEL4 = "Level4" + LEVEL5 = "Level5" + LEVEL6 = "Level6" + LEVEL7 = "Level7" + LEVEL8 = "Level8" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """Pdf417ErrorLevel - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(Pdf417ErrorLevel, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Pdf417ErrorLevel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/pdf417_params.py b/aspose_barcode_cloud/models/pdf417_params.py new file mode 100644 index 0000000..b41910b --- /dev/null +++ b/aspose_barcode_cloud/models/pdf417_params.py @@ -0,0 +1,412 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class Pdf417Params(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + "pdf417_encode_mode": "Pdf417EncodeMode", + "pdf417_error_level": "Pdf417ErrorLevel", + "pdf417_truncate": "bool", + "pdf417_columns": "int", + "pdf417_rows": "int", + "pdf417_aspect_ratio": "float", + "pdf417_eci_encoding": "ECIEncodings", + "pdf417_is_reader_initialization": "bool", + "pdf417_macro_characters": "MacroCharacter", + "pdf417_is_linked": "bool", + "pdf417_is_code128_emulation": "bool", + } + + attribute_map = { + "pdf417_encode_mode": "pdf417EncodeMode", + "pdf417_error_level": "pdf417ErrorLevel", + "pdf417_truncate": "pdf417Truncate", + "pdf417_columns": "pdf417Columns", + "pdf417_rows": "pdf417Rows", + "pdf417_aspect_ratio": "pdf417AspectRatio", + "pdf417_eci_encoding": "pdf417ECIEncoding", + "pdf417_is_reader_initialization": "pdf417IsReaderInitialization", + "pdf417_macro_characters": "pdf417MacroCharacters", + "pdf417_is_linked": "pdf417IsLinked", + "pdf417_is_code128_emulation": "pdf417IsCode128Emulation", + } + + def __init__( + self, + pdf417_encode_mode=None, + pdf417_error_level=None, + pdf417_truncate=None, + pdf417_columns=None, + pdf417_rows=None, + pdf417_aspect_ratio=None, + pdf417_eci_encoding=None, + pdf417_is_reader_initialization=None, + pdf417_macro_characters=None, + pdf417_is_linked=None, + pdf417_is_code128_emulation=None, + ): # noqa: E501 + """Pdf417Params - a model defined in Swagger""" # noqa: E501 + + self._pdf417_encode_mode = None + self._pdf417_error_level = None + self._pdf417_truncate = None + self._pdf417_columns = None + self._pdf417_rows = None + self._pdf417_aspect_ratio = None + self._pdf417_eci_encoding = None + self._pdf417_is_reader_initialization = None + self._pdf417_macro_characters = None + self._pdf417_is_linked = None + self._pdf417_is_code128_emulation = None + self.discriminator = None + + if pdf417_encode_mode is not None: + self.pdf417_encode_mode = pdf417_encode_mode + if pdf417_error_level is not None: + self.pdf417_error_level = pdf417_error_level + if pdf417_truncate is not None: + self.pdf417_truncate = pdf417_truncate + if pdf417_columns is not None: + self.pdf417_columns = pdf417_columns + if pdf417_rows is not None: + self.pdf417_rows = pdf417_rows + if pdf417_aspect_ratio is not None: + self.pdf417_aspect_ratio = pdf417_aspect_ratio + if pdf417_eci_encoding is not None: + self.pdf417_eci_encoding = pdf417_eci_encoding + if pdf417_is_reader_initialization is not None: + self.pdf417_is_reader_initialization = pdf417_is_reader_initialization + if pdf417_macro_characters is not None: + self.pdf417_macro_characters = pdf417_macro_characters + if pdf417_is_linked is not None: + self.pdf417_is_linked = pdf417_is_linked + if pdf417_is_code128_emulation is not None: + self.pdf417_is_code128_emulation = pdf417_is_code128_emulation + + @property + def pdf417_encode_mode(self): + """Gets the pdf417_encode_mode of this Pdf417Params. # noqa: E501 + + + :return: The pdf417_encode_mode of this Pdf417Params. # noqa: E501 + :rtype: Pdf417EncodeMode + """ + return self._pdf417_encode_mode + + @pdf417_encode_mode.setter + def pdf417_encode_mode(self, pdf417_encode_mode): + """Sets the pdf417_encode_mode of this Pdf417Params. + + + :param pdf417_encode_mode: The pdf417_encode_mode of this Pdf417Params. # noqa: E501 + :type: Pdf417EncodeMode + """ + + self._pdf417_encode_mode = pdf417_encode_mode + + @property + def pdf417_error_level(self): + """Gets the pdf417_error_level of this Pdf417Params. # noqa: E501 + + + :return: The pdf417_error_level of this Pdf417Params. # noqa: E501 + :rtype: Pdf417ErrorLevel + """ + return self._pdf417_error_level + + @pdf417_error_level.setter + def pdf417_error_level(self, pdf417_error_level): + """Sets the pdf417_error_level of this Pdf417Params. + + + :param pdf417_error_level: The pdf417_error_level of this Pdf417Params. # noqa: E501 + :type: Pdf417ErrorLevel + """ + + self._pdf417_error_level = pdf417_error_level + + @property + def pdf417_truncate(self): + """Gets the pdf417_truncate of this Pdf417Params. # noqa: E501 + + Whether to use truncated PDF417 format (removes right-side stop pattern). # noqa: E501 + + :return: The pdf417_truncate of this Pdf417Params. # noqa: E501 + :rtype: bool + """ + return self._pdf417_truncate + + @pdf417_truncate.setter + def pdf417_truncate(self, pdf417_truncate): + """Sets the pdf417_truncate of this Pdf417Params. + + Whether to use truncated PDF417 format (removes right-side stop pattern). # noqa: E501 + + :param pdf417_truncate: The pdf417_truncate of this Pdf417Params. # noqa: E501 + :type: bool + """ + + self._pdf417_truncate = pdf417_truncate + + @property + def pdf417_columns(self): + """Gets the pdf417_columns of this Pdf417Params. # noqa: E501 + + Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. # noqa: E501 + + :return: The pdf417_columns of this Pdf417Params. # noqa: E501 + :rtype: int + """ + return self._pdf417_columns + + @pdf417_columns.setter + def pdf417_columns(self, pdf417_columns): + """Sets the pdf417_columns of this Pdf417Params. + + Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. # noqa: E501 + + :param pdf417_columns: The pdf417_columns of this Pdf417Params. # noqa: E501 + :type: int + """ + if pdf417_columns is not None and pdf417_columns > 30: # noqa: E501 + raise ValueError( + "Invalid value for `pdf417_columns`, must be a value less than or equal to `30`" + ) # noqa: E501 + if pdf417_columns is not None and pdf417_columns < 0: # noqa: E501 + raise ValueError( + "Invalid value for `pdf417_columns`, must be a value greater than or equal to `0`" + ) # noqa: E501 + + self._pdf417_columns = pdf417_columns + + @property + def pdf417_rows(self): + """Gets the pdf417_rows of this Pdf417Params. # noqa: E501 + + Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. # noqa: E501 + + :return: The pdf417_rows of this Pdf417Params. # noqa: E501 + :rtype: int + """ + return self._pdf417_rows + + @pdf417_rows.setter + def pdf417_rows(self, pdf417_rows): + """Sets the pdf417_rows of this Pdf417Params. + + Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. # noqa: E501 + + :param pdf417_rows: The pdf417_rows of this Pdf417Params. # noqa: E501 + :type: int + """ + if pdf417_rows is not None and pdf417_rows > 90: # noqa: E501 + raise ValueError( + "Invalid value for `pdf417_rows`, must be a value less than or equal to `90`" + ) # noqa: E501 + if pdf417_rows is not None and pdf417_rows < 0: # noqa: E501 + raise ValueError( + "Invalid value for `pdf417_rows`, must be a value greater than or equal to `0`" + ) # noqa: E501 + + self._pdf417_rows = pdf417_rows + + @property + def pdf417_aspect_ratio(self): + """Gets the pdf417_aspect_ratio of this Pdf417Params. # noqa: E501 + + 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. # noqa: E501 + + :return: The pdf417_aspect_ratio of this Pdf417Params. # noqa: E501 + :rtype: float + """ + return self._pdf417_aspect_ratio + + @pdf417_aspect_ratio.setter + def pdf417_aspect_ratio(self, pdf417_aspect_ratio): + """Sets the pdf417_aspect_ratio of this Pdf417Params. + + 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. # noqa: E501 + + :param pdf417_aspect_ratio: The pdf417_aspect_ratio of this Pdf417Params. # noqa: E501 + :type: float + """ + if pdf417_aspect_ratio is not None and pdf417_aspect_ratio > 10: # noqa: E501 + raise ValueError( + "Invalid value for `pdf417_aspect_ratio`, must be a value less than or equal to `10`" + ) # noqa: E501 + if pdf417_aspect_ratio is not None and pdf417_aspect_ratio < 2: # noqa: E501 + raise ValueError( + "Invalid value for `pdf417_aspect_ratio`, must be a value greater than or equal to `2`" + ) # noqa: E501 + + self._pdf417_aspect_ratio = pdf417_aspect_ratio + + @property + def pdf417_eci_encoding(self): + """Gets the pdf417_eci_encoding of this Pdf417Params. # noqa: E501 + + + :return: The pdf417_eci_encoding of this Pdf417Params. # noqa: E501 + :rtype: ECIEncodings + """ + return self._pdf417_eci_encoding + + @pdf417_eci_encoding.setter + def pdf417_eci_encoding(self, pdf417_eci_encoding): + """Sets the pdf417_eci_encoding of this Pdf417Params. + + + :param pdf417_eci_encoding: The pdf417_eci_encoding of this Pdf417Params. # noqa: E501 + :type: ECIEncodings + """ + + self._pdf417_eci_encoding = pdf417_eci_encoding + + @property + def pdf417_is_reader_initialization(self): + """Gets the pdf417_is_reader_initialization of this Pdf417Params. # noqa: E501 + + Whether the barcode is used for reader initialization (programming). # noqa: E501 + + :return: The pdf417_is_reader_initialization of this Pdf417Params. # noqa: E501 + :rtype: bool + """ + return self._pdf417_is_reader_initialization + + @pdf417_is_reader_initialization.setter + def pdf417_is_reader_initialization(self, pdf417_is_reader_initialization): + """Sets the pdf417_is_reader_initialization of this Pdf417Params. + + Whether the barcode is used for reader initialization (programming). # noqa: E501 + + :param pdf417_is_reader_initialization: The pdf417_is_reader_initialization of this Pdf417Params. # noqa: E501 + :type: bool + """ + + self._pdf417_is_reader_initialization = pdf417_is_reader_initialization + + @property + def pdf417_macro_characters(self): + """Gets the pdf417_macro_characters of this Pdf417Params. # noqa: E501 + + + :return: The pdf417_macro_characters of this Pdf417Params. # noqa: E501 + :rtype: MacroCharacter + """ + return self._pdf417_macro_characters + + @pdf417_macro_characters.setter + def pdf417_macro_characters(self, pdf417_macro_characters): + """Sets the pdf417_macro_characters of this Pdf417Params. + + + :param pdf417_macro_characters: The pdf417_macro_characters of this Pdf417Params. # noqa: E501 + :type: MacroCharacter + """ + + self._pdf417_macro_characters = pdf417_macro_characters + + @property + def pdf417_is_linked(self): + """Gets the pdf417_is_linked of this Pdf417Params. # noqa: E501 + + Whether to use linked mode (for MicroPdf417). # noqa: E501 + + :return: The pdf417_is_linked of this Pdf417Params. # noqa: E501 + :rtype: bool + """ + return self._pdf417_is_linked + + @pdf417_is_linked.setter + def pdf417_is_linked(self, pdf417_is_linked): + """Sets the pdf417_is_linked of this Pdf417Params. + + Whether to use linked mode (for MicroPdf417). # noqa: E501 + + :param pdf417_is_linked: The pdf417_is_linked of this Pdf417Params. # noqa: E501 + :type: bool + """ + + self._pdf417_is_linked = pdf417_is_linked + + @property + def pdf417_is_code128_emulation(self): + """Gets the pdf417_is_code128_emulation of this Pdf417Params. # noqa: E501 + + Whether to use Code128 emulation for MicroPdf417. # noqa: E501 + + :return: The pdf417_is_code128_emulation of this Pdf417Params. # noqa: E501 + :rtype: bool + """ + return self._pdf417_is_code128_emulation + + @pdf417_is_code128_emulation.setter + def pdf417_is_code128_emulation(self, pdf417_is_code128_emulation): + """Sets the pdf417_is_code128_emulation of this Pdf417Params. + + Whether to use Code128 emulation for MicroPdf417. # noqa: E501 + + :param pdf417_is_code128_emulation: The pdf417_is_code128_emulation of this Pdf417Params. # noqa: E501 + :type: bool + """ + + self._pdf417_is_code128_emulation = pdf417_is_code128_emulation + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(Pdf417Params, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Pdf417Params): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/qr_encode_mode.py b/aspose_barcode_cloud/models/qr_encode_mode.py new file mode 100644 index 0000000..553632d --- /dev/null +++ b/aspose_barcode_cloud/models/qr_encode_mode.py @@ -0,0 +1,79 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class QREncodeMode(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + AUTO = "Auto" + EXTENDED = "Extended" + BINARY = "Binary" + ECI = "ECI" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """QREncodeMode - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(QREncodeMode, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, QREncodeMode): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/qr_error_level.py b/aspose_barcode_cloud/models/qr_error_level.py new file mode 100644 index 0000000..67b60f0 --- /dev/null +++ b/aspose_barcode_cloud/models/qr_error_level.py @@ -0,0 +1,79 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class QRErrorLevel(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + LEVELL = "LevelL" + LEVELM = "LevelM" + LEVELQ = "LevelQ" + LEVELH = "LevelH" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """QRErrorLevel - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(QRErrorLevel, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, QRErrorLevel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/qr_params.py b/aspose_barcode_cloud/models/qr_params.py new file mode 100644 index 0000000..8274091 --- /dev/null +++ b/aspose_barcode_cloud/models/qr_params.py @@ -0,0 +1,276 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class QrParams(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + "qr_encode_mode": "QREncodeMode", + "qr_error_level": "QRErrorLevel", + "qr_version": "QRVersion", + "qr_eci_encoding": "ECIEncodings", + "qr_aspect_ratio": "float", + "micro_qr_version": "MicroQRVersion", + "rect_micro_qr_version": "RectMicroQRVersion", + } + + attribute_map = { + "qr_encode_mode": "qrEncodeMode", + "qr_error_level": "qrErrorLevel", + "qr_version": "qrVersion", + "qr_eci_encoding": "qrECIEncoding", + "qr_aspect_ratio": "qrAspectRatio", + "micro_qr_version": "microQRVersion", + "rect_micro_qr_version": "rectMicroQrVersion", + } + + def __init__( + self, + qr_encode_mode=None, + qr_error_level=None, + qr_version=None, + qr_eci_encoding=None, + qr_aspect_ratio=None, + micro_qr_version=None, + rect_micro_qr_version=None, + ): # noqa: E501 + """QrParams - a model defined in Swagger""" # noqa: E501 + + self._qr_encode_mode = None + self._qr_error_level = None + self._qr_version = None + self._qr_eci_encoding = None + self._qr_aspect_ratio = None + self._micro_qr_version = None + self._rect_micro_qr_version = None + self.discriminator = None + + if qr_encode_mode is not None: + self.qr_encode_mode = qr_encode_mode + if qr_error_level is not None: + self.qr_error_level = qr_error_level + if qr_version is not None: + self.qr_version = qr_version + if qr_eci_encoding is not None: + self.qr_eci_encoding = qr_eci_encoding + if qr_aspect_ratio is not None: + self.qr_aspect_ratio = qr_aspect_ratio + if micro_qr_version is not None: + self.micro_qr_version = micro_qr_version + if rect_micro_qr_version is not None: + self.rect_micro_qr_version = rect_micro_qr_version + + @property + def qr_encode_mode(self): + """Gets the qr_encode_mode of this QrParams. # noqa: E501 + + + :return: The qr_encode_mode of this QrParams. # noqa: E501 + :rtype: QREncodeMode + """ + return self._qr_encode_mode + + @qr_encode_mode.setter + def qr_encode_mode(self, qr_encode_mode): + """Sets the qr_encode_mode of this QrParams. + + + :param qr_encode_mode: The qr_encode_mode of this QrParams. # noqa: E501 + :type: QREncodeMode + """ + + self._qr_encode_mode = qr_encode_mode + + @property + def qr_error_level(self): + """Gets the qr_error_level of this QrParams. # noqa: E501 + + + :return: The qr_error_level of this QrParams. # noqa: E501 + :rtype: QRErrorLevel + """ + return self._qr_error_level + + @qr_error_level.setter + def qr_error_level(self, qr_error_level): + """Sets the qr_error_level of this QrParams. + + + :param qr_error_level: The qr_error_level of this QrParams. # noqa: E501 + :type: QRErrorLevel + """ + + self._qr_error_level = qr_error_level + + @property + def qr_version(self): + """Gets the qr_version of this QrParams. # noqa: E501 + + + :return: The qr_version of this QrParams. # noqa: E501 + :rtype: QRVersion + """ + return self._qr_version + + @qr_version.setter + def qr_version(self, qr_version): + """Sets the qr_version of this QrParams. + + + :param qr_version: The qr_version of this QrParams. # noqa: E501 + :type: QRVersion + """ + + self._qr_version = qr_version + + @property + def qr_eci_encoding(self): + """Gets the qr_eci_encoding of this QrParams. # noqa: E501 + + + :return: The qr_eci_encoding of this QrParams. # noqa: E501 + :rtype: ECIEncodings + """ + return self._qr_eci_encoding + + @qr_eci_encoding.setter + def qr_eci_encoding(self, qr_eci_encoding): + """Sets the qr_eci_encoding of this QrParams. + + + :param qr_eci_encoding: The qr_eci_encoding of this QrParams. # noqa: E501 + :type: ECIEncodings + """ + + self._qr_eci_encoding = qr_eci_encoding + + @property + def qr_aspect_ratio(self): + """Gets the qr_aspect_ratio of this QrParams. # noqa: E501 + + QR barcode aspect ratio. Values: 0 to 1. # noqa: E501 + + :return: The qr_aspect_ratio of this QrParams. # noqa: E501 + :rtype: float + """ + return self._qr_aspect_ratio + + @qr_aspect_ratio.setter + def qr_aspect_ratio(self, qr_aspect_ratio): + """Sets the qr_aspect_ratio of this QrParams. + + QR barcode aspect ratio. Values: 0 to 1. # noqa: E501 + + :param qr_aspect_ratio: The qr_aspect_ratio of this QrParams. # noqa: E501 + :type: float + """ + if qr_aspect_ratio is not None and qr_aspect_ratio > 1: # noqa: E501 + raise ValueError( + "Invalid value for `qr_aspect_ratio`, must be a value less than or equal to `1`" + ) # noqa: E501 + if qr_aspect_ratio is not None and qr_aspect_ratio < 0.001: # noqa: E501 + raise ValueError( + "Invalid value for `qr_aspect_ratio`, must be a value greater than or equal to `0.001`" + ) # noqa: E501 + + self._qr_aspect_ratio = qr_aspect_ratio + + @property + def micro_qr_version(self): + """Gets the micro_qr_version of this QrParams. # noqa: E501 + + + :return: The micro_qr_version of this QrParams. # noqa: E501 + :rtype: MicroQRVersion + """ + return self._micro_qr_version + + @micro_qr_version.setter + def micro_qr_version(self, micro_qr_version): + """Sets the micro_qr_version of this QrParams. + + + :param micro_qr_version: The micro_qr_version of this QrParams. # noqa: E501 + :type: MicroQRVersion + """ + + self._micro_qr_version = micro_qr_version + + @property + def rect_micro_qr_version(self): + """Gets the rect_micro_qr_version of this QrParams. # noqa: E501 + + + :return: The rect_micro_qr_version of this QrParams. # noqa: E501 + :rtype: RectMicroQRVersion + """ + return self._rect_micro_qr_version + + @rect_micro_qr_version.setter + def rect_micro_qr_version(self, rect_micro_qr_version): + """Sets the rect_micro_qr_version of this QrParams. + + + :param rect_micro_qr_version: The rect_micro_qr_version of this QrParams. # noqa: E501 + :type: RectMicroQRVersion + """ + + self._rect_micro_qr_version = rect_micro_qr_version + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(QrParams, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, QrParams): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/qr_version.py b/aspose_barcode_cloud/models/qr_version.py new file mode 100644 index 0000000..e63efdc --- /dev/null +++ b/aspose_barcode_cloud/models/qr_version.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class QRVersion(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + AUTO = "Auto" + VERSION01 = "Version01" + VERSION02 = "Version02" + VERSION03 = "Version03" + VERSION04 = "Version04" + VERSION05 = "Version05" + VERSION06 = "Version06" + VERSION07 = "Version07" + VERSION08 = "Version08" + VERSION09 = "Version09" + VERSION10 = "Version10" + VERSION11 = "Version11" + VERSION12 = "Version12" + VERSION13 = "Version13" + VERSION14 = "Version14" + VERSION15 = "Version15" + VERSION16 = "Version16" + VERSION17 = "Version17" + VERSION18 = "Version18" + VERSION19 = "Version19" + VERSION20 = "Version20" + VERSION21 = "Version21" + VERSION22 = "Version22" + VERSION23 = "Version23" + VERSION24 = "Version24" + VERSION25 = "Version25" + VERSION26 = "Version26" + VERSION27 = "Version27" + VERSION28 = "Version28" + VERSION29 = "Version29" + VERSION30 = "Version30" + VERSION31 = "Version31" + VERSION32 = "Version32" + VERSION33 = "Version33" + VERSION34 = "Version34" + VERSION35 = "Version35" + VERSION36 = "Version36" + VERSION37 = "Version37" + VERSION38 = "Version38" + VERSION39 = "Version39" + VERSION40 = "Version40" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """QRVersion - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(QRVersion, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, QRVersion): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/aspose_barcode_cloud/models/recognize_base64_request.py b/aspose_barcode_cloud/models/recognize_base64_request.py index 43e45eb..e270cc6 100644 --- a/aspose_barcode_cloud/models/recognize_base64_request.py +++ b/aspose_barcode_cloud/models/recognize_base64_request.py @@ -54,7 +54,7 @@ def __init__( def barcode_types(self): """Gets the barcode_types of this RecognizeBase64Request. # noqa: E501 - Array of decode types to find on barcode # noqa: E501 + Array of barcode decode types to find. # noqa: E501 :return: The barcode_types of this RecognizeBase64Request. # noqa: E501 :rtype: List[DecodeBarcodeType] @@ -65,7 +65,7 @@ def barcode_types(self): def barcode_types(self, barcode_types): """Sets the barcode_types of this RecognizeBase64Request. - Array of decode types to find on barcode # noqa: E501 + Array of barcode decode types to find. # noqa: E501 :param barcode_types: The barcode_types of this RecognizeBase64Request. # noqa: E501 :type: List[DecodeBarcodeType] diff --git a/aspose_barcode_cloud/models/rect_micro_qr_version.py b/aspose_barcode_cloud/models/rect_micro_qr_version.py new file mode 100644 index 0000000..58c49f8 --- /dev/null +++ b/aspose_barcode_cloud/models/rect_micro_qr_version.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +import pprint +import re # noqa: F401 +import warnings # noqa: F401 + + +class RectMicroQRVersion(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + allowed enum values + """ + AUTO = "Auto" + R7X43 = "R7x43" + R7X59 = "R7x59" + R7X77 = "R7x77" + R7X99 = "R7x99" + R7X139 = "R7x139" + R9X43 = "R9x43" + R9X59 = "R9x59" + R9X77 = "R9x77" + R9X99 = "R9x99" + R9X139 = "R9x139" + R11X27 = "R11x27" + R11X43 = "R11x43" + R11X59 = "R11x59" + R11X77 = "R11x77" + R11X99 = "R11x99" + R11X139 = "R11x139" + R13X27 = "R13x27" + R13X43 = "R13x43" + R13X59 = "R13x59" + R13X77 = "R13x77" + R13X99 = "R13x99" + R13X139 = "R13x139" + R15X43 = "R15x43" + R15X59 = "R15x59" + R15X77 = "R15x77" + R15X99 = "R15x99" + R15X139 = "R15x139" + R17X43 = "R17x43" + R17X59 = "R17x59" + R17X77 = "R17x77" + R17X99 = "R17x99" + R17X139 = "R17x139" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = {} + + attribute_map = {} + + def __init__(self): # noqa: E501 + """RectMicroQRVersion - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr in self.swagger_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict( + map( + lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, + value.items(), + ) + ) + else: + result[attr] = value + if issubclass(RectMicroQRVersion, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RectMicroQRVersion): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/docs/BarcodeImageParams.md b/docs/BarcodeImageParams.md index a4028fb..a102d8c 100644 --- a/docs/BarcodeImageParams.md +++ b/docs/BarcodeImageParams.md @@ -1,6 +1,6 @@ # BarcodeImageParams -Barcode image optional parameters +Optional barcode image parameters. ## Properties @@ -8,12 +8,12 @@ Name | Type | Description | Notes ---- | ---- | ----------- | ----- **image_format** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | | [optional] **text_location** | [**CodeLocation**](CodeLocation.md) | | [optional] -**foreground_color** | **str** | Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. | [optional] [default to 'Black'] -**background_color** | **str** | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. | [optional] [default to 'White'] +**foreground_color** | **str** | 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'] +**background_color** | **str** | 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] -**resolution** | **float** | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. | [optional] -**image_height** | **float** | Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. | [optional] -**image_width** | **float** | Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. | [optional] -**rotation_angle** | **int** | BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional] +**resolution** | **float** | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional] +**image_height** | **float** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] +**image_width** | **float** | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] +**rotation_angle** | **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] [[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/BarcodeResponse.md b/docs/BarcodeResponse.md index 47a98db..e712d9a 100644 --- a/docs/BarcodeResponse.md +++ b/docs/BarcodeResponse.md @@ -1,6 +1,6 @@ # BarcodeResponse -Represents information about barcode. +Represents information about a barcode. ## Properties @@ -8,7 +8,7 @@ Name | Type | Description | Notes ---- | ---- | ----------- | ----- **barcode_value** | **str** | Barcode data. | [optional] **type** | **str** | Type of the barcode. | [optional] -**region** | [**List[RegionPoint]**](RegionPoint.md) | Region with barcode. | [optional] -**checksum** | **str** | Checksum of barcode. | [optional] +**region** | [**List[RegionPoint]**](RegionPoint.md) | Region with the barcode. | [optional] +**checksum** | **str** | Checksum of the barcode. | [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/BarcodeResponseList.md b/docs/BarcodeResponseList.md index 3c9fdd4..7ff124a 100644 --- a/docs/BarcodeResponseList.md +++ b/docs/BarcodeResponseList.md @@ -1,11 +1,11 @@ # BarcodeResponseList -Represents information about barcode list. +Represents information about a barcode list. ## Properties Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**barcodes** | [**List[BarcodeResponse]**](BarcodeResponse.md) | List of barcodes which are present in image. | +**barcodes** | [**List[BarcodeResponse]**](BarcodeResponse.md) | List of barcodes that are present in the image. | [[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/Code128EncodeMode.md b/docs/Code128EncodeMode.md new file mode 100644 index 0000000..49be972 --- /dev/null +++ b/docs/Code128EncodeMode.md @@ -0,0 +1,14 @@ +# Code128EncodeMode + +Code128 barcode encode mode. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/code128encodemode/ +## Allowable values + +* **Code128EncodeMode.AUTO** +* Code128EncodeMode.CODEA +* Code128EncodeMode.CODEB +* Code128EncodeMode.CODEAB +* Code128EncodeMode.CODEC +* Code128EncodeMode.CODEAC +* Code128EncodeMode.CODEBC + +[[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/Code128Params.md b/docs/Code128Params.md new file mode 100644 index 0000000..8d56379 --- /dev/null +++ b/docs/Code128Params.md @@ -0,0 +1,11 @@ +# Code128Params + +Optional Code128 barcode generation parameters. + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**code128_encode_mode** | [**Code128EncodeMode**](Code128EncodeMode.md) | | [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/DecodeBarcodeType.md b/docs/DecodeBarcodeType.md index 6272ca7..0898f95 100644 --- a/docs/DecodeBarcodeType.md +++ b/docs/DecodeBarcodeType.md @@ -1,6 +1,6 @@ # DecodeBarcodeType -See Aspose.BarCode.BarCodeRecognition.DecodeType +See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ ## Allowable values * **DecodeBarcodeType.MOSTCOMMONLYUSED** diff --git a/docs/ECIEncodings.md b/docs/ECIEncodings.md new file mode 100644 index 0000000..1adc2e5 --- /dev/null +++ b/docs/ECIEncodings.md @@ -0,0 +1,41 @@ +# ECIEncodings + +ECI encoding identifiers. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/eciencodings/ +## Allowable values + +* **ECIEncodings.NONE** +* ECIEncodings.ISO_8859_1 +* ECIEncodings.ISO_8859_2 +* ECIEncodings.ISO_8859_3 +* ECIEncodings.ISO_8859_4 +* ECIEncodings.ISO_8859_5 +* ECIEncodings.ISO_8859_6 +* ECIEncodings.ISO_8859_7 +* ECIEncodings.ISO_8859_8 +* ECIEncodings.ISO_8859_9 +* ECIEncodings.ISO_8859_10 +* ECIEncodings.ISO_8859_11 +* ECIEncodings.ISO_8859_13 +* ECIEncodings.ISO_8859_14 +* ECIEncodings.ISO_8859_15 +* ECIEncodings.ISO_8859_16 +* ECIEncodings.SHIFT_JIS +* ECIEncodings.WIN1250 +* ECIEncodings.WIN1251 +* ECIEncodings.WIN1252 +* ECIEncodings.WIN1256 +* ECIEncodings.UTF16BE +* ECIEncodings.UTF8 +* ECIEncodings.US_ASCII +* ECIEncodings.BIG5 +* ECIEncodings.GB2312 +* ECIEncodings.EUC_KR +* ECIEncodings.GBK +* ECIEncodings.GB18030 +* ECIEncodings.UTF16LE +* ECIEncodings.UTF32BE +* ECIEncodings.UTF32LE +* ECIEncodings.INVARIANT +* ECIEncodings.BINARY + +[[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/EncodeBarcodeType.md b/docs/EncodeBarcodeType.md index 0a8a8c8..dcad05b 100644 --- a/docs/EncodeBarcodeType.md +++ b/docs/EncodeBarcodeType.md @@ -1,6 +1,6 @@ # EncodeBarcodeType -See Aspose.BarCode.Generation.EncodeTypes +See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ ## Allowable values * **EncodeBarcodeType.QR** diff --git a/docs/EncodeData.md b/docs/EncodeData.md index af22b21..72f3394 100644 --- a/docs/EncodeData.md +++ b/docs/EncodeData.md @@ -1,12 +1,12 @@ # EncodeData -Data to encode in barcode +Data to encode in a barcode. ## Properties Name | Type | Description | Notes ---- | ---- | ----------- | ----- **data_type** | [**EncodeDataType**](EncodeDataType.md) | | [optional] -**data** | **str** | String represents data to encode | +**data** | **str** | 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/EncodeDataType.md b/docs/EncodeDataType.md index 828b922..656371b 100644 --- a/docs/EncodeDataType.md +++ b/docs/EncodeDataType.md @@ -1,6 +1,6 @@ # EncodeDataType -Types of data can be encoded to barcode +Types of data that can be encoded into a barcode. ## Allowable values * **EncodeDataType.STRINGDATA** diff --git a/docs/GenerateApi.md b/docs/GenerateApi.md index 01ee9e6..115604f 100644 --- a/docs/GenerateApi.md +++ b/docs/GenerateApi.md @@ -4,15 +4,15 @@ All URIs are relative to *https://api.aspose.cloud/v4.0* Method | HTTP request | Description ------ | ------------ | ----------- -[**generate**](GenerateApi.md#generate) | **GET** /barcode/generate/{barcodeType} | Generate barcode using GET request with parameters in route and query string. -[**generate_body**](GenerateApi.md#generate_body) | **POST** /barcode/generate-body | Generate barcode using POST request with parameters in body in json or xml format. -[**generate_multipart**](GenerateApi.md#generate_multipart) | **POST** /barcode/generate-multipart | Generate barcode using POST request with parameters in multipart form. +[**generate**](GenerateApi.md#generate) | **GET** /barcode/generate/{barcodeType} | Generate a barcode using a GET request with parameters in the route and query string. +[**generate_body**](GenerateApi.md#generate_body) | **POST** /barcode/generate-body | Generate a barcode using a POST request with parameters in the request body in JSON or XML format. +[**generate_multipart**](GenerateApi.md#generate_multipart) | **POST** /barcode/generate-multipart | Generate a barcode using a POST request with parameters in a multipart form. # **generate** -> bytearray generate(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle) +> bytearray generate(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, qr_encode_mode=qr_encode_mode, qr_error_level=qr_error_level, qr_version=qr_version, qr_eci_encoding=qr_eci_encoding, qr_aspect_ratio=qr_aspect_ratio, micro_qr_version=micro_qr_version, rect_micro_qr_version=rect_micro_qr_version, code128_encode_mode=code128_encode_mode, pdf417_encode_mode=pdf417_encode_mode, pdf417_error_level=pdf417_error_level, pdf417_truncate=pdf417_truncate, pdf417_columns=pdf417_columns, pdf417_rows=pdf417_rows, pdf417_aspect_ratio=pdf417_aspect_ratio, pdf417_eci_encoding=pdf417_eci_encoding, pdf417_is_reader_initialization=pdf417_is_reader_initialization, pdf417_macro_characters=pdf417_macro_characters, pdf417_is_linked=pdf417_is_linked, pdf417_is_code128_emulation=pdf417_is_code128_emulation) -Generate barcode using GET request with parameters in route and query string. +Generate a barcode using a GET request with parameters in the route and query string. ### Example ```python @@ -27,21 +27,40 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.GenerateApi(aspose_barcode_cloud.ApiClient(configuration)) barcode_type = aspose_barcode_cloud.EncodeBarcodeType() # EncodeBarcodeType | Type of barcode to generate. -data = 'data_example' # str | String represents data to encode +data = 'data_example' # str | String that represents the data to encode. data_type = aspose_barcode_cloud.EncodeDataType() # EncodeDataType | Type of data to encode. Default value: StringData. (optional) -image_format = aspose_barcode_cloud.BarcodeImageFormat() # BarcodeImageFormat | Barcode output image format. Default value: png (optional) -text_location = aspose_barcode_cloud.CodeLocation() # CodeLocation | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: Depends on BarcodeType. CodeLocation.Below for 1D Barcodes. CodeLocation.None for 2D Barcodes. (optional) -foreground_color = 'Black' # str | Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. (optional) (default to 'Black') -background_color = 'White' # str | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. (optional) (default to 'White') -units = aspose_barcode_cloud.GraphicsUnit() # GraphicsUnit | Common Units for all measuring in query. Default units: pixel. (optional) -resolution = 3.4 # float | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. (optional) -image_height = 3.4 # float | Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. (optional) -image_width = 3.4 # float | Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. (optional) -rotation_angle = 56 # int | BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. (optional) +image_format = aspose_barcode_cloud.BarcodeImageFormat() # BarcodeImageFormat | Barcode output image format. Default value: png. (optional) +text_location = aspose_barcode_cloud.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) +foreground_color = 'Black' # str | 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') +background_color = 'White' # str | 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 = aspose_barcode_cloud.GraphicsUnit() # GraphicsUnit | Common units for all measurements. Default units: pixels. (optional) +resolution = 3.4 # float | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) +image_height = 3.4 # float | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) +image_width = 3.4 # float | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) +rotation_angle = 56 # 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) +qr_encode_mode = aspose_barcode_cloud.QREncodeMode() # QREncodeMode | QR barcode encode mode. (optional) +qr_error_level = aspose_barcode_cloud.QRErrorLevel() # QRErrorLevel | QR barcode error correction level. (optional) +qr_version = aspose_barcode_cloud.QRVersion() # QRVersion | QR barcode version. Automatically selects the smallest version that fits the data. (optional) +qr_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | ECI encoding for QR barcode data. (optional) +qr_aspect_ratio = 3.4 # float | QR barcode aspect ratio. Values: 0 to 1. (optional) +micro_qr_version = aspose_barcode_cloud.MicroQRVersion() # MicroQRVersion | MicroQR barcode version. Used when BarcodeType is MicroQR. (optional) +rect_micro_qr_version = aspose_barcode_cloud.RectMicroQRVersion() # RectMicroQRVersion | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional) +code128_encode_mode = aspose_barcode_cloud.Code128EncodeMode() # Code128EncodeMode | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional) +pdf417_encode_mode = aspose_barcode_cloud.Pdf417EncodeMode() # Pdf417EncodeMode | PDF417 barcode encode mode. (optional) +pdf417_error_level = aspose_barcode_cloud.Pdf417ErrorLevel() # Pdf417ErrorLevel | PDF417 barcode error correction level. (optional) +pdf417_truncate = True # bool | Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) +pdf417_columns = 56 # int | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) +pdf417_rows = 56 # int | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) +pdf417_aspect_ratio = 3.4 # 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) +pdf417_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | ECI encoding for PDF417 barcode data. (optional) +pdf417_is_reader_initialization = True # bool | Whether the barcode is used for reader initialization (programming). (optional) +pdf417_macro_characters = aspose_barcode_cloud.MacroCharacter() # MacroCharacter | Macro character to prepend (structured append). (optional) +pdf417_is_linked = True # bool | Whether to use linked mode (for MicroPdf417). (optional) +pdf417_is_code128_emulation = True # bool | Whether to use Code128 emulation for MicroPdf417. (optional) try: - # Generate barcode using GET request with parameters in route and query string. - api_response = api_instance.generate(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle) + # Generate a barcode using a GET request with parameters in the route and query string. + api_response = api_instance.generate(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, qr_encode_mode=qr_encode_mode, qr_error_level=qr_error_level, qr_version=qr_version, qr_eci_encoding=qr_eci_encoding, qr_aspect_ratio=qr_aspect_ratio, micro_qr_version=micro_qr_version, rect_micro_qr_version=rect_micro_qr_version, code128_encode_mode=code128_encode_mode, pdf417_encode_mode=pdf417_encode_mode, pdf417_error_level=pdf417_error_level, pdf417_truncate=pdf417_truncate, pdf417_columns=pdf417_columns, pdf417_rows=pdf417_rows, pdf417_aspect_ratio=pdf417_aspect_ratio, pdf417_eci_encoding=pdf417_eci_encoding, pdf417_is_reader_initialization=pdf417_is_reader_initialization, pdf417_macro_characters=pdf417_macro_characters, pdf417_is_linked=pdf417_is_linked, pdf417_is_code128_emulation=pdf417_is_code128_emulation) pprint(api_response) except ApiException as e: print("Exception when calling GenerateApi->generate: %s\n" % e) @@ -52,17 +71,36 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- **barcode_type** | [**EncodeBarcodeType**](.md)| Type of barcode to generate. | - **data** | **str**| String represents data to encode | + **data** | **str**| String that represents the data to encode. | **data_type** | [**EncodeDataType**](.md)| Type of data to encode. Default value: StringData. | [optional] - **image_format** | [**BarcodeImageFormat**](.md)| Barcode output image format. Default value: png | [optional] - **text_location** | [**CodeLocation**](.md)| Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: Depends on BarcodeType. CodeLocation.Below for 1D Barcodes. CodeLocation.None for 2D Barcodes. | [optional] - **foreground_color** | **str**| Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. | [optional] [default to 'Black'] - **background_color** | **str**| Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. | [optional] [default to 'White'] - **units** | [**GraphicsUnit**](.md)| Common Units for all measuring in query. Default units: pixel. | [optional] - **resolution** | **float**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. | [optional] - **image_height** | **float**| Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. | [optional] - **image_width** | **float**| Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. | [optional] - **rotation_angle** | **int**| BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional] + **image_format** | [**BarcodeImageFormat**](.md)| Barcode output image format. Default value: png. | [optional] + **text_location** | [**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] + **foreground_color** | **str**| 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'] + **background_color** | **str**| 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**](.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] + **image_height** | **float**| Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] + **image_width** | **float**| Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] + **rotation_angle** | **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] + **qr_encode_mode** | [**QREncodeMode**](.md)| QR barcode encode mode. | [optional] + **qr_error_level** | [**QRErrorLevel**](.md)| QR barcode error correction level. | [optional] + **qr_version** | [**QRVersion**](.md)| QR barcode version. Automatically selects the smallest version that fits the data. | [optional] + **qr_eci_encoding** | [**ECIEncodings**](.md)| ECI encoding for QR barcode data. | [optional] + **qr_aspect_ratio** | **float**| QR barcode aspect ratio. Values: 0 to 1. | [optional] + **micro_qr_version** | [**MicroQRVersion**](.md)| MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional] + **rect_micro_qr_version** | [**RectMicroQRVersion**](.md)| RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional] + **code128_encode_mode** | [**Code128EncodeMode**](.md)| Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional] + **pdf417_encode_mode** | [**Pdf417EncodeMode**](.md)| PDF417 barcode encode mode. | [optional] + **pdf417_error_level** | [**Pdf417ErrorLevel**](.md)| PDF417 barcode error correction level. | [optional] + **pdf417_truncate** | **bool**| Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] + **pdf417_columns** | **int**| Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] + **pdf417_rows** | **int**| Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] + **pdf417_aspect_ratio** | **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] + **pdf417_eci_encoding** | [**ECIEncodings**](.md)| ECI encoding for PDF417 barcode data. | [optional] + **pdf417_is_reader_initialization** | **bool**| Whether the barcode is used for reader initialization (programming). | [optional] + **pdf417_macro_characters** | [**MacroCharacter**](.md)| Macro character to prepend (structured append). | [optional] + **pdf417_is_linked** | **bool**| Whether to use linked mode (for MicroPdf417). | [optional] + **pdf417_is_code128_emulation** | **bool**| Whether to use Code128 emulation for MicroPdf417. | [optional] ### Return type @@ -82,7 +120,7 @@ Name | Type | Description | Notes # **generate_body** > bytearray generate_body(generate_params) -Generate barcode using POST request with parameters in body in json or xml format. +Generate a barcode using a POST request with parameters in the request body in JSON or XML format. ### Example ```python @@ -96,10 +134,10 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.GenerateApi(aspose_barcode_cloud.ApiClient(configuration)) -generate_params = aspose_barcode_cloud.GenerateParams() # GenerateParams | Parameters of generation +generate_params = aspose_barcode_cloud.GenerateParams() # GenerateParams | Generation parameters. try: - # Generate barcode using POST request with parameters in body in json or xml format. + # Generate a barcode using a POST request with parameters in the request body in JSON or XML format. api_response = api_instance.generate_body(generate_params) pprint(api_response) except ApiException as e: @@ -110,7 +148,7 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **generate_params** | [**GenerateParams**](GenerateParams.md)| Parameters of generation | + **generate_params** | [**GenerateParams**](GenerateParams.md)| Generation parameters. | ### Return type @@ -128,9 +166,9 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **generate_multipart** -> bytearray generate_multipart(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle) +> bytearray generate_multipart(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, qr_encode_mode=qr_encode_mode, qr_error_level=qr_error_level, qr_version=qr_version, qr_eci_encoding=qr_eci_encoding, qr_aspect_ratio=qr_aspect_ratio, micro_qr_version=micro_qr_version, rect_micro_qr_version=rect_micro_qr_version, code128_encode_mode=code128_encode_mode, pdf417_encode_mode=pdf417_encode_mode, pdf417_error_level=pdf417_error_level, pdf417_truncate=pdf417_truncate, pdf417_columns=pdf417_columns, pdf417_rows=pdf417_rows, pdf417_aspect_ratio=pdf417_aspect_ratio, pdf417_eci_encoding=pdf417_eci_encoding, pdf417_is_reader_initialization=pdf417_is_reader_initialization, pdf417_macro_characters=pdf417_macro_characters, pdf417_is_linked=pdf417_is_linked, pdf417_is_code128_emulation=pdf417_is_code128_emulation) -Generate barcode using POST request with parameters in multipart form. +Generate a barcode using a POST request with parameters in a multipart form. ### Example ```python @@ -145,21 +183,40 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.GenerateApi(aspose_barcode_cloud.ApiClient(configuration)) barcode_type = aspose_barcode_cloud.EncodeBarcodeType() # EncodeBarcodeType | -data = 'data_example' # str | String represents data to encode +data = 'data_example' # str | String that represents the data to encode. data_type = aspose_barcode_cloud.EncodeDataType() # EncodeDataType | (optional) image_format = aspose_barcode_cloud.BarcodeImageFormat() # BarcodeImageFormat | (optional) text_location = aspose_barcode_cloud.CodeLocation() # CodeLocation | (optional) -foreground_color = 'Black' # str | Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. (optional) (default to 'Black') -background_color = 'White' # str | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. (optional) (default to 'White') +foreground_color = 'Black' # str | 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') +background_color = 'White' # str | 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 = aspose_barcode_cloud.GraphicsUnit() # GraphicsUnit | (optional) -resolution = 3.4 # float | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. (optional) -image_height = 3.4 # float | Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. (optional) -image_width = 3.4 # float | Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. (optional) -rotation_angle = 56 # int | BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. (optional) +resolution = 3.4 # float | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) +image_height = 3.4 # float | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) +image_width = 3.4 # float | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) +rotation_angle = 56 # 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) +qr_encode_mode = aspose_barcode_cloud.QREncodeMode() # QREncodeMode | (optional) +qr_error_level = aspose_barcode_cloud.QRErrorLevel() # QRErrorLevel | (optional) +qr_version = aspose_barcode_cloud.QRVersion() # QRVersion | (optional) +qr_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | (optional) +qr_aspect_ratio = 3.4 # float | QR barcode aspect ratio. Values: 0 to 1. (optional) +micro_qr_version = aspose_barcode_cloud.MicroQRVersion() # MicroQRVersion | (optional) +rect_micro_qr_version = aspose_barcode_cloud.RectMicroQRVersion() # RectMicroQRVersion | (optional) +code128_encode_mode = aspose_barcode_cloud.Code128EncodeMode() # Code128EncodeMode | (optional) +pdf417_encode_mode = aspose_barcode_cloud.Pdf417EncodeMode() # Pdf417EncodeMode | (optional) +pdf417_error_level = aspose_barcode_cloud.Pdf417ErrorLevel() # Pdf417ErrorLevel | (optional) +pdf417_truncate = True # bool | Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) +pdf417_columns = 56 # int | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) +pdf417_rows = 56 # int | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) +pdf417_aspect_ratio = 3.4 # 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) +pdf417_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | (optional) +pdf417_is_reader_initialization = True # bool | Whether the barcode is used for reader initialization (programming). (optional) +pdf417_macro_characters = aspose_barcode_cloud.MacroCharacter() # MacroCharacter | (optional) +pdf417_is_linked = True # bool | Whether to use linked mode (for MicroPdf417). (optional) +pdf417_is_code128_emulation = True # bool | Whether to use Code128 emulation for MicroPdf417. (optional) try: - # Generate barcode using POST request with parameters in multipart form. - api_response = api_instance.generate_multipart(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle) + # Generate a barcode using a POST request with parameters in a multipart form. + api_response = api_instance.generate_multipart(barcode_type, data, data_type=data_type, image_format=image_format, text_location=text_location, foreground_color=foreground_color, background_color=background_color, units=units, resolution=resolution, image_height=image_height, image_width=image_width, rotation_angle=rotation_angle, qr_encode_mode=qr_encode_mode, qr_error_level=qr_error_level, qr_version=qr_version, qr_eci_encoding=qr_eci_encoding, qr_aspect_ratio=qr_aspect_ratio, micro_qr_version=micro_qr_version, rect_micro_qr_version=rect_micro_qr_version, code128_encode_mode=code128_encode_mode, pdf417_encode_mode=pdf417_encode_mode, pdf417_error_level=pdf417_error_level, pdf417_truncate=pdf417_truncate, pdf417_columns=pdf417_columns, pdf417_rows=pdf417_rows, pdf417_aspect_ratio=pdf417_aspect_ratio, pdf417_eci_encoding=pdf417_eci_encoding, pdf417_is_reader_initialization=pdf417_is_reader_initialization, pdf417_macro_characters=pdf417_macro_characters, pdf417_is_linked=pdf417_is_linked, pdf417_is_code128_emulation=pdf417_is_code128_emulation) pprint(api_response) except ApiException as e: print("Exception when calling GenerateApi->generate_multipart: %s\n" % e) @@ -170,17 +227,36 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- **barcode_type** | [**EncodeBarcodeType**](EncodeBarcodeType.md)| | - **data** | **str**| String represents data to encode | + **data** | **str**| String that represents the data to encode. | **data_type** | [**EncodeDataType**](EncodeDataType.md)| | [optional] **image_format** | [**BarcodeImageFormat**](BarcodeImageFormat.md)| | [optional] **text_location** | [**CodeLocation**](CodeLocation.md)| | [optional] - **foreground_color** | **str**| Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black. | [optional] [default to 'Black'] - **background_color** | **str**| Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White. | [optional] [default to 'White'] + **foreground_color** | **str**| 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'] + **background_color** | **str**| 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] - **resolution** | **float**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot. | [optional] - **image_height** | **float**| Height of the barcode image in given units. Default units: pixel. Decimal separator is dot. | [optional] - **image_width** | **float**| Width of the barcode image in given units. Default units: pixel. Decimal separator is dot. | [optional] - **rotation_angle** | **int**| BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional] + **resolution** | **float**| Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional] + **image_height** | **float**| Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] + **image_width** | **float**| Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] + **rotation_angle** | **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] + **qr_encode_mode** | [**QREncodeMode**](QREncodeMode.md)| | [optional] + **qr_error_level** | [**QRErrorLevel**](QRErrorLevel.md)| | [optional] + **qr_version** | [**QRVersion**](QRVersion.md)| | [optional] + **qr_eci_encoding** | [**ECIEncodings**](ECIEncodings.md)| | [optional] + **qr_aspect_ratio** | **float**| QR barcode aspect ratio. Values: 0 to 1. | [optional] + **micro_qr_version** | [**MicroQRVersion**](MicroQRVersion.md)| | [optional] + **rect_micro_qr_version** | [**RectMicroQRVersion**](RectMicroQRVersion.md)| | [optional] + **code128_encode_mode** | [**Code128EncodeMode**](Code128EncodeMode.md)| | [optional] + **pdf417_encode_mode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md)| | [optional] + **pdf417_error_level** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md)| | [optional] + **pdf417_truncate** | **bool**| Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] + **pdf417_columns** | **int**| Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] + **pdf417_rows** | **int**| Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] + **pdf417_aspect_ratio** | **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] + **pdf417_eci_encoding** | [**ECIEncodings**](ECIEncodings.md)| | [optional] + **pdf417_is_reader_initialization** | **bool**| Whether the barcode is used for reader initialization (programming). | [optional] + **pdf417_macro_characters** | [**MacroCharacter**](MacroCharacter.md)| | [optional] + **pdf417_is_linked** | **bool**| Whether to use linked mode (for MicroPdf417). | [optional] + **pdf417_is_code128_emulation** | **bool**| Whether to use Code128 emulation for MicroPdf417. | [optional] ### Return type diff --git a/docs/GenerateParams.md b/docs/GenerateParams.md index 484fe36..1cdf492 100644 --- a/docs/GenerateParams.md +++ b/docs/GenerateParams.md @@ -1,6 +1,6 @@ # GenerateParams -Barcode generation parameters +Barcode generation parameters. ## Properties @@ -9,5 +9,8 @@ Name | Type | Description | Notes **barcode_type** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | | **encode_data** | [**EncodeData**](EncodeData.md) | | **barcode_image_params** | [**BarcodeImageParams**](BarcodeImageParams.md) | | [optional] +**qr_params** | [**QrParams**](QrParams.md) | | [optional] +**code128_params** | [**Code128Params**](Code128Params.md) | | [optional] +**pdf417_params** | [**Pdf417Params**](Pdf417Params.md) | | [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/GraphicsUnit.md b/docs/GraphicsUnit.md index e11fddd..f89b08e 100644 --- a/docs/GraphicsUnit.md +++ b/docs/GraphicsUnit.md @@ -1,6 +1,6 @@ # GraphicsUnit -Subset of Aspose.Drawing.GraphicsUnit. +Subset of https://reference.aspose.com/drawing/net/system.drawing/graphicsunit/ ## Allowable values * **GraphicsUnit.PIXEL** diff --git a/docs/MacroCharacter.md b/docs/MacroCharacter.md new file mode 100644 index 0000000..51b74f1 --- /dev/null +++ b/docs/MacroCharacter.md @@ -0,0 +1,10 @@ +# MacroCharacter + +PDF417 macro character mode. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/macrocharacter/ +## Allowable values + +* **MacroCharacter.NONE** +* MacroCharacter.MACRO05 +* MacroCharacter.MACRO06 + +[[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/MicroQRVersion.md b/docs/MicroQRVersion.md new file mode 100644 index 0000000..e9dbc27 --- /dev/null +++ b/docs/MicroQRVersion.md @@ -0,0 +1,12 @@ +# MicroQRVersion + +MicroQR barcode version. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/microqrversion/ +## Allowable values + +* **MicroQRVersion.AUTO** +* MicroQRVersion.M1 +* MicroQRVersion.M2 +* MicroQRVersion.M3 +* MicroQRVersion.M4 + +[[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/Pdf417EncodeMode.md b/docs/Pdf417EncodeMode.md new file mode 100644 index 0000000..778c20c --- /dev/null +++ b/docs/Pdf417EncodeMode.md @@ -0,0 +1,11 @@ +# Pdf417EncodeMode + +PDF417 barcode encode mode. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/pdf417encodemode/ +## Allowable values + +* **Pdf417EncodeMode.AUTO** +* Pdf417EncodeMode.BINARY +* Pdf417EncodeMode.ECI +* Pdf417EncodeMode.EXTENDED + +[[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/Pdf417ErrorLevel.md b/docs/Pdf417ErrorLevel.md new file mode 100644 index 0000000..210d362 --- /dev/null +++ b/docs/Pdf417ErrorLevel.md @@ -0,0 +1,16 @@ +# Pdf417ErrorLevel + +PDF417 barcode error correction level. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/pdf417errorlevel/ +## Allowable values + +* **Pdf417ErrorLevel.LEVEL0** +* Pdf417ErrorLevel.LEVEL1 +* Pdf417ErrorLevel.LEVEL2 +* Pdf417ErrorLevel.LEVEL3 +* Pdf417ErrorLevel.LEVEL4 +* Pdf417ErrorLevel.LEVEL5 +* Pdf417ErrorLevel.LEVEL6 +* Pdf417ErrorLevel.LEVEL7 +* Pdf417ErrorLevel.LEVEL8 + +[[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 new file mode 100644 index 0000000..d405948 --- /dev/null +++ b/docs/Pdf417Params.md @@ -0,0 +1,21 @@ +# Pdf417Params + +Optional PDF417 barcode generation parameters. Applies to Pdf417, MacroPdf417, MicroPdf417, and GS1MicroPdf417 barcode types. + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**pdf417_encode_mode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | | [optional] +**pdf417_error_level** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | | [optional] +**pdf417_truncate** | **bool** | Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] +**pdf417_columns** | **int** | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] +**pdf417_rows** | **int** | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] +**pdf417_aspect_ratio** | **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] +**pdf417_eci_encoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] +**pdf417_is_reader_initialization** | **bool** | Whether the barcode is used for reader initialization (programming). | [optional] +**pdf417_macro_characters** | [**MacroCharacter**](MacroCharacter.md) | | [optional] +**pdf417_is_linked** | **bool** | Whether to use linked mode (for MicroPdf417). | [optional] +**pdf417_is_code128_emulation** | **bool** | Whether to use Code128 emulation for MicroPdf417. | [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/QREncodeMode.md b/docs/QREncodeMode.md new file mode 100644 index 0000000..0218d25 --- /dev/null +++ b/docs/QREncodeMode.md @@ -0,0 +1,11 @@ +# QREncodeMode + +QR barcode encode mode. Subset of https://reference.aspose.com/barcode/net/aspose.barcode.generation/qrencodemode/ Obsolete members (Bytes, Utf8BOM, Utf16BEBOM, ECIEncoding, ExtendedCodetext) are omitted. +## Allowable values + +* **QREncodeMode.AUTO** +* QREncodeMode.EXTENDED +* QREncodeMode.BINARY +* QREncodeMode.ECI + +[[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/QRErrorLevel.md b/docs/QRErrorLevel.md new file mode 100644 index 0000000..0cdcc3d --- /dev/null +++ b/docs/QRErrorLevel.md @@ -0,0 +1,11 @@ +# QRErrorLevel + +QR barcode error correction level. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/qrerrorlevel/ +## Allowable values + +* **QRErrorLevel.LEVELL** +* QRErrorLevel.LEVELM +* QRErrorLevel.LEVELQ +* QRErrorLevel.LEVELH + +[[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/QRVersion.md b/docs/QRVersion.md new file mode 100644 index 0000000..91afd40 --- /dev/null +++ b/docs/QRVersion.md @@ -0,0 +1,48 @@ +# QRVersion + +QR barcode version. Subset of https://reference.aspose.com/barcode/net/aspose.barcode.generation/qrversion/ MicroQR versions (VersionM1–VersionM4) are omitted; use Aspose.BarCode.Cloud.DTO.Enums.MicroQRVersion instead. +## Allowable values + +* **QRVersion.AUTO** +* QRVersion.VERSION01 +* QRVersion.VERSION02 +* QRVersion.VERSION03 +* QRVersion.VERSION04 +* QRVersion.VERSION05 +* QRVersion.VERSION06 +* QRVersion.VERSION07 +* QRVersion.VERSION08 +* QRVersion.VERSION09 +* QRVersion.VERSION10 +* QRVersion.VERSION11 +* QRVersion.VERSION12 +* QRVersion.VERSION13 +* QRVersion.VERSION14 +* QRVersion.VERSION15 +* QRVersion.VERSION16 +* QRVersion.VERSION17 +* QRVersion.VERSION18 +* QRVersion.VERSION19 +* QRVersion.VERSION20 +* QRVersion.VERSION21 +* QRVersion.VERSION22 +* QRVersion.VERSION23 +* QRVersion.VERSION24 +* QRVersion.VERSION25 +* QRVersion.VERSION26 +* QRVersion.VERSION27 +* QRVersion.VERSION28 +* QRVersion.VERSION29 +* QRVersion.VERSION30 +* QRVersion.VERSION31 +* QRVersion.VERSION32 +* QRVersion.VERSION33 +* QRVersion.VERSION34 +* QRVersion.VERSION35 +* QRVersion.VERSION36 +* QRVersion.VERSION37 +* QRVersion.VERSION38 +* QRVersion.VERSION39 +* QRVersion.VERSION40 + +[[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/QrParams.md b/docs/QrParams.md new file mode 100644 index 0000000..894a5c2 --- /dev/null +++ b/docs/QrParams.md @@ -0,0 +1,17 @@ +# QrParams + +Optional QR barcode generation parameters. Applies to QR, GS1QR, MicroQR, and RectMicroQR barcode types. + +## Properties + +Name | Type | Description | Notes +---- | ---- | ----------- | ----- +**qr_encode_mode** | [**QREncodeMode**](QREncodeMode.md) | | [optional] +**qr_error_level** | [**QRErrorLevel**](QRErrorLevel.md) | | [optional] +**qr_version** | [**QRVersion**](QRVersion.md) | | [optional] +**qr_eci_encoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] +**qr_aspect_ratio** | **float** | QR barcode aspect ratio. Values: 0 to 1. | [optional] +**micro_qr_version** | [**MicroQRVersion**](MicroQRVersion.md) | | [optional] +**rect_micro_qr_version** | [**RectMicroQRVersion**](RectMicroQRVersion.md) | | [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 9c3229f..58234e3 100644 --- a/docs/RecognizeApi.md +++ b/docs/RecognizeApi.md @@ -4,15 +4,15 @@ All URIs are relative to *https://api.aspose.cloud/v4.0* Method | HTTP request | Description ------ | ------------ | ----------- -[**recognize**](RecognizeApi.md#recognize) | **GET** /barcode/recognize | Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead. -[**recognize_base64**](RecognizeApi.md#recognize_base64) | **POST** /barcode/recognize-body | Recognize barcode from file in request body using POST requests with parameters in body in json or xml format. -[**recognize_multipart**](RecognizeApi.md#recognize_multipart) | **POST** /barcode/recognize-multipart | Recognize barcode from file in request body using POST requests with parameters in multipart form. +[**recognize**](RecognizeApi.md#recognize) | **GET** /barcode/recognize | Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. +[**recognize_base64**](RecognizeApi.md#recognize_base64) | **POST** /barcode/recognize-body | Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. +[**recognize_multipart**](RecognizeApi.md#recognize_multipart) | **POST** /barcode/recognize-multipart | Recognize a barcode from a file in the request body using a POST request with multipart form parameters. # **recognize** > BarcodeResponseList recognize(barcode_type, file_url, recognition_mode=recognition_mode, recognition_image_kind=recognition_image_kind) -Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead. +Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. ### Example ```python @@ -26,13 +26,13 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.RecognizeApi(aspose_barcode_cloud.ApiClient(configuration)) -barcode_type = aspose_barcode_cloud.DecodeBarcodeType() # DecodeBarcodeType | Type of barcode to recognize -file_url = 'file_url_example' # str | Url to barcode image -recognition_mode = aspose_barcode_cloud.RecognitionMode() # RecognitionMode | Recognition mode (optional) -recognition_image_kind = aspose_barcode_cloud.RecognitionImageKind() # RecognitionImageKind | Image kind for recognition (optional) +barcode_type = aspose_barcode_cloud.DecodeBarcodeType() # DecodeBarcodeType | Type of barcode to recognize. +file_url = 'file_url_example' # str | URL to the barcode image. +recognition_mode = aspose_barcode_cloud.RecognitionMode() # RecognitionMode | Recognition mode. (optional) +recognition_image_kind = aspose_barcode_cloud.RecognitionImageKind() # RecognitionImageKind | Image kind for recognition. (optional) try: - # Recognize barcode from file on server in the Internet using GET requests with parameter in query string. For recognizing files from your hard drive use `recognize-body` or `recognize-multipart` endpoints instead. + # Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. api_response = api_instance.recognize(barcode_type, file_url, recognition_mode=recognition_mode, recognition_image_kind=recognition_image_kind) pprint(api_response) except ApiException as e: @@ -43,10 +43,10 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **barcode_type** | [**DecodeBarcodeType**](.md)| Type of barcode to recognize | - **file_url** | **str**| Url to barcode image | - **recognition_mode** | [**RecognitionMode**](.md)| Recognition mode | [optional] - **recognition_image_kind** | [**RecognitionImageKind**](.md)| Image kind for recognition | [optional] + **barcode_type** | [**DecodeBarcodeType**](.md)| Type of barcode to recognize. | + **file_url** | **str**| URL to the barcode image. | + **recognition_mode** | [**RecognitionMode**](.md)| Recognition mode. | [optional] + **recognition_image_kind** | [**RecognitionImageKind**](.md)| Image kind for recognition. | [optional] ### Return type @@ -66,7 +66,7 @@ Name | Type | Description | Notes # **recognize_base64** > BarcodeResponseList recognize_base64(recognize_base64_request) -Recognize barcode from file in request body using POST requests with parameters in body in json or xml format. +Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. ### Example ```python @@ -80,10 +80,10 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.RecognizeApi(aspose_barcode_cloud.ApiClient(configuration)) -recognize_base64_request = aspose_barcode_cloud.RecognizeBase64Request() # RecognizeBase64Request | Barcode recognition request +recognize_base64_request = aspose_barcode_cloud.RecognizeBase64Request() # RecognizeBase64Request | Barcode recognition request. try: - # Recognize barcode from file in request body using POST requests with parameters in body in json or xml format. + # Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. api_response = api_instance.recognize_base64(recognize_base64_request) pprint(api_response) except ApiException as e: @@ -94,7 +94,7 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **recognize_base64_request** | [**RecognizeBase64Request**](RecognizeBase64Request.md)| Barcode recognition request | + **recognize_base64_request** | [**RecognizeBase64Request**](RecognizeBase64Request.md)| Barcode recognition request. | ### Return type @@ -114,7 +114,7 @@ Name | Type | Description | Notes # **recognize_multipart** > BarcodeResponseList recognize_multipart(barcode_type, file, recognition_mode=recognition_mode, recognition_image_kind=recognition_image_kind) -Recognize barcode from file in request body using POST requests with parameters in multipart form. +Recognize a barcode from a file in the request body using a POST request with multipart form parameters. ### Example ```python @@ -129,12 +129,12 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.RecognizeApi(aspose_barcode_cloud.ApiClient(configuration)) barcode_type = aspose_barcode_cloud.DecodeBarcodeType() # DecodeBarcodeType | -file = None # bytearray | Barcode image file +file = None # bytearray | Barcode image file. recognition_mode = aspose_barcode_cloud.RecognitionMode() # RecognitionMode | (optional) recognition_image_kind = aspose_barcode_cloud.RecognitionImageKind() # RecognitionImageKind | (optional) try: - # Recognize barcode from file in request body using POST requests with parameters in multipart form. + # Recognize a barcode from a file in the request body using a POST request with multipart form parameters. api_response = api_instance.recognize_multipart(barcode_type, file, recognition_mode=recognition_mode, recognition_image_kind=recognition_image_kind) pprint(api_response) except ApiException as e: @@ -146,7 +146,7 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- **barcode_type** | [**DecodeBarcodeType**](DecodeBarcodeType.md)| | - **file** | **bytearray**| Barcode image file | + **file** | **bytearray**| Barcode image file. | **recognition_mode** | [**RecognitionMode**](RecognitionMode.md)| | [optional] **recognition_image_kind** | [**RecognitionImageKind**](RecognitionImageKind.md)| | [optional] diff --git a/docs/RecognizeBase64Request.md b/docs/RecognizeBase64Request.md index 18bccb6..9e47667 100644 --- a/docs/RecognizeBase64Request.md +++ b/docs/RecognizeBase64Request.md @@ -1,12 +1,12 @@ # RecognizeBase64Request -Barcode recognize request +Barcode recognition request. ## Properties Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**barcode_types** | [**List[DecodeBarcodeType]**](DecodeBarcodeType.md) | Array of decode types to find on barcode | +**barcode_types** | [**List[DecodeBarcodeType]**](DecodeBarcodeType.md) | Array of barcode decode types to find. | **file_base64** | **str** | Barcode image bytes encoded as base-64. | **recognition_mode** | [**RecognitionMode**](RecognitionMode.md) | | [optional] **recognition_image_kind** | [**RecognitionImageKind**](RecognitionImageKind.md) | | [optional] diff --git a/docs/RectMicroQRVersion.md b/docs/RectMicroQRVersion.md new file mode 100644 index 0000000..a387c49 --- /dev/null +++ b/docs/RectMicroQRVersion.md @@ -0,0 +1,40 @@ +# RectMicroQRVersion + +RectMicroQR barcode version. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/rectmicroqrversion/ +## Allowable values + +* **RectMicroQRVersion.AUTO** +* RectMicroQRVersion.R7X43 +* RectMicroQRVersion.R7X59 +* RectMicroQRVersion.R7X77 +* RectMicroQRVersion.R7X99 +* RectMicroQRVersion.R7X139 +* RectMicroQRVersion.R9X43 +* RectMicroQRVersion.R9X59 +* RectMicroQRVersion.R9X77 +* RectMicroQRVersion.R9X99 +* RectMicroQRVersion.R9X139 +* RectMicroQRVersion.R11X27 +* RectMicroQRVersion.R11X43 +* RectMicroQRVersion.R11X59 +* RectMicroQRVersion.R11X77 +* RectMicroQRVersion.R11X99 +* RectMicroQRVersion.R11X139 +* RectMicroQRVersion.R13X27 +* RectMicroQRVersion.R13X43 +* RectMicroQRVersion.R13X59 +* RectMicroQRVersion.R13X77 +* RectMicroQRVersion.R13X99 +* RectMicroQRVersion.R13X139 +* RectMicroQRVersion.R15X43 +* RectMicroQRVersion.R15X59 +* RectMicroQRVersion.R15X77 +* RectMicroQRVersion.R15X99 +* RectMicroQRVersion.R15X139 +* RectMicroQRVersion.R17X43 +* RectMicroQRVersion.R17X59 +* RectMicroQRVersion.R17X77 +* RectMicroQRVersion.R17X99 +* RectMicroQRVersion.R17X139 + +[[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/ScanApi.md b/docs/ScanApi.md index 04a5ac7..4b8b73e 100644 --- a/docs/ScanApi.md +++ b/docs/ScanApi.md @@ -4,15 +4,15 @@ All URIs are relative to *https://api.aspose.cloud/v4.0* Method | HTTP request | Description ------ | ------------ | ----------- -[**scan**](ScanApi.md#scan) | **GET** /barcode/scan | Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead. -[**scan_base64**](ScanApi.md#scan_base64) | **POST** /barcode/scan-body | Scan barcode from file in request body using POST requests with parameter in body in json or xml format. -[**scan_multipart**](ScanApi.md#scan_multipart) | **POST** /barcode/scan-multipart | Scan barcode from file in request body using POST requests with parameter in multipart form. +[**scan**](ScanApi.md#scan) | **GET** /barcode/scan | Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. +[**scan_base64**](ScanApi.md#scan_base64) | **POST** /barcode/scan-body | Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. +[**scan_multipart**](ScanApi.md#scan_multipart) | **POST** /barcode/scan-multipart | Scan a barcode from a file in the request body using a POST request with a multipart form parameter. # **scan** > BarcodeResponseList scan(file_url) -Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead. +Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. ### Example ```python @@ -26,10 +26,10 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.ScanApi(aspose_barcode_cloud.ApiClient(configuration)) -file_url = 'file_url_example' # str | Url to barcode image +file_url = 'file_url_example' # str | URL to the barcode image. try: - # Scan barcode from file on server in the Internet using GET requests with parameter in query string. For scaning files from your hard drive use `scan-body` or `scan-multipart` endpoints instead. + # Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. api_response = api_instance.scan(file_url) pprint(api_response) except ApiException as e: @@ -40,7 +40,7 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **file_url** | **str**| Url to barcode image | + **file_url** | **str**| URL to the barcode image. | ### Return type @@ -60,7 +60,7 @@ Name | Type | Description | Notes # **scan_base64** > BarcodeResponseList scan_base64(scan_base64_request) -Scan barcode from file in request body using POST requests with parameter in body in json or xml format. +Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. ### Example ```python @@ -74,10 +74,10 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.ScanApi(aspose_barcode_cloud.ApiClient(configuration)) -scan_base64_request = aspose_barcode_cloud.ScanBase64Request() # ScanBase64Request | Barcode scan request +scan_base64_request = aspose_barcode_cloud.ScanBase64Request() # ScanBase64Request | Barcode scan request. try: - # Scan barcode from file in request body using POST requests with parameter in body in json or xml format. + # Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. api_response = api_instance.scan_base64(scan_base64_request) pprint(api_response) except ApiException as e: @@ -88,7 +88,7 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **scan_base64_request** | [**ScanBase64Request**](ScanBase64Request.md)| Barcode scan request | + **scan_base64_request** | [**ScanBase64Request**](ScanBase64Request.md)| Barcode scan request. | ### Return type @@ -108,7 +108,7 @@ Name | Type | Description | Notes # **scan_multipart** > BarcodeResponseList scan_multipart(file) -Scan barcode from file in request body using POST requests with parameter in multipart form. +Scan a barcode from a file in the request body using a POST request with a multipart form parameter. ### Example ```python @@ -122,10 +122,10 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.ScanApi(aspose_barcode_cloud.ApiClient(configuration)) -file = None # bytearray | Barcode image file +file = None # bytearray | Barcode image file. try: - # Scan barcode from file in request body using POST requests with parameter in multipart form. + # Scan a barcode from a file in the request body using a POST request with a multipart form parameter. api_response = api_instance.scan_multipart(file) pprint(api_response) except ApiException as e: @@ -136,7 +136,7 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **file** | **bytearray**| Barcode image file | + **file** | **bytearray**| Barcode image file. | ### Return type diff --git a/example.py b/example.py index cbfee42..7065da7 100644 --- a/example.py +++ b/example.py @@ -9,6 +9,9 @@ EncodeBarcodeType, CodeLocation, DecodeBarcodeType, + QREncodeMode, + QRErrorLevel, + QRVersion, ) config = Configuration( @@ -19,7 +22,15 @@ # Generate barcode generateApi = GenerateApi(ApiClient(config)) -response = generateApi.generate(EncodeBarcodeType.QR, "Example", text_location=CodeLocation.NONE) +response = generateApi.generate( + EncodeBarcodeType.QR, + "Example", + text_location=CodeLocation.NONE, + qr_encode_mode=QREncodeMode.AUTO, + qr_error_level=QRErrorLevel.LEVELM, + qr_version=QRVersion.AUTO, + qr_aspect_ratio=0.75, +) with open("example.png", "wb") as f: f.write(response.data) print("Barcode saved to file 'example.png'") diff --git a/scripts/insert-example.bash b/scripts/insert-example.bash index 69afc57..e045bec 100755 --- a/scripts/insert-example.bash +++ b/scripts/insert-example.bash @@ -3,6 +3,9 @@ set -euo pipefail cd "$( dirname "${BASH_SOURCE[0]}" )/.." -python "./scripts/insert-example.py" "README.template" > "README.md" +tmp_readme="$(mktemp README.md.XXXXXX)" +trap 'rm -f "$tmp_readme"' EXIT -rm "README.template" +python3 "./scripts/insert-example.py" "README.template" > "$tmp_readme" +mv "$tmp_readme" "README.md" +trap - EXIT diff --git a/setup.py b/setup.py index 831078f..73c658c 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ from setuptools import setup, find_packages NAME = "aspose-barcode-cloud" -VERSION = "26.5.0" +VERSION = "26.6.0" # To install the library, run the following # # python setup.py install diff --git a/snippets/generate/appearance/generate_body.py b/snippets/generate/appearance/generate_body.py index 59e1ff4..9137cdf 100644 --- a/snippets/generate/appearance/generate_body.py +++ b/snippets/generate/appearance/generate_body.py @@ -8,6 +8,10 @@ GenerateParams, BarcodeImageParams, BarcodeImageFormat, + QrParams, + QREncodeMode, + QRErrorLevel, + QRVersion, ) from aspose_barcode_cloud.api.generate_api import GenerateApi @@ -32,11 +36,11 @@ def main(): generate_api = GenerateApi(api_client=api_client) # Define the file path for the generated barcode - file_name = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "testdata", "code39.jpeg")) + file_name = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "testdata", "qr-custom.jpeg")) # Set up the generation parameters generate_params = GenerateParams( - barcode_type=EncodeBarcodeType.CODE39, + barcode_type=EncodeBarcodeType.QR, encode_data=EncodeData(data="Aspose", data_type=EncodeDataType.STRINGDATA), barcode_image_params=BarcodeImageParams( foreground_color="#FF0000", @@ -44,6 +48,12 @@ def main(): image_format=BarcodeImageFormat.JPEG, rotation_angle=90, ), + qr_params=QrParams( + qr_encode_mode=QREncodeMode.AUTO, + qr_error_level=QRErrorLevel.LEVELM, + qr_version=QRVersion.AUTO, + qr_aspect_ratio=0.75, + ), ) # Generate barcode From 1f98cad170d2b8a0b001bd53ef39cc9c819202f1 Mon Sep 17 00:00:00 2001 From: Timur Baiguskarov Date: Tue, 16 Jun 2026 15:02:20 +0500 Subject: [PATCH 2/3] Remove generated README template --- scripts/insert-example.bash | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/insert-example.bash b/scripts/insert-example.bash index e045bec..7db98c4 100755 --- a/scripts/insert-example.bash +++ b/scripts/insert-example.bash @@ -8,4 +8,5 @@ trap 'rm -f "$tmp_readme"' EXIT python3 "./scripts/insert-example.py" "README.template" > "$tmp_readme" mv "$tmp_readme" "README.md" +rm -f "README.template" trap - EXIT From 4b8aaed351c3860cea2da30081aa23344d71a423 Mon Sep 17 00:00:00 2001 From: ivankamkin <109517020+ivankamkin@users.noreply.github.com> Date: Tue, 30 Jun 2026 16:46:32 +0500 Subject: [PATCH 3/3] Group generate params (#112) * Code regenerate with new templates. Build and tests fixed. * Fix snippets --- README.md | 14 +- aspose_barcode_cloud/api/generate_api.py | 438 +++++++----------- aspose_barcode_cloud/api/recognize_api.py | 8 +- aspose_barcode_cloud/models/api_error.py | 2 + .../models/api_error_response.py | 2 + .../models/barcode_image_params.py | 6 + aspose_barcode_cloud/models/code128_params.py | 2 + aspose_barcode_cloud/models/encode_data.py | 2 + .../models/generate_params.py | 12 + aspose_barcode_cloud/models/pdf417_params.py | 8 + aspose_barcode_cloud/models/qr_params.py | 12 + .../models/recognize_base64_request.py | 4 + 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 +- example.py | 14 +- snippets/generate/appearance/generate_get.py | 35 +- .../generate/appearance/generate_multipart.py | 23 +- snippets/generate/save/generate_get.py | 18 +- .../generate/set_colorscheme/generate_get.py | 10 +- .../set_colorscheme/generate_multipart.py | 17 +- .../generate/set_size/generate_multipart.py | 12 +- .../generate/set_text/generate_multipart.py | 14 +- .../set_image_kind/recognize_multipart.py | 7 +- snippets/read/set_quality/recognize_body.py | 7 +- tests/test_generate_api.py | 5 +- 34 files changed, 407 insertions(+), 391 deletions(-) diff --git a/README.md b/README.md index 8bdbd5b..c7ebdd5 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,8 @@ from aspose_barcode_cloud import ( EncodeBarcodeType, CodeLocation, DecodeBarcodeType, + BarcodeImageParams, + QrParams, QREncodeMode, QRErrorLevel, QRVersion, @@ -90,11 +92,13 @@ generateApi = GenerateApi(ApiClient(config)) response = generateApi.generate( EncodeBarcodeType.QR, "Example", - text_location=CodeLocation.NONE, - qr_encode_mode=QREncodeMode.AUTO, - qr_error_level=QRErrorLevel.LEVELM, - qr_version=QRVersion.AUTO, - qr_aspect_ratio=0.75, + barcode_image_params=BarcodeImageParams(text_location=CodeLocation.NONE), + qr_params=QrParams( + qr_encode_mode=QREncodeMode.AUTO, + qr_error_level=QRErrorLevel.LEVELM, + qr_version=QRVersion.AUTO, + qr_aspect_ratio=0.75, + ), ) with open("example.png", "wb") as f: f.write(response.data) diff --git a/aspose_barcode_cloud/api/generate_api.py b/aspose_barcode_cloud/api/generate_api.py index e1a3486..7abf6f7 100644 --- a/aspose_barcode_cloud/api/generate_api.py +++ b/aspose_barcode_cloud/api/generate_api.py @@ -25,34 +25,10 @@ def generate( barcode_type, data, data_type=None, - image_format=None, - text_location=None, - foreground_color="Black", - background_color="White", - units=None, - resolution=None, - image_height=None, - image_width=None, - rotation_angle=None, - qr_encode_mode=None, - qr_error_level=None, - qr_version=None, - qr_eci_encoding=None, - qr_aspect_ratio=None, - micro_qr_version=None, - rect_micro_qr_version=None, - code128_encode_mode=None, - pdf417_encode_mode=None, - pdf417_error_level=None, - pdf417_truncate=None, - pdf417_columns=None, - pdf417_rows=None, - pdf417_aspect_ratio=None, - pdf417_eci_encoding=None, - pdf417_is_reader_initialization=None, - pdf417_macro_characters=None, - pdf417_is_linked=None, - pdf417_is_code128_emulation=None, + barcode_image_params=None, + qr_params=None, + code128_params=None, + pdf417_params=None, async_req=False, **kwargs ): @@ -66,34 +42,10 @@ def generate( :param EncodeBarcodeType barcode_type: Type of barcode to generate. # noqa: E501 :param str data: String that represents the data to encode. # noqa: E501 :param EncodeDataType data_type: Type of data to encode. Default value: StringData. # noqa: E501 - :param BarcodeImageFormat image_format: Barcode output image format. Default value: png. # noqa: E501 - :param CodeLocation text_location: 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. # noqa: E501 - :param str foreground_color: 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. # noqa: E501 - :param str background_color: 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. # noqa: E501 - :param GraphicsUnit units: Common units for all measurements. Default units: pixels. # noqa: E501 - :param float resolution: Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. # noqa: E501 - :param float image_height: Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 - :param float image_width: Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 - :param int rotation_angle: 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. # noqa: E501 - :param QREncodeMode qr_encode_mode: QR barcode encode mode. # noqa: E501 - :param QRErrorLevel qr_error_level: QR barcode error correction level. # noqa: E501 - :param QRVersion qr_version: QR barcode version. Automatically selects the smallest version that fits the data. # noqa: E501 - :param ECIEncodings qr_eci_encoding: ECI encoding for QR barcode data. # noqa: E501 - :param float qr_aspect_ratio: QR barcode aspect ratio. Values: 0 to 1. # noqa: E501 - :param MicroQRVersion micro_qr_version: MicroQR barcode version. Used when BarcodeType is MicroQR. # noqa: E501 - :param RectMicroQRVersion rect_micro_qr_version: RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. # noqa: E501 - :param Code128EncodeMode code128_encode_mode: Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. # noqa: E501 - :param Pdf417EncodeMode pdf417_encode_mode: PDF417 barcode encode mode. # noqa: E501 - :param Pdf417ErrorLevel pdf417_error_level: PDF417 barcode error correction level. # noqa: E501 - :param bool pdf417_truncate: Whether to use truncated PDF417 format (removes right-side stop pattern). # noqa: E501 - :param int pdf417_columns: Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. # noqa: E501 - :param int pdf417_rows: Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. # noqa: E501 - :param float pdf417_aspect_ratio: 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. # noqa: E501 - :param ECIEncodings pdf417_eci_encoding: ECI encoding for PDF417 barcode data. # noqa: E501 - :param bool pdf417_is_reader_initialization: Whether the barcode is used for reader initialization (programming). # noqa: E501 - :param MacroCharacter pdf417_macro_characters: Macro character to prepend (structured append). # noqa: E501 - :param bool pdf417_is_linked: Whether to use linked mode (for MicroPdf417). # noqa: E501 - :param bool pdf417_is_code128_emulation: Whether to use Code128 emulation for MicroPdf417. # noqa: E501 + :param BarcodeImageParams barcode_image_params: Grouped BarcodeImageParams parameters. # noqa: E501 + :param QrParams qr_params: Grouped QrParams parameters. # noqa: E501 + :param Code128Params code128_params: Grouped Code128Params parameters. # noqa: E501 + :param Pdf417Params pdf417_params: Grouped Pdf417Params parameters. # noqa: E501 :param async_req bool :return: bytearray If the method is called asynchronously, @@ -105,34 +57,10 @@ def generate( barcode_type, data, data_type=data_type, - image_format=image_format, - text_location=text_location, - foreground_color=foreground_color, - background_color=background_color, - units=units, - resolution=resolution, - image_height=image_height, - image_width=image_width, - rotation_angle=rotation_angle, - qr_encode_mode=qr_encode_mode, - qr_error_level=qr_error_level, - qr_version=qr_version, - qr_eci_encoding=qr_eci_encoding, - qr_aspect_ratio=qr_aspect_ratio, - micro_qr_version=micro_qr_version, - rect_micro_qr_version=rect_micro_qr_version, - code128_encode_mode=code128_encode_mode, - pdf417_encode_mode=pdf417_encode_mode, - pdf417_error_level=pdf417_error_level, - pdf417_truncate=pdf417_truncate, - pdf417_columns=pdf417_columns, - pdf417_rows=pdf417_rows, - pdf417_aspect_ratio=pdf417_aspect_ratio, - pdf417_eci_encoding=pdf417_eci_encoding, - pdf417_is_reader_initialization=pdf417_is_reader_initialization, - pdf417_macro_characters=pdf417_macro_characters, - pdf417_is_linked=pdf417_is_linked, - pdf417_is_code128_emulation=pdf417_is_code128_emulation, + barcode_image_params=barcode_image_params, + qr_params=qr_params, + code128_params=code128_params, + pdf417_params=pdf417_params, **kwargs ) else: @@ -140,34 +68,10 @@ def generate( barcode_type, data, data_type=data_type, - image_format=image_format, - text_location=text_location, - foreground_color=foreground_color, - background_color=background_color, - units=units, - resolution=resolution, - image_height=image_height, - image_width=image_width, - rotation_angle=rotation_angle, - qr_encode_mode=qr_encode_mode, - qr_error_level=qr_error_level, - qr_version=qr_version, - qr_eci_encoding=qr_eci_encoding, - qr_aspect_ratio=qr_aspect_ratio, - micro_qr_version=micro_qr_version, - rect_micro_qr_version=rect_micro_qr_version, - code128_encode_mode=code128_encode_mode, - pdf417_encode_mode=pdf417_encode_mode, - pdf417_error_level=pdf417_error_level, - pdf417_truncate=pdf417_truncate, - pdf417_columns=pdf417_columns, - pdf417_rows=pdf417_rows, - pdf417_aspect_ratio=pdf417_aspect_ratio, - pdf417_eci_encoding=pdf417_eci_encoding, - pdf417_is_reader_initialization=pdf417_is_reader_initialization, - pdf417_macro_characters=pdf417_macro_characters, - pdf417_is_linked=pdf417_is_linked, - pdf417_is_code128_emulation=pdf417_is_code128_emulation, + barcode_image_params=barcode_image_params, + qr_params=qr_params, + code128_params=code128_params, + pdf417_params=pdf417_params, **kwargs ) return data @@ -191,34 +95,10 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): "barcode_type", "data", "data_type", - "image_format", - "text_location", - "foreground_color", - "background_color", - "units", - "resolution", - "image_height", - "image_width", - "rotation_angle", - "qr_encode_mode", - "qr_error_level", - "qr_version", - "qr_eci_encoding", - "qr_aspect_ratio", - "micro_qr_version", - "rect_micro_qr_version", - "code128_encode_mode", - "pdf417_encode_mode", - "pdf417_error_level", - "pdf417_truncate", - "pdf417_columns", - "pdf417_rows", - "pdf417_aspect_ratio", - "pdf417_eci_encoding", - "pdf417_is_reader_initialization", - "pdf417_macro_characters", - "pdf417_is_linked", - "pdf417_is_code128_emulation", + "barcode_image_params", + "qr_params", + "code128_params", + "pdf417_params", } all_params.add("async_req") all_params.add("_return_http_data_only") @@ -234,6 +114,62 @@ def generate_with_http_info(self, barcode_type, data, **kwargs): params[key] = val del params["kwargs"] + if "barcode_image_params" in params and params["barcode_image_params"].image_format is not None: + params["image_format"] = params["barcode_image_params"].image_format + if "barcode_image_params" in params and params["barcode_image_params"].text_location is not None: + params["text_location"] = params["barcode_image_params"].text_location + if "barcode_image_params" in params and params["barcode_image_params"].foreground_color is not None: + params["foreground_color"] = params["barcode_image_params"].foreground_color + if "barcode_image_params" in params and params["barcode_image_params"].background_color is not None: + params["background_color"] = params["barcode_image_params"].background_color + if "barcode_image_params" in params and params["barcode_image_params"].units is not None: + params["units"] = params["barcode_image_params"].units + if "barcode_image_params" in params and params["barcode_image_params"].resolution is not None: + params["resolution"] = params["barcode_image_params"].resolution + if "barcode_image_params" in params and params["barcode_image_params"].image_height is not None: + params["image_height"] = params["barcode_image_params"].image_height + if "barcode_image_params" in params and params["barcode_image_params"].image_width is not None: + params["image_width"] = params["barcode_image_params"].image_width + if "barcode_image_params" in params and params["barcode_image_params"].rotation_angle is not None: + params["rotation_angle"] = params["barcode_image_params"].rotation_angle + if "qr_params" in params and params["qr_params"].qr_encode_mode is not None: + params["qr_encode_mode"] = params["qr_params"].qr_encode_mode + if "qr_params" in params and params["qr_params"].qr_error_level is not None: + params["qr_error_level"] = params["qr_params"].qr_error_level + if "qr_params" in params and params["qr_params"].qr_version is not None: + params["qr_version"] = params["qr_params"].qr_version + if "qr_params" in params and params["qr_params"].qr_eci_encoding is not None: + params["qr_eci_encoding"] = params["qr_params"].qr_eci_encoding + if "qr_params" in params and params["qr_params"].qr_aspect_ratio is not None: + params["qr_aspect_ratio"] = params["qr_params"].qr_aspect_ratio + if "qr_params" in params and params["qr_params"].micro_qr_version is not None: + params["micro_qr_version"] = params["qr_params"].micro_qr_version + if "qr_params" in params and params["qr_params"].rect_micro_qr_version is not None: + params["rect_micro_qr_version"] = params["qr_params"].rect_micro_qr_version + if "code128_params" in params and params["code128_params"].code128_encode_mode is not None: + params["code128_encode_mode"] = params["code128_params"].code128_encode_mode + if "pdf417_params" in params and params["pdf417_params"].pdf417_encode_mode is not None: + params["pdf417_encode_mode"] = params["pdf417_params"].pdf417_encode_mode + if "pdf417_params" in params and params["pdf417_params"].pdf417_error_level is not None: + params["pdf417_error_level"] = params["pdf417_params"].pdf417_error_level + if "pdf417_params" in params and params["pdf417_params"].pdf417_truncate is not None: + params["pdf417_truncate"] = params["pdf417_params"].pdf417_truncate + if "pdf417_params" in params and params["pdf417_params"].pdf417_columns is not None: + params["pdf417_columns"] = params["pdf417_params"].pdf417_columns + if "pdf417_params" in params and params["pdf417_params"].pdf417_rows is not None: + params["pdf417_rows"] = params["pdf417_params"].pdf417_rows + if "pdf417_params" in params and params["pdf417_params"].pdf417_aspect_ratio is not None: + params["pdf417_aspect_ratio"] = params["pdf417_params"].pdf417_aspect_ratio + if "pdf417_params" in params and params["pdf417_params"].pdf417_eci_encoding is not None: + params["pdf417_eci_encoding"] = params["pdf417_params"].pdf417_eci_encoding + if "pdf417_params" in params and params["pdf417_params"].pdf417_is_reader_initialization is not None: + params["pdf417_is_reader_initialization"] = params["pdf417_params"].pdf417_is_reader_initialization + if "pdf417_params" in params and params["pdf417_params"].pdf417_macro_characters is not None: + params["pdf417_macro_characters"] = params["pdf417_params"].pdf417_macro_characters + if "pdf417_params" in params and params["pdf417_params"].pdf417_is_linked is not None: + params["pdf417_is_linked"] = params["pdf417_params"].pdf417_is_linked + if "pdf417_params" in params and params["pdf417_params"].pdf417_is_code128_emulation is not None: + params["pdf417_is_code128_emulation"] = params["pdf417_params"].pdf417_is_code128_emulation # verify the required parameter "barcode_type" is set if "barcode_type" not in params or params["barcode_type"] is None: raise ValueError("Missing the required parameter 'barcode_type' when calling 'generate'") @@ -497,34 +433,10 @@ def generate_multipart( barcode_type, data, data_type=None, - image_format=None, - text_location=None, - foreground_color="Black", - background_color="White", - units=None, - resolution=None, - image_height=None, - image_width=None, - rotation_angle=None, - qr_encode_mode=None, - qr_error_level=None, - qr_version=None, - qr_eci_encoding=None, - qr_aspect_ratio=None, - micro_qr_version=None, - rect_micro_qr_version=None, - code128_encode_mode=None, - pdf417_encode_mode=None, - pdf417_error_level=None, - pdf417_truncate=None, - pdf417_columns=None, - pdf417_rows=None, - pdf417_aspect_ratio=None, - pdf417_eci_encoding=None, - pdf417_is_reader_initialization=None, - pdf417_macro_characters=None, - pdf417_is_linked=None, - pdf417_is_code128_emulation=None, + barcode_image_params=None, + qr_params=None, + code128_params=None, + pdf417_params=None, async_req=False, **kwargs ): @@ -535,37 +447,13 @@ def generate_multipart( >>> thread = GenerateApi().generate_multipart(barcode_type, data, async_req=True) >>> result = thread.get() - :param EncodeBarcodeType barcode_type: # noqa: E501 + :param EncodeBarcodeType barcode_type: See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ # noqa: E501 :param str data: String that represents the data to encode. # noqa: E501 - :param EncodeDataType data_type: # noqa: E501 - :param BarcodeImageFormat image_format: # noqa: E501 - :param CodeLocation text_location: # noqa: E501 - :param str foreground_color: 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. # noqa: E501 - :param str background_color: 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. # noqa: E501 - :param GraphicsUnit units: # noqa: E501 - :param float resolution: Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. # noqa: E501 - :param float image_height: Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 - :param float image_width: Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. # noqa: E501 - :param int rotation_angle: 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. # noqa: E501 - :param QREncodeMode qr_encode_mode: # noqa: E501 - :param QRErrorLevel qr_error_level: # noqa: E501 - :param QRVersion qr_version: # noqa: E501 - :param ECIEncodings qr_eci_encoding: # noqa: E501 - :param float qr_aspect_ratio: QR barcode aspect ratio. Values: 0 to 1. # noqa: E501 - :param MicroQRVersion micro_qr_version: # noqa: E501 - :param RectMicroQRVersion rect_micro_qr_version: # noqa: E501 - :param Code128EncodeMode code128_encode_mode: # noqa: E501 - :param Pdf417EncodeMode pdf417_encode_mode: # noqa: E501 - :param Pdf417ErrorLevel pdf417_error_level: # noqa: E501 - :param bool pdf417_truncate: Whether to use truncated PDF417 format (removes right-side stop pattern). # noqa: E501 - :param int pdf417_columns: Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. # noqa: E501 - :param int pdf417_rows: Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. # noqa: E501 - :param float pdf417_aspect_ratio: 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. # noqa: E501 - :param ECIEncodings pdf417_eci_encoding: # noqa: E501 - :param bool pdf417_is_reader_initialization: Whether the barcode is used for reader initialization (programming). # noqa: E501 - :param MacroCharacter pdf417_macro_characters: # noqa: E501 - :param bool pdf417_is_linked: Whether to use linked mode (for MicroPdf417). # noqa: E501 - :param bool pdf417_is_code128_emulation: Whether to use Code128 emulation for MicroPdf417. # noqa: E501 + :param EncodeDataType data_type: Type of data to encode. Default value: StringData. # noqa: E501 + :param BarcodeImageParams barcode_image_params: Grouped BarcodeImageParams parameters. # noqa: E501 + :param QrParams qr_params: Grouped QrParams parameters. # noqa: E501 + :param Code128Params code128_params: Grouped Code128Params parameters. # noqa: E501 + :param Pdf417Params pdf417_params: Grouped Pdf417Params parameters. # noqa: E501 :param async_req bool :return: bytearray If the method is called asynchronously, @@ -577,34 +465,10 @@ def generate_multipart( barcode_type, data, data_type=data_type, - image_format=image_format, - text_location=text_location, - foreground_color=foreground_color, - background_color=background_color, - units=units, - resolution=resolution, - image_height=image_height, - image_width=image_width, - rotation_angle=rotation_angle, - qr_encode_mode=qr_encode_mode, - qr_error_level=qr_error_level, - qr_version=qr_version, - qr_eci_encoding=qr_eci_encoding, - qr_aspect_ratio=qr_aspect_ratio, - micro_qr_version=micro_qr_version, - rect_micro_qr_version=rect_micro_qr_version, - code128_encode_mode=code128_encode_mode, - pdf417_encode_mode=pdf417_encode_mode, - pdf417_error_level=pdf417_error_level, - pdf417_truncate=pdf417_truncate, - pdf417_columns=pdf417_columns, - pdf417_rows=pdf417_rows, - pdf417_aspect_ratio=pdf417_aspect_ratio, - pdf417_eci_encoding=pdf417_eci_encoding, - pdf417_is_reader_initialization=pdf417_is_reader_initialization, - pdf417_macro_characters=pdf417_macro_characters, - pdf417_is_linked=pdf417_is_linked, - pdf417_is_code128_emulation=pdf417_is_code128_emulation, + barcode_image_params=barcode_image_params, + qr_params=qr_params, + code128_params=code128_params, + pdf417_params=pdf417_params, **kwargs ) else: @@ -612,34 +476,10 @@ def generate_multipart( barcode_type, data, data_type=data_type, - image_format=image_format, - text_location=text_location, - foreground_color=foreground_color, - background_color=background_color, - units=units, - resolution=resolution, - image_height=image_height, - image_width=image_width, - rotation_angle=rotation_angle, - qr_encode_mode=qr_encode_mode, - qr_error_level=qr_error_level, - qr_version=qr_version, - qr_eci_encoding=qr_eci_encoding, - qr_aspect_ratio=qr_aspect_ratio, - micro_qr_version=micro_qr_version, - rect_micro_qr_version=rect_micro_qr_version, - code128_encode_mode=code128_encode_mode, - pdf417_encode_mode=pdf417_encode_mode, - pdf417_error_level=pdf417_error_level, - pdf417_truncate=pdf417_truncate, - pdf417_columns=pdf417_columns, - pdf417_rows=pdf417_rows, - pdf417_aspect_ratio=pdf417_aspect_ratio, - pdf417_eci_encoding=pdf417_eci_encoding, - pdf417_is_reader_initialization=pdf417_is_reader_initialization, - pdf417_macro_characters=pdf417_macro_characters, - pdf417_is_linked=pdf417_is_linked, - pdf417_is_code128_emulation=pdf417_is_code128_emulation, + barcode_image_params=barcode_image_params, + qr_params=qr_params, + code128_params=code128_params, + pdf417_params=pdf417_params, **kwargs ) return data @@ -652,7 +492,7 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): >>> thread = GenerateApi().generate_multipart_with_http_info(barcode_type, data, async_req=True) >>> result = thread.get() - :param EncodeBarcodeType barcode_type: # noqa: E501 + :param EncodeBarcodeType barcode_type: See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ # noqa: E501 :param str data: String that represents the data to encode. # noqa: E501 :return: bytearray If the method is called asynchronously, @@ -663,34 +503,10 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): "barcode_type", "data", "data_type", - "image_format", - "text_location", - "foreground_color", - "background_color", - "units", - "resolution", - "image_height", - "image_width", - "rotation_angle", - "qr_encode_mode", - "qr_error_level", - "qr_version", - "qr_eci_encoding", - "qr_aspect_ratio", - "micro_qr_version", - "rect_micro_qr_version", - "code128_encode_mode", - "pdf417_encode_mode", - "pdf417_error_level", - "pdf417_truncate", - "pdf417_columns", - "pdf417_rows", - "pdf417_aspect_ratio", - "pdf417_eci_encoding", - "pdf417_is_reader_initialization", - "pdf417_macro_characters", - "pdf417_is_linked", - "pdf417_is_code128_emulation", + "barcode_image_params", + "qr_params", + "code128_params", + "pdf417_params", } all_params.add("async_req") all_params.add("_return_http_data_only") @@ -706,6 +522,62 @@ def generate_multipart_with_http_info(self, barcode_type, data, **kwargs): params[key] = val del params["kwargs"] + if "barcode_image_params" in params and params["barcode_image_params"].image_format is not None: + params["image_format"] = params["barcode_image_params"].image_format + if "barcode_image_params" in params and params["barcode_image_params"].text_location is not None: + params["text_location"] = params["barcode_image_params"].text_location + if "barcode_image_params" in params and params["barcode_image_params"].foreground_color is not None: + params["foreground_color"] = params["barcode_image_params"].foreground_color + if "barcode_image_params" in params and params["barcode_image_params"].background_color is not None: + params["background_color"] = params["barcode_image_params"].background_color + if "barcode_image_params" in params and params["barcode_image_params"].units is not None: + params["units"] = params["barcode_image_params"].units + if "barcode_image_params" in params and params["barcode_image_params"].resolution is not None: + params["resolution"] = params["barcode_image_params"].resolution + if "barcode_image_params" in params and params["barcode_image_params"].image_height is not None: + params["image_height"] = params["barcode_image_params"].image_height + if "barcode_image_params" in params and params["barcode_image_params"].image_width is not None: + params["image_width"] = params["barcode_image_params"].image_width + if "barcode_image_params" in params and params["barcode_image_params"].rotation_angle is not None: + params["rotation_angle"] = params["barcode_image_params"].rotation_angle + if "qr_params" in params and params["qr_params"].qr_encode_mode is not None: + params["qr_encode_mode"] = params["qr_params"].qr_encode_mode + if "qr_params" in params and params["qr_params"].qr_error_level is not None: + params["qr_error_level"] = params["qr_params"].qr_error_level + if "qr_params" in params and params["qr_params"].qr_version is not None: + params["qr_version"] = params["qr_params"].qr_version + if "qr_params" in params and params["qr_params"].qr_eci_encoding is not None: + params["qr_eci_encoding"] = params["qr_params"].qr_eci_encoding + if "qr_params" in params and params["qr_params"].qr_aspect_ratio is not None: + params["qr_aspect_ratio"] = params["qr_params"].qr_aspect_ratio + if "qr_params" in params and params["qr_params"].micro_qr_version is not None: + params["micro_qr_version"] = params["qr_params"].micro_qr_version + if "qr_params" in params and params["qr_params"].rect_micro_qr_version is not None: + params["rect_micro_qr_version"] = params["qr_params"].rect_micro_qr_version + if "code128_params" in params and params["code128_params"].code128_encode_mode is not None: + params["code128_encode_mode"] = params["code128_params"].code128_encode_mode + if "pdf417_params" in params and params["pdf417_params"].pdf417_encode_mode is not None: + params["pdf417_encode_mode"] = params["pdf417_params"].pdf417_encode_mode + if "pdf417_params" in params and params["pdf417_params"].pdf417_error_level is not None: + params["pdf417_error_level"] = params["pdf417_params"].pdf417_error_level + if "pdf417_params" in params and params["pdf417_params"].pdf417_truncate is not None: + params["pdf417_truncate"] = params["pdf417_params"].pdf417_truncate + if "pdf417_params" in params and params["pdf417_params"].pdf417_columns is not None: + params["pdf417_columns"] = params["pdf417_params"].pdf417_columns + if "pdf417_params" in params and params["pdf417_params"].pdf417_rows is not None: + params["pdf417_rows"] = params["pdf417_params"].pdf417_rows + if "pdf417_params" in params and params["pdf417_params"].pdf417_aspect_ratio is not None: + params["pdf417_aspect_ratio"] = params["pdf417_params"].pdf417_aspect_ratio + if "pdf417_params" in params and params["pdf417_params"].pdf417_eci_encoding is not None: + params["pdf417_eci_encoding"] = params["pdf417_params"].pdf417_eci_encoding + if "pdf417_params" in params and params["pdf417_params"].pdf417_is_reader_initialization is not None: + params["pdf417_is_reader_initialization"] = params["pdf417_params"].pdf417_is_reader_initialization + if "pdf417_params" in params and params["pdf417_params"].pdf417_macro_characters is not None: + params["pdf417_macro_characters"] = params["pdf417_params"].pdf417_macro_characters + if "pdf417_params" in params and params["pdf417_params"].pdf417_is_linked is not None: + params["pdf417_is_linked"] = params["pdf417_params"].pdf417_is_linked + if "pdf417_params" in params and params["pdf417_params"].pdf417_is_code128_emulation is not None: + params["pdf417_is_code128_emulation"] = params["pdf417_params"].pdf417_is_code128_emulation # verify the required parameter "barcode_type" is set if "barcode_type" not in params or params["barcode_type"] is None: raise ValueError("Missing the required parameter 'barcode_type' when calling 'generate_multipart'") diff --git a/aspose_barcode_cloud/api/recognize_api.py b/aspose_barcode_cloud/api/recognize_api.py index 84f5c56..8ade304 100644 --- a/aspose_barcode_cloud/api/recognize_api.py +++ b/aspose_barcode_cloud/api/recognize_api.py @@ -242,10 +242,10 @@ def recognize_multipart( >>> thread = RecognizeApi().recognize_multipart(barcode_type, file, async_req=True) >>> result = thread.get() - :param DecodeBarcodeType barcode_type: # noqa: E501 + :param DecodeBarcodeType barcode_type: See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ # noqa: E501 :param bytearray file: Barcode image file. # noqa: E501 - :param RecognitionMode recognition_mode: # noqa: E501 - :param RecognitionImageKind recognition_image_kind: # noqa: E501 + :param RecognitionMode recognition_mode: Recognition mode. # noqa: E501 + :param RecognitionImageKind recognition_image_kind: Image kind for recognition. # noqa: E501 :param async_req bool :return: BarcodeResponseList If the method is called asynchronously, @@ -278,7 +278,7 @@ def recognize_multipart_with_http_info(self, barcode_type, file, **kwargs): >>> thread = RecognizeApi().recognize_multipart_with_http_info(barcode_type, file, async_req=True) >>> result = thread.get() - :param DecodeBarcodeType barcode_type: # noqa: E501 + :param DecodeBarcodeType barcode_type: See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ # noqa: E501 :param bytearray file: Barcode image file. # noqa: E501 :return: BarcodeResponseList If the method is called asynchronously, diff --git a/aspose_barcode_cloud/models/api_error.py b/aspose_barcode_cloud/models/api_error.py index 56c2115..648a730 100644 --- a/aspose_barcode_cloud/models/api_error.py +++ b/aspose_barcode_cloud/models/api_error.py @@ -153,6 +153,7 @@ def date_time(self, date_time): def inner_error(self): """Gets the inner_error of this ApiError. # noqa: E501 + Gets or sets inner error. # noqa: E501 :return: The inner_error of this ApiError. # noqa: E501 :rtype: ApiError @@ -163,6 +164,7 @@ def inner_error(self): def inner_error(self, inner_error): """Sets the inner_error of this ApiError. + Gets or sets inner error. # noqa: E501 :param inner_error: The inner_error of this ApiError. # noqa: E501 :type: ApiError diff --git a/aspose_barcode_cloud/models/api_error_response.py b/aspose_barcode_cloud/models/api_error_response.py index 333b889..91d0771 100644 --- a/aspose_barcode_cloud/models/api_error_response.py +++ b/aspose_barcode_cloud/models/api_error_response.py @@ -61,6 +61,7 @@ def request_id(self, request_id): def error(self): """Gets the error of this ApiErrorResponse. # noqa: E501 + Gets or sets error. # noqa: E501 :return: The error of this ApiErrorResponse. # noqa: E501 :rtype: ApiError @@ -71,6 +72,7 @@ def error(self): def error(self, error): """Sets the error of this ApiErrorResponse. + Gets or sets error. # noqa: E501 :param error: The error of this ApiErrorResponse. # noqa: E501 :type: ApiError diff --git a/aspose_barcode_cloud/models/barcode_image_params.py b/aspose_barcode_cloud/models/barcode_image_params.py index d09f301..3854c9a 100644 --- a/aspose_barcode_cloud/models/barcode_image_params.py +++ b/aspose_barcode_cloud/models/barcode_image_params.py @@ -90,6 +90,7 @@ def __init__( def image_format(self): """Gets the image_format of this BarcodeImageParams. # noqa: E501 + Barcode output image format. Default value: png. # noqa: E501 :return: The image_format of this BarcodeImageParams. # noqa: E501 :rtype: BarcodeImageFormat @@ -100,6 +101,7 @@ def image_format(self): def image_format(self, image_format): """Sets the image_format of this BarcodeImageParams. + Barcode output image format. Default value: png. # noqa: E501 :param image_format: The image_format of this BarcodeImageParams. # noqa: E501 :type: BarcodeImageFormat @@ -111,6 +113,7 @@ def image_format(self, image_format): def text_location(self): """Gets the text_location of this BarcodeImageParams. # noqa: E501 + 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. # noqa: E501 :return: The text_location of this BarcodeImageParams. # noqa: E501 :rtype: CodeLocation @@ -121,6 +124,7 @@ def text_location(self): def text_location(self, text_location): """Sets the text_location of this BarcodeImageParams. + 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. # noqa: E501 :param text_location: The text_location of this BarcodeImageParams. # noqa: E501 :type: CodeLocation @@ -178,6 +182,7 @@ def background_color(self, background_color): def units(self): """Gets the units of this BarcodeImageParams. # noqa: E501 + Common units for all measurements. Default units: pixels. # noqa: E501 :return: The units of this BarcodeImageParams. # noqa: E501 :rtype: GraphicsUnit @@ -188,6 +193,7 @@ def units(self): def units(self, units): """Sets the units of this BarcodeImageParams. + Common units for all measurements. Default units: pixels. # noqa: E501 :param units: The units of this BarcodeImageParams. # noqa: E501 :type: GraphicsUnit diff --git a/aspose_barcode_cloud/models/code128_params.py b/aspose_barcode_cloud/models/code128_params.py index f795337..de1a67c 100644 --- a/aspose_barcode_cloud/models/code128_params.py +++ b/aspose_barcode_cloud/models/code128_params.py @@ -35,6 +35,7 @@ def __init__(self, code128_encode_mode=None): # noqa: E501 def code128_encode_mode(self): """Gets the code128_encode_mode of this Code128Params. # noqa: E501 + Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. # noqa: E501 :return: The code128_encode_mode of this Code128Params. # noqa: E501 :rtype: Code128EncodeMode @@ -45,6 +46,7 @@ def code128_encode_mode(self): def code128_encode_mode(self, code128_encode_mode): """Sets the code128_encode_mode of this Code128Params. + Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. # noqa: E501 :param code128_encode_mode: The code128_encode_mode of this Code128Params. # noqa: E501 :type: Code128EncodeMode diff --git a/aspose_barcode_cloud/models/encode_data.py b/aspose_barcode_cloud/models/encode_data.py index 98e1a87..3d6e8e9 100644 --- a/aspose_barcode_cloud/models/encode_data.py +++ b/aspose_barcode_cloud/models/encode_data.py @@ -37,6 +37,7 @@ def __init__(self, data_type=None, data=None): # noqa: E501 def data_type(self): """Gets the data_type of this EncodeData. # noqa: E501 + Type of data to encode. Default value: StringData. # noqa: E501 :return: The data_type of this EncodeData. # noqa: E501 :rtype: EncodeDataType @@ -47,6 +48,7 @@ def data_type(self): def data_type(self, data_type): """Sets the data_type of this EncodeData. + Type of data to encode. Default value: StringData. # noqa: E501 :param data_type: The data_type of this EncodeData. # noqa: E501 :type: EncodeDataType diff --git a/aspose_barcode_cloud/models/generate_params.py b/aspose_barcode_cloud/models/generate_params.py index deb012f..6bd2668 100644 --- a/aspose_barcode_cloud/models/generate_params.py +++ b/aspose_barcode_cloud/models/generate_params.py @@ -70,6 +70,7 @@ def __init__( def barcode_type(self): """Gets the barcode_type of this GenerateParams. # noqa: E501 + Barcode type. # noqa: E501 :return: The barcode_type of this GenerateParams. # noqa: E501 :rtype: EncodeBarcodeType @@ -80,6 +81,7 @@ def barcode_type(self): def barcode_type(self, barcode_type): """Sets the barcode_type of this GenerateParams. + Barcode type. # noqa: E501 :param barcode_type: The barcode_type of this GenerateParams. # noqa: E501 :type: EncodeBarcodeType @@ -93,6 +95,7 @@ def barcode_type(self, barcode_type): def encode_data(self): """Gets the encode_data of this GenerateParams. # noqa: E501 + Data to encode into a barcode. # noqa: E501 :return: The encode_data of this GenerateParams. # noqa: E501 :rtype: EncodeData @@ -103,6 +106,7 @@ def encode_data(self): def encode_data(self, encode_data): """Sets the encode_data of this GenerateParams. + Data to encode into a barcode. # noqa: E501 :param encode_data: The encode_data of this GenerateParams. # noqa: E501 :type: EncodeData @@ -116,6 +120,7 @@ def encode_data(self, encode_data): def barcode_image_params(self): """Gets the barcode_image_params of this GenerateParams. # noqa: E501 + Optional barcode image parameters. # noqa: E501 :return: The barcode_image_params of this GenerateParams. # noqa: E501 :rtype: BarcodeImageParams @@ -126,6 +131,7 @@ def barcode_image_params(self): def barcode_image_params(self, barcode_image_params): """Sets the barcode_image_params of this GenerateParams. + Optional barcode image parameters. # noqa: E501 :param barcode_image_params: The barcode_image_params of this GenerateParams. # noqa: E501 :type: BarcodeImageParams @@ -137,6 +143,7 @@ def barcode_image_params(self, barcode_image_params): def qr_params(self): """Gets the qr_params of this GenerateParams. # noqa: E501 + Optional QR barcode generation parameters. # noqa: E501 :return: The qr_params of this GenerateParams. # noqa: E501 :rtype: QrParams @@ -147,6 +154,7 @@ def qr_params(self): def qr_params(self, qr_params): """Sets the qr_params of this GenerateParams. + Optional QR barcode generation parameters. # noqa: E501 :param qr_params: The qr_params of this GenerateParams. # noqa: E501 :type: QrParams @@ -158,6 +166,7 @@ def qr_params(self, qr_params): def code128_params(self): """Gets the code128_params of this GenerateParams. # noqa: E501 + Optional Code128 barcode generation parameters. # noqa: E501 :return: The code128_params of this GenerateParams. # noqa: E501 :rtype: Code128Params @@ -168,6 +177,7 @@ def code128_params(self): def code128_params(self, code128_params): """Sets the code128_params of this GenerateParams. + Optional Code128 barcode generation parameters. # noqa: E501 :param code128_params: The code128_params of this GenerateParams. # noqa: E501 :type: Code128Params @@ -179,6 +189,7 @@ def code128_params(self, code128_params): def pdf417_params(self): """Gets the pdf417_params of this GenerateParams. # noqa: E501 + Optional PDF417 barcode generation parameters. # noqa: E501 :return: The pdf417_params of this GenerateParams. # noqa: E501 :rtype: Pdf417Params @@ -189,6 +200,7 @@ def pdf417_params(self): def pdf417_params(self, pdf417_params): """Sets the pdf417_params of this GenerateParams. + Optional PDF417 barcode generation parameters. # noqa: E501 :param pdf417_params: The pdf417_params of this GenerateParams. # noqa: E501 :type: Pdf417Params diff --git a/aspose_barcode_cloud/models/pdf417_params.py b/aspose_barcode_cloud/models/pdf417_params.py index b41910b..a2d77f7 100644 --- a/aspose_barcode_cloud/models/pdf417_params.py +++ b/aspose_barcode_cloud/models/pdf417_params.py @@ -102,6 +102,7 @@ def __init__( def pdf417_encode_mode(self): """Gets the pdf417_encode_mode of this Pdf417Params. # noqa: E501 + PDF417 barcode encode mode. # noqa: E501 :return: The pdf417_encode_mode of this Pdf417Params. # noqa: E501 :rtype: Pdf417EncodeMode @@ -112,6 +113,7 @@ def pdf417_encode_mode(self): def pdf417_encode_mode(self, pdf417_encode_mode): """Sets the pdf417_encode_mode of this Pdf417Params. + PDF417 barcode encode mode. # noqa: E501 :param pdf417_encode_mode: The pdf417_encode_mode of this Pdf417Params. # noqa: E501 :type: Pdf417EncodeMode @@ -123,6 +125,7 @@ def pdf417_encode_mode(self, pdf417_encode_mode): def pdf417_error_level(self): """Gets the pdf417_error_level of this Pdf417Params. # noqa: E501 + PDF417 barcode error correction level. # noqa: E501 :return: The pdf417_error_level of this Pdf417Params. # noqa: E501 :rtype: Pdf417ErrorLevel @@ -133,6 +136,7 @@ def pdf417_error_level(self): def pdf417_error_level(self, pdf417_error_level): """Sets the pdf417_error_level of this Pdf417Params. + PDF417 barcode error correction level. # noqa: E501 :param pdf417_error_level: The pdf417_error_level of this Pdf417Params. # noqa: E501 :type: Pdf417ErrorLevel @@ -260,6 +264,7 @@ def pdf417_aspect_ratio(self, pdf417_aspect_ratio): def pdf417_eci_encoding(self): """Gets the pdf417_eci_encoding of this Pdf417Params. # noqa: E501 + ECI encoding for PDF417 barcode data. # noqa: E501 :return: The pdf417_eci_encoding of this Pdf417Params. # noqa: E501 :rtype: ECIEncodings @@ -270,6 +275,7 @@ def pdf417_eci_encoding(self): def pdf417_eci_encoding(self, pdf417_eci_encoding): """Sets the pdf417_eci_encoding of this Pdf417Params. + ECI encoding for PDF417 barcode data. # noqa: E501 :param pdf417_eci_encoding: The pdf417_eci_encoding of this Pdf417Params. # noqa: E501 :type: ECIEncodings @@ -304,6 +310,7 @@ def pdf417_is_reader_initialization(self, pdf417_is_reader_initialization): def pdf417_macro_characters(self): """Gets the pdf417_macro_characters of this Pdf417Params. # noqa: E501 + Macro character to prepend (structured append). # noqa: E501 :return: The pdf417_macro_characters of this Pdf417Params. # noqa: E501 :rtype: MacroCharacter @@ -314,6 +321,7 @@ def pdf417_macro_characters(self): def pdf417_macro_characters(self, pdf417_macro_characters): """Sets the pdf417_macro_characters of this Pdf417Params. + Macro character to prepend (structured append). # noqa: E501 :param pdf417_macro_characters: The pdf417_macro_characters of this Pdf417Params. # noqa: E501 :type: MacroCharacter diff --git a/aspose_barcode_cloud/models/qr_params.py b/aspose_barcode_cloud/models/qr_params.py index 8274091..608275b 100644 --- a/aspose_barcode_cloud/models/qr_params.py +++ b/aspose_barcode_cloud/models/qr_params.py @@ -78,6 +78,7 @@ def __init__( def qr_encode_mode(self): """Gets the qr_encode_mode of this QrParams. # noqa: E501 + QR barcode encode mode. # noqa: E501 :return: The qr_encode_mode of this QrParams. # noqa: E501 :rtype: QREncodeMode @@ -88,6 +89,7 @@ def qr_encode_mode(self): def qr_encode_mode(self, qr_encode_mode): """Sets the qr_encode_mode of this QrParams. + QR barcode encode mode. # noqa: E501 :param qr_encode_mode: The qr_encode_mode of this QrParams. # noqa: E501 :type: QREncodeMode @@ -99,6 +101,7 @@ def qr_encode_mode(self, qr_encode_mode): def qr_error_level(self): """Gets the qr_error_level of this QrParams. # noqa: E501 + QR barcode error correction level. # noqa: E501 :return: The qr_error_level of this QrParams. # noqa: E501 :rtype: QRErrorLevel @@ -109,6 +112,7 @@ def qr_error_level(self): def qr_error_level(self, qr_error_level): """Sets the qr_error_level of this QrParams. + QR barcode error correction level. # noqa: E501 :param qr_error_level: The qr_error_level of this QrParams. # noqa: E501 :type: QRErrorLevel @@ -120,6 +124,7 @@ def qr_error_level(self, qr_error_level): def qr_version(self): """Gets the qr_version of this QrParams. # noqa: E501 + QR barcode version. Automatically selects the smallest version that fits the data. # noqa: E501 :return: The qr_version of this QrParams. # noqa: E501 :rtype: QRVersion @@ -130,6 +135,7 @@ def qr_version(self): def qr_version(self, qr_version): """Sets the qr_version of this QrParams. + QR barcode version. Automatically selects the smallest version that fits the data. # noqa: E501 :param qr_version: The qr_version of this QrParams. # noqa: E501 :type: QRVersion @@ -141,6 +147,7 @@ def qr_version(self, qr_version): def qr_eci_encoding(self): """Gets the qr_eci_encoding of this QrParams. # noqa: E501 + ECI encoding for QR barcode data. # noqa: E501 :return: The qr_eci_encoding of this QrParams. # noqa: E501 :rtype: ECIEncodings @@ -151,6 +158,7 @@ def qr_eci_encoding(self): def qr_eci_encoding(self, qr_eci_encoding): """Sets the qr_eci_encoding of this QrParams. + ECI encoding for QR barcode data. # noqa: E501 :param qr_eci_encoding: The qr_eci_encoding of this QrParams. # noqa: E501 :type: ECIEncodings @@ -193,6 +201,7 @@ def qr_aspect_ratio(self, qr_aspect_ratio): def micro_qr_version(self): """Gets the micro_qr_version of this QrParams. # noqa: E501 + MicroQR barcode version. Used when BarcodeType is MicroQR. # noqa: E501 :return: The micro_qr_version of this QrParams. # noqa: E501 :rtype: MicroQRVersion @@ -203,6 +212,7 @@ def micro_qr_version(self): def micro_qr_version(self, micro_qr_version): """Sets the micro_qr_version of this QrParams. + MicroQR barcode version. Used when BarcodeType is MicroQR. # noqa: E501 :param micro_qr_version: The micro_qr_version of this QrParams. # noqa: E501 :type: MicroQRVersion @@ -214,6 +224,7 @@ def micro_qr_version(self, micro_qr_version): def rect_micro_qr_version(self): """Gets the rect_micro_qr_version of this QrParams. # noqa: E501 + RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. # noqa: E501 :return: The rect_micro_qr_version of this QrParams. # noqa: E501 :rtype: RectMicroQRVersion @@ -224,6 +235,7 @@ def rect_micro_qr_version(self): def rect_micro_qr_version(self, rect_micro_qr_version): """Sets the rect_micro_qr_version of this QrParams. + RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. # noqa: E501 :param rect_micro_qr_version: The rect_micro_qr_version of this QrParams. # noqa: E501 :type: RectMicroQRVersion diff --git a/aspose_barcode_cloud/models/recognize_base64_request.py b/aspose_barcode_cloud/models/recognize_base64_request.py index e270cc6..5be1c82 100644 --- a/aspose_barcode_cloud/models/recognize_base64_request.py +++ b/aspose_barcode_cloud/models/recognize_base64_request.py @@ -112,6 +112,7 @@ def file_base64(self, file_base64): def recognition_mode(self): """Gets the recognition_mode of this RecognizeBase64Request. # noqa: E501 + Barcode recognition mode. # noqa: E501 :return: The recognition_mode of this RecognizeBase64Request. # noqa: E501 :rtype: RecognitionMode @@ -122,6 +123,7 @@ def recognition_mode(self): def recognition_mode(self, recognition_mode): """Sets the recognition_mode of this RecognizeBase64Request. + Barcode recognition mode. # noqa: E501 :param recognition_mode: The recognition_mode of this RecognizeBase64Request. # noqa: E501 :type: RecognitionMode @@ -133,6 +135,7 @@ def recognition_mode(self, recognition_mode): def recognition_image_kind(self): """Gets the recognition_image_kind of this RecognizeBase64Request. # noqa: E501 + Image kind for recognition. # noqa: E501 :return: The recognition_image_kind of this RecognizeBase64Request. # noqa: E501 :rtype: RecognitionImageKind @@ -143,6 +146,7 @@ def recognition_image_kind(self): def recognition_image_kind(self, recognition_image_kind): """Sets the recognition_image_kind of this RecognizeBase64Request. + Image kind for recognition. # noqa: E501 :param recognition_image_kind: The recognition_image_kind of this RecognizeBase64Request. # noqa: E501 :type: RecognitionImageKind diff --git a/docs/ApiError.md b/docs/ApiError.md index ad85b2b..0e450e4 100644 --- a/docs/ApiError.md +++ b/docs/ApiError.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **message** | **str** | Gets or sets error message. | **description** | **str** | Gets or sets error description. | [optional] **date_time** | **datetime** | Gets or sets server datetime. | [optional] -**inner_error** | [**ApiError**](ApiError.md) | | [optional] +**inner_error** | [**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 75e03d3..8651679 100644 --- a/docs/ApiErrorResponse.md +++ b/docs/ApiErrorResponse.md @@ -7,6 +7,6 @@ ApiError Response Name | Type | Description | Notes ---- | ---- | ----------- | ----- **request_id** | **str** | 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 a102d8c..2292032 100644 --- a/docs/BarcodeImageParams.md +++ b/docs/BarcodeImageParams.md @@ -6,11 +6,11 @@ Optional barcode image parameters. Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**image_format** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | | [optional] -**text_location** | [**CodeLocation**](CodeLocation.md) | | [optional] +**image_format** | [**BarcodeImageFormat**](BarcodeImageFormat.md) | Barcode output image format. Default value: png. | [optional] +**text_location** | [**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] **foreground_color** | **str** | 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'] **background_color** | **str** | 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] **image_height** | **float** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] **image_width** | **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 8d56379..a71b159 100644 --- a/docs/Code128Params.md +++ b/docs/Code128Params.md @@ -6,6 +6,6 @@ Optional Code128 barcode generation parameters. Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**code128_encode_mode** | [**Code128EncodeMode**](Code128EncodeMode.md) | | [optional] +**code128_encode_mode** | [**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 72f3394..26939d4 100644 --- a/docs/EncodeData.md +++ b/docs/EncodeData.md @@ -6,7 +6,7 @@ Data to encode in a barcode. Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**data_type** | [**EncodeDataType**](EncodeDataType.md) | | [optional] +**data_type** | [**EncodeDataType**](EncodeDataType.md) | Type of data to encode. Default value: StringData. | [optional] **data** | **str** | 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 115604f..493cbfb 100644 --- a/docs/GenerateApi.md +++ b/docs/GenerateApi.md @@ -182,35 +182,35 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.GenerateApi(aspose_barcode_cloud.ApiClient(configuration)) -barcode_type = aspose_barcode_cloud.EncodeBarcodeType() # EncodeBarcodeType | +barcode_type = aspose_barcode_cloud.EncodeBarcodeType() # EncodeBarcodeType | See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ data = 'data_example' # str | String that represents the data to encode. -data_type = aspose_barcode_cloud.EncodeDataType() # EncodeDataType | (optional) -image_format = aspose_barcode_cloud.BarcodeImageFormat() # BarcodeImageFormat | (optional) -text_location = aspose_barcode_cloud.CodeLocation() # CodeLocation | (optional) +data_type = aspose_barcode_cloud.EncodeDataType() # EncodeDataType | Type of data to encode. Default value: StringData. (optional) +image_format = aspose_barcode_cloud.BarcodeImageFormat() # BarcodeImageFormat | Barcode output image format. Default value: png. (optional) +text_location = aspose_barcode_cloud.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) foreground_color = 'Black' # str | 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') background_color = 'White' # str | 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 = aspose_barcode_cloud.GraphicsUnit() # GraphicsUnit | (optional) +units = aspose_barcode_cloud.GraphicsUnit() # GraphicsUnit | Common units for all measurements. Default units: pixels. (optional) resolution = 3.4 # float | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional) image_height = 3.4 # float | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) image_width = 3.4 # float | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional) rotation_angle = 56 # 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) -qr_encode_mode = aspose_barcode_cloud.QREncodeMode() # QREncodeMode | (optional) -qr_error_level = aspose_barcode_cloud.QRErrorLevel() # QRErrorLevel | (optional) -qr_version = aspose_barcode_cloud.QRVersion() # QRVersion | (optional) -qr_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | (optional) +qr_encode_mode = aspose_barcode_cloud.QREncodeMode() # QREncodeMode | QR barcode encode mode. (optional) +qr_error_level = aspose_barcode_cloud.QRErrorLevel() # QRErrorLevel | QR barcode error correction level. (optional) +qr_version = aspose_barcode_cloud.QRVersion() # QRVersion | QR barcode version. Automatically selects the smallest version that fits the data. (optional) +qr_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | ECI encoding for QR barcode data. (optional) qr_aspect_ratio = 3.4 # float | QR barcode aspect ratio. Values: 0 to 1. (optional) -micro_qr_version = aspose_barcode_cloud.MicroQRVersion() # MicroQRVersion | (optional) -rect_micro_qr_version = aspose_barcode_cloud.RectMicroQRVersion() # RectMicroQRVersion | (optional) -code128_encode_mode = aspose_barcode_cloud.Code128EncodeMode() # Code128EncodeMode | (optional) -pdf417_encode_mode = aspose_barcode_cloud.Pdf417EncodeMode() # Pdf417EncodeMode | (optional) -pdf417_error_level = aspose_barcode_cloud.Pdf417ErrorLevel() # Pdf417ErrorLevel | (optional) +micro_qr_version = aspose_barcode_cloud.MicroQRVersion() # MicroQRVersion | MicroQR barcode version. Used when BarcodeType is MicroQR. (optional) +rect_micro_qr_version = aspose_barcode_cloud.RectMicroQRVersion() # RectMicroQRVersion | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional) +code128_encode_mode = aspose_barcode_cloud.Code128EncodeMode() # Code128EncodeMode | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional) +pdf417_encode_mode = aspose_barcode_cloud.Pdf417EncodeMode() # Pdf417EncodeMode | PDF417 barcode encode mode. (optional) +pdf417_error_level = aspose_barcode_cloud.Pdf417ErrorLevel() # Pdf417ErrorLevel | PDF417 barcode error correction level. (optional) pdf417_truncate = True # bool | Whether to use truncated PDF417 format (removes right-side stop pattern). (optional) pdf417_columns = 56 # int | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional) pdf417_rows = 56 # int | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional) pdf417_aspect_ratio = 3.4 # 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) -pdf417_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | (optional) +pdf417_eci_encoding = aspose_barcode_cloud.ECIEncodings() # ECIEncodings | ECI encoding for PDF417 barcode data. (optional) pdf417_is_reader_initialization = True # bool | Whether the barcode is used for reader initialization (programming). (optional) -pdf417_macro_characters = aspose_barcode_cloud.MacroCharacter() # MacroCharacter | (optional) +pdf417_macro_characters = aspose_barcode_cloud.MacroCharacter() # MacroCharacter | Macro character to prepend (structured append). (optional) pdf417_is_linked = True # bool | Whether to use linked mode (for MicroPdf417). (optional) pdf417_is_code128_emulation = True # bool | Whether to use Code128 emulation for MicroPdf417. (optional) @@ -226,35 +226,35 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **barcode_type** | [**EncodeBarcodeType**](EncodeBarcodeType.md)| | + **barcode_type** | [**EncodeBarcodeType**](EncodeBarcodeType.md)| See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ | **data** | **str**| String that represents the data to encode. | - **data_type** | [**EncodeDataType**](EncodeDataType.md)| | [optional] - **image_format** | [**BarcodeImageFormat**](BarcodeImageFormat.md)| | [optional] - **text_location** | [**CodeLocation**](CodeLocation.md)| | [optional] + **data_type** | [**EncodeDataType**](EncodeDataType.md)| Type of data to encode. Default value: StringData. | [optional] + **image_format** | [**BarcodeImageFormat**](BarcodeImageFormat.md)| Barcode output image format. Default value: png. | [optional] + **text_location** | [**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] **foreground_color** | **str**| 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'] **background_color** | **str**| 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] **image_height** | **float**| Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] **image_width** | **float**| Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional] **rotation_angle** | **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] - **qr_encode_mode** | [**QREncodeMode**](QREncodeMode.md)| | [optional] - **qr_error_level** | [**QRErrorLevel**](QRErrorLevel.md)| | [optional] - **qr_version** | [**QRVersion**](QRVersion.md)| | [optional] - **qr_eci_encoding** | [**ECIEncodings**](ECIEncodings.md)| | [optional] + **qr_encode_mode** | [**QREncodeMode**](QREncodeMode.md)| QR barcode encode mode. | [optional] + **qr_error_level** | [**QRErrorLevel**](QRErrorLevel.md)| QR barcode error correction level. | [optional] + **qr_version** | [**QRVersion**](QRVersion.md)| QR barcode version. Automatically selects the smallest version that fits the data. | [optional] + **qr_eci_encoding** | [**ECIEncodings**](ECIEncodings.md)| ECI encoding for QR barcode data. | [optional] **qr_aspect_ratio** | **float**| QR barcode aspect ratio. Values: 0 to 1. | [optional] - **micro_qr_version** | [**MicroQRVersion**](MicroQRVersion.md)| | [optional] - **rect_micro_qr_version** | [**RectMicroQRVersion**](RectMicroQRVersion.md)| | [optional] - **code128_encode_mode** | [**Code128EncodeMode**](Code128EncodeMode.md)| | [optional] - **pdf417_encode_mode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md)| | [optional] - **pdf417_error_level** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md)| | [optional] + **micro_qr_version** | [**MicroQRVersion**](MicroQRVersion.md)| MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional] + **rect_micro_qr_version** | [**RectMicroQRVersion**](RectMicroQRVersion.md)| RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional] + **code128_encode_mode** | [**Code128EncodeMode**](Code128EncodeMode.md)| Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional] + **pdf417_encode_mode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md)| PDF417 barcode encode mode. | [optional] + **pdf417_error_level** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md)| PDF417 barcode error correction level. | [optional] **pdf417_truncate** | **bool**| Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] **pdf417_columns** | **int**| Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] **pdf417_rows** | **int**| Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] **pdf417_aspect_ratio** | **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] - **pdf417_eci_encoding** | [**ECIEncodings**](ECIEncodings.md)| | [optional] + **pdf417_eci_encoding** | [**ECIEncodings**](ECIEncodings.md)| ECI encoding for PDF417 barcode data. | [optional] **pdf417_is_reader_initialization** | **bool**| Whether the barcode is used for reader initialization (programming). | [optional] - **pdf417_macro_characters** | [**MacroCharacter**](MacroCharacter.md)| | [optional] + **pdf417_macro_characters** | [**MacroCharacter**](MacroCharacter.md)| Macro character to prepend (structured append). | [optional] **pdf417_is_linked** | **bool**| Whether to use linked mode (for MicroPdf417). | [optional] **pdf417_is_code128_emulation** | **bool**| Whether to use Code128 emulation for MicroPdf417. | [optional] diff --git a/docs/GenerateParams.md b/docs/GenerateParams.md index 1cdf492..b80af62 100644 --- a/docs/GenerateParams.md +++ b/docs/GenerateParams.md @@ -6,11 +6,11 @@ Barcode generation parameters. Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**barcode_type** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | | -**encode_data** | [**EncodeData**](EncodeData.md) | | -**barcode_image_params** | [**BarcodeImageParams**](BarcodeImageParams.md) | | [optional] -**qr_params** | [**QrParams**](QrParams.md) | | [optional] -**code128_params** | [**Code128Params**](Code128Params.md) | | [optional] -**pdf417_params** | [**Pdf417Params**](Pdf417Params.md) | | [optional] +**barcode_type** | [**EncodeBarcodeType**](EncodeBarcodeType.md) | Barcode type. | +**encode_data** | [**EncodeData**](EncodeData.md) | Data to encode into a barcode. | +**barcode_image_params** | [**BarcodeImageParams**](BarcodeImageParams.md) | Optional barcode image parameters. | [optional] +**qr_params** | [**QrParams**](QrParams.md) | Optional QR barcode generation parameters. | [optional] +**code128_params** | [**Code128Params**](Code128Params.md) | Optional Code128 barcode generation parameters. | [optional] +**pdf417_params** | [**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 d405948..818f3e0 100644 --- a/docs/Pdf417Params.md +++ b/docs/Pdf417Params.md @@ -6,15 +6,15 @@ Optional PDF417 barcode generation parameters. Applies to Pdf417, MacroPdf417, M Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**pdf417_encode_mode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | | [optional] -**pdf417_error_level** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | | [optional] +**pdf417_encode_mode** | [**Pdf417EncodeMode**](Pdf417EncodeMode.md) | PDF417 barcode encode mode. | [optional] +**pdf417_error_level** | [**Pdf417ErrorLevel**](Pdf417ErrorLevel.md) | PDF417 barcode error correction level. | [optional] **pdf417_truncate** | **bool** | Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional] **pdf417_columns** | **int** | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional] **pdf417_rows** | **int** | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional] **pdf417_aspect_ratio** | **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] -**pdf417_eci_encoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] +**pdf417_eci_encoding** | [**ECIEncodings**](ECIEncodings.md) | ECI encoding for PDF417 barcode data. | [optional] **pdf417_is_reader_initialization** | **bool** | Whether the barcode is used for reader initialization (programming). | [optional] -**pdf417_macro_characters** | [**MacroCharacter**](MacroCharacter.md) | | [optional] +**pdf417_macro_characters** | [**MacroCharacter**](MacroCharacter.md) | Macro character to prepend (structured append). | [optional] **pdf417_is_linked** | **bool** | Whether to use linked mode (for MicroPdf417). | [optional] **pdf417_is_code128_emulation** | **bool** | Whether to use Code128 emulation for MicroPdf417. | [optional] diff --git a/docs/QrParams.md b/docs/QrParams.md index 894a5c2..f3939c4 100644 --- a/docs/QrParams.md +++ b/docs/QrParams.md @@ -6,12 +6,12 @@ Optional QR barcode generation parameters. Applies to QR, GS1QR, MicroQR, and Re Name | Type | Description | Notes ---- | ---- | ----------- | ----- -**qr_encode_mode** | [**QREncodeMode**](QREncodeMode.md) | | [optional] -**qr_error_level** | [**QRErrorLevel**](QRErrorLevel.md) | | [optional] -**qr_version** | [**QRVersion**](QRVersion.md) | | [optional] -**qr_eci_encoding** | [**ECIEncodings**](ECIEncodings.md) | | [optional] +**qr_encode_mode** | [**QREncodeMode**](QREncodeMode.md) | QR barcode encode mode. | [optional] +**qr_error_level** | [**QRErrorLevel**](QRErrorLevel.md) | QR barcode error correction level. | [optional] +**qr_version** | [**QRVersion**](QRVersion.md) | QR barcode version. Automatically selects the smallest version that fits the data. | [optional] +**qr_eci_encoding** | [**ECIEncodings**](ECIEncodings.md) | ECI encoding for QR barcode data. | [optional] **qr_aspect_ratio** | **float** | QR barcode aspect ratio. Values: 0 to 1. | [optional] -**micro_qr_version** | [**MicroQRVersion**](MicroQRVersion.md) | | [optional] -**rect_micro_qr_version** | [**RectMicroQRVersion**](RectMicroQRVersion.md) | | [optional] +**micro_qr_version** | [**MicroQRVersion**](MicroQRVersion.md) | MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional] +**rect_micro_qr_version** | [**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 58234e3..317f0e1 100644 --- a/docs/RecognizeApi.md +++ b/docs/RecognizeApi.md @@ -128,10 +128,10 @@ configuration = aspose_barcode_cloud.Configuration(access_token="YOUR_ACCESS_TOK # create an instance of the API class api_instance = aspose_barcode_cloud.RecognizeApi(aspose_barcode_cloud.ApiClient(configuration)) -barcode_type = aspose_barcode_cloud.DecodeBarcodeType() # DecodeBarcodeType | +barcode_type = aspose_barcode_cloud.DecodeBarcodeType() # DecodeBarcodeType | See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ file = None # bytearray | Barcode image file. -recognition_mode = aspose_barcode_cloud.RecognitionMode() # RecognitionMode | (optional) -recognition_image_kind = aspose_barcode_cloud.RecognitionImageKind() # RecognitionImageKind | (optional) +recognition_mode = aspose_barcode_cloud.RecognitionMode() # RecognitionMode | Recognition mode. (optional) +recognition_image_kind = aspose_barcode_cloud.RecognitionImageKind() # RecognitionImageKind | Image kind for recognition. (optional) try: # Recognize a barcode from a file in the request body using a POST request with multipart form parameters. @@ -145,10 +145,10 @@ except ApiException as e: Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **barcode_type** | [**DecodeBarcodeType**](DecodeBarcodeType.md)| | + **barcode_type** | [**DecodeBarcodeType**](DecodeBarcodeType.md)| See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ | **file** | **bytearray**| Barcode image file. | - **recognition_mode** | [**RecognitionMode**](RecognitionMode.md)| | [optional] - **recognition_image_kind** | [**RecognitionImageKind**](RecognitionImageKind.md)| | [optional] + **recognition_mode** | [**RecognitionMode**](RecognitionMode.md)| Recognition mode. | [optional] + **recognition_image_kind** | [**RecognitionImageKind**](RecognitionImageKind.md)| Image kind for recognition. | [optional] ### Return type diff --git a/docs/RecognizeBase64Request.md b/docs/RecognizeBase64Request.md index 9e47667..268c4c6 100644 --- a/docs/RecognizeBase64Request.md +++ b/docs/RecognizeBase64Request.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ---- | ---- | ----------- | ----- **barcode_types** | [**List[DecodeBarcodeType]**](DecodeBarcodeType.md) | Array of barcode decode types to find. | **file_base64** | **str** | Barcode image bytes encoded as base-64. | -**recognition_mode** | [**RecognitionMode**](RecognitionMode.md) | | [optional] -**recognition_image_kind** | [**RecognitionImageKind**](RecognitionImageKind.md) | | [optional] +**recognition_mode** | [**RecognitionMode**](RecognitionMode.md) | Barcode recognition mode. | [optional] +**recognition_image_kind** | [**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) diff --git a/example.py b/example.py index 7065da7..21b98f4 100644 --- a/example.py +++ b/example.py @@ -9,6 +9,8 @@ EncodeBarcodeType, CodeLocation, DecodeBarcodeType, + BarcodeImageParams, + QrParams, QREncodeMode, QRErrorLevel, QRVersion, @@ -25,11 +27,13 @@ response = generateApi.generate( EncodeBarcodeType.QR, "Example", - text_location=CodeLocation.NONE, - qr_encode_mode=QREncodeMode.AUTO, - qr_error_level=QRErrorLevel.LEVELM, - qr_version=QRVersion.AUTO, - qr_aspect_ratio=0.75, + barcode_image_params=BarcodeImageParams(text_location=CodeLocation.NONE), + qr_params=QrParams( + qr_encode_mode=QREncodeMode.AUTO, + qr_error_level=QRErrorLevel.LEVELM, + qr_version=QRVersion.AUTO, + qr_aspect_ratio=0.75, + ), ) with open("example.png", "wb") as f: f.write(response.data) diff --git a/snippets/generate/appearance/generate_get.py b/snippets/generate/appearance/generate_get.py index ad2458d..06e718b 100644 --- a/snippets/generate/appearance/generate_get.py +++ b/snippets/generate/appearance/generate_get.py @@ -1,5 +1,16 @@ import os -from aspose_barcode_cloud import ApiClient, EncodeBarcodeType, BarcodeImageFormat, CodeLocation, Configuration +from aspose_barcode_cloud import ( + ApiClient, + EncodeBarcodeType, + BarcodeImageFormat, + BarcodeImageParams, + CodeLocation, + Configuration, + QrParams, + QREncodeMode, + QRErrorLevel, + QRVersion, +) from aspose_barcode_cloud.api.generate_api import GenerateApi @@ -23,13 +34,21 @@ def main(): response = generate_api.generate( EncodeBarcodeType.QR, "Aspose.BarCode.Cloud", - image_format=BarcodeImageFormat.PNG, - foreground_color="Black", - background_color="White", - resolution=300, - image_height=200, - image_width=200, - text_location=CodeLocation.BELOW, + barcode_image_params=BarcodeImageParams( + image_format=BarcodeImageFormat.PNG, + foreground_color="Black", + background_color="White", + text_location=CodeLocation.BELOW, + resolution=300, + image_height=200, + image_width=200, + ), + qr_params=QrParams( + qr_encode_mode=QREncodeMode.AUTO, + qr_error_level=QRErrorLevel.LEVELM, + qr_version=QRVersion.AUTO, + qr_aspect_ratio=0.75, + ), ) file_name = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "testdata", "qr.png")) diff --git a/snippets/generate/appearance/generate_multipart.py b/snippets/generate/appearance/generate_multipart.py index 5e67c67..b7b1996 100644 --- a/snippets/generate/appearance/generate_multipart.py +++ b/snippets/generate/appearance/generate_multipart.py @@ -1,5 +1,15 @@ import os -from aspose_barcode_cloud import ApiClient, EncodeBarcodeType, BarcodeImageFormat, CodeLocation, Configuration +from aspose_barcode_cloud import ( + ApiClient, + EncodeBarcodeType, + BarcodeImageFormat, + BarcodeImageParams, + CodeLocation, + Configuration, + Pdf417Params, + Pdf417EncodeMode, + Pdf417ErrorLevel, +) from aspose_barcode_cloud.api.generate_api import GenerateApi @@ -25,8 +35,15 @@ def main(): response = generate_api.generate_multipart( barcode_type=EncodeBarcodeType.PDF417, data="Aspose.BarCode.Cloud", - text_location=CodeLocation.ABOVE, - image_format=BarcodeImageFormat.SVG, + barcode_image_params=BarcodeImageParams( + text_location=CodeLocation.ABOVE, + image_format=BarcodeImageFormat.SVG, + ), + pdf417_params=Pdf417Params( + pdf417_encode_mode=Pdf417EncodeMode.AUTO, + pdf417_error_level=Pdf417ErrorLevel.LEVEL2, + pdf417_aspect_ratio=3, + ), ) with open(file_name, "wb") as stream: diff --git a/snippets/generate/save/generate_get.py b/snippets/generate/save/generate_get.py index cff820b..73186a4 100644 --- a/snippets/generate/save/generate_get.py +++ b/snippets/generate/save/generate_get.py @@ -1,5 +1,14 @@ import os -from aspose_barcode_cloud import ApiClient, GenerateApi, EncodeBarcodeType, Configuration +from aspose_barcode_cloud import ( + ApiClient, + GenerateApi, + BarcodeImageFormat, + BarcodeImageParams, + Code128Params, + Code128EncodeMode, + EncodeBarcodeType, + Configuration, +) def make_configuration(): @@ -21,7 +30,12 @@ def main(): file_name = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "testdata", "code128.jpeg")) - response = api.generate(EncodeBarcodeType.CODE128, "Aspose.BarCode.Cloud") + response = api.generate( + EncodeBarcodeType.CODE128, + "Aspose.BarCode.Cloud", + barcode_image_params=BarcodeImageParams(image_format=BarcodeImageFormat.PNG), + code128_params=Code128Params(code128_encode_mode=Code128EncodeMode.AUTO), + ) with open(file_name, "wb") as f: f.write(response.data) diff --git a/snippets/generate/set_colorscheme/generate_get.py b/snippets/generate/set_colorscheme/generate_get.py index 2931814..977325d 100644 --- a/snippets/generate/set_colorscheme/generate_get.py +++ b/snippets/generate/set_colorscheme/generate_get.py @@ -1,5 +1,5 @@ import os -from aspose_barcode_cloud import ApiClient, EncodeBarcodeType, BarcodeImageFormat, Configuration +from aspose_barcode_cloud import ApiClient, EncodeBarcodeType, BarcodeImageFormat, BarcodeImageParams, Configuration from aspose_barcode_cloud.api.generate_api import GenerateApi @@ -26,9 +26,11 @@ def main(): response = generate_api.generate( EncodeBarcodeType.QR, "https://products.aspose.cloud/barcode/family/", - foreground_color="DarkBlue", - background_color="LightGray", - image_format=BarcodeImageFormat.PNG, + barcode_image_params=BarcodeImageParams( + foreground_color="DarkBlue", + background_color="LightGray", + image_format=BarcodeImageFormat.PNG, + ), ) # Write the response to a file diff --git a/snippets/generate/set_colorscheme/generate_multipart.py b/snippets/generate/set_colorscheme/generate_multipart.py index 94423d3..f9b36dd 100644 --- a/snippets/generate/set_colorscheme/generate_multipart.py +++ b/snippets/generate/set_colorscheme/generate_multipart.py @@ -1,5 +1,12 @@ import os -from aspose_barcode_cloud import ApiClient, GenerateApi, EncodeBarcodeType, BarcodeImageFormat, Configuration +from aspose_barcode_cloud import ( + ApiClient, + GenerateApi, + EncodeBarcodeType, + BarcodeImageFormat, + BarcodeImageParams, + Configuration, +) def make_configuration(): @@ -23,9 +30,11 @@ def main(): response = generate_api.generate_multipart( barcode_type=EncodeBarcodeType.CODE39, data="Aspose", - foreground_color="Green", - background_color="Yellow", - image_format=BarcodeImageFormat.GIF, + barcode_image_params=BarcodeImageParams( + foreground_color="Green", + background_color="Yellow", + image_format=BarcodeImageFormat.GIF, + ), ) with open(file_name, "wb") as stream: diff --git a/snippets/generate/set_size/generate_multipart.py b/snippets/generate/set_size/generate_multipart.py index 235dea3..a571cef 100644 --- a/snippets/generate/set_size/generate_multipart.py +++ b/snippets/generate/set_size/generate_multipart.py @@ -1,5 +1,5 @@ import os -from aspose_barcode_cloud import ApiClient, EncodeBarcodeType, Configuration, GraphicsUnit +from aspose_barcode_cloud import ApiClient, BarcodeImageParams, EncodeBarcodeType, Configuration, GraphicsUnit from aspose_barcode_cloud.api.generate_api import GenerateApi @@ -25,10 +25,12 @@ def main(): response = api.generate_multipart( barcode_type=EncodeBarcodeType.AZTEC, data="Aspose.BarCode.Cloud", - image_height=200, - image_width=200, - resolution=150, - units=GraphicsUnit.POINT, + barcode_image_params=BarcodeImageParams( + image_height=200, + image_width=200, + resolution=150, + units=GraphicsUnit.POINT, + ), ) with open(file_name, "wb") as file_stream: file_stream.write(response.data) diff --git a/snippets/generate/set_text/generate_multipart.py b/snippets/generate/set_text/generate_multipart.py index 506e868..f847eca 100644 --- a/snippets/generate/set_text/generate_multipart.py +++ b/snippets/generate/set_text/generate_multipart.py @@ -1,6 +1,13 @@ import os -from aspose_barcode_cloud import ApiClient, EncodeBarcodeType, EncodeDataType, Configuration +from aspose_barcode_cloud import ( + ApiClient, + Code128Params, + Code128EncodeMode, + EncodeBarcodeType, + EncodeDataType, + Configuration, +) from aspose_barcode_cloud.api.generate_api import GenerateApi @@ -23,7 +30,10 @@ def main(): generate_api = GenerateApi(api_client=api_client) response = generate_api.generate_multipart( - EncodeBarcodeType.CODE128, "4173706F73652E426172436F64652E436C6F7564", EncodeDataType.HEXBYTES + EncodeBarcodeType.CODE128, + "4173706F73652E426172436F64652E436C6F7564", + data_type=EncodeDataType.HEXBYTES, + code128_params=Code128Params(code128_encode_mode=Code128EncodeMode.AUTO), ) with open(file_name, "wb") as stream: diff --git a/snippets/read/set_image_kind/recognize_multipart.py b/snippets/read/set_image_kind/recognize_multipart.py index eafd592..f6ef95d 100644 --- a/snippets/read/set_image_kind/recognize_multipart.py +++ b/snippets/read/set_image_kind/recognize_multipart.py @@ -5,6 +5,7 @@ ApiClient, Configuration, DecodeBarcodeType, + RecognitionImageKind, ) @@ -29,7 +30,11 @@ def main(): with open(file_name, "rb") as file: image_bytes = file.read() - result = recognize_api.recognize_multipart(DecodeBarcodeType.MOSTCOMMONLYUSED, image_bytes) + result = recognize_api.recognize_multipart( + DecodeBarcodeType.MOSTCOMMONLYUSED, + image_bytes, + recognition_image_kind=RecognitionImageKind.CLEARIMAGE, + ) print(f"File '{file_name}' recognized, result: '{result.barcodes[0].barcode_value}'") diff --git a/snippets/read/set_quality/recognize_body.py b/snippets/read/set_quality/recognize_body.py index da397f8..d333f68 100644 --- a/snippets/read/set_quality/recognize_body.py +++ b/snippets/read/set_quality/recognize_body.py @@ -5,6 +5,7 @@ ApiClient, Configuration, DecodeBarcodeType, + RecognitionMode, RecognizeBase64Request, ) @@ -31,7 +32,11 @@ def main(): image_bytes = file.read() image_base64 = base64.b64encode(image_bytes).decode("utf-8") - request = RecognizeBase64Request(barcode_types=[DecodeBarcodeType.PDF417], file_base64=image_base64) + request = RecognizeBase64Request( + barcode_types=[DecodeBarcodeType.PDF417], + file_base64=image_base64, + recognition_mode=RecognitionMode.EXCELLENT, + ) result = recognize_api.recognize_base64(request) diff --git a/tests/test_generate_api.py b/tests/test_generate_api.py index 9809d2f..0cdbbf7 100644 --- a/tests/test_generate_api.py +++ b/tests/test_generate_api.py @@ -61,7 +61,10 @@ def test_barcode_generate_multipart_post(self): """ response = self.api.generate_multipart( - EncodeBarcodeType.QR, "54657374", EncodeDataType.HEXBYTES, background_color="0xffe" + EncodeBarcodeType.QR, + "54657374", + EncodeDataType.HEXBYTES, + barcode_image_params=BarcodeImageParams(background_color="0xffe"), ) content_length = int(response.headers["content-length"])