Release Aspose.Cells Cloud SDK 20.4

Author: roywangaspose

README.md

@@ -1,78 +1,70 @@
-# Aspose.Cells Cloud SDK for NodeJS 
+Node.js Cloud SDK wraps Aspose.Cells REST API so you could seamlessly integrate Excel® file generation, manipulation, conversion & processing features into your own Node.js applications.
 
-- API version: 3.0
-- SDK version: 20.2
+# Process Excel® Files in the Cloud with Node.js
 
-This repository contains Aspose.Cells Cloud SDK for NodeJS source code. This SDK allows you to work with Aspose.Cells Cloud REST APIs in your NodeJS applications quickly and easily, with zero initial cost.
+[Aspose.Cells Cloud SDK for Node.js](https://products.aspose.cloud/cells/nodejs) allows developers to create, edit, process & convert Excel spreadsheets in the Cloud. The Excel Cloud SDK gets its functionality from Aspose.Cells Cloud API, allowing your Node.js apps to work with all Excel file formats and features including worksheet & cell management, conditional formatting, auto-filters, auto-shapes, charts, OleObjects, page breaks, ListObjects, Pivot Tables, charts and much more. 
 
+## Excel File Processing Features
 
+- Create Excel files from scratch using the API. 
+- Load, process & convert spreadsheets via Cloud SDK.
+- Add, update or delete worksheet, charts, pictures, shapes, hyperlinks & validations.
+- Add or remove cells area for conditional formatting from Excel worksheets.
+- Insert or delete, horizontal or vertical page breaks.
+- Add ListObject or convert ListObjects to a range of cells.
+- Summarize data with Pivot Tables & charts.
+- Apply custom criteria to list filters of various types.
+- Get, update, show or hide chart legend & titles.
+- Manipulate page setup, header & footer.
+- Create, update, fetch or delete document properties.
+- Fetch the required shape from worksheet.
+- Leverage the Power of Pivot Tables & ranges.
 
-# Key Features
+## Features & Enhancements in Version 20.4
 
-- Conversion between various document-related formats (20+ formats supported), including PDF<->Excel conversion
+- Support to export area or page of sheet to JPEG.
+- Support to add background for workbook.
+- Enhancement for splitting workbook.
+- Enhancement for create workbook.
 
-- Splitting Excel documents
 
-- Accessing Excel document metadata and statistics
 
-- Find and replace
+## Read & Write Spreadsheet Formats
 
-- Watermarks and protection
+**Microsoft Excel:** XLS, XLSX, XLSB, XLSM, XLT, XLTX, XLTM
+**OpenOffice:** ODS
+**SpreadsheetML:** XML
+**Text:** CSV, TSV, TXT (TabDelimited)
+**Web:** HTML, MHTML
+**PDF**
 
-- Full read & write access to Cells Object Model, including workbook, worksheet, cell, shapes, tables, list object ,ole Object,headers/footers and many others
+## Save Spreadsheet As
 
-  
+DIF, HTML, MHTML,PNG,JPG, TIFF, XPS, SVG, MD (Markdown), ODS ,xlsx,xls,xlsb, PDF,XML,TXT,CSV
 
-See [API Reference](https://apireference.aspose.cloud/cells/) for full API specification.
+## Read File Formats
 
+SXC, FODS
 
+## Storage API Support
 
-# Storage API support
-
-#### Since version 19.9 SDK includes support of storage operations for better user experience and unification, so now there's no need to use 2 different SDKs!
+Since version 19.9, SDK includes support of storage operations for better user experience and unification, so now there's no need to use 2 different SDKs!
 
 It gives you an ability to:
 
-- Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default)
-- Create, copy, move and delete folders
-- Copy and move files and folders accross separate storages in scope of a single operation
-- Check if certain file, folder or storage exists
-
-# Licensing
-
-All Aspose.Cells Cloud SDKs are licensed under [MIT License](https://github.com/aspose-cells-cloud/aspose-cells-cloud-node/blob/master/LICENSE).
-
-
-
-# How to use the SDK?
-
-The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [nmpjs distribution](https://www.npmjs.com/package/asposecellscloud) (recommended).  For more details, please visit our [documentation website](https://docs.aspose.cloud/display/cellscloud/Available+SDKs).
-
- 
-
-### Prerequisites
-
- To use Aspose.Cells Cloud  SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
-
- 
-
-### Installation
+- Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default).
+- Create, copy, move and delete folders.
+- Copy and move files and folders across separate storages in scope of a single operation.
+- Check if certain file, folder or storage exists.
 
-#### Install Aspose.Cells-Cloud via NPM
+## Getting Started with Aspose.Cells Cloud SDK for Node.js
 
-From the command line:
+Firstly, create an account at [Aspose for Cloud](https://dashboard.aspose.cloud/#/apps) to get your application information and free quota to use the API. Now execute `npm install asposecellscloud --save` from the command line to install Aspose.Cells Cloud SDK for Node.js via NPM.
 
-```
-npm install asposecellscloud --save
-```
-
-
-
-### Sample usage
-
- 
+The complete source code is available at [GitHub Repository](https://github.com/aspose-cells-cloud/aspose-cells-cloud-node).
 
-```
+## Convert Excel to PDF via Node.js
+```js
 var fs = require('fs');
 var path = require('path');
 var assert = require('assert');
@@ -102,23 +94,52 @@ describe('cellsWorkbookPutConvertWorkbook', function() {
 });
 ```
 
-# Tests
+## Hide Excel Columns via Node.js
+
+```js
+const { CellsApi, Cells_PostHideWorksheetColumnsRequest } = require("asposecellscloud");
+
+AppSid = ""
+AppKey = ""
+cellsApi = new CellsApi(AppSid, AppKey);
+filename = "Book1.xlsx"
 
-[Tests](https://github.com/aspose-cells-cloud/aspose-cells-cloud-php/tree/master/test/Api) contain various examples of using the SDK.
+var req = new Cells_PostHideWorksheetColumnsRequest();
+req.name = filename;
+req.sheetName = "Sheet1";
+req.startColumn = 1;
+req.totalColumns = 2;
+req.folder = "";
 
+return cellsApi.cellsPostHideWorksheetColumns(req)
+    .then((result) => {
+        console.log(result)
+    });
+```
 
+## Merge Worksheets in the Cloud via Node.js
 
-# Contact Us
+```js
+const { CellsApi, Cells_PostWorksheetMergeRequest } = require("asposecellscloud");
 
-Your feedback is very important to us. Please feel free to contact via
+AppSid = ""
+AppKey = ""
+cellsApi = new CellsApi(AppSid, AppKey);
+filename = "Book1.xlsx"
 
-- [**Free Support Forum**](https://forum.aspose.cloud/c/cells)
-- [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
+var req = new Cells_PostWorksheetMergeRequest();
+req.name = filename;
+req.sheetName = "Sheet1";
+req.startRow = 1;
+req.startColumn = 1;
+req.totalRows = 4;
+req.totalColumns = 4;
+req.folder = "";
 
-# Resources
+return cellsApi.cellsPostWorksheetMerge(req)
+  .then((result) => {
+    console.log(result)
+  });
+```
 
-- [**Web API reference**](https://apireference.aspose.cloud/cells/)
-- [**Website**](https://www.aspose.cloud)
-- [**Product Home**](https://products.aspose.cloud/cells)
-- [**Documentation**](https://docs.aspose.cloud/display/cellscloud/Home)
-- [**Blog**](https://blog.aspose.cloud/category/cells/)
+[Product Page](https://products.aspose.cloud/cells/nodejs) | [Documentation](https://docs.aspose.cloud/display/cellscloud/Home) | [Live Demo](https://products.aspose.app/cells/family) | [API Reference](https://apireference.aspose.cloud/cells/) | [Code Samples](https://github.com/aspose-cells-cloud/aspose-cells-cloud-node) | [Blog](https://blog.aspose.cloud/category/cells/) | [Free Support](https://forum.aspose.cloud/c/cells) | [Free Trial](https://dashboard.aspose.cloud/#/apps)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "asposecellscloud",
-  "version": "20.2.0",
-  "description": "Aspose.Cells Cloud SDK for Node.js",
+  "version": "20.4.0",
+  "description": "Node.js Cloud SDK wraps Aspose.Cells REST API so you could seamlessly integrate Excel® file generation, manipulation, conversion & processing features into your own Node.js applications.",
   "keywords": [
     "Aspose",
     "Cloud",

src/api.ts

@@ -47,8 +47,8 @@ export class CellsApi {
      * @param baseUrl Base api Url.
      * @param debugMode A value indicating whether debug mode. In debug mode all requests and responses are logged to console.
      */
-    constructor(appSID: string, appKey: string, apiVersion?: string, baseUrl?: string, debugMode?: boolean) {
-        this.configuration = new Configuration(appSID, appKey,apiVersion, baseUrl, debugMode);
+    constructor(appSID: string, appKey: string, baseUrl?: string, debugMode?: boolean) {
+        this.configuration = new Configuration(appSID, appKey, baseUrl, debugMode);
     }
 
     /**
@@ -6038,6 +6038,11 @@ export class CellsApi {
         if (requestObj.cellName === null || requestObj.cellName === undefined) {
             throw new Error('Required parameter "requestObj.cellName" was null or undefined when calling cellsPostSetCellHtmlString.');
         }
+
+        // verify required parameter 'requestObj.htmlString' is not null or undefined
+        if (requestObj.htmlString === null || requestObj.htmlString === undefined) {
+            throw new Error('Required parameter "requestObj.htmlString" was null or undefined when calling cellsPostSetCellHtmlString.');
+        }
 
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
@@ -6046,6 +6051,7 @@ export class CellsApi {
             qs: queryParameters,
             uri: localVarPath,
             json: true,
+            body: (requestObj.htmlString == null) ? null : ObjectSerializer.serialize(requestObj.htmlString, requestObj.htmlString.constructor.name === "Object" ? "string" : requestObj.htmlString.constructor.name),
         };
 
         const response = await invokeApiMethod(requestOptions, this.configuration);
@@ -7867,6 +7873,38 @@ export class CellsApi {
         return Promise.resolve({body: result, response});
     }
 
+    /**
+     * Set worksheet background image.
+     * @param requestObj contains request parameters
+     */
+    public async cellsWorkbookDeleteWorkbookBackground(requestObj: model.CellsWorkbook_DeleteWorkbookBackgroundRequest): Promise<{response: http.ClientResponse, body: model.CellsCloudResponse}> {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "requestObj" was null or undefined when calling cellsWorkbookDeleteWorkbookBackground.');
+        }
+
+        let localVarPath = this.configuration.getApiBaseUrl() + "/cells/{name}/background"
+            .replace("{" + "name" + "}", String(requestObj.name));
+        const queryParameters: any = {};
+
+        // verify required parameter 'requestObj.name' is not null or undefined
+        if (requestObj.name === null || requestObj.name === undefined) {
+            throw new Error('Required parameter "requestObj.name" was null or undefined when calling cellsWorkbookDeleteWorkbookBackground.');
+        }
+        
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
+        const requestOptions: request.Options = {
+            method: "DELETE",
+            qs: queryParameters,
+            uri: localVarPath,
+            json: true,
+        };
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result =  ObjectSerializer.deserialize(response.body, "CellsCloudResponse");
+        return Promise.resolve({body: result, response});
+    }
+
     /**
      * Clean workbook's names.
      * @param requestObj contains request parameters
@@ -8443,6 +8481,7 @@ export class CellsApi {
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "horizontalResolution", requestObj.horizontalResolution);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "verticalResolution", requestObj.verticalResolution);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "outFolder", requestObj.outFolder);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
         const requestOptions: request.Options = {
             method: "POST",
@@ -8647,6 +8686,44 @@ export class CellsApi {
         return Promise.resolve({body: result, response});
     }
 
+    /**
+     * Set workbook background image.
+     * @param requestObj contains request parameters
+     */
+    public async cellsWorkbookPutWorkbookBackground(requestObj: model.CellsWorkbook_PutWorkbookBackgroundRequest): Promise<{response: http.ClientResponse, body: model.CellsCloudResponse}> {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "requestObj" was null or undefined when calling cellsWorkbookPutWorkbookBackground.');
+        }
+
+        let localVarPath = this.configuration.getApiBaseUrl() + "/cells/{name}/background"
+            .replace("{" + "name" + "}", String(requestObj.name));
+        const queryParameters: any = {};
+
+        // verify required parameter 'requestObj.name' is not null or undefined
+        if (requestObj.name === null || requestObj.name === undefined) {
+            throw new Error('Required parameter "requestObj.name" was null or undefined when calling cellsWorkbookPutWorkbookBackground.');
+        }
+
+        // verify required parameter 'requestObj.png' is not null or undefined
+        if (requestObj.png === null || requestObj.png === undefined) {
+            throw new Error('Required parameter "requestObj.png" was null or undefined when calling cellsWorkbookPutWorkbookBackground.');
+        }
+        
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
+        const requestOptions: request.Options = {
+            method: "PUT",
+            qs: queryParameters,
+            uri: localVarPath,
+            json: true,
+            body: (requestObj.png == null) ? null : ObjectSerializer.serialize(requestObj.png, requestObj.png.constructor.name === "Object" ? "string" : requestObj.png.constructor.name),
+        };
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result =  ObjectSerializer.deserialize(response.body, "CellsCloudResponse");
+        return Promise.resolve({body: result, response});
+    }
+
     /**
      * Create new workbook using deferent methods.
      * @param requestObj contains request parameters
@@ -8667,6 +8744,7 @@ export class CellsApi {
 
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "templateFile", requestObj.templateFile);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "dataFile", requestObj.dataFile);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "isWriteOver", requestObj.isWriteOver);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
         const requestOptions: request.Options = {
@@ -9248,6 +9326,8 @@ export class CellsApi {
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "format", requestObj.format);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "verticalResolution", requestObj.verticalResolution);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "horizontalResolution", requestObj.horizontalResolution);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "area", requestObj.area);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "pageIndex", requestObj.pageIndex);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
         localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
         const requestOptions: request.Options = {