com.crowdin.client.teams

Class TeamsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.teams.TeamsApi

public class TeamsApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
TeamsApi(Credentials credentials)
TeamsApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<Team>	addTeam(AddTeamRequest request)
AddTeamMembersResponse	addTeamMembers(java.lang.Long teamId, AddTeamMembersRequest request)
ProjectTeamResources	addTeamToProject(java.lang.Long projectId, AddTeamToProjectRequest request)
void	deleteAllTeamMembers(java.lang.Long teamId)
void	deleteTeam(java.lang.Long teamId)
void	deleteTeamMember(java.lang.Long teamId, java.lang.Long memberId)
ResponseObject<Team>	editTeam(java.lang.Long teamId, java.util.List<PatchRequest> request)
ResponseObject<GroupTeam>	getGroupTeam(java.lang.Long groupId, java.lang.Long teamId) Get group team.
ResponseObject<Team>	getTeam(java.lang.Long teamId)
ResponseList<GroupTeam>	listGroupTeams(ListGroupTeamsParams params) List group teams.
ResponseList<GroupTeam>	listGroupTeams(java.lang.Long groupId, java.lang.String orderBy) List group teams.
ResponseList<TeamMember>	listTeamMembers(java.lang.Long teamId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Team>	listTeams(java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Team>	listTeams(java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<Team>	listTeams(ListTeamsParams params)
ResponseList<GroupTeam>	updateGroupTeams(java.lang.Long groupId, java.util.List<PatchRequest> request) Update group teams.

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

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

Constructor Detail

TeamsApi

public TeamsApi(Credentials credentials)

TeamsApi

public TeamsApi(Credentials credentials,
                ClientConfig clientConfig)

Method Detail

listGroupTeams

public ResponseList<GroupTeam> listGroupTeams(java.lang.Long groupId,
                                              java.lang.String orderBy)
                                       throws HttpException,
                                              HttpBadRequestException

List group teams. For Crowdin Enterprise only

Parameters:

groupId - group identifier

orderBy -

Returns:

list of group teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listGroupTeams

public ResponseList<GroupTeam> listGroupTeams(ListGroupTeamsParams params)
                                       throws HttpException,
                                              HttpBadRequestException

List group teams. For Crowdin Enterprise only

Parameters:

params - ListGroupTeamsParams object

Returns:

list of group teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

updateGroupTeams

public ResponseList<GroupTeam> updateGroupTeams(java.lang.Long groupId,
                                                java.util.List<PatchRequest> request)
                                         throws HttpException,
                                                HttpBadRequestException

Update group teams. For Crowdin Enterprise only

Parameters:

groupId - group identifier

request - request object

Returns:

list of updated group teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getGroupTeam

public ResponseObject<GroupTeam> getGroupTeam(java.lang.Long groupId,
                                              java.lang.Long teamId)
                                       throws HttpException,
                                              HttpBadRequestException

Get group team. For Crowdin Enterprise only

Parameters:

groupId - group identifier

teamId - team identifier

Returns:

group team

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

addTeamToProject

public ProjectTeamResources addTeamToProject(java.lang.Long projectId,
                                             AddTeamToProjectRequest request)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

project team status

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listTeams

public ResponseList<Team> listTeams(java.lang.Integer limit,
                                    java.lang.Integer offset)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listTeams

public ResponseList<Team> listTeams(java.lang.Integer limit,
                                    java.lang.Integer offset,
                                    java.util.List<OrderByField> orderBy)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listTeams

public ResponseList<Team> listTeams(ListTeamsParams params)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

params - ListTeamsParams

Returns:

list of teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

addTeam

public ResponseObject<Team> addTeam(AddTeamRequest request)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

request - request object

Returns:

newly created team

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getTeam

public ResponseObject<Team> getTeam(java.lang.Long teamId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

teamId - team identifier

Returns:

team

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteTeam

public void deleteTeam(java.lang.Long teamId)
                throws HttpException,
                       HttpBadRequestException

Parameters:

teamId - team identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

editTeam

public ResponseObject<Team> editTeam(java.lang.Long teamId,
                                     java.util.List<PatchRequest> request)
                              throws HttpException,
                                     HttpBadRequestException

Parameters:

teamId - team identifier

request - request object

Returns:

updated team

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listTeamMembers

public ResponseList<TeamMember> listTeamMembers(java.lang.Long teamId,
                                                java.lang.Integer limit,
                                                java.lang.Integer offset)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

teamId - team identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of team members

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

addTeamMembers

public AddTeamMembersResponse addTeamMembers(java.lang.Long teamId,
                                             AddTeamMembersRequest request)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

teamId - team identifier

request - request object

Returns:

response

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteAllTeamMembers

public void deleteAllTeamMembers(java.lang.Long teamId)
                          throws HttpException,
                                 HttpBadRequestException

Parameters:

teamId - team identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteTeamMember

public void deleteTeamMember(java.lang.Long teamId,
                             java.lang.Long memberId)
                      throws HttpException,
                             HttpBadRequestException

Parameters:

teamId - team identifier

memberId - member identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation