projectmanager-sdk
Version:
Software development kit for the ProjectManager.com API. for TypeScript
125 lines • 5.93 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 ProjectMembersClient {
client;
/**
* Internal constructor for this client library
*/
constructor(client) {
this.client = client;
}
/**
* Returns a list of users that can be added as members of a new project, as well as their available project security roles.
*
* A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to
* the project. Possible project security roles include manage, edit, collaborate, creator, and guest.
*
*/
retrieveNewProjectMembers() {
const url = `/api/data/projects/members`;
return this.client.request("get", url, null, null);
}
/**
* Returns a list of users that are currently members of a specified project, as well as their current project security roles and available project security roles.
* Optionally include users who are not currently members of the project, but who can be added.
*
* A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to
* the project. Possible project security roles include manage, edit, collaborate, creator, and guest.
*
* @param projectId Reference to the project
* @param includeAllUsers Set to true to include all users in the workspace
*/
retrieveProjectMembers(projectId, includeAllUsers) {
const url = `/api/data/projects/${projectId}/members`;
const options = {
params: {
'includeAllUsers': includeAllUsers,
},
};
return this.client.request("get", url, options, null);
}
/**
* Updates the project access for a current member of a specified project
* by giving the users a new project security role.
*
* A project member is a user who has access to a specific project.
* Project members are assigned a project security role, which controls the level of access they have to
* the project.
* Possible project security roles include manage, edit, collaborate, creator, and guest.
*
* @param projectId Reference to Project
* @param body The permission to update
*/
updateAListOfUserProjectMembership(projectId, body) {
const url = `/api/data/projects/${projectId}/members`;
return this.client.request("put", url, null, body);
}
/**
* Returns the project security role in a specified project for a current project member.
*
* A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to
* the project. Possible project security roles include manage, edit, collaborate, creator, and guest.
*
* @param projectId Reference of Project
* @param userId Reference of User
*/
retrieveUserProjectMembership(projectId, userId) {
const url = `/api/data/projects/${projectId}/members/${userId}`;
return this.client.request("get", url, null, null);
}
/**
* Creates a membership for a user in a specified project
* and assigns the user the appropriate project access based on the specified project security role.
*
* A project member is a user who has access to a specific project.
* Project members are assigned a project security role, which controls the level of access they have to
* the project.
* Possible project security roles include manage, edit, collaborate, creator, and guest.
*
* @param projectId Reference to Project
* @param userId Reference to User
* @param body The permission to set
*/
createUserProjectMembership(projectId, userId, body) {
const url = `/api/data/projects/${projectId}/members/${userId}`;
return this.client.request("post", url, null, body);
}
/**
* Updates the project access for a current member of a specified project by giving the user a new project security role.
*
* A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to
* the project. Possible project security roles include manage, edit, collaborate, creator, and guest.
*
* @param projectId Reference to Project
* @param userId Reference to User
* @param body The permission to update
*/
updateUserProjectMembership(projectId, userId, body) {
const url = `/api/data/projects/${projectId}/members/${userId}`;
return this.client.request("put", url, null, body);
}
/**
* Removes a current project member from a specified project. This removes the user's access to that project.
*
* A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to
* the project. Possible project security roles include manage, edit, collaborate, creator, and guest.
*
* @param projectId Reference to Project
* @param userId Reference to User
*/
removeUserProjectMembership(projectId, userId) {
const url = `/api/data/projects/${projectId}/members/${userId}`;
return this.client.request("delete", url, null, null);
}
}
//# sourceMappingURL=ProjectMembersClient.js.map