Merge pull request #97 from aspose-pdf-cloud/develop

update to 24.10

Author: boiledgas

README.md

@@ -30,7 +30,7 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
 ## Read PDF Formats
 MHT, PCL, PS, XSLFO, MD
 
-## Enhancements in Version 24.9
+## Enhancements in Version 24.10
 - Develop DeleteDocumentLayer Method.
 - Develop GetDocumentLayers Method.
 - How to extract PDF layer elements and create a new PDF

docs/PdfApi.md

@@ -189,6 +189,8 @@ Method | HTTP request | Description
 *PdfApi* | [**getWordsPerPage**](PdfApi.md#getWordsPerPage) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page.
 *PdfApi* | [**getXfaPdfInStorageToAcroForm**](PdfApi.md#getXfaPdfInStorageToAcroForm) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
 *PdfApi* | [**getXmlInStorageToPdf**](PdfApi.md#getXmlInStorageToPdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response. 
+*PdfApi* | [**getXmpMetadataJson**](PdfApi.md#getXmpMetadataJson) | **GET** /pdf/\{name}/xmpmetadata/json | Gets document XMP Metadata as JSON.
+*PdfApi* | [**getXmpMetadataXml**](PdfApi.md#getXmpMetadataXml) | **GET** /pdf/\{name}/xmpmetadata/xml | Gets document XMP Metadata as XML file.
 *PdfApi* | [**getXpsInStorageToPdf**](PdfApi.md#getXpsInStorageToPdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response. 
 *PdfApi* | [**getXslFoInStorageToPdf**](PdfApi.md#getXslFoInStorageToPdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response. 
 *PdfApi* | [**moveFile**](PdfApi.md#moveFile) | **PUT** /pdf/storage/file/move/\{srcPath} | Move file
@@ -258,6 +260,7 @@ Method | HTTP request | Description
 *PdfApi* | [**postSplitDocument**](PdfApi.md#postSplitDocument) | **POST** /pdf/\{name}/split | Split document to parts.
 *PdfApi* | [**postSplitRangePdfDocument**](PdfApi.md#postSplitRangePdfDocument) | **POST** /pdf/\{name}/splitrangepdf | Split document into ranges.
 *PdfApi* | [**postTextBoxFields**](PdfApi.md#postTextBoxFields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
+*PdfApi* | [**postXmpMetadata**](PdfApi.md#postXmpMetadata) | **POST** /pdf/\{name}/xmpmetadata | Add or remove XMP Metadata properties.
 *PdfApi* | [**putAddNewPage**](PdfApi.md#putAddNewPage) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
 *PdfApi* | [**putAddText**](PdfApi.md#putAddText) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
 *PdfApi* | [**putAnnotationsFlatten**](PdfApi.md#putAnnotationsFlatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
@@ -4682,6 +4685,52 @@ Name | Type | Description  | Notes
 
 **Buffer**
 
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: multipart/form-data
+
+<a name="getXmpMetadataJson"></a>
+## **getXmpMetadataJson**
+> getXmpMetadataJson(name, folder, storage, passBase64)
+
+Gets document XMP Metadata as JSON.
+
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**name** | **string** | The document name. | 
+**folder** | **string** | The document folder. | [optional]
+**storage** | **string** | The document storage. | [optional]
+**passBase64** | **string** | The password (Base64). | [optional]
+
+### Return type
+
+[**XmpMetadata**](XmpMetadata.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="getXmpMetadataXml"></a>
+## **getXmpMetadataXml**
+> getXmpMetadataXml(name, folder, storage, passBase64)
+
+Gets document XMP Metadata as XML file.
+
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**name** | **string** | The document name. | 
+**folder** | **string** | The document folder. | [optional]
+**storage** | **string** | The document storage. | [optional]
+**passBase64** | **string** | The password (Base64). | [optional]
+
+### Return type
+
+**Buffer**
+
 ### HTTP request headers
 
  - **Content-Type**: application/json
@@ -6340,6 +6389,30 @@ Name | Type | Description  | Notes
 
 [**AsposeResponse**](AsposeResponse.md)
 
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="postXmpMetadata"></a>
+## **postXmpMetadata**
+> postXmpMetadata(name, metadata, folder, storage, passBase64)
+
+Add or remove XMP Metadata properties.
+
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**name** | **string** | The document name. | 
+**metadata** | [**XmpMetadata**](XmpMetadata.md) | XmpMetadata instance. | 
+**folder** | **string** | The document folder. | [optional]
+**storage** | **string** | The document storage. | [optional]
+**passBase64** | **string** | The password (Base64). | [optional]
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
 ### HTTP request headers
 
  - **Content-Type**: application/json

docs/XmpMetadata.md

@@ -0,0 +1,10 @@
+# XmpMetadata
+Document Xmp Metadata.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**Array<XmpMetadataProperty>**](XmpMetadataProperty.md) | List of document Xmp Metadata default properties. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/xmpMetadata.ts)
+

docs/XmpMetadataProperty.md

@@ -0,0 +1,12 @@
+# XmpMetadataProperty
+Xmp Metadata Property.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | Xmp Metadata Property Key. Can take the form for default keys: xmp:DefaultKeyName or DefaultKeyName. Form for user defined properties: customNamespace:UserPropertyName. | 
+**value** | **string** | Xmp Metadata Property Value. Null for delete property. | [optional]
+**namespaceUri** | **string** | Namespace Uri. For user defined properties only. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[View Source]](../src/models/xmpMetadataProperty.ts)
+

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "asposepdfcloud",
-    "version": "24.9.0",
+    "version": "24.10.0",
     "description": "Aspose.PDF Cloud is a REST API for creating and editing PDF files. Most popular features proposed by Aspose.PDF Cloud: PDF to Word, Convert PDF to Image, Merge PDF, Split PDF, Add Images to PDF, Rotate PDF. It can also be used to convert PDF files to different formats like DOC, HTML, XPS, TIFF and many more. Aspose.PDF Cloud gives you control: create PDFs from scratch or from HTML, XML, template, database, XPS or an image. Render PDFs to image formats such as JPEG, PNG, GIF, BMP, TIFF and many others. Aspose.PDF Cloud helps you manipulate elements of a PDF file like text, annotations, watermarks, signatures, bookmarks, stamps and so on. Its REST API also allows you to manage PDF pages by using features like merging, splitting, and inserting. Add images to a PDF file or convert PDF pages to images.",
     "homepage": "https://products.aspose.cloud/pdf/cloud",
     "author": {

package.json

@@ -135,6 +135,8 @@ import { TimestampSettings } from "../models/timestampSettings";
 import { VerticalAlignment } from "../models/verticalAlignment";
 import { WordCount } from "../models/wordCount";
 import { WrapMode } from "../models/wrapMode";
+import { XmpMetadata } from "../models/xmpMetadata";
+import { XmpMetadataProperty } from "../models/xmpMetadataProperty";
 import { Annotation } from "../models/annotation";
 import { AnnotationsInfo } from "../models/annotationsInfo";
 import { AnnotationsInfoResponse } from "../models/annotationsInfoResponse";
@@ -11509,6 +11511,120 @@ export class PdfApi {
     }
 
 
+    /**
+     * 
+     * @summary Gets document XMP Metadata as JSON.
+     * @param name The document name.
+     * @param folder The document folder.
+     * @param storage The document storage.
+     * @param passBase64 The password (Base64).
+     */
+    public async getXmpMetadataJson (name: string, folder?: string, storage?: string, passBase64?: string) : Promise<{ response: http.IncomingMessage; body: XmpMetadata;  }> {
+        const localVarPath = this.basePath + '/pdf/{name}/xmpmetadata/json'
+            .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/'));
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        let localVarFormParams: any = {};
+
+        // verify required parameter 'name' is not null or undefined
+        if (name === null || name === undefined) {
+            throw new Error('Required parameter name was null or undefined when calling getXmpMetadataJson.');
+        }
+
+        if (folder !== undefined && null !== folder) {
+            localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string");
+        }
+
+        if (storage !== undefined && null !== storage) {
+            localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string");
+        }
+
+        if (passBase64 !== undefined && null !== passBase64) {
+            localVarQueryParameters['passBase64'] = ObjectSerializer.serialize(passBase64, "string");
+        }
+
+
+        let localVarUseFormData = false;
+        let fileData = null;
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        if (Object.keys(localVarFormParams).length) {
+            if (localVarUseFormData) {
+                (<any>localVarRequestOptions).formData = localVarFormParams;
+            } else {
+                localVarRequestOptions.form = localVarFormParams;
+            }
+        }
+        const response = await invokeApiMethod(localVarRequestOptions, this.configuration, false, fileData);
+        const result =  ObjectSerializer.deserialize(response.body, "XmpMetadata");
+        return Promise.resolve({body: result, response});
+    }
+
+
+    /**
+     * 
+     * @summary Gets document XMP Metadata as XML file.
+     * @param name The document name.
+     * @param folder The document folder.
+     * @param storage The document storage.
+     * @param passBase64 The password (Base64).
+     */
+    public async getXmpMetadataXml (name: string, folder?: string, storage?: string, passBase64?: string) : Promise<{ response: http.IncomingMessage; body: Buffer;  }> {
+        const localVarPath = this.basePath + '/pdf/{name}/xmpmetadata/xml'
+            .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/'));
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        let localVarFormParams: any = {};
+
+        // verify required parameter 'name' is not null or undefined
+        if (name === null || name === undefined) {
+            throw new Error('Required parameter name was null or undefined when calling getXmpMetadataXml.');
+        }
+
+        if (folder !== undefined && null !== folder) {
+            localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string");
+        }
+
+        if (storage !== undefined && null !== storage) {
+            localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string");
+        }
+
+        if (passBase64 !== undefined && null !== passBase64) {
+            localVarQueryParameters['passBase64'] = ObjectSerializer.serialize(passBase64, "string");
+        }
+
+
+        let localVarUseFormData = false;
+        let fileData = null;
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            encoding: null,
+        };
+
+        if (Object.keys(localVarFormParams).length) {
+            if (localVarUseFormData) {
+                (<any>localVarRequestOptions).formData = localVarFormParams;
+            } else {
+                localVarRequestOptions.form = localVarFormParams;
+            }
+        }
+        const response = await invokeApiMethod(localVarRequestOptions, this.configuration, false, fileData);
+        const result =  ObjectSerializer.deserialize(response.body, "Buffer");
+        return Promise.resolve({body: result, response});
+    }
+
+
     /**
      * 
      * @summary Convert XPS file (located on storage) to PDF format and return resulting file in response. 
@@ -16074,6 +16190,70 @@ export class PdfApi {
     }
 
 
+    /**
+     * 
+     * @summary Add or remove XMP Metadata properties.
+     * @param name The document name.
+     * @param metadata XmpMetadata instance.
+     * @param folder The document folder.
+     * @param storage The document storage.
+     * @param passBase64 The password (Base64).
+     */
+    public async postXmpMetadata (name: string, metadata: XmpMetadata, folder?: string, storage?: string, passBase64?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse;  }> {
+        const localVarPath = this.basePath + '/pdf/{name}/xmpmetadata'
+            .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/'));
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        let localVarFormParams: any = {};
+
+        // verify required parameter 'name' is not null or undefined
+        if (name === null || name === undefined) {
+            throw new Error('Required parameter name was null or undefined when calling postXmpMetadata.');
+        }
+
+        // verify required parameter 'metadata' is not null or undefined
+        if (metadata === null || metadata === undefined) {
+            throw new Error('Required parameter metadata was null or undefined when calling postXmpMetadata.');
+        }
+
+        if (folder !== undefined && null !== folder) {
+            localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string");
+        }
+
+        if (storage !== undefined && null !== storage) {
+            localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string");
+        }
+
+        if (passBase64 !== undefined && null !== passBase64) {
+            localVarQueryParameters['passBase64'] = ObjectSerializer.serialize(passBase64, "string");
+        }
+
+
+        let localVarUseFormData = false;
+        let fileData = null;
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+            body: ObjectSerializer.serialize(metadata, "XmpMetadata")
+        };
+
+        if (Object.keys(localVarFormParams).length) {
+            if (localVarUseFormData) {
+                (<any>localVarRequestOptions).formData = localVarFormParams;
+            } else {
+                localVarRequestOptions.form = localVarFormParams;
+            }
+        }
+        const response = await invokeApiMethod(localVarRequestOptions, this.configuration, false, fileData);
+        const result =  ObjectSerializer.deserialize(response.body, "AsposeResponse");
+        return Promise.resolve({body: result, response});
+    }
+
+
     /**
      * 
      * @summary Add new page to end of the document.