projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
40 lines (39 loc) • 1.57 kB
TypeScript
/**
* ProjectManager API for TypeScript
*
* (c) ProjectManager.com, Inc.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @author ProjectManager.com <support@projectmanager.com>
* @copyright ProjectManager.com, Inc.
* @link https://github.com/projectmgr/projectmanager-sdk-typescript
*/
import { ProjectManagerClient } from "../index.js";
import { AstroResult } from "../index.js";
import { FileDto } from "../index.js";
export declare class TaskFileClient {
private readonly client;
/**
* Internal constructor for this client library
*/
constructor(client: ProjectManagerClient);
/**
* Uploads a file to a task.
*
* ProjectManager allows you to store Files connected to other elements of your Workspace
* such as a Project, a Task, or Home. Files are maintained separately based on the location
* where the file was stored.
*
* When you upload a File, please allow a few moments for the File to be processed and verified.
* ProjectManager may reject File uploads that contain problems such as malware. Once a File has
* completed the upload the process, you may retrieve it using the DownloadFile API.
*
* This API returns a JSON response indicating success or failure.
*
* @param taskId The reference to the task
* @param fileName The full path of a file to upload to the API
*/
uploadTaskFile(taskId: string, fileName: string): Promise<AstroResult<FileDto>>;
}