projectmanager-sdk/dist/clients/ProjectMembersClient.d.ts

Software development kit for the ProjectManager.com API. for 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 { ProjectMemberDto } from "../index.js";
import { ProjectMembersAccessDto } from "../index.js";
import { ProjectMemberRoleDto } from "../index.js";
export declare class ProjectMembersClient {
    private readonly client;
    /**
     * Internal constructor for this client library
     */
    constructor(client: ProjectManagerClient);
    /**
     * 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(): Promise<AstroResult<ProjectMemberDto[]>>;
    /**
     * 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: string, includeAllUsers?: boolean): Promise<AstroResult<ProjectMemberDto[]>>;
    /**
     * 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: string, body: ProjectMembersAccessDto): Promise<AstroResult<ProjectMemberDto>>;
    /**
     * 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: string, userId: string): Promise<AstroResult<ProjectMemberDto>>;
    /**
     * 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: string, userId: string, body: ProjectMemberRoleDto): Promise<AstroResult<ProjectMemberDto>>;
    /**
     * 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: string, userId: string, body: ProjectMemberRoleDto): Promise<AstroResult<ProjectMemberDto>>;
    /**
     * 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: string, userId: string): Promise<AstroResult<object>>;
}