com.crowdin.client.projectsgroups

Class ProjectsGroupsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.projectsgroups.ProjectsGroupsApi

public class ProjectsGroupsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Group>	addGroup(AddGroupRequest request)
ResponseObject<? extends Project>	addProject(AddProjectRequest request)
ResponseObject<FileFormatSettingsResource>	addProjectFileFormatSettings(java.lang.Long projectId, AddProjectFileFormatSettingsRequest request)
ResponseObject<StringsExporterSettingsResource>	addProjectStringsExporterSettings(java.lang.Long projectId, StringsExporterSettingsRequest data)
void	deleteGroup(java.lang.Long groupId)
void	deleteProject(java.lang.Long projectId)
void	deleteProjectFileFormatSettings(java.lang.Long projectId, java.lang.Long fileFormatSettingsId)
void	deleteProjectStringsExporterSettings(java.lang.Long projectId, java.lang.Long systemStringsExporterSettingsId)
ResponseObject<DownloadLink>	downloadProjectFileFormatSettingsCustomSegmentation(java.lang.Long projectId, java.lang.Long fileFormatSettingsId)
ResponseObject<Group>	editGroup(java.lang.Long groupId, java.util.List<PatchRequest> request)
ResponseObject<? extends Project>	editProject(java.lang.Long projectId, java.util.List<PatchRequest> request)
ResponseObject<FileFormatSettingsResource>	editProjectFileFormatSettings(java.lang.Long projectId, java.lang.Long fileFormatSettingsId, java.util.List<PatchRequest> request)
ResponseObject<StringsExporterSettingsResource>	editProjectStringsExporterSettings(java.lang.Long projectId, java.lang.Long systemStringsExporterSettingsId, StringsExporterSettingsRequest request)
ResponseObject<Group>	getGroup(java.lang.Long groupId)
ResponseObject<? extends Project>	getProject(java.lang.Long projectId)
ResponseObject<FileFormatSettingsResource>	getProjectFileFormatSettings(java.lang.Long projectId, java.lang.Long fileFormatSettingsId)
ResponseObject<StringsExporterSettingsResource>	getProjectStringsExporterSettings(java.lang.Long projectId, java.lang.Long systemStringsExporterSettingsId)
ResponseList<Group>	listGroups(ListGroupOptions options)
ResponseList<Group>	listGroups(java.lang.Long parentId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<FileFormatSettingsResource>	listProjectFileFormatSettings(java.lang.Long projectId)
ResponseList<? extends Project>	listProjects(ListProjectOptions options)
ResponseList<? extends Project>	listProjects(java.lang.Long groupId, java.lang.Integer hasManagerAccess, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<? extends Project>	listProjects(java.lang.Long groupId, java.lang.Integer hasManagerAccess, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<StringsExporterSettingsResource>	listProjectStringsExporterSettings(java.lang.Long projectId)
void	resetProjectFileFormatSettingsCustomSegmentation(java.lang.Long projectId, java.lang.Long fileFormatSettingsId)

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

ProjectsGroupsApi

public ProjectsGroupsApi(Credentials credentials)

ProjectsGroupsApi

public ProjectsGroupsApi(Credentials credentials,
                         ClientConfig clientConfig)

Method Detail

listGroups

public ResponseList<Group> listGroups(java.lang.Long parentId,
                                      java.lang.Integer limit,
                                      java.lang.Integer offset)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

parentId - parent group identifier. Get via List Groups

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

offset - starting offset in the collection (default 0)

Returns:

list of groups

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listGroups

public ResponseList<Group> listGroups(ListGroupOptions options)
                               throws HttpException,
                                      HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addGroup

public ResponseObject<Group> addGroup(AddGroupRequest request)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

request - request object

Returns:

newly created group

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getGroup

public ResponseObject<Group> getGroup(java.lang.Long groupId)
                               throws HttpException,
                                      HttpBadRequestException

Parameters:

groupId - group identifier

Returns:

group

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteGroup

public void deleteGroup(java.lang.Long groupId)
                 throws HttpException,
                        HttpBadRequestException

Parameters:

groupId - group identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

editGroup

public ResponseObject<Group> editGroup(java.lang.Long groupId,
                                       java.util.List<PatchRequest> request)
                                throws HttpException,
                                       HttpBadRequestException

Parameters:

groupId - group identifier

request - request object

Returns:

updated group

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listProjects

public ResponseList<? extends Project> listProjects(java.lang.Long groupId,
                                                    java.lang.Integer hasManagerAccess,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

groupId - group identifier (optional)

hasManagerAccess - projects with manager access (default 0)

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

offset - starting offset in the collection (default 0)

Returns:

list of projects

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listProjects

public ResponseList<? extends Project> listProjects(java.lang.Long groupId,
                                                    java.lang.Integer hasManagerAccess,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset,
                                                    java.util.List<OrderByField> orderBy)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

groupId - group identifier (optional)

hasManagerAccess - projects with manager access (default 0)

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of projects

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listProjects

public ResponseList<? extends Project> listProjects(ListProjectOptions options)
                                             throws HttpException,
                                                    HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addProject

public ResponseObject<? extends Project> addProject(AddProjectRequest request)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

request - request object

Returns:

newly created project

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getProject

public ResponseObject<? extends Project> getProject(java.lang.Long projectId)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

Returns:

project

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteProject

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

Parameters:

projectId - project identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editProject

public ResponseObject<? extends Project> editProject(java.lang.Long projectId,
                                                     java.util.List<PatchRequest> request)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

updated project

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadProjectFileFormatSettingsCustomSegmentation

public ResponseObject<DownloadLink> downloadProjectFileFormatSettingsCustomSegmentation(java.lang.Long projectId,
                                                                                        java.lang.Long fileFormatSettingsId)

Parameters:

projectId - project identifier

fileFormatSettingsId - file format settings identifier

Returns:

download link

See Also:

• API Documentation
• Enterprise API Documentation

resetProjectFileFormatSettingsCustomSegmentation

public void resetProjectFileFormatSettingsCustomSegmentation(java.lang.Long projectId,
                                                             java.lang.Long fileFormatSettingsId)
                                                      throws HttpException,
                                                             HttpBadRequestException

Parameters:

projectId - project identifier

fileFormatSettingsId - file format settings identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listProjectFileFormatSettings

public ResponseList<FileFormatSettingsResource> listProjectFileFormatSettings(java.lang.Long projectId)

Parameters:

projectId - project identifier

See Also:

• API Documentation
• Enterprise API Documentation

addProjectFileFormatSettings

public ResponseObject<FileFormatSettingsResource> addProjectFileFormatSettings(java.lang.Long projectId,
                                                                               AddProjectFileFormatSettingsRequest request)

Parameters:

request - request object

Returns:

newly created project

See Also:

• API Documentation
• Enterprise API Documentation

getProjectFileFormatSettings

public ResponseObject<FileFormatSettingsResource> getProjectFileFormatSettings(java.lang.Long projectId,
                                                                               java.lang.Long fileFormatSettingsId)

Parameters:

projectId - project identifier

fileFormatSettingsId - file format settings identifier

Returns:

project

See Also:

• API Documentation
• Enterprise API Documentation

deleteProjectFileFormatSettings

public void deleteProjectFileFormatSettings(java.lang.Long projectId,
                                            java.lang.Long fileFormatSettingsId)
                                     throws HttpException,
                                            HttpBadRequestException

Parameters:

projectId - project identifier

fileFormatSettingsId - file format settings identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editProjectFileFormatSettings

public ResponseObject<FileFormatSettingsResource> editProjectFileFormatSettings(java.lang.Long projectId,
                                                                                java.lang.Long fileFormatSettingsId,
                                                                                java.util.List<PatchRequest> request)
                                                                         throws HttpException,
                                                                                HttpBadRequestException

Parameters:

projectId - project identifier

fileFormatSettingsId - file format settings identifier

request - request object

Returns:

updated file format settings

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listProjectStringsExporterSettings

public ResponseList<StringsExporterSettingsResource> listProjectStringsExporterSettings(java.lang.Long projectId)
                                                                                 throws HttpException,
                                                                                        HttpBadRequestException

Parameters:

projectId - project identifier

Returns:

list of strings exporter settings resources

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addProjectStringsExporterSettings

public ResponseObject<StringsExporterSettingsResource> addProjectStringsExporterSettings(java.lang.Long projectId,
                                                                                         StringsExporterSettingsRequest data)
                                                                                  throws HttpException,
                                                                                         HttpBadRequestException

Parameters:

projectId - project identifier

data - strings exporter settings

Returns:

strings exporter settings resource

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getProjectStringsExporterSettings

public ResponseObject<StringsExporterSettingsResource> getProjectStringsExporterSettings(java.lang.Long projectId,
                                                                                         java.lang.Long systemStringsExporterSettingsId)
                                                                                  throws HttpException,
                                                                                         HttpBadRequestException

Parameters:

projectId - project identifier

systemStringsExporterSettingsId - strings exporter settings identifier

Returns:

strings exporter settings resource

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteProjectStringsExporterSettings

public void deleteProjectStringsExporterSettings(java.lang.Long projectId,
                                                 java.lang.Long systemStringsExporterSettingsId)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

projectId - project identifier

systemStringsExporterSettingsId - strings exporter settings identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editProjectStringsExporterSettings

public ResponseObject<StringsExporterSettingsResource> editProjectStringsExporterSettings(java.lang.Long projectId,
                                                                                          java.lang.Long systemStringsExporterSettingsId,
                                                                                          StringsExporterSettingsRequest request)
                                                                                   throws HttpException,
                                                                                          HttpBadRequestException

Parameters:

projectId - project identifier

systemStringsExporterSettingsId - strings exporter settings identifier

Returns:

updated strings exporter settings resource

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation