groupdocs-comparison-cloud
Version:
GroupDocs.Comparison Cloud SDK for Node.js
1,582 lines (1,581 loc) • 34.8 kB
TypeScript
/// <reference types="node" />
/**
* Options for apply revisions method
*/
export declare class ApplyRevisionsOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Information about source file
*/
sourceFile: FileInfo;
/**
* Revisions to apply or reject.
*/
revisions: Array<RevisionInfo>;
/**
* Indicates whether to apply all revisions in the document
*/
acceptAll: boolean;
/**
* Indicates whether to reject all revisions in the document
*/
rejectAll: boolean;
/**
* Path to the resultant document (if not specified the document will not be saved)
*/
outputPath: string;
constructor(init?: Partial<ApplyRevisionsOptions>);
}
/**
* ChangeInfo Object fields
*/
export declare class ChangeInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Id of change
*/
id: number;
/**
* Action (accept or reject). This field shows comparison what to do with this change
*/
comparisonAction: ChangeInfo.ComparisonActionEnum;
/**
* Type of change (Inserted, Deleted or StyleChanged)
*/
type: ChangeInfo.TypeEnum;
/**
* Text of changed element
*/
text: string;
/**
* Changed text of target doc
*/
targetText: string;
/**
* Array of authors who made this change (used for multi comparison)
*/
authors: Array<string>;
/**
* Array of style changes
*/
styleChangeInfo: Array<StyleChangeInfo>;
/**
* Page where current change is placed
*/
pageInfo: PageInfo;
/**
* Coordinates of changed element
*/
box: Rectangle;
constructor(init?: Partial<ChangeInfo>);
}
export declare namespace ChangeInfo {
enum ComparisonActionEnum {
None,
Accept,
Reject
}
enum TypeEnum {
None,
Modified,
Inserted,
Deleted,
Added,
NotModified,
StyleChanged,
Resized,
Moved,
MovedAndResized,
ShiftedAndResized
}
}
/**
* Defines comparison options
*/
export declare class ComparisonOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Information about source file
*/
sourceFile: FileInfo;
/**
* Information about target file(s)
*/
targetFiles: Array<FileInfo>;
/**
* Comparison settings
*/
settings: Settings;
/**
* Changes type. Used only for Changes resource(/comparison/changes)
*/
changeType: ComparisonOptions.ChangeTypeEnum;
/**
* Path to the resultant document (if not specified the document will not be saved)
*/
outputPath: string;
constructor(init?: Partial<ComparisonOptions>);
}
export declare namespace ComparisonOptions {
enum ChangeTypeEnum {
None,
Modified,
Inserted,
Deleted,
Added,
NotModified,
StyleChanged,
Resized,
Moved,
MovedAndResized,
ShiftedAndResized
}
}
/**
* 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>);
}
/**
* DiagramMasterSetting Object fields
*/
export declare class DiagramMasterSetting {
/**
* 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 to custom master path
*/
masterPath: string;
/**
* Value of using master from source and target document together
*/
useSourceMaster: boolean;
constructor(init?: Partial<DiagramMasterSetting>);
}
/**
* 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>);
}
/**
* 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 compared document
*/
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;
}[];
/**
* Path to the compared document
*/
filePath: string;
/**
* Document version
*/
versionId: string;
/**
* Storage name
*/
storageName: string;
/**
* Password for encrypted document
*/
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>);
}
/**
* File-format
*/
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 format extension
*/
extension: string;
/**
* File format name
*/
fileFormat: string;
constructor(init?: Partial<Format>);
}
/**
* Describes 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
*/
formats: Array<Format>;
constructor(init?: Partial<FormatsResult>);
}
/**
* Represents document information
*/
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 format
*/
format: string;
/**
* Document file extension
*/
extension: string;
/**
* Document file size
*/
size: number;
/**
* Pages count
*/
pageCount: number;
constructor(init?: Partial<InfoResult>);
}
/**
* ItemsStyle Object fields
*/
export declare class ItemsStyle {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Font color for changed components
*/
fontColor: string;
/**
* Highlight color for changed components
*/
highlightColor: string;
/**
* Start tag for changed components
*/
beginSeparatorString: string;
/**
* End tag for changed components
*/
endSeparatorString: string;
/**
* Bold style for changed components
*/
bold: boolean;
/**
* Italic style for changed components
*/
italic: boolean;
/**
* Strike through style for changed components
*/
strikeThrough: boolean;
/**
* Underline style for changed components
*/
underline: boolean;
constructor(init?: Partial<ItemsStyle>);
}
/**
* Provides information for the object link. This is supposed to be an atom:link, therefore it should have all attributes specified here http://tools.ietf.org/html/rfc4287#section-4.2.7
*/
export declare class Link {
/**
* 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 \"href\" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference
*/
href: string;
/**
* atom:link elements MAY have a \"rel\" attribute that indicates the link relation type. If the \"rel\" attribute is not present, the link element MUST be interpreted as if the link relation type is \"alternate\".
*/
rel: string;
/**
* On the link element, the \"type\" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation.
*/
type: string;
/**
* The \"title\" attribute conveys human-readable information about the link. The content of the \"title\" attribute is Language-Sensitive.
*/
title: string;
constructor(init?: Partial<Link>);
}
/**
* MetaData Object fields
*/
export declare class Metadata {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Value of document Author
*/
author: string;
/**
* Value of last save by author of document
*/
lastSaveBy: string;
/**
* Value of Company of document
*/
company: string;
constructor(init?: Partial<Metadata>);
}
/**
* 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>);
}
/**
* 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>);
}
/**
* Represents information about page
*/
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
*/
width: number;
/**
* Page height
*/
height: number;
/**
* Page number
*/
pageNumber: number;
constructor(init?: Partial<PageInfo>);
}
/**
* Defines preview options
*/
export declare class PreviewOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Input file info
*/
fileInfo: FileInfo;
/**
* Preview image format
*/
format: PreviewOptions.FormatEnum;
/**
* Path to folder with preview results
*/
outputFolder: string;
/**
* Preview width
*/
width: number;
/**
* Preview height
*/
height: number;
/**
* Page numbers that will be previewed.
*/
pageNumbers: Array<number>;
constructor(init?: Partial<PreviewOptions>);
}
export declare namespace PreviewOptions {
enum FormatEnum {
Jpeg,
Png,
Bmp
}
}
/**
* Rectangle model
*/
export declare class Rectangle {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Height
*/
height: number;
/**
* Width
*/
width: number;
/**
* X coordinate
*/
x: number;
/**
* Y coordinate
*/
y: number;
constructor(init?: Partial<Rectangle>);
}
/**
* Provides information about one revision.
*/
export declare class RevisionInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Id of revision
*/
id: number;
/**
* Action (accept or reject). This field allows you to influence the display of the revision.
*/
action: RevisionInfo.ActionEnum;
/**
* The text that is in revision.
*/
text: string;
/**
* Author.
*/
author: string;
/**
* RevisionHandler type, depending on the type the Action (accept or reject) logic changes.
*/
type: RevisionInfo.TypeEnum;
constructor(init?: Partial<RevisionInfo>);
}
export declare namespace RevisionInfo {
enum ActionEnum {
None,
Accept,
Reject
}
enum TypeEnum {
Insertion,
Deletion,
FormatChange,
StyleDefinitionChange,
Moving
}
}
/**
* Defines comparison process additional settings
*/
export declare class Settings {
/**
* 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 to add summary page to resultant document or not
*/
generateSummaryPage: boolean;
/**
* Indicates whether to show deleted components in resultant document or not
*/
showDeletedContent: boolean;
/**
* Indicates whether to show inserted components in resultant document or not
*/
showInsertedContent: boolean;
/**
* Indicates whether to detect style changes or not
*/
styleChangeDetection: boolean;
/**
* Style for inserted components
*/
insertedItemsStyle: ItemsStyle;
/**
* Style for deleted components
*/
deletedItemsStyle: ItemsStyle;
/**
* Style for components with changed style
*/
changedItemsStyle: ItemsStyle;
/**
* An array of delimiters to split text into words
*/
wordsSeparatorChars: Array<string>;
/**
* Gets of sets the comparison details level
*/
detailsLevel: Settings.DetailsLevelEnum;
/**
* Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents
*/
useFramesForDelInsElements: boolean;
/**
* Indicates whether to calculate coordinates for changed components
*/
calculateComponentCoordinates: boolean;
/**
* Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents
*/
markChangedContent: boolean;
/**
* Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted
*/
markNestedContent: boolean;
/**
* Gets or sets type of metadata to clone
*/
cloneMetadata: Settings.CloneMetadataEnum;
/**
* Gets or sets user metadata
*/
metaData: Metadata;
/**
* Gets or sets type of password saving
*/
passwordSaveOption: Settings.PasswordSaveOptionEnum;
/**
* Gets or sets user password to resultant document
*/
password: string;
/**
* Gets or sets master for Diagram document
*/
diagramMasterSetting: DiagramMasterSetting;
/**
* Gets or sets original document size when picture is compared with other different formats
*/
originalSize: Size;
/**
* Control to turn on comparison of header/footer contents
*/
headerFootersComparison: boolean;
/**
* Gets or sets the result document paper size
*/
paperSize: Settings.PaperSizeEnum;
/**
* Gets or sets a sensitivity of comparison. Default is 75
*/
sensitivityOfComparison: number;
constructor(init?: Partial<Settings>);
}
export declare namespace Settings {
enum DetailsLevelEnum {
Low,
Middle,
High
}
enum CloneMetadataEnum {
Default,
Source,
Target,
FileAuthor
}
enum PasswordSaveOptionEnum {
None,
Source,
Target,
User
}
enum PaperSizeEnum {
Default,
A0,
A1,
A2,
A3,
A4,
A5,
A6,
A7,
A8
}
}
/**
* Item size
*/
export declare class Size {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Width of item
*/
width: number;
/**
* Height of item
*/
height: number;
constructor(init?: Partial<Size>);
}
/**
* 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>);
}
/**
* StyleChangeInfo Object fields
*/
export declare class StyleChangeInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Name of changed style
*/
changedProperty: string;
/**
* Value of changed style from source document
*/
oldValue: string;
/**
* Value of changed style from target document
*/
newValue: string;
constructor(init?: Partial<StyleChangeInfo>);
}
/**
* 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>);
}
/**
* Comparison option class for updates endpoint
*/
export declare class UpdatesOptions extends ComparisonOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Changes to apply or reject. Used only for updates resource (/comparison/updates)
*/
changes: Array<ChangeInfo>;
constructor(init?: Partial<UpdatesOptions>);
}
export declare namespace UpdatesOptions {
}
declare const enumsMap: {
"ChangeInfo.ComparisonActionEnum": typeof ChangeInfo.ComparisonActionEnum;
"ChangeInfo.TypeEnum": typeof ChangeInfo.TypeEnum;
"ComparisonOptions.ChangeTypeEnum": typeof ComparisonOptions.ChangeTypeEnum;
"PreviewOptions.FormatEnum": typeof PreviewOptions.FormatEnum;
"RevisionInfo.ActionEnum": typeof RevisionInfo.ActionEnum;
"RevisionInfo.TypeEnum": typeof RevisionInfo.TypeEnum;
"Settings.DetailsLevelEnum": typeof Settings.DetailsLevelEnum;
"Settings.CloneMetadataEnum": typeof Settings.CloneMetadataEnum;
"Settings.PasswordSaveOptionEnum": typeof Settings.PasswordSaveOptionEnum;
"Settings.PaperSizeEnum": typeof Settings.PaperSizeEnum;
};
declare const typeMap: {
ApplyRevisionsOptions: typeof ApplyRevisionsOptions;
ChangeInfo: typeof ChangeInfo;
ComparisonOptions: typeof ComparisonOptions;
ConsumptionResult: typeof ConsumptionResult;
DiagramMasterSetting: typeof DiagramMasterSetting;
DiscUsage: typeof DiscUsage;
ErrorDetails: typeof ErrorDetails;
FileInfo: typeof FileInfo;
FileVersions: typeof FileVersions;
FilesList: typeof FilesList;
FilesUploadResult: typeof FilesUploadResult;
Format: typeof Format;
FormatsResult: typeof FormatsResult;
InfoResult: typeof InfoResult;
ItemsStyle: typeof ItemsStyle;
Link: typeof Link;
Metadata: typeof Metadata;
ModelError: typeof ModelError;
ObjectExist: typeof ObjectExist;
PageInfo: typeof PageInfo;
PreviewOptions: typeof PreviewOptions;
Rectangle: typeof Rectangle;
RevisionInfo: typeof RevisionInfo;
Settings: typeof Settings;
Size: typeof Size;
StorageExist: typeof StorageExist;
StorageFile: typeof StorageFile;
StyleChangeInfo: typeof StyleChangeInfo;
FileVersion: typeof FileVersion;
UpdatesOptions: typeof UpdatesOptions;
};
export { enumsMap, typeMap };
/**
* Request model for Comparisons operation.
*/
export declare class ComparisonsRequest {
/**
* Comparison options
*/
comparisonOptions: ComparisonOptions;
constructor(comparisonOptions: ComparisonOptions);
}
/**
* Request model for PostChanges operation.
*/
export declare class PostChangesRequest {
/**
* Comparison options
*/
comparisonOptions: ComparisonOptions;
constructor(comparisonOptions: ComparisonOptions);
}
/**
* Request model for PutChangesDocument operation.
*/
export declare class PutChangesDocumentRequest {
/**
* Comparison options
*/
updatesOptions: UpdatesOptions;
constructor(updatesOptions: UpdatesOptions);
}
/**
* 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 GetDocumentInfo operation.
*/
export declare class GetDocumentInfoRequest {
/**
* Gets or sets fileInfo
*/
fileInfo: FileInfo;
constructor(fileInfo: FileInfo);
}
/**
* Request model for Preview operation.
*/
export declare class PreviewRequest {
/**
* Preview options
*/
previewOptions: PreviewOptions;
constructor(previewOptions: PreviewOptions);
}
/**
* Request model for ApplyRevisions operation.
*/
export declare class ApplyRevisionsRequest {
/**
* Apply revisions options
*/
revisionOptions: ApplyRevisionsOptions;
constructor(revisionOptions: ApplyRevisionsOptions);
}
/**
* Request model for GetRevisions operation.
*/
export declare class GetRevisionsRequest {
/**
* File information
*/
fileInfo: FileInfo;
constructor(fileInfo: FileInfo);
}
/**
* 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);
}