Release 23.11 (#61)

Denis-Averin · web-flow · commit 926e0aac27b3 · 2023-11-28T14:07:52.000+07:00
* Update version to 23.11.0

* Update API

* Change Maximum timeout value
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![Supported PHP Versions](https://img.shields.io/packagist/dependency-v/aspose/barcode-cloud-php/php)](https://packagist.org/packages/aspose/barcode-cloud-php)
 
 - API version: 3.0
-- Package version: 23.10.0
+- Package version: 23.11.0
 - Supported PHP versions: ">=7.4 || >=8.0"
 
 ## Demo applications
diff --git a/docs/Api/BarcodeApi.md b/docs/Api/BarcodeApi.md
@@ -163,7 +163,7 @@ $rect_y = 56; // int | Set Y of top left corner of area for recognition.
 $rect_width = 56; // int | Set Width of area for recognition.
 $rect_height = 56; // int | Set Height of area for recognition.
 $strip_fnc = true; // bool | Value indicating whether FNC symbol strip must be done.
-$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.
+$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.
 $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.
 $allow_median_smoothing = true; // bool | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
 $allow_complex_background = true; // bool | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
@@ -215,7 +215,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]
@@ -287,7 +287,7 @@ $rect_y = 56; // int | Set Y of top left corner of area for recognition.
 $rect_width = 56; // int | Set Width of area for recognition.
 $rect_height = 56; // int | Set Height of area for recognition.
 $strip_fnc = true; // bool | Value indicating whether FNC symbol strip must be done.
-$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.
+$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.
 $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.
 $allow_median_smoothing = true; // bool | Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
 $allow_complex_background = true; // bool | Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
@@ -338,7 +338,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]
diff --git a/docs/Model/Code128Emulation.md b/docs/Model/Code128Emulation.md
@@ -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
 
 * **NONE**
diff --git a/docs/Model/DecodeBarcodeType.md b/docs/Model/DecodeBarcodeType.md
@@ -86,6 +86,7 @@ See DecodeType
 * GS1_HAN_XIN
 * GS1_AZTEC
 * GS1_COMPOSITE_BAR
+* GS1_MICRO_PDF417
 
 [[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/EncodeBarcodeType.md b/docs/Model/EncodeBarcodeType.md
@@ -74,6 +74,7 @@ See EncodeTypes
 * HAN_XIN
 * GS1_HAN_XIN
 * GS1_AZTEC
+* GS1_MICRO_PDF417
 
 [[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/Pdf417Params.md b/docs/Model/Pdf417Params.md
@@ -24,8 +24,11 @@ Name | Type | Description | Notes
 **macro_file_name** | **string** | Macro Pdf417 barcode file name | [optional] 
 **macro_addressee** | **string** | Macro Pdf417 barcode addressee name | [optional] 
 **macro_eci_encoding** | [**\Aspose\BarCode\Model\ECIEncodings**](ECIEncodings.md) | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. | [optional] 
-**code128_emulation** | [**\Aspose\BarCode\Model\Code128Emulation**](Code128Emulation.md) | Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. | [optional] 
+**code128_emulation** | [**\Aspose\BarCode\Model\Code128Emulation**](Code128Emulation.md) | 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. | [optional] 
+**is_code128_emulation** | **bool** | 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. | [optional] 
 **pdf417_macro_terminator** | [**\Aspose\BarCode\Model\Pdf417MacroTerminator**](Pdf417MacroTerminator.md) | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. | [optional] 
+**is_linked** | **bool** | 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. | [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 MicroPdf417 and encodes 916 and 917 MicroPdf417 modes. 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/ReaderParams.md b/docs/Model/ReaderParams.md
@@ -14,7 +14,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] 
diff --git a/src/Aspose/BarCode/Configuration.php b/src/Aspose/BarCode/Configuration.php
@@ -23,7 +23,7 @@ class Configuration implements JsonSerializable
      *
      * @var string
      */
-    protected $clientVersion = '23.10.0';
+    protected $clientVersion = '23.11.0';
 
     /**
      * ClientId for API
diff --git a/src/Aspose/BarCode/Model/Code128Emulation.php b/src/Aspose/BarCode/Model/Code128Emulation.php
@@ -39,7 +39,7 @@
 /**
  * Code128Emulation
  *
- * @description
+ * @description 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.
  */
 class Code128Emulation
 {
diff --git a/src/Aspose/BarCode/Model/DecodeBarcodeType.php b/src/Aspose/BarCode/Model/DecodeBarcodeType.php
@@ -458,4 +458,9 @@ class DecodeBarcodeType
     /// </summary>
     public const GS1CompositeBar =  "GS1CompositeBar";
 
+    /// <summary>
+    /// Enum value GS1MicroPdf417
+    /// </summary>
+    public const GS1MicroPdf417 =  "GS1MicroPdf417";
+
 }
diff --git a/src/Aspose/BarCode/Model/EncodeBarcodeType.php b/src/Aspose/BarCode/Model/EncodeBarcodeType.php
@@ -398,4 +398,9 @@ class EncodeBarcodeType
     /// </summary>
     public const GS1Aztec =  "GS1Aztec";
 
+    /// <summary>
+    /// Enum value GS1MicroPdf417
+    /// </summary>
+    public const GS1MicroPdf417 =  "GS1MicroPdf417";
+
 }
diff --git a/src/Aspose/BarCode/Model/Pdf417Params.php b/src/Aspose/BarCode/Model/Pdf417Params.php
@@ -79,7 +79,10 @@ class Pdf417Params implements ArrayAccess
         'macro_addressee' => 'string',
         'macro_eci_encoding' => '\Aspose\BarCode\Model\ECIEncodings',
         'code128_emulation' => '\Aspose\BarCode\Model\Code128Emulation',
-        'pdf417_macro_terminator' => '\Aspose\BarCode\Model\Pdf417MacroTerminator'
+        'is_code128_emulation' => 'bool',
+        'pdf417_macro_terminator' => '\Aspose\BarCode\Model\Pdf417MacroTerminator',
+        'is_linked' => 'bool',
+        'macro_characters' => '\Aspose\BarCode\Model\MacroCharacter'
     ];
 
     /**
@@ -108,7 +111,10 @@ class Pdf417Params implements ArrayAccess
         'macro_addressee' => null,
         'macro_eci_encoding' => null,
         'code128_emulation' => null,
-        'pdf417_macro_terminator' => null
+        'is_code128_emulation' => null,
+        'pdf417_macro_terminator' => null,
+        'is_linked' => null,
+        'macro_characters' => null
     ];
 
     /**
@@ -158,7 +164,10 @@ public static function swaggerFormats()
         'macro_addressee' => 'MacroAddressee',
         'macro_eci_encoding' => 'MacroECIEncoding',
         'code128_emulation' => 'Code128Emulation',
-        'pdf417_macro_terminator' => 'Pdf417MacroTerminator'
+        'is_code128_emulation' => 'IsCode128Emulation',
+        'pdf417_macro_terminator' => 'Pdf417MacroTerminator',
+        'is_linked' => 'IsLinked',
+        'macro_characters' => 'MacroCharacters'
     ];
 
     /**
@@ -187,7 +196,10 @@ public static function swaggerFormats()
         'macro_addressee' => 'setMacroAddressee',
         'macro_eci_encoding' => 'setMacroEciEncoding',
         'code128_emulation' => 'setCode128Emulation',
-        'pdf417_macro_terminator' => 'setPdf417MacroTerminator'
+        'is_code128_emulation' => 'setIsCode128Emulation',
+        'pdf417_macro_terminator' => 'setPdf417MacroTerminator',
+        'is_linked' => 'setIsLinked',
+        'macro_characters' => 'setMacroCharacters'
     ];
 
     /**
@@ -216,7 +228,10 @@ public static function swaggerFormats()
         'macro_addressee' => 'getMacroAddressee',
         'macro_eci_encoding' => 'getMacroEciEncoding',
         'code128_emulation' => 'getCode128Emulation',
-        'pdf417_macro_terminator' => 'getPdf417MacroTerminator'
+        'is_code128_emulation' => 'getIsCode128Emulation',
+        'pdf417_macro_terminator' => 'getPdf417MacroTerminator',
+        'is_linked' => 'getIsLinked',
+        'macro_characters' => 'getMacroCharacters'
     ];
 
     /**
@@ -299,7 +314,10 @@ public function __construct(array $data = null)
         $this->container['macro_addressee'] = isset($data['macro_addressee']) ? $data['macro_addressee'] : null;
         $this->container['macro_eci_encoding'] = isset($data['macro_eci_encoding']) ? $data['macro_eci_encoding'] : null;
         $this->container['code128_emulation'] = isset($data['code128_emulation']) ? $data['code128_emulation'] : null;
+        $this->container['is_code128_emulation'] = isset($data['is_code128_emulation']) ? $data['is_code128_emulation'] : null;
         $this->container['pdf417_macro_terminator'] = isset($data['pdf417_macro_terminator']) ? $data['pdf417_macro_terminator'] : null;
+        $this->container['is_linked'] = isset($data['is_linked']) ? $data['is_linked'] : null;
+        $this->container['macro_characters'] = isset($data['macro_characters']) ? $data['macro_characters'] : null;
     }
 
     /**
@@ -796,17 +814,42 @@ public function getCode128Emulation()
     /**
      * Sets code128_emulation
      *
-     * @param \Aspose\BarCode\Model\Code128Emulation $code128_emulation Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.
+     * @param \Aspose\BarCode\Model\Code128Emulation $code128_emulation 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.
      *
      * @return $this
      */
     public function setCode128Emulation($code128_emulation)
     {
+        trigger_error('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.', E_USER_DEPRECATED);
         $this->container['code128_emulation'] = $code128_emulation;
 
         return $this;
     }
 
+    /**
+     * Gets is_code128_emulation
+     *
+     * @return bool
+     */
+    public function getIsCode128Emulation()
+    {
+        return $this->container['is_code128_emulation'];
+    }
+
+    /**
+     * Sets is_code128_emulation
+     *
+     * @param bool $is_code128_emulation 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.
+     *
+     * @return $this
+     */
+    public function setIsCode128Emulation($is_code128_emulation)
+    {
+        $this->container['is_code128_emulation'] = $is_code128_emulation;
+
+        return $this;
+    }
+
     /**
      * Gets pdf417_macro_terminator
      *
@@ -831,6 +874,54 @@ public function setPdf417MacroTerminator($pdf417_macro_terminator)
         return $this;
     }
 
+    /**
+     * Gets is_linked
+     *
+     * @return bool
+     */
+    public function getIsLinked()
+    {
+        return $this->container['is_linked'];
+    }
+
+    /**
+     * Sets is_linked
+     *
+     * @param bool $is_linked 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.
+     *
+     * @return $this
+     */
+    public function setIsLinked($is_linked)
+    {
+        $this->container['is_linked'] = $is_linked;
+
+        return $this;
+    }
+
+    /**
+     * Gets macro_characters
+     *
+     * @return \Aspose\BarCode\Model\MacroCharacter
+     */
+    public function getMacroCharacters()
+    {
+        return $this->container['macro_characters'];
+    }
+
+    /**
+     * Sets macro_characters
+     *
+     * @param \Aspose\BarCode\Model\MacroCharacter $macro_characters 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.
+     *
+     * @return $this
+     */
+    public function setMacroCharacters($macro_characters)
+    {
+        $this->container['macro_characters'] = $macro_characters;
+
+        return $this;
+    }
+
     /**
      * Returns true if offset exists. False otherwise.
      *
diff --git a/src/Aspose/BarCode/Model/ReaderParams.php b/src/Aspose/BarCode/Model/ReaderParams.php
@@ -639,7 +639,7 @@ public function getTimeout()
     /**
      * Sets timeout
      *
-     * @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.
+     * @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.
      *
      * @return $this
      */
diff --git a/src/Aspose/BarCode/Requests/GetBarcodeRecognizeRequest.php b/src/Aspose/BarCode/Requests/GetBarcodeRecognizeRequest.php
diff --git a/src/Aspose/BarCode/Requests/PostBarcodeRecognizeFromUrlOrContentRequest.php b/src/Aspose/BarCode/Requests/PostBarcodeRecognizeFromUrlOrContentRequest.php

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class Configuration implements JsonSerializable`
`23`	`23`	`*`
`24`	`24`	`* @var string`
`25`	`25`	`*/`
`26`		`- protected $clientVersion = '23.10.0';`
	`26`	`+ protected $clientVersion = '23.11.0';`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* ClientId for API`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@`
`39`	`39`	`/**`
`40`	`40`	`* Code128Emulation`
`41`	`41`	`*`
`42`		`- * @description`
	`42`	`+ * @description 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.`
`43`	`43`	`*/`
`44`	`44`	`class Code128Emulation`
`45`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -458,4 +458,9 @@ class DecodeBarcodeType`
`458`	`458`	`/// </summary>`
`459`	`459`	`public const GS1CompositeBar = "GS1CompositeBar";`
`460`	`460`
	`461`	`+ /// <summary>`
	`462`	`+ /// Enum value GS1MicroPdf417`
	`463`	`+ /// </summary>`
	`464`	`+ public const GS1MicroPdf417 = "GS1MicroPdf417";`
	`465`	`+`
`461`	`466`	`}`