com.crowdin.client.users

Class UsersApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.users.UsersApi

public class UsersApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ProjectMembersResponse	addProjectMember(java.lang.Long projectId, AddProjectMemberRequest request)
void	deleteMemberFromProject(java.lang.Long projectId, java.lang.Long memberId)
void	deleteUser(java.lang.Long userId)
ResponseObject<User>	editUser(java.lang.Long userId, java.util.List<PatchRequest> request)
ResponseObject<User>	getAuthenticatedUser()
ResponseObject<GroupManager>	getGroupManager(java.lang.Long groupId, java.lang.Long userId) Get group manager.
ResponseObject<TeamMember>	getMemberInfo(java.lang.Long projectId, java.lang.Long memberId)
ResponseObject<ProjectMember>	getProjectMemberPermissions(java.lang.Long projectId, java.lang.Long memberId)
ResponseObject<User>	getUser(java.lang.Long userId)
ResponseObject<User>	inviteUser(InviteUserRequest request)
ResponseList<GroupManager>	listGroupManagers(java.lang.Long groupId, java.util.List<java.lang.Long> teamIds, java.lang.String orderBy) List group managers.
ResponseList<GroupManager>	listGroupManagers(java.lang.Long groupId, ListGroupManagersParams params) List group managers.
ResponseList<TeamMember>	listProjectMembers(java.lang.Long projectId, java.lang.String search, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<TeamMember>	listProjectMembers(java.lang.Long projectId, java.lang.String search, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<ProjectMember>	listProjectMembersEnterprise(java.lang.Long projectId, java.lang.String search, java.lang.String languageId, java.lang.Long workflowStepId, java.lang.Integer limit, java.lang.Integer offset) List project members.
ResponseList<ProjectMember>	listProjectMembersEnterprise(java.lang.Long projectId, java.lang.String search, java.lang.String languageId, java.lang.Long workflowStepId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy) List project members.
ResponseList<User>	listUsers(ListUsersParams params)
ResponseList<User>	listUsers(Status status, java.lang.String search, TwoFactor twoFactor, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<User>	listUsers(Status status, java.lang.String search, TwoFactor twoFactor, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseObject<ProjectMember>	replaceProjectMemberPermissions(java.lang.Long projectId, java.lang.Long memberId, ReplaceProjectMemberPermissionsRequest request)
ResponseList<GroupManager>	updateGroupManagers(java.lang.Long groupId, java.util.List<PatchRequest> request) Update group managers.

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

UsersApi

public UsersApi(Credentials credentials)

UsersApi

public UsersApi(Credentials credentials,
                ClientConfig clientConfig)

Method Detail

listGroupManagers

public ResponseList<GroupManager> listGroupManagers(java.lang.Long groupId,
                                                    java.util.List<java.lang.Long> teamIds,
                                                    java.lang.String orderBy)
                                             throws HttpException,
                                                    HttpBadRequestException

List group managers. For Crowdin Enterprise only

Parameters:

groupId - Group Identifier. Get via List Groups

teamIds - Defines team ids. It can be one team id or a list of comma-separated ones.

orderBy -

Returns:

list of group managers

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listGroupManagers

public ResponseList<GroupManager> listGroupManagers(java.lang.Long groupId,
                                                    ListGroupManagersParams params)
                                             throws HttpException,
                                                    HttpBadRequestException

List group managers. For Crowdin Enterprise only

Parameters:

groupId - Group Identifier. Get via List Groups

params - ListGroupManagersParams

Returns:

list of group managers

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

updateGroupManagers

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

Update group managers. For Crowdin Enterprise only

Parameters:

groupId - group identifier

request - request object

Returns:

list of updated group managers

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getGroupManager

public ResponseObject<GroupManager> getGroupManager(java.lang.Long groupId,
                                                    java.lang.Long userId)
                                             throws HttpException,
                                                    HttpBadRequestException

Get group manager. For Crowdin Enterprise only

Parameters:

groupId - group identifier

userId - user identifier

Returns:

group manager

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listProjectMembersEnterprise

public ResponseList<ProjectMember> listProjectMembersEnterprise(java.lang.Long projectId,
                                                                java.lang.String search,
                                                                java.lang.String languageId,
                                                                java.lang.Long workflowStepId,
                                                                java.lang.Integer limit,
                                                                java.lang.Integer offset)
                                                         throws HttpException,
                                                                HttpBadRequestException

List project members. For Crowdin Enterprise only

Parameters:

projectId - Project Identifier. Get via List Projects

search - Search users by firstName, lastName or username

languageId - Language Identifier. Get via Project Target Languages

workflowStepId - Workflow Step Identifier. Get via List Workflow Steps

limit - A maximum number of items to retrieve

offset - A starting offset in the collection

Returns:

list of project members

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listProjectMembersEnterprise

public ResponseList<ProjectMember> listProjectMembersEnterprise(java.lang.Long projectId,
                                                                java.lang.String search,
                                                                java.lang.String languageId,
                                                                java.lang.Long workflowStepId,
                                                                java.lang.Integer limit,
                                                                java.lang.Integer offset,
                                                                java.util.List<OrderByField> orderBy)
                                                         throws HttpException,
                                                                HttpBadRequestException

List project members. For Crowdin Enterprise only

Parameters:

projectId - Project Identifier. Get via List Projects

search - Search users by firstName, lastName or username

languageId - Language Identifier. Get via Project Target Languages

workflowStepId - Workflow Step Identifier. Get via List Workflow Steps

limit - A maximum number of items to retrieve

offset - A starting offset in the collection

orderBy - list of OrderByField

Returns:

list of project members

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

addProjectMember

public ProjectMembersResponse addProjectMember(java.lang.Long projectId,
                                               AddProjectMemberRequest request)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

project team members response info

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getProjectMemberPermissions

public ResponseObject<ProjectMember> getProjectMemberPermissions(java.lang.Long projectId,
                                                                 java.lang.Long memberId)
                                                          throws HttpException,
                                                                 HttpBadRequestException

Parameters:

projectId - project identifier

memberId - member identifier

Returns:

project member info

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

replaceProjectMemberPermissions

public ResponseObject<ProjectMember> replaceProjectMemberPermissions(java.lang.Long projectId,
                                                                     java.lang.Long memberId,
                                                                     ReplaceProjectMemberPermissionsRequest request)
                                                              throws HttpException,
                                                                     HttpBadRequestException

Parameters:

projectId - project identifier

memberId - member identifier

request - request object

Returns:

updated project member info

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteMemberFromProject

public void deleteMemberFromProject(java.lang.Long projectId,
                                    java.lang.Long memberId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

memberId - member identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listUsers

public ResponseList<User> listUsers(Status status,
                                    java.lang.String search,
                                    TwoFactor twoFactor,
                                    java.lang.Integer limit,
                                    java.lang.Integer offset)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

status - filter by status

search - search users by firstName, lastName, username, or email (2 or more characters)

twoFactor - filter by two-factor authentication status

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

offset - starting offset in the collection (default 0)

Returns:

list of users

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listUsers

public ResponseList<User> listUsers(Status status,
                                    java.lang.String search,
                                    TwoFactor twoFactor,
                                    java.lang.Integer limit,
                                    java.lang.Integer offset,
                                    java.util.List<OrderByField> orderBy)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

status - filter by status

search - search users by firstName, lastName, username, or email (2 or more characters)

twoFactor - filter by two-factor authentication status

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of users

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listUsers

public ResponseList<User> listUsers(ListUsersParams params)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

params - ListUsersParams

Returns:

list of teams

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

inviteUser

public ResponseObject<User> inviteUser(InviteUserRequest request)
                                throws HttpException,
                                       HttpBadRequestException

Parameters:

request - request object

Returns:

invited user

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getUser

public ResponseObject<User> getUser(java.lang.Long userId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

userId - user identifier

Returns:

user

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteUser

public void deleteUser(java.lang.Long userId)
                throws HttpException,
                       HttpBadRequestException

Parameters:

userId - user identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

editUser

public ResponseObject<User> editUser(java.lang.Long userId,
                                     java.util.List<PatchRequest> request)
                              throws HttpException,
                                     HttpBadRequestException

Parameters:

userId - user identifier

request - request object

Returns:

updated user

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getAuthenticatedUser

public ResponseObject<User> getAuthenticatedUser()
                                          throws HttpException,
                                                 HttpBadRequestException

Returns:

current authenticated user

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listProjectMembers

public ResponseList<TeamMember> listProjectMembers(java.lang.Long projectId,
                                                   java.lang.String search,
                                                   java.lang.Integer limit,
                                                   java.lang.Integer offset)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

search - search users by firstName, lastName, username, or email (2 or more characters)

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:

• API Documentation

listProjectMembers

public ResponseList<TeamMember> listProjectMembers(java.lang.Long projectId,
                                                   java.lang.String search,
                                                   java.lang.Integer limit,
                                                   java.lang.Integer offset,
                                                   java.util.List<OrderByField> orderBy)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

search - search users by firstName, lastName, username, or email (2 or more characters)

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of team members

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation

getMemberInfo

public ResponseObject<TeamMember> getMemberInfo(java.lang.Long projectId,
                                                java.lang.Long memberId)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

memberId - member identifier

Returns:

team member

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation