projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
67 lines (66 loc) • 2.98 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 { TaskTagDto } from "../index.js";
import { NameDto } from "../index.js";
export declare class NptTagClient {
private readonly client;
/**
* Internal constructor for this client library
*/
constructor(client: ProjectManagerClient);
/**
* Replaces the existing TaskTags on a Task with a newly provided list of TaskTags.
*
* A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many
* TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you
* classify your Tasks and prioritize work.
*
* @param taskId The unique identifier of the Task for which we will replace TaskTags
* @param body The replacement list of TaskTags for this Task
*/
replaceTaskTags(taskId: string, body: NameDto[]): Promise<AstroResult<TaskTagDto[]>>;
/**
* Add one or more new TaskTags to a Task.
*
* A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many
* TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you
* classify your Tasks and prioritize work.
*
* @param taskId The unique identifier of the Task for which we will add TaskTags
* @param body The new TaskTags to add to this Task
*/
addTaskTagtoTask(taskId: string, body: NameDto[]): Promise<AstroResult<TaskTagDto[]>>;
/**
* Removes one or more existing TaskTags from a Task.
*
* A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many
* TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you
* classify your Tasks and prioritize work.
*
* @param taskId The unique identifier of the Task for which we will remove existing TaskTags
* @param body The TaskTags to remove from this Task
*/
removeTaskTagfromTask(taskId: string, body: NameDto[]): Promise<AstroResult<object>>;
/**
* Retrieve the existing TaskTags on a Task
*
* A TaskTag is a connection between a Task and a Tag. Each Task can have zero, one or many
* TaskTags associated with it. TaskTags can be assigned and removed from the Task to help you
* classify your Tasks and prioritize work.
*
* @param taskId The unique identifier of the Task for which we will retrieve TaskTags
*/
retrieveTaskTags(taskId: string): Promise<AstroResult<TaskTagDto[]>>;
}