From bd297955859f8dfdc5fd10f7e9d5bb7820cf09c8 Mon Sep 17 00:00:00 2001 From: Denis Averin Date: Sat, 25 Nov 2023 22:45:22 +0700 Subject: [PATCH] Update API --- docs/index.md | 14 ++++++------- docs/models.md | 25 +++++++++++++++++++---- src/api.ts | 10 +++++----- src/models.ts | 54 +++++++++++++++++++++++++++++++++++++++++--------- 4 files changed, 78 insertions(+), 25 deletions(-) diff --git a/docs/index.md b/docs/index.md index e38e809..7aa530c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,14 +7,14 @@ Generate barcode. ```ts -getBarcodeGenerate(type: 'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec', text: string): Buffer; +getBarcodeGenerate(type: 'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1MicroPdf417', text: string): Buffer; ``` #### BarcodeApi.getBarcodeGenerate parameters Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **type** | 'Codabar', 'Code11', 'Code39Standard', 'Code39Extended', 'Code93Standard', 'Code93Extended', 'Code128', 'GS1Code128', 'EAN8', 'EAN13', 'EAN14', 'SCC14', 'SSCC18', 'UPCA', 'UPCE', 'ISBN', 'ISSN', 'ISMN', 'Standard2of5', 'Interleaved2of5', 'Matrix2of5', 'ItalianPost25', 'IATA2of5', 'ITF14', 'ITF6', 'MSI', 'VIN', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'OPC', 'PZN', 'Code16K', 'Pharmacode', 'DataMatrix', 'QR', 'Aztec', 'Pdf417', 'MacroPdf417', 'AustraliaPost', 'Postnet', 'Planet', 'OneCode', 'RM4SCC', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SingaporePost', 'GS1DataMatrix', 'AustralianPosteParcel', 'SwissPostParcel', 'PatchCode', 'DatabarExpandedStacked', 'DatabarStacked', 'DatabarStackedOmniDirectional', 'MicroPdf417', 'GS1QR', 'MaxiCode', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'UpcaGs1Code128Coupon', 'UpcaGs1DatabarCoupon', 'CodablockF', 'GS1CodablockF', 'Mailmark', 'GS1DotCode', 'HanXin', 'GS1HanXin', 'GS1Aztec' | Type of barcode to generate. | + **type** | 'Codabar', 'Code11', 'Code39Standard', 'Code39Extended', 'Code93Standard', 'Code93Extended', 'Code128', 'GS1Code128', 'EAN8', 'EAN13', 'EAN14', 'SCC14', 'SSCC18', 'UPCA', 'UPCE', 'ISBN', 'ISSN', 'ISMN', 'Standard2of5', 'Interleaved2of5', 'Matrix2of5', 'ItalianPost25', 'IATA2of5', 'ITF14', 'ITF6', 'MSI', 'VIN', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'OPC', 'PZN', 'Code16K', 'Pharmacode', 'DataMatrix', 'QR', 'Aztec', 'Pdf417', 'MacroPdf417', 'AustraliaPost', 'Postnet', 'Planet', 'OneCode', 'RM4SCC', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SingaporePost', 'GS1DataMatrix', 'AustralianPosteParcel', 'SwissPostParcel', 'PatchCode', 'DatabarExpandedStacked', 'DatabarStacked', 'DatabarStackedOmniDirectional', 'MicroPdf417', 'GS1QR', 'MaxiCode', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'UpcaGs1Code128Coupon', 'UpcaGs1DatabarCoupon', 'CodablockF', 'GS1CodablockF', 'Mailmark', 'GS1DotCode', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1MicroPdf417' | Type of barcode to generate. | **text** | **string**| Text to encode. | **twoDDisplayText** | **string**| Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional] **textLocation** | 'Below', 'Above', 'None' | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional] @@ -70,7 +70,7 @@ getBarcodeRecognize(name: string): BarcodeResponseList; Name | Type | Description | Notes ---- | ---- | ------------ | ----- **name** | **string**| The image file name. | - **type** | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar' | The type of barcode to read. | [optional] + **type** | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar', 'GS1MicroPdf417' | The type of barcode to read. | [optional] **checksumValidation** | 'Default', 'On', 'Off' | Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies | [optional] **detectEncoding** | **boolean**| A flag which force engine to detect codetext encoding for Unicode. | [optional] **preset** | 'HighPerformance', 'NormalQuality', 'HighQualityDetection', 'MaxQualityDetection', 'HighQuality', 'MaxBarCodes' | Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality. | [optional] @@ -126,7 +126,7 @@ postBarcodeRecognizeFromUrlOrContent(): BarcodeResponseList; Name | Type | Description | Notes ---- | ---- | ------------ | ----- - **type** | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar' | The type of barcode to read. | [optional] + **type** | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar', 'GS1MicroPdf417' | The type of barcode to read. | [optional] **checksumValidation** | 'Default', 'On', 'Off' | Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies | [optional] **detectEncoding** | **boolean**| A flag which force engine to detect codetext encoding for Unicode. | [optional] **preset** | 'HighPerformance', 'NormalQuality', 'HighQualityDetection', 'MaxQualityDetection', 'HighQuality', 'MaxBarCodes' | Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality. | [optional] @@ -196,7 +196,7 @@ Buffer Generate barcode and save on server (from query params or from file with json or xml content) ```ts -putBarcodeGenerateFile(name: string, type: 'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec', text: string): ResultImageInfo; +putBarcodeGenerateFile(name: string, type: 'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1MicroPdf417', text: string): ResultImageInfo; ``` #### BarcodeApi.putBarcodeGenerateFile parameters @@ -204,7 +204,7 @@ putBarcodeGenerateFile(name: string, type: 'Codabar' | 'Code11' | 'Code39Standar Name | Type | Description | Notes ---- | ---- | ------------ | ----- **name** | **string**| The image file name. | - **type** | 'Codabar', 'Code11', 'Code39Standard', 'Code39Extended', 'Code93Standard', 'Code93Extended', 'Code128', 'GS1Code128', 'EAN8', 'EAN13', 'EAN14', 'SCC14', 'SSCC18', 'UPCA', 'UPCE', 'ISBN', 'ISSN', 'ISMN', 'Standard2of5', 'Interleaved2of5', 'Matrix2of5', 'ItalianPost25', 'IATA2of5', 'ITF14', 'ITF6', 'MSI', 'VIN', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'OPC', 'PZN', 'Code16K', 'Pharmacode', 'DataMatrix', 'QR', 'Aztec', 'Pdf417', 'MacroPdf417', 'AustraliaPost', 'Postnet', 'Planet', 'OneCode', 'RM4SCC', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SingaporePost', 'GS1DataMatrix', 'AustralianPosteParcel', 'SwissPostParcel', 'PatchCode', 'DatabarExpandedStacked', 'DatabarStacked', 'DatabarStackedOmniDirectional', 'MicroPdf417', 'GS1QR', 'MaxiCode', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'UpcaGs1Code128Coupon', 'UpcaGs1DatabarCoupon', 'CodablockF', 'GS1CodablockF', 'Mailmark', 'GS1DotCode', 'HanXin', 'GS1HanXin', 'GS1Aztec' | Type of barcode to generate. | + **type** | 'Codabar', 'Code11', 'Code39Standard', 'Code39Extended', 'Code93Standard', 'Code93Extended', 'Code128', 'GS1Code128', 'EAN8', 'EAN13', 'EAN14', 'SCC14', 'SSCC18', 'UPCA', 'UPCE', 'ISBN', 'ISSN', 'ISMN', 'Standard2of5', 'Interleaved2of5', 'Matrix2of5', 'ItalianPost25', 'IATA2of5', 'ITF14', 'ITF6', 'MSI', 'VIN', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'OPC', 'PZN', 'Code16K', 'Pharmacode', 'DataMatrix', 'QR', 'Aztec', 'Pdf417', 'MacroPdf417', 'AustraliaPost', 'Postnet', 'Planet', 'OneCode', 'RM4SCC', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SingaporePost', 'GS1DataMatrix', 'AustralianPosteParcel', 'SwissPostParcel', 'PatchCode', 'DatabarExpandedStacked', 'DatabarStacked', 'DatabarStackedOmniDirectional', 'MicroPdf417', 'GS1QR', 'MaxiCode', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'UpcaGs1Code128Coupon', 'UpcaGs1DatabarCoupon', 'CodablockF', 'GS1CodablockF', 'Mailmark', 'GS1DotCode', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1MicroPdf417' | Type of barcode to generate. | **text** | **string**| Text to encode. | **twoDDisplayText** | **string**| Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode | [optional] **textLocation** | 'Below', 'Above', 'None' | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. | [optional] @@ -263,7 +263,7 @@ Name | Type | Description | Notes ---- | ---- | ------------ | ----- **name** | **string**| The image file name. | **readerParams** | [**ReaderParams**](models.md#ReaderParams)| BarcodeReader object with parameters. | - **type** | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar' | | [optional] + **type** | 'all', 'AustraliaPost', 'Aztec', 'ISBN', 'Codabar', 'Code11', 'Code128', 'GS1Code128', 'Code39Extended', 'Code39Standard', 'Code93Extended', 'Code93Standard', 'DataMatrix', 'DeutschePostIdentcode', 'DeutschePostLeitcode', 'EAN13', 'EAN14', 'EAN8', 'IATA2of5', 'Interleaved2of5', 'ISSN', 'ISMN', 'ItalianPost25', 'ITF14', 'ITF6', 'MacroPdf417', 'Matrix2of5', 'MSI', 'OneCode', 'OPC', 'PatchCode', 'Pdf417', 'MicroPdf417', 'Planet', 'Postnet', 'PZN', 'QR', 'MicroQR', 'RM4SCC', 'SCC14', 'SSCC18', 'Standard2of5', 'Supplement', 'UPCA', 'UPCE', 'VIN', 'Pharmacode', 'GS1DataMatrix', 'DatabarOmniDirectional', 'DatabarTruncated', 'DatabarLimited', 'DatabarExpanded', 'SwissPostParcel', 'AustralianPosteParcel', 'Code16K', 'DatabarStackedOmniDirectional', 'DatabarStacked', 'DatabarExpandedStacked', 'CompactPdf417', 'GS1QR', 'MaxiCode', 'MicrE13B', 'Code32', 'DataLogic2of5', 'DotCode', 'DutchKIX', 'CodablockF', 'Mailmark', 'GS1DotCode', 'HIBCCode39LIC', 'HIBCCode128LIC', 'HIBCAztecLIC', 'HIBCDataMatrixLIC', 'HIBCQRLIC', 'HIBCCode39PAS', 'HIBCCode128PAS', 'HIBCAztecPAS', 'HIBCDataMatrixPAS', 'HIBCQRPAS', 'HanXin', 'GS1HanXin', 'GS1Aztec', 'GS1CompositeBar', 'GS1MicroPdf417' | | [optional] **storage** | **string**| The storage name | [optional] **folder** | **string**| The image folder. | [optional] diff --git a/docs/models.md b/docs/models.md index fbbdf22..53fc669 100644 --- a/docs/models.md +++ b/docs/models.md @@ -324,7 +324,7 @@ interface CodablockParams { ## 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. ```ts enum Code128Emulation { @@ -712,7 +712,8 @@ enum DecodeBarcodeType { HanXin = 'HanXin', GS1HanXin = 'GS1HanXin', GS1Aztec = 'GS1Aztec', - GS1CompositeBar = 'GS1CompositeBar' + GS1CompositeBar = 'GS1CompositeBar', + GS1MicroPdf417 = 'GS1MicroPdf417' } ``` @@ -910,7 +911,8 @@ enum EncodeBarcodeType { GS1DotCode = 'GS1DotCode', HanXin = 'HanXin', GS1HanXin = 'GS1HanXin', - GS1Aztec = 'GS1Aztec' + GS1Aztec = 'GS1Aztec', + GS1MicroPdf417 = 'GS1MicroPdf417' } ``` @@ -1849,14 +1851,29 @@ interface Pdf417Params { macroECIEncoding?: ECIEncodings; /** - * Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. + * 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. */ code128Emulation?: Code128Emulation; + /** + * 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. + */ + isCode128Emulation?: boolean; + /** * Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. */ pdf417MacroTerminator?: Pdf417MacroTerminator; + + /** + * 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. + */ + isLinked?: boolean; + + /** + * 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. + */ + macroCharacters?: MacroCharacter; } ``` diff --git a/src/api.ts b/src/api.ts index 7d7aa51..846baf2 100644 --- a/src/api.ts +++ b/src/api.ts @@ -399,7 +399,7 @@ export class BarcodeApi { if (request.type != null) { queryParameters['Type'] = ObjectSerializer.serialize( request.type, - "'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec'" + "'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1MicroPdf417'" ); } @@ -601,7 +601,7 @@ export class BarcodeApi { if (request.type != null) { queryParameters['Type'] = ObjectSerializer.serialize( request.type, - "'all' | 'AustraliaPost' | 'Aztec' | 'ISBN' | 'Codabar' | 'Code11' | 'Code128' | 'GS1Code128' | 'Code39Extended' | 'Code39Standard' | 'Code93Extended' | 'Code93Standard' | 'DataMatrix' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'EAN13' | 'EAN14' | 'EAN8' | 'IATA2of5' | 'Interleaved2of5' | 'ISSN' | 'ISMN' | 'ItalianPost25' | 'ITF14' | 'ITF6' | 'MacroPdf417' | 'Matrix2of5' | 'MSI' | 'OneCode' | 'OPC' | 'PatchCode' | 'Pdf417' | 'MicroPdf417' | 'Planet' | 'Postnet' | 'PZN' | 'QR' | 'MicroQR' | 'RM4SCC' | 'SCC14' | 'SSCC18' | 'Standard2of5' | 'Supplement' | 'UPCA' | 'UPCE' | 'VIN' | 'Pharmacode' | 'GS1DataMatrix' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SwissPostParcel' | 'AustralianPosteParcel' | 'Code16K' | 'DatabarStackedOmniDirectional' | 'DatabarStacked' | 'DatabarExpandedStacked' | 'CompactPdf417' | 'GS1QR' | 'MaxiCode' | 'MicrE13B' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HIBCCode39LIC' | 'HIBCCode128LIC' | 'HIBCAztecLIC' | 'HIBCDataMatrixLIC' | 'HIBCQRLIC' | 'HIBCCode39PAS' | 'HIBCCode128PAS' | 'HIBCAztecPAS' | 'HIBCDataMatrixPAS' | 'HIBCQRPAS' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1CompositeBar'" + "'all' | 'AustraliaPost' | 'Aztec' | 'ISBN' | 'Codabar' | 'Code11' | 'Code128' | 'GS1Code128' | 'Code39Extended' | 'Code39Standard' | 'Code93Extended' | 'Code93Standard' | 'DataMatrix' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'EAN13' | 'EAN14' | 'EAN8' | 'IATA2of5' | 'Interleaved2of5' | 'ISSN' | 'ISMN' | 'ItalianPost25' | 'ITF14' | 'ITF6' | 'MacroPdf417' | 'Matrix2of5' | 'MSI' | 'OneCode' | 'OPC' | 'PatchCode' | 'Pdf417' | 'MicroPdf417' | 'Planet' | 'Postnet' | 'PZN' | 'QR' | 'MicroQR' | 'RM4SCC' | 'SCC14' | 'SSCC18' | 'Standard2of5' | 'Supplement' | 'UPCA' | 'UPCE' | 'VIN' | 'Pharmacode' | 'GS1DataMatrix' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SwissPostParcel' | 'AustralianPosteParcel' | 'Code16K' | 'DatabarStackedOmniDirectional' | 'DatabarStacked' | 'DatabarExpandedStacked' | 'CompactPdf417' | 'GS1QR' | 'MaxiCode' | 'MicrE13B' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HIBCCode39LIC' | 'HIBCCode128LIC' | 'HIBCAztecLIC' | 'HIBCDataMatrixLIC' | 'HIBCQRLIC' | 'HIBCCode39PAS' | 'HIBCCode128PAS' | 'HIBCAztecPAS' | 'HIBCDataMatrixPAS' | 'HIBCQRPAS' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1CompositeBar' | 'GS1MicroPdf417'" ); } @@ -833,7 +833,7 @@ export class BarcodeApi { if (request.type != null) { queryParameters['Type'] = ObjectSerializer.serialize( request.type, - "'all' | 'AustraliaPost' | 'Aztec' | 'ISBN' | 'Codabar' | 'Code11' | 'Code128' | 'GS1Code128' | 'Code39Extended' | 'Code39Standard' | 'Code93Extended' | 'Code93Standard' | 'DataMatrix' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'EAN13' | 'EAN14' | 'EAN8' | 'IATA2of5' | 'Interleaved2of5' | 'ISSN' | 'ISMN' | 'ItalianPost25' | 'ITF14' | 'ITF6' | 'MacroPdf417' | 'Matrix2of5' | 'MSI' | 'OneCode' | 'OPC' | 'PatchCode' | 'Pdf417' | 'MicroPdf417' | 'Planet' | 'Postnet' | 'PZN' | 'QR' | 'MicroQR' | 'RM4SCC' | 'SCC14' | 'SSCC18' | 'Standard2of5' | 'Supplement' | 'UPCA' | 'UPCE' | 'VIN' | 'Pharmacode' | 'GS1DataMatrix' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SwissPostParcel' | 'AustralianPosteParcel' | 'Code16K' | 'DatabarStackedOmniDirectional' | 'DatabarStacked' | 'DatabarExpandedStacked' | 'CompactPdf417' | 'GS1QR' | 'MaxiCode' | 'MicrE13B' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HIBCCode39LIC' | 'HIBCCode128LIC' | 'HIBCAztecLIC' | 'HIBCDataMatrixLIC' | 'HIBCQRLIC' | 'HIBCCode39PAS' | 'HIBCCode128PAS' | 'HIBCAztecPAS' | 'HIBCDataMatrixPAS' | 'HIBCQRPAS' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1CompositeBar'" + "'all' | 'AustraliaPost' | 'Aztec' | 'ISBN' | 'Codabar' | 'Code11' | 'Code128' | 'GS1Code128' | 'Code39Extended' | 'Code39Standard' | 'Code93Extended' | 'Code93Standard' | 'DataMatrix' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'EAN13' | 'EAN14' | 'EAN8' | 'IATA2of5' | 'Interleaved2of5' | 'ISSN' | 'ISMN' | 'ItalianPost25' | 'ITF14' | 'ITF6' | 'MacroPdf417' | 'Matrix2of5' | 'MSI' | 'OneCode' | 'OPC' | 'PatchCode' | 'Pdf417' | 'MicroPdf417' | 'Planet' | 'Postnet' | 'PZN' | 'QR' | 'MicroQR' | 'RM4SCC' | 'SCC14' | 'SSCC18' | 'Standard2of5' | 'Supplement' | 'UPCA' | 'UPCE' | 'VIN' | 'Pharmacode' | 'GS1DataMatrix' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SwissPostParcel' | 'AustralianPosteParcel' | 'Code16K' | 'DatabarStackedOmniDirectional' | 'DatabarStacked' | 'DatabarExpandedStacked' | 'CompactPdf417' | 'GS1QR' | 'MaxiCode' | 'MicrE13B' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HIBCCode39LIC' | 'HIBCCode128LIC' | 'HIBCAztecLIC' | 'HIBCDataMatrixLIC' | 'HIBCQRLIC' | 'HIBCCode39PAS' | 'HIBCCode128PAS' | 'HIBCAztecPAS' | 'HIBCDataMatrixPAS' | 'HIBCQRPAS' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1CompositeBar' | 'GS1MicroPdf417'" ); } @@ -1131,7 +1131,7 @@ export class BarcodeApi { if (request.type != null) { queryParameters['Type'] = ObjectSerializer.serialize( request.type, - "'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec'" + "'Codabar' | 'Code11' | 'Code39Standard' | 'Code39Extended' | 'Code93Standard' | 'Code93Extended' | 'Code128' | 'GS1Code128' | 'EAN8' | 'EAN13' | 'EAN14' | 'SCC14' | 'SSCC18' | 'UPCA' | 'UPCE' | 'ISBN' | 'ISSN' | 'ISMN' | 'Standard2of5' | 'Interleaved2of5' | 'Matrix2of5' | 'ItalianPost25' | 'IATA2of5' | 'ITF14' | 'ITF6' | 'MSI' | 'VIN' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'OPC' | 'PZN' | 'Code16K' | 'Pharmacode' | 'DataMatrix' | 'QR' | 'Aztec' | 'Pdf417' | 'MacroPdf417' | 'AustraliaPost' | 'Postnet' | 'Planet' | 'OneCode' | 'RM4SCC' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SingaporePost' | 'GS1DataMatrix' | 'AustralianPosteParcel' | 'SwissPostParcel' | 'PatchCode' | 'DatabarExpandedStacked' | 'DatabarStacked' | 'DatabarStackedOmniDirectional' | 'MicroPdf417' | 'GS1QR' | 'MaxiCode' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'UpcaGs1Code128Coupon' | 'UpcaGs1DatabarCoupon' | 'CodablockF' | 'GS1CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1MicroPdf417'" ); } @@ -1349,7 +1349,7 @@ export class BarcodeApi { if (request.type != null) { queryParameters['type'] = ObjectSerializer.serialize( request.type, - "'all' | 'AustraliaPost' | 'Aztec' | 'ISBN' | 'Codabar' | 'Code11' | 'Code128' | 'GS1Code128' | 'Code39Extended' | 'Code39Standard' | 'Code93Extended' | 'Code93Standard' | 'DataMatrix' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'EAN13' | 'EAN14' | 'EAN8' | 'IATA2of5' | 'Interleaved2of5' | 'ISSN' | 'ISMN' | 'ItalianPost25' | 'ITF14' | 'ITF6' | 'MacroPdf417' | 'Matrix2of5' | 'MSI' | 'OneCode' | 'OPC' | 'PatchCode' | 'Pdf417' | 'MicroPdf417' | 'Planet' | 'Postnet' | 'PZN' | 'QR' | 'MicroQR' | 'RM4SCC' | 'SCC14' | 'SSCC18' | 'Standard2of5' | 'Supplement' | 'UPCA' | 'UPCE' | 'VIN' | 'Pharmacode' | 'GS1DataMatrix' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SwissPostParcel' | 'AustralianPosteParcel' | 'Code16K' | 'DatabarStackedOmniDirectional' | 'DatabarStacked' | 'DatabarExpandedStacked' | 'CompactPdf417' | 'GS1QR' | 'MaxiCode' | 'MicrE13B' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HIBCCode39LIC' | 'HIBCCode128LIC' | 'HIBCAztecLIC' | 'HIBCDataMatrixLIC' | 'HIBCQRLIC' | 'HIBCCode39PAS' | 'HIBCCode128PAS' | 'HIBCAztecPAS' | 'HIBCDataMatrixPAS' | 'HIBCQRPAS' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1CompositeBar'" + "'all' | 'AustraliaPost' | 'Aztec' | 'ISBN' | 'Codabar' | 'Code11' | 'Code128' | 'GS1Code128' | 'Code39Extended' | 'Code39Standard' | 'Code93Extended' | 'Code93Standard' | 'DataMatrix' | 'DeutschePostIdentcode' | 'DeutschePostLeitcode' | 'EAN13' | 'EAN14' | 'EAN8' | 'IATA2of5' | 'Interleaved2of5' | 'ISSN' | 'ISMN' | 'ItalianPost25' | 'ITF14' | 'ITF6' | 'MacroPdf417' | 'Matrix2of5' | 'MSI' | 'OneCode' | 'OPC' | 'PatchCode' | 'Pdf417' | 'MicroPdf417' | 'Planet' | 'Postnet' | 'PZN' | 'QR' | 'MicroQR' | 'RM4SCC' | 'SCC14' | 'SSCC18' | 'Standard2of5' | 'Supplement' | 'UPCA' | 'UPCE' | 'VIN' | 'Pharmacode' | 'GS1DataMatrix' | 'DatabarOmniDirectional' | 'DatabarTruncated' | 'DatabarLimited' | 'DatabarExpanded' | 'SwissPostParcel' | 'AustralianPosteParcel' | 'Code16K' | 'DatabarStackedOmniDirectional' | 'DatabarStacked' | 'DatabarExpandedStacked' | 'CompactPdf417' | 'GS1QR' | 'MaxiCode' | 'MicrE13B' | 'Code32' | 'DataLogic2of5' | 'DotCode' | 'DutchKIX' | 'CodablockF' | 'Mailmark' | 'GS1DotCode' | 'HIBCCode39LIC' | 'HIBCCode128LIC' | 'HIBCAztecLIC' | 'HIBCDataMatrixLIC' | 'HIBCQRLIC' | 'HIBCCode39PAS' | 'HIBCCode128PAS' | 'HIBCAztecPAS' | 'HIBCDataMatrixPAS' | 'HIBCQRPAS' | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' | 'GS1CompositeBar' | 'GS1MicroPdf417'" ); } diff --git a/src/models.ts b/src/models.ts index 4828db5..db165b2 100644 --- a/src/models.ts +++ b/src/models.ts @@ -503,7 +503,7 @@ export class CodablockParams { } /** - * + * 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. */ export enum Code128Emulation { None = 'None', @@ -962,6 +962,7 @@ export enum DecodeBarcodeType { GS1HanXin = 'GS1HanXin', GS1Aztec = 'GS1Aztec', GS1CompositeBar = 'GS1CompositeBar', + GS1MicroPdf417 = 'GS1MicroPdf417', } /** @@ -1188,6 +1189,7 @@ export enum EncodeBarcodeType { HanXin = 'HanXin', GS1HanXin = 'GS1HanXin', GS1Aztec = 'GS1Aztec', + GS1MicroPdf417 = 'GS1MicroPdf417', } /** @@ -2480,13 +2482,25 @@ export class Pdf417Params { */ 'macroECIEncoding'?: ECIEncodings; /** - * Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes. + * @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. */ 'code128Emulation'?: Code128Emulation; + /** + * 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. + */ + 'isCode128Emulation'?: boolean; /** * Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. */ 'pdf417MacroTerminator'?: Pdf417MacroTerminator; + /** + * 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. + */ + 'isLinked'?: boolean; + /** + * 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. + */ + 'macroCharacters'?: MacroCharacter; static attributeTypeMap: Array<{ name: string; baseName: string; type: string }> = [ { @@ -2589,11 +2603,26 @@ export class Pdf417Params { baseName: 'Code128Emulation', type: 'Code128Emulation', }, + { + name: 'isCode128Emulation', + baseName: 'IsCode128Emulation', + type: 'boolean', + }, { name: 'pdf417MacroTerminator', baseName: 'Pdf417MacroTerminator', type: 'Pdf417MacroTerminator', }, + { + name: 'isLinked', + baseName: 'IsLinked', + type: 'boolean', + }, + { + name: 'macroCharacters', + baseName: 'MacroCharacters', + type: 'MacroCharacter', + }, ]; static getAttributeTypeMap() { @@ -3482,7 +3511,8 @@ export class GetBarcodeGenerateRequest { | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' - | 'GS1Aztec'; + | 'GS1Aztec' + | 'GS1MicroPdf417'; /** * Text to encode. */ @@ -3736,7 +3766,8 @@ Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISM | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' - | 'GS1Aztec', + | 'GS1Aztec' + | 'GS1MicroPdf417', text: string ) { this.type = type; @@ -3838,7 +3869,8 @@ export class GetBarcodeRecognizeRequest { | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' - | 'GS1CompositeBar'; + | 'GS1CompositeBar' + | 'GS1MicroPdf417'; /** * Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. @@ -4119,7 +4151,8 @@ export class PostBarcodeRecognizeFromUrlOrContentRequest { | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' - | 'GS1CompositeBar'; + | 'GS1CompositeBar' + | 'GS1MicroPdf417'; /** * Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. @@ -4406,7 +4439,8 @@ export class PutBarcodeGenerateFileRequest { | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' - | 'GS1Aztec'; + | 'GS1Aztec' + | 'GS1MicroPdf417'; /** * Text to encode. */ @@ -4671,7 +4705,8 @@ Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISM | 'GS1DotCode' | 'HanXin' | 'GS1HanXin' - | 'GS1Aztec', + | 'GS1Aztec' + | 'GS1MicroPdf417', text: string ) { this.name = name; @@ -4778,7 +4813,8 @@ export class PutBarcodeRecognizeFromBodyRequest { | 'HanXin' | 'GS1HanXin' | 'GS1Aztec' - | 'GS1CompositeBar'; + | 'GS1CompositeBar' + | 'GS1MicroPdf417'; /** * The storage name */