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/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  [![npm](https://img.shields.io/npm/v/aspose-barcode-cloud-node)](https://www.npmjs.com/package/aspose-barcode-cloud-node)
6
6
 
7
7
  + API version: 4.0
8
- + Package version: 25.2.0
8
+ + Package version: 25.4.0
9
9
 
10
10
  ## SDK and API Version Compatibility:
11
11
 
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Api Error.
3
3
  */
4
- export declare class ApiError {
4
+ declare class ApiError {
5
5
  /**
6
6
  * Gets or sets api error code.
7
7
  */
@@ -33,7 +33,7 @@ export declare class ApiError {
33
33
  /**
34
34
  * ApiError Response
35
35
  */
36
- export declare class ApiErrorResponse {
36
+ declare class ApiErrorResponse {
37
37
  /**
38
38
  * Gets or sets request Id.
39
39
  */
@@ -53,7 +53,7 @@ export declare class ApiErrorResponse {
53
53
  /**
54
54
  * Specifies the file format of the image.
55
55
  */
56
- export declare enum BarcodeImageFormat {
56
+ declare enum BarcodeImageFormat {
57
57
  Png = "Png",
58
58
  Jpeg = "Jpeg",
59
59
  Svg = "Svg",
@@ -63,7 +63,7 @@ export declare enum BarcodeImageFormat {
63
63
  /**
64
64
  * Barcode image optional parameters
65
65
  */
66
- export declare class BarcodeImageParams {
66
+ declare class BarcodeImageParams {
67
67
  'imageFormat'?: BarcodeImageFormat;
68
68
  'textLocation'?: CodeLocation;
69
69
  /**
@@ -105,7 +105,7 @@ export declare class BarcodeImageParams {
105
105
  /**
106
106
  * Represents information about barcode.
107
107
  */
108
- export declare class BarcodeResponse {
108
+ declare class BarcodeResponse {
109
109
  /**
110
110
  * Barcode data.
111
111
  */
@@ -136,7 +136,7 @@ export declare class BarcodeResponse {
136
136
  /**
137
137
  * Represents information about barcode list.
138
138
  */
139
- export declare class BarcodeResponseList {
139
+ declare class BarcodeResponseList {
140
140
  /**
141
141
  * List of barcodes which are present in image.
142
142
  */
@@ -152,7 +152,7 @@ export declare class BarcodeResponseList {
152
152
  type: string;
153
153
  }[];
154
154
  }
155
- export declare enum CodeLocation {
155
+ declare enum CodeLocation {
156
156
  Below = "Below",
157
157
  Above = "Above",
158
158
  None = "None"
@@ -160,7 +160,7 @@ export declare enum CodeLocation {
160
160
  /**
161
161
  * See Aspose.BarCode.Aspose.BarCode.BarCodeRecognition.DecodeType
162
162
  */
163
- export declare enum DecodeBarcodeType {
163
+ declare enum DecodeBarcodeType {
164
164
  MostCommonlyUsed = "MostCommonlyUsed",
165
165
  Qr = "QR",
166
166
  AustraliaPost = "AustraliaPost",
@@ -249,7 +249,7 @@ export declare enum DecodeBarcodeType {
249
249
  /**
250
250
  * See Aspose.BarCode.Generation.EncodeTypes
251
251
  */
252
- export declare enum EncodeBarcodeType {
252
+ declare enum EncodeBarcodeType {
253
253
  Qr = "QR",
254
254
  AustraliaPost = "AustraliaPost",
255
255
  AustralianPosteParcel = "AustralianPosteParcel",
@@ -327,7 +327,7 @@ export declare enum EncodeBarcodeType {
327
327
  /**
328
328
  * Data to encode in barcode
329
329
  */
330
- export declare class EncodeData {
330
+ declare class EncodeData {
331
331
  'dataType'?: EncodeDataType;
332
332
  /**
333
333
  * String represents data to encode
@@ -347,7 +347,7 @@ export declare class EncodeData {
347
347
  /**
348
348
  * Types of data can be encoded to barcode
349
349
  */
350
- export declare enum EncodeDataType {
350
+ declare enum EncodeDataType {
351
351
  StringData = "StringData",
352
352
  Base64Bytes = "Base64Bytes",
353
353
  HexBytes = "HexBytes"
@@ -355,7 +355,7 @@ export declare enum EncodeDataType {
355
355
  /**
356
356
  * Barcode generation parameters
357
357
  */
358
- export declare class GenerateParams {
358
+ declare class GenerateParams {
359
359
  'barcodeType': EncodeBarcodeType;
360
360
  'encodeData': EncodeData;
361
361
  'barcodeImageParams'?: BarcodeImageParams;
@@ -373,7 +373,7 @@ export declare class GenerateParams {
373
373
  /**
374
374
  * Subset of Aspose.Drawing.GraphicsUnit.
375
375
  */
376
- export declare enum GraphicsUnit {
376
+ declare enum GraphicsUnit {
377
377
  Pixel = "Pixel",
378
378
  Point = "Point",
379
379
  Inch = "Inch",
@@ -382,7 +382,7 @@ export declare enum GraphicsUnit {
382
382
  /**
383
383
  * Kind of image to recognize
384
384
  */
385
- export declare enum RecognitionImageKind {
385
+ declare enum RecognitionImageKind {
386
386
  Photo = "Photo",
387
387
  ScannedDocument = "ScannedDocument",
388
388
  ClearImage = "ClearImage"
@@ -390,7 +390,7 @@ export declare enum RecognitionImageKind {
390
390
  /**
391
391
  * Recognition mode.
392
392
  */
393
- export declare enum RecognitionMode {
393
+ declare enum RecognitionMode {
394
394
  Fast = "Fast",
395
395
  Normal = "Normal",
396
396
  Excellent = "Excellent"
@@ -398,7 +398,7 @@ export declare enum RecognitionMode {
398
398
  /**
399
399
  * Barcode recognize request
400
400
  */
401
- export declare class RecognizeBase64Request {
401
+ declare class RecognizeBase64Request {
402
402
  /**
403
403
  * Array of decode types to find on barcode
404
404
  */
@@ -423,7 +423,7 @@ export declare class RecognizeBase64Request {
423
423
  /**
424
424
  * Wrapper around Drawing.Point for proper specification.
425
425
  */
426
- export declare class RegionPoint {
426
+ declare class RegionPoint {
427
427
  /**
428
428
  * X-coordinate
429
429
  */
@@ -446,7 +446,7 @@ export declare class RegionPoint {
446
446
  /**
447
447
  * Scan barcode request.
448
448
  */
449
- export declare class ScanBase64Request {
449
+ declare class ScanBase64Request {
450
450
  /**
451
451
  * Barcode image bytes encoded as base-64.
452
452
  */
@@ -465,7 +465,7 @@ export declare class ScanBase64Request {
465
465
  /**
466
466
  * Generate barcode using GET request with parameters in route and query string.
467
467
  */
468
- export declare class GenerateRequestWrapper {
468
+ declare class GenerateRequestWrapper {
469
469
  /**
470
470
  * Type of barcode to generate.
471
471
  */
@@ -540,7 +540,7 @@ Default value: 0.
540
540
  /**
541
541
  * Generate barcode using POST request with parameters in body in json or xml format.
542
542
  */
543
- export declare class GenerateBodyRequestWrapper {
543
+ declare class GenerateBodyRequestWrapper {
544
544
  /**
545
545
  *
546
546
  */
@@ -553,7 +553,7 @@ export declare class GenerateBodyRequestWrapper {
553
553
  /**
554
554
  * Generate barcode using POST request with parameters in multipart form.
555
555
  */
556
- export declare class GenerateMultipartRequestWrapper {
556
+ declare class GenerateMultipartRequestWrapper {
557
557
  /**
558
558
  *
559
559
  */
@@ -612,7 +612,7 @@ export declare class GenerateMultipartRequestWrapper {
612
612
  /**
613
613
  * Recognize barcode from file on server using GET requests with parameters in route and query string.
614
614
  */
615
- export declare class RecognizeRequestWrapper {
615
+ declare class RecognizeRequestWrapper {
616
616
  /**
617
617
  * Type of barcode to recognize
618
618
  */
@@ -639,7 +639,7 @@ export declare class RecognizeRequestWrapper {
639
639
  /**
640
640
  * Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
641
641
  */
642
- export declare class RecognizeBase64RequestWrapper {
642
+ declare class RecognizeBase64RequestWrapper {
643
643
  /**
644
644
  *
645
645
  */
@@ -652,7 +652,7 @@ export declare class RecognizeBase64RequestWrapper {
652
652
  /**
653
653
  * Recognize barcode from file in request body using POST requests with parameters in multipart form.
654
654
  */
655
- export declare class RecognizeMultipartRequestWrapper {
655
+ declare class RecognizeMultipartRequestWrapper {
656
656
  /**
657
657
  *
658
658
  */
@@ -679,7 +679,7 @@ export declare class RecognizeMultipartRequestWrapper {
679
679
  /**
680
680
  * Scan barcode from file on server using GET requests with parameter in query string.
681
681
  */
682
- export declare class ScanRequestWrapper {
682
+ declare class ScanRequestWrapper {
683
683
  /**
684
684
  * Url to barcode image
685
685
  */
@@ -692,7 +692,7 @@ export declare class ScanRequestWrapper {
692
692
  /**
693
693
  * Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
694
694
  */
695
- export declare class ScanBase64RequestWrapper {
695
+ declare class ScanBase64RequestWrapper {
696
696
  /**
697
697
  *
698
698
  */
@@ -705,7 +705,7 @@ export declare class ScanBase64RequestWrapper {
705
705
  /**
706
706
  * Scan barcode from file in request body using POST requests with parameter in multipart form.
707
707
  */
708
- export declare class ScanMultipartRequestWrapper {
708
+ declare class ScanMultipartRequestWrapper {
709
709
  /**
710
710
  * Barcode image file
711
711
  */
@@ -715,3 +715,162 @@ export declare class ScanMultipartRequestWrapper {
715
715
  */
716
716
  constructor(fileBytes: Buffer);
717
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 };