projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
52 lines (51 loc) • 1.94 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 { ProjectCustomerDto } from "../index.js";
import { ProjectCustomerCreateDto } from "../index.js";
export declare class ProjectCustomerClient {
private readonly client;
/**
* Internal constructor for this client library
*/
constructor(client: ProjectManagerClient);
/**
* Retrieves all ProjectCustomers defined within your Workspace.
*
* A ProjectCustomer is a code used to identify customers associated with your Projects. Each
* ProjectCustomer has a name and a unique identifier. ProjectCustomers are defined per
* Workspace and are shared among Projects.
*
*/
retrieveProjectCustomers(): Promise<AstroResult<ProjectCustomerDto[]>>;
/**
* Create a project customer
*
* @param body The data to create the customer
*/
createProjectCustomer(body: ProjectCustomerCreateDto): Promise<AstroResult<ProjectCustomerDto>>;
/**
* Updates a project customer
*
* @param customerId The id of the customer to update
* @param body The data to update
*/
updateProjectCustomer(customerId: string, body: ProjectCustomerCreateDto): Promise<AstroResult<ProjectCustomerDto>>;
/**
* Delete a project customer. They will also be removed from any projects they were assigned too.
*
* @param customerId The id of the customer to remove
*/
deleteProjectCustomer(customerId: string): Promise<AstroResult<object>>;
}