aspose-barcode-cloud-node 24.12.0 → 25.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Aspose Pty Ltd
+Copyright (c) 2025 Aspose Pty Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,8 +4,13 @@
 [![Node.js CI](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-node/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-node/actions/workflows/node.js.yml)
 [![npm](https://img.shields.io/npm/v/aspose-barcode-cloud-node)](https://www.npmjs.com/package/aspose-barcode-cloud-node)
 
-+ API version: 3.0
-+ Package version: 24.12.0
++ API version: 4.0
++ Package version: 25.1.0
+
+## SDK and API Version Compatibility:
+
+- SDK Version 25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
+- SDK Version 24.12 and Earlier: These versions are compatible with API Version v3.0.
 
 ## Demo applications
 
@@ -49,12 +54,11 @@ const config = new Barcode.Configuration(
 );
 
 async function generateBarcode(api) {
-    const request = new Barcode.GetBarcodeGenerateRequest(
-        Barcode.EncodeBarcodeType.QR,
+    const request = new Barcode.GenerateRequestWrapper(
+        Barcode.EncodeBarcodeType.Qr, 
         'Aspose.BarCode for Cloud Sample');
-        request.textLocation = Barcode.CodeLocation.None;
 
-    const oneBarcode = await api.getBarcodeGenerate(request);
+    const oneBarcode = await api.generate(request);
 
     const fileName = 'QR.png'
     fs.writeFileSync(fileName, oneBarcode.body);
@@ -63,30 +67,30 @@ async function generateBarcode(api) {
 }
 
 async function scanBarcode(api, fileName) {
-    const request = new Barcode.ScanBarcodeRequest(fs.readFileSync(fileName));
-    request.decodeTypes = [Barcode.DecodeBarcodeType.QR];
 
-    const result = await api.scanBarcode(request);
+    const scanRequest = new Barcode.ScanMultipartRequestWrapper(fs.readFileSync(fileName));
+    const result = await api.scanMultipart(scanRequest);
 
     return result.body.barcodes;
 }
 
-const api = new Barcode.BarcodeApi(config);
+const genApi = new Barcode.GenerateApi(config);
+const scanApi = new Barcode.ScanApi(config);
 
 console.log('Generating barcode...');
-generateBarcode(api)
+generateBarcode(genApi)
     .then(fileName => {
         console.log('Barcode saved to ' + fileName);
 
         console.log('Trying to recognize barcode...');
-        scanBarcode(api, fileName)
+        scanBarcode(scanApi, fileName)
             .then(barcodes => {
                 console.log('Recognized barcodes are:');
                 console.log(JSON.stringify(barcodes, null, 2));
             });
     })
     .catch(err => {
-        console.error(JSON.stringify(err, null, 2));
+        console.error("Error: " + JSON.stringify(err, null, 2));
         process.exitCode = 1;
     });
 
@@ -109,30 +113,17 @@ All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed und
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *<https://api.aspose.cloud/v3.0/>*
+All URIs are relative to *<https://api.aspose.cloud/v4.0/>*
 
 Class | Method | HTTP request | Description
 ----- | ------ | ------------ | -----------
-BarcodeApi | [**getBarcodeGenerate**](docs/index.md#getbarcodegenerate) | **GET** /barcode/generate | Generate barcode.
-BarcodeApi | [**getBarcodeRecognize**](docs/index.md#getbarcoderecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
-BarcodeApi | [**postBarcodeRecognizeFromUrlOrContent**](docs/index.md#postbarcoderecognizefromurlorcontent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \&quot;application/octet-stream\&quot;. An image can also be passed as a form field.
-BarcodeApi | [**postGenerateMultiple**](docs/index.md#postgeneratemultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
-BarcodeApi | [**putBarcodeGenerateFile**](docs/index.md#putbarcodegeneratefile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
-BarcodeApi | [**putBarcodeRecognizeFromBody**](docs/index.md#putbarcoderecognizefrombody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
-BarcodeApi | [**putGenerateMultiple**](docs/index.md#putgeneratemultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server
-BarcodeApi | [**scanBarcode**](docs/index.md#scanbarcode) | **POST** /barcode/scan | Quickly scan a barcode from an image.
-FileApi | [**copyFile**](docs/index.md#copyfile) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file
-FileApi | [**deleteFile**](docs/index.md#deletefile) | **DELETE** /barcode/storage/file/{path} | Delete file
-FileApi | [**downloadFile**](docs/index.md#downloadfile) | **GET** /barcode/storage/file/{path} | Download file
-FileApi | [**moveFile**](docs/index.md#movefile) | **PUT** /barcode/storage/file/move/{srcPath} | Move file
-FileApi | [**uploadFile**](docs/index.md#uploadfile) | **PUT** /barcode/storage/file/{path} | Upload file
-FolderApi | [**copyFolder**](docs/index.md#copyfolder) | **PUT** /barcode/storage/folder/copy/{srcPath} | Copy folder
-FolderApi | [**createFolder**](docs/index.md#createfolder) | **PUT** /barcode/storage/folder/{path} | Create the folder
-FolderApi | [**deleteFolder**](docs/index.md#deletefolder) | **DELETE** /barcode/storage/folder/{path} | Delete folder
-FolderApi | [**getFilesList**](docs/index.md#getfileslist) | **GET** /barcode/storage/folder/{path} | Get all files and folders within a folder
-FolderApi | [**moveFolder**](docs/index.md#movefolder) | **PUT** /barcode/storage/folder/move/{srcPath} | Move folder
-StorageApi | [**getDiscUsage**](docs/index.md#getdiscusage) | **GET** /barcode/storage/disc | Get disc usage
-StorageApi | [**getFileVersions**](docs/index.md#getfileversions) | **GET** /barcode/storage/version/{path} | Get file versions
-StorageApi | [**objectExists**](docs/index.md#objectexists) | **GET** /barcode/storage/exist/{path} | Check if file or folder exists
-StorageApi | [**storageExists**](docs/index.md#storageexists) | **GET** /barcode/storage/{storageName}/exist | Check if storage exists
+GenerateApi | [**generate**](docs/index.md#generate) | **GET** /barcode/generate/{barcodeType} | Generate barcode using GET request with parameters in route and query string.
+GenerateApi | [**generateBody**](docs/index.md#generatebody) | **POST** /barcode/generate-body | Generate barcode using POST request with parameters in body in json or xml format.
+GenerateApi | [**generateMultipart**](docs/index.md#generatemultipart) | **POST** /barcode/generate-multipart | Generate barcode using POST request with parameters in multipart form.
+RecognizeApi | [**recognize**](docs/index.md#recognize) | **GET** /barcode/recognize | Recognize barcode from file on server using GET requests with parameters in route and query string.
+RecognizeApi | [**recognizeBase64**](docs/index.md#recognizebase64) | **POST** /barcode/recognize-body | Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
+RecognizeApi | [**recognizeMultipart**](docs/index.md#recognizemultipart) | **POST** /barcode/recognize-multipart | Recognize barcode from file in request body using POST requests with parameters in multipart form.
+ScanApi | [**scan**](docs/index.md#scan) | **GET** /barcode/scan | Scan barcode from file on server using GET requests with parameter in query string.
+ScanApi | [**scanBase64**](docs/index.md#scanbase64) | **POST** /barcode/scan-body | Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
+ScanApi | [**scanMultipart**](docs/index.md#scanmultipart) | **POST** /barcode/scan-multipart | Scan barcode from file in request body using POST requests with parameter in multipart form.
 

package/dist/Configuration.d.ts

@@ -1,6 +1,6 @@
 import { Authentication } from './Authentication';
 export declare enum ApiVersion {
-    v3 = "v3.0"
+    v4 = "v4.0"
 }
 export declare class Configuration {
     /**

package/dist/api.d.ts

@@ -1,227 +1,104 @@
 import { Configuration } from './Configuration';
 import { HttpResponse } from './httpClient';
-import { BarcodeResponseList, DiscUsage, FileVersions, FilesList, FilesUploadResult, ObjectExist, ResultImageInfo, StorageExist } from './models';
-import { GetBarcodeGenerateRequest, GetBarcodeRecognizeRequest, PostBarcodeRecognizeFromUrlOrContentRequest, PostGenerateMultipleRequest, PutBarcodeGenerateFileRequest, PutBarcodeRecognizeFromBodyRequest, PutGenerateMultipleRequest, ScanBarcodeRequest, CopyFileRequest, DeleteFileRequest, DownloadFileRequest, MoveFileRequest, UploadFileRequest, CopyFolderRequest, CreateFolderRequest, DeleteFolderRequest, GetFilesListRequest, MoveFolderRequest, GetDiscUsageRequest, GetFileVersionsRequest, ObjectExistsRequest, StorageExistsRequest } from './models';
+import { BarcodeResponseList } from './models';
+import { GenerateRequestWrapper, GenerateBodyRequestWrapper, GenerateMultipartRequestWrapper, RecognizeRequestWrapper, RecognizeBase64RequestWrapper, RecognizeMultipartRequestWrapper, ScanRequestWrapper, ScanBase64RequestWrapper, ScanMultipartRequestWrapper } from './models';
 export * from './models';
-export declare class BarcodeApi {
+export declare class GenerateApi {
     protected defaultHeaders: any;
     protected _configuration: Configuration;
     private _client;
     constructor(configuration: Configuration);
     /**
      *
-     * @summary Generate barcode.
-     * @param request GetBarcodeGenerateRequest
+     * @summary Generate barcode using GET request with parameters in route and query string.
+     * @param request GenerateRequestWrapper
      */
-    getBarcodeGenerate(request: GetBarcodeGenerateRequest): Promise<{
+    generate(request: GenerateRequestWrapper): Promise<{
         response: HttpResponse;
         body: Buffer;
     }>;
     /**
      *
-     * @summary Recognize barcode from a file on server.
-     * @param request GetBarcodeRecognizeRequest
+     * @summary Generate barcode using POST request with parameters in body in json or xml format.
+     * @param request GenerateBodyRequestWrapper
      */
-    getBarcodeRecognize(request: GetBarcodeRecognizeRequest): Promise<{
-        response: HttpResponse;
-        body: BarcodeResponseList;
-    }>;
-    /**
-     *
-     * @summary 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.
-     * @param request PostBarcodeRecognizeFromUrlOrContentRequest
-     */
-    postBarcodeRecognizeFromUrlOrContent(request: PostBarcodeRecognizeFromUrlOrContentRequest): Promise<{
-        response: HttpResponse;
-        body: BarcodeResponseList;
-    }>;
-    /**
-     *
-     * @summary Generate multiple barcodes and return in response stream
-     * @param request PostGenerateMultipleRequest
-     */
-    postGenerateMultiple(request: PostGenerateMultipleRequest): Promise<{
+    generateBody(request: GenerateBodyRequestWrapper): Promise<{
         response: HttpResponse;
         body: Buffer;
     }>;
     /**
      *
-     * @summary Generate barcode and save on server (from query params or from file with json or xml content)
-     * @param request PutBarcodeGenerateFileRequest
-     */
-    putBarcodeGenerateFile(request: PutBarcodeGenerateFileRequest): Promise<{
-        response: HttpResponse;
-        body: ResultImageInfo;
-    }>;
-    /**
-     *
-     * @summary Recognition of a barcode from file on server with parameters in body.
-     * @param request PutBarcodeRecognizeFromBodyRequest
-     */
-    putBarcodeRecognizeFromBody(request: PutBarcodeRecognizeFromBodyRequest): Promise<{
-        response: HttpResponse;
-        body: BarcodeResponseList;
-    }>;
-    /**
-     *
-     * @summary Generate image with multiple barcodes and put new file on server
-     * @param request PutGenerateMultipleRequest
-     */
-    putGenerateMultiple(request: PutGenerateMultipleRequest): Promise<{
-        response: HttpResponse;
-        body: ResultImageInfo;
-    }>;
-    /**
-     *
-     * @summary Quickly scan a barcode from an image.
-     * @param request ScanBarcodeRequest
-     */
-    scanBarcode(request: ScanBarcodeRequest): Promise<{
-        response: HttpResponse;
-        body: BarcodeResponseList;
-    }>;
-}
-export declare class FileApi {
-    protected defaultHeaders: any;
-    protected _configuration: Configuration;
-    private _client;
-    constructor(configuration: Configuration);
-    /**
-     *
-     * @summary Copy file
-     * @param request CopyFileRequest
-     */
-    copyFile(request: CopyFileRequest): Promise<{
-        response: HttpResponse;
-        body?: any;
-    }>;
-    /**
-     *
-     * @summary Delete file
-     * @param request DeleteFileRequest
-     */
-    deleteFile(request: DeleteFileRequest): Promise<{
-        response: HttpResponse;
-        body?: any;
-    }>;
-    /**
-     *
-     * @summary Download file
-     * @param request DownloadFileRequest
+     * @summary Generate barcode using POST request with parameters in multipart form.
+     * @param request GenerateMultipartRequestWrapper
      */
-    downloadFile(request: DownloadFileRequest): Promise<{
+    generateMultipart(request: GenerateMultipartRequestWrapper): Promise<{
         response: HttpResponse;
         body: Buffer;
     }>;
-    /**
-     *
-     * @summary Move file
-     * @param request MoveFileRequest
-     */
-    moveFile(request: MoveFileRequest): Promise<{
-        response: HttpResponse;
-        body?: any;
-    }>;
-    /**
-     *
-     * @summary Upload file
-     * @param request UploadFileRequest
-     */
-    uploadFile(request: UploadFileRequest): Promise<{
-        response: HttpResponse;
-        body: FilesUploadResult;
-    }>;
 }
-export declare class FolderApi {
+export declare class RecognizeApi {
     protected defaultHeaders: any;
     protected _configuration: Configuration;
     private _client;
     constructor(configuration: Configuration);
     /**
      *
-     * @summary Copy folder
-     * @param request CopyFolderRequest
-     */
-    copyFolder(request: CopyFolderRequest): Promise<{
-        response: HttpResponse;
-        body?: any;
-    }>;
-    /**
-     *
-     * @summary Create the folder
-     * @param request CreateFolderRequest
-     */
-    createFolder(request: CreateFolderRequest): Promise<{
-        response: HttpResponse;
-        body?: any;
-    }>;
-    /**
-     *
-     * @summary Delete folder
-     * @param request DeleteFolderRequest
+     * @summary Recognize barcode from file on server using GET requests with parameters in route and query string.
+     * @param request RecognizeRequestWrapper
      */
-    deleteFolder(request: DeleteFolderRequest): Promise<{
+    recognize(request: RecognizeRequestWrapper): Promise<{
         response: HttpResponse;
-        body?: any;
+        body: BarcodeResponseList;
     }>;
     /**
      *
-     * @summary Get all files and folders within a folder
-     * @param request GetFilesListRequest
+     * @summary Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
+     * @param request RecognizeBase64RequestWrapper
      */
-    getFilesList(request: GetFilesListRequest): Promise<{
+    recognizeBase64(request: RecognizeBase64RequestWrapper): Promise<{
         response: HttpResponse;
-        body: FilesList;
+        body: BarcodeResponseList;
     }>;
     /**
      *
-     * @summary Move folder
-     * @param request MoveFolderRequest
+     * @summary Recognize barcode from file in request body using POST requests with parameters in multipart form.
+     * @param request RecognizeMultipartRequestWrapper
      */
-    moveFolder(request: MoveFolderRequest): Promise<{
+    recognizeMultipart(request: RecognizeMultipartRequestWrapper): Promise<{
         response: HttpResponse;
-        body?: any;
+        body: BarcodeResponseList;
     }>;
 }
-export declare class StorageApi {
+export declare class ScanApi {
     protected defaultHeaders: any;
     protected _configuration: Configuration;
     private _client;
     constructor(configuration: Configuration);
     /**
      *
-     * @summary Get disc usage
-     * @param request GetDiscUsageRequest
-     */
-    getDiscUsage(request: GetDiscUsageRequest): Promise<{
-        response: HttpResponse;
-        body: DiscUsage;
-    }>;
-    /**
-     *
-     * @summary Get file versions
-     * @param request GetFileVersionsRequest
+     * @summary Scan barcode from file on server using GET requests with parameter in query string.
+     * @param request ScanRequestWrapper
      */
-    getFileVersions(request: GetFileVersionsRequest): Promise<{
+    scan(request: ScanRequestWrapper): Promise<{
         response: HttpResponse;
-        body: FileVersions;
+        body: BarcodeResponseList;
     }>;
     /**
      *
-     * @summary Check if file or folder exists
-     * @param request ObjectExistsRequest
+     * @summary Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
+     * @param request ScanBase64RequestWrapper
      */
-    objectExists(request: ObjectExistsRequest): Promise<{
+    scanBase64(request: ScanBase64RequestWrapper): Promise<{
         response: HttpResponse;
-        body: ObjectExist;
+        body: BarcodeResponseList;
     }>;
     /**
      *
-     * @summary Check if storage exists
-     * @param request StorageExistsRequest
+     * @summary Scan barcode from file in request body using POST requests with parameter in multipart form.
+     * @param request ScanMultipartRequestWrapper
      */
-    storageExists(request: StorageExistsRequest): Promise<{
+    scanMultipart(request: ScanMultipartRequestWrapper): Promise<{
         response: HttpResponse;
-        body: StorageExist;
+        body: BarcodeResponseList;
     }>;
 }