Release 20.12 (#6)

aspose-barcode-cloud · Dec 25, 2020 · 45ee15c · 45ee15c
1 parent 3120bd0
commit 45ee15c
Show file tree

Hide file tree

Showing 21 changed files with 705 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Aspose.BarCode Cloud SDK for PHP
 
 - API version: 3.0
-- Package version: 20.11.0
+- Package version: 20.12.0
 
 Aspose.BarCode for Cloud is a REST API for Linear, 2D and postal barcode generation and recognition in the cloud. API recognizes and generates barcode images in a variety of formats. Barcode REST API allows to specify barcode image attributes like image width, height, border style and output image format in order to customize the generation process. Developers can also specify the barcode type and text attributes such as text location and font styles in order to suit the application requirements.
 
@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
 - [GeneratorParamsList](docs/Model/GeneratorParamsList.md)
 - [ITF14BorderType](docs/Model/ITF14BorderType.md)
 - [ITFParams](docs/Model/ITFParams.md)
+- [MacroCharacter](docs/Model/MacroCharacter.md)
 - [MaxiCodeParams](docs/Model/MaxiCodeParams.md)
 - [ObjectExist](docs/Model/ObjectExist.md)
 - [Padding](docs/Model/Padding.md)
@@ -160,6 +161,7 @@ Class | Method | HTTP request | Description
 - [ResultImageInfo](docs/Model/ResultImageInfo.md)
 - [StorageExist](docs/Model/StorageExist.md)
 - [StorageFile](docs/Model/StorageFile.md)
+- [StructuredAppend](docs/Model/StructuredAppend.md)
 - [TextAlignment](docs/Model/TextAlignment.md)
 - [FileVersion](docs/Model/FileVersion.md)
 
diff --git a/docs/Api/BarcodeApi.md b/docs/Api/BarcodeApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 
 # **getBarcodeGenerate**
-> \SplFileObject getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format)
+> \SplFileObject getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format)
 
 Generate barcode.
 
@@ -39,6 +39,7 @@ $text_location = "text_location_example"; // string | Specify the displaying Tex
 $text_alignment = "text_alignment_example"; // string | Text alignment.
 $text_color = "text_color_example"; // string | Specify the displaying CodeText's Color. Default value: Color.Black.
 $font_size_mode = "font_size_mode_example"; // string | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
+$no_wrap = true; // bool | Specify word wraps (line breaks) within text. Default value: false.
 $resolution = 1.2; // double | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
 $resolution_x = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
 $resolution_y = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
@@ -68,7 +69,7 @@ $bar_width_reduction = 1.2; // double | Bars reduction value that is used to com
 $format = "format_example"; // string | Result image format.
 
 try {
-    $result = $apiInstance->getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format);
+    $result = $apiInstance->getBarcodeGenerate($type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $format);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling BarcodeApi->getBarcodeGenerate: ', $e->getMessage(), PHP_EOL;
@@ -87,6 +88,7 @@ Name | Type | Description  | Notes
  **text_alignment** | **string**| Text alignment. | [optional]
  **text_color** | **string**| Specify the displaying CodeText&#39;s Color. Default value: Color.Black. | [optional]
  **font_size_mode** | **string**| Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional]
+ **no_wrap** | **bool**| Specify word wraps (line breaks) within text. Default value: false. | [optional]
  **resolution** | **double**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
  **resolution_x** | **double**| DEPRECATED: Use &#39;Resolution&#39; instead. | [optional]
  **resolution_y** | **double**| DEPRECATED: Use &#39;Resolution&#39; instead. | [optional]
@@ -420,7 +422,7 @@ 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)
 
 # **putBarcodeGenerateFile**
-> \Aspose\BarCode\Model\ResultImageInfo putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format)
+> \Aspose\BarCode\Model\ResultImageInfo putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format)
 
 Generate barcode and save on server (from query params or from file with json or xml content)
 
@@ -446,6 +448,7 @@ $text_location = "text_location_example"; // string | Specify the displaying Tex
 $text_alignment = "text_alignment_example"; // string | Text alignment.
 $text_color = "text_color_example"; // string | Specify the displaying CodeText's Color. Default value: Color.Black.
 $font_size_mode = "font_size_mode_example"; // string | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
