projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
65 lines • 2.9 kB
JavaScript
/**
* 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
*/
export class ProjectFileClient {
client;
/**
* Internal constructor for this client library
*/
constructor(client) {
this.client = client;
}
/**
* Uploads a file to the All Files folder on the Files page within the project that you specify.
*
* 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 projectId The reference to the project
* @param fileName The full path of a file to upload to the API
*/
uploadProjectFile(projectId, fileName) {
const url = `/api/data/projects/${projectId}/files`;
return this.client.fileUpload("post", url, null, fileName);
}
/**
* Uploads a file to a specific folder on the Files page within the project that you specify.
*
* 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.
*
* You can organize your files in the Home Files and Project Files pages by adding folders.
*
* 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 projectId The reference to the project
* @param folderId The reference to the sub folder to put the file into
* @param fileName The full path of a file to upload to the API
*/
uploadProjectFileToFolder(projectId, folderId, fileName) {
const url = `/api/data/projects/${projectId}/folders/${folderId}/files`;
return this.client.fileUpload("post", url, null, fileName);
}
}
//# sourceMappingURL=ProjectFileClient.js.map