public class TranslationsApi extends CrowdinApi
clientConfig, graphqlUrl, httpClient, url| Constructor and Description |
|---|
TranslationsApi(Credentials credentials) |
TranslationsApi(Credentials credentials,
ClientConfig clientConfig) |
| Modifier and Type | Method and Description |
|---|---|
ResponseObject<PreTranslationStatus> |
applyPreTranslation(java.lang.Long projectId,
ApplyPreTranslationRequest request) |
ResponseObject<PreTranslationStatus> |
applyPreTranslationStringsBased(java.lang.Long projectId,
ApplyPreTranslationStringsBasedRequest request)
Apply Pre-Translation (string-based projects)
|
ResponseList<PreTranslation> |
batchEditPreTranslations(java.lang.Long projectId,
java.util.List<PatchRequest> request)
Pre-Translation Batch Operations
|
ResponseObject<ProjectBuild> |
buildDirectoryTranslation(java.lang.Long projectId,
java.lang.Long directoryId,
BuildProjectDirectoryTranslationRequest request)
Build Project Directory Translation
|
ResponseObject<DownloadLink> |
buildProjectDirectoryTranslation(java.lang.Long projectId,
java.lang.Long directoryId,
BuildProjectDirectoryTranslationRequest request)
Deprecated.
the API responds with a directory build object, not a download link; use
buildDirectoryTranslation(Long, Long, BuildProjectDirectoryTranslationRequest) instead. |
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 jobIdentifier,
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 jobIdentifier)
Pre-Translation Report
|
ResponseObject<ImportTranslationsStatus> |
importTranslations(java.lang.Long projectId,
ImportTranslationsRequest request) |
ResponseObject<ImportTranslationsStringsBasedStatus> |
importTranslations(java.lang.Long projectId,
ImportTranslationsStringsBasedRequest request) |
ResponseObject<ImportTranslationsReportResponse> |
importTranslationsReport(java.lang.Long projectId,
java.lang.String importId) |
ResponseObject<ImportTranslationsStatus> |
importTranslationsStatus(java.lang.Long projectId,
java.lang.String importId) |
ResponseObject<ImportTranslationsStringsBasedReportResponse> |
importTranslationsStringsBasedReport(java.lang.Long projectId,
java.lang.String importId) |
ResponseObject<ImportTranslationsStringsBasedStatus> |
importTranslationsStringsBasedStatus(java.lang.Long projectId,
java.lang.String importId) |
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,
java.lang.Integer limit,
java.lang.Integer offset,
java.util.List<OrderByField> orderBy)
List Pre-Translations
|
ResponseList<PreTranslation> |
listPreTranslations(java.lang.Long projectId,
Pagination options)
List Pre-Translations
|
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 jobIdentifier) |
ResponseObject<UploadTranslationsResponse> |
uploadTranslations(java.lang.Long projectId,
java.lang.String languageId,
UploadTranslationsRequest request)
Deprecated.
deprecated by the API; use
importTranslations(Long, ImportTranslationsRequest) instead. |
ResponseObject<UploadTranslationsStringsResponse> |
uploadTranslationStringsBased(java.lang.Long projectId,
java.lang.String languageId,
UploadTranslationsStringsRequest request)
Deprecated.
deprecated by the API; use
importTranslations(Long, ImportTranslationsStringsBasedRequest) instead. |
ResponseList<QaCheck> |
validateQaChecks(java.lang.Long projectId,
java.util.List<ValidateQaChecksRequest> request)
Validate QA Checks
|
graphql, graphqlpublic TranslationsApi(Credentials credentials)
public TranslationsApi(Credentials credentials, ClientConfig clientConfig)
public ResponseObject<PreTranslationStatus> applyPreTranslation(java.lang.Long projectId, ApplyPreTranslationRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<PreTranslationStatus> applyPreTranslationStringsBased(java.lang.Long projectId, ApplyPreTranslationStringsBasedRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<PreTranslationStatus> preTranslationStatus(java.lang.Long projectId, java.lang.String jobIdentifier) throws HttpException, HttpBadRequestException
projectId - project identifierjobIdentifier - pre-translation job identifierHttpExceptionHttpBadRequestException@Deprecated public ResponseObject<DownloadLink> buildProjectDirectoryTranslation(java.lang.Long projectId, java.lang.Long directoryId, BuildProjectDirectoryTranslationRequest request) throws HttpException, HttpBadRequestException
buildDirectoryTranslation(Long, Long, BuildProjectDirectoryTranslationRequest) instead.projectId - project identifierdirectoryId - directory identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ProjectBuild> buildDirectoryTranslation(java.lang.Long projectId, java.lang.Long directoryId, BuildProjectDirectoryTranslationRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierdirectoryId - directory identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<DownloadLink> buildProjectFileTranslation(java.lang.Long projectId, java.lang.Long fileId, java.lang.String etag, BuildProjectFileTranslationRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierfileId - file identifieretag - Etag identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseList<ProjectBuild> listProjectBuilds(java.lang.Long projectId, java.lang.Long branchId, java.lang.Integer limit, java.lang.Integer offset) throws HttpException, HttpBadRequestException
projectId - project identifierbranchId - filter by branchIdlimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)HttpExceptionHttpBadRequestExceptionpublic ResponseObject<ProjectBuild> buildProjectTranslation(java.lang.Long projectId, BuildProjectTranslationRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request bodyHttpExceptionHttpBadRequestException@Deprecated public ResponseObject<UploadTranslationsResponse> uploadTranslations(java.lang.Long projectId, java.lang.String languageId, UploadTranslationsRequest request) throws HttpException, HttpBadRequestException
importTranslations(Long, ImportTranslationsRequest) instead.projectId - project identifierlanguageId - language identifierrequest - request bodyHttpExceptionHttpBadRequestException@Deprecated public ResponseObject<UploadTranslationsStringsResponse> uploadTranslationStringsBased(java.lang.Long projectId, java.lang.String languageId, UploadTranslationsStringsRequest request) throws HttpException, HttpBadRequestException
importTranslations(Long, ImportTranslationsStringsBasedRequest) instead.projectId - project identifierlanguageId - language identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<DownloadLink> downloadProjectTranslations(java.lang.Long projectId, java.lang.Long buildId) throws HttpException, HttpBadRequestException
projectId - project identifierbuildId - build identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ProjectBuild> checkBuildStatus(java.lang.Long projectId, java.lang.Long buildId) throws HttpException, HttpBadRequestException
projectId - project identifierbuildId - build identifierHttpExceptionHttpBadRequestExceptionpublic void cancelBuild(java.lang.Long projectId,
java.lang.Long buildId)
throws HttpException,
HttpBadRequestException
projectId - project identifierbuildId - build identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<DownloadLink> exportProjectTranslation(java.lang.Long projectId, ExportProjectTranslationRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseList<PreTranslation> listPreTranslations(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset) throws HttpException, HttpBadRequestException
projectId - project identifierlimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)HttpExceptionHttpBadRequestExceptionpublic ResponseList<PreTranslation> listPreTranslations(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy) throws HttpException, HttpBadRequestException
projectId - project identifierlimit - maximum number of items to retrieve (default 25)offset - starting offset in the collection (default 0)orderBy - list of OrderByFieldHttpExceptionHttpBadRequestExceptionpublic ResponseList<PreTranslation> listPreTranslations(java.lang.Long projectId, Pagination options) throws HttpException, HttpBadRequestException
projectId - project identifieroptions - pagination options; pass ListPreTranslationsOptions to also sort the resultsHttpExceptionHttpBadRequestExceptionpublic ResponseList<PreTranslation> batchEditPreTranslations(java.lang.Long projectId, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - list of patch operationsHttpExceptionHttpBadRequestExceptionpublic ResponseObject<PreTranslation> editPreTranslation(java.lang.Long projectId, java.lang.String jobIdentifier, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierjobIdentifier - pre-translation job identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<PreTranslationReportResponse> getPreTranslationReport(java.lang.Long projectId, java.lang.String jobIdentifier) throws HttpException, HttpBadRequestException
projectId - project identifierjobIdentifier - pre-translation job identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ImportTranslationsStatus> importTranslations(java.lang.Long projectId, ImportTranslationsRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ImportTranslationsStringsBasedStatus> importTranslations(java.lang.Long projectId, ImportTranslationsStringsBasedRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request bodyHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ImportTranslationsStatus> importTranslationsStatus(java.lang.Long projectId, java.lang.String importId) throws HttpException, HttpBadRequestException
projectId - project identifierimportId - import identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ImportTranslationsStringsBasedStatus> importTranslationsStringsBasedStatus(java.lang.Long projectId, java.lang.String importId) throws HttpException, HttpBadRequestException
projectId - project identifierimportId - import identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ImportTranslationsReportResponse> importTranslationsReport(java.lang.Long projectId, java.lang.String importId) throws HttpException, HttpBadRequestException
projectId - project identifierimportId - import identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ImportTranslationsStringsBasedReportResponse> importTranslationsStringsBasedReport(java.lang.Long projectId, java.lang.String importId) throws HttpException, HttpBadRequestException
projectId - project identifierimportId - import identifierHttpExceptionHttpBadRequestExceptionpublic ResponseList<QaCheck> validateQaChecks(java.lang.Long projectId, java.util.List<ValidateQaChecksRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - list of translations to validateHttpExceptionHttpBadRequestException