com.crowdin.client.translations

Class TranslationsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.translations.TranslationsApi

public class TranslationsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<PreTranslationStatus>	applyPreTranslation(java.lang.Long projectId, ApplyPreTranslationRequest request)
ResponseObject<PreTranslationStatus>	applyPreTranslationStringsBased(java.lang.Long projectId, ApplyPreTranslationStringsBasedRequest request)
ResponseObject<DownloadLink>	buildProjectDirectoryTranslation(java.lang.Long projectId, java.lang.Long directoryId, BuildProjectDirectoryTranslationRequest request)
ResponseObject<DownloadLink>	buildProjectFileTranslation(java.lang.Long projectId, java.lang.Long fileId, java.lang.String etag, BuildProjectFileTranslationRequest request)
ResponseObject<ProjectBuild>	buildProjectTranslation(java.lang.Long projectId, BuildProjectTranslationRequest request)
void	cancelBuild(java.lang.Long projectId, java.lang.Long buildId)
ResponseObject<ProjectBuild>	checkBuildStatus(java.lang.Long projectId, java.lang.Long buildId)
ResponseObject<DownloadLink>	downloadProjectTranslations(java.lang.Long projectId, java.lang.Long buildId)
ResponseObject<PreTranslation>	editPreTranslation(java.lang.Long projectId, java.lang.String preTranslationId, java.util.List<PatchRequest> request) Edit Pre-Translation
ResponseObject<DownloadLink>	exportProjectTranslation(java.lang.Long projectId, ExportProjectTranslationRequest request) Export Project Translation
ResponseObject<PreTranslationReportResponse>	getPreTranslationReport(java.lang.Long projectId, java.lang.String preTranslationId) Pre-Translation Report
ResponseList<PreTranslation>	listPreTranslations(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset) List Pre-Translations
ResponseList<PreTranslation>	listPreTranslations(java.lang.Long projectId, Pagination options)
ResponseList<ProjectBuild>	listProjectBuilds(java.lang.Long projectId, java.lang.Long branchId, java.lang.Integer limit, java.lang.Integer offset)
ResponseObject<PreTranslationStatus>	preTranslationStatus(java.lang.Long projectId, java.lang.String preTranslationId)
ResponseObject<UploadTranslationsResponse>	uploadTranslations(java.lang.Long projectId, java.lang.String languageId, UploadTranslationsRequest request)
ResponseObject<UploadTranslationsStringsResponse>	uploadTranslationStringsBased(java.lang.Long projectId, java.lang.String languageId, UploadTranslationsStringsRequest request)

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

TranslationsApi

public TranslationsApi(Credentials credentials)

TranslationsApi

public TranslationsApi(Credentials credentials,
                       ClientConfig clientConfig)

Method Detail

applyPreTranslation

public ResponseObject<PreTranslationStatus> applyPreTranslation(java.lang.Long projectId,
                                                                ApplyPreTranslationRequest request)
                                                         throws HttpException,
                                                                HttpBadRequestException

Parameters:

projectId - project identifier

request - request body

Returns:

pre-translation status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

applyPreTranslationStringsBased

public ResponseObject<PreTranslationStatus> applyPreTranslationStringsBased(java.lang.Long projectId,
                                                                            ApplyPreTranslationStringsBasedRequest request)
                                                                     throws HttpException,
                                                                            HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

preTranslationStatus

public ResponseObject<PreTranslationStatus> preTranslationStatus(java.lang.Long projectId,
                                                                 java.lang.String preTranslationId)
                                                          throws HttpException,
                                                                 HttpBadRequestException

Parameters:

projectId - project identifier

preTranslationId - pre-translation identifier

Returns:

pre-translation status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

buildProjectDirectoryTranslation

public ResponseObject<DownloadLink> buildProjectDirectoryTranslation(java.lang.Long projectId,
                                                                     java.lang.Long directoryId,
                                                                     BuildProjectDirectoryTranslationRequest request)
                                                              throws HttpException,
                                                                     HttpBadRequestException

