SDK regenerated by CI server [ci skip]

Author: evgeny.ivanov

README.md

@@ -20,6 +20,8 @@ Feel free to explore the [Developer's Guide](https://docs.aspose.cloud/display/w
 
 - ImlRenderingMode option introduced witch is used to determine how ink (InkML) objects are rendered
 - MaxCharactersPerLine option introduced which is used to specify the maximum number of characters per one line
+- Added new API method to get a RSA public key to encrypt document passwords
+- Added encryptedPassword common query option to pass an encrypted document password
 
 
 ## Enhancements in Version 21.6

src/api.ts

@@ -2671,6 +2671,24 @@ export class WordsApi {
         return Promise.resolve(result);
     }
 
+    /**
+     * Get assymetric public key.
+     * @param requestObj contains request parameters
+     */
+    public async getPublicKey(requestObj: model.GetPublicKeyRequest): Promise< model.WordsIncomingMessage< model.PublicKeyResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling getPublicKey.');
+        }
+
+        const requestOptions = requestObj.createRequestOptions(this.configuration); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.PublicKeyResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body);
+        return Promise.resolve(result);
+    }
+
     /**
      * Reads range text from the document.
      * @param requestObj contains request parameters

src/model/model.ts

@@ -184,6 +184,7 @@ import * as importedProtectionData from './protectionData';
 import * as importedProtectionDataResponse from './protectionDataResponse';
 import * as importedProtectionRequest from './protectionRequest';
 import * as importedPsSaveOptionsData from './psSaveOptionsData';
+import * as importedPublicKeyResponse from './publicKeyResponse';
 import * as importedRangeDocument from './rangeDocument';
 import * as importedRangeDocumentDto from './rangeDocumentDto';
 import * as importedRangeTextResponse from './rangeTextResponse';
@@ -425,6 +426,7 @@ export * from './protectionData';
 export * from './protectionDataResponse';
 export * from './protectionRequest';
 export * from './psSaveOptionsData';
+export * from './publicKeyResponse';
 export * from './rangeDocument';
 export * from './rangeDocumentDto';
 export * from './rangeTextResponse';
@@ -767,6 +769,7 @@ const typeMap = {
     ProtectionDataResponse: importedProtectionDataResponse.ProtectionDataResponse,
     ProtectionRequest: importedProtectionRequest.ProtectionRequest,
     PsSaveOptionsData: importedPsSaveOptionsData.PsSaveOptionsData,
+    PublicKeyResponse: importedPublicKeyResponse.PublicKeyResponse,
     RangeDocument: importedRangeDocument.RangeDocument,
     RangeDocumentDto: importedRangeDocumentDto.RangeDocumentDto,
     RangeTextResponse: importedRangeTextResponse.RangeTextResponse,
@@ -15339,6 +15342,45 @@ export class GetParagraphTabStopsOnlineRequest implements RequestInterface {
 	}
 }
 
+/**
+ * Request model for GetPublicKey operation.
+ * Get assymetric public key.
+ */
+export class GetPublicKeyRequest implements RequestInterface {
+
+    public constructor(init?: Partial< GetPublicKeyRequest >) {
+        Object.assign(this, init);
+    }
+
+
+	/**
+	 * create the requst options for this request
+	 * @param configuration a configuration for the request
+	 */
+	createRequestOptions(configuration: Configuration) : request.OptionsWithUri {
+        const localVarPath = configuration.getApiBaseUrl() + "/words/encryption/publickey"
+            .replace("//", "/");
+        const queryParameters: any = {};
+
+        const requestOptions: request.Options = {
+            method: "GET",
+            qs: queryParameters,
+            uri: localVarPath,
+            json: true,
+        };
+
+
+        return requestOptions;
+    }
+
+	/**
+	 * create response from string
+	 */
+	createResponse(_response: Buffer, _boundary?: string): any {
+        return ObjectSerializer.deserialize(_response, "PublicKeyResponse");
+	}
+}
+
 /**
  * Request model for GetRangeText operation.
  * Reads range text from the document.

src/model/publicKeyResponse.ts

@@ -0,0 +1,77 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="publicKeyResponse.ts">
+ *   Copyright (c) 2021 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+import { AttributeInfo } from '../internal/attributeInfo';
+import { WordsResponse } from './wordsResponse';
+
+export const importsMapPublicKeyResponse = {
+    WordsResponse,
+};
+
+/**
+ * REST response for RSA public key info.
+ */
+export class PublicKeyResponse extends WordsResponse {
+    /**
+     * Attribute type map
+     */
+    public static attributeTypeMap: Array<AttributeInfo> = [
+        {
+            name: "exponent",
+            baseName: "Exponent",
+            type: "string",
+        },
+        {
+            name: "modulus",
+            baseName: "Modulus",
+            type: "string",
+        }
+    ];
+
+    /**
+     * Returns attribute type map
+     */
+    public static getAttributeTypeMap() {
+        return super.getAttributeTypeMap().concat(PublicKeyResponse.attributeTypeMap);
+    }
+
+    /**
+     * Gets or sets RSA key exponent as Base64 string.
+     */
+    public exponent: string;
+
+    /**
+     * Gets or sets RSA key modulus as Base64 string.
+     */
+    public modulus: string;
+
+    public constructor(init?: Partial< PublicKeyResponse >) {
+        super(init);
+        Object.assign(this, init);
+    }
+}
+

test/document/passwordEncryptionTests.ts

@@ -0,0 +1,59 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="passwordEncryptionTests.ts">
+ *   Copyright (c) 2021 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+import { expect } from "chai";
+import "mocha";
+
+import * as fs from "fs";
+import * as model from "../../src/model/model";
+import * as BaseTest from "../baseTest";
+
+// Example of how to handle an encrypted document.
+describe("passwordEncryption", () => {
+    expect(fs);
+    const remoteDataFolder = BaseTest.remoteBaseTestDataFolder + "/DocumentActions/PasswordEncryption";
+    const localFile = "Common/test_multi_pages.docx";
+
+    // Test for getting a public key for password encryption.
+    describe("getPublicKey test", () => {
+        it("should return response with code 200", () => {
+            const wordsApi = BaseTest.initializeWordsApi();
+            const request = new model.GetPublicKeyRequest({
+            });
+
+            // Act
+            return wordsApi.getPublicKey(request)
+            .then((resultApi) => {
+                // Assert
+                expect(resultApi.response.statusCode).to.equal(200);
+                expect(resultApi.body.exponent).to.exist;
+                expect(resultApi.body.modulus).to.exist;
+            });
+
+       });
+    });
+});