Interface ITeamUsers

export
interface: ITeamUsers

Hierarchy

ITeamUsers

Implemented by

TeamUsers

Index

Methods

Methods

delete

delete(teamId: number, userId: number): Promise<object>

- Defined in api/i-team-users.ts:56
description

Deletes a user from the team. Requires Admin role in the team.

memberof

ITeamUsers

Parameters
- teamId: number
- userId: number
Returns Promise<object>

}

get

get(teamId: number, userId: number): Promise<object>

- Defined in api/i-team-users.ts:31
description

Retrieves a Team user object. Requires Admin role in the team.

memberof

ITeamUsers

Parameters
- teamId: number
- userId: number
Returns Promise<object>

}

list

list(teamId: number, query?: IPage): Promise<object>

- Defined in api/i-team-users.ts:19
description

Lists all team users. Requires Admin role in the team

memberof

ITeamUsers

Parameters
- teamId: number
- Optional query: IPage
Returns Promise<object>

}

update

update(teamId: number, userId: number, body: object): Promise<object>

- Defined in api/i-team-users.ts:44
description

Updates the role of a team user. Requires Admin role in the team.

memberof

ITeamUsers

Parameters
- teamId: number
- userId: number
- body: object
Returns Promise<object>

}

Generated using TypeDoc