UNPKG

asposeslidescloud

Version:

Aspose.Slides Cloud SDK for Node.js

1,104 lines 174 kB
/// <reference types="node" /> /// <reference types="node" /> /// <reference types="node" /> import http = require("http"); import { Readable } from 'stream'; import { Configuration } from "./internal/configuration"; import * as model from "./model"; export * from "./model"; export declare class SlidesApi { private _configuration; get configuration(): Configuration; /** * @param appSid Client Id. * @param appKey Client Secret. * @param baseUrl Base api Url. * @param authBaseUrl Base authentication Url. * @param debugMode A value indicating whether debug mode. In debug mode all requests and responses are logged to console. * @param timeout Timeout (in seconds) for an operation. Applies to the Slides operation, not to the HTTP request. * @param httpRequestTimeout Timeout (in seconds) for an HTTP request. Applies to the HTTP request, not to the Slides operation. */ constructor(appSid: string, appKey: string, baseUrl?: string, authBaseUrl?: string, debugMode?: boolean, timeout?: number, httpRequestTimeout?: number); /** * Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or aligns them relative to each other. * @param name Document name. * @param slideIndex Slide index. * @param alignmentType Alignment type that will be applied to the shapes. * @param alignToSlide If true, shapes will be aligned relative to the slide edges. * @param shapes Shapes indexes. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ alignShapes(name: string, slideIndex: number, alignmentType: model.ShapesAlignmentType, alignToSlide?: boolean, shapes?: Array<number>, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Shapes; }>; /** * Changes the placement of selected shapes on the master slide. Aligns shapes to the margins or the edge of the slide or aligns them relative to each other. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param alignmentType Alignment type that will be applied to the shapes. * @param alignToSlide If true, shapes will be aligned relative to the slide edges. * @param shapes Shapes indexes. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ alignSpecialSlideShapes(name: string, slideIndex: number, slideType: model.SpecialSlideType, alignmentType: model.ShapesAlignmentType, alignToSlide?: boolean, shapes?: Array<number>, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Shapes; }>; /** * Compresses embedded fonts by removing unused characters. * @param name Document name. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ compressEmbeddedFonts(name: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Compresses embedded fonts by removing unused characters. * @param document Document data. * @param password Document password. */ compressEmbeddedFontsOnline(document: Readable, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Deletes cropped areas of a pictire. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index (must refer to a picture frame). * @param resolution Target resolution in DPI. * @param deletePictureCroppedAreas true to delete picture cropped areas. * @param password Document password. * @param folder Document folder. * @param storage Presentation storage. */ compressImage(name: string, slideIndex: number, shapeIndex: number, resolution?: number, deletePictureCroppedAreas?: boolean, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Convert presentation from request content to format specified. * @param document Document data. * @param format Export format. * @param password Document password. * @param storage Document storage. * @param fontsFolder Custom fonts folder. * @param slides The indices of the slides to be converted. If not specified, all slides are converted by default. * @param options Export options. */ convert(document: Readable, format: model.ExportFormat, password?: string, storage?: string, fontsFolder?: string, slides?: Array<number>, options?: model.ExportOptions): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Convert presentation from request content to format specified. * @param document Document data. * @param format Export format. * @param outPath Path to save result. * @param password Document password. * @param storage Document storage. * @param fontsFolder Custom fonts folder. * @param slides The indices of the slides to be converted. If not specified, all slides are converted by default. * @param options Export options. */ convertAndSave(document: Readable, format: model.ExportFormat, outPath: string, password?: string, storage?: string, fontsFolder?: string, slides?: Array<number>, options?: model.ExportOptions): Promise<{ response: http.ServerResponse; }>; /** * 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 */ copyFile(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string): Promise<{ response: http.ServerResponse; }>; /** * 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 */ copyFolder(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string): Promise<{ response: http.ServerResponse; }>; /** * Copy layoutSlide from source presentation. * @param name Document name. * @param cloneFrom Name of the document to clone layoutSlide from. * @param cloneFromPosition Position of cloned layout slide. * @param cloneFromPassword Password for the document to clone layoutSlide from. * @param cloneFromStorage Storage of the document to clone layoutSlide from. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ copyLayoutSlide(name: string, cloneFrom: string, cloneFromPosition: number, cloneFromPassword?: string, cloneFromStorage?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.LayoutSlide; }>; /** * Copy masterSlide from source presentation. * @param name Document name. * @param cloneFrom Name of the document to clone masterSlide from. * @param cloneFromPosition Position of cloned master slide. * @param cloneFromPassword Password for the document to clone masterSlide from. * @param cloneFromStorage Storage of the document to clone masterSlide from. * @param applyToAll True to apply cloned master slide to every existing slide. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ copyMasterSlide(name: string, cloneFrom: string, cloneFromPosition: number, cloneFromPassword?: string, cloneFromStorage?: string, applyToAll?: boolean, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.MasterSlide; }>; /** * Copy a slide from the current or another presentation. * @param name Document name. * @param slideToCopy The index of the slide to be copied from the source presentation. * @param position The target position at which to copy the slide. Copy to the end by default. * @param source Name of the document to copy a slide from. * @param sourcePassword Password for the document to copy a slide from. * @param sourceStorage Template storage name. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ copySlide(name: string, slideToCopy: number, position?: number, source?: string, sourcePassword?: string, sourceStorage?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Slides; }>; /** * Add an effect to slide animation. * @param name Document name. * @param slideIndex Slide index. * @param effect Animation effect DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createAnimationEffect(name: string, slideIndex: number, effect: model.Effect, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Set slide animation. * @param name Document name. * @param slideIndex Slide index. * @param sequence Animation sequence DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createAnimationInteractiveSequence(name: string, slideIndex: number, sequence: model.InteractiveSequence, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Add an animation effect to a slide interactive sequence. * @param name Document name. * @param slideIndex Slide index. * @param sequenceIndex The position of the interactive sequence. * @param effect Animation effect DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createAnimationInteractiveSequenceEffect(name: string, slideIndex: number, sequenceIndex: number, effect: model.Effect, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Create video/audio captions track. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index (must refer to a video or audio frame). * @param label Caption track label. * @param data Caption track data. * @param password Document password. * @param folder Document folder. * @param storage Presentation storage. */ createCaptionTrack(name: string, slideIndex: number, shapeIndex: number, label: string, data?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.CaptionTrack; }>; /** * Add a new category to a chart. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param category Category DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createChartCategory(name: string, slideIndex: number, shapeIndex: number, category: model.ChartCategory, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Chart; }>; /** * Add a new data point to a chart series. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param seriesIndex Series index. * @param dataPoint Data point DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createChartDataPoint(name: string, slideIndex: number, shapeIndex: number, seriesIndex: number, dataPoint: model.DataPoint, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Chart; }>; /** * Add a new series to a chart. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index (must be a chart). * @param series Series DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createChartSeries(name: string, slideIndex: number, shapeIndex: number, series: model.Series, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Chart; }>; /** * Adds the comment on the slide. * @param name Document name. * @param slideIndex Slide index. * @param dto Comment DTO. * @param shapeIndex Shape index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createComment(name: string, slideIndex: number, dto: model.SlideCommentBase, shapeIndex?: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideComments; }>; /** * Adds the comment on the slide. * @param document Document data. * @param slideIndex Slide index. * @param dto Comment DTO. * @param shapeIndex Shape index. * @param password Document password. */ createCommentOnline(document: Readable, slideIndex: number, dto: model.SlideCommentBase, shapeIndex?: number, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Create the folder * @param path Folder path to create e.g. 'folder_1/folder_2/' * @param storageName Storage name */ createFolder(path?: string, storageName?: string): Promise<{ response: http.ServerResponse; }>; /** * Adds an image watermark to each slide of the presentation. Image can be provided as a part of the form or withing PictureFrame DTO for detailed customization. Both options are applicable simultaneously. * @param name Document name. * @param image Image data. * @param pictureFrame PictureFrame DTO * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createImageWatermark(name: string, image?: Readable, pictureFrame?: model.PictureFrame, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Adds an image watermark to each slide of the presentation. Image can be provided as a part of the form or withing PictureFrame DTO for detailed customization. Both options are applicable simultaneously. * @param document Document data. * @param image Image data. * @param pictureFrame PictureFrame DTO. * @param password Document password. */ createImageWatermarkOnline(document: Readable, image?: Readable, pictureFrame?: model.PictureFrame, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Add new notes slide. * @param name Document name. * @param slideIndex Slide index. * @param dto A NotesSlide object with notes slide data. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createNotesSlide(name: string, slideIndex: number, dto: model.NotesSlide, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.NotesSlide; }>; /** * Creates new paragraph. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param dto Paragraph DTO. * @param position Position of the new paragraph in the list. Default is at the end of the list. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ createParagraph(name: string, slideIndex: number, shapeIndex: number, dto: model.Paragraph, position?: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Paragraph; }>; /** * Creates new portion. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param paragraphIndex Paragraph index. * @param dto Portion DTO. * @param position Position of the new portion in the list. Default is at the end of the list. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ createPortion(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, dto: model.Portion, position?: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Portion; }>; /** * Create a presentation. * @param name Document name. * @param data Source presentation binary data. * @param inputPassword The password for source presentation. * @param password The document password. * @param folder Document folder. * @param storage Document storage. */ createPresentation(name: string, data?: Readable, inputPassword?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Document; }>; /** * Create a presentation from an existing source. * @param name Document name. * @param sourcePath Source file path. * @param sourcePassword Source file password. * @param sourceStorage Source storage name. * @param password The document password. * @param folder Document folder. * @param storage Document storage. */ createPresentationFromSource(name: string, sourcePath?: string, sourcePassword?: string, sourceStorage?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Document; }>; /** * Create a presentation. * @param name Document name. * @param templatePath Template file path. * @param data Document input data. * @param templatePassword Template file password. * @param templateStorage Template storage name. * @param isImageDataEmbedded True if image data is embedded. * @param password The document password. * @param folder Document folder. * @param storage Document storage. */ createPresentationFromTemplate(name: string, templatePath: string, data?: string, templatePassword?: string, templateStorage?: string, isImageDataEmbedded?: boolean, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Document; }>; /** * Create a section starting at a specified slide index. * @param name Document name. * @param sectionName Section name. * @param slideIndex Slide index (one-based). * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createSection(name: string, sectionName: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Sections; }>; /** * Create new shape. * @param name Document name. * @param slideIndex Slide index. * @param dto Shape DTO. * @param shapeToClone Optional index for clone shape instead of adding a new one. * @param position Position of the new shape in the list. Default is at the end of the list. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ createShape(name: string, slideIndex: number, dto?: model.ShapeBase, shapeToClone?: number, position?: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.ShapeBase; }>; /** * Create a slide. * @param name Document name. * @param layoutAlias Alias of layout slide for new slide. Alias may be the type of layout, name of layout slide or index * @param position The target position at which to create the slide. Add to the end by default. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createSlide(name: string, layoutAlias?: string, position?: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Slides; }>; /** * Add SmartArt node * @param name Document name. * @param slideIndex Slide index. * @param smartArtIndex Index of the object on the slide among the same type of objects. * @param subNode Sub-node path (e.g. \"3\", \"3/nodes/2). * @param text Node text. * @param position Position to insert a new node. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createSmartArtNode(name: string, slideIndex: number, smartArtIndex: number, subNode?: string, text?: string, position?: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SmartArt; }>; /** * Add an effect to special slide (master, layout, notes) animation. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param effect Animation effect DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createSpecialSlideAnimationEffect(name: string, slideIndex: number, slideType: model.SpecialSlideType, effect: model.Effect, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Set special slide (master, layout, notes) animation. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param sequence Animation sequence DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createSpecialSlideAnimationInteractiveSequence(name: string, slideIndex: number, slideType: model.SpecialSlideType, sequence: model.InteractiveSequence, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Add an animation effect to a special slide (master, layout, notes) interactive sequence. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param sequenceIndex The position of the interactive sequence. * @param effect Animation effect DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createSpecialSlideAnimationInteractiveSequenceEffect(name: string, slideIndex: number, slideType: model.SpecialSlideType, sequenceIndex: number, effect: model.Effect, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Creates new paragraph. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param shapeIndex Shape index. * @param dto Paragraph DTO. * @param position Position of the new paragraph in the list. Default is at the end of the list. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ createSpecialSlideParagraph(name: string, slideIndex: number, slideType: model.SpecialSlideType, shapeIndex: number, dto: model.Paragraph, position?: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Paragraph; }>; /** * Creates new portion. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param shapeIndex Shape index. * @param paragraphIndex Paragraph index. * @param dto Portion DTO. * @param position Position of the new portion in the list. Default is at the end of the list. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ createSpecialSlidePortion(name: string, slideIndex: number, slideType: model.SpecialSlideType, shapeIndex: number, paragraphIndex: number, dto: model.Portion, position?: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Portion; }>; /** * Create new shape. * @param name Document name. * @param slideIndex Parent slide index. * @param slideType Slide type (master, layout or notes). * @param dto Shape DTO. * @param shapeToClone Optional index for clone shape instead of adding a new one. * @param position Position of the new shape in the list. Default is at the end of the list. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ createSpecialSlideShape(name: string, slideIndex: number, slideType: model.SpecialSlideType, dto: model.ShapeBase, shapeToClone?: number, position?: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.ShapeBase; }>; /** * Creates table cell paragraph. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param rowIndex Row index. * @param cellIndex Table cell index. * @param dto Paragraph DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createTableCellParagraph(name: string, slideIndex: number, shapeIndex: number, rowIndex: number, cellIndex: number, dto: model.Paragraph, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Paragraph; }>; /** * Creates table cell portion. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param rowIndex Row index. * @param cellIndex Table cell index. * @param paragraphIndex Paragraph index. * @param dto Portion DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createTableCellPortion(name: string, slideIndex: number, shapeIndex: number, rowIndex: number, cellIndex: number, paragraphIndex: number, dto: model.Portion, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Portion; }>; /** * Inserts the table row in the specified position. If position is not specified, the row add to the end of the table. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param dto Table row data. * @param position Position. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createTableRow(name: string, slideIndex: number, shapeIndex: number, dto: model.TableRow, position?: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.TableRow; }>; /** * Append module to VBA project * @param name Document name. * @param moduleDto VBA module DTO. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createVbaModule(name: string, moduleDto: model.VbaModule, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.VbaModule; }>; /** * Adds a text watermark to each slide of the presentation. Text watermark can be setup via method arguments or withing Shape DTO for detailed customization. Both options are applicable simultaneously. * @param name Document name. * @param shape Shape DTO * @param fontHeight Watermark font height. * @param text Watermark text. * @param fontName Watermark font name. * @param fontColor Watermark font color. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ createWatermark(name: string, shape?: model.Shape, fontHeight?: number, text?: string, fontName?: string, fontColor?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Adds a text watermark to each slide of the presentation. Text watermark can be setup via method arguments or withing Shape DTO for detailed customization. Both options are applicable simultaneously. * @param document Document data. * @param shape Shape DTO * @param fontHeight Watermark font height. * @param text Watermark text. * @param fontName Watermark font name. * @param fontColor Watermark font color. * @param password Document password. */ createWatermarkOnline(document: Readable, shape?: model.Shape, fontHeight?: number, text?: string, fontName?: string, fontColor?: string, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Remove animation from a slide. * @param name Document name. * @param slideIndex Slide index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteAnimation(name: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Remove an effect from slide animation. * @param name Document name. * @param slideIndex Slide index. * @param effectIndex Index of the effect to be removed. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteAnimationEffect(name: string, slideIndex: number, effectIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Remove an interactive sequence from slide animation. * @param name Document name. * @param slideIndex Slide index. * @param sequenceIndex The index of an interactive sequence to be deleted. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteAnimationInteractiveSequence(name: string, slideIndex: number, sequenceIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Remove an effect from slide animation interactive sequence. * @param name Document name. * @param slideIndex Slide index. * @param sequenceIndex Interactive sequence index. * @param effectIndex Index of the effect to be removed. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteAnimationInteractiveSequenceEffect(name: string, slideIndex: number, sequenceIndex: number, effectIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Clear all interactive sequences from slide animation. * @param name Document name. * @param slideIndex Slide index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteAnimationInteractiveSequences(name: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Clear main sequence in slide animation. * @param name Document name. * @param slideIndex Slide index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteAnimationMainSequence(name: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideAnimation; }>; /** * Remove background from a slide. * @param name Document name. * @param slideIndex Slide index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteBackground(name: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideBackground; }>; /** * Delete video/audio captions track. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index (must refer to a video or audio frame). * @param captionsIndex Captions track index. * @param password Document password. * @param folder Document folder. * @param storage Presentation storage. */ deleteCaptionTrack(name: string, slideIndex: number, shapeIndex: number, captionsIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Delete all video/audio captions tracks. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index (must refer to a video frame). * @param password Document password. * @param folder Document folder. * @param storage Presentation storage. */ deleteCaptionTracks(name: string, slideIndex: number, shapeIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Delete a category from a chart. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param categoryIndex Category index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteChartCategory(name: string, slideIndex: number, shapeIndex: number, categoryIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Chart; }>; /** * Delete a data point from a chart series. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param seriesIndex Series index. * @param pointIndex Data point index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteChartDataPoint(name: string, slideIndex: number, shapeIndex: number, seriesIndex: number, pointIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Chart; }>; /** * Delete a series from a chart. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index (must be a chart). * @param seriesIndex Series index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteChartSeries(name: string, slideIndex: number, shapeIndex: number, seriesIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Chart; }>; /** * Removes comments of the specified author from the presentation. If author value is not provided all comments will be removed. * @param name Document name. * @param author Author of comments. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteComments(name: string, author?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; }>; /** * Removes comments of the specified author from the presentation. If author value is not provided all comments will be removed. * @param document Document data. * @param author Author of comments. * @param password Document password. */ deleteCommentsOnline(document: Readable, author?: string, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Clean document properties. * @param name Document name. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteDocumentProperties(name: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.DocumentProperties; }>; /** * Delete document property. * @param name Document name. * @param propertyName The property name. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteDocumentProperty(name: string, propertyName: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.DocumentProperties; }>; /** * Removes specified embedded font and returns presentation fonts info. * @param name Document name. * @param fontName Font name. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteEmbeddedFont(name: string, fontName: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.FontsData; }>; /** * Removes specified embedded font and returns presentation. * @param document Document data. * @param fontName Font name. * @param password Document password. */ deleteEmbeddedFontOnline(document: Readable, fontName: string, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Delete file * @param path File path e.g. '/folder/file.ext' * @param storageName Storage name * @param versionId File version ID to delete */ deleteFile(path?: string, storageName?: string, versionId?: string): Promise<{ response: http.ServerResponse; }>; /** * Delete folder * @param path Folder path e.g. '/folder' * @param storageName Storage name * @param recursive Enable to delete folders, subfolders and files */ deleteFolder(path?: string, storageName?: string, recursive?: boolean): Promise<{ response: http.ServerResponse; }>; /** * Remove notes slide. * @param name Document name. * @param slideIndex Slide index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteNotesSlide(name: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Slide; }>; /** * Remove a paragraph. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param paragraphIndex Paragraph index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ deleteParagraph(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Paragraphs; }>; /** * Remove a range of paragraphs. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param paragraphs The indices of the paragraphs to be deleted; delete all by default. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ deleteParagraphs(name: string, slideIndex: number, shapeIndex: number, paragraphs?: Array<number>, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Paragraphs; }>; /** * Remove a portion. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param paragraphIndex Paragraph index. * @param portionIndex Portion index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ deletePortion(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, portionIndex: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Portions; }>; /** * Remove a range of portions. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param paragraphIndex Paragraph index. * @param portions The indices of the portions to be deleted; delete all by default. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ deletePortions(name: string, slideIndex: number, shapeIndex: number, paragraphIndex: number, portions?: Array<number>, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Portions; }>; /** * Resets all presentation protection settings. * @param name Document name. * @param password Presentation password. * @param folder Document folder. * @param storage Document storage. */ deleteProtection(name: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.ProtectionProperties; }>; /** * Resets all presentation protection settings. * @param document Document data. * @param password Presentation password. */ deleteProtectionOnline(document: Readable, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Delete a presentation section. * @param name Document name. * @param sectionIndex Section index. * @param withSlides True to delete the slides related to the deleted section; move them to the remaining sections otherwise. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteSection(name: string, sectionIndex: number, withSlides?: boolean, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Sections; }>; /** * Delete presentation sections. * @param name Document name. * @param sections The indices of the sections to be deleted; delete all by default. * @param withSlides True to delete the slides related to the deleted sections; move them to the remaining sections otherwise. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteSections(name: string, sections?: Array<number>, withSlides?: boolean, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Sections; }>; /** * Remove a shape. * @param name Document name. * @param slideIndex Slide index. * @param shapeIndex Shape index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ deleteShape(name: string, slideIndex: number, shapeIndex: number, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Shapes; }>; /** * Remove a range of shapes. * @param name Document name. * @param slideIndex Slide index. * @param shapes The indices of the shapes to be deleted; delete all by default. * @param password Document password. * @param folder Document folder. * @param storage Document storage. * @param subShape Sub-shape path (e.g. \"3\", \"3/shapes/2). */ deleteShapes(name: string, slideIndex: number, shapes?: Array<number>, password?: string, folder?: string, storage?: string, subShape?: string): Promise<{ response: http.ServerResponse; body: model.Shapes; }>; /** * Delete a presentation slide by index. * @param name Document name. * @param slideIndex Slide index. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteSlide(name: string, slideIndex: number, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.Slides; }>; /** * Removes comments of the specified author from the slide. If author value is not provided all comments will be removed. * @param name Document name. * @param slideIndex Slide index. * @param author Author of comments. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteSlideComments(name: string, slideIndex: number, author?: string, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; body: model.SlideComments; }>; /** * Removes comments of the specified author from the slide. If author value is not provided all comments will be removed. * @param document Document data. * @param slideIndex * @param author Author of comments. * @param password Document password. */ deleteSlideCommentsOnline(document: Readable, slideIndex: number, author?: string, password?: string): Promise<{ response: http.ServerResponse; body: Buffer; }>; /** * Delete presentation slides. * @param name Document name. * @param slides The indices of the slides to be deleted; delete all by default. * @param password Document password. * @param folder Document folder. * @param storage Document storage. */ deleteSlides(name: string, slides?: Array<number>, password?: string, folder?: string, storage?: string): Promise<{ response: http.ServerResponse; bo