Release 25.1 V4 (#84)

* Generate code for v4

Fixed notFile in templates

Fixed auth type

Fixed tests

Unit tests fixed

Fixed tests

Added exception test

Code formatted

Generate form content type changed to multipart

Test fixed

Regenerated after spec changed

Added snippets placeholders

Set image source snippets moved to github

All snippets converted to python

Added snippets run scripts

Errors fixed

Code changed after addition operationId to spec.

Snippets and tests fixed

Year and version updated

* Snippets formated

* Try to fix ci error

* Fix

* Added snippets tests requirement

* Skip manual fetch token if there is no test configuration

Unified name with github secret

* Bug fix

* Fixed snippet env configuration

* Reformat

* Reformat with python3.13

* README updated

Code formated

* Fix typo and cleanup Makefile

---------

Co-authored-by: Denis Averin <[email protected]>

.github/workflows/python-package.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   build:
     # See https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json
-    # for awailable Python versions on ubuntu
+    # for available Python versions on ubuntu
     runs-on: ubuntu-20.04
     strategy:
       matrix:
@@ -34,4 +34,6 @@ jobs:
     - name: Test
       env:
         TEST_CONFIGURATION_ACCESS_TOKEN: ${{ secrets.TEST_CONFIGURATION_ACCESS_TOKEN }}
-      run: make test test-example
+      run: |
+        chmod +x scripts/*
+        make test test-example

.gitignore

@@ -7,3 +7,4 @@ example.png
 aspose_barcode_cloud.egg-info/
 build/
 dist/
+snippets_test/

Makefile

@@ -8,21 +8,13 @@ check_git:
 	git fetch origin
 	git diff origin/main --exit-code
 
-.PHONY: clean-git
-clean-git:
-	git clean -dfx --exclude='tests/configuration*.json'
-
-.PHONY: clean-pyc
-clean-pyc:
-	find . -type f -name '*.pyc' -delete
-
 .PHONY: dist
 dist:
 	python setup.py sdist bdist_wheel --universal
 
 .PHONY: format
 format:
-	black --line-length=120 -v $(SRC) tests/ scripts/ *.py
+	black --line-length=120 -v $(SRC) tests/ scripts/ snippets/ *.py
 
 .PHONY: format_doc
 format_doc:
@@ -58,6 +50,7 @@ publish-docker: init-docker unittest dist
 .PHONY: test
 test:
 	python -m pytest --cov=aspose_barcode_cloud tests/
+	./scripts/run_snippets.sh
 
 .PHONY: cover
 cover:

README.md

@@ -4,8 +4,13 @@
 [![Python package](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-python/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-python/actions/workflows/python-package.yml)
 [![PyPI](https://img.shields.io/pypi/v/aspose-barcode-cloud)](https://pypi.org/project/aspose-barcode-cloud/)
 
-- API version: 3.0
-- Package version: 24.12.0
+- API version: 4.0
+- Package version: 25.1.0
+
+## SDK and API Version Compatibility:
+
+- SDK Version 25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
+- SDK Version 24.12 and Earlier: These versions are compatible with API Version v3.0.
 
 ## Demo applications
 
@@ -58,7 +63,8 @@ import os
 from pprint import pprint
 
 from aspose_barcode_cloud import (
-    BarcodeApi,
+    GenerateApi,
+    RecognizeApi,
     ApiClient,
     Configuration,
     EncodeBarcodeType,
@@ -72,16 +78,16 @@ config = Configuration(
     access_token=os.environ.get("TEST_CONFIGURATION_ACCESS_TOKEN"),  # Only for testing in CI, remove this line
 )
 
-api = BarcodeApi(ApiClient(config))
-
 # Generate barcode
-response = api.get_barcode_generate(EncodeBarcodeType.QR, "Example", text_location=CodeLocation.NONE)
+generateApi = GenerateApi(ApiClient(config))
+response = generateApi.generate(EncodeBarcodeType.QR, "Example", text_location=CodeLocation.NONE)
 with open("example.png", "wb") as f:
     f.write(response.data)
 print("Barcode saved to file 'example.png'")
 
 # Recognize barcode
-response = api.scan_barcode("example.png", decode_types=[DecodeBarcodeType.QR])
+recognizeApi = RecognizeApi(ApiClient(config))
+response = recognizeApi.recognize_multipart(DecodeBarcodeType.QR, open("example.png", "rb"))
 pprint(response)
 
 ```
@@ -105,113 +111,39 @@ All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed und
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *<https://api.aspose.cloud/v3.0>*
+All URIs are relative to *<https://api.aspose.cloud/v4.0>*
 
 Class | Method | HTTP request | Description
 ----- | ------ | ------------ | -----------
-*BarcodeApi* | [**get_barcode_generate**](docs/BarcodeApi.md#get_barcode_generate) | **GET** /barcode/generate | Generate barcode.
-*BarcodeApi* | [**get_barcode_recognize**](docs/BarcodeApi.md#get_barcode_recognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
-*BarcodeApi* | [**post_barcode_recognize_from_url_or_content**](docs/BarcodeApi.md#post_barcode_recognize_from_url_or_content) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \&quot;application/octet-stream\&quot;. An image can also be passed as a form field.
-*BarcodeApi* | [**post_generate_multiple**](docs/BarcodeApi.md#post_generate_multiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
-*BarcodeApi* | [**put_barcode_generate_file**](docs/BarcodeApi.md#put_barcode_generate_file) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
-*BarcodeApi* | [**put_barcode_recognize_from_body**](docs/BarcodeApi.md#put_barcode_recognize_from_body) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
-*BarcodeApi* | [**put_generate_multiple**](docs/BarcodeApi.md#put_generate_multiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
-*BarcodeApi* | [**scan_barcode**](docs/BarcodeApi.md#scan_barcode) | **POST** /barcode/scan | Quickly scan a barcode from an image.
-*FileApi* | [**copy_file**](docs/FileApi.md#copy_file) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file
-*FileApi* | [**delete_file**](docs/FileApi.md#delete_file) | **DELETE** /barcode/storage/file/{path} | Delete file
-*FileApi* | [**download_file**](docs/FileApi.md#download_file) | **GET** /barcode/storage/file/{path} | Download file
-*FileApi* | [**move_file**](docs/FileApi.md#move_file) | **PUT** /barcode/storage/file/move/{srcPath} | Move file
-*FileApi* | [**upload_file**](docs/FileApi.md#upload_file) | **PUT** /barcode/storage/file/{path} | Upload file
-*FolderApi* | [**copy_folder**](docs/FolderApi.md#copy_folder) | **PUT** /barcode/storage/folder/copy/{srcPath} | Copy folder
-*FolderApi* | [**create_folder**](docs/FolderApi.md#create_folder) | **PUT** /barcode/storage/folder/{path} | Create the folder
-*FolderApi* | [**delete_folder**](docs/FolderApi.md#delete_folder) | **DELETE** /barcode/storage/folder/{path} | Delete folder
-*FolderApi* | [**get_files_list**](docs/FolderApi.md#get_files_list) | **GET** /barcode/storage/folder/{path} | Get all files and folders within a folder
-*FolderApi* | [**move_folder**](docs/FolderApi.md#move_folder) | **PUT** /barcode/storage/folder/move/{srcPath} | Move folder
-*StorageApi* | [**get_disc_usage**](docs/StorageApi.md#get_disc_usage) | **GET** /barcode/storage/disc | Get disc usage
-*StorageApi* | [**get_file_versions**](docs/StorageApi.md#get_file_versions) | **GET** /barcode/storage/version/{path} | Get file versions
-*StorageApi* | [**object_exists**](docs/StorageApi.md#object_exists) | **GET** /barcode/storage/exist/{path} | Check if file or folder exists
-*StorageApi* | [**storage_exists**](docs/StorageApi.md#storage_exists) | **GET** /barcode/storage/{storageName}/exist | Check if storage exists
+*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 using GET requests with parameters in route and query string.
+*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 using GET requests with parameter in query string.
+*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.
 
 ## Documentation For Models
 
 - [ApiError](docs/ApiError.md)
 - [ApiErrorResponse](docs/ApiErrorResponse.md)
-- [AustralianPostParams](docs/AustralianPostParams.md)
-- [AutoSizeMode](docs/AutoSizeMode.md)
-- [AvailableGraphicsUnit](docs/AvailableGraphicsUnit.md)
-- [AztecEncodeMode](docs/AztecEncodeMode.md)
-- [AztecParams](docs/AztecParams.md)
-- [AztecSymbolMode](docs/AztecSymbolMode.md)
+- [BarcodeImageFormat](docs/BarcodeImageFormat.md)
+- [BarcodeImageParams](docs/BarcodeImageParams.md)
 - [BarcodeResponse](docs/BarcodeResponse.md)
 - [BarcodeResponseList](docs/BarcodeResponseList.md)
-- [BorderDashStyle](docs/BorderDashStyle.md)
-- [CaptionParams](docs/CaptionParams.md)
-- [ChecksumValidation](docs/ChecksumValidation.md)
-- [CodabarChecksumMode](docs/CodabarChecksumMode.md)
-- [CodabarParams](docs/CodabarParams.md)
-- [CodabarSymbol](docs/CodabarSymbol.md)
-- [CodablockParams](docs/CodablockParams.md)
-- [Code128Emulation](docs/Code128Emulation.md)
-- [Code128EncodeMode](docs/Code128EncodeMode.md)
-- [Code128Params](docs/Code128Params.md)
-- [Code16KParams](docs/Code16KParams.md)
 - [CodeLocation](docs/CodeLocation.md)
-- [CouponParams](docs/CouponParams.md)
-- [CustomerInformationInterpretingType](docs/CustomerInformationInterpretingType.md)
-- [DataBarParams](docs/DataBarParams.md)
-- [DataMatrixEccType](docs/DataMatrixEccType.md)
-- [DataMatrixEncodeMode](docs/DataMatrixEncodeMode.md)
-- [DataMatrixParams](docs/DataMatrixParams.md)
-- [DataMatrixVersion](docs/DataMatrixVersion.md)
 - [DecodeBarcodeType](docs/DecodeBarcodeType.md)
-- [DiscUsage](docs/DiscUsage.md)
-- [DotCodeEncodeMode](docs/DotCodeEncodeMode.md)
-- [DotCodeParams](docs/DotCodeParams.md)
-- [ECIEncodings](docs/ECIEncodings.md)
-- [EnableChecksum](docs/EnableChecksum.md)
 - [EncodeBarcodeType](docs/EncodeBarcodeType.md)
-- [Error](docs/Error.md)
-- [ErrorDetails](docs/ErrorDetails.md)
-- [FileVersions](docs/FileVersions.md)
-- [FilesList](docs/FilesList.md)
-- [FilesUploadResult](docs/FilesUploadResult.md)
-- [FontMode](docs/FontMode.md)
-- [FontParams](docs/FontParams.md)
-- [FontStyle](docs/FontStyle.md)
-- [GeneratorParams](docs/GeneratorParams.md)
-- [GeneratorParamsList](docs/GeneratorParamsList.md)
-- [HanXinEncodeMode](docs/HanXinEncodeMode.md)
-- [HanXinErrorLevel](docs/HanXinErrorLevel.md)
-- [HanXinParams](docs/HanXinParams.md)
-- [HanXinVersion](docs/HanXinVersion.md)
-- [ITF14BorderType](docs/ITF14BorderType.md)
-- [ITFParams](docs/ITFParams.md)
-- [MacroCharacter](docs/MacroCharacter.md)
-- [MaxiCodeEncodeMode](docs/MaxiCodeEncodeMode.md)
-- [MaxiCodeMode](docs/MaxiCodeMode.md)
-- [MaxiCodeParams](docs/MaxiCodeParams.md)
-- [ObjectExist](docs/ObjectExist.md)
-- [Padding](docs/Padding.md)
-- [PatchCodeParams](docs/PatchCodeParams.md)
-- [PatchFormat](docs/PatchFormat.md)
-- [Pdf417CompactionMode](docs/Pdf417CompactionMode.md)
-- [Pdf417ErrorLevel](docs/Pdf417ErrorLevel.md)
-- [Pdf417MacroTerminator](docs/Pdf417MacroTerminator.md)
-- [Pdf417Params](docs/Pdf417Params.md)
-- [PostalParams](docs/PostalParams.md)
-- [PresetType](docs/PresetType.md)
-- [QREncodeMode](docs/QREncodeMode.md)
-- [QREncodeType](docs/QREncodeType.md)
-- [QRErrorLevel](docs/QRErrorLevel.md)
-- [QRVersion](docs/QRVersion.md)
-- [QrParams](docs/QrParams.md)
-- [ReaderParams](docs/ReaderParams.md)
+- [EncodeData](docs/EncodeData.md)
+- [EncodeDataType](docs/EncodeDataType.md)
+- [GenerateParams](docs/GenerateParams.md)
+- [GraphicsUnit](docs/GraphicsUnit.md)
+- [RecognitionImageKind](docs/RecognitionImageKind.md)
+- [RecognitionMode](docs/RecognitionMode.md)
+- [RecognizeBase64Request](docs/RecognizeBase64Request.md)
 - [RegionPoint](docs/RegionPoint.md)
-- [ResultImageInfo](docs/ResultImageInfo.md)
-- [StorageExist](docs/StorageExist.md)
-- [StorageFile](docs/StorageFile.md)
-- [StructuredAppend](docs/StructuredAppend.md)
-- [TextAlignment](docs/TextAlignment.md)
-- [FileVersion](docs/FileVersion.md)
+- [ScanBase64Request](docs/ScanBase64Request.md)
 
 

aspose_barcode_cloud/__init__.py

@@ -5,10 +5,9 @@
 from aspose_barcode_cloud.rest import ApiException
 
 # import apis into sdk package
-from aspose_barcode_cloud.api.barcode_api import BarcodeApi
-from aspose_barcode_cloud.api.file_api import FileApi
-from aspose_barcode_cloud.api.folder_api import FolderApi
-from aspose_barcode_cloud.api.storage_api import StorageApi
+from aspose_barcode_cloud.api.generate_api import GenerateApi
+from aspose_barcode_cloud.api.recognize_api import RecognizeApi
+from aspose_barcode_cloud.api.scan_api import ScanApi
 
 # import ApiClient
 from aspose_barcode_cloud.api_client import ApiClient
@@ -17,80 +16,19 @@
 # import models into sdk package
 from aspose_barcode_cloud.models.api_error import ApiError
 from aspose_barcode_cloud.models.api_error_response import ApiErrorResponse
-from aspose_barcode_cloud.models.australian_post_params import AustralianPostParams
-from aspose_barcode_cloud.models.auto_size_mode import AutoSizeMode
-from aspose_barcode_cloud.models.available_graphics_unit import AvailableGraphicsUnit
-from aspose_barcode_cloud.models.aztec_encode_mode import AztecEncodeMode
-from aspose_barcode_cloud.models.aztec_params import AztecParams
-from aspose_barcode_cloud.models.aztec_symbol_mode import AztecSymbolMode
+from aspose_barcode_cloud.models.barcode_image_format import BarcodeImageFormat
+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.border_dash_style import BorderDashStyle
-from aspose_barcode_cloud.models.caption_params import CaptionParams
-from aspose_barcode_cloud.models.checksum_validation import ChecksumValidation
-from aspose_barcode_cloud.models.codabar_checksum_mode import CodabarChecksumMode
-from aspose_barcode_cloud.models.codabar_params import CodabarParams
-from aspose_barcode_cloud.models.codabar_symbol import CodabarSymbol
-from aspose_barcode_cloud.models.codablock_params import CodablockParams
-from aspose_barcode_cloud.models.code128_emulation import Code128Emulation
-from aspose_barcode_cloud.models.code128_encode_mode import Code128EncodeMode
-from aspose_barcode_cloud.models.code128_params import Code128Params
-from aspose_barcode_cloud.models.code16_k_params import Code16KParams
 from aspose_barcode_cloud.models.code_location import CodeLocation
-from aspose_barcode_cloud.models.coupon_params import CouponParams
-from aspose_barcode_cloud.models.customer_information_interpreting_type import CustomerInformationInterpretingType
-from aspose_barcode_cloud.models.data_bar_params import DataBarParams
-from aspose_barcode_cloud.models.data_matrix_ecc_type import DataMatrixEccType
-from aspose_barcode_cloud.models.data_matrix_encode_mode import DataMatrixEncodeMode
-from aspose_barcode_cloud.models.data_matrix_params import DataMatrixParams
-from aspose_barcode_cloud.models.data_matrix_version import DataMatrixVersion
 from aspose_barcode_cloud.models.decode_barcode_type import DecodeBarcodeType
-from aspose_barcode_cloud.models.disc_usage import DiscUsage
-from aspose_barcode_cloud.models.dot_code_encode_mode import DotCodeEncodeMode
-from aspose_barcode_cloud.models.dot_code_params import DotCodeParams
-from aspose_barcode_cloud.models.eci_encodings import ECIEncodings
-from aspose_barcode_cloud.models.enable_checksum import EnableChecksum
 from aspose_barcode_cloud.models.encode_barcode_type import EncodeBarcodeType
-from aspose_barcode_cloud.models.error import Error
-from aspose_barcode_cloud.models.error_details import ErrorDetails
-from aspose_barcode_cloud.models.file_versions import FileVersions
-from aspose_barcode_cloud.models.files_list import FilesList
-from aspose_barcode_cloud.models.files_upload_result import FilesUploadResult
-from aspose_barcode_cloud.models.font_mode import FontMode
-from aspose_barcode_cloud.models.font_params import FontParams
-from aspose_barcode_cloud.models.font_style import FontStyle
-from aspose_barcode_cloud.models.generator_params import GeneratorParams
-from aspose_barcode_cloud.models.generator_params_list import GeneratorParamsList
-from aspose_barcode_cloud.models.han_xin_encode_mode import HanXinEncodeMode
-from aspose_barcode_cloud.models.han_xin_error_level import HanXinErrorLevel
-from aspose_barcode_cloud.models.han_xin_params import HanXinParams
-from aspose_barcode_cloud.models.han_xin_version import HanXinVersion
-from aspose_barcode_cloud.models.itf14_border_type import ITF14BorderType
-from aspose_barcode_cloud.models.itf_params import ITFParams
-from aspose_barcode_cloud.models.macro_character import MacroCharacter
-from aspose_barcode_cloud.models.maxi_code_encode_mode import MaxiCodeEncodeMode
-from aspose_barcode_cloud.models.maxi_code_mode import MaxiCodeMode
-from aspose_barcode_cloud.models.maxi_code_params import MaxiCodeParams
-from aspose_barcode_cloud.models.object_exist import ObjectExist
-from aspose_barcode_cloud.models.padding import Padding
-from aspose_barcode_cloud.models.patch_code_params import PatchCodeParams
-from aspose_barcode_cloud.models.patch_format import PatchFormat
-from aspose_barcode_cloud.models.pdf417_compaction_mode import Pdf417CompactionMode
-from aspose_barcode_cloud.models.pdf417_error_level import Pdf417ErrorLevel
-from aspose_barcode_cloud.models.pdf417_macro_terminator import Pdf417MacroTerminator
-from aspose_barcode_cloud.models.pdf417_params import Pdf417Params
-from aspose_barcode_cloud.models.postal_params import PostalParams
-from aspose_barcode_cloud.models.preset_type import PresetType
-from aspose_barcode_cloud.models.qr_encode_mode import QREncodeMode
-from aspose_barcode_cloud.models.qr_encode_type import QREncodeType
-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.reader_params import ReaderParams
+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.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.region_point import RegionPoint
-from aspose_barcode_cloud.models.result_image_info import ResultImageInfo
-from aspose_barcode_cloud.models.storage_exist import StorageExist
-from aspose_barcode_cloud.models.storage_file import StorageFile
-from aspose_barcode_cloud.models.structured_append import StructuredAppend
-from aspose_barcode_cloud.models.text_alignment import TextAlignment
-from aspose_barcode_cloud.models.file_version import FileVersion
+from aspose_barcode_cloud.models.scan_base64_request import ScanBase64Request

aspose_barcode_cloud/api/__init__.py

@@ -1,7 +1,6 @@
 # flake8: noqa
 
 # import apis into api package
-from aspose_barcode_cloud.api.barcode_api import BarcodeApi
-from aspose_barcode_cloud.api.file_api import FileApi
-from aspose_barcode_cloud.api.folder_api import FolderApi
-from aspose_barcode_cloud.api.storage_api import StorageApi
+from aspose_barcode_cloud.api.generate_api import GenerateApi
+from aspose_barcode_cloud.api.recognize_api import RecognizeApi
+from aspose_barcode_cloud.api.scan_api import ScanApi