Merge remote-tracking branch 'origin/master' into release

Author: dynabic-billing-team

README.md

@@ -16,6 +16,12 @@ Feel free to explore the [Developer's Guide](https://docs.aspose.cloud/display/w
 - Add & remove watermarks and protection.
 - Read & write access to Document Object Model.
 
+## Enhancements in Version 24.11
+
+- Added GetAllRevisions method to obtain all available revisions in document.
+- Added AppendAllEntriesToOneSection parameter to AppendDocument method to append entries to the same section.
+
+
 ## Enhancements in Version 24.9
 
 - Added digital signature methds for DOC, DOCX, XPS, or ODT documents.

TestData/DocumentElements/Revisions/TestRevisions.doc

@@ -1,6 +1,6 @@
 {
   "name": "asposewordscloud",
-  "version": "24.10.0",
+  "version": "24.11.0",
   "description": "Aspose.Words Cloud SDK for Node.js",
   "homepage": "https://products.aspose.cloud/words/cloud",
   "author": {

package.json

@@ -1645,6 +1645,42 @@ export class WordsApi implements Encryptor {
         return Promise.resolve(result);
     }
 
+    /**
+     * Get all information about revisions.
+     * @param requestObj contains request parameters
+     */
+    public async getAllRevisions(requestObj: model.GetAllRevisionsRequest): Promise< model.WordsIncomingMessage< model.RevisionsResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling getAllRevisions.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.RevisionsResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
+    /**
+     * Get all information about revisions.
+     * @param requestObj contains request parameters
+     */
+    public async getAllRevisionsOnline(requestObj: model.GetAllRevisionsOnlineRequest): Promise< model.WordsIncomingMessage< model.RevisionsResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling getAllRevisionsOnline.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.RevisionsResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
     /**
      * Reads available fonts from the document.
      * @param requestObj contains request parameters

src/api.ts

@@ -131,7 +131,7 @@ async function invokeApiMethodInternal(requestOptions: request.OptionsWithUri, c
     requestOptions.timeout = 1000 * confguration.timeout;
 
     requestOptions.headers["x-aspose-client"] = "nodejs sdk";
-    requestOptions.headers["x-aspose-client-version"] = "24.10";
+    requestOptions.headers["x-aspose-client-version"] = "24.11";
     requestOptions.encoding = null;
 
 	requestOptions.uri = encodeURI(requestOptions.uri.toString());

src/internal/requestHelper.ts

@@ -43,6 +43,11 @@ export class DocumentEntryList extends BaseEntryList {
      * Attribute type map
      */
     public static attributeTypeMap: Array<AttributeInfo> = [
+        {
+            name: "appendAllEntriesToOneSection",
+            baseName: "AppendAllEntriesToOneSection",
+            type: "boolean",
+        },
         {
             name: "applyBaseDocumentHeadersAndFootersToAppendingDocuments",
             baseName: "ApplyBaseDocumentHeadersAndFootersToAppendingDocuments",
@@ -62,6 +67,11 @@ export class DocumentEntryList extends BaseEntryList {
         return super.getAttributeTypeMap().concat(DocumentEntryList.attributeTypeMap);
     }
 
+    /**
+     * Gets or sets a value indicating whether to append all documents to the same section.
+     */
+    public appendAllEntriesToOneSection: boolean;
+
     /**
      * Gets or sets a value indicating whether to apply headers and footers from base document to appending documents. The default value is true.
      */

src/model/documentEntryList.ts

@@ -231,7 +231,10 @@ import * as importedReplaceTextParameters from './replaceTextParameters';
 import * as importedReplaceTextResponse from './replaceTextResponse';
 import * as importedReportBuildOptions from './reportBuildOptions';
 import * as importedReportEngineSettings from './reportEngineSettings';
+import * as importedRevision from './revision';
+import * as importedRevisionCollection from './revisionCollection';
 import * as importedRevisionsModificationResponse from './revisionsModificationResponse';
+import * as importedRevisionsResponse from './revisionsResponse';
 import * as importedRtfSaveOptionsData from './rtfSaveOptionsData';
 import * as importedRun from './run';
 import * as importedRunBase from './runBase';
@@ -519,7 +522,10 @@ export * from './replaceTextParameters';
 export * from './replaceTextResponse';
 export * from './reportBuildOptions';
 export * from './reportEngineSettings';
+export * from './revision';
+export * from './revisionCollection';
 export * from './revisionsModificationResponse';
+export * from './revisionsResponse';
 export * from './rtfSaveOptionsData';
 export * from './run';
 export * from './runBase';
@@ -930,7 +936,10 @@ const typeMap = {
     ReplaceTextResponse: importedReplaceTextResponse.ReplaceTextResponse,
     ReportBuildOptions: importedReportBuildOptions.ReportBuildOptions,
     ReportEngineSettings: importedReportEngineSettings.ReportEngineSettings,
+    Revision: importedRevision.Revision,
+    RevisionCollection: importedRevisionCollection.RevisionCollection,
     RevisionsModificationResponse: importedRevisionsModificationResponse.RevisionsModificationResponse,
+    RevisionsResponse: importedRevisionsResponse.RevisionsResponse,
     RtfSaveOptionsData: importedRtfSaveOptionsData.RtfSaveOptionsData,
     Run: importedRun.Run,
     RunInsert: importedRunInsert.RunInsert,
@@ -13956,6 +13965,232 @@ export class ExecuteMailMergeOnlineRequest implements RequestInterface {
 	}
 }
 
+/**
+ * Request model for GetAllRevisions operation.
+ * Get all information about revisions.
+ */
+export class GetAllRevisionsRequest implements RequestInterface {
+
+    public constructor(init?: Partial< GetAllRevisionsRequest >) {
+        Object.assign(this, init);
+    }
+
+    /**
+     * The filename of the input document.
+     */
+    public name: string;
+
+    /**
+     * Original document folder.
+     */
+    public folder: string;
+
+    /**
+     * Original document storage.
+     */
+    public storage: string;
+
+    /**
+     * Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+     */
+    public loadEncoding: string;
+
+    /**
+     * Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
+     */
+    public password: string;
+
+    /**
+     * Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
+     */
+    public encryptedPassword: string;
+
+    /**
+     * The value indicates whether OpenType support is on.
+     */
+    public openTypeSupport: boolean;
+
+	/**
+	 * create the requst options for this request
+	 * @param configuration a configuration for the request
+	 * @param data encryptor 
+	 */
+	public async createRequestOptions(configuration: Configuration, _encryptor: Encryptor) : Promise<request.OptionsWithUri> {
+        let localVarPath = configuration.getApiBaseUrl() + "/words/{name}/revisions/getAll"
+            .replace("/{" + "name" + "}", (this.name !== null && this.name !== undefined) ? "/" + String(this.name) : "")
+            .replace("//", "/");
+        var queryParameters: any = {};
+        var headerParams: any = {};
+        var formParams: any = [];
+        var filesContent: any = [];
+        // verify required parameter 'this.name' is not undefined
+        if (this.name === undefined) {
+            throw new Error('Required parameter "this.name" was undefined when calling getAllRevisions.');
+        }
+
+        // verify required parameter 'this.name' is not null
+        if (this.name === null) {
+            throw new Error('Required parameter "this.name" was null when calling getAllRevisions.');
+        }
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "folder", this.folder, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "storage", this.storage, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "loadEncoding", this.loadEncoding, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "password", this.password, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "encryptedPassword", this.encryptedPassword, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "openTypeSupport", this.openTypeSupport, _encryptor);
+
+        for (let fileContent of filesContent) {
+            await fileContent.encryptPassword(_encryptor);
+            if (fileContent.getSource() == FileReference.SourceEnum.Request) {
+                formParams.push([fileContent.getReference(), fileContent.getContent(), 'application/octet-stream']);
+            }
+        }
+
+        const requestOptions: request.Options = {
+            method: "GET",
+            qs: queryParameters,
+            headers: headerParams,
+            uri: localVarPath,
+        };
+
+        if (formParams.length == 1) {
+            let formFirstParam = formParams[0];
+            requestOptions.body = formFirstParam[1];
+            requestOptions.headers["Content-Type"] = formFirstParam[2];
+        }
+        else if (formParams.length > 1) {
+            const requestParts = [];
+            for (let formParam of formParams) {
+                requestParts.push({
+                    'Content-Type': formParam[2],
+                    'Content-Disposition': 'form-data; name="' + formParam[0] + '"',
+                    body: formParam[1],
+                });
+            }
+
+            requestOptions.headers["Content-Type"] = 'multipart/form-data';
+            requestOptions.multipart = requestParts;
+        }
+
+        return Promise.resolve(requestOptions);
+    }
+
+	/**
+	 * create response from string
+	 */
+	createResponse(_response: Buffer, _headers: http.IncomingHttpHeaders): any {
+        return ObjectSerializer.deserialize(JSON.parse(_response.toString()), "RevisionsResponse");
+	}
+}
+
+/**
+ * Request model for GetAllRevisionsOnline operation.
+ * Get all information about revisions.
+ */
+export class GetAllRevisionsOnlineRequest implements RequestInterface {
+
+    public constructor(init?: Partial< GetAllRevisionsOnlineRequest >) {
+        Object.assign(this, init);
+    }
+
+    /**
+     * The document.
+     */
+    public document: Readable;
+
+    /**
+     * Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+     */
+    public loadEncoding: string;
+
+    /**
+     * Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
+     */
+    public password: string;
+
+    /**
+     * Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
+     */
+    public encryptedPassword: string;
+
+    /**
+     * The value indicates whether OpenType support is on.
+     */
+    public openTypeSupport: boolean;
+
+	/**
+	 * create the requst options for this request
+	 * @param configuration a configuration for the request
+	 * @param data encryptor 
+	 */
+	public async createRequestOptions(configuration: Configuration, _encryptor: Encryptor) : Promise<request.OptionsWithUri> {
+        let localVarPath = configuration.getApiBaseUrl() + "/words/online/get/revisions/getAll"
+            .replace("//", "/");
+        var queryParameters: any = {};
+        var headerParams: any = {};
+        var formParams: any = [];
+        var filesContent: any = [];
+        // verify required parameter 'this.document' is not undefined
+        if (this.document === undefined) {
+            throw new Error('Required parameter "this.document" was undefined when calling getAllRevisionsOnline.');
+        }
+
+        // verify required parameter 'this.document' is not null
+        if (this.document === null) {
+            throw new Error('Required parameter "this.document" was null when calling getAllRevisionsOnline.');
+        }
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "loadEncoding", this.loadEncoding, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "password", this.password, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "encryptedPassword", this.encryptedPassword, _encryptor);
+        localVarPath = await addQueryParameterToUrl(localVarPath, queryParameters, "openTypeSupport", this.openTypeSupport, _encryptor);
+        if (this.document !== undefined) {
+            formParams.push(['Document', this.document, 'application/octet-stream']);
+        }
+
+        for (let fileContent of filesContent) {
+            await fileContent.encryptPassword(_encryptor);
+            if (fileContent.getSource() == FileReference.SourceEnum.Request) {
+                formParams.push([fileContent.getReference(), fileContent.getContent(), 'application/octet-stream']);
+            }
+        }
+
+        const requestOptions: request.Options = {
+            method: "PUT",
+            qs: queryParameters,
+            headers: headerParams,
+            uri: localVarPath,
+        };
+
+        if (formParams.length == 1) {
+            let formFirstParam = formParams[0];
+            requestOptions.body = formFirstParam[1];
+            requestOptions.headers["Content-Type"] = formFirstParam[2];
+        }
+        else if (formParams.length > 1) {
+            const requestParts = [];
+            for (let formParam of formParams) {
+                requestParts.push({
+                    'Content-Type': formParam[2],
+                    'Content-Disposition': 'form-data; name="' + formParam[0] + '"',
+                    body: formParam[1],
+                });
+            }
+
+            requestOptions.headers["Content-Type"] = 'multipart/form-data';
+            requestOptions.multipart = requestParts;
+        }
+
+        return Promise.resolve(requestOptions);
+    }
+
+	/**
+	 * create response from string
+	 */
+	createResponse(_response: Buffer, _headers: http.IncomingHttpHeaders): any {
+        return ObjectSerializer.deserialize(JSON.parse(_response.toString()), "RevisionsResponse");
+	}
+}
+
 /**
  * Request model for GetAvailableFonts operation.
  * Reads available fonts from the document.