+$no_wrap = true; // bool | Specify word wraps (line breaks) within text. Default value: false.
 $resolution = 1.2; // double | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
 $resolution_x = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
 $resolution_y = 1.2; // double | DEPRECATED: Use 'Resolution' instead.
@@ -477,7 +480,7 @@ $folder = "folder_example"; // string | Image's folder.
 $format = "format_example"; // string | The image format.
 
 try {
-    $result = $apiInstance->putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format);
+    $result = $apiInstance->putBarcodeGenerateFile($name, $type, $text, $two_d_display_text, $text_location, $text_alignment, $text_color, $font_size_mode, $no_wrap, $resolution, $resolution_x, $resolution_y, $dimension_x, $text_space, $units, $size_mode, $bar_height, $image_height, $image_width, $rotation_angle, $back_color, $bar_color, $border_color, $border_width, $border_dash_style, $border_visible, $enable_checksum, $enable_escape, $filled_bars, $always_show_checksum, $wide_narrow_ratio, $validate_text, $supplement_data, $supplement_space, $bar_width_reduction, $storage, $folder, $format);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling BarcodeApi->putBarcodeGenerateFile: ', $e->getMessage(), PHP_EOL;
@@ -497,6 +500,7 @@ Name | Type | Description  | Notes
  **text_alignment** | **string**| Text alignment. | [optional]
  **text_color** | **string**| Specify the displaying CodeText&#39;s Color. Default value: Color.Black. | [optional]
  **font_size_mode** | **string**| Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional]
+ **no_wrap** | **bool**| Specify word wraps (line breaks) within text. Default value: false. | [optional]
  **resolution** | **double**| Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional]
  **resolution_x** | **double**| DEPRECATED: Use &#39;Resolution&#39; instead. | [optional]
  **resolution_y** | **double**| DEPRECATED: Use &#39;Resolution&#39; instead. | [optional]

diff --git a/docs/Model/CaptionParams.md b/docs/Model/CaptionParams.md
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **visible** | **bool** | Is caption visible. | [optional] 
 **font** | [**\Aspose\BarCode\Model\FontParams**](FontParams.md) | Font. | [optional] 
 **padding** | [**\Aspose\BarCode\Model\Padding**](Padding.md) | Padding. | [optional] 
+**no_wrap** | **bool** | Specify word wraps (line breaks) within text. Default value: false. | [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/Model/DataBarParams.md b/docs/Model/DataBarParams.md
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
 **aspect_ratio** | **double** | Height/Width ratio of 2D BarCode module. Used for DataBar stacked. | [optional] 
 **columns** | **int** | Columns count. | [optional] 
 **rows** | **int** | Rows count. | [optional] 
+**is2_d_composite_component** | **bool** | Enables flag of 2D composite component with DataBar barcode | [optional] 
+**is_allow_only_gs1_encoding** | **bool** | If this flag is set, it allows only GS1 encoding standard for Databar barcode types | [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/Model/DataMatrixParams.md b/docs/Model/DataMatrixParams.md
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **data_matrix_ecc** | [**\Aspose\BarCode\Model\DataMatrixEccType**](DataMatrixEccType.md) | Datamatrix ECC type. Default value: DataMatrixEccType.Ecc200. | [optional] 
 **data_matrix_encode_mode** | [**\Aspose\BarCode\Model\DataMatrixEncodeMode**](DataMatrixEncodeMode.md) | Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.Auto. | [optional] 
 **rows** | **int** | Rows count. | [optional] 
+**macro_characters** | [**\Aspose\BarCode\Model\MacroCharacter**](MacroCharacter.md) | Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with DataMatrixEccType.Ecc200 or DataMatrixEccType.EccAuto. Cannot be used with EncodeTypes.GS1DataMatrix Default value: MacroCharacters.None. | [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/Model/GeneratorParams.md b/docs/Model/GeneratorParams.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **text_color** | **string** | Specify the displaying CodeText&#39;s Color. Default value: Color.Black. | [optional] 
 **font** | [**\Aspose\BarCode\Model\FontParams**](FontParams.md) | Specify the displaying Text&#39;s font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto. | [optional] 
 **font_size_mode** | [**\Aspose\BarCode\Model\FontMode**](FontMode.md) | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. | [optional] 
+**no_wrap** | **bool** | Specify word wraps (line breaks) within text. Default value: false. | [optional] 
 **resolution** | **double** | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. | [optional] 
 **resolution_x** | **double** | DEPRECATED: Use &#39;Resolution&#39; instead. | [optional] 
 **resolution_y** | **double** | DEPRECATED: Use &#39;Resolution&#39; instead. | [optional] 

diff --git a/docs/Model/MacroCharacter.md b/docs/Model/MacroCharacter.md
@@ -0,0 +1,9 @@
+# MacroCharacter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[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/Model/QrParams.md b/docs/Model/QrParams.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **encode_mode** | [**\Aspose\BarCode\Model\QREncodeMode**](QREncodeMode.md) | QR symbology type of BarCode&#39;s encoding mode. Default value: QREncodeMode.Auto. | [optional] 
 **error_level** | [**\Aspose\BarCode\Model\QRErrorLevel**](QRErrorLevel.md) | Level of Reed-Solomon error correction for QR barcode. From low to high: LevelL, LevelM, LevelQ, LevelH. see QRErrorLevel. | [optional] 
 **version** | [**\Aspose\BarCode\Model\QRVersion**](QRVersion.md) | Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.Auto. | [optional] 
+**structured_append** | [**\Aspose\BarCode\Model\StructuredAppend**](StructuredAppend.md) | QR structured append 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/Model/StructuredAppend.md b/docs/Model/StructuredAppend.md
@@ -0,0 +1,12 @@
+# StructuredAppend
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sequence_indicator** | **int** | The index of the QR structured append mode barcode. Index starts from 0. | [optional] 
+**total_count** | **int** | Gets or sets the QR structured append mode barcodes quantity. Max value is 16. | [optional] 
+**parity_byte** | **int** | Gets or sets the QR structured append mode parity data. | [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/src/Aspose/BarCode/BarcodeApi.php b/src/Aspose/BarCode/BarcodeApi.php
@@ -352,6 +352,16 @@ protected function GetBarcodeGenerateRequest(Requests\GetBarcodeGenerateRequest
             }
         }
         // query params
+        if (isset($request->no_wrap)) {
+            $localName = lcfirst('NoWrap');
+            $localValue = is_bool($request->no_wrap) ? ($request->no_wrap ? 'true' : 'false') : $request->no_wrap;
+            if (strpos($resourcePath, '{' . $localName . '}') !== false) {
+                $resourcePath = str_replace('{' . $localName . '}', ObjectSerializer::toPathValue($localValue), $resourcePath);
+            } else {
+                $queryParams[$localName] = ObjectSerializer::toQueryValue($localValue);
+            }
+        }
+        // query params
         if (isset($request->resolution)) {
             $localName = lcfirst('Resolution');
             $localValue = is_bool($request->resolution) ? ($request->resolution ? 'true' : 'false') : $request->resolution;
@@ -2458,6 +2468,16 @@ protected function PutBarcodeGenerateFileRequest(Requests\PutBarcodeGenerateFile
             }
         }
         // query params
+        if (isset($request->no_wrap)) {
+            $localName = lcfirst('NoWrap');
+            $localValue = is_bool($request->no_wrap) ? ($request->no_wrap ? 'true' : 'false') : $request->no_wrap;
+            if (strpos($resourcePath, '{' . $localName . '}') !== false) {
+                $resourcePath = str_replace('{' . $localName . '}', ObjectSerializer::toPathValue($localValue), $resourcePath);
+            } else {
+                $queryParams[$localName] = ObjectSerializer::toQueryValue($localValue);
+            }
+        }
+        // query params
         if (isset($request->resolution)) {
             $localName = lcfirst('Resolution');
             $localValue = is_bool($request->resolution) ? ($request->resolution ? 'true' : 'false') : $request->resolution;

diff --git a/src/Aspose/BarCode/Configuration.php b/src/Aspose/BarCode/Configuration.php
@@ -46,7 +46,7 @@ class Configuration implements JsonSerializable
      *
      * @var string
      */
-    protected $clientVersion = '20.11.0';
+    protected $clientVersion = '20.12.0';
 
     /*
      * ClientId for API
@@ -362,7 +362,7 @@ public static function toDebugReport()
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
         $report .= '    OpenAPI Spec Version: 3.0' . PHP_EOL;
-        $report .= '    SDK Package Version: 20.11.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 20.12.0' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;