Skip to content

Commit

Permalink
Release 23.11 (#67)
Browse files Browse the repository at this point in the history
* Update version to 23.11.0

* Update API

* Change Maximum timeout value

* Use requirements from requirements.txt
  • Loading branch information
Denis-Averin committed Nov 28, 2023
1 parent e3b3a17 commit 31387f5
Show file tree
Hide file tree
Showing 15 changed files with 119 additions and 20 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![PyPI](https://img.shields.io/pypi/v/aspose-barcode-cloud)](https://pypi.org/project/aspose-barcode-cloud/)

- API version: 3.0
- Package version: 23.10.0
- Package version: 23.11.0

## Demo applications

Expand Down
4 changes: 2 additions & 2 deletions aspose_barcode_cloud/api/barcode_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ def get_barcode_recognize(
:param int rect_width: Set Width of area for recognition. # noqa: E501
:param int rect_height: Set Height of area for recognition. # noqa: E501
:param bool strip_fnc: Value indicating whether FNC symbol strip must be done. # noqa: E501
:param int timeout: Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
:param int timeout: Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
:param int median_smoothing_window_size: Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. # noqa: E501
:param bool allow_median_smoothing: Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. # noqa: E501
:param bool allow_complex_background: Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. # noqa: E501
Expand Down Expand Up @@ -834,7 +834,7 @@ def post_barcode_recognize_from_url_or_content(
:param int rect_width: Set Width of area for recognition. # noqa: E501
:param int rect_height: Set Height of area for recognition. # noqa: E501
:param bool strip_fnc: Value indicating whether FNC symbol strip must be done. # noqa: E501
:param int timeout: Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
:param int timeout: Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
:param int median_smoothing_window_size: Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. # noqa: E501
:param bool allow_median_smoothing: Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. # noqa: E501
:param bool allow_complex_background: Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. # noqa: E501
Expand Down
4 changes: 2 additions & 2 deletions aspose_barcode_cloud/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,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": "23.10.0",
"x-aspose-client-version": "23.11.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/23.10.0/python"
self.user_agent = "Aspose-Barcode-SDK/23.11.0/python"

def __del__(self):
self.rest_client.close()
Expand Down
2 changes: 1 addition & 1 deletion aspose_barcode_cloud/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ def to_debug_report(self):
"OS: {env}\n"
"Python Version: {pyversion}\n"
"Version of the API: 3.0\n"
"SDK Package Version: 23.10.0".format(env=sys.platform, pyversion=sys.version)
"SDK Package Version: 23.11.0".format(env=sys.platform, pyversion=sys.version)
)

@staticmethod
Expand Down
1 change: 1 addition & 0 deletions aspose_barcode_cloud/models/decode_barcode_type.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ class DecodeBarcodeType(object):
GS1HANXIN = "GS1HanXin"
GS1AZTEC = "GS1Aztec"
GS1COMPOSITEBAR = "GS1CompositeBar"
GS1MICROPDF417 = "GS1MicroPdf417"

"""
Attributes:
Expand Down
1 change: 1 addition & 0 deletions aspose_barcode_cloud/models/encode_barcode_type.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ class EncodeBarcodeType(object):
HANXIN = "HanXin"
GS1HANXIN = "GS1HanXin"
GS1AZTEC = "GS1Aztec"
GS1MICROPDF417 = "GS1MicroPdf417"

"""
Attributes:
Expand Down
95 changes: 93 additions & 2 deletions aspose_barcode_cloud/models/pdf417_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,10 @@ class Pdf417Params(object):
"macro_addressee": "str",
"macro_eci_encoding": "ECIEncodings",
"code128_emulation": "Code128Emulation",
"is_code128_emulation": "bool",
"pdf417_macro_terminator": "Pdf417MacroTerminator",
"is_linked": "bool",
"macro_characters": "MacroCharacter",
}

attribute_map = {
Expand All @@ -90,7 +93,10 @@ class Pdf417Params(object):
"macro_addressee": "MacroAddressee",
"macro_eci_encoding": "MacroECIEncoding",
"code128_emulation": "Code128Emulation",
"is_code128_emulation": "IsCode128Emulation",
"pdf417_macro_terminator": "Pdf417MacroTerminator",
"is_linked": "IsLinked",
"macro_characters": "MacroCharacters",
}

def __init__(
Expand All @@ -115,7 +121,10 @@ def __init__(
macro_addressee=None,
macro_eci_encoding=None,
code128_emulation=None,
is_code128_emulation=None,
pdf417_macro_terminator=None,
is_linked=None,
macro_characters=None,
): # noqa: E501
"""Pdf417Params - a model defined in Swagger""" # noqa: E501

Expand All @@ -139,7 +148,10 @@ def __init__(
self._macro_addressee = None
self._macro_eci_encoding = None
self._code128_emulation = None
self._is_code128_emulation = None
self._pdf417_macro_terminator = None
self._is_linked = None
self._macro_characters = None
self.discriminator = None

if aspect_ratio is not None:
Expand Down Expand Up @@ -182,8 +194,14 @@ def __init__(
self.macro_eci_encoding = macro_eci_encoding
if code128_emulation is not None:
self.code128_emulation = code128_emulation
if is_code128_emulation is not None:
self.is_code128_emulation = is_code128_emulation
if pdf417_macro_terminator is not None:
self.pdf417_macro_terminator = pdf417_macro_terminator
if is_linked is not None:
self.is_linked = is_linked
if macro_characters is not None:
self.macro_characters = macro_characters

@property
def aspect_ratio(self):
Expand Down Expand Up @@ -630,7 +648,7 @@ def macro_eci_encoding(self, macro_eci_encoding):
def code128_emulation(self):
"""Gets the code128_emulation of this Pdf417Params. # noqa: E501
Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. # noqa: E501
DEPRECATED: This property is obsolete and will be removed in future releases. See samples of using new parameters on https://releases.aspose.com/barcode/net/release-notes/2023/aspose-barcode-for-net-23-10-release-notes/ Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. # noqa: E501
:return: The code128_emulation of this Pdf417Params. # noqa: E501
:rtype: Code128Emulation
Expand All @@ -641,14 +659,41 @@ def code128_emulation(self):
def code128_emulation(self, code128_emulation):
"""Sets the code128_emulation of this Pdf417Params.
Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. # noqa: E501
DEPRECATED: This property is obsolete and will be removed in future releases. See samples of using new parameters on https://releases.aspose.com/barcode/net/release-notes/2023/aspose-barcode-for-net-23-10-release-notes/ Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. # noqa: E501
:param code128_emulation: The code128_emulation of this Pdf417Params. # noqa: E501
:type: Code128Emulation
"""
warnings.warn(
"Property 'code128_emulation' is deprecated. This property is obsolete and will be removed in future releases. See samples of using new parameters on https://releases.aspose.com/barcode/net/release-notes/2023/aspose-barcode-for-net-23-10-release-notes/ Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.", # noqa: E501
category=DeprecationWarning,
)

self._code128_emulation = code128_emulation

@property
def is_code128_emulation(self):
"""Gets the is_code128_emulation of this Pdf417Params. # noqa: E501
Can be used only with MicroPdf417 and encodes Code 128 emulation modes. Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128. # noqa: E501
:return: The is_code128_emulation of this Pdf417Params. # noqa: E501
:rtype: bool
"""
return self._is_code128_emulation

@is_code128_emulation.setter
def is_code128_emulation(self, is_code128_emulation):
"""Sets the is_code128_emulation of this Pdf417Params.
Can be used only with MicroPdf417 and encodes Code 128 emulation modes. Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128. # noqa: E501
:param is_code128_emulation: The is_code128_emulation of this Pdf417Params. # noqa: E501
:type: bool
"""

self._is_code128_emulation = is_code128_emulation

@property
def pdf417_macro_terminator(self):
"""Gets the pdf417_macro_terminator of this Pdf417Params. # noqa: E501
Expand All @@ -672,6 +717,52 @@ def pdf417_macro_terminator(self, pdf417_macro_terminator):

self._pdf417_macro_terminator = pdf417_macro_terminator

@property
def is_linked(self):
"""Gets the is_linked of this Pdf417Params. # noqa: E501
Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes. With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes. With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC. # noqa: E501
:return: The is_linked of this Pdf417Params. # noqa: E501
:rtype: bool
"""
return self._is_linked

@is_linked.setter
def is_linked(self, is_linked):
"""Sets the is_linked of this Pdf417Params.
Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes. With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes. With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC. # noqa: E501
:param is_linked: The is_linked of this Pdf417Params. # noqa: E501
:type: bool
"""

self._is_linked = is_linked

@property
def macro_characters(self):
"""Gets the macro_characters of this Pdf417Params. # noqa: E501
Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes. Default value: MacroCharacters.None. # noqa: E501
:return: The macro_characters of this Pdf417Params. # noqa: E501
:rtype: MacroCharacter
"""
return self._macro_characters

@macro_characters.setter
def macro_characters(self, macro_characters):
"""Sets the macro_characters of this Pdf417Params.
Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes. Default value: MacroCharacters.None. # noqa: E501
:param macro_characters: The macro_characters of this Pdf417Params. # noqa: E501
:type: MacroCharacter
"""

self._macro_characters = macro_characters

def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
Expand Down
4 changes: 2 additions & 2 deletions aspose_barcode_cloud/models/reader_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ def strip_fnc(self, strip_fnc):
def timeout(self):
"""Gets the timeout of this ReaderParams. # noqa: E501
Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
:return: The timeout of this ReaderParams. # noqa: E501
:rtype: int
Expand All @@ -491,7 +491,7 @@ def timeout(self):
def timeout(self, timeout):
"""Sets the timeout of this ReaderParams.
Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. # noqa: E501
:param timeout: The timeout of this ReaderParams. # noqa: E501
:type: int
Expand Down
8 changes: 4 additions & 4 deletions docs/BarcodeApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ rect_y = 56 # int | Set Y of top left corner of area for recognition. (optional)
rect_width = 56 # int | Set Width of area for recognition. (optional)
rect_height = 56 # int | Set Height of area for recognition. (optional)
strip_fnc = True # bool | Value indicating whether FNC symbol strip must be done. (optional)
timeout = 56 # int | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. (optional)
timeout = 56 # int | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. (optional)
median_smoothing_window_size = 56 # int | Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. (optional)
allow_median_smoothing = True # bool | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. (optional)
allow_complex_background = True # bool | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. (optional)
Expand Down Expand Up @@ -211,7 +211,7 @@ Name | Type | Description | Notes
**rect_width** | **int**| Set Width of area for recognition. | [optional]
**rect_height** | **int**| Set Height of area for recognition. | [optional]
**strip_fnc** | **bool**| Value indicating whether FNC symbol strip must be done. | [optional]
**timeout** | **int**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
**timeout** | **int**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
**median_smoothing_window_size** | **int**| Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
**allow_median_smoothing** | **bool**| Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
**allow_complex_background** | **bool**| Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
Expand Down Expand Up @@ -282,7 +282,7 @@ rect_y = 56 # int | Set Y of top left corner of area for recognition. (optional)
rect_width = 56 # int | Set Width of area for recognition. (optional)
rect_height = 56 # int | Set Height of area for recognition. (optional)
strip_fnc = True # bool | Value indicating whether FNC symbol strip must be done. (optional)
timeout = 56 # int | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. (optional)
timeout = 56 # int | Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. (optional)
median_smoothing_window_size = 56 # int | Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. (optional)
allow_median_smoothing = True # bool | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. (optional)
allow_complex_background = True # bool | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. (optional)
Expand Down Expand Up @@ -332,7 +332,7 @@ Name | Type | Description | Notes
**rect_width** | **int**| Set Width of area for recognition. | [optional]
**rect_height** | **int**| Set Height of area for recognition. | [optional]
**strip_fnc** | **bool**| Value indicating whether FNC symbol strip must be done. | [optional]
**timeout** | **int**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 60_000 (1 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
**timeout** | **int**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). Maximum value is 30_000 (1/2 minute). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
**median_smoothing_window_size** | **int**| Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
**allow_median_smoothing** | **bool**| Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
**allow_complex_background** | **bool**| Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Code128Emulation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code128Emulation


DEPRECATED. This enum will be removed in future releases Function codewords for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.
## Allowable values

* **Code128Emulation.NONE**
Expand Down
1 change: 1 addition & 0 deletions docs/DecodeBarcodeType.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,6 @@ See DecodeType
* DecodeBarcodeType.GS1HANXIN
* DecodeBarcodeType.GS1AZTEC
* DecodeBarcodeType.GS1COMPOSITEBAR
* DecodeBarcodeType.GS1MICROPDF417

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1 change: 1 addition & 0 deletions docs/EncodeBarcodeType.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,6 @@ See EncodeTypes
* EncodeBarcodeType.HANXIN
* EncodeBarcodeType.GS1HANXIN
* EncodeBarcodeType.GS1AZTEC
* EncodeBarcodeType.GS1MICROPDF417

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Loading

0 comments on commit 31387f5

Please sign in to comment.