Package com.spotify.github.v3.clients

Class TeamClient

java.lang.Object

com.spotify.github.v3.clients.TeamClient

public class TeamClient
extends Object

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Team>	createTeam(TeamCreate request)	Create a team in an organisation.
CompletableFuture<Void>	deleteMembership(String slug, String username)	Delete a membership for a user.
CompletableFuture<Void>	deleteTeam(String slug)	Delete a specific team in an organisation.
CompletableFuture<Membership>	getMembership(String slug, String username)	Get a team membership of a user.
CompletableFuture<Team>	getTeam(String slug)	Get a specific team in an organisation.
CompletableFuture<List<TeamInvitation>>	listPendingTeamInvitations(String slug)	List pending invitations for a team.
CompletableFuture<List<User>>	listTeamMembers(String slug)	List members of a specific team.
Iterator<AsyncPage<User>>	listTeamMembers(String slug, int pageSize)	List members of a specific team.
CompletableFuture<List<Team>>	listTeams()	List teams within an organisation.
CompletableFuture<Membership>	updateMembership(MembershipCreate request, String slug, String username)	Add or update a team membership for a user.
CompletableFuture<Team>	updateTeam(TeamUpdate request, String slug)	Update a team in an organisation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createTeam

public CompletableFuture<Team> createTeam(TeamCreate request)

Create a team in an organisation.

Parameters:

request - create team request

Returns:

team

getTeam

public CompletableFuture<Team> getTeam(String slug)

Get a specific team in an organisation.

Parameters:

slug - slug of the team name

Returns:

team

listTeams

public CompletableFuture<List<Team>> listTeams()

List teams within an organisation.

Returns:

list of all teams in an organisation

updateTeam

public CompletableFuture<Team> updateTeam(TeamUpdate request,
                                          String slug)

Update a team in an organisation.

Parameters:

request - update team request

slug - slug of the team name

Returns:

team

deleteTeam

public CompletableFuture<Void> deleteTeam(String slug)

Delete a specific team in an organisation.

Parameters:

slug - slug of the team name

Returns:

team

updateMembership

public CompletableFuture<Membership> updateMembership(MembershipCreate request,
                                                      String slug,
                                                      String username)

Add or update a team membership for a user.

Parameters:

request - update membership request

Returns:

membership

getMembership

public CompletableFuture<Membership> getMembership(String slug,
                                                   String username)

Get a team membership of a user.

Parameters:

slug - the team slug

username - username of the team member

Returns:

membership

listTeamMembers

public CompletableFuture<List<User>> listTeamMembers(String slug)

List members of a specific team.

Parameters:

slug - the team slug

Returns:

list of all users in a team

listTeamMembers

public Iterator<AsyncPage<User>> listTeamMembers(String slug,
                                                 int pageSize)

List members of a specific team.

Parameters:

slug - the team slug

pageSize - the number of users to fetch per page

Returns:

list of all users in a team

deleteMembership

public CompletableFuture<Void> deleteMembership(String slug,
                                                String username)

Delete a membership for a user.

Parameters:

slug - slug of the team name

Returns:

membership

listPendingTeamInvitations

public CompletableFuture<List<TeamInvitation>> listPendingTeamInvitations(String slug)

List pending invitations for a team.

Parameters:

slug - the team slug

Returns:

list of pending invitations for a team