@asposecloud/aspose-tasks-cloud/dist/src/api.d.ts

Aspose.Tasks Cloud SDK for Node.js

/// <reference types="node" />
import http = require("http");
import { Configuration } from "./internal/configuration";
import * as model from "./model/model";
/**
 * Library for communicating with the Aspose.Tasks Cloud API
 */
export declare class TasksApi {
    /**
     * API configuration
     */
    configuration: Configuration;
    /**
     * @param appSID App SID.
     * @param appKey App key.
     * @param baseUrl Base api Url.
     * @param authUrl Auth Url.
     * @param debugMode A value indicating whether debug mode. In debug mode all requests and responses are logged to console.
     */
    constructor(appSID: string, appKey: string, baseUrl?: string, authUrl?: string, debugMode?: boolean);
    /**
     * Copy file
     * @param requestObj contains request parameters
     */
    copyFile(requestObj: model.CopyFileRequest): Promise<http.IncomingMessage>;
    /**
     * Delete file
     * @param requestObj contains request parameters
     */
    deleteFile(requestObj: model.DeleteFileRequest): Promise<http.IncomingMessage>;
    /**
     * Download file
     * @param requestObj contains request parameters
     */
    downloadFile(requestObj: model.DownloadFileRequest): Promise<model.TasksIncomingMessage<Buffer>>;
    /**
     * Move file
     * @param requestObj contains request parameters
     */
    moveFile(requestObj: model.MoveFileRequest): Promise<http.IncomingMessage>;
    /**
     * Upload file
     * @param requestObj contains request parameters
     */
    uploadFile(requestObj: model.UploadFileRequest): Promise<model.TasksIncomingMessage<model.FilesUploadResult>>;
    /**
     * Copy folder
     * @param requestObj contains request parameters
     */
    copyFolder(requestObj: model.CopyFolderRequest): Promise<http.IncomingMessage>;
    /**
     * Create the folder
     * @param requestObj contains request parameters
     */
    createFolder(requestObj: model.CreateFolderRequest): Promise<http.IncomingMessage>;
    /**
     * Delete folder
     * @param requestObj contains request parameters
     */
    deleteFolder(requestObj: model.DeleteFolderRequest): Promise<http.IncomingMessage>;
    /**
     * Get all files and folders within a folder
     * @param requestObj contains request parameters
     */
    getFilesList(requestObj: model.GetFilesListRequest): Promise<model.TasksIncomingMessage<model.FilesList>>;
    /**
     * Move folder
     * @param requestObj contains request parameters
     */
    moveFolder(requestObj: model.MoveFolderRequest): Promise<http.IncomingMessage>;
    /**
     * Get disc usage
     * @param requestObj contains request parameters
     */
    getDiscUsage(requestObj: model.GetDiscUsageRequest): Promise<model.TasksIncomingMessage<model.DiscUsage>>;
    /**
     * Get file versions
     * @param requestObj contains request parameters
     */
    getFileVersions(requestObj: model.GetFileVersionsRequest): Promise<model.TasksIncomingMessage<model.FileVersions>>;
    /**
     * Check if file or folder exists
     * @param requestObj contains request parameters
     */
    objectExists(requestObj: model.ObjectExistsRequest): Promise<model.TasksIncomingMessage<model.ObjectExist>>;
    /**
     * Check if storage exists
     * @param requestObj contains request parameters
     */
    storageExists(requestObj: model.StorageExistsRequest): Promise<model.TasksIncomingMessage<model.StorageExist>>;
    /**
     * Deletes a project assignment with all references to it.
     * @param requestObj contains request parameters
     */
    deleteAssignment(requestObj: model.DeleteAssignmentRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Read project assignment with the specified Uid.
     * @param requestObj contains request parameters
     */
    getAssignment(requestObj: model.GetAssignmentRequest): Promise<model.TasksIncomingMessage<model.AssignmentResponse>>;
    /**
     * Get timescaled data for an assignment with the specified Uid.
     * @param requestObj contains request parameters
     */
    getAssignmentTimephasedData(requestObj: model.GetAssignmentTimephasedDataRequest): Promise<model.TasksIncomingMessage<model.TimephasedDataResponse>>;
    /**
     * Get project's assignment items.
     * @param requestObj contains request parameters
     */
    getAssignments(requestObj: model.GetAssignmentsRequest): Promise<model.TasksIncomingMessage<model.AssignmentItemsResponse>>;
    /**
     * Adds a new assignment to a project and returns assignment item in a response.
     * @param requestObj contains request parameters
     */
    postAssignment(requestObj: model.PostAssignmentRequest): Promise<model.TasksIncomingMessage<model.AssignmentItemResponse>>;
    /**
     * Updates resources assignment with the specified Uid.
     * @param requestObj contains request parameters
     */
    putAssignment(requestObj: model.PutAssignmentRequest): Promise<model.TasksIncomingMessage<model.AssignmentResponse>>;
    /**
     * Deletes a project calendar
     * @param requestObj contains request parameters
     */
    deleteCalendar(requestObj: model.DeleteCalendarRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Deletes calendar exception from calendar exceptions collection.
     * @param requestObj contains request parameters
     */
    deleteCalendarException(requestObj: model.DeleteCalendarExceptionRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get a project's calendar with the specified Uid.
     * @param requestObj contains request parameters
     */
    getCalendar(requestObj: model.GetCalendarRequest): Promise<model.TasksIncomingMessage<model.CalendarResponse>>;
    /**
     * Get a list of calendar's exceptions.
     * @param requestObj contains request parameters
     */
    getCalendarExceptions(requestObj: model.GetCalendarExceptionsRequest): Promise<model.TasksIncomingMessage<model.CalendarExceptionsResponse>>;
    /**
     * Gets the collection of work weeks of the specified calendar.
     * @param requestObj contains request parameters
     */
    getCalendarWorkWeeks(requestObj: model.GetCalendarWorkWeeksRequest): Promise<model.TasksIncomingMessage<model.CalendarWorkWeeksResponse>>;
    /**
     * Read project calendar items.
     * @param requestObj contains request parameters
     */
    getCalendars(requestObj: model.GetCalendarsRequest): Promise<model.TasksIncomingMessage<model.CalendarItemsResponse>>;
    /**
     * Adds a new calendar to project file.
     * @param requestObj contains request parameters
     */
    postCalendar(requestObj: model.PostCalendarRequest): Promise<model.TasksIncomingMessage<model.CalendarItemResponse>>;
    /**
     * Adds a new calendar exception to a calendar.
     * @param requestObj contains request parameters
     */
    postCalendarException(requestObj: model.PostCalendarExceptionRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Edits an existing project calendar.
     * @param requestObj contains request parameters
     */
    putCalendar(requestObj: model.PutCalendarRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Updates calendar exception.
     * @param requestObj contains request parameters
     */
    putCalendarException(requestObj: model.PutCalendarExceptionRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Returns the list of the tasks which must be completed on time for a project to finish on schedule. Each task of the project is represented as a task item here, which is light-weighted task representation of the project task..
     * @param requestObj contains request parameters
     */
    getCriticalPath(requestObj: model.GetCriticalPathRequest): Promise<model.TasksIncomingMessage<model.TaskItemsResponse>>;
    /**
     * Returns page count for the project to be rendered using given Timescale and PresentationFormat  or specified PageSize.
     * @param requestObj contains request parameters
     */
    getPageCount(requestObj: model.GetPageCountRequest): Promise<model.TasksIncomingMessage<model.PageCountResponse>>;
    /**
     * Get Uids of projects contained in the file.
     * @param requestObj contains request parameters
     */
    getProjectIds(requestObj: model.GetProjectIdsRequest): Promise<model.TasksIncomingMessage<model.ProjectIdsResponse>>;
    /**
     * Get a project document.
     * @param requestObj contains request parameters
     */
    getTaskDocument(requestObj: model.GetTaskDocumentRequest): Promise<model.TasksIncomingMessage<Buffer>>;
    /**
     * Get a project document in the specified format
     * @param requestObj contains request parameters
     */
    getTaskDocumentWithFormat(requestObj: model.GetTaskDocumentWithFormatRequest): Promise<model.TasksIncomingMessage<Buffer>>;
    /**
     * Imports project from database with the specified connection string and saves it to specified file with the specified format.
     * @param requestObj contains request parameters
     */
    putImportProjectFromDb(requestObj: model.PutImportProjectFromDbRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Imports project from primavera db formats (Primavera SQLite .db or Primavera xml) and saves it to specified file with the specified format.
     * @param requestObj contains request parameters
     */
    putImportProjectFromFile(requestObj: model.PutImportProjectFromFileRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Imports project from Project Online and saves it to specified file.
     * @param requestObj contains request parameters
     */
    putImportProjectFromProjectOnline(requestObj: model.PutImportProjectFromProjectOnlineRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get a collection of a project's document properties.
     * @param requestObj contains request parameters
     */
    getDocumentProperties(requestObj: model.GetDocumentPropertiesRequest): Promise<model.TasksIncomingMessage<model.DocumentPropertiesResponse>>;
    /**
     * Get a document property by name.
     * @param requestObj contains request parameters
     */
    getDocumentProperty(requestObj: model.GetDocumentPropertyRequest): Promise<model.TasksIncomingMessage<model.DocumentPropertyResponse>>;
    /**
     * Set/create document property.
     * @param requestObj contains request parameters
     */
    postDocumentProperty(requestObj: model.PostDocumentPropertyRequest): Promise<model.TasksIncomingMessage<model.DocumentPropertyResponse>>;
    /**
     * Set/create document property.
     * @param requestObj contains request parameters
     */
    putDocumentProperty(requestObj: model.PutDocumentPropertyRequest): Promise<model.TasksIncomingMessage<model.DocumentPropertyResponse>>;
    /**
     * Delete a project extended attribute.
     * @param requestObj contains request parameters
     */
    deleteExtendedAttributeByIndex(requestObj: model.DeleteExtendedAttributeByIndexRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get a project extended attribute definition with the specified index.
     * @param requestObj contains request parameters
     */
    getExtendedAttributeByIndex(requestObj: model.GetExtendedAttributeByIndexRequest): Promise<model.TasksIncomingMessage<model.ExtendedAttributeResponse>>;
    /**
     * Get a project's extended attributes.
     * @param requestObj contains request parameters
     */
    getExtendedAttributes(requestObj: model.GetExtendedAttributesRequest): Promise<model.TasksIncomingMessage<model.ExtendedAttributeItemsResponse>>;
    /**
     * Add a new extended attribute definition to a project or  updates existing attribute definition (with the same FieldId).
     * @param requestObj contains request parameters
     */
    putExtendedAttribute(requestObj: model.PutExtendedAttributeRequest): Promise<model.TasksIncomingMessage<model.ExtendedAttributeItemResponse>>;
    /**
     * Deletes a project outline code
     * @param requestObj contains request parameters
     */
    deleteOutlineCodeByIndex(requestObj: model.DeleteOutlineCodeByIndexRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get outline code by index.
     * @param requestObj contains request parameters
     */
    getOutlineCodeByIndex(requestObj: model.GetOutlineCodeByIndexRequest): Promise<model.TasksIncomingMessage<model.OutlineCodeResponse>>;
    /**
     * Get a project's outline codes.
     * @param requestObj contains request parameters
     */
    getOutlineCodes(requestObj: model.GetOutlineCodesRequest): Promise<model.TasksIncomingMessage<model.OutlineCodeItemsResponse>>;
    /**
     * Creates new project in Project Server\\Project Online instance.
     * @param requestObj contains request parameters
     */
    createNewProject(requestObj: model.CreateNewProjectRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Gets the list of published projects in the current Project Online account.
     * @param requestObj contains request parameters
     */
    getProjectList(requestObj: model.GetProjectListRequest): Promise<model.TasksIncomingMessage<model.ProjectListResponse>>;
    /**
     * Updates existing project in Project Server\\Project Online instance. The existing project will be overwritten.
     * @param requestObj contains request parameters
     */
    updateProject(requestObj: model.UpdateProjectRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields.
     * @param requestObj contains request parameters
     */
    putRecalculateProject(requestObj: model.PutRecalculateProjectRequest): Promise<model.TasksIncomingMessage<model.ProjectRecalculateResponse>>;
    /**
     * Recalculate project resource fields
     * @param requestObj contains request parameters
     */
    putRecalculateProjectResourceFields(requestObj: model.PutRecalculateProjectResourceFieldsRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Recalculate project uncomplete work
     * @param requestObj contains request parameters
     */
    putRecalculateProjectUncompleteWorkToStartAfter(requestObj: model.PutRecalculateProjectUncompleteWorkToStartAfterRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Recalculate project work as complete
     * @param requestObj contains request parameters
     */
    putRecalculateProjectWorkAsComplete(requestObj: model.PutRecalculateProjectWorkAsCompleteRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Returns created report in PDF format.
     * @param requestObj contains request parameters
     */
    getReportPdf(requestObj: model.GetReportPdfRequest): Promise<model.TasksIncomingMessage<Buffer>>;
    /**
     * Clears leveling delays that was previously added to the project during resource leveling.  If request body is empty, all leveling delays will be cleared.
     * @param requestObj contains request parameters
     */
    clearLeveling(requestObj: model.ClearLevelingRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Levels tasks for project’s resources. If request body is empty,  all project's resources with default leveling options will be leveled.
     * @param requestObj contains request parameters
     */
    levelTasks(requestObj: model.LevelTasksRequest): Promise<model.TasksIncomingMessage<model.LevelingResponse>>;
    /**
     * Deletes a project resource with all references to it
     * @param requestObj contains request parameters
     */
    deleteResource(requestObj: model.DeleteResourceRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get project resource.
     * @param requestObj contains request parameters
     */
    getResource(requestObj: model.GetResourceRequest): Promise<model.TasksIncomingMessage<model.ResourceResponse>>;
    /**
     * Get resource's assignments.
     * @param requestObj contains request parameters
     */
    getResourceAssignments(requestObj: model.GetResourceAssignmentsRequest): Promise<model.TasksIncomingMessage<model.AssignmentsResponse>>;
    /**
     * Get timescaled data for a resource with the specified Uid.
     * @param requestObj contains request parameters
     */
    getResourceTimephasedData(requestObj: model.GetResourceTimephasedDataRequest): Promise<model.TasksIncomingMessage<model.TimephasedDataResponse>>;
    /**
     * Get a project's resources.
     * @param requestObj contains request parameters
     */
    getResources(requestObj: model.GetResourcesRequest): Promise<model.TasksIncomingMessage<model.ResourceItemsResponse>>;
    /**
     * Add a new resource to a project.
     * @param requestObj contains request parameters
     */
    postResource(requestObj: model.PostResourceRequest): Promise<model.TasksIncomingMessage<model.ResourceItemResponse>>;
    /**
     * Updates resource with the specified Uid
     * @param requestObj contains request parameters
     */
    putResource(requestObj: model.PutResourceRequest): Promise<model.TasksIncomingMessage<model.ResourceResponse>>;
    /**
     * Performs a risk analysys using Monte Carlo simulation and creates a risk analysis report.
     * @param requestObj contains request parameters
     */
    getRiskAnalysisReport(requestObj: model.GetRiskAnalysisReportRequest): Promise<model.TasksIncomingMessage<Buffer>>;
    /**
     * Deletes a project task with all references to it and rebuilds tasks tree.
     * @param requestObj contains request parameters
     */
    deleteTask(requestObj: model.DeleteTaskRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get primavera properties for a task with the specified Uid.
     * @param requestObj contains request parameters
     */
    getPrimaveraTaskProperties(requestObj: model.GetPrimaveraTaskPropertiesRequest): Promise<model.TasksIncomingMessage<model.PrimaveraTaskPropertiesResponse>>;
    /**
     * Read project task.
     * @param requestObj contains request parameters
     */
    getTask(requestObj: model.GetTaskRequest): Promise<model.TasksIncomingMessage<model.TaskResponse>>;
    /**
     * Get task assignments.
     * @param requestObj contains request parameters
     */
    getTaskAssignments(requestObj: model.GetTaskAssignmentsRequest): Promise<model.TasksIncomingMessage<model.AssignmentsResponse>>;
    /**
     * Get recurring info for a task with the specified Uid
     * @param requestObj contains request parameters
     */
    getTaskRecurringInfo(requestObj: model.GetTaskRecurringInfoRequest): Promise<model.TasksIncomingMessage<model.RecurringInfoResponse>>;
    /**
     * Get timescaled data for a task with the specified Uid.
     * @param requestObj contains request parameters
     */
    getTaskTimephasedData(requestObj: model.GetTaskTimephasedDataRequest): Promise<model.TasksIncomingMessage<model.TimephasedDataResponse>>;
    /**
     * Get a project's tasks.
     * @param requestObj contains request parameters
     */
    getTasks(requestObj: model.GetTasksRequest): Promise<model.TasksIncomingMessage<model.TaskItemsResponse>>;
    /**
     * Add a new task to a project.
     * @param requestObj contains request parameters
     */
    postTask(requestObj: model.PostTaskRequest): Promise<model.TasksIncomingMessage<model.TaskItemResponse>>;
    /**
     * Adds a new recurring task.
     * @param requestObj contains request parameters
     */
    postTaskRecurringInfo(requestObj: model.PostTaskRecurringInfoRequest): Promise<model.TasksIncomingMessage<model.TaskItemResponse>>;
    /**
     * Create multiple tasks by single request.
     * @param requestObj contains request parameters
     */
    postTasks(requestObj: model.PostTasksRequest): Promise<model.TasksIncomingMessage<model.TaskItemsResponse>>;
    /**
     * Move one task to another parent task.
     * @param requestObj contains request parameters
     */
    putMoveTask(requestObj: model.PutMoveTaskRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Move a task to another position under the same parent and the same outline level
     * @param requestObj contains request parameters
     */
    putMoveTaskToSibling(requestObj: model.PutMoveTaskToSiblingRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Updates special task getting by task UID
     * @param requestObj contains request parameters
     */
    putTask(requestObj: model.PutTaskRequest): Promise<model.TasksIncomingMessage<model.TaskResponse>>;
    /**
     * Updates existing task's recurring info. Note that task should be already recurring.
     * @param requestObj contains request parameters
     */
    putTaskRecurringInfo(requestObj: model.PutTaskRecurringInfoRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Delete task link.
     * @param requestObj contains request parameters
     */
    deleteTaskLink(requestObj: model.DeleteTaskLinkRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get tasks' links of a project.
     * @param requestObj contains request parameters
     */
    getTaskLinks(requestObj: model.GetTaskLinksRequest): Promise<model.TasksIncomingMessage<model.TaskLinksResponse>>;
    /**
     * Adds a new task link to a project.
     * @param requestObj contains request parameters
     */
    postTaskLink(requestObj: model.PostTaskLinkRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Updates existing task link.
     * @param requestObj contains request parameters
     */
    putTaskLink(requestObj: model.PutTaskLinkRequest): Promise<model.TasksIncomingMessage<model.TaskLinkResponse>>;
    /**
     * Returns VBA project.
     * @param requestObj contains request parameters
     */
    getVbaProject(requestObj: model.GetVbaProjectRequest): Promise<model.TasksIncomingMessage<model.VbaProjectResponse>>;
    /**
     * Create table text style in specified view.
     * @param requestObj contains request parameters
     */
    createTableTextStyle(requestObj: model.CreateTableTextStyleRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Delete specified table text style from specified view.
     * @param requestObj contains request parameters
     */
    deleteTableTextStyle(requestObj: model.DeleteTableTextStyleRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Read all table text styles from specified view.
     * @param requestObj contains request parameters
     */
    getAllTableTextStyles(requestObj: model.GetAllTableTextStylesRequest): Promise<model.TasksIncomingMessage<model.TableTextStylesResponse>>;
    /**
     * Read specified table text style from specified view.
     * @param requestObj contains request parameters
     */
    getTableTextStyle(requestObj: model.GetTableTextStyleRequest): Promise<model.TasksIncomingMessage<model.TableTextStyleResponse>>;
    /**
     * Read all project views.
     * @param requestObj contains request parameters
     */
    getViews(requestObj: model.GetViewsRequest): Promise<model.TasksIncomingMessage<model.ViewsResponse>>;
    /**
     * Update table text style in specified view.
     * @param requestObj contains request parameters
     */
    updateTableTextStyle(requestObj: model.UpdateTableTextStyleRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get a project's WBS Definition.
     * @param requestObj contains request parameters
     */
    getWbsDefinition(requestObj: model.GetWbsDefinitionRequest): Promise<model.TasksIncomingMessage<model.WBSDefinitionResponse>>;
    /**
     * Renumber WBS code of passed tasks (if specified) or all project's tasks.
     * @param requestObj contains request parameters
     */
    putRenumberWbsCode(requestObj: model.PutRenumberWbsCodeRequest): Promise<model.TasksIncomingMessage<model.AsposeResponse>>;
    /**
     * Get a project document in the specified format and with the specified save options.
     * @param requestObj contains request parameters
     */
    postTaskDocumentWithFormat(requestObj: model.PostTaskDocumentWithFormatRequest): Promise<model.TasksIncomingMessage<Buffer>>;
}