aspose-barcode-cloud-node 25.2.0 → 25.4.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.
package/dist/index.d.ts CHANGED
@@ -1,2 +1,876 @@
1
- export * from './api';
2
- export * from './Configuration';
1
+ /**
2
+ * Api Error.
3
+ */
4
+ declare class ApiError {
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
+ */
16
+ 'description'?: string;
17
+ /**
18
+ * Gets or sets server datetime.
19
+ */
20
+ 'dateTime'?: Date;
21
+ 'innerError'?: ApiError;
22
+ static attributeTypeMap: Array<{
23
+ name: string;
24
+ baseName: string;
25
+ type: string;
26
+ }>;
27
+ static getAttributeTypeMap(): {
28
+ name: string;
29
+ baseName: string;
30
+ type: string;
31
+ }[];
32
+ }
33
+ /**
34
+ * ApiError Response
35
+ */
36
+ declare class ApiErrorResponse {
37
+ /**
38
+ * Gets or sets request Id.
39
+ */
40
+ 'requestId': string;
41
+ 'error': ApiError;
42
+ static attributeTypeMap: Array<{
43
+ name: string;
44
+ baseName: string;
45
+ type: string;
46
+ }>;
47
+ static getAttributeTypeMap(): {
48
+ name: string;
49
+ baseName: string;
50
+ type: string;
51
+ }[];
52
+ }
53
+ /**
54
+ * Specifies the file format of the image.
55
+ */
56
+ declare enum BarcodeImageFormat {
57
+ Png = "Png",
58
+ Jpeg = "Jpeg",
59
+ Svg = "Svg",
60
+ Tiff = "Tiff",
61
+ Gif = "Gif"
62
+ }
63
+ /**
64
+ * Barcode image optional parameters
65
+ */
66
+ declare class BarcodeImageParams {
67
+ 'imageFormat'?: BarcodeImageFormat;
68
+ 'textLocation'?: CodeLocation;
69
+ /**
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.
71
+ */
72
+ 'foregroundColor'?: string;
73
+ /**
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.
75
+ */
76
+ 'backgroundColor'?: string;
77
+ 'units'?: GraphicsUnit;
78
+ /**
79
+ * Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot.
80
+ */
81
+ 'resolution'?: number;
82
+ /**
83
+ * Height of the barcode image in given units. Default units: pixel. Decimal separator is dot.
84
+ */
85
+ 'imageHeight'?: number;
86
+ /**
87
+ * Width of the barcode image in given units. Default units: pixel. Decimal separator is dot.
88
+ */
89
+ 'imageWidth'?: number;
90
+ /**
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.
92
+ */
93
+ 'rotationAngle'?: number;
94
+ static attributeTypeMap: Array<{
95
+ name: string;
96
+ baseName: string;
97
+ type: string;
98
+ }>;
99
+ static getAttributeTypeMap(): {
100
+ name: string;
101
+ baseName: string;
102
+ type: string;
103
+ }[];
104
+ }
105
+ /**
106
+ * Represents information about barcode.
107
+ */
108
+ declare class BarcodeResponse {
109
+ /**
110
+ * Barcode data.
111
+ */
112
+ 'barcodeValue'?: string;
113
+ /**
114
+ * Type of the barcode.
115
+ */
116
+ 'type'?: string;
117
+ /**
118
+ * Region with barcode.
119
+ */
120
+ 'region'?: Array<RegionPoint>;
121
+ /**
122
+ * Checksum of barcode.
123
+ */
124
+ 'checksum'?: string;
125
+ static attributeTypeMap: Array<{
126
+ name: string;
127
+ baseName: string;
128
+ type: string;
129
+ }>;
130
+ static getAttributeTypeMap(): {
131
+ name: string;
132
+ baseName: string;
133
+ type: string;
134
+ }[];
135
+ }
136
+ /**
137
+ * Represents information about barcode list.
138
+ */
139
+ declare class BarcodeResponseList {
140
+ /**
141
+ * List of barcodes which are present in image.
142
+ */
143
+ 'barcodes': Array<BarcodeResponse>;
144
+ static attributeTypeMap: Array<{
145
+ name: string;
146
+ baseName: string;
147
+ type: string;
148
+ }>;
149
+ static getAttributeTypeMap(): {
150
+ name: string;
151
+ baseName: string;
152
+ type: string;
153
+ }[];
154
+ }
155
+ declare enum CodeLocation {
156
+ Below = "Below",
157
+ Above = "Above",
158
+ None = "None"
159
+ }
160
+ /**
161
+ * See Aspose.BarCode.Aspose.BarCode.BarCodeRecognition.DecodeType
162
+ */
163
+ 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"
248
+ }
249
+ /**
250
+ * See Aspose.BarCode.Generation.EncodeTypes
251
+ */
252
+ 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"
326
+ }
327
+ /**
328
+ * Data to encode in barcode
329
+ */
330
+ declare class EncodeData {
331
+ 'dataType'?: EncodeDataType;
332
+ /**
333
+ * String represents data to encode
334
+ */
335
+ 'data': string;
336
+ static attributeTypeMap: Array<{
337
+ name: string;
338
+ baseName: string;
339
+ type: string;
340
+ }>;
341
+ static getAttributeTypeMap(): {
342
+ name: string;
343
+ baseName: string;
344
+ type: string;
345
+ }[];
346
+ }
347
+ /**
348
+ * Types of data can be encoded to barcode
349
+ */
350
+ declare enum EncodeDataType {
351
+ StringData = "StringData",
352
+ Base64Bytes = "Base64Bytes",
353
+ HexBytes = "HexBytes"
354
+ }
355
+ /**
356
+ * Barcode generation parameters
357
+ */
358
+ declare class GenerateParams {
359
+ 'barcodeType': EncodeBarcodeType;
360
+ 'encodeData': EncodeData;
361
+ 'barcodeImageParams'?: BarcodeImageParams;
362
+ static attributeTypeMap: Array<{
363
+ name: string;
364
+ baseName: string;
365
+ type: string;
366
+ }>;
367
+ static getAttributeTypeMap(): {
368
+ name: string;
369
+ baseName: string;
370
+ type: string;
371
+ }[];
372
+ }
373
+ /**
374
+ * Subset of Aspose.Drawing.GraphicsUnit.
375
+ */
376
+ declare enum GraphicsUnit {
377
+ Pixel = "Pixel",
378
+ Point = "Point",
379
+ Inch = "Inch",
380
+ Millimeter = "Millimeter"
381
+ }
382
+ /**
383
+ * Kind of image to recognize
384
+ */
385
+ declare enum RecognitionImageKind {
386
+ Photo = "Photo",
387
+ ScannedDocument = "ScannedDocument",
388
+ ClearImage = "ClearImage"
389
+ }
390
+ /**
391
+ * Recognition mode.
392
+ */
393
+ declare enum RecognitionMode {
394
+ Fast = "Fast",
395
+ Normal = "Normal",
396
+ Excellent = "Excellent"
397
+ }
398
+ /**
399
+ * Barcode recognize request
400
+ */
401
+ declare class RecognizeBase64Request {
402
+ /**
403
+ * Array of decode types to find on barcode
404
+ */
405
+ 'barcodeTypes': Array<DecodeBarcodeType>;
406
+ /**
407
+ * Barcode image bytes encoded as base-64.
408
+ */
409
+ 'fileBase64': string;
410
+ 'recognitionMode'?: RecognitionMode;
411
+ 'recognitionImageKind'?: RecognitionImageKind;
412
+ static attributeTypeMap: Array<{
413
+ name: string;
414
+ baseName: string;
415
+ type: string;
416
+ }>;
417
+ static getAttributeTypeMap(): {
418
+ name: string;
419
+ baseName: string;
420
+ type: string;
421
+ }[];
422
+ }
423
+ /**
424
+ * Wrapper around Drawing.Point for proper specification.
425
+ */
426
+ declare class RegionPoint {
427
+ /**
428
+ * X-coordinate
429
+ */
430
+ 'x'?: number;
431
+ /**
432
+ * Y-coordinate
433
+ */
434
+ 'y'?: number;
435
+ static attributeTypeMap: Array<{
436
+ name: string;
437
+ baseName: string;
438
+ type: string;
439
+ }>;
440
+ static getAttributeTypeMap(): {
441
+ name: string;
442
+ baseName: string;
443
+ type: string;
444
+ }[];
445
+ }
446
+ /**
447
+ * Scan barcode request.
448
+ */
449
+ declare class ScanBase64Request {
450
+ /**
451
+ * Barcode image bytes encoded as base-64.
452
+ */
453
+ 'fileBase64': string;
454
+ static attributeTypeMap: Array<{
455
+ name: string;
456
+ baseName: string;
457
+ type: string;
458
+ }>;
459
+ static getAttributeTypeMap(): {
460
+ name: string;
461
+ baseName: string;
462
+ type: string;
463
+ }[];
464
+ }
465
+ /**
466
+ * Generate barcode using GET request with parameters in route and query string.
467
+ */
468
+ declare class GenerateRequestWrapper {
469
+ /**
470
+ * Type of barcode to generate.
471
+ */
472
+ 'barcodeType': EncodeBarcodeType;
473
+ /**
474
+ * String represents data to encode
475
+ */
476
+ 'data': string;
477
+ /**
478
+ * Type of data to encode.
479
+ Default value: StringData.
480
+ */
481
+ 'dataType'?: EncodeDataType;
482
+ /**
483
+ * Barcode output image format.
484
+ Default value: png
485
+ */
486
+ 'imageFormat'?: BarcodeImageFormat;
487
+ /**
488
+ * Specify the displaying Text Location, set to CodeLocation.None to hide CodeText.
489
+ Default value: Depends on BarcodeType. CodeLocation.Below for 1D Barcodes. CodeLocation.None for 2D Barcodes.
490
+ */
491
+ 'textLocation'?: CodeLocation;
492
+ /**
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.
497
+ */
498
+ 'foregroundColor'?: string;
499
+ /**
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.
504
+ */
505
+ 'backgroundColor'?: string;
506
+ /**
507
+ * Common Units for all measuring in query. Default units: pixel.
508
+ */
509
+ 'units'?: GraphicsUnit;
510
+ /**
511
+ * Resolution of the BarCode image.
512
+ One value for both dimensions.
513
+ Default value: 96 dpi.
514
+ Decimal separator is dot.
515
+ */
516
+ 'resolution'?: number;
517
+ /**
518
+ * Height of the barcode image in given units. Default units: pixel.
519
+ Decimal separator is dot.
520
+ */
521
+ 'imageHeight'?: number;
522
+ /**
523
+ * Width of the barcode image in given units. Default units: pixel.
524
+ Decimal separator is dot.
525
+ */
526
+ 'imageWidth'?: number;
527
+ /**
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.
531
+ */
532
+ 'rotationAngle'?: number;
533
+ /**
534
+ * @param barcodeType Type of barcode to generate.
535
+
536
+ * @param data String represents data to encode
537
+ */
538
+ constructor(barcodeType: EncodeBarcodeType, data: string);
539
+ }
540
+ /**
541
+ * Generate barcode using POST request with parameters in body in json or xml format.
542
+ */
543
+ declare class GenerateBodyRequestWrapper {
544
+ /**
545
+ *
546
+ */
547
+ 'generateParams': GenerateParams;
548
+ /**
549
+ * @param generateParams
550
+ */
551
+ constructor(generateParams: GenerateParams);
552
+ }
553
+ /**
554
+ * Generate barcode using POST request with parameters in multipart form.
555
+ */
556
+ declare class GenerateMultipartRequestWrapper {
557
+ /**
558
+ *
559
+ */
560
+ 'barcodeType': EncodeBarcodeType;
561
+ /**
562
+ * String represents data to encode
563
+ */
564
+ 'data': string;
565
+ /**
566
+ *
567
+ */
568
+ 'dataType'?: EncodeDataType;
569
+ /**
570
+ *
571
+ */
572
+ 'imageFormat'?: BarcodeImageFormat;
573
+ /**
574
+ *
575
+ */
576
+ 'textLocation'?: CodeLocation;
577
+ /**
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.
579
+ */
580
+ 'foregroundColor'?: string;
581
+ /**
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.
583
+ */
584
+ 'backgroundColor'?: string;
585
+ /**
586
+ *
587
+ */
588
+ 'units'?: GraphicsUnit;
589
+ /**
590
+ * Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is dot.
591
+ */
592
+ 'resolution'?: number;
593
+ /**
594
+ * Height of the barcode image in given units. Default units: pixel. Decimal separator is dot.
595
+ */
596
+ 'imageHeight'?: number;
597
+ /**
598
+ * Width of the barcode image in given units. Default units: pixel. Decimal separator is dot.
599
+ */
600
+ 'imageWidth'?: number;
601
+ /**
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.
603
+ */
604
+ 'rotationAngle'?: number;
605
+ /**
606
+ * @param barcodeType
607
+
608
+ * @param data String represents data to encode
609
+ */
610
+ constructor(barcodeType: EncodeBarcodeType, data: string);
611
+ }
612
+ /**
613
+ * Recognize barcode from file on server using GET requests with parameters in route and query string.
614
+ */
615
+ declare class RecognizeRequestWrapper {
616
+ /**
617
+ * Type of barcode to recognize
618
+ */
619
+ 'barcodeType': DecodeBarcodeType;
620
+ /**
621
+ * Url to barcode image
622
+ */
623
+ 'fileUrl': string;
624
+ /**
625
+ * Recognition mode
626
+ */
627
+ 'recognitionMode'?: RecognitionMode;
628
+ /**
629
+ * Image kind for recognition
630
+ */
631
+ 'recognitionImageKind'?: RecognitionImageKind;
632
+ /**
633
+ * @param barcodeType Type of barcode to recognize
634
+
635
+ * @param fileUrl Url to barcode image
636
+ */
637
+ constructor(barcodeType: DecodeBarcodeType, fileUrl: string);
638
+ }
639
+ /**
640
+ * Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
641
+ */
642
+ declare class RecognizeBase64RequestWrapper {
643
+ /**
644
+ *
645
+ */
646
+ 'recognizeBase64Request': RecognizeBase64Request;
647
+ /**
648
+ * @param recognizeBase64Request
649
+ */
650
+ constructor(recognizeBase64Request: RecognizeBase64Request);
651
+ }
652
+ /**
653
+ * Recognize barcode from file in request body using POST requests with parameters in multipart form.
654
+ */
655
+ declare class RecognizeMultipartRequestWrapper {
656
+ /**
657
+ *
658
+ */
659
+ 'barcodeType': DecodeBarcodeType;
660
+ /**
661
+ * Barcode image file
662
+ */
663
+ 'fileBytes': Buffer;
664
+ /**
665
+ *
666
+ */
667
+ 'recognitionMode'?: RecognitionMode;
668
+ /**
669
+ *
670
+ */
671
+ 'recognitionImageKind'?: RecognitionImageKind;
672
+ /**
673
+ * @param barcodeType
674
+
675
+ * @param fileBytes Barcode image file
676
+ */
677
+ constructor(barcodeType: DecodeBarcodeType, fileBytes: Buffer);
678
+ }
679
+ /**
680
+ * Scan barcode from file on server using GET requests with parameter in query string.
681
+ */
682
+ declare class ScanRequestWrapper {
683
+ /**
684
+ * Url to barcode image
685
+ */
686
+ 'fileUrl': string;
687
+ /**
688
+ * @param fileUrl Url to barcode image
689
+ */
690
+ constructor(fileUrl: string);
691
+ }
692
+ /**
693
+ * Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
694
+ */
695
+ declare class ScanBase64RequestWrapper {
696
+ /**
697
+ *
698
+ */
699
+ 'scanBase64Request': ScanBase64Request;
700
+ /**
701
+ * @param scanBase64Request
702
+ */
703
+ constructor(scanBase64Request: ScanBase64Request);
704
+ }
705
+ /**
706
+ * Scan barcode from file in request body using POST requests with parameter in multipart form.
707
+ */
708
+ declare class ScanMultipartRequestWrapper {
709
+ /**
710
+ * Barcode image file
711
+ */
712
+ 'fileBytes': Buffer;
713
+ /**
714
+ * @param fileBytes Barcode image file
715
+ */
716
+ constructor(fileBytes: Buffer);
717
+ }
718
+
719
+ interface StringKeyWithStringValue {
720
+ [key: string]: string;
721
+ }
722
+ interface HttpOptions {
723
+ uri: string;
724
+ body?: any;
725
+ encoding?: BufferEncoding | null;
726
+ form?: StringKeyWithStringValue;
727
+ headers?: StringKeyWithStringValue;
728
+ json?: boolean;
729
+ method?: string;
730
+ qs?: StringKeyWithStringValue;
731
+ }
732
+ interface HttpResponse {
733
+ statusCode: number;
734
+ statusMessage: string;
735
+ headers: NodeJS.Dict<string | string[]>;
736
+ body: any;
737
+ }
738
+
739
+ interface Authentication {
740
+ /**
741
+ * Apply authentication settings to header and query params.
742
+ */
743
+ applyToRequestAsync(requestOptions: HttpOptions): Promise<void>;
744
+ }
745
+
746
+ declare enum ApiVersion {
747
+ v4 = "v4.0"
748
+ }
749
+ declare class Configuration {
750
+ /**
751
+ * Authentication type.
752
+ */
753
+ authentication: Authentication;
754
+ /**
755
+ * Client Id.
756
+ */
757
+ clientId: string;
758
+ /**
759
+ * Client Secret.
760
+ */
761
+ clientSecret: string;
762
+ /**
763
+ * Base Url.
764
+ */
765
+ baseUrl: string;
766
+ readonly version: ApiVersion;
767
+ readonly accessToken: string;
768
+ readonly tokenUrl: string;
769
+ constructor(clientId: string, clientSecret: string, baseUrl?: string, accessToken?: string, tokenUrl?: string);
770
+ /**
771
+ * Returns api base url
772
+ */
773
+ getApiBaseUrl(): string;
774
+ }
775
+
776
+ declare class GenerateApi {
777
+ protected defaultHeaders: any;
778
+ protected _configuration: Configuration;
779
+ private _client;
780
+ constructor(configuration: Configuration);
781
+ /**
782
+ *
783
+ * @summary Generate barcode using GET request with parameters in route and query string.
784
+ * @param request GenerateRequestWrapper
785
+ */
786
+ generate(request: GenerateRequestWrapper): Promise<{
787
+ response: HttpResponse;
788
+ body: Buffer;
789
+ }>;
790
+ /**
791
+ *
792
+ * @summary Generate barcode using POST request with parameters in body in json or xml format.
793
+ * @param request GenerateBodyRequestWrapper
794
+ */
795
+ generateBody(request: GenerateBodyRequestWrapper): Promise<{
796
+ response: HttpResponse;
797
+ body: Buffer;
798
+ }>;
799
+ /**
800
+ *
801
+ * @summary Generate barcode using POST request with parameters in multipart form.
802
+ * @param request GenerateMultipartRequestWrapper
803
+ */
804
+ generateMultipart(request: GenerateMultipartRequestWrapper): Promise<{
805
+ response: HttpResponse;
806
+ body: Buffer;
807
+ }>;
808
+ }
809
+ declare class RecognizeApi {
810
+ protected defaultHeaders: any;
811
+ protected _configuration: Configuration;
812
+ private _client;
813
+ constructor(configuration: Configuration);
814
+ /**
815
+ *
816
+ * @summary Recognize barcode from file on server using GET requests with parameters in route and query string.
817
+ * @param request RecognizeRequestWrapper
818
+ */
819
+ recognize(request: RecognizeRequestWrapper): Promise<{
820
+ response: HttpResponse;
821
+ body: BarcodeResponseList;
822
+ }>;
823
+ /**
824
+ *
825
+ * @summary Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
826
+ * @param request RecognizeBase64RequestWrapper
827
+ */
828
+ recognizeBase64(request: RecognizeBase64RequestWrapper): Promise<{
829
+ response: HttpResponse;
830
+ body: BarcodeResponseList;
831
+ }>;
832
+ /**
833
+ *
834
+ * @summary Recognize barcode from file in request body using POST requests with parameters in multipart form.
835
+ * @param request RecognizeMultipartRequestWrapper
836
+ */
837
+ recognizeMultipart(request: RecognizeMultipartRequestWrapper): Promise<{
838
+ response: HttpResponse;
839
+ body: BarcodeResponseList;
840
+ }>;
841
+ }
842
+ declare class ScanApi {
843
+ protected defaultHeaders: any;
844
+ protected _configuration: Configuration;
845
+ private _client;
846
+ constructor(configuration: Configuration);
847
+ /**
848
+ *
849
+ * @summary Scan barcode from file on server using GET requests with parameter in query string.
850
+ * @param request ScanRequestWrapper
851
+ */
852
+ scan(request: ScanRequestWrapper): Promise<{
853
+ response: HttpResponse;
854
+ body: BarcodeResponseList;
855
+ }>;
856
+ /**
857
+ *
858
+ * @summary Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
859
+ * @param request ScanBase64RequestWrapper
860
+ */
861
+ scanBase64(request: ScanBase64RequestWrapper): Promise<{
862
+ response: HttpResponse;
863
+ body: BarcodeResponseList;
864
+ }>;
865
+ /**
866
+ *
867
+ * @summary Scan barcode from file in request body using POST requests with parameter in multipart form.
868
+ * @param request ScanMultipartRequestWrapper
869
+ */
870
+ scanMultipart(request: ScanMultipartRequestWrapper): Promise<{
871
+ response: HttpResponse;
872
+ body: BarcodeResponseList;
873
+ }>;
874
+ }
875
+
876
+ export { ApiError, ApiErrorResponse, ApiVersion, BarcodeImageFormat, BarcodeImageParams, BarcodeResponse, BarcodeResponseList, CodeLocation, Configuration, DecodeBarcodeType, EncodeBarcodeType, EncodeData, EncodeDataType, GenerateApi, GenerateBodyRequestWrapper, GenerateMultipartRequestWrapper, GenerateParams, GenerateRequestWrapper, GraphicsUnit, RecognitionImageKind, RecognitionMode, RecognizeApi, RecognizeBase64Request, RecognizeBase64RequestWrapper, RecognizeMultipartRequestWrapper, RecognizeRequestWrapper, RegionPoint, ScanApi, ScanBase64Request, ScanBase64RequestWrapper, ScanMultipartRequestWrapper, ScanRequestWrapper };