asposepdfcloud

Version:

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 diff

products.aspose.cloud/pdf/cloud

aspose-pdf-cloud/aspose-pdf-cloud-node.js

1,038 lines (916 loc) • 1.14 MB

text/typescript

/** * * Copyright (c) 2025 Aspose.PDF Cloud * 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. * */ import { AnnotationFlags } from "../models/annotationFlags"; import { AnnotationState } from "../models/annotationState"; import { AnnotationType } from "../models/annotationType"; import { AntialiasingProcessingType } from "../models/antialiasingProcessingType"; import { AsposeResponse } from "../models/asposeResponse"; import { AttachmentInfo } from "../models/attachmentInfo"; import { Border } from "../models/border"; import { BorderCornerStyle } from "../models/borderCornerStyle"; import { BorderEffect } from "../models/borderEffect"; import { BorderInfo } from "../models/borderInfo"; import { BorderStyle } from "../models/borderStyle"; import { BoxStyle } from "../models/boxStyle"; import { CapStyle } from "../models/capStyle"; import { CaptionPosition } from "../models/captionPosition"; import { CaretSymbol } from "../models/caretSymbol"; import { Cell } from "../models/cell"; import { CellRecognized } from "../models/cellRecognized"; import { Color } from "../models/color"; import { ColorDepth } from "../models/colorDepth"; import { ColumnAdjustment } from "../models/columnAdjustment"; import { CompressionType } from "../models/compressionType"; import { CryptoAlgorithm } from "../models/cryptoAlgorithm"; import { Dash } from "../models/dash"; import { DefaultPageConfig } from "../models/defaultPageConfig"; import { Direction } from "../models/direction"; import { DiscUsage } from "../models/discUsage"; import { DocFormat } from "../models/docFormat"; import { DocMDPAccessPermissionType } from "../models/docMDPAccessPermissionType"; import { DocRecognitionMode } from "../models/docRecognitionMode"; import { DocumentConfig } from "../models/documentConfig"; import { DocumentLayers } from "../models/documentLayers"; import { DocumentPrivilege } from "../models/documentPrivilege"; import { EpubRecognitionMode } from "../models/epubRecognitionMode"; import { ErrorDetails } from "../models/errorDetails"; import { FieldType } from "../models/fieldType"; import { FileIcon } from "../models/fileIcon"; import { FileVersions } from "../models/fileVersions"; import { FilesList } from "../models/filesList"; import { FilesUploadResult } from "../models/filesUploadResult"; import { FontEncodingRules } from "../models/fontEncodingRules"; import { FontSavingModes } from "../models/fontSavingModes"; import { FontStyles } from "../models/fontStyles"; import { FreeTextIntent } from "../models/freeTextIntent"; import { GraphInfo } from "../models/graphInfo"; import { HorizontalAlignment } from "../models/horizontalAlignment"; import { HtmlDocumentType } from "../models/htmlDocumentType"; import { HtmlMarkupGenerationModes } from "../models/htmlMarkupGenerationModes"; import { ImageCompressionVersion } from "../models/imageCompressionVersion"; import { ImageEncoding } from "../models/imageEncoding"; import { ImageFragment } from "../models/imageFragment"; import { ImageSrcType } from "../models/imageSrcType"; import { ImageTemplate } from "../models/imageTemplate"; import { ImageTemplatesRequest } from "../models/imageTemplatesRequest"; import { Justification } from "../models/justification"; import { LayerInfo } from "../models/layerInfo"; import { LettersPositioningMethods } from "../models/lettersPositioningMethods"; import { LineEnding } from "../models/lineEnding"; import { LineIntent } from "../models/lineIntent"; import { LineSpacing } from "../models/lineSpacing"; import { Link } from "../models/link"; import { LinkActionType } from "../models/linkActionType"; import { LinkElement } from "../models/linkElement"; import { LinkHighlightingMode } from "../models/linkHighlightingMode"; import { MarginInfo } from "../models/marginInfo"; import { MergeDocuments } from "../models/mergeDocuments"; import { ModelError } from "../models/modelError"; import { ObjectExist } from "../models/objectExist"; import { OptimizeOptions } from "../models/optimizeOptions"; import { Option } from "../models/option"; import { OrganizeDocumentData } from "../models/organizeDocumentData"; import { OrganizeDocumentRequest } from "../models/organizeDocumentRequest"; import { OutputFormat } from "../models/outputFormat"; import { PageLayout } from "../models/pageLayout"; import { PageMode } from "../models/pageMode"; import { PageRange } from "../models/pageRange"; import { PageWordCount } from "../models/pageWordCount"; import { Paragraph } from "../models/paragraph"; import { PartsEmbeddingModes } from "../models/partsEmbeddingModes"; import { PdfAType } from "../models/pdfAType"; import { PermissionsFlags } from "../models/permissionsFlags"; import { Point } from "../models/point"; import { PolyIntent } from "../models/polyIntent"; import { Position } from "../models/position"; import { RasterImagesSavingModes } from "../models/rasterImagesSavingModes"; import { Rectangle } from "../models/rectangle"; import { Rotation } from "../models/rotation"; import { Row } from "../models/row"; import { RowRecognized } from "../models/rowRecognized"; import { Segment } from "../models/segment"; import { ShapeType } from "../models/shapeType"; import { Signature } from "../models/signature"; import { SignatureCustomAppearance } from "../models/signatureCustomAppearance"; import { SignatureType } from "../models/signatureType"; import { SoundEncoding } from "../models/soundEncoding"; import { SoundIcon } from "../models/soundIcon"; import { SplitRangePdfOptions } from "../models/splitRangePdfOptions"; import { SplitResult } from "../models/splitResult"; import { Stamp } from "../models/stamp"; import { StampIcon } from "../models/stampIcon"; import { StampType } from "../models/stampType"; import { StorageExist } from "../models/storageExist"; import { StorageFile } from "../models/storageFile"; import { TableBroken } from "../models/tableBroken"; import { TextHorizontalAlignment } from "../models/textHorizontalAlignment"; import { TextIcon } from "../models/textIcon"; import { TextLine } from "../models/textLine"; import { TextRect } from "../models/textRect"; import { TextRects } from "../models/textRects"; import { TextReplace } from "../models/textReplace"; import { TextReplaceListRequest } from "../models/textReplaceListRequest"; import { TextState } from "../models/textState"; import { TextStyle } from "../models/textStyle"; 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"; import { Attachment } from "../models/attachment"; import { AttachmentResponse } from "../models/attachmentResponse"; import { Attachments } from "../models/attachments"; import { AttachmentsResponse } from "../models/attachmentsResponse"; import { Bookmark } from "../models/bookmark"; import { BookmarkResponse } from "../models/bookmarkResponse"; import { Bookmarks } from "../models/bookmarks"; import { BookmarksResponse } from "../models/bookmarksResponse"; import { CaretAnnotationResponse } from "../models/caretAnnotationResponse"; import { CaretAnnotations } from "../models/caretAnnotations"; import { CaretAnnotationsResponse } from "../models/caretAnnotationsResponse"; import { CheckBoxFieldResponse } from "../models/checkBoxFieldResponse"; import { CheckBoxFields } from "../models/checkBoxFields"; import { CheckBoxFieldsResponse } from "../models/checkBoxFieldsResponse"; import { CircleAnnotationResponse } from "../models/circleAnnotationResponse"; import { CircleAnnotations } from "../models/circleAnnotations"; import { CircleAnnotationsResponse } from "../models/circleAnnotationsResponse"; import { ComboBoxFieldResponse } from "../models/comboBoxFieldResponse"; import { ComboBoxFields } from "../models/comboBoxFields"; import { ComboBoxFieldsResponse } from "../models/comboBoxFieldsResponse"; import { DisplayProperties } from "../models/displayProperties"; import { DisplayPropertiesResponse } from "../models/displayPropertiesResponse"; import { Document } from "../models/document"; import { DocumentPageResponse } from "../models/documentPageResponse"; import { DocumentPagesResponse } from "../models/documentPagesResponse"; import { DocumentProperties } from "../models/documentProperties"; import { DocumentPropertiesResponse } from "../models/documentPropertiesResponse"; import { DocumentProperty } from "../models/documentProperty"; import { DocumentPropertyResponse } from "../models/documentPropertyResponse"; import { DocumentResponse } from "../models/documentResponse"; import { Field } from "../models/field"; import { FieldResponse } from "../models/fieldResponse"; import { Fields } from "../models/fields"; import { FieldsResponse } from "../models/fieldsResponse"; import { FileAttachmentAnnotationResponse } from "../models/fileAttachmentAnnotationResponse"; import { FileAttachmentAnnotations } from "../models/fileAttachmentAnnotations"; import { FileAttachmentAnnotationsResponse } from "../models/fileAttachmentAnnotationsResponse"; import { FileVersion } from "../models/fileVersion"; import { FormField } from "../models/formField"; import { FreeTextAnnotationResponse } from "../models/freeTextAnnotationResponse"; import { FreeTextAnnotations } from "../models/freeTextAnnotations"; import { FreeTextAnnotationsResponse } from "../models/freeTextAnnotationsResponse"; import { HighlightAnnotationResponse } from "../models/highlightAnnotationResponse"; import { HighlightAnnotations } from "../models/highlightAnnotations"; import { HighlightAnnotationsResponse } from "../models/highlightAnnotationsResponse"; import { Image } from "../models/image"; import { ImageResponse } from "../models/imageResponse"; import { Images } from "../models/images"; import { ImagesResponse } from "../models/imagesResponse"; import { InkAnnotationResponse } from "../models/inkAnnotationResponse"; import { InkAnnotations } from "../models/inkAnnotations"; import { InkAnnotationsResponse } from "../models/inkAnnotationsResponse"; import { LineAnnotationResponse } from "../models/lineAnnotationResponse"; import { LineAnnotations } from "../models/lineAnnotations"; import { LineAnnotationsResponse } from "../models/lineAnnotationsResponse"; import { LinkAnnotation } from "../models/linkAnnotation"; import { LinkAnnotationResponse } from "../models/linkAnnotationResponse"; import { LinkAnnotations } from "../models/linkAnnotations"; import { LinkAnnotationsResponse } from "../models/linkAnnotationsResponse"; import { ListBoxFieldResponse } from "../models/listBoxFieldResponse"; import { ListBoxFields } from "../models/listBoxFields"; import { ListBoxFieldsResponse } from "../models/listBoxFieldsResponse"; import { MovieAnnotationResponse } from "../models/movieAnnotationResponse"; import { MovieAnnotations } from "../models/movieAnnotations"; import { MovieAnnotationsResponse } from "../models/movieAnnotationsResponse"; import { Page } from "../models/page"; import { Pages } from "../models/pages"; import { PolyLineAnnotationResponse } from "../models/polyLineAnnotationResponse"; import { PolyLineAnnotations } from "../models/polyLineAnnotations"; import { PolyLineAnnotationsResponse } from "../models/polyLineAnnotationsResponse"; import { PolygonAnnotationResponse } from "../models/polygonAnnotationResponse"; import { PolygonAnnotations } from "../models/polygonAnnotations"; import { PolygonAnnotationsResponse } from "../models/polygonAnnotationsResponse"; import { PopupAnnotationResponse } from "../models/popupAnnotationResponse"; import { PopupAnnotations } from "../models/popupAnnotations"; import { PopupAnnotationsResponse } from "../models/popupAnnotationsResponse"; import { RadioButtonFieldResponse } from "../models/radioButtonFieldResponse"; import { RadioButtonFields } from "../models/radioButtonFields"; import { RadioButtonFieldsResponse } from "../models/radioButtonFieldsResponse"; import { RedactionAnnotationResponse } from "../models/redactionAnnotationResponse"; import { RedactionAnnotations } from "../models/redactionAnnotations"; import { RedactionAnnotationsResponse } from "../models/redactionAnnotationsResponse"; import { ScreenAnnotationResponse } from "../models/screenAnnotationResponse"; import { ScreenAnnotations } from "../models/screenAnnotations"; import { ScreenAnnotationsResponse } from "../models/screenAnnotationsResponse"; import { SignatureFieldResponse } from "../models/signatureFieldResponse"; import { SignatureFields } from "../models/signatureFields"; import { SignatureFieldsResponse } from "../models/signatureFieldsResponse"; import { SignatureVerifyResponse } from "../models/signatureVerifyResponse"; import { SoundAnnotationResponse } from "../models/soundAnnotationResponse"; import { SoundAnnotations } from "../models/soundAnnotations"; import { SoundAnnotationsResponse } from "../models/soundAnnotationsResponse"; import { SplitResultDocument } from "../models/splitResultDocument"; import { SplitResultResponse } from "../models/splitResultResponse"; import { SquareAnnotationResponse } from "../models/squareAnnotationResponse"; import { SquareAnnotations } from "../models/squareAnnotations"; import { SquareAnnotationsResponse } from "../models/squareAnnotationsResponse"; import { SquigglyAnnotationResponse } from "../models/squigglyAnnotationResponse"; import { SquigglyAnnotations } from "../models/squigglyAnnotations"; import { SquigglyAnnotationsResponse } from "../models/squigglyAnnotationsResponse"; import { StampAnnotationResponse } from "../models/stampAnnotationResponse"; import { StampAnnotations } from "../models/stampAnnotations"; import { StampAnnotationsResponse } from "../models/stampAnnotationsResponse"; import { StampBase } from "../models/stampBase"; import { StampInfo } from "../models/stampInfo"; import { StampsInfo } from "../models/stampsInfo"; import { StampsInfoResponse } from "../models/stampsInfoResponse"; import { StrikeOutAnnotationResponse } from "../models/strikeOutAnnotationResponse"; import { StrikeOutAnnotations } from "../models/strikeOutAnnotations"; import { StrikeOutAnnotationsResponse } from "../models/strikeOutAnnotationsResponse"; import { SvgImages } from "../models/svgImages"; import { Table } from "../models/table"; import { TableRecognized } from "../models/tableRecognized"; import { TableRecognizedResponse } from "../models/tableRecognizedResponse"; import { TablesRecognized } from "../models/tablesRecognized"; import { TablesRecognizedResponse } from "../models/tablesRecognizedResponse"; import { TextAnnotationResponse } from "../models/textAnnotationResponse"; import { TextAnnotations } from "../models/textAnnotations"; import { TextAnnotationsResponse } from "../models/textAnnotationsResponse"; import { TextBoxFieldResponse } from "../models/textBoxFieldResponse"; import { TextBoxFields } from "../models/textBoxFields"; import { TextBoxFieldsResponse } from "../models/textBoxFieldsResponse"; import { TextRectsResponse } from "../models/textRectsResponse"; import { TextReplaceResponse } from "../models/textReplaceResponse"; import { UnderlineAnnotationResponse } from "../models/underlineAnnotationResponse"; import { UnderlineAnnotations } from "../models/underlineAnnotations"; import { UnderlineAnnotationsResponse } from "../models/underlineAnnotationsResponse"; import { WordCountResponse } from "../models/wordCountResponse"; import { AnnotationInfo } from "../models/annotationInfo"; import { CheckBoxField } from "../models/checkBoxField"; import { ChoiceField } from "../models/choiceField"; import { ImageFooter } from "../models/imageFooter"; import { ImageHeader } from "../models/imageHeader"; import { ImageStamp } from "../models/imageStamp"; import { MarkupAnnotation } from "../models/markupAnnotation"; import { MovieAnnotation } from "../models/movieAnnotation"; import { PageNumberStamp } from "../models/pageNumberStamp"; import { PdfPageStamp } from "../models/pdfPageStamp"; import { PopupAnnotation } from "../models/popupAnnotation"; import { RadioButtonOptionField } from "../models/radioButtonOptionField"; import { RedactionAnnotation } from "../models/redactionAnnotation"; import { ScreenAnnotation } from "../models/screenAnnotation"; import { SignatureField } from "../models/signatureField"; import { TextBoxField } from "../models/textBoxField"; import { TextFooter } from "../models/textFooter"; import { TextHeader } from "../models/textHeader"; import { TextStamp } from "../models/textStamp"; import { CaretAnnotation } from "../models/caretAnnotation"; import { ComboBoxField } from "../models/comboBoxField"; import { CommonFigureAnnotation } from "../models/commonFigureAnnotation"; import { FileAttachmentAnnotation } from "../models/fileAttachmentAnnotation"; import { FreeTextAnnotation } from "../models/freeTextAnnotation"; import { HighlightAnnotation } from "../models/highlightAnnotation"; import { ImageStampPageSpecified } from "../models/imageStampPageSpecified"; import { InkAnnotation } from "../models/inkAnnotation"; import { LineAnnotation } from "../models/lineAnnotation"; import { ListBoxField } from "../models/listBoxField"; import { PolyAnnotation } from "../models/polyAnnotation"; import { PopupAnnotationWithParent } from "../models/popupAnnotationWithParent"; import { RadioButtonField } from "../models/radioButtonField"; import { SoundAnnotation } from "../models/soundAnnotation"; import { SquigglyAnnotation } from "../models/squigglyAnnotation"; import { StampAnnotation } from "../models/stampAnnotation"; import { StrikeOutAnnotation } from "../models/strikeOutAnnotation"; import { TextAnnotation } from "../models/textAnnotation"; import { TextStampPageSpecified } from "../models/textStampPageSpecified"; import { UnderlineAnnotation } from "../models/underlineAnnotation"; import { CircleAnnotation } from "../models/circleAnnotation"; import { PolyLineAnnotation } from "../models/polyLineAnnotation"; import { PolygonAnnotation } from "../models/polygonAnnotation"; import { SquareAnnotation } from "../models/squareAnnotation"; import { ObjectSerializer } from "../objectSerializer"; import { Configuration } from "../configuration"; import localVarRequest = require('request'); import http = require('http'); import { invokeApiMethod } from "../requestHelper"; let defaultBasePath = 'https://api.aspose.cloud/v3.0'; export class PdfApi { protected _basePath = defaultBasePath; protected defaultHeaders : any = {}; protected _useQuerystring : boolean = false; /** * API configuration */ public configuration: Configuration; /** * @param baseUrl SelfHost Base api Url. */ constructor(baseUrl: string); /** * @param appSID App SID. * @param appKey App key. */ constructor(appSID: string, appKey: string); constructor(...arr: string[]){ if (arr.length === 1) { this.configuration = new Configuration(true, "", "", arr[0]); } else if (arr.length === 2) { this.configuration = new Configuration(false, arr[0], arr[1], defaultBasePath); } } set useQuerystring(value: boolean) { this._useQuerystring = value; } set basePath(basePath: string) { this.configuration.baseUrl = basePath; } get basePath() { return this.configuration.baseUrl; } /** * * @summary Copy file * @param srcPath Source file path e.g. '/folder/file.ext' * @param destPath Destination file path * @param srcStorageName Source storage name * @param destStorageName Destination storage name * @param versionId File version ID to copy */ public async copyFile (srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string) : Promise<{ response: http.IncomingMessage; body?: any; }> { const localVarPath = this.basePath + '/pdf/storage/file/copy/{srcPath}' .replace('{' + 'srcPath' + '}', encodeURIComponent(String(srcPath)).replace('%2F', '/')); let localVarQueryParameters: any = {}; let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders); let localVarFormParams: any = {}; // verify required parameter 'srcPath' is not null or undefined if (srcPath === null || srcPath === undefined) { throw new Error('Required parameter srcPath was null or undefined when calling copyFile.'); } // verify required parameter 'destPath' is not null or undefined if (destPath === null || destPath === undefined) { throw new Error('Required parameter destPath was null or undefined when calling copyFile.'); } if (destPath !== undefined && null !== destPath) { localVarQueryParameters['destPath'] = ObjectSerializer.serialize(destPath, "string"); } if (srcStorageName !== undefined && null !== srcStorageName) { localVarQueryParameters['srcStorageName'] = ObjectSerializer.serialize(srcStorageName, "string"); } if (destStorageName !== undefined && null !== destStorageName) { localVarQueryParameters['destStorageName'] = ObjectSerializer.serialize(destStorageName, "string"); } if (versionId !== undefined && null !== versionId) { localVarQueryParameters['versionId'] = ObjectSerializer.serialize(versionId, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'PUT', 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, ""); return Promise.resolve({body: result, response}); } /** * * @summary Copy folder * @param srcPath Source folder path e.g. '/src' * @param destPath Destination folder path e.g. '/dst' * @param srcStorageName Source storage name * @param destStorageName Destination storage name */ public async copyFolder (srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string) : Promise<{ response: http.IncomingMessage; body?: any; }> { const localVarPath = this.basePath + '/pdf/storage/folder/copy/{srcPath}' .replace('{' + 'srcPath' + '}', encodeURIComponent(String(srcPath)).replace('%2F', '/')); let localVarQueryParameters: any = {}; let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders); let localVarFormParams: any = {}; // verify required parameter 'srcPath' is not null or undefined if (srcPath === null || srcPath === undefined) { throw new Error('Required parameter srcPath was null or undefined when calling copyFolder.'); } // verify required parameter 'destPath' is not null or undefined if (destPath === null || destPath === undefined) { throw new Error('Required parameter destPath was null or undefined when calling copyFolder.'); } if (destPath !== undefined && null !== destPath) { localVarQueryParameters['destPath'] = ObjectSerializer.serialize(destPath, "string"); } if (srcStorageName !== undefined && null !== srcStorageName) { localVarQueryParameters['srcStorageName'] = ObjectSerializer.serialize(srcStorageName, "string"); } if (destStorageName !== undefined && null !== destStorageName) { localVarQueryParameters['destStorageName'] = ObjectSerializer.serialize(destStorageName, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'PUT', 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, ""); return Promise.resolve({body: result, response}); } /** * * @summary Create the folder * @param path Folder path to create e.g. 'folder_1/folder_2/' * @param storageName Storage name */ public async createFolder (path: string, storageName?: string) : Promise<{ response: http.IncomingMessage; body?: any; }> { const localVarPath = this.basePath + '/pdf/storage/folder/{path}' .replace('{' + 'path' + '}', encodeURIComponent(String(path)).replace('%2F', '/')); let localVarQueryParameters: any = {}; let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders); let localVarFormParams: any = {}; // verify required parameter 'path' is not null or undefined if (path === null || path === undefined) { throw new Error('Required parameter path was null or undefined when calling createFolder.'); } if (storageName !== undefined && null !== storageName) { localVarQueryParameters['storageName'] = ObjectSerializer.serialize(storageName, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'PUT', 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, ""); return Promise.resolve({body: result, response}); } /** * * @summary Delete document annotation by ID * @param name The document name. * @param annotationId The annotation ID. * @param storage The document storage. * @param folder The document folder. */ public async deleteAnnotation (name: string, annotationId: string, storage?: string, folder?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/annotations/{annotationId}' .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/')) .replace('{' + 'annotationId' + '}', encodeURIComponent(String(annotationId)).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 deleteAnnotation.'); } // verify required parameter 'annotationId' is not null or undefined if (annotationId === null || annotationId === undefined) { throw new Error('Required parameter annotationId was null or undefined when calling deleteAnnotation.'); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete document bookmark by ID. * @param name The document name. * @param bookmarkPath The bookmark path. * @param folder The document folder. * @param storage The document storage. * @param password The password (Base64). */ public async deleteBookmark (name: string, bookmarkPath: string, folder?: string, storage?: string, password?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/bookmarks/bookmark/{bookmarkPath}' .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/')) .replace('{' + 'bookmarkPath' + '}', encodeURIComponent(String(bookmarkPath)).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 deleteBookmark.'); } // verify required parameter 'bookmarkPath' is not null or undefined if (bookmarkPath === null || bookmarkPath === undefined) { throw new Error('Required parameter bookmarkPath was null or undefined when calling deleteBookmark.'); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (password !== undefined && null !== password) { localVarQueryParameters['password'] = ObjectSerializer.serialize(password, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete all annotations from the document * @param name The document name. * @param storage The document storage. * @param folder The document folder. */ public async deleteDocumentAnnotations (name: string, storage?: string, folder?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/annotations' .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 deleteDocumentAnnotations.'); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete all document bookmarks. * @param name The document name. * @param folder The document folder. * @param storage The document storage. * @param password The password (Base64). */ public async deleteDocumentBookmarks (name: string, folder?: string, storage?: string, password?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/bookmarks/tree' .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 deleteDocumentBookmarks.'); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (password !== undefined && null !== password) { localVarQueryParameters['password'] = ObjectSerializer.serialize(password, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Remove document layer. * @param name The document name. * @param pageNumber Layer page. * @param layerId Layer Id. * @param folder The document folder. * @param storage The document storage. * @param passBase64 The password (Base64). */ public async deleteDocumentLayer (name: string, pageNumber: number, layerId: string, folder?: string, storage?: string, passBase64?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/layers' .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 deleteDocumentLayer.'); } // verify required parameter 'pageNumber' is not null or undefined if (pageNumber === null || pageNumber === undefined) { throw new Error('Required parameter pageNumber was null or undefined when calling deleteDocumentLayer.'); } // verify required parameter 'layerId' is not null or undefined if (layerId === null || layerId === undefined) { throw new Error('Required parameter layerId was null or undefined when calling deleteDocumentLayer.'); } if (pageNumber !== undefined && null !== pageNumber) { localVarQueryParameters['pageNumber'] = ObjectSerializer.serialize(pageNumber, "number"); } if (layerId !== undefined && null !== layerId) { localVarQueryParameters['layerId'] = ObjectSerializer.serialize(layerId, "string"); } 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: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete all link annotations from the document * @param name The document name. * @param storage The document storage. * @param folder The document folder. */ public async deleteDocumentLinkAnnotations (name: string, storage?: string, folder?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/links' .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 deleteDocumentLinkAnnotations.'); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete all stamps from the document * @param name The document name. * @param storage The document storage. * @param folder The document folder. * @param password Base64 encoded password. */ public async deleteDocumentStamps (name: string, storage?: string, folder?: string, password?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/stamps' .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 deleteDocumentStamps.'); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } if (password !== undefined && null !== password) { localVarQueryParameters['password'] = ObjectSerializer.serialize(password, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete all tables from the document * @param name The document name. * @param storage The document storage. * @param folder The document folder. */ public async deleteDocumentTables (name: string, storage?: string, folder?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/tables' .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 deleteDocumentTables.'); } if (storage !== undefined && null !== storage) { localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string"); } if (folder !== undefined && null !== folder) { localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string"); } let localVarUseFormData = false; let fileData = null; let localVarRequestOptions: localVarRequest.Options = { method: 'DELETE', 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, "AsposeResponse"); return Promise.resolve({body: result, response}); } /** * * @summary Delete document field by name. * @param name The document name. * @param fieldName The field name/ * @param storage The document storage. * @param folder The document folder. */ public async deleteField (name: string, fieldName: string, storage?: string, folder?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse; }> { const localVarPath = this.basePath + '/pdf/{name}/fields/{fieldName}' .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/')) .replace('{' + 'fieldName' + '}', encodeURIComponent(String(fieldName)).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 deleteField.'); } // verify required parameter 'fieldName' is not null or undefined if (fieldName === null || fieldName =