projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
57 lines (56 loc) • 2.3 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 { TagDto } from "../index.js";
import { TagCreateDto } from "../index.js";
import { TagUpdateDto } from "../index.js";
export declare class TagClient {
private readonly client;
/**
* Internal constructor for this client library
*/
constructor(client: ProjectManagerClient);
/**
* Retrieve a list of Tags that match an [OData formatted query](https://www.odata.org/).
*
* A Tag is a named categorization you can use to distinguish objects from each other.
* Tags each have a unique identifier, a name, and a color.
*
* @param top The number of records to return
* @param skip Skips the given number of records and then returns $top records
* @param filter Filter the expression according to oData queries
* @param orderby Order collection by this field.
* @param expand Include related data in the response
*/
queryTags(top?: number, skip?: number, filter?: string, orderby?: string, expand?: string): Promise<AstroResult<TagDto[]>>;
/**
* Creates a new Tag based on information you provide.
*
* A Tag is a named categorization you can use to distinguish objects from each other.
* Tags each have a unique identifier, a name, and a color.
*
* @param body The information for the new Tag to create
*/
createTag(body: TagCreateDto): Promise<AstroResult<TagDto>>;
/**
* Updates an existing Tag based on information you provide.
*
* A Tag is a named categorization you can use to distinguish objects from each other.
* Tags each have a unique identifier, a name, and a color.
*
* @param tagId The id of the tag
* @param body The information to update the tag
*/
updateTag(tagId: string, body: TagUpdateDto): Promise<AstroResult<TagDto>>;
}