groupdocs-merger-cloud
Version:
GroupDocs.Merger Cloud SDK for Node.js
1,519 lines (1,518 loc) • 32.6 kB
TypeScript
/// <reference types="node" />
/**
* Metered license consumption information
*/
export declare class ConsumptionResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Amount of used credits
*/
credit: number;
/**
* Amount of MBs processed
*/
quantity: number;
constructor(init?: Partial<ConsumptionResult>);
}
/**
* Class for disc space information.
*/
export declare class DiscUsage {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Application used disc space.
*/
usedSize: number;
/**
* Total disc space.
*/
totalSize: number;
constructor(init?: Partial<DiscUsage>);
}
/**
* Describes document result
*/
export declare class DocumentResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Path of the output document
*/
path: string;
constructor(init?: Partial<DocumentResult>);
}
/**
* The error details
*/
export declare class ErrorDetails {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* The request id
*/
requestId: string;
/**
* Date
*/
date: Date;
constructor(init?: Partial<ErrorDetails>);
}
/**
* Describes file properties
*/
export declare class FileInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File path in storage
*/
filePath: string;
/**
* Storage name
*/
storageName: string;
/**
* Version ID
*/
versionId: string;
/**
* Password to open file
*/
password: string;
constructor(init?: Partial<FileInfo>);
}
/**
* File versions FileVersion.
*/
export declare class FileVersions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File versions FileVersion.
*/
value: Array<FileVersion>;
constructor(init?: Partial<FileVersions>);
}
/**
* Files list
*/
export declare class FilesList {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Files and folders contained by folder StorageFile.
*/
value: Array<StorageFile>;
constructor(init?: Partial<FilesList>);
}
/**
* File upload result
*/
export declare class FilesUploadResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of uploaded file names
*/
uploaded: Array<string>;
/**
* List of errors.
*/
errors: Array<Error>;
constructor(init?: Partial<FilesUploadResult>);
}
/**
* Describes file format properties
*/
export declare class Format {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File extension
*/
extension: string;
/**
* File format
*/
fileFormat: string;
constructor(init?: Partial<Format>);
}
/**
* Describes object which contains list of supported file formats.
*/
export declare class FormatsResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Supported file formats collection
*/
formats: Array<Format>;
constructor(init?: Partial<FormatsResult>);
}
/**
* Describes document properties result
*/
export declare class InfoResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Document extension
*/
extension: string;
/**
* Collection page descriptors
*/
pages: Array<PageInfo>;
/**
* Document size in bytes
*/
size: number;
/**
* File format
*/
fileFormat: string;
constructor(init?: Partial<InfoResult>);
}
/**
* Describes document for join operation.
*/
export declare class JoinItem {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File info.
*/
fileInfo: FileInfo;
/**
* List of page numbers to use in a Join operation. NOTE: page numbering starts from 1.
*/
pages: Array<number>;
/**
* Start page number. Ignored if Pages collection is not empty.
*/
startPageNumber: number;
/**
* End page number. Ignored if Pages collection is not empty.
*/
endPageNumber: number;
/**
* Range mode. Ignored if Pages collection is not empty. Default value is AllPages.
*/
rangeMode: JoinItem.RangeModeEnum;
/**
* Allows to join word documents without empty space between documents.
*/
wordJoinMode: JoinItem.WordJoinModeEnum;
/**
* Compliance mode for the Word Ooxml format
*/
wordJoinCompliance: JoinItem.WordJoinComplianceEnum;
/**
* Possible modes for the image joining.
*/
imageJoinMode: JoinItem.ImageJoinModeEnum;
constructor(init?: Partial<JoinItem>);
}
export declare namespace JoinItem {
enum RangeModeEnum {
AllPages,
OddPages,
EvenPages
}
enum WordJoinModeEnum {
Default,
Continuous
}
enum WordJoinComplianceEnum {
Ecma3762006,
Iso295002008Transitional,
Iso295002008Strict,
Auto
}
enum ImageJoinModeEnum {
Horizontal,
Vertical
}
}
/**
* Defines options for documents Join method
*/
export declare class JoinOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Documents descriptions for Join operation
*/
joinItems: Array<JoinItem>;
/**
* The output path
*/
outputPath: string;
constructor(init?: Partial<JoinOptions>);
}
/**
* Error
*/
export declare class ModelError {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Code
*/
code: string;
/**
* Message
*/
message: string;
/**
* Description
*/
description: string;
/**
* Inner Error
*/
innerError: ErrorDetails;
constructor(init?: Partial<ModelError>);
}
/**
* Describes result that contains multiple documents
*/
export declare class MultiDocumentResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Documents collection
*/
documents: Array<DocumentResult>;
constructor(init?: Partial<MultiDocumentResult>);
}
/**
* Object exists
*/
export declare class ObjectExist {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Indicates that the file or folder exists.
*/
exists: boolean;
/**
* True if it is a folder, false if it is a file.
*/
isFolder: boolean;
constructor(init?: Partial<ObjectExist>);
}
/**
* Options
*/
export declare class Options {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File info
*/
fileInfo: FileInfo;
/**
* The output path.
*/
outputPath: string;
constructor(init?: Partial<Options>);
}
/**
* Describes page properties
*/
export declare class PageInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Page width in pixels when converted to image
*/
width: number;
/**
* Page height in pixels when converted to image
*/
height: number;
/**
* Document page number
*/
pageNumber: number;
/**
* Indicates whether page is visible or not
*/
visible: boolean;
constructor(init?: Partial<PageInfo>);
}
/**
* Describesd result of password check operation
*/
export declare class PasswordResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Indicates whether document is password protected or not
*/
isPasswordSet: boolean;
constructor(init?: Partial<PasswordResult>);
}
/**
* Storage exists
*/
export declare class StorageExist {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Shows that the storage exists.
*/
exists: boolean;
constructor(init?: Partial<StorageExist>);
}
/**
* File or folder information
*/
export declare class StorageFile {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File or folder name.
*/
name: string;
/**
* True if it is a folder.
*/
isFolder: boolean;
/**
* File or folder last modified DateTime.
*/
modifiedDate: Date;
/**
* File or folder size.
*/
size: number;
/**
* File or folder path.
*/
path: string;
constructor(init?: Partial<StorageFile>);
}
/**
* File Version
*/
export declare class FileVersion extends StorageFile {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File Version ID.
*/
versionId: string;
/**
* Specifies whether the file is (true) or is not (false) the latest version of an file.
*/
isLatest: boolean;
constructor(init?: Partial<FileVersion>);
}
/**
* Import API options
*/
export declare class ImportOptions extends Options {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of files paths to import as attachments
*/
attachments: Array<string>;
constructor(init?: Partial<ImportOptions>);
}
/**
* Move page options
*/
export declare class MoveOptions extends Options {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Page number to move
*/
pageNumber: number;
/**
* New page number
*/
newPageNumber: number;
constructor(init?: Partial<MoveOptions>);
}
/**
* Describes options for specifying page or pages range
*/
export declare class PageOptions extends Options {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of page numbers to use in a specific API method. NOTE: page numbering starts from 1.
*/
pages: Array<number>;
/**
* Start page number. Ignored if Pages collection is not empty.
*/
startPageNumber: number;
/**
* End page number. Ignored if Pages collection is not empty.
*/
endPageNumber: number;
/**
* Range mode. Ignored if Pages collection is not empty. Default value is AllPages.
*/
rangeMode: PageOptions.RangeModeEnum;
constructor(init?: Partial<PageOptions>);
}
export declare namespace PageOptions {
enum RangeModeEnum {
AllPages,
OddPages,
EvenPages
}
}
/**
* Describes options for document pages Swap operation
*/
export declare class SwapOptions extends Options {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* First page number to exchange
*/
firstPageNumber: number;
/**
* Second page number to exchange
*/
secondPageNumber: number;
constructor(init?: Partial<SwapOptions>);
}
/**
* Defines options for document password Update operation
*/
export declare class UpdatePasswordOptions extends Options {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* The new document password
*/
newPassword: string;
constructor(init?: Partial<UpdatePasswordOptions>);
}
/**
* Options for document pages Extract operation
*/
export declare class ExtractOptions extends PageOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<ExtractOptions>);
}
export declare namespace ExtractOptions {
}
/**
* Options for changing document page orientation
*/
export declare class OrientationOptions extends PageOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Orientation mode
*/
mode: OrientationOptions.ModeEnum;
constructor(init?: Partial<OrientationOptions>);
}
export declare namespace OrientationOptions {
enum ModeEnum {
Portrait,
Landscape
}
}
/**
* Represents document preview options
*/
export declare class PreviewOptions extends PageOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Preview width
*/
width: number;
/**
* Preview height
*/
height: number;
/**
* Preview image format
*/
format: PreviewOptions.FormatEnum;
constructor(init?: Partial<PreviewOptions>);
}
export declare namespace PreviewOptions {
enum FormatEnum {
Jpeg,
Png,
Bmp
}
}
/**
* Remove pages options
*/
export declare class RemoveOptions extends PageOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
constructor(init?: Partial<RemoveOptions>);
}
export declare namespace RemoveOptions {
}
/**
* Rotate pages options
*/
export declare class RotateOptions extends PageOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Get or sets desired page rotation - 90, 180 or 270 degrees.
*/
mode: RotateOptions.ModeEnum;
constructor(init?: Partial<RotateOptions>);
}
export declare namespace RotateOptions {
enum ModeEnum {
Rotate90,
Rotate180,
Rotate270
}
}
/**
* Defines options for document Split operation
*/
export declare class SplitOptions extends PageOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Document split mode
*/
mode: SplitOptions.ModeEnum;
constructor(init?: Partial<SplitOptions>);
}
export declare namespace SplitOptions {
enum ModeEnum {
Pages,
Intervals
}
}
declare const enumsMap: {
"JoinItem.RangeModeEnum": typeof JoinItem.RangeModeEnum;
"JoinItem.WordJoinModeEnum": typeof JoinItem.WordJoinModeEnum;
"JoinItem.WordJoinComplianceEnum": typeof JoinItem.WordJoinComplianceEnum;
"JoinItem.ImageJoinModeEnum": typeof JoinItem.ImageJoinModeEnum;
"PageOptions.RangeModeEnum": typeof PageOptions.RangeModeEnum;
"OrientationOptions.ModeEnum": typeof OrientationOptions.ModeEnum;
"PreviewOptions.FormatEnum": typeof PreviewOptions.FormatEnum;
"RotateOptions.ModeEnum": typeof RotateOptions.ModeEnum;
"SplitOptions.ModeEnum": typeof SplitOptions.ModeEnum;
};
declare const typeMap: {
ConsumptionResult: typeof ConsumptionResult;
DiscUsage: typeof DiscUsage;
DocumentResult: typeof DocumentResult;
ErrorDetails: typeof ErrorDetails;
FileInfo: typeof FileInfo;
FileVersions: typeof FileVersions;
FilesList: typeof FilesList;
FilesUploadResult: typeof FilesUploadResult;
Format: typeof Format;
FormatsResult: typeof FormatsResult;
InfoResult: typeof InfoResult;
JoinItem: typeof JoinItem;
JoinOptions: typeof JoinOptions;
ModelError: typeof ModelError;
MultiDocumentResult: typeof MultiDocumentResult;
ObjectExist: typeof ObjectExist;
Options: typeof Options;
PageInfo: typeof PageInfo;
PasswordResult: typeof PasswordResult;
StorageExist: typeof StorageExist;
StorageFile: typeof StorageFile;
FileVersion: typeof FileVersion;
ImportOptions: typeof ImportOptions;
MoveOptions: typeof MoveOptions;
PageOptions: typeof PageOptions;
SwapOptions: typeof SwapOptions;
UpdatePasswordOptions: typeof UpdatePasswordOptions;
ExtractOptions: typeof ExtractOptions;
OrientationOptions: typeof OrientationOptions;
PreviewOptions: typeof PreviewOptions;
RemoveOptions: typeof RemoveOptions;
RotateOptions: typeof RotateOptions;
SplitOptions: typeof SplitOptions;
};
export { enumsMap, typeMap };
/**
* Request model for Import operation.
*/
export declare class ImportRequest {
/**
* Import options
*/
options: ImportOptions;
constructor(options: ImportOptions);
}
/**
* Request model for Join operation.
*/
export declare class JoinRequest {
/**
* Join options
*/
options: JoinOptions;
constructor(options: JoinOptions);
}
/**
* Request model for Preview operation.
*/
export declare class PreviewRequest {
/**
* Preview options
*/
options: PreviewOptions;
constructor(options: PreviewOptions);
}
/**
* Request model for Split operation.
*/
export declare class SplitRequest {
/**
* SplitOptions
*/
options: SplitOptions;
constructor(options: SplitOptions);
}
/**
* Request model for CopyFile operation.
*/
export declare class CopyFileRequest {
/**
* Source file path e.g. '/folder/file.ext'
*/
srcPath: string;
/**
* Destination file path
*/
destPath: string;
/**
* Source storage name
*/
srcStorageName: string;
/**
* Destination storage name
*/
destStorageName: string;
/**
* File version ID to copy
*/
versionId: string;
constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string);
}
/**
* Request model for DeleteFile operation.
*/
export declare class DeleteFileRequest {
/**
* File path e.g. '/folder/file.ext'
*/
path: string;
/**
* Storage name
*/
storageName: string;
/**
* File version ID to delete
*/
versionId: string;
constructor(path: string, storageName?: string, versionId?: string);
}
/**
* Request model for DownloadFile operation.
*/
export declare class DownloadFileRequest {
/**
* File path e.g. '/folder/file.ext'
*/
path: string;
/**
* Storage name
*/
storageName: string;
/**
* File version ID to download
*/
versionId: string;
constructor(path: string, storageName?: string, versionId?: string);
}
/**
* Request model for MoveFile operation.
*/
export declare class MoveFileRequest {
/**
* Source file path e.g. '/src.ext'
*/
srcPath: string;
/**
* Destination file path e.g. '/dest.ext'
*/
destPath: string;
/**
* Source storage name
*/
srcStorageName: string;
/**
* Destination storage name
*/
destStorageName: string;
/**
* File version ID to move
*/
versionId: string;
constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string);
}
/**
* Request model for UploadFile operation.
*/
export declare class UploadFileRequest {
/**
* Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.
*/
path: string;
/**
* File to upload
*/
file: Buffer;
/**
* Storage name
*/
storageName: string;
constructor(path: string, file: Buffer, storageName?: string);
}
/**
* Request model for CopyFolder operation.
*/
export declare class CopyFolderRequest {
/**
* Source folder path e.g. '/src'
*/
srcPath: string;
/**
* Destination folder path e.g. '/dst'
*/
destPath: string;
/**
* Source storage name
*/
srcStorageName: string;
/**
* Destination storage name
*/
destStorageName: string;
constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string);
}
/**
* Request model for CreateFolder operation.
*/
export declare class CreateFolderRequest {
/**
* Folder path to create e.g. 'folder_1/folder_2/'
*/
path: string;
/**
* Storage name
*/
storageName: string;
constructor(path: string, storageName?: string);
}
/**
* Request model for DeleteFolder operation.
*/
export declare class DeleteFolderRequest {
/**
* Folder path e.g. '/folder'
*/
path: string;
/**
* Storage name
*/
storageName: string;
/**
* Enable to delete folders, subfolders and files
*/
recursive: boolean;
constructor(path: string, storageName?: string, recursive?: boolean);
}
/**
* Request model for GetFilesList operation.
*/
export declare class GetFilesListRequest {
/**
* Folder path e.g. '/folder'
*/
path: string;
/**
* Storage name
*/
storageName: string;
constructor(path: string, storageName?: string);
}
/**
* Request model for MoveFolder operation.
*/
export declare class MoveFolderRequest {
/**
* Folder path to move e.g. '/folder'
*/
srcPath: string;
/**
* Destination folder path to move to e.g '/dst'
*/
destPath: string;
/**
* Source storage name
*/
srcStorageName: string;
/**
* Destination storage name
*/
destStorageName: string;
constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string);
}
/**
* Request model for GetInfo operation.
*/
export declare class GetInfoRequest {
/**
* File Info
*/
fileInfo: FileInfo;
constructor(fileInfo: FileInfo);
}
/**
* Request model for Extract operation.
*/
export declare class ExtractRequest {
/**
* Extract options
*/
options: ExtractOptions;
constructor(options: ExtractOptions);
}
/**
* Request model for Move operation.
*/
export declare class MoveRequest {
/**
* Move options
*/
options: MoveOptions;
constructor(options: MoveOptions);
}
/**
* Request model for Orientation operation.
*/
export declare class OrientationRequest {
/**
* Orientation options
*/
options: OrientationOptions;
constructor(options: OrientationOptions);
}
/**
* Request model for Remove operation.
*/
export declare class RemoveRequest {
/**
* Remove options
*/
options: RemoveOptions;
constructor(options: RemoveOptions);
}
/**
* Request model for Rotate operation.
*/
export declare class RotateRequest {
/**
* Rotate options
*/
options: RotateOptions;
constructor(options: RotateOptions);
}
/**
* Request model for Swap operation.
*/
export declare class SwapRequest {
/**
* Swap options
*/
options: SwapOptions;
constructor(options: SwapOptions);
}
/**
* Request model for AddPassword operation.
*/
export declare class AddPasswordRequest {
/**
* Options to specify document name and new password
*/
options: Options;
constructor(options: Options);
}
/**
* Request model for CheckPassword operation.
*/
export declare class CheckPasswordRequest {
/**
* File path
*/
filePath: string;
/**
* Storage name
*/
storageName: string;
/**
* Version Id
*/
versionId: string;
constructor(filePath: string, storageName?: string, versionId?: string);
}
/**
* Request model for RemovePassword operation.
*/
export declare class RemovePasswordRequest {
/**
* Options to specify document name and current password
*/
options: Options;
constructor(options: Options);
}
/**
* Request model for UpdatePassword operation.
*/
export declare class UpdatePasswordRequest {
/**
* Options to specify document name, current and new password
*/
options: UpdatePasswordOptions;
constructor(options: UpdatePasswordOptions);
}
/**
* Request model for GetDiscUsage operation.
*/
export declare class GetDiscUsageRequest {
/**
* Storage name
*/
storageName: string;
constructor(storageName?: string);
}
/**
* Request model for GetFileVersions operation.
*/
export declare class GetFileVersionsRequest {
/**
* File path e.g. '/file.ext'
*/
path: string;
/**
* Storage name
*/
storageName: string;
constructor(path: string, storageName?: string);
}
/**
* Request model for ObjectExists operation.
*/
export declare class ObjectExistsRequest {
/**
* File or folder path e.g. '/file.ext' or '/folder'
*/
path: string;
/**
* Storage name
*/
storageName: string;
/**
* File version ID
*/
versionId: string;
constructor(path: string, storageName?: string, versionId?: string);
}
/**
* Request model for StorageExists operation.
*/
export declare class StorageExistsRequest {
/**
* Storage name
*/
storageName: string;
constructor(storageName: string);
}