aspose-barcode-cloud-node 24.11.0 → 25.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +27 -36
  3. package/dist/Authentication.d.ts +0 -0
  4. package/dist/Configuration.d.ts +1 -1
  5. package/dist/JWTAuth.d.ts +0 -0
  6. package/dist/api.d.ts +38 -161
  7. package/dist/aspose-barcode-cloud-node.cjs.development.js +916 -5351
  8. package/dist/aspose-barcode-cloud-node.cjs.development.js.map +1 -1
  9. package/dist/aspose-barcode-cloud-node.cjs.production.min.js +1 -1
  10. package/dist/aspose-barcode-cloud-node.cjs.production.min.js.map +1 -1
  11. package/dist/aspose-barcode-cloud-node.esm.js +900 -5291
  12. package/dist/aspose-barcode-cloud-node.esm.js.map +1 -1
  13. package/dist/httpClient.d.ts +2 -0
  14. package/dist/index.d.ts +0 -0
  15. package/dist/index.js +0 -0
  16. package/dist/models.d.ts +397 -3127
  17. package/dist/multipart.d.ts +3 -3
  18. package/package.json +6 -6
package/dist/models.d.ts CHANGED
@@ -1,7 +1,22 @@
1
+ /**
2
+ * Api Error.
3
+ */
1
4
  export declare class ApiError {
2
- 'code'?: string;
3
- 'message'?: string;
5
+ /**
6
+ * Gets or sets api error code.
7
+ */
8
+ 'code': string;
9
+ /**
10
+ * Gets or sets error message.
11
+ */
12
+ 'message': string;
13
+ /**
14
+ * Gets or sets error description.
15
+ */
4
16
  'description'?: string;
17
+ /**
18
+ * Gets or sets server datetime.
19
+ */
5
20
  'dateTime'?: Date;
6
21
  'innerError'?: ApiError;
7
22
  static attributeTypeMap: Array<{
@@ -15,32 +30,15 @@ export declare class ApiError {
15
30
  type: string;
16
31
  }[];
17
32
  }
18
- export declare class ApiErrorResponse {
19
- 'requestId'?: string;
20
- 'error'?: ApiError;
21
- static attributeTypeMap: Array<{
22
- name: string;
23
- baseName: string;
24
- type: string;
25
- }>;
26
- static getAttributeTypeMap(): {
27
- name: string;
28
- baseName: string;
29
- type: string;
30
- }[];
31
- }
32
33
  /**
33
- * AustralianPost barcode parameters.
34
+ * ApiError Response
34
35
  */
35
- export declare class AustralianPostParams {
36
- /**
37
- * Interpreting type for the Customer Information of AustralianPost, default to CustomerInformationInterpretingType.Other
38
- */
39
- 'encodingTable'?: CustomerInformationInterpretingType;
36
+ export declare class ApiErrorResponse {
40
37
  /**
41
- * Short bar's height of AustralianPost barcode.
38
+ * Gets or sets request Id.
42
39
  */
43
- 'shortBarHeight'?: number;
40
+ 'requestId': string;
41
+ 'error': ApiError;
44
42
  static attributeTypeMap: Array<{
45
43
  name: string;
46
44
  baseName: string;
@@ -53,66 +51,46 @@ export declare class AustralianPostParams {
53
51
  }[];
54
52
  }
55
53
  /**
56
- *
57
- */
58
- export declare enum AutoSizeMode {
59
- None = "None",
60
- Nearest = "Nearest",
61
- Interpolation = "Interpolation"
62
- }
63
- /**
64
- * Subset of GraphicsUnit.
65
- */
66
- export declare enum AvailableGraphicsUnit {
67
- Pixel = "Pixel",
68
- Point = "Point",
69
- Inch = "Inch",
70
- Millimeter = "Millimeter"
71
- }
72
- /**
73
- *
54
+ * Specifies the file format of the image.
74
55
  */
75
- export declare enum AztecEncodeMode {
76
- Auto = "Auto",
77
- Bytes = "Bytes",
78
- ExtendedCodetext = "ExtendedCodetext"
56
+ export declare enum BarcodeImageFormat {
57
+ Png = "Png",
58
+ Jpeg = "Jpeg",
59
+ Svg = "Svg",
60
+ Tiff = "Tiff",
61
+ Gif = "Gif"
79
62
  }
80
63
  /**
81
- * Aztec parameters.
64
+ * Barcode image optional parameters
82
65
  */
83
- export declare class AztecParams {
84
- /**
85
- * Height/Width ratio of 2D BarCode module.
86
- */
87
- 'aspectRatio'?: number;
88
- /**
89
- * Level of error correction of Aztec types of barcode. Value should between 10 to 95.
90
- */
91
- 'errorLevel'?: number;
66
+ export declare class BarcodeImageParams {
67
+ 'imageFormat'?: BarcodeImageFormat;
68
+ 'textLocation'?: CodeLocation;
92
69
  /**
93
- * Aztec Symbol mode. Default value: AztecSymbolMode.Auto.
70
+ * Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black.
94
71
  */
95
- 'symbolMode'?: AztecSymbolMode;
72
+ 'foregroundColor'?: string;
96
73
  /**
97
- * @deprecated This property is obsolete and will be removed in future releases. Unicode symbols detection and encoding will be processed in Auto mode with Extended Channel Interpretation charset designator. Using of own encodings requires manual CodeText encoding into byte[] array. Sets the encoding of codetext.
74
+ * Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White.
98
75
  */
99
- 'textEncoding'?: string;
76
+ 'backgroundColor'?: string;
77
+ 'units'?: GraphicsUnit;
100
78
  /**
101
- * Encoding mode for Aztec barcodes. Default value: Auto
79
+ * Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot.
102
80
  */
103
- 'encodeMode'?: AztecEncodeMode;
81
+ 'resolution'?: number;
104
82
  /**
105
- * Identifies ECI encoding. Used when AztecEncodeMode is Auto. Default value: ISO-8859-1.
83
+ * Height of the barcode image in given units. Default units: pixel. Decimal separator is dot.
106
84
  */
107
- 'eCIEncoding'?: ECIEncodings;
85
+ 'imageHeight'?: number;
108
86
  /**
109
- * Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.
87
+ * Width of the barcode image in given units. Default units: pixel. Decimal separator is dot.
110
88
  */
111
- 'isReaderInitialization'?: boolean;
89
+ 'imageWidth'?: number;
112
90
  /**
113
- * Gets or sets layers count of Aztec symbol. Layers count should be in range from 1 to 3 for Compact mode and in range from 1 to 32 for Full Range mode. Default value: 0 (auto).
91
+ * BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
114
92
  */
115
- 'layersCount'?: number;
93
+ 'rotationAngle'?: number;
116
94
  static attributeTypeMap: Array<{
117
95
  name: string;
118
96
  baseName: string;
@@ -124,15 +102,6 @@ export declare class AztecParams {
124
102
  type: string;
125
103
  }[];
126
104
  }
127
- /**
128
- *
129
- */
130
- export declare enum AztecSymbolMode {
131
- Auto = "Auto",
132
- Compact = "Compact",
133
- FullRange = "FullRange",
134
- Rune = "Rune"
135
- }
136
105
  /**
137
106
  * Represents information about barcode.
138
107
  */
@@ -171,7 +140,7 @@ export declare class BarcodeResponseList {
171
140
  /**
172
141
  * List of barcodes which are present in image.
173
142
  */
174
- 'barcodes'?: Array<BarcodeResponse>;
143
+ 'barcodes': Array<BarcodeResponse>;
175
144
  static attributeTypeMap: Array<{
176
145
  name: string;
177
146
  baseName: string;
@@ -183,90 +152,187 @@ export declare class BarcodeResponseList {
183
152
  type: string;
184
153
  }[];
185
154
  }
186
- /**
187
- *
188
- */
189
- export declare enum BorderDashStyle {
190
- Solid = "Solid",
191
- Dash = "Dash",
192
- Dot = "Dot",
193
- DashDot = "DashDot",
194
- DashDotDot = "DashDotDot"
195
- }
196
- /**
197
- * Caption
198
- */
199
- export declare class CaptionParams {
200
- /**
201
- * Caption text.
202
- */
203
- 'text'?: string;
204
- /**
205
- * Text alignment.
206
- */
207
- 'alignment'?: TextAlignment;
208
- /**
209
- * Text color. Default value: black Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
210
- */
211
- 'color'?: string;
212
- /**
213
- * Is caption visible.
214
- */
215
- 'visible'?: boolean;
216
- /**
217
- * Font.
218
- */
219
- 'font'?: FontParams;
220
- /**
221
- * Padding.
222
- */
223
- 'padding'?: Padding;
224
- /**
225
- * Specify word wraps (line breaks) within text. Default value: false.
226
- */
227
- 'noWrap'?: boolean;
228
- static attributeTypeMap: Array<{
229
- name: string;
230
- baseName: string;
231
- type: string;
232
- }>;
233
- static getAttributeTypeMap(): {
234
- name: string;
235
- baseName: string;
236
- type: string;
237
- }[];
155
+ export declare enum CodeLocation {
156
+ Below = "Below",
157
+ Above = "Above",
158
+ None = "None"
238
159
  }
239
160
  /**
240
- *
161
+ * See Aspose.BarCode.Aspose.BarCode.BarCodeRecognition.DecodeType
241
162
  */
242
- export declare enum ChecksumValidation {
243
- Default = "Default",
244
- On = "On",
245
- Off = "Off"
163
+ export declare enum DecodeBarcodeType {
164
+ MostCommonlyUsed = "MostCommonlyUsed",
165
+ Qr = "QR",
166
+ AustraliaPost = "AustraliaPost",
167
+ AustralianPosteParcel = "AustralianPosteParcel",
168
+ Aztec = "Aztec",
169
+ Codabar = "Codabar",
170
+ CodablockF = "CodablockF",
171
+ Code11 = "Code11",
172
+ Code128 = "Code128",
173
+ Code16K = "Code16K",
174
+ Code32 = "Code32",
175
+ Code39 = "Code39",
176
+ Code39FullAscii = "Code39FullASCII",
177
+ Code93 = "Code93",
178
+ CompactPdf417 = "CompactPdf417",
179
+ DataLogic2of5 = "DataLogic2of5",
180
+ DataMatrix = "DataMatrix",
181
+ DatabarExpanded = "DatabarExpanded",
182
+ DatabarExpandedStacked = "DatabarExpandedStacked",
183
+ DatabarLimited = "DatabarLimited",
184
+ DatabarOmniDirectional = "DatabarOmniDirectional",
185
+ DatabarStacked = "DatabarStacked",
186
+ DatabarStackedOmniDirectional = "DatabarStackedOmniDirectional",
187
+ DatabarTruncated = "DatabarTruncated",
188
+ DeutschePostIdentcode = "DeutschePostIdentcode",
189
+ DeutschePostLeitcode = "DeutschePostLeitcode",
190
+ DotCode = "DotCode",
191
+ DutchKix = "DutchKIX",
192
+ Ean13 = "EAN13",
193
+ Ean14 = "EAN14",
194
+ Ean8 = "EAN8",
195
+ Gs1Aztec = "GS1Aztec",
196
+ Gs1Code128 = "GS1Code128",
197
+ Gs1CompositeBar = "GS1CompositeBar",
198
+ Gs1DataMatrix = "GS1DataMatrix",
199
+ Gs1DotCode = "GS1DotCode",
200
+ Gs1HanXin = "GS1HanXin",
201
+ Gs1MicroPdf417 = "GS1MicroPdf417",
202
+ Gs1Qr = "GS1QR",
203
+ HanXin = "HanXin",
204
+ HibcAztecLic = "HIBCAztecLIC",
205
+ HibcAztecPas = "HIBCAztecPAS",
206
+ HibcCode128Lic = "HIBCCode128LIC",
207
+ HibcCode128Pas = "HIBCCode128PAS",
208
+ HibcCode39Lic = "HIBCCode39LIC",
209
+ HibcCode39Pas = "HIBCCode39PAS",
210
+ HibcDataMatrixLic = "HIBCDataMatrixLIC",
211
+ HibcDataMatrixPas = "HIBCDataMatrixPAS",
212
+ Hibcqrlic = "HIBCQRLIC",
213
+ Hibcqrpas = "HIBCQRPAS",
214
+ Iata2of5 = "IATA2of5",
215
+ Isbn = "ISBN",
216
+ Ismn = "ISMN",
217
+ Issn = "ISSN",
218
+ Itf14 = "ITF14",
219
+ Itf6 = "ITF6",
220
+ Interleaved2of5 = "Interleaved2of5",
221
+ ItalianPost25 = "ItalianPost25",
222
+ MacroPdf417 = "MacroPdf417",
223
+ Mailmark = "Mailmark",
224
+ Matrix2of5 = "Matrix2of5",
225
+ MaxiCode = "MaxiCode",
226
+ MicrE13B = "MicrE13B",
227
+ MicroPdf417 = "MicroPdf417",
228
+ MicroQr = "MicroQR",
229
+ Msi = "MSI",
230
+ OneCode = "OneCode",
231
+ Opc = "OPC",
232
+ PatchCode = "PatchCode",
233
+ Pdf417 = "Pdf417",
234
+ Pharmacode = "Pharmacode",
235
+ Planet = "Planet",
236
+ Postnet = "Postnet",
237
+ Pzn = "PZN",
238
+ RectMicroQr = "RectMicroQR",
239
+ Rm4Scc = "RM4SCC",
240
+ Scc14 = "SCC14",
241
+ Sscc18 = "SSCC18",
242
+ Standard2of5 = "Standard2of5",
243
+ Supplement = "Supplement",
244
+ SwissPostParcel = "SwissPostParcel",
245
+ Upca = "UPCA",
246
+ Upce = "UPCE",
247
+ Vin = "VIN"
246
248
  }
247
249
  /**
248
- *
250
+ * See Aspose.BarCode.Generation.EncodeTypes
249
251
  */
250
- export declare enum CodabarChecksumMode {
251
- Mod10 = "Mod10",
252
- Mod16 = "Mod16"
252
+ export declare enum EncodeBarcodeType {
253
+ Qr = "QR",
254
+ AustraliaPost = "AustraliaPost",
255
+ AustralianPosteParcel = "AustralianPosteParcel",
256
+ Aztec = "Aztec",
257
+ Codabar = "Codabar",
258
+ CodablockF = "CodablockF",
259
+ Code11 = "Code11",
260
+ Code128 = "Code128",
261
+ Code16K = "Code16K",
262
+ Code32 = "Code32",
263
+ Code39 = "Code39",
264
+ Code39FullAscii = "Code39FullASCII",
265
+ Code93 = "Code93",
266
+ DataLogic2of5 = "DataLogic2of5",
267
+ DataMatrix = "DataMatrix",
268
+ DatabarExpanded = "DatabarExpanded",
269
+ DatabarExpandedStacked = "DatabarExpandedStacked",
270
+ DatabarLimited = "DatabarLimited",
271
+ DatabarOmniDirectional = "DatabarOmniDirectional",
272
+ DatabarStacked = "DatabarStacked",
273
+ DatabarStackedOmniDirectional = "DatabarStackedOmniDirectional",
274
+ DatabarTruncated = "DatabarTruncated",
275
+ DeutschePostIdentcode = "DeutschePostIdentcode",
276
+ DeutschePostLeitcode = "DeutschePostLeitcode",
277
+ DotCode = "DotCode",
278
+ DutchKix = "DutchKIX",
279
+ Ean13 = "EAN13",
280
+ Ean14 = "EAN14",
281
+ Ean8 = "EAN8",
282
+ Gs1Aztec = "GS1Aztec",
283
+ Gs1CodablockF = "GS1CodablockF",
284
+ Gs1Code128 = "GS1Code128",
285
+ Gs1DataMatrix = "GS1DataMatrix",
286
+ Gs1DotCode = "GS1DotCode",
287
+ Gs1HanXin = "GS1HanXin",
288
+ Gs1MicroPdf417 = "GS1MicroPdf417",
289
+ Gs1Qr = "GS1QR",
290
+ HanXin = "HanXin",
291
+ Iata2of5 = "IATA2of5",
292
+ Isbn = "ISBN",
293
+ Ismn = "ISMN",
294
+ Issn = "ISSN",
295
+ Itf14 = "ITF14",
296
+ Itf6 = "ITF6",
297
+ Interleaved2of5 = "Interleaved2of5",
298
+ ItalianPost25 = "ItalianPost25",
299
+ Msi = "MSI",
300
+ MacroPdf417 = "MacroPdf417",
301
+ Mailmark = "Mailmark",
302
+ Matrix2of5 = "Matrix2of5",
303
+ MaxiCode = "MaxiCode",
304
+ MicroPdf417 = "MicroPdf417",
305
+ MicroQr = "MicroQR",
306
+ Opc = "OPC",
307
+ OneCode = "OneCode",
308
+ Pzn = "PZN",
309
+ PatchCode = "PatchCode",
310
+ Pdf417 = "Pdf417",
311
+ Pharmacode = "Pharmacode",
312
+ Planet = "Planet",
313
+ Postnet = "Postnet",
314
+ Rm4Scc = "RM4SCC",
315
+ RectMicroQr = "RectMicroQR",
316
+ Scc14 = "SCC14",
317
+ Sscc18 = "SSCC18",
318
+ SingaporePost = "SingaporePost",
319
+ Standard2of5 = "Standard2of5",
320
+ SwissPostParcel = "SwissPostParcel",
321
+ Upca = "UPCA",
322
+ Upce = "UPCE",
323
+ UpcaGs1Code128Coupon = "UpcaGs1Code128Coupon",
324
+ UpcaGs1DatabarCoupon = "UpcaGs1DatabarCoupon",
325
+ Vin = "VIN"
253
326
  }
254
327
  /**
255
- * Codabar parameters.
328
+ * Data to encode in barcode
256
329
  */
257
- export declare class CodabarParams {
258
- /**
259
- * Checksum algorithm for Codabar barcodes. Default value: CodabarChecksumMode.Mod16. To enable checksum calculation set value EnableChecksum.Yes to property EnableChecksum.
260
- */
261
- 'checksumMode'?: CodabarChecksumMode;
330
+ export declare class EncodeData {
331
+ 'dataType'?: EncodeDataType;
262
332
  /**
263
- * Start symbol (character) of Codabar symbology. Default value: CodabarSymbol.A
333
+ * String represents data to encode
264
334
  */
265
- 'startSymbol'?: CodabarSymbol;
266
- /**
267
- * Stop symbol (character) of Codabar symbology. Default value: CodabarSymbol.A
268
- */
269
- 'stopSymbol'?: CodabarSymbol;
335
+ 'data': string;
270
336
  static attributeTypeMap: Array<{
271
337
  name: string;
272
338
  baseName: string;
@@ -279,30 +345,20 @@ export declare class CodabarParams {
279
345
  }[];
280
346
  }
281
347
  /**
282
- *
348
+ * Types of data can be encoded to barcode
283
349
  */
284
- export declare enum CodabarSymbol {
285
- A = "A",
286
- B = "B",
287
- C = "C",
288
- D = "D"
350
+ export declare enum EncodeDataType {
351
+ StringData = "StringData",
352
+ Base64Bytes = "Base64Bytes",
353
+ HexBytes = "HexBytes"
289
354
  }
290
355
  /**
291
- * Codablock parameters.
356
+ * Barcode generation parameters
292
357
  */
293
- export declare class CodablockParams {
294
- /**
295
- * Height/Width ratio of 2D BarCode module.
296
- */
297
- 'aspectRatio'?: number;
298
- /**
299
- * Columns count.
300
- */
301
- 'columns'?: number;
302
- /**
303
- * Rows count.
304
- */
305
- 'rows'?: number;
358
+ export declare class GenerateParams {
359
+ 'barcodeType': EncodeBarcodeType;
360
+ 'encodeData': EncodeData;
361
+ 'barcodeImageParams'?: BarcodeImageParams;
306
362
  static attributeTypeMap: Array<{
307
363
  name: string;
308
364
  baseName: string;
@@ -315,34 +371,44 @@ export declare class CodablockParams {
315
371
  }[];
316
372
  }
317
373
  /**
318
- * 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.
374
+ * Subset of Aspose.Drawing.GraphicsUnit.
375
+ */
376
+ export declare enum GraphicsUnit {
377
+ Pixel = "Pixel",
378
+ Point = "Point",
379
+ Inch = "Inch",
380
+ Millimeter = "Millimeter"
381
+ }
382
+ /**
383
+ * Kind of image to recognize
319
384
  */
320
- export declare enum Code128Emulation {
321
- None = "None",
322
- Code903 = "Code903",
323
- Code904 = "Code904",
324
- Code905 = "Code905"
385
+ export declare enum RecognitionImageKind {
386
+ Photo = "Photo",
387
+ ScannedDocument = "ScannedDocument",
388
+ ClearImage = "ClearImage"
325
389
  }
326
390
  /**
327
- *
391
+ * Recognition mode.
328
392
  */
329
- export declare enum Code128EncodeMode {
330
- Auto = "Auto",
331
- CodeA = "CodeA",
332
- CodeB = "CodeB",
333
- CodeAB = "CodeAB",
334
- CodeC = "CodeC",
335
- CodeAC = "CodeAC",
336
- CodeBC = "CodeBC"
393
+ export declare enum RecognitionMode {
394
+ Fast = "Fast",
395
+ Normal = "Normal",
396
+ Excellent = "Excellent"
337
397
  }
338
398
  /**
339
- * Code128 params.
399
+ * Barcode recognize request
340
400
  */
341
- export declare class Code128Params {
401
+ export declare class RecognizeBase64Request {
402
+ /**
403
+ * Array of decode types to find on barcode
404
+ */
405
+ 'barcodeTypes': Array<DecodeBarcodeType>;
342
406
  /**
343
- * Encoding mode for Code128 barcodes. Code 128 specification Default value: Code128EncodeMode.Auto.
407
+ * Barcode image bytes encoded as base-64.
344
408
  */
345
- 'encodeMode'?: Code128EncodeMode;
409
+ 'fileBase64': string;
410
+ 'recognitionMode'?: RecognitionMode;
411
+ 'recognitionImageKind'?: RecognitionImageKind;
346
412
  static attributeTypeMap: Array<{
347
413
  name: string;
348
414
  baseName: string;
@@ -355,21 +421,17 @@ export declare class Code128Params {
355
421
  }[];
356
422
  }
357
423
  /**
358
- * Code16K parameters.
424
+ * Wrapper around Drawing.Point for proper specification.
359
425
  */
360
- export declare class Code16KParams {
361
- /**
362
- * Height/Width ratio of 2D BarCode module.
363
- */
364
- 'aspectRatio'?: number;
426
+ export declare class RegionPoint {
365
427
  /**
366
- * Size of the left quiet zone in xDimension. Default value: 10, meaning if xDimension = 2px than left quiet zone will be 20px.
428
+ * X-coordinate
367
429
  */
368
- 'quietZoneLeftCoef'?: number;
430
+ 'x'?: number;
369
431
  /**
370
- * Size of the right quiet zone in xDimension. Default value: 1, meaning if xDimension = 2px than right quiet zone will be 2px.
432
+ * Y-coordinate
371
433
  */
372
- 'quietZoneRightCoef'?: number;
434
+ 'y'?: number;
373
435
  static attributeTypeMap: Array<{
374
436
  name: string;
375
437
  baseName: string;
@@ -382,21 +444,13 @@ export declare class Code16KParams {
382
444
  }[];
383
445
  }
384
446
  /**
385
- *
386
- */
387
- export declare enum CodeLocation {
388
- Below = "Below",
389
- Above = "Above",
390
- None = "None"
391
- }
392
- /**
393
- * Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.
447
+ * Scan barcode request.
394
448
  */
395
- export declare class CouponParams {
449
+ export declare class ScanBase64Request {
396
450
  /**
397
- * Space between main the BarCode and supplement BarCode in Unit value.
451
+ * Barcode image bytes encoded as base-64.
398
452
  */
399
- 'supplementSpace'?: number;
453
+ 'fileBase64': string;
400
454
  static attributeTypeMap: Array<{
401
455
  name: string;
402
456
  baseName: string;
@@ -409,3039 +463,255 @@ export declare class CouponParams {
409
463
  }[];
410
464
  }
411
465
  /**
412
- *
413
- */
414
- export declare enum CustomerInformationInterpretingType {
415
- CTable = "CTable",
416
- NTable = "NTable",
417
- Other = "Other"
418
- }
419
- /**
420
- * Databar parameters.
466
+ * Generate barcode using GET request with parameters in route and query string.
421
467
  */
422
- export declare class DataBarParams {
468
+ export declare class GenerateRequestWrapper {
423
469
  /**
424
- * Height/Width ratio of 2D BarCode module. Used for DataBar stacked.
470
+ * Type of barcode to generate.
425
471
  */
426
- 'aspectRatio'?: number;
472
+ 'barcodeType': EncodeBarcodeType;
427
473
  /**
428
- * Columns count.
474
+ * String represents data to encode
429
475
  */
430
- 'columns'?: number;
476
+ 'data': string;
431
477
  /**
432
- * Rows count.
478
+ * Type of data to encode.
479
+ Default value: StringData.
433
480
  */
434
- 'rows'?: number;
481
+ 'dataType'?: EncodeDataType;
435
482
  /**
436
- * Enables flag of 2D composite component with DataBar barcode
483
+ * Barcode output image format.
484
+ Default value: png
437
485
  */
438
- 'is2DCompositeComponent'?: boolean;
486
+ 'imageFormat'?: BarcodeImageFormat;
439
487
  /**
440
- * If this flag is set, it allows only GS1 encoding standard for Databar barcode types
488
+ * Specify the displaying Text Location, set to CodeLocation.None to hide CodeText.
489
+ Default value: CodeLocation.Below.
441
490
  */
442
- 'isAllowOnlyGS1Encoding'?: boolean;
443
- static attributeTypeMap: Array<{
444
- name: string;
445
- baseName: string;
446
- type: string;
447
- }>;
448
- static getAttributeTypeMap(): {
449
- name: string;
450
- baseName: string;
451
- type: string;
452
- }[];
453
- }
454
- /**
455
- *
456
- */
457
- export declare enum DataMatrixEccType {
458
- EccAuto = "EccAuto",
459
- Ecc000 = "Ecc000",
460
- Ecc050 = "Ecc050",
461
- Ecc080 = "Ecc080",
462
- Ecc100 = "Ecc100",
463
- Ecc140 = "Ecc140",
464
- Ecc200 = "Ecc200"
465
- }
466
- /**
467
- * DataMatrix encoder's encoding mode, default to Auto
468
- */
469
- export declare enum DataMatrixEncodeMode {
470
- Auto = "Auto",
471
- ASCII = "ASCII",
472
- Full = "Full",
473
- Custom = "Custom",
474
- C40 = "C40",
475
- Text = "Text",
476
- EDIFACT = "EDIFACT",
477
- ANSIX12 = "ANSIX12",
478
- ExtendedCodetext = "ExtendedCodetext"
479
- }
480
- /**
481
- * DataMatrix parameters.
482
- */
483
- export declare class DataMatrixParams {
491
+ 'textLocation'?: CodeLocation;
484
492
  /**
485
- * Height/Width ratio of 2D BarCode module
493
+ * Specify the displaying bars and content Color.
494
+ Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #.
495
+ For example: AliceBlue or #FF000000
496
+ Default value: Black.
486
497
  */
487
- 'aspectRatio'?: number;
498
+ 'foregroundColor'?: string;
488
499
  /**
489
- * @deprecated This property is obsolete and will be removed in future releases. Unicode symbols detection and encoding will be processed in Auto mode with Extended Channel Interpretation charset designator. Using of own encodings requires manual CodeText encoding into byte[] array. Sets the encoding of codetext.
500
+ * Background color of the barcode image.
501
+ Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #.
502
+ For example: AliceBlue or #FF000000
503
+ Default value: White.
490
504
  */
491
- 'textEncoding'?: string;
505
+ 'backgroundColor'?: string;
492
506
  /**
493
- * @deprecated Will be replaced with 'DataMatrix.Version' in the next release Columns count.
507
+ * Common Units for all measuring in query. Default units: pixel.
494
508
  */
495
- 'columns'?: number;
509
+ 'units'?: GraphicsUnit;
496
510
  /**
497
- * Datamatrix ECC type. Default value: DataMatrixEccType.Ecc200.
511
+ * Resolution of the BarCode image.
512
+ One value for both dimensions.
513
+ Default value: 96 dpi.
514
+ Decimal separator is dot.
498
515
  */
499
- 'dataMatrixEcc'?: DataMatrixEccType;
516
+ 'resolution'?: number;
500
517
  /**
501
- * Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.Auto.
518
+ * Height of the barcode image in given units. Default units: pixel.
519
+ Decimal separator is dot.
502
520
  */
503
- 'dataMatrixEncodeMode'?: DataMatrixEncodeMode;
521
+ 'imageHeight'?: number;
504
522
  /**
505
- * @deprecated Will be replaced with 'DataMatrix.Version' in the next release Rows count.
523
+ * Width of the barcode image in given units. Default units: pixel.
524
+ Decimal separator is dot.
506
525
  */
507
- 'rows'?: number;
526
+ 'imageWidth'?: number;
508
527
  /**
509
- * 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.
528
+ * BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation.
529
+ If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image.
530
+ Default value: 0.
510
531
  */
511
- 'macroCharacters'?: MacroCharacter;
532
+ 'rotationAngle'?: number;
512
533
  /**
513
- * Sets a Datamatrix symbol size. Default value: DataMatrixVersion.Auto.
534
+ * @param barcodeType Type of barcode to generate.
535
+
536
+ * @param data String represents data to encode
514
537
  */
515
- 'version'?: DataMatrixVersion;
516
- static attributeTypeMap: Array<{
517
- name: string;
518
- baseName: string;
519
- type: string;
520
- }>;
521
- static getAttributeTypeMap(): {
522
- name: string;
523
- baseName: string;
524
- type: string;
525
- }[];
538
+ constructor(barcodeType: EncodeBarcodeType, data: string);
526
539
  }
527
540
  /**
528
- *
541
+ * Generate barcode using POST request with parameters in body in json or xml format.
529
542
  */
530
- export declare enum DataMatrixVersion {
531
- Auto = "Auto",
532
- RowsColumns = "RowsColumns",
533
- ECC0009x9 = "ECC000_9x9",
534
- ECC00005011x11 = "ECC000_050_11x11",
535
- ECC00010013x13 = "ECC000_100_13x13",
536
- ECC00010015x15 = "ECC000_100_15x15",
537
- ECC00014017x17 = "ECC000_140_17x17",
538
- ECC00014019x19 = "ECC000_140_19x19",
539
- ECC00014021x21 = "ECC000_140_21x21",
540
- ECC00014023x23 = "ECC000_140_23x23",
541
- ECC00014025x25 = "ECC000_140_25x25",
542
- ECC00014027x27 = "ECC000_140_27x27",
543
- ECC00014029x29 = "ECC000_140_29x29",
544
- ECC00014031x31 = "ECC000_140_31x31",
545
- ECC00014033x33 = "ECC000_140_33x33",
546
- ECC00014035x35 = "ECC000_140_35x35",
547
- ECC00014037x37 = "ECC000_140_37x37",
548
- ECC00014039x39 = "ECC000_140_39x39",
549
- ECC00014041x41 = "ECC000_140_41x41",
550
- ECC00014043x43 = "ECC000_140_43x43",
551
- ECC00014045x45 = "ECC000_140_45x45",
552
- ECC00014047x47 = "ECC000_140_47x47",
553
- ECC00014049x49 = "ECC000_140_49x49",
554
- ECC20010x10 = "ECC200_10x10",
555
- ECC20012x12 = "ECC200_12x12",
556
- ECC20014x14 = "ECC200_14x14",
557
- ECC20016x16 = "ECC200_16x16",
558
- ECC20018x18 = "ECC200_18x18",
559
- ECC20020x20 = "ECC200_20x20",
560
- ECC20022x22 = "ECC200_22x22",
561
- ECC20024x24 = "ECC200_24x24",
562
- ECC20026x26 = "ECC200_26x26",
563
- ECC20032x32 = "ECC200_32x32",
564
- ECC20036x36 = "ECC200_36x36",
565
- ECC20040x40 = "ECC200_40x40",
566
- ECC20044x44 = "ECC200_44x44",
567
- ECC20048x48 = "ECC200_48x48",
568
- ECC20052x52 = "ECC200_52x52",
569
- ECC20064x64 = "ECC200_64x64",
570
- ECC20072x72 = "ECC200_72x72",
571
- ECC20080x80 = "ECC200_80x80",
572
- ECC20088x88 = "ECC200_88x88",
573
- ECC20096x96 = "ECC200_96x96",
574
- ECC200104x104 = "ECC200_104x104",
575
- ECC200120x120 = "ECC200_120x120",
576
- ECC200132x132 = "ECC200_132x132",
577
- ECC200144x144 = "ECC200_144x144",
578
- ECC2008x18 = "ECC200_8x18",
579
- ECC2008x32 = "ECC200_8x32",
580
- ECC20012x26 = "ECC200_12x26",
581
- ECC20012x36 = "ECC200_12x36",
582
- ECC20016x36 = "ECC200_16x36",
583
- ECC20016x48 = "ECC200_16x48",
584
- DMRE8x48 = "DMRE_8x48",
585
- DMRE8x64 = "DMRE_8x64",
586
- DMRE8x80 = "DMRE_8x80",
587
- DMRE8x96 = "DMRE_8x96",
588
- DMRE8x120 = "DMRE_8x120",
589
- DMRE8x144 = "DMRE_8x144",
590
- DMRE12x64 = "DMRE_12x64",
591
- DMRE12x88 = "DMRE_12x88",
592
- DMRE16x64 = "DMRE_16x64",
593
- DMRE20x36 = "DMRE_20x36",
594
- DMRE20x44 = "DMRE_20x44",
595
- DMRE20x64 = "DMRE_20x64",
596
- DMRE22x48 = "DMRE_22x48",
597
- DMRE24x48 = "DMRE_24x48",
598
- DMRE24x64 = "DMRE_24x64",
599
- DMRE26x40 = "DMRE_26x40",
600
- DMRE26x48 = "DMRE_26x48",
601
- DMRE26x64 = "DMRE_26x64"
543
+ export declare class GenerateBodyRequestWrapper {
544
+ /**
545
+ *
546
+ */
547
+ 'generateParams': GenerateParams;
548
+ /**
549
+ * @param generateParams
550
+ */
551
+ constructor(generateParams: GenerateParams);
602
552
  }
603
553
  /**
604
- * See DecodeType
554
+ * Generate barcode using POST request with parameters in multipart form.
605
555
  */
606
- export declare enum DecodeBarcodeType {
607
- All = "all",
608
- AustraliaPost = "AustraliaPost",
609
- Aztec = "Aztec",
610
- ISBN = "ISBN",
611
- Codabar = "Codabar",
612
- Code11 = "Code11",
613
- Code128 = "Code128",
614
- GS1Code128 = "GS1Code128",
615
- Code39Extended = "Code39Extended",
616
- Code39Standard = "Code39Standard",
617
- Code93Extended = "Code93Extended",
618
- Code93Standard = "Code93Standard",
619
- DataMatrix = "DataMatrix",
620
- DeutschePostIdentcode = "DeutschePostIdentcode",
621
- DeutschePostLeitcode = "DeutschePostLeitcode",
622
- EAN13 = "EAN13",
623
- EAN14 = "EAN14",
624
- EAN8 = "EAN8",
625
- IATA2of5 = "IATA2of5",
626
- Interleaved2of5 = "Interleaved2of5",
627
- ISSN = "ISSN",
628
- ISMN = "ISMN",
629
- ItalianPost25 = "ItalianPost25",
630
- ITF14 = "ITF14",
631
- ITF6 = "ITF6",
632
- MacroPdf417 = "MacroPdf417",
633
- Matrix2of5 = "Matrix2of5",
634
- MSI = "MSI",
635
- OneCode = "OneCode",
636
- OPC = "OPC",
637
- PatchCode = "PatchCode",
638
- Pdf417 = "Pdf417",
639
- MicroPdf417 = "MicroPdf417",
640
- Planet = "Planet",
641
- Postnet = "Postnet",
642
- PZN = "PZN",
643
- QR = "QR",
644
- MicroQR = "MicroQR",
645
- RM4SCC = "RM4SCC",
646
- SCC14 = "SCC14",
647
- SSCC18 = "SSCC18",
648
- Standard2of5 = "Standard2of5",
649
- Supplement = "Supplement",
650
- UPCA = "UPCA",
651
- UPCE = "UPCE",
652
- VIN = "VIN",
653
- Pharmacode = "Pharmacode",
654
- GS1DataMatrix = "GS1DataMatrix",
655
- DatabarOmniDirectional = "DatabarOmniDirectional",
656
- DatabarTruncated = "DatabarTruncated",
657
- DatabarLimited = "DatabarLimited",
658
- DatabarExpanded = "DatabarExpanded",
659
- SwissPostParcel = "SwissPostParcel",
660
- AustralianPosteParcel = "AustralianPosteParcel",
661
- Code16K = "Code16K",
662
- DatabarStackedOmniDirectional = "DatabarStackedOmniDirectional",
663
- DatabarStacked = "DatabarStacked",
664
- DatabarExpandedStacked = "DatabarExpandedStacked",
665
- CompactPdf417 = "CompactPdf417",
666
- GS1QR = "GS1QR",
667
- MaxiCode = "MaxiCode",
668
- MicrE13B = "MicrE13B",
669
- Code32 = "Code32",
670
- DataLogic2of5 = "DataLogic2of5",
671
- DotCode = "DotCode",
672
- DutchKIX = "DutchKIX",
673
- CodablockF = "CodablockF",
674
- Mailmark = "Mailmark",
675
- GS1DotCode = "GS1DotCode",
676
- HIBCCode39LIC = "HIBCCode39LIC",
677
- HIBCCode128LIC = "HIBCCode128LIC",
678
- HIBCAztecLIC = "HIBCAztecLIC",
679
- HIBCDataMatrixLIC = "HIBCDataMatrixLIC",
680
- HIBCQRLIC = "HIBCQRLIC",
681
- HIBCCode39PAS = "HIBCCode39PAS",
682
- HIBCCode128PAS = "HIBCCode128PAS",
683
- HIBCAztecPAS = "HIBCAztecPAS",
684
- HIBCDataMatrixPAS = "HIBCDataMatrixPAS",
685
- HIBCQRPAS = "HIBCQRPAS",
686
- HanXin = "HanXin",
687
- GS1HanXin = "GS1HanXin",
688
- GS1Aztec = "GS1Aztec",
689
- GS1CompositeBar = "GS1CompositeBar",
690
- GS1MicroPdf417 = "GS1MicroPdf417",
691
- MostCommonlyUsed = "mostCommonlyUsed"
692
- }
693
- /**
694
- * Class for disc space information.
695
- */
696
- export declare class DiscUsage {
697
- /**
698
- * Application used disc space.
699
- */
700
- 'usedSize': number;
701
- /**
702
- * Total disc space.
703
- */
704
- 'totalSize': number;
705
- static attributeTypeMap: Array<{
706
- name: string;
707
- baseName: string;
708
- type: string;
709
- }>;
710
- static getAttributeTypeMap(): {
711
- name: string;
712
- baseName: string;
713
- type: string;
714
- }[];
715
- }
716
- /**
717
- *
718
- */
719
- export declare enum DotCodeEncodeMode {
720
- Auto = "Auto",
721
- Bytes = "Bytes",
722
- ExtendedCodetext = "ExtendedCodetext"
723
- }
724
- /**
725
- * DotCode parameters.
726
- */
727
- export declare class DotCodeParams {
728
- /**
729
- * Height/Width ratio of 2D BarCode module.
730
- */
731
- 'aspectRatio'?: number;
732
- /**
733
- * Identifies columns count. Sum of the number of rows plus the number of columns of a DotCode symbol must be odd. Number of columns must be at least 5.
734
- */
735
- 'columns'?: number;
736
- /**
737
- * Identifies DotCode encode mode. Default value: Auto.
738
- */
739
- 'encodeMode'?: DotCodeEncodeMode;
740
- /**
741
- * Identifies ECI encoding. Used when DotCodeEncodeMode is Auto. Default value: ISO-8859-1.
742
- */
743
- 'eCIEncoding'?: ECIEncodings;
744
- /**
745
- * Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader. Default value is false.
746
- */
747
- 'isReaderInitialization'?: boolean;
748
- /**
749
- * Identifies rows count. Sum of the number of rows plus the number of columns of a DotCode symbol must be odd. Number of rows must be at least 5.
750
- */
751
- 'rows'?: number;
752
- static attributeTypeMap: Array<{
753
- name: string;
754
- baseName: string;
755
- type: string;
756
- }>;
757
- static getAttributeTypeMap(): {
758
- name: string;
759
- baseName: string;
760
- type: string;
761
- }[];
762
- }
763
- /**
764
- *
765
- */
766
- export declare enum ECIEncodings {
767
- NONE = "NONE",
768
- ISO88591 = "ISO_8859_1",
769
- ISO88592 = "ISO_8859_2",
770
- ISO88593 = "ISO_8859_3",
771
- ISO88594 = "ISO_8859_4",
772
- ISO88595 = "ISO_8859_5",
773
- ISO88596 = "ISO_8859_6",
774
- ISO88597 = "ISO_8859_7",
775
- ISO88598 = "ISO_8859_8",
776
- ISO88599 = "ISO_8859_9",
777
- ISO885910 = "ISO_8859_10",
778
- ISO885911 = "ISO_8859_11",
779
- ISO885913 = "ISO_8859_13",
780
- ISO885914 = "ISO_8859_14",
781
- ISO885915 = "ISO_8859_15",
782
- ISO885916 = "ISO_8859_16",
783
- ShiftJIS = "Shift_JIS",
784
- Win1250 = "Win1250",
785
- Win1251 = "Win1251",
786
- Win1252 = "Win1252",
787
- Win1256 = "Win1256",
788
- UTF16BE = "UTF16BE",
789
- UTF8 = "UTF8",
790
- USASCII = "US_ASCII",
791
- Big5 = "Big5",
792
- GB18030 = "GB18030",
793
- EUCKR = "EUC_KR"
794
- }
795
- /**
796
- *
797
- */
798
- export declare enum EnableChecksum {
799
- Default = "Default",
800
- Yes = "Yes",
801
- No = "No"
802
- }
803
- /**
804
- * See EncodeTypes
805
- */
806
- export declare enum EncodeBarcodeType {
807
- Codabar = "Codabar",
808
- Code11 = "Code11",
809
- Code39Standard = "Code39Standard",
810
- Code39Extended = "Code39Extended",
811
- Code93Standard = "Code93Standard",
812
- Code93Extended = "Code93Extended",
813
- Code128 = "Code128",
814
- GS1Code128 = "GS1Code128",
815
- EAN8 = "EAN8",
816
- EAN13 = "EAN13",
817
- EAN14 = "EAN14",
818
- SCC14 = "SCC14",
819
- SSCC18 = "SSCC18",
820
- UPCA = "UPCA",
821
- UPCE = "UPCE",
822
- ISBN = "ISBN",
823
- ISSN = "ISSN",
824
- ISMN = "ISMN",
825
- Standard2of5 = "Standard2of5",
826
- Interleaved2of5 = "Interleaved2of5",
827
- Matrix2of5 = "Matrix2of5",
828
- ItalianPost25 = "ItalianPost25",
829
- IATA2of5 = "IATA2of5",
830
- ITF14 = "ITF14",
831
- ITF6 = "ITF6",
832
- MSI = "MSI",
833
- VIN = "VIN",
834
- DeutschePostIdentcode = "DeutschePostIdentcode",
835
- DeutschePostLeitcode = "DeutschePostLeitcode",
836
- OPC = "OPC",
837
- PZN = "PZN",
838
- Code16K = "Code16K",
839
- Pharmacode = "Pharmacode",
840
- DataMatrix = "DataMatrix",
841
- QR = "QR",
842
- Aztec = "Aztec",
843
- Pdf417 = "Pdf417",
844
- MacroPdf417 = "MacroPdf417",
845
- AustraliaPost = "AustraliaPost",
846
- Postnet = "Postnet",
847
- Planet = "Planet",
848
- OneCode = "OneCode",
849
- RM4SCC = "RM4SCC",
850
- DatabarOmniDirectional = "DatabarOmniDirectional",
851
- DatabarTruncated = "DatabarTruncated",
852
- DatabarLimited = "DatabarLimited",
853
- DatabarExpanded = "DatabarExpanded",
854
- SingaporePost = "SingaporePost",
855
- GS1DataMatrix = "GS1DataMatrix",
856
- AustralianPosteParcel = "AustralianPosteParcel",
857
- SwissPostParcel = "SwissPostParcel",
858
- PatchCode = "PatchCode",
859
- DatabarExpandedStacked = "DatabarExpandedStacked",
860
- DatabarStacked = "DatabarStacked",
861
- DatabarStackedOmniDirectional = "DatabarStackedOmniDirectional",
862
- MicroPdf417 = "MicroPdf417",
863
- GS1QR = "GS1QR",
864
- MaxiCode = "MaxiCode",
865
- Code32 = "Code32",
866
- DataLogic2of5 = "DataLogic2of5",
867
- DotCode = "DotCode",
868
- DutchKIX = "DutchKIX",
869
- UpcaGs1Code128Coupon = "UpcaGs1Code128Coupon",
870
- UpcaGs1DatabarCoupon = "UpcaGs1DatabarCoupon",
871
- CodablockF = "CodablockF",
872
- GS1CodablockF = "GS1CodablockF",
873
- Mailmark = "Mailmark",
874
- GS1DotCode = "GS1DotCode",
875
- HanXin = "HanXin",
876
- GS1HanXin = "GS1HanXin",
877
- GS1Aztec = "GS1Aztec",
878
- GS1MicroPdf417 = "GS1MicroPdf417"
879
- }
880
- /**
881
- * The error details
882
- */
883
- export declare class ErrorDetails {
884
- /**
885
- * The request id
886
- */
887
- 'requestId'?: string;
888
- /**
889
- * Date
890
- */
891
- 'date': Date;
892
- static attributeTypeMap: Array<{
893
- name: string;
894
- baseName: string;
895
- type: string;
896
- }>;
897
- static getAttributeTypeMap(): {
898
- name: string;
899
- baseName: string;
900
- type: string;
901
- }[];
902
- }
903
- /**
904
- * File versions FileVersion.
905
- */
906
- export declare class FileVersions {
907
- /**
908
- * File versions FileVersion.
909
- */
910
- 'value'?: Array<FileVersion>;
911
- static attributeTypeMap: Array<{
912
- name: string;
913
- baseName: string;
914
- type: string;
915
- }>;
916
- static getAttributeTypeMap(): {
917
- name: string;
918
- baseName: string;
919
- type: string;
920
- }[];
921
- }
922
- /**
923
- * Files list
924
- */
925
- export declare class FilesList {
926
- /**
927
- * Files and folders contained by folder StorageFile.
928
- */
929
- 'value'?: Array<StorageFile>;
930
- static attributeTypeMap: Array<{
931
- name: string;
932
- baseName: string;
933
- type: string;
934
- }>;
935
- static getAttributeTypeMap(): {
936
- name: string;
937
- baseName: string;
938
- type: string;
939
- }[];
940
- }
941
- /**
942
- * File upload result
943
- */
944
- export declare class FilesUploadResult {
945
- /**
946
- * List of uploaded file names
947
- */
948
- 'uploaded'?: Array<string>;
949
- /**
950
- * List of errors.
951
- */
952
- 'errors'?: Array<Error>;
953
- static attributeTypeMap: Array<{
954
- name: string;
955
- baseName: string;
956
- type: string;
957
- }>;
958
- static getAttributeTypeMap(): {
959
- name: string;
960
- baseName: string;
961
- type: string;
962
- }[];
963
- }
964
- /**
965
- *
966
- */
967
- export declare enum FontMode {
968
- Auto = "Auto",
969
- Manual = "Manual"
970
- }
971
- /**
972
- * Font.
973
- */
974
- export declare class FontParams {
975
- /**
976
- * Font family.
977
- */
978
- 'family'?: string;
979
- /**
980
- * Font size in units.
981
- */
982
- 'size'?: number;
983
- /**
984
- * Font style.
985
- */
986
- 'style'?: FontStyle;
987
- static attributeTypeMap: Array<{
988
- name: string;
989
- baseName: string;
990
- type: string;
991
- }>;
992
- static getAttributeTypeMap(): {
993
- name: string;
994
- baseName: string;
995
- type: string;
996
- }[];
997
- }
998
- /**
999
- *
1000
- */
1001
- export declare enum FontStyle {
1002
- Regular = "Regular",
1003
- Bold = "Bold",
1004
- Italic = "Italic",
1005
- Underline = "Underline",
1006
- Strikeout = "Strikeout"
1007
- }
1008
- /**
1009
- * Represents extended BarcodeGenerator params.
1010
- */
1011
- export declare class GeneratorParams {
1012
- /**
1013
- * Type of barcode to generate.
1014
- */
1015
- 'typeOfBarcode': EncodeBarcodeType;
1016
- /**
1017
- * Text to encode.
1018
- */
1019
- 'text': string;
1020
- /**
1021
- * Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
1022
- */
1023
- 'twoDDisplayText'?: string;
1024
- /**
1025
- * Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below.
1026
- */
1027
- 'textLocation'?: CodeLocation;
1028
- /**
1029
- * Text alignment.
1030
- */
1031
- 'textAlignment'?: TextAlignment;
1032
- /**
1033
- * Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
1034
- */
1035
- 'textColor'?: string;
1036
- /**
1037
- * Specify the displaying Text's font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto.
1038
- */
1039
- 'font'?: FontParams;
1040
- /**
1041
- * 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.
1042
- */
1043
- 'fontSizeMode'?: FontMode;
1044
- /**
1045
- * Specify word wraps (line breaks) within text. Default value: false.
1046
- */
1047
- 'noWrap'?: boolean;
1048
- /**
1049
- * Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
1050
- */
1051
- 'resolution'?: number;
1052
- /**
1053
- * @deprecated Use 'Resolution' instead.
1054
- */
1055
- 'resolutionX'?: number;
1056
- /**
1057
- * @deprecated Use 'Resolution' instead.
1058
- */
1059
- 'resolutionY'?: number;
1060
- /**
1061
- * The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
1062
- */
1063
- 'dimensionX'?: number;
1064
- /**
1065
- * Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
1066
- */
1067
- 'textSpace'?: number;
1068
- /**
1069
- * Common Units for all measuring in query. Default units: pixel.
1070
- */
1071
- 'units'?: AvailableGraphicsUnit;
1072
- /**
1073
- * Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None.
1074
- */
1075
- 'sizeMode'?: AutoSizeMode;
1076
- /**
1077
- * Height of the barcode in given units. Default units: pixel.
1078
- */
1079
- 'barHeight'?: number;
1080
- /**
1081
- * Height of the barcode image in given units. Default units: pixel.
1082
- */
1083
- 'imageHeight'?: number;
1084
- /**
1085
- * Width of the barcode image in given units. Default units: pixel.
1086
- */
1087
- 'imageWidth'?: number;
1088
- /**
1089
- * BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
1090
- */
1091
- 'rotationAngle'?: number;
1092
- /**
1093
- * Barcode paddings. Default value: 5pt 5pt 5pt 5pt.
1094
- */
1095
- 'padding'?: Padding;
1096
- /**
1097
- * Additional caption above barcode.
1098
- */
1099
- 'captionAbove'?: CaptionParams;
1100
- /**
1101
- * Additional caption below barcode.
1102
- */
1103
- 'captionBelow'?: CaptionParams;
1104
- /**
1105
- * Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
1106
- */
1107
- 'backColor'?: string;
1108
- /**
1109
- * Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
1110
- */
1111
- 'barColor'?: string;
1112
- /**
1113
- * Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF
1114
- */
1115
- 'borderColor'?: string;
1116
- /**
1117
- * Border width. Default value: 0. Ignored if Visible is set to false.
1118
- */
1119
- 'borderWidth'?: number;
1120
- /**
1121
- * Border dash style. Default value: BorderDashStyle.Solid.
1122
- */
1123
- 'borderDashStyle'?: BorderDashStyle;
1124
- /**
1125
- * Border visibility. If false than parameter Width is always ignored (0). Default value: false.
1126
- */
1127
- 'borderVisible'?: boolean;
1128
- /**
1129
- * Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology
1130
- */
1131
- 'enableChecksum'?: EnableChecksum;
1132
- /**
1133
- * Indicates whether explains the character \"\\\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, \"\\\" will be explained as a special escape character. Otherwise, \"\\\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \\013 and \\\\CR stands for CR.
1134
- */
1135
- 'enableEscape'?: boolean;
1136
- /**
1137
- * Value indicating whether bars are filled. Only for 1D barcodes. Default value: true.
1138
- */
1139
- 'filledBars'?: boolean;
1140
- /**
1141
- * Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
1142
- */
1143
- 'alwaysShowChecksum'?: boolean;
1144
- /**
1145
- * Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
1146
- */
1147
- 'wideNarrowRatio'?: number;
1148
- /**
1149
- * Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
1150
- */
1151
- 'validateText'?: boolean;
1152
- /**
1153
- * Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
1154
- */
1155
- 'supplementData'?: string;
1156
- /**
1157
- * Space between main the BarCode and supplement BarCode.
1158
- */
1159
- 'supplementSpace'?: number;
1160
- /**
1161
- * Bars reduction value that is used to compensate ink spread while printing.
1162
- */
1163
- 'barWidthReduction'?: number;
1164
- /**
1165
- * Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing.
1166
- */
1167
- 'useAntiAlias'?: boolean;
1168
- /**
1169
- * AustralianPost params.
1170
- */
1171
- 'australianPost'?: AustralianPostParams;
1172
- /**
1173
- * Aztec params.
1174
- */
1175
- 'aztec'?: AztecParams;
1176
- /**
1177
- * Codabar params.
1178
- */
1179
- 'codabar'?: CodabarParams;
1180
- /**
1181
- * Codablock params.
1182
- */
1183
- 'codablock'?: CodablockParams;
1184
- /**
1185
- * Code16K params.
1186
- */
1187
- 'code16K'?: Code16KParams;
1188
- /**
1189
- * Coupon params.
1190
- */
1191
- 'coupon'?: CouponParams;
1192
- /**
1193
- * DataBar params.
1194
- */
1195
- 'dataBar'?: DataBarParams;
1196
- /**
1197
- * DataMatrix params.
1198
- */
1199
- 'dataMatrix'?: DataMatrixParams;
1200
- /**
1201
- * DotCode params.
1202
- */
1203
- 'dotCode'?: DotCodeParams;
1204
- /**
1205
- * ITF params.
1206
- */
1207
- 'ITF'?: ITFParams;
1208
- /**
1209
- * MaxiCode params.
1210
- */
1211
- 'maxiCode'?: MaxiCodeParams;
1212
- /**
1213
- * Pdf417 params.
1214
- */
1215
- 'pdf417'?: Pdf417Params;
1216
- /**
1217
- * Postal params.
1218
- */
1219
- 'postal'?: PostalParams;
1220
- /**
1221
- * QR params.
1222
- */
1223
- 'QR'?: QrParams;
1224
- /**
1225
- * PatchCode params.
1226
- */
1227
- 'patchCode'?: PatchCodeParams;
1228
- /**
1229
- * Code128 parameters
1230
- */
1231
- 'code128'?: Code128Params;
1232
- /**
1233
- * HanXin params.
1234
- */
1235
- 'hanXin'?: HanXinParams;
1236
- static attributeTypeMap: Array<{
1237
- name: string;
1238
- baseName: string;
1239
- type: string;
1240
- }>;
1241
- static getAttributeTypeMap(): {
1242
- name: string;
1243
- baseName: string;
1244
- type: string;
1245
- }[];
1246
- }
1247
- /**
1248
- * Represents list of barcode generators
1249
- */
1250
- export declare class GeneratorParamsList {
1251
- /**
1252
- * List of barcode generators
1253
- */
1254
- 'barcodeBuilders'?: Array<GeneratorParams>;
1255
- /**
1256
- * Shift step according to X axis
1257
- */
1258
- 'xStep': number;
1259
- /**
1260
- * Shift step according to Y axis
1261
- */
1262
- 'yStep': number;
1263
- static attributeTypeMap: Array<{
1264
- name: string;
1265
- baseName: string;
1266
- type: string;
1267
- }>;
1268
- static getAttributeTypeMap(): {
1269
- name: string;
1270
- baseName: string;
1271
- type: string;
1272
- }[];
1273
- }
1274
- /**
1275
- *
1276
- */
1277
- export declare enum HanXinEncodeMode {
1278
- Auto = "Auto",
1279
- Binary = "Binary",
1280
- ECI = "ECI",
1281
- Unicode = "Unicode",
1282
- URI = "URI",
1283
- Extended = "Extended"
1284
- }
1285
- /**
1286
- *
1287
- */
1288
- export declare enum HanXinErrorLevel {
1289
- L1 = "L1",
1290
- L2 = "L2",
1291
- L3 = "L3",
1292
- L4 = "L4"
1293
- }
1294
- /**
1295
- * HanXin params.
1296
- */
1297
- export declare class HanXinParams {
1298
- /**
1299
- * Encoding mode for XanXin barcodes. Default value: HanXinEncodeMode.Auto.
1300
- */
1301
- 'encodeMode'?: HanXinEncodeMode;
1302
- /**
1303
- * Allowed Han Xin error correction levels from L1 to L4. Default value: HanXinErrorLevel.L1.
1304
- */
1305
- 'errorLevel'?: HanXinErrorLevel;
1306
- /**
1307
- * Allowed Han Xin versions, Auto and Version01 - Version84. Default value: HanXinVersion.Auto.
1308
- */
1309
- 'version'?: HanXinVersion;
1310
- /**
1311
- * Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings. Default value: ECIEncodings.ISO_8859_1
1312
- */
1313
- 'eCIEncoding'?: ECIEncodings;
1314
- static attributeTypeMap: Array<{
1315
- name: string;
1316
- baseName: string;
1317
- type: string;
1318
- }>;
1319
- static getAttributeTypeMap(): {
1320
- name: string;
1321
- baseName: string;
1322
- type: string;
1323
- }[];
1324
- }
1325
- /**
1326
- *
1327
- */
1328
- export declare enum HanXinVersion {
1329
- Auto = "Auto",
1330
- Version01 = "Version01",
1331
- Version02 = "Version02",
1332
- Version03 = "Version03",
1333
- Version04 = "Version04",
1334
- Version05 = "Version05",
1335
- Version06 = "Version06",
1336
- Version07 = "Version07",
1337
- Version08 = "Version08",
1338
- Version09 = "Version09",
1339
- Version10 = "Version10",
1340
- Version11 = "Version11",
1341
- Version12 = "Version12",
1342
- Version13 = "Version13",
1343
- Version14 = "Version14",
1344
- Version15 = "Version15",
1345
- Version16 = "Version16",
1346
- Version17 = "Version17",
1347
- Version18 = "Version18",
1348
- Version19 = "Version19",
1349
- Version20 = "Version20",
1350
- Version21 = "Version21",
1351
- Version22 = "Version22",
1352
- Version23 = "Version23",
1353
- Version24 = "Version24",
1354
- Version25 = "Version25",
1355
- Version26 = "Version26",
1356
- Version27 = "Version27",
1357
- Version28 = "Version28",
1358
- Version29 = "Version29",
1359
- Version30 = "Version30",
1360
- Version31 = "Version31",
1361
- Version32 = "Version32",
1362
- Version33 = "Version33",
1363
- Version34 = "Version34",
1364
- Version35 = "Version35",
1365
- Version36 = "Version36",
1366
- Version37 = "Version37",
1367
- Version38 = "Version38",
1368
- Version39 = "Version39",
1369
- Version40 = "Version40",
1370
- Version41 = "Version41",
1371
- Version42 = "Version42",
1372
- Version43 = "Version43",
1373
- Version44 = "Version44",
1374
- Version45 = "Version45",
1375
- Version46 = "Version46",
1376
- Version47 = "Version47",
1377
- Version48 = "Version48",
1378
- Version49 = "Version49",
1379
- Version50 = "Version50",
1380
- Version51 = "Version51",
1381
- Version52 = "Version52",
1382
- Version53 = "Version53",
1383
- Version54 = "Version54",
1384
- Version55 = "Version55",
1385
- Version56 = "Version56",
1386
- Version57 = "Version57",
1387
- Version58 = "Version58",
1388
- Version59 = "Version59",
1389
- Version60 = "Version60",
1390
- Version61 = "Version61",
1391
- Version62 = "Version62",
1392
- Version63 = "Version63",
1393
- Version64 = "Version64",
1394
- Version65 = "Version65",
1395
- Version66 = "Version66",
1396
- Version67 = "Version67",
1397
- Version68 = "Version68",
1398
- Version69 = "Version69",
1399
- Version70 = "Version70",
1400
- Version71 = "Version71",
1401
- Version72 = "Version72",
1402
- Version73 = "Version73",
1403
- Version74 = "Version74",
1404
- Version75 = "Version75",
1405
- Version76 = "Version76",
1406
- Version77 = "Version77",
1407
- Version78 = "Version78",
1408
- Version79 = "Version79",
1409
- Version80 = "Version80",
1410
- Version81 = "Version81",
1411
- Version82 = "Version82",
1412
- Version83 = "Version83",
1413
- Version84 = "Version84"
1414
- }
1415
- /**
1416
- *
1417
- */
1418
- export declare enum ITF14BorderType {
1419
- None = "None",
1420
- Frame = "Frame",
1421
- Bar = "Bar",
1422
- FrameOut = "FrameOut",
1423
- BarOut = "BarOut"
1424
- }
1425
- /**
1426
- * ITF parameters.
1427
- */
1428
- export declare class ITFParams {
1429
- /**
1430
- * ITF border (bearer bar) thickness in Unit value. Default value: 12pt.
1431
- */
1432
- 'borderThickness'?: number;
1433
- /**
1434
- * Border type of ITF barcode. Default value: ITF14BorderType.Bar.
1435
- */
1436
- 'borderType'?: ITF14BorderType;
1437
- /**
1438
- * Size of the quiet zones in xDimension. Default value: 10, meaning if xDimension = 2px than quiet zones will be 20px.
1439
- */
1440
- 'quietZoneCoef'?: number;
1441
- static attributeTypeMap: Array<{
1442
- name: string;
1443
- baseName: string;
1444
- type: string;
1445
- }>;
1446
- static getAttributeTypeMap(): {
1447
- name: string;
1448
- baseName: string;
1449
- type: string;
1450
- }[];
1451
- }
1452
- /**
1453
- *
1454
- */
1455
- export declare enum MacroCharacter {
1456
- None = "None",
1457
- Macro05 = "Macro05",
1458
- Macro06 = "Macro06"
1459
- }
1460
- /**
1461
- *
1462
- */
1463
- export declare enum MaxiCodeEncodeMode {
1464
- Auto = "Auto",
1465
- Bytes = "Bytes",
1466
- ExtendedCodetext = "ExtendedCodetext"
1467
- }
1468
- /**
1469
- *
1470
- */
1471
- export declare enum MaxiCodeMode {
1472
- Mode2 = "Mode2",
1473
- Mode3 = "Mode3",
1474
- Mode4 = "Mode4",
1475
- Mode5 = "Mode5",
1476
- Mode6 = "Mode6"
1477
- }
1478
- /**
1479
- * MaxiCode parameters.
1480
- */
1481
- export declare class MaxiCodeParams {
1482
- /**
1483
- * Height/Width ratio of 2D BarCode module.
1484
- */
1485
- 'aspectRatio'?: number;
1486
- /**
1487
- * Mode for MaxiCode barcodes.
1488
- */
1489
- 'mode'?: MaxiCodeMode;
1490
- /**
1491
- * Encoding mode for MaxiCode barcodes.
1492
- */
1493
- 'encodeMode'?: MaxiCodeEncodeMode;
1494
- static attributeTypeMap: Array<{
1495
- name: string;
1496
- baseName: string;
1497
- type: string;
1498
- }>;
1499
- static getAttributeTypeMap(): {
1500
- name: string;
1501
- baseName: string;
1502
- type: string;
1503
- }[];
1504
- }
1505
- /**
1506
- * Error
1507
- */
1508
- export declare class ModelError {
1509
- /**
1510
- * Code
1511
- */
1512
- 'code'?: string;
1513
- /**
1514
- * Message
1515
- */
1516
- 'message'?: string;
1517
- /**
1518
- * Description
1519
- */
1520
- 'description'?: string;
1521
- /**
1522
- * Inner Error
1523
- */
1524
- 'innerError'?: ErrorDetails;
1525
- static attributeTypeMap: Array<{
1526
- name: string;
1527
- baseName: string;
1528
- type: string;
1529
- }>;
1530
- static getAttributeTypeMap(): {
1531
- name: string;
1532
- baseName: string;
1533
- type: string;
1534
- }[];
1535
- }
1536
- /**
1537
- * Object exists
1538
- */
1539
- export declare class ObjectExist {
1540
- /**
1541
- * Indicates that the file or folder exists.
1542
- */
1543
- 'exists': boolean;
1544
- /**
1545
- * True if it is a folder, false if it is a file.
1546
- */
1547
- 'isFolder': boolean;
1548
- static attributeTypeMap: Array<{
1549
- name: string;
1550
- baseName: string;
1551
- type: string;
1552
- }>;
1553
- static getAttributeTypeMap(): {
1554
- name: string;
1555
- baseName: string;
1556
- type: string;
1557
- }[];
1558
- }
1559
- /**
1560
- * Padding around barcode.
1561
- */
1562
- export declare class Padding {
1563
- /**
1564
- * Left padding.
1565
- */
1566
- 'left'?: number;
1567
- /**
1568
- * Right padding.
1569
- */
1570
- 'right'?: number;
1571
- /**
1572
- * Top padding.
1573
- */
1574
- 'top'?: number;
1575
- /**
1576
- * Bottom padding.
1577
- */
1578
- 'bottom'?: number;
1579
- static attributeTypeMap: Array<{
1580
- name: string;
1581
- baseName: string;
1582
- type: string;
1583
- }>;
1584
- static getAttributeTypeMap(): {
1585
- name: string;
1586
- baseName: string;
1587
- type: string;
1588
- }[];
1589
- }
1590
- /**
1591
- * PatchCode parameters.
1592
- */
1593
- export declare class PatchCodeParams {
1594
- /**
1595
- * Specifies codetext for an extra QR barcode, when PatchCode is generated in page mode.
1596
- */
1597
- 'extraBarcodeText'?: string;
1598
- /**
1599
- * PatchCode format. Choose PatchOnly to generate single PatchCode. Use page format to generate Patch page with PatchCodes as borders. Default value: PatchFormat.PatchOnly
1600
- */
1601
- 'patchFormat'?: PatchFormat;
1602
- static attributeTypeMap: Array<{
1603
- name: string;
1604
- baseName: string;
1605
- type: string;
1606
- }>;
1607
- static getAttributeTypeMap(): {
1608
- name: string;
1609
- baseName: string;
1610
- type: string;
1611
- }[];
1612
- }
1613
- /**
1614
- *
1615
- */
1616
- export declare enum PatchFormat {
1617
- PatchOnly = "PatchOnly",
1618
- A4 = "A4",
1619
- A4LANDSCAPE = "A4_LANDSCAPE",
1620
- USLetter = "US_Letter",
1621
- USLetterLANDSCAPE = "US_Letter_LANDSCAPE"
1622
- }
1623
- /**
1624
- *
1625
- */
1626
- export declare enum Pdf417CompactionMode {
1627
- Auto = "Auto",
1628
- Text = "Text",
1629
- Numeric = "Numeric",
1630
- Binary = "Binary"
1631
- }
1632
- /**
1633
- *
1634
- */
1635
- export declare enum Pdf417ErrorLevel {
1636
- Level0 = "Level0",
1637
- Level1 = "Level1",
1638
- Level2 = "Level2",
1639
- Level3 = "Level3",
1640
- Level4 = "Level4",
1641
- Level5 = "Level5",
1642
- Level6 = "Level6",
1643
- Level7 = "Level7",
1644
- Level8 = "Level8"
1645
- }
1646
- /**
1647
- *
1648
- */
1649
- export declare enum Pdf417MacroTerminator {
1650
- Auto = "Auto",
1651
- None = "None",
1652
- Set = "Set"
1653
- }
1654
- /**
1655
- * PDF417 parameters.
1656
- */
1657
- export declare class Pdf417Params {
1658
- /**
1659
- * Height/Width ratio of 2D BarCode module.
1660
- */
1661
- 'aspectRatio'?: number;
1662
- /**
1663
- * @deprecated This property is obsolete and will be removed in future releases. Unicode symbols detection and encoding will be processed in Auto mode with Extended Channel Interpretation charset designator. Using of own encodings requires manual CodeText encoding into byte[] array. Sets the encoding of codetext.
1664
- */
1665
- 'textEncoding'?: string;
1666
- /**
1667
- * Columns count.
1668
- */
1669
- 'columns'?: number;
1670
- /**
1671
- * Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.Auto.
1672
- */
1673
- 'compactionMode'?: Pdf417CompactionMode;
1674
- /**
1675
- * Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
1676
- */
1677
- 'errorLevel'?: Pdf417ErrorLevel;
1678
- /**
1679
- * Macro Pdf417 barcode's file ID. Used for MacroPdf417.
1680
- */
1681
- 'macroFileID'?: number;
1682
- /**
1683
- * Macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.
1684
- */
1685
- 'macroSegmentID'?: number;
1686
- /**
1687
- * Macro Pdf417 barcode segments count.
1688
- */
1689
- 'macroSegmentsCount'?: number;
1690
- /**
1691
- * Rows count.
1692
- */
1693
- 'rows'?: number;
1694
- /**
1695
- * Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
1696
- */
1697
- 'truncate'?: boolean;
1698
- /**
1699
- * Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings.
1700
- */
1701
- 'pdf417ECIEncoding'?: ECIEncodings;
1702
- /**
1703
- * Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization
1704
- */
1705
- 'isReaderInitialization'?: boolean;
1706
- /**
1707
- * Macro Pdf417 barcode time stamp
1708
- */
1709
- 'macroTimeStamp'?: Date;
1710
- /**
1711
- * Macro Pdf417 barcode sender name
1712
- */
1713
- 'macroSender'?: string;
1714
- /**
1715
- * Macro Pdf417 file size. The file size field contains the size in bytes of the entire source file
1716
- */
1717
- 'macroFileSize'?: number;
1718
- /**
1719
- * Macro Pdf417 barcode checksum. The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial
1720
- */
1721
- 'macroChecksum'?: number;
1722
- /**
1723
- * Macro Pdf417 barcode file name
1724
- */
1725
- 'macroFileName'?: string;
1726
- /**
1727
- * Macro Pdf417 barcode addressee name
1728
- */
1729
- 'macroAddressee'?: string;
1730
- /**
1731
- * Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
1732
- */
1733
- 'macroECIEncoding'?: ECIEncodings;
1734
- /**
1735
- * @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.
1736
- */
1737
- 'code128Emulation'?: Code128Emulation;
1738
- /**
1739
- * 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.
1740
- */
1741
- 'isCode128Emulation'?: boolean;
1742
- /**
1743
- * Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
1744
- */
1745
- 'pdf417MacroTerminator'?: Pdf417MacroTerminator;
1746
- /**
1747
- * 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.
1748
- */
1749
- 'isLinked'?: boolean;
1750
- /**
1751
- * 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.
1752
- */
1753
- 'macroCharacters'?: MacroCharacter;
1754
- static attributeTypeMap: Array<{
1755
- name: string;
1756
- baseName: string;
1757
- type: string;
1758
- }>;
1759
- static getAttributeTypeMap(): {
1760
- name: string;
1761
- baseName: string;
1762
- type: string;
1763
- }[];
1764
- }
1765
- /**
1766
- * Postal parameters. Used for Postnet, Planet.
1767
- */
1768
- export declare class PostalParams {
1769
- /**
1770
- * Short bar's height of Postal barcodes.
1771
- */
1772
- 'shortBarHeight'?: number;
1773
- static attributeTypeMap: Array<{
1774
- name: string;
1775
- baseName: string;
1776
- type: string;
1777
- }>;
1778
- static getAttributeTypeMap(): {
1779
- name: string;
1780
- baseName: string;
1781
- type: string;
1782
- }[];
1783
- }
1784
- /**
1785
- * See QualitySettings allows to configure recognition quality and speed manually.
1786
- */
1787
- export declare enum PresetType {
1788
- HighPerformance = "HighPerformance",
1789
- NormalQuality = "NormalQuality",
1790
- HighQualityDetection = "HighQualityDetection",
1791
- MaxQualityDetection = "MaxQualityDetection",
1792
- HighQuality = "HighQuality",
1793
- MaxBarCodes = "MaxBarCodes"
1794
- }
1795
- /**
1796
- *
1797
- */
1798
- export declare enum QREncodeMode {
1799
- Auto = "Auto",
1800
- Bytes = "Bytes",
1801
- Utf8BOM = "Utf8BOM",
1802
- Utf16BEBOM = "Utf16BEBOM",
1803
- ECIEncoding = "ECIEncoding",
1804
- ExtendedCodetext = "ExtendedCodetext"
1805
- }
1806
- /**
1807
- *
1808
- */
1809
- export declare enum QREncodeType {
1810
- Auto = "Auto",
1811
- ForceQR = "ForceQR",
1812
- ForceMicroQR = "ForceMicroQR"
1813
- }
1814
- /**
1815
- *
1816
- */
1817
- export declare enum QRErrorLevel {
1818
- LevelL = "LevelL",
1819
- LevelM = "LevelM",
1820
- LevelQ = "LevelQ",
1821
- LevelH = "LevelH"
1822
- }
1823
- /**
1824
- *
1825
- */
1826
- export declare enum QRVersion {
1827
- Auto = "Auto",
1828
- Version01 = "Version01",
1829
- Version02 = "Version02",
1830
- Version03 = "Version03",
1831
- Version04 = "Version04",
1832
- Version05 = "Version05",
1833
- Version06 = "Version06",
1834
- Version07 = "Version07",
1835
- Version08 = "Version08",
1836
- Version09 = "Version09",
1837
- Version10 = "Version10",
1838
- Version11 = "Version11",
1839
- Version12 = "Version12",
1840
- Version13 = "Version13",
1841
- Version14 = "Version14",
1842
- Version15 = "Version15",
1843
- Version16 = "Version16",
1844
- Version17 = "Version17",
1845
- Version18 = "Version18",
1846
- Version19 = "Version19",
1847
- Version20 = "Version20",
1848
- Version21 = "Version21",
1849
- Version22 = "Version22",
1850
- Version23 = "Version23",
1851
- Version24 = "Version24",
1852
- Version25 = "Version25",
1853
- Version26 = "Version26",
1854
- Version27 = "Version27",
1855
- Version28 = "Version28",
1856
- Version29 = "Version29",
1857
- Version30 = "Version30",
1858
- Version31 = "Version31",
1859
- Version32 = "Version32",
1860
- Version33 = "Version33",
1861
- Version34 = "Version34",
1862
- Version35 = "Version35",
1863
- Version36 = "Version36",
1864
- Version37 = "Version37",
1865
- Version38 = "Version38",
1866
- Version39 = "Version39",
1867
- Version40 = "Version40",
1868
- VersionM1 = "VersionM1",
1869
- VersionM2 = "VersionM2",
1870
- VersionM3 = "VersionM3",
1871
- VersionM4 = "VersionM4"
1872
- }
1873
- /**
1874
- * QR parameters.
1875
- */
1876
- export declare class QrParams {
1877
- /**
1878
- * Height/Width ratio of 2D BarCode module.
1879
- */
1880
- 'aspectRatio'?: number;
1881
- /**
1882
- * @deprecated This property is obsolete and will be removed in future releases. Unicode symbols detection and encoding will be processed in Auto mode with Extended Channel Interpretation charset designator. Using of own encodings requires manual CodeText encoding into byte[] array. Sets the encoding of codetext.
1883
- */
1884
- 'textEncoding'?: string;
1885
- /**
1886
- * QR / MicroQR selector mode. Select ForceQR for standard QR symbols, Auto for MicroQR.
1887
- */
1888
- 'encodeType'?: QREncodeType;
1889
- /**
1890
- * Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings.
1891
- */
1892
- 'eCIEncoding'?: ECIEncodings;
1893
- /**
1894
- * QR symbology type of BarCode's encoding mode. Default value: QREncodeMode.Auto.
1895
- */
1896
- 'encodeMode'?: QREncodeMode;
1897
- /**
1898
- * Level of Reed-Solomon error correction for QR barcode. From low to high: LevelL, LevelM, LevelQ, LevelH. see QRErrorLevel.
1899
- */
1900
- 'errorLevel'?: QRErrorLevel;
1901
- /**
1902
- * Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.Auto.
1903
- */
1904
- 'version'?: QRVersion;
1905
- /**
1906
- * QR structured append parameters.
1907
- */
1908
- 'structuredAppend'?: StructuredAppend;
1909
- static attributeTypeMap: Array<{
1910
- name: string;
1911
- baseName: string;
1912
- type: string;
1913
- }>;
1914
- static getAttributeTypeMap(): {
1915
- name: string;
1916
- baseName: string;
1917
- type: string;
1918
- }[];
1919
- }
1920
- /**
1921
- * Represents BarcodeReader object.
1922
- */
1923
- export declare class ReaderParams {
1924
- /**
1925
- * The type of barcode to read.
1926
- */
1927
- 'type'?: DecodeBarcodeType;
1928
- /**
1929
- * Multiple barcode types to read.
1930
- */
1931
- 'types'?: Array<DecodeBarcodeType>;
1932
- /**
1933
- * 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
1934
- */
1935
- 'checksumValidation'?: ChecksumValidation;
1936
- /**
1937
- * A flag which force engine to detect codetext encoding for Unicode.
1938
- */
1939
- 'detectEncoding'?: boolean;
1940
- /**
1941
- * 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.
1942
- */
1943
- 'preset'?: PresetType;
1944
- /**
1945
- * Set X of top left corner of area for recognition.
1946
- */
1947
- 'rectX'?: number;
1948
- /**
1949
- * Set Y of top left corner of area for recognition.
1950
- */
1951
- 'rectY'?: number;
1952
- /**
1953
- * Set Width of area for recognition.
1954
- */
1955
- 'rectWidth'?: number;
1956
- /**
1957
- * Set Height of area for recognition.
1958
- */
1959
- 'rectHeight'?: number;
1960
- /**
1961
- * Value indicating whether FNC symbol strip must be done.
1962
- */
1963
- 'stripFNC'?: boolean;
1964
- /**
1965
- * 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.
1966
- */
1967
- 'timeout'?: number;
1968
- /**
1969
- * Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.
1970
- */
1971
- 'medianSmoothingWindowSize'?: number;
1972
- /**
1973
- * Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
1974
- */
1975
- 'allowMedianSmoothing'?: boolean;
1976
- /**
1977
- * Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
1978
- */
1979
- 'allowComplexBackground'?: boolean;
1980
- /**
1981
- * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots.
1982
- */
1983
- 'allowDatamatrixIndustrialBarcodes'?: boolean;
1984
- /**
1985
- * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
1986
- */
1987
- 'allowDecreasedImage'?: boolean;
1988
- /**
1989
- * Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
1990
- */
1991
- 'allowDetectScanGap'?: boolean;
1992
- /**
1993
- * Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text.
1994
- */
1995
- 'allowIncorrectBarcodes'?: boolean;
1996
- /**
1997
- * Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.
1998
- */
1999
- 'allowInvertImage'?: boolean;
2000
- /**
2001
- * Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.
2002
- */
2003
- 'allowMicroWhiteSpotsRemoving'?: boolean;
2004
- /**
2005
- * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet.
2006
- */
2007
- 'allowOneDFastBarcodesDetector'?: boolean;
2008
- /**
2009
- * Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.
2010
- */
2011
- 'allowOneDWipedBarsRestoration'?: boolean;
2012
- /**
2013
- * Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
2014
- */
2015
- 'allowQRMicroQrRestoration'?: boolean;
2016
- /**
2017
- * Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.
2018
- */
2019
- 'allowRegularImage'?: boolean;
2020
- /**
2021
- * Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.
2022
- */
2023
- 'allowSaltAndPepperFiltering'?: boolean;
2024
- /**
2025
- * Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.
2026
- */
2027
- 'allowWhiteSpotsRemoving'?: boolean;
2028
- /**
2029
- * Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
2030
- */
2031
- 'checkMore1DVariants'?: boolean;
2032
- /**
2033
- * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False.
2034
- */
2035
- 'fastScanOnly'?: boolean;
2036
- /**
2037
- * Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type. Default value: False.
2038
- */
2039
- 'allowAdditionalRestorations'?: boolean;
2040
- /**
2041
- * Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time.
2042
- */
2043
- 'regionLikelihoodThresholdPercent'?: number;
2044
- /**
2045
- * Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality.
2046
- */
2047
- 'scanWindowSizes'?: Array<number>;
2048
- /**
2049
- * Similarity coefficient depends on how homogeneous barcodes are. Use high value for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9]
2050
- */
2051
- 'similarity'?: number;
2052
- /**
2053
- * Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time.
2054
- */
2055
- 'skipDiagonalSearch'?: boolean;
2056
- /**
2057
- * Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.
2058
- */
2059
- 'readTinyBarcodes'?: boolean;
2060
- /**
2061
- * Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
2062
- */
2063
- 'australianPostEncodingTable'?: CustomerInformationInterpretingType;
2064
- /**
2065
- * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence \"333\" of filling patterns is decoded as letter \"z\".
2066
- */
2067
- 'ignoreEndingFillingPatternsForCTable'?: boolean;
2068
- static attributeTypeMap: Array<{
2069
- name: string;
2070
- baseName: string;
2071
- type: string;
2072
- }>;
2073
- static getAttributeTypeMap(): {
2074
- name: string;
2075
- baseName: string;
2076
- type: string;
2077
- }[];
2078
- }
2079
- /**
2080
- * Wrapper around Drawing.Point for proper specification.
2081
- */
2082
- export declare class RegionPoint {
2083
- /**
2084
- * X-coordinate
2085
- */
2086
- 'X': number;
2087
- /**
2088
- * Y-coordinate
2089
- */
2090
- 'Y': number;
2091
- static attributeTypeMap: Array<{
2092
- name: string;
2093
- baseName: string;
2094
- type: string;
2095
- }>;
2096
- static getAttributeTypeMap(): {
2097
- name: string;
2098
- baseName: string;
2099
- type: string;
2100
- }[];
2101
- }
2102
- /**
2103
- * Created image info.
2104
- */
2105
- export declare class ResultImageInfo {
2106
- /**
2107
- * Result file size.
2108
- */
2109
- 'fileSize': number;
2110
- /**
2111
- * Result image width.
2112
- */
2113
- 'imageWidth'?: number;
2114
- /**
2115
- * Result image height.
2116
- */
2117
- 'imageHeight'?: number;
2118
- static attributeTypeMap: Array<{
2119
- name: string;
2120
- baseName: string;
2121
- type: string;
2122
- }>;
2123
- static getAttributeTypeMap(): {
2124
- name: string;
2125
- baseName: string;
2126
- type: string;
2127
- }[];
2128
- }
2129
- /**
2130
- * Storage exists
2131
- */
2132
- export declare class StorageExist {
2133
- /**
2134
- * Shows that the storage exists.
2135
- */
2136
- 'exists': boolean;
2137
- static attributeTypeMap: Array<{
2138
- name: string;
2139
- baseName: string;
2140
- type: string;
2141
- }>;
2142
- static getAttributeTypeMap(): {
2143
- name: string;
2144
- baseName: string;
2145
- type: string;
2146
- }[];
2147
- }
2148
- /**
2149
- * File or folder information
2150
- */
2151
- export declare class StorageFile {
2152
- /**
2153
- * File or folder name.
2154
- */
2155
- 'name'?: string;
2156
- /**
2157
- * True if it is a folder.
2158
- */
2159
- 'isFolder': boolean;
2160
- /**
2161
- * File or folder last modified DateTime.
2162
- */
2163
- 'modifiedDate'?: Date;
2164
- /**
2165
- * File or folder size.
2166
- */
2167
- 'size': number;
2168
- /**
2169
- * File or folder path.
2170
- */
2171
- 'path'?: string;
2172
- static attributeTypeMap: Array<{
2173
- name: string;
2174
- baseName: string;
2175
- type: string;
2176
- }>;
2177
- static getAttributeTypeMap(): {
2178
- name: string;
2179
- baseName: string;
2180
- type: string;
2181
- }[];
2182
- }
2183
- /**
2184
- * QR structured append parameters.
2185
- */
2186
- export declare class StructuredAppend {
2187
- /**
2188
- * The index of the QR structured append mode barcode. Index starts from 0.
2189
- */
2190
- 'sequenceIndicator'?: number;
2191
- /**
2192
- * QR structured append mode barcodes quantity. Max value is 16.
2193
- */
2194
- 'totalCount'?: number;
2195
- /**
2196
- * QR structured append mode parity data.
2197
- */
2198
- 'parityByte'?: number;
2199
- static attributeTypeMap: Array<{
2200
- name: string;
2201
- baseName: string;
2202
- type: string;
2203
- }>;
2204
- static getAttributeTypeMap(): {
2205
- name: string;
2206
- baseName: string;
2207
- type: string;
2208
- }[];
2209
- }
2210
- /**
2211
- *
2212
- */
2213
- export declare enum TextAlignment {
2214
- Left = "Left",
2215
- Center = "Center",
2216
- Right = "Right"
2217
- }
2218
- export declare class FileVersion {
2219
- /**
2220
- * File or folder name.
2221
- */
2222
- 'name'?: string;
2223
- /**
2224
- * True if it is a folder.
2225
- */
2226
- 'isFolder': boolean;
2227
- /**
2228
- * File or folder last modified DateTime.
2229
- */
2230
- 'modifiedDate'?: Date;
2231
- /**
2232
- * File or folder size.
2233
- */
2234
- 'size': number;
2235
- /**
2236
- * File or folder path.
2237
- */
2238
- 'path'?: string;
2239
- /**
2240
- * File Version ID.
2241
- */
2242
- 'versionId'?: string;
2243
- /**
2244
- * Specifies whether the file is (true) or is not (false) the latest version of an file.
2245
- */
2246
- 'isLatest': boolean;
2247
- static attributeTypeMap: Array<{
2248
- name: string;
2249
- baseName: string;
2250
- type: string;
2251
- }>;
2252
- static getAttributeTypeMap(): {
2253
- name: string;
2254
- baseName: string;
2255
- type: string;
2256
- }[];
2257
- }
2258
- /**
2259
- * Generate barcode.
2260
- */
2261
- export declare class GetBarcodeGenerateRequest {
2262
- /**
2263
- * Type of barcode to generate.
2264
- */
2265
- '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';
2266
- /**
2267
- * Text to encode.
2268
- */
2269
- 'text': string;
2270
- /**
2271
- * Text that will be displayed instead of codetext in 2D barcodes.
2272
- Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
2273
- */
2274
- 'twoDDisplayText'?: string;
2275
- /**
2276
- * Specify the displaying Text Location, set to CodeLocation.None to hide CodeText.
2277
- Default value: CodeLocation.Below.
2278
- */
2279
- 'textLocation'?: 'Below' | 'Above' | 'None';
2280
- /**
2281
- * Text alignment.
2282
- */
2283
- 'textAlignment'?: 'Left' | 'Center' | 'Right';
2284
- /**
2285
- * Specify the displaying CodeText's Color.
2286
- Default value: black.
2287
- Use named colors like: red, green, blue
2288
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2289
- */
2290
- 'textColor'?: string;
2291
- /**
2292
- * Specify word wraps (line breaks) within text.
2293
- Default value: false.
2294
- */
2295
- 'noWrap'?: boolean;
2296
- /**
2297
- * Resolution of the BarCode image.
2298
- One value for both dimensions.
2299
- Default value: 96 dpi.
2300
- */
2301
- 'resolution'?: number;
2302
- /**
2303
- * @deprecated Use 'Resolution' instead.
2304
- */
2305
- 'resolutionX'?: number;
2306
- /**
2307
- * @deprecated Use 'Resolution' instead.
2308
- */
2309
- 'resolutionY'?: number;
2310
- /**
2311
- * The smallest width of the unit of BarCode bars or spaces.
2312
- Increase this will increase the whole barcode image width.
2313
- Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
2314
- */
2315
- 'dimensionX'?: number;
2316
- /**
2317
- * Space between the CodeText and the BarCode in Unit value.
2318
- Default value: 2pt.
2319
- Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
2320
- */
2321
- 'textSpace'?: number;
2322
- /**
2323
- * Common Units for all measuring in query. Default units: pixel.
2324
- */
2325
- 'units'?: 'Pixel' | 'Point' | 'Inch' | 'Millimeter';
2326
- /**
2327
- * Specifies the different types of automatic sizing modes.
2328
- Default value: AutoSizeMode.None.
2329
- */
2330
- 'sizeMode'?: 'None' | 'Nearest' | 'Interpolation';
2331
- /**
2332
- * Height of the barcode in given units. Default units: pixel.
2333
- */
2334
- 'barHeight'?: number;
2335
- /**
2336
- * Height of the barcode image in given units. Default units: pixel.
2337
- */
2338
- 'imageHeight'?: number;
2339
- /**
2340
- * Width of the barcode image in given units. Default units: pixel.
2341
- */
2342
- 'imageWidth'?: number;
2343
- /**
2344
- * BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation.
2345
- If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image.
2346
- Default value: 0.
2347
- */
2348
- 'rotationAngle'?: number;
2349
- /**
2350
- * Background color of the barcode image.
2351
- Default value: white.
2352
- Use named colors like: red, green, blue
2353
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2354
- */
2355
- 'backColor'?: string;
2356
- /**
2357
- * Bars color.
2358
- Default value: black.
2359
- Use named colors like: red, green, blue
2360
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2361
- */
2362
- 'barColor'?: string;
2363
- /**
2364
- * Border color.
2365
- Default value: black.
2366
- Use named colors like: red, green, blue
2367
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2368
- */
2369
- 'borderColor'?: string;
2370
- /**
2371
- * Border width.
2372
- Default value: 0.
2373
- Ignored if Visible is set to false.
2374
- */
2375
- 'borderWidth'?: number;
2376
- /**
2377
- * Border dash style.
2378
- Default value: BorderDashStyle.Solid.
2379
- */
2380
- 'borderDashStyle'?: 'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot';
2381
- /**
2382
- * Border visibility. If false than parameter Width is always ignored (0).
2383
- Default value: false.
2384
- */
2385
- 'borderVisible'?: boolean;
2386
- /**
2387
- * Enable checksum during generation 1D barcodes.
2388
- Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible.
2389
- Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar
2390
- Checksum always used: Rest symbology
2391
- */
2392
- 'enableChecksum'?: 'Default' | 'Yes' | 'No';
2393
- /**
2394
- * Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only
2395
- If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters.
2396
- Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.
2397
- */
2398
- 'enableEscape'?: boolean;
2399
- /**
2400
- * Value indicating whether bars are filled.
2401
- Only for 1D barcodes.
2402
- Default value: true.
2403
- */
2404
- 'filledBars'?: boolean;
2405
- /**
2406
- * Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
2407
- */
2408
- 'alwaysShowChecksum'?: boolean;
2409
- /**
2410
- * Wide bars to Narrow bars ratio.
2411
- Default value: 3, that is, wide bars are 3 times as wide as narrow bars.
2412
- Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
2413
- */
2414
- 'wideNarrowRatio'?: number;
2415
- /**
2416
- * Only for 1D barcodes.
2417
- If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification.
2418
- Exception always will be thrown for: Databar symbology if codetext is incorrect.
2419
- Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
2420
- */
2421
- 'validateText'?: boolean;
2422
- /**
2423
- * Supplement parameters.
2424
- Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
2425
- */
2426
- 'supplementData'?: string;
2427
- /**
2428
- * Space between main the BarCode and supplement BarCode.
2429
- */
2430
- 'supplementSpace'?: number;
2431
- /**
2432
- * Bars reduction value that is used to compensate ink spread while printing.
2433
- */
2434
- 'barWidthReduction'?: number;
2435
- /**
2436
- * Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing.
2437
- */
2438
- 'useAntiAlias'?: boolean;
2439
- /**
2440
- * Result image format.
2441
- */
2442
- 'format'?: string;
2443
- /**
2444
- * @param type Type of barcode to generate.
2445
-
2446
- * @param text Text to encode.
2447
- */
2448
- constructor(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);
2449
- }
2450
- /**
2451
- * Recognize barcode from a file on server.
2452
- */
2453
- export declare class GetBarcodeRecognizeRequest {
2454
- /**
2455
- * The image file name.
2456
- */
2457
- 'name': string;
2458
- /**
2459
- * The type of barcode to read.
2460
- */
2461
- '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' | 'mostCommonlyUsed';
2462
- /**
2463
- * Multiple barcode types to read.
2464
- */
2465
- 'types'?: Array<DecodeBarcodeType>;
2466
- /**
2467
- * Enable checksum validation during recognition for 1D barcodes.
2468
- Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
2469
- Checksum never used: Codabar
2470
- Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
2471
- Checksum always used: Rest symbologies
2472
- */
2473
- 'checksumValidation'?: 'Default' | 'On' | 'Off';
2474
- /**
2475
- * A flag which force engine to detect codetext encoding for Unicode.
2476
- */
2477
- 'detectEncoding'?: boolean;
2478
- /**
2479
- * Preset allows to configure recognition quality and speed manually.
2480
- You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality,
2481
- HighQuality, MaxBarCodes or you can manually configure separate options.
2482
- Default value of Preset is NormalQuality.
2483
- */
2484
- 'preset'?: 'HighPerformance' | 'NormalQuality' | 'HighQualityDetection' | 'MaxQualityDetection' | 'HighQuality' | 'MaxBarCodes';
2485
- /**
2486
- * Set X of top left corner of area for recognition.
2487
- */
2488
- 'rectX'?: number;
2489
- /**
2490
- * Set Y of top left corner of area for recognition.
2491
- */
2492
- 'rectY'?: number;
2493
- /**
2494
- * Set Width of area for recognition.
2495
- */
2496
- 'rectWidth'?: number;
2497
- /**
2498
- * Set Height of area for recognition.
2499
- */
2500
- 'rectHeight'?: number;
2501
- /**
2502
- * Value indicating whether FNC symbol strip must be done.
2503
- */
2504
- 'stripFNC'?: boolean;
2505
- /**
2506
- * Timeout of recognition process in milliseconds.
2507
- Default value is 15_000 (15 seconds).
2508
- Maximum value is 30_000 (1/2 minute).
2509
- In case of a timeout RequestTimeout (408) status will be returned.
2510
- Try reducing the image size to avoid timeout.
2511
- */
2512
- 'timeout'?: number;
2513
- /**
2514
- * Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.
2515
- */
2516
- 'medianSmoothingWindowSize'?: number;
2517
- /**
2518
- * Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
2519
- */
2520
- 'allowMedianSmoothing'?: boolean;
2521
- /**
2522
- * Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
2523
- */
2524
- 'allowComplexBackground'?: boolean;
2525
- /**
2526
- * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes.
2527
- Slow mode which helps only for dashed barcodes which consist from spots.
2528
- */
2529
- 'allowDatamatrixIndustrialBarcodes'?: boolean;
2530
- /**
2531
- * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms.
2532
- Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
2533
- */
2534
- 'allowDecreasedImage'?: boolean;
2535
- /**
2536
- * Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
2537
- */
2538
- 'allowDetectScanGap'?: boolean;
2539
- /**
2540
- * Allows engine to recognize barcodes which has incorrect checksum or incorrect values.
2541
- Mode can be used to recognize damaged barcodes with incorrect text.
2542
- */
2543
- 'allowIncorrectBarcodes'?: boolean;
2544
- /**
2545
- * Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.
2546
- */
2547
- 'allowInvertImage'?: boolean;
2548
- /**
2549
- * Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.
2550
- */
2551
- 'allowMicroWhiteSpotsRemoving'?: boolean;
2552
- /**
2553
- * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image.
2554
- Mode helps to quickly recognize generated barcodes from Internet.
2555
- */
2556
- 'allowOneDFastBarcodesDetector'?: boolean;
2557
- /**
2558
- * Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.
2559
- */
2560
- 'allowOneDWipedBarsRestoration'?: boolean;
2561
- /**
2562
- * Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
2563
- */
2564
- 'allowQRMicroQrRestoration'?: boolean;
2565
- /**
2566
- * Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.
2567
- */
2568
- 'allowRegularImage'?: boolean;
2569
- /**
2570
- * Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.
2571
- */
2572
- 'allowSaltAndPepperFiltering'?: boolean;
2573
- /**
2574
- * Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.
2575
- */
2576
- 'allowWhiteSpotsRemoving'?: boolean;
2577
- /**
2578
- * Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
2579
- */
2580
- 'checkMore1DVariants'?: boolean;
2581
- /**
2582
- * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms.
2583
- Default value: False.
2584
- */
2585
- 'fastScanOnly'?: boolean;
2586
- /**
2587
- * Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type.
2588
- Default value: False.
2589
- */
2590
- 'allowAdditionalRestorations'?: boolean;
2591
- /**
2592
- * Sets threshold for detected regions that may contain barcodes.
2593
- Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further.
2594
- Region likelihood threshold must be between [0.05, 0.9]
2595
- Use high values for clear images with few barcodes.
2596
- Use low values for images with many barcodes or for noisy images.
2597
- Low value may lead to a bigger recognition time.
2598
- */
2599
- 'regionLikelihoodThresholdPercent'?: number;
2600
- /**
2601
- * Scan window sizes in pixels.
2602
- Allowed sizes are 10, 15, 20, 25, 30.
2603
- Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes.
2604
- Combining of several window sizes can improve detection quality.
2605
- */
2606
- 'scanWindowSizes'?: Array<number>;
2607
- /**
2608
- * Similarity coefficient depends on how homogeneous barcodes are.
2609
- Use high value for clear barcodes.
2610
- Use low values to detect barcodes that ara partly damaged or not lighten evenly.
2611
- Similarity coefficient must be between [0.5, 0.9]
2612
- */
2613
- 'similarity'?: number;
2614
- /**
2615
- * Allows detector to skip search for diagonal barcodes.
2616
- Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise.
2617
- Enabling of diagonal search leads to a bigger detection time.
2618
- */
2619
- 'skipDiagonalSearch'?: boolean;
2620
- /**
2621
- * Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.
2622
- */
2623
- 'readTinyBarcodes'?: boolean;
2624
- /**
2625
- * Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
2626
- */
2627
- 'australianPostEncodingTable'?: 'CTable' | 'NTable' | 'Other';
2628
- /**
2629
- * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method.
2630
- CTable encoding method does not have any gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z".
2631
- */
2632
- 'ignoreEndingFillingPatternsForCTable'?: boolean;
2633
- /**
2634
- * The image storage.
2635
- */
2636
- 'storage'?: string;
2637
- /**
2638
- * The image folder.
2639
- */
2640
- 'folder'?: string;
2641
- /**
2642
- * @param name The image file name.
2643
- */
2644
- constructor(name: string);
2645
- }
2646
- /**
2647
- * Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
2648
- */
2649
- export declare class PostBarcodeRecognizeFromUrlOrContentRequest {
2650
- /**
2651
- * The type of barcode to read.
2652
- */
2653
- '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' | 'mostCommonlyUsed';
2654
- /**
2655
- * Multiple barcode types to read.
2656
- */
2657
- 'types'?: Array<DecodeBarcodeType>;
2658
- /**
2659
- * Enable checksum validation during recognition for 1D barcodes.
2660
- Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible.
2661
- Checksum never used: Codabar
2662
- Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN
2663
- Checksum always used: Rest symbologies
2664
- */
2665
- 'checksumValidation'?: 'Default' | 'On' | 'Off';
2666
- /**
2667
- * A flag which force engine to detect codetext encoding for Unicode.
2668
- */
2669
- 'detectEncoding'?: boolean;
2670
- /**
2671
- * Preset allows to configure recognition quality and speed manually.
2672
- You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality,
2673
- HighQuality, MaxBarCodes or you can manually configure separate options.
2674
- Default value of Preset is NormalQuality.
2675
- */
2676
- 'preset'?: 'HighPerformance' | 'NormalQuality' | 'HighQualityDetection' | 'MaxQualityDetection' | 'HighQuality' | 'MaxBarCodes';
2677
- /**
2678
- * Set X of top left corner of area for recognition.
2679
- */
2680
- 'rectX'?: number;
2681
- /**
2682
- * Set Y of top left corner of area for recognition.
2683
- */
2684
- 'rectY'?: number;
2685
- /**
2686
- * Set Width of area for recognition.
2687
- */
2688
- 'rectWidth'?: number;
2689
- /**
2690
- * Set Height of area for recognition.
2691
- */
2692
- 'rectHeight'?: number;
2693
- /**
2694
- * Value indicating whether FNC symbol strip must be done.
2695
- */
2696
- 'stripFNC'?: boolean;
2697
- /**
2698
- * Timeout of recognition process in milliseconds.
2699
- Default value is 15_000 (15 seconds).
2700
- Maximum value is 30_000 (1/2 minute).
2701
- In case of a timeout RequestTimeout (408) status will be returned.
2702
- Try reducing the image size to avoid timeout.
2703
- */
2704
- 'timeout'?: number;
2705
- /**
2706
- * Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.
2707
- */
2708
- 'medianSmoothingWindowSize'?: number;
2709
- /**
2710
- * Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
2711
- */
2712
- 'allowMedianSmoothing'?: boolean;
2713
- /**
2714
- * Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
2715
- */
2716
- 'allowComplexBackground'?: boolean;
2717
- /**
2718
- * Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes.
2719
- Slow mode which helps only for dashed barcodes which consist from spots.
2720
- */
2721
- 'allowDatamatrixIndustrialBarcodes'?: boolean;
2722
- /**
2723
- * Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms.
2724
- Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
2725
- */
2726
- 'allowDecreasedImage'?: boolean;
2727
- /**
2728
- * Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
2729
- */
2730
- 'allowDetectScanGap'?: boolean;
2731
- /**
2732
- * Allows engine to recognize barcodes which has incorrect checksum or incorrect values.
2733
- Mode can be used to recognize damaged barcodes with incorrect text.
2734
- */
2735
- 'allowIncorrectBarcodes'?: boolean;
2736
- /**
2737
- * Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.
2738
- */
2739
- 'allowInvertImage'?: boolean;
2740
- /**
2741
- * Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.
2742
- */
2743
- 'allowMicroWhiteSpotsRemoving'?: boolean;
2744
- /**
2745
- * Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image.
2746
- Mode helps to quickly recognize generated barcodes from Internet.
2747
- */
2748
- 'allowOneDFastBarcodesDetector'?: boolean;
2749
- /**
2750
- * Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.
2751
- */
2752
- 'allowOneDWipedBarsRestoration'?: boolean;
2753
- /**
2754
- * Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
2755
- */
2756
- 'allowQRMicroQrRestoration'?: boolean;
2757
- /**
2758
- * Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.
2759
- */
2760
- 'allowRegularImage'?: boolean;
2761
- /**
2762
- * Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.
2763
- */
2764
- 'allowSaltAndPepperFiltering'?: boolean;
2765
- /**
2766
- * Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.
2767
- */
2768
- 'allowWhiteSpotsRemoving'?: boolean;
2769
- /**
2770
- * Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
2771
- */
2772
- 'checkMore1DVariants'?: boolean;
2773
- /**
2774
- * Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms.
2775
- Default value: False.
2776
- */
2777
- 'fastScanOnly'?: boolean;
2778
- /**
2779
- * Allows engine using additional image restorations to recognize corrupted barcodes. At this time, it is used only in MicroPdf417 barcode type.
2780
- Default value: False.
2781
- */
2782
- 'allowAdditionalRestorations'?: boolean;
2783
- /**
2784
- * Sets threshold for detected regions that may contain barcodes.
2785
- Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further.
2786
- Region likelihood threshold must be between [0.05, 0.9]
2787
- Use high values for clear images with few barcodes.
2788
- Use low values for images with many barcodes or for noisy images.
2789
- Low value may lead to a bigger recognition time.
2790
- */
2791
- 'regionLikelihoodThresholdPercent'?: number;
2792
- /**
2793
- * Scan window sizes in pixels.
2794
- Allowed sizes are 10, 15, 20, 25, 30.
2795
- Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes.
2796
- Combining of several window sizes can improve detection quality.
2797
- */
2798
- 'scanWindowSizes'?: Array<number>;
2799
- /**
2800
- * Similarity coefficient depends on how homogeneous barcodes are.
2801
- Use high value for clear barcodes.
2802
- Use low values to detect barcodes that ara partly damaged or not lighten evenly.
2803
- Similarity coefficient must be between [0.5, 0.9]
2804
- */
2805
- 'similarity'?: number;
2806
- /**
2807
- * Allows detector to skip search for diagonal barcodes.
2808
- Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise.
2809
- Enabling of diagonal search leads to a bigger detection time.
2810
- */
2811
- 'skipDiagonalSearch'?: boolean;
2812
- /**
2813
- * Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.
2814
- */
2815
- 'readTinyBarcodes'?: boolean;
2816
- /**
2817
- * Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
2818
- */
2819
- 'australianPostEncodingTable'?: 'CTable' | 'NTable' | 'Other';
2820
- /**
2821
- * The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method.
2822
- CTable encoding method does not have any gaps in encoding table and sequence "333" of filling patterns is decoded as letter "z".
2823
- */
2824
- 'ignoreEndingFillingPatternsForCTable'?: boolean;
2825
- /**
2826
- * The image file url.
2827
- */
2828
- 'url'?: string;
2829
- /**
2830
- * Image data
2831
- */
2832
- 'image'?: Buffer;
2833
- }
2834
- /**
2835
- * Generate multiple barcodes and return in response stream
2836
- */
2837
- export declare class PostGenerateMultipleRequest {
2838
- /**
2839
- * List of barcodes
2840
- */
2841
- 'generatorParamsList': GeneratorParamsList;
2842
- /**
2843
- * Format to return stream in
2844
- */
2845
- 'format'?: string;
2846
- /**
2847
- * @param generatorParamsList List of barcodes
2848
- */
2849
- constructor(generatorParamsList: GeneratorParamsList);
2850
- }
2851
- /**
2852
- * Generate barcode and save on server (from query params or from file with json or xml content)
2853
- */
2854
- export declare class PutBarcodeGenerateFileRequest {
556
+ export declare class GenerateMultipartRequestWrapper {
2855
557
  /**
2856
- * The image file name.
558
+ *
2857
559
  */
2858
- 'name': string;
560
+ 'barcodeType': EncodeBarcodeType;
2859
561
  /**
2860
- * Type of barcode to generate.
562
+ * String represents data to encode
2861
563
  */
2862
- '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';
564
+ 'data': string;
2863
565
  /**
2864
- * Text to encode.
566
+ *
2865
567
  */
2866
- 'text': string;
568
+ 'dataType'?: EncodeDataType;
2867
569
  /**
2868
- * Text that will be displayed instead of codetext in 2D barcodes.
2869
- Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
570
+ *
2870
571
  */
2871
- 'twoDDisplayText'?: string;
572
+ 'imageFormat'?: BarcodeImageFormat;
2872
573
  /**
2873
- * Specify the displaying Text Location, set to CodeLocation.None to hide CodeText.
2874
- Default value: CodeLocation.Below.
574
+ *
2875
575
  */
2876
- 'textLocation'?: 'Below' | 'Above' | 'None';
576
+ 'textLocation'?: CodeLocation;
2877
577
  /**
2878
- * Text alignment.
578
+ * Specify the displaying bars and content Color. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: Black.
2879
579
  */
2880
- 'textAlignment'?: 'Left' | 'Center' | 'Right';
580
+ 'foregroundColor'?: string;
2881
581
  /**
2882
- * Specify the displaying CodeText's Color.
2883
- Default value: black.
2884
- Use named colors like: red, green, blue
2885
- Or HTML colors like: #FF0000, #00FF00, #0000FF
582
+ * Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value started with #. For example: AliceBlue or #FF000000 Default value: White.
2886
583
  */
2887
- 'textColor'?: string;
584
+ 'backgroundColor'?: string;
2888
585
  /**
2889
- * Specify word wraps (line breaks) within text.
2890
- Default value: false.
586
+ *
2891
587
  */
2892
- 'noWrap'?: boolean;
588
+ 'units'?: GraphicsUnit;
2893
589
  /**
2894
- * Resolution of the BarCode image.
2895
- One value for both dimensions.
2896
- Default value: 96 dpi.
590
+ * Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot.
2897
591
  */
2898
592
  'resolution'?: number;
2899
593
  /**
2900
- * @deprecated Use 'Resolution' instead.
2901
- */
2902
- 'resolutionX'?: number;
2903
- /**
2904
- * @deprecated Use 'Resolution' instead.
2905
- */
2906
- 'resolutionY'?: number;
2907
- /**
2908
- * The smallest width of the unit of BarCode bars or spaces.
2909
- Increase this will increase the whole barcode image width.
2910
- Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
2911
- */
2912
- 'dimensionX'?: number;
2913
- /**
2914
- * Space between the CodeText and the BarCode in Unit value.
2915
- Default value: 2pt.
2916
- Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
2917
- */
2918
- 'textSpace'?: number;
2919
- /**
2920
- * Common Units for all measuring in query. Default units: pixel.
2921
- */
2922
- 'units'?: 'Pixel' | 'Point' | 'Inch' | 'Millimeter';
2923
- /**
2924
- * Specifies the different types of automatic sizing modes.
2925
- Default value: AutoSizeMode.None.
2926
- */
2927
- 'sizeMode'?: 'None' | 'Nearest' | 'Interpolation';
2928
- /**
2929
- * Height of the barcode in given units. Default units: pixel.
2930
- */
2931
- 'barHeight'?: number;
2932
- /**
2933
- * Height of the barcode image in given units. Default units: pixel.
594
+ * Height of the barcode image in given units. Default units: pixel. Decimal separator is dot.
2934
595
  */
2935
596
  'imageHeight'?: number;
2936
597
  /**
2937
- * Width of the barcode image in given units. Default units: pixel.
598
+ * Width of the barcode image in given units. Default units: pixel. Decimal separator is dot.
2938
599
  */
2939
600
  'imageWidth'?: number;
2940
601
  /**
2941
- * BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation.
2942
- If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image.
2943
- Default value: 0.
602
+ * BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
2944
603
  */
2945
604
  'rotationAngle'?: number;
2946
605
  /**
2947
- * Background color of the barcode image.
2948
- Default value: white.
2949
- Use named colors like: red, green, blue
2950
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2951
- */
2952
- 'backColor'?: string;
2953
- /**
2954
- * Bars color.
2955
- Default value: black.
2956
- Use named colors like: red, green, blue
2957
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2958
- */
2959
- 'barColor'?: string;
2960
- /**
2961
- * Border color.
2962
- Default value: black.
2963
- Use named colors like: red, green, blue
2964
- Or HTML colors like: #FF0000, #00FF00, #0000FF
2965
- */
2966
- 'borderColor'?: string;
2967
- /**
2968
- * Border width.
2969
- Default value: 0.
2970
- Ignored if Visible is set to false.
2971
- */
2972
- 'borderWidth'?: number;
2973
- /**
2974
- * Border dash style.
2975
- Default value: BorderDashStyle.Solid.
2976
- */
2977
- 'borderDashStyle'?: 'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot';
2978
- /**
2979
- * Border visibility. If false than parameter Width is always ignored (0).
2980
- Default value: false.
2981
- */
2982
- 'borderVisible'?: boolean;
2983
- /**
2984
- * Enable checksum during generation 1D barcodes.
2985
- Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible.
2986
- Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar
2987
- Checksum always used: Rest symbology
2988
- */
2989
- 'enableChecksum'?: 'Default' | 'Yes' | 'No';
2990
- /**
2991
- * Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only
2992
- If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters.
2993
- Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.
2994
- */
2995
- 'enableEscape'?: boolean;
2996
- /**
2997
- * Value indicating whether bars are filled.
2998
- Only for 1D barcodes.
2999
- Default value: true.
3000
- */
3001
- 'filledBars'?: boolean;
3002
- /**
3003
- * Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
3004
- */
3005
- 'alwaysShowChecksum'?: boolean;
3006
- /**
3007
- * Wide bars to Narrow bars ratio.
3008
- Default value: 3, that is, wide bars are 3 times as wide as narrow bars.
3009
- Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
3010
- */
3011
- 'wideNarrowRatio'?: number;
3012
- /**
3013
- * Only for 1D barcodes.
3014
- If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification.
3015
- Exception always will be thrown for: Databar symbology if codetext is incorrect.
3016
- Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
3017
- */
3018
- 'validateText'?: boolean;
3019
- /**
3020
- * Supplement parameters.
3021
- Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
3022
- */
3023
- 'supplementData'?: string;
3024
- /**
3025
- * Space between main the BarCode and supplement BarCode.
3026
- */
3027
- 'supplementSpace'?: number;
3028
- /**
3029
- * Bars reduction value that is used to compensate ink spread while printing.
3030
- */
3031
- 'barWidthReduction'?: number;
3032
- /**
3033
- * Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing.
3034
- */
3035
- 'useAntiAlias'?: boolean;
3036
- /**
3037
- * Image's storage.
3038
- */
3039
- 'storage'?: string;
3040
- /**
3041
- * Image's folder.
3042
- */
3043
- 'folder'?: string;
3044
- /**
3045
- * The image format.
3046
- */
3047
- 'format'?: string;
3048
- /**
3049
- * @param name The image file name.
3050
-
3051
- * @param type Type of barcode to generate.
3052
-
3053
- * @param text Text to encode.
3054
- */
3055
- constructor(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);
3056
- }
3057
- /**
3058
- * Recognition of a barcode from file on server with parameters in body.
3059
- */
3060
- export declare class PutBarcodeRecognizeFromBodyRequest {
3061
- /**
3062
- * The image file name.
3063
- */
3064
- 'name': string;
3065
- /**
3066
- * BarcodeReader object with parameters.
3067
- */
3068
- 'readerParams': ReaderParams;
3069
- /**
3070
- *
3071
- */
3072
- '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' | 'mostCommonlyUsed';
3073
- /**
3074
- * The storage name
3075
- */
3076
- 'storage'?: string;
3077
- /**
3078
- * The image folder.
3079
- */
3080
- 'folder'?: string;
3081
- /**
3082
- * @param name The image file name.
3083
-
3084
- * @param readerParams BarcodeReader object with parameters.
3085
- */
3086
- constructor(name: string, readerParams: ReaderParams);
3087
- }
3088
- /**
3089
- * Generate image with multiple barcodes and put new file on server
3090
- */
3091
- export declare class PutGenerateMultipleRequest {
3092
- /**
3093
- * New filename
3094
- */
3095
- 'name': string;
3096
- /**
3097
- * List of barcodes
3098
- */
3099
- 'generatorParamsList': GeneratorParamsList;
3100
- /**
3101
- * Format of file
3102
- */
3103
- 'format'?: string;
3104
- /**
3105
- * Folder to place file to
3106
- */
3107
- 'folder'?: string;
3108
- /**
3109
- * The storage name
3110
- */
3111
- 'storage'?: string;
3112
- /**
3113
- * @param name New filename
3114
-
3115
- * @param generatorParamsList List of barcodes
3116
- */
3117
- constructor(name: string, generatorParamsList: GeneratorParamsList);
3118
- }
3119
- /**
3120
- * Quickly scan a barcode from an image.
3121
- */
3122
- export declare class ScanBarcodeRequest {
3123
- /**
3124
- * Image as file
3125
- */
3126
- 'imageFile': Buffer;
3127
- /**
3128
- * Types of barcode to recognize
3129
- */
3130
- 'decodeTypes'?: Array<DecodeBarcodeType>;
3131
- /**
3132
- * Timeout of recognition process in milliseconds.
3133
- Default value is 15_000 (15 seconds).
3134
- Maximum value is 30_000 (1/2 minute).
3135
- In case of a timeout RequestTimeout (408) status will be returned.
3136
- Try reducing the image size to avoid timeout.
3137
- */
3138
- 'timeout'?: number;
3139
- /**
3140
- * Checksum validation setting. Default is ON.
3141
- */
3142
- 'checksumValidation'?: 'Default' | 'On' | 'Off';
3143
- /**
3144
- * @param imageFile Image as file
3145
- */
3146
- constructor(imageFile: Buffer);
3147
- }
3148
- /**
3149
- * Copy file
3150
- */
3151
- export declare class CopyFileRequest {
3152
- /**
3153
- * Source file path e.g. '/folder/file.ext'
3154
- */
3155
- 'srcPath': string;
3156
- /**
3157
- * Destination file path
3158
- */
3159
- 'destPath': string;
3160
- /**
3161
- * Source storage name
3162
- */
3163
- 'srcStorageName'?: string;
3164
- /**
3165
- * Destination storage name
3166
- */
3167
- 'destStorageName'?: string;
3168
- /**
3169
- * File version ID to copy
3170
- */
3171
- 'versionId'?: string;
3172
- /**
3173
- * @param srcPath Source file path e.g. '/folder/file.ext'
3174
-
3175
- * @param destPath Destination file path
3176
- */
3177
- constructor(srcPath: string, destPath: string);
3178
- }
3179
- /**
3180
- * Delete file
3181
- */
3182
- export declare class DeleteFileRequest {
3183
- /**
3184
- * File path e.g. '/folder/file.ext'
3185
- */
3186
- 'path': string;
3187
- /**
3188
- * Storage name
3189
- */
3190
- 'storageName'?: string;
3191
- /**
3192
- * File version ID to delete
3193
- */
3194
- 'versionId'?: string;
3195
- /**
3196
- * @param path File path e.g. '/folder/file.ext'
3197
- */
3198
- constructor(path: string);
3199
- }
3200
- /**
3201
- * Download file
3202
- */
3203
- export declare class DownloadFileRequest {
3204
- /**
3205
- * File path e.g. '/folder/file.ext'
3206
- */
3207
- 'path': string;
3208
- /**
3209
- * Storage name
3210
- */
3211
- 'storageName'?: string;
3212
- /**
3213
- * File version ID to download
3214
- */
3215
- 'versionId'?: string;
3216
- /**
3217
- * @param path File path e.g. '/folder/file.ext'
3218
- */
3219
- constructor(path: string);
3220
- }
3221
- /**
3222
- * Move file
3223
- */
3224
- export declare class MoveFileRequest {
3225
- /**
3226
- * Source file path e.g. '/src.ext'
3227
- */
3228
- 'srcPath': string;
3229
- /**
3230
- * Destination file path e.g. '/dest.ext'
3231
- */
3232
- 'destPath': string;
3233
- /**
3234
- * Source storage name
3235
- */
3236
- 'srcStorageName'?: string;
3237
- /**
3238
- * Destination storage name
3239
- */
3240
- 'destStorageName'?: string;
3241
- /**
3242
- * File version ID to move
3243
- */
3244
- 'versionId'?: string;
3245
- /**
3246
- * @param srcPath Source file path e.g. '/src.ext'
3247
-
3248
- * @param destPath Destination file path e.g. '/dest.ext'
3249
- */
3250
- constructor(srcPath: string, destPath: string);
3251
- }
3252
- /**
3253
- * Upload file
3254
- */
3255
- export declare class UploadFileRequest {
3256
- /**
3257
- * Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext
3258
- If the content is multipart and path does not contains the file name it tries to get them from filename parameter
3259
- from Content-Disposition header.
3260
- */
3261
- 'path': string;
3262
- /**
3263
- * File to upload
3264
- */
3265
- 'file': Buffer;
3266
- /**
3267
- * Storage name
3268
- */
3269
- 'storageName'?: string;
3270
- /**
3271
- * @param path Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext
3272
- If the content is multipart and path does not contains the file name it tries to get them from filename parameter
3273
- from Content-Disposition header.
606
+ * @param barcodeType
3274
607
 
3275
- * @param file File to upload
608
+ * @param data String represents data to encode
3276
609
  */
3277
- constructor(path: string, file: Buffer);
610
+ constructor(barcodeType: EncodeBarcodeType, data: string);
3278
611
  }
3279
612
  /**
3280
- * Copy folder
613
+ * Recognize barcode from file on server using GET requests with parameters in route and query string.
3281
614
  */
3282
- export declare class CopyFolderRequest {
615
+ export declare class RecognizeRequestWrapper {
3283
616
  /**
3284
- * Source folder path e.g. '/src'
617
+ * Type of barcode to recognize
3285
618
  */
3286
- 'srcPath': string;
619
+ 'barcodeType': DecodeBarcodeType;
3287
620
  /**
3288
- * Destination folder path e.g. '/dst'
621
+ * Url to barcode image
3289
622
  */
3290
- 'destPath': string;
623
+ 'fileUrl': string;
3291
624
  /**
3292
- * Source storage name
625
+ * Recognition mode
3293
626
  */
3294
- 'srcStorageName'?: string;
627
+ 'recognitionMode'?: RecognitionMode;
3295
628
  /**
3296
- * Destination storage name
629
+ * Image kind for recognition
3297
630
  */
3298
- 'destStorageName'?: string;
631
+ 'recognitionImageKind'?: RecognitionImageKind;
3299
632
  /**
3300
- * @param srcPath Source folder path e.g. '/src'
633
+ * @param barcodeType Type of barcode to recognize
3301
634
 
3302
- * @param destPath Destination folder path e.g. '/dst'
3303
- */
3304
- constructor(srcPath: string, destPath: string);
3305
- }
3306
- /**
3307
- * Create the folder
3308
- */
3309
- export declare class CreateFolderRequest {
3310
- /**
3311
- * Folder path to create e.g. 'folder_1/folder_2/'
3312
- */
3313
- 'path': string;
3314
- /**
3315
- * Storage name
3316
- */
3317
- 'storageName'?: string;
3318
- /**
3319
- * @param path Folder path to create e.g. 'folder_1/folder_2/'
3320
- */
3321
- constructor(path: string);
3322
- }
3323
- /**
3324
- * Delete folder
3325
- */
3326
- export declare class DeleteFolderRequest {
3327
- /**
3328
- * Folder path e.g. '/folder'
635
+ * @param fileUrl Url to barcode image
3329
636
  */
3330
- 'path': string;
3331
- /**
3332
- * Storage name
3333
- */
3334
- 'storageName'?: string;
3335
- /**
3336
- * Enable to delete folders, subfolders and files
3337
- */
3338
- 'recursive'?: boolean;
3339
- /**
3340
- * @param path Folder path e.g. '/folder'
3341
- */
3342
- constructor(path: string);
637
+ constructor(barcodeType: DecodeBarcodeType, fileUrl: string);
3343
638
  }
3344
639
  /**
3345
- * Get all files and folders within a folder
640
+ * Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
3346
641
  */
3347
- export declare class GetFilesListRequest {
3348
- /**
3349
- * Folder path e.g. '/folder'
3350
- */
3351
- 'path': string;
642
+ export declare class RecognizeBase64RequestWrapper {
3352
643
  /**
3353
- * Storage name
644
+ *
3354
645
  */
3355
- 'storageName'?: string;
646
+ 'recognizeBase64Request': RecognizeBase64Request;
3356
647
  /**
3357
- * @param path Folder path e.g. '/folder'
648
+ * @param recognizeBase64Request
3358
649
  */
3359
- constructor(path: string);
650
+ constructor(recognizeBase64Request: RecognizeBase64Request);
3360
651
  }
3361
652
  /**
3362
- * Move folder
653
+ * Recognize barcode from file in request body using POST requests with parameters in multipart form.
3363
654
  */
3364
- export declare class MoveFolderRequest {
655
+ export declare class RecognizeMultipartRequestWrapper {
3365
656
  /**
3366
- * Folder path to move e.g. '/folder'
657
+ *
3367
658
  */
3368
- 'srcPath': string;
659
+ 'barcodeType': DecodeBarcodeType;
3369
660
  /**
3370
- * Destination folder path to move to e.g '/dst'
661
+ * Barcode image file
3371
662
  */
3372
- 'destPath': string;
663
+ 'fileBytes': Buffer;
3373
664
  /**
3374
- * Source storage name
665
+ *
3375
666
  */
3376
- 'srcStorageName'?: string;
667
+ 'recognitionMode'?: RecognitionMode;
3377
668
  /**
3378
- * Destination storage name
669
+ *
3379
670
  */
3380
- 'destStorageName'?: string;
671
+ 'recognitionImageKind'?: RecognitionImageKind;
3381
672
  /**
3382
- * @param srcPath Folder path to move e.g. '/folder'
673
+ * @param barcodeType
3383
674
 
3384
- * @param destPath Destination folder path to move to e.g '/dst'
3385
- */
3386
- constructor(srcPath: string, destPath: string);
3387
- }
3388
- /**
3389
- * Get disc usage
3390
- */
3391
- export declare class GetDiscUsageRequest {
3392
- /**
3393
- * Storage name
675
+ * @param fileBytes Barcode image file
3394
676
  */
3395
- 'storageName'?: string;
677
+ constructor(barcodeType: DecodeBarcodeType, fileBytes: Buffer);
3396
678
  }
3397
679
  /**
3398
- * Get file versions
680
+ * Scan barcode from file on server using GET requests with parameter in query string.
3399
681
  */
3400
- export declare class GetFileVersionsRequest {
3401
- /**
3402
- * File path e.g. '/file.ext'
3403
- */
3404
- 'path': string;
682
+ export declare class ScanRequestWrapper {
3405
683
  /**
3406
- * Storage name
684
+ * Url to barcode image
3407
685
  */
3408
- 'storageName'?: string;
686
+ 'fileUrl': string;
3409
687
  /**
3410
- * @param path File path e.g. '/file.ext'
688
+ * @param fileUrl Url to barcode image
3411
689
  */
3412
- constructor(path: string);
690
+ constructor(fileUrl: string);
3413
691
  }
3414
692
  /**
3415
- * Check if file or folder exists
693
+ * Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
3416
694
  */
3417
- export declare class ObjectExistsRequest {
3418
- /**
3419
- * File or folder path e.g. '/file.ext' or '/folder'
3420
- */
3421
- 'path': string;
3422
- /**
3423
- * Storage name
3424
- */
3425
- 'storageName'?: string;
695
+ export declare class ScanBase64RequestWrapper {
3426
696
  /**
3427
- * File version ID
697
+ *
3428
698
  */
3429
- 'versionId'?: string;
699
+ 'scanBase64Request': ScanBase64Request;
3430
700
  /**
3431
- * @param path File or folder path e.g. '/file.ext' or '/folder'
701
+ * @param scanBase64Request
3432
702
  */
3433
- constructor(path: string);
703
+ constructor(scanBase64Request: ScanBase64Request);
3434
704
  }
3435
705
  /**
3436
- * Check if storage exists
706
+ * Scan barcode from file in request body using POST requests with parameter in multipart form.
3437
707
  */
3438
- export declare class StorageExistsRequest {
708
+ export declare class ScanMultipartRequestWrapper {
3439
709
  /**
3440
- * Storage name
710
+ * Barcode image file
3441
711
  */
3442
- 'storageName': string;
712
+ 'fileBytes': Buffer;
3443
713
  /**
3444
- * @param storageName Storage name
714
+ * @param fileBytes Barcode image file
3445
715
  */
3446
- constructor(storageName: string);
716
+ constructor(fileBytes: Buffer);
3447
717
  }