Parameters:

projectId - project identifier

directoryId - directory identifier

request - request body

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

buildProjectFileTranslation

public ResponseObject<DownloadLink> buildProjectFileTranslation(java.lang.Long projectId,
                                                                java.lang.Long fileId,
                                                                java.lang.String etag,
                                                                BuildProjectFileTranslationRequest request)
                                                         throws HttpException,
                                                                HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

etag - Etag identifier

request - request body

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listProjectBuilds

public ResponseList<ProjectBuild> listProjectBuilds(java.lang.Long projectId,
                                                    java.lang.Long branchId,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

branchId - filter by branchId

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

offset - starting offset in the collection (default 0)

Returns:

list of project builds

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

buildProjectTranslation

public ResponseObject<ProjectBuild> buildProjectTranslation(java.lang.Long projectId,
                                                            BuildProjectTranslationRequest request)
                                                     throws HttpException,
                                                            HttpBadRequestException

Parameters:

projectId - project identifier

request - request body

Returns:

project build status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

uploadTranslations

public ResponseObject<UploadTranslationsResponse> uploadTranslations(java.lang.Long projectId,
                                                                     java.lang.String languageId,
                                                                     UploadTranslationsRequest request)
                                                              throws HttpException,
                                                                     HttpBadRequestException

Parameters:

projectId - project identifier

languageId - language identifier

request - request body

Returns:

upload translations response

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

uploadTranslationStringsBased

public ResponseObject<UploadTranslationsStringsResponse> uploadTranslationStringsBased(java.lang.Long projectId,
                                                                                       java.lang.String languageId,
                                                                                       UploadTranslationsStringsRequest request)
                                                                                throws HttpException,
                                                                                       HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

downloadProjectTranslations

public ResponseObject<DownloadLink> downloadProjectTranslations(java.lang.Long projectId,
                                                                java.lang.Long buildId)
                                                         throws HttpException,
                                                                HttpBadRequestException

Parameters:

projectId - project identifier

buildId - build identifier

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkBuildStatus

public ResponseObject<ProjectBuild> checkBuildStatus(java.lang.Long projectId,
                                                     java.lang.Long buildId)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

projectId - project identifier

buildId - build identifier

Returns:

project build status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

cancelBuild

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

Parameters:

projectId - project identifier

buildId - build identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

exportProjectTranslation

public ResponseObject<DownloadLink> exportProjectTranslation(java.lang.Long projectId,
                                                             ExportProjectTranslationRequest request)
                                                      throws HttpException,
                                                             HttpBadRequestException

Export Project Translation

Parameters:

projectId - project identifier

request - request body

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listPreTranslations

public ResponseList<PreTranslation> listPreTranslations(java.lang.Long projectId,
                                                        java.lang.Integer limit,
                                                        java.lang.Integer offset)
                                                 throws HttpException,
                                                        HttpBadRequestException

List Pre-Translations

Parameters:

projectId - project identifier

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

offset - starting offset in the collection (default 0)

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listPreTranslations

public ResponseList<PreTranslation> listPreTranslations(java.lang.Long projectId,
                                                        Pagination options)
                                                 throws HttpException,
                                                        HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

editPreTranslation

public ResponseObject<PreTranslation> editPreTranslation(java.lang.Long projectId,
                                                         java.lang.String preTranslationId,
                                                         java.util.List<PatchRequest> request)
                                                  throws HttpException,
                                                         HttpBadRequestException

Edit Pre-Translation

Parameters:

projectId - project identifier

preTranslationId - pre-translation identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getPreTranslationReport

public ResponseObject<PreTranslationReportResponse> getPreTranslationReport(java.lang.Long projectId,
                                                                            java.lang.String preTranslationId)
                                                                     throws HttpException,
                                                                            HttpBadRequestException

Pre-Translation Report

Parameters:

projectId - project identifier

preTranslationId - pre-translation identifier

Returns:

pre-translation report data

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation