aspose-barcode-cloud-node 25.1.0 → 25.3.0

package/README.md

@@ -5,7 +5,7 @@
 [![npm](https://img.shields.io/npm/v/aspose-barcode-cloud-node)](https://www.npmjs.com/package/aspose-barcode-cloud-node)
 
 + API version: 4.0
-+ Package version: 25.1.0
++ Package version: 25.3.0
 
 ## SDK and API Version Compatibility:
 

package/dist/{models.d.ts → index.d.mts}

@@ -1,7 +1,7 @@
 /**
  * Api Error.
  */
-export declare class ApiError {
+declare class ApiError {
     /**
      * Gets or sets api error code.
      */
@@ -33,7 +33,7 @@ export declare class ApiError {
 /**
  * ApiError Response
  */
-export declare class ApiErrorResponse {
+declare class ApiErrorResponse {
     /**
      * Gets or sets request Id.
      */
@@ -53,7 +53,7 @@ export declare class ApiErrorResponse {
 /**
  * Specifies the file format of the image.
  */
-export declare enum BarcodeImageFormat {
+declare enum BarcodeImageFormat {
     Png = "Png",
     Jpeg = "Jpeg",
     Svg = "Svg",
@@ -63,7 +63,7 @@ export declare enum BarcodeImageFormat {
 /**
  * Barcode image optional parameters
  */
-export declare class BarcodeImageParams {
+declare class BarcodeImageParams {
     'imageFormat'?: BarcodeImageFormat;
     'textLocation'?: CodeLocation;
     /**
@@ -105,7 +105,7 @@ export declare class BarcodeImageParams {
 /**
  * Represents information about barcode.
  */
-export declare class BarcodeResponse {
+declare class BarcodeResponse {
     /**
      * Barcode data.
      */
@@ -136,7 +136,7 @@ export declare class BarcodeResponse {
 /**
  * Represents information about barcode list.
  */
-export declare class BarcodeResponseList {
+declare class BarcodeResponseList {
     /**
      * List of barcodes which are present in image.
      */
@@ -152,7 +152,7 @@ export declare class BarcodeResponseList {
         type: string;
     }[];
 }
-export declare enum CodeLocation {
+declare enum CodeLocation {
     Below = "Below",
     Above = "Above",
     None = "None"
@@ -160,7 +160,7 @@ export declare enum CodeLocation {
 /**
  * See Aspose.BarCode.Aspose.BarCode.BarCodeRecognition.DecodeType
  */
-export declare enum DecodeBarcodeType {
+declare enum DecodeBarcodeType {
     MostCommonlyUsed = "MostCommonlyUsed",
     Qr = "QR",
     AustraliaPost = "AustraliaPost",
@@ -249,7 +249,7 @@ export declare enum DecodeBarcodeType {
 /**
  * See Aspose.BarCode.Generation.EncodeTypes
  */
-export declare enum EncodeBarcodeType {
+declare enum EncodeBarcodeType {
     Qr = "QR",
     AustraliaPost = "AustraliaPost",
     AustralianPosteParcel = "AustralianPosteParcel",
@@ -327,7 +327,7 @@ export declare enum EncodeBarcodeType {
 /**
  * Data to encode in barcode
  */
-export declare class EncodeData {
+declare class EncodeData {
     'dataType'?: EncodeDataType;
     /**
      * String represents data to encode
@@ -347,7 +347,7 @@ export declare class EncodeData {
 /**
  * Types of data can be encoded to barcode
  */
-export declare enum EncodeDataType {
+declare enum EncodeDataType {
     StringData = "StringData",
     Base64Bytes = "Base64Bytes",
     HexBytes = "HexBytes"
@@ -355,7 +355,7 @@ export declare enum EncodeDataType {
 /**
  * Barcode generation parameters
  */
-export declare class GenerateParams {
+declare class GenerateParams {
     'barcodeType': EncodeBarcodeType;
     'encodeData': EncodeData;
     'barcodeImageParams'?: BarcodeImageParams;
@@ -373,7 +373,7 @@ export declare class GenerateParams {
 /**
  * Subset of Aspose.Drawing.GraphicsUnit.
  */
-export declare enum GraphicsUnit {
+declare enum GraphicsUnit {
     Pixel = "Pixel",
     Point = "Point",
     Inch = "Inch",
@@ -382,7 +382,7 @@ export declare enum GraphicsUnit {
 /**
  * Kind of image to recognize
  */
-export declare enum RecognitionImageKind {
+declare enum RecognitionImageKind {
     Photo = "Photo",
     ScannedDocument = "ScannedDocument",
     ClearImage = "ClearImage"
@@ -390,7 +390,7 @@ export declare enum RecognitionImageKind {
 /**
  * Recognition mode.
  */
-export declare enum RecognitionMode {
+declare enum RecognitionMode {
     Fast = "Fast",
     Normal = "Normal",
     Excellent = "Excellent"
@@ -398,7 +398,7 @@ export declare enum RecognitionMode {
 /**
  * Barcode recognize request
  */
-export declare class RecognizeBase64Request {
+declare class RecognizeBase64Request {
     /**
      * Array of decode types to find on barcode
      */
@@ -423,7 +423,7 @@ export declare class RecognizeBase64Request {
 /**
  * Wrapper around Drawing.Point for proper specification.
  */
-export declare class RegionPoint {
+declare class RegionPoint {
     /**
      * X-coordinate
      */
@@ -446,7 +446,7 @@ export declare class RegionPoint {
 /**
  * Scan barcode request.
  */
-export declare class ScanBase64Request {
+declare class ScanBase64Request {
     /**
      * Barcode image bytes encoded as base-64.
      */
@@ -465,7 +465,7 @@ export declare class ScanBase64Request {
 /**
  * Generate barcode using GET request with parameters in route and query string.
  */
-export declare class GenerateRequestWrapper {
+declare class GenerateRequestWrapper {
     /**
      * Type of barcode to generate.
      */
@@ -486,7 +486,7 @@ Default value: png
     'imageFormat'?: BarcodeImageFormat;
     /**
      * Specify the displaying Text Location, set to CodeLocation.None to hide CodeText.
-Default value: CodeLocation.Below.
+Default value: Depends on BarcodeType. CodeLocation.Below for 1D Barcodes. CodeLocation.None for 2D Barcodes.
      */
     'textLocation'?: CodeLocation;
     /**
@@ -540,7 +540,7 @@ Default value: 0.
 /**
  * Generate barcode using POST request with parameters in body in json or xml format.
  */
-export declare class GenerateBodyRequestWrapper {
+declare class GenerateBodyRequestWrapper {
     /**
      *
      */
@@ -553,7 +553,7 @@ export declare class GenerateBodyRequestWrapper {
 /**
  * Generate barcode using POST request with parameters in multipart form.
  */
-export declare class GenerateMultipartRequestWrapper {
+declare class GenerateMultipartRequestWrapper {
     /**
      *
      */
@@ -612,7 +612,7 @@ export declare class GenerateMultipartRequestWrapper {
 /**
  * Recognize barcode from file on server using GET requests with parameters in route and query string.
  */
-export declare class RecognizeRequestWrapper {
+declare class RecognizeRequestWrapper {
     /**
      * Type of barcode to recognize
      */
@@ -639,7 +639,7 @@ export declare class RecognizeRequestWrapper {
 /**
  * Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
  */
-export declare class RecognizeBase64RequestWrapper {
+declare class RecognizeBase64RequestWrapper {
     /**
      *
      */
@@ -652,7 +652,7 @@ export declare class RecognizeBase64RequestWrapper {
 /**
  * Recognize barcode from file in request body using POST requests with parameters in multipart form.
  */
-export declare class RecognizeMultipartRequestWrapper {
+declare class RecognizeMultipartRequestWrapper {
     /**
      *
      */
@@ -679,7 +679,7 @@ export declare class RecognizeMultipartRequestWrapper {
 /**
  * Scan barcode from file on server using GET requests with parameter in query string.
  */
-export declare class ScanRequestWrapper {
+declare class ScanRequestWrapper {
     /**
      * Url to barcode image
      */
@@ -692,7 +692,7 @@ export declare class ScanRequestWrapper {
 /**
  * Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
  */
-export declare class ScanBase64RequestWrapper {
+declare class ScanBase64RequestWrapper {
     /**
      *
      */
@@ -705,7 +705,7 @@ export declare class ScanBase64RequestWrapper {
 /**
  * Scan barcode from file in request body using POST requests with parameter in multipart form.
  */
-export declare class ScanMultipartRequestWrapper {
+declare class ScanMultipartRequestWrapper {
     /**
      * Barcode image file
      */
@@ -715,3 +715,162 @@ export declare class ScanMultipartRequestWrapper {
      */
     constructor(fileBytes: Buffer);
 }
+
+interface StringKeyWithStringValue {
+    [key: string]: string;
+}
+interface HttpOptions {
+    uri: string;
+    body?: any;
+    encoding?: BufferEncoding | null;
+    form?: StringKeyWithStringValue;
+    headers?: StringKeyWithStringValue;
+    json?: boolean;
+    method?: string;
+    qs?: StringKeyWithStringValue;
+}
+interface HttpResponse {
+    statusCode: number;
+    statusMessage: string;
+    headers: NodeJS.Dict<string | string[]>;
+    body: any;
+}
+
+interface Authentication {
+    /**
+     * Apply authentication settings to header and query params.
+     */
+    applyToRequestAsync(requestOptions: HttpOptions): Promise<void>;
+}
+
+declare enum ApiVersion {
+    v4 = "v4.0"
+}
+declare class Configuration {
+    /**
+     * Authentication type.
+     */
+    authentication: Authentication;
+    /**
+     * Client Id.
+     */
+    clientId: string;
+    /**
+     * Client Secret.
+     */
+    clientSecret: string;
+    /**
+     * Base Url.
+     */
+    baseUrl: string;
+    readonly version: ApiVersion;
+    readonly accessToken: string;
+    readonly tokenUrl: string;
+    constructor(clientId: string, clientSecret: string, baseUrl?: string, accessToken?: string, tokenUrl?: string);
+    /**
+     * Returns api base url
+     */
+    getApiBaseUrl(): string;
+}
+
+declare class GenerateApi {
+    protected defaultHeaders: any;
+    protected _configuration: Configuration;
+    private _client;
+    constructor(configuration: Configuration);
+    /**
+     *
+     * @summary Generate barcode using GET request with parameters in route and query string.
+     * @param request GenerateRequestWrapper
+     */
+    generate(request: GenerateRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: Buffer;
+    }>;
+    /**
+     *
+     * @summary Generate barcode using POST request with parameters in body in json or xml format.
+     * @param request GenerateBodyRequestWrapper
+     */
+    generateBody(request: GenerateBodyRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: Buffer;
+    }>;
+    /**
+     *
+     * @summary Generate barcode using POST request with parameters in multipart form.
+     * @param request GenerateMultipartRequestWrapper
+     */
+    generateMultipart(request: GenerateMultipartRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: Buffer;
+    }>;
+}
+declare class RecognizeApi {
+    protected defaultHeaders: any;
+    protected _configuration: Configuration;
+    private _client;
+    constructor(configuration: Configuration);
+    /**
+     *
+     * @summary Recognize barcode from file on server using GET requests with parameters in route and query string.
+     * @param request RecognizeRequestWrapper
+     */
+    recognize(request: RecognizeRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: BarcodeResponseList;
+    }>;
+    /**
+     *
+     * @summary Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
+     * @param request RecognizeBase64RequestWrapper
+     */
+    recognizeBase64(request: RecognizeBase64RequestWrapper): Promise<{
+        response: HttpResponse;
+        body: BarcodeResponseList;
+    }>;
+    /**
+     *
+     * @summary Recognize barcode from file in request body using POST requests with parameters in multipart form.
+     * @param request RecognizeMultipartRequestWrapper
+     */
+    recognizeMultipart(request: RecognizeMultipartRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: BarcodeResponseList;
+    }>;
+}
+declare class ScanApi {
+    protected defaultHeaders: any;
+    protected _configuration: Configuration;
+    private _client;
+    constructor(configuration: Configuration);
+    /**
+     *
+     * @summary Scan barcode from file on server using GET requests with parameter in query string.
+     * @param request ScanRequestWrapper
+     */
+    scan(request: ScanRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: BarcodeResponseList;
+    }>;
+    /**
+     *
+     * @summary Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
+     * @param request ScanBase64RequestWrapper
+     */
+    scanBase64(request: ScanBase64RequestWrapper): Promise<{
+        response: HttpResponse;
+        body: BarcodeResponseList;
+    }>;
+    /**
+     *
+     * @summary Scan barcode from file in request body using POST requests with parameter in multipart form.
+     * @param request ScanMultipartRequestWrapper
+     */
+    scanMultipart(request: ScanMultipartRequestWrapper): Promise<{
+        response: HttpResponse;
+        body: BarcodeResponseList;
+    }>;
+}
+
+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 };