com.crowdin.client.stringtranslations

Class StringTranslationsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.stringtranslations.StringTranslationsApi

public class StringTranslationsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Approval>	addApproval(java.lang.Long projectId, AddApprovalRequest request)
ResponseObject<StringTranslation>	addTranslation(java.lang.Long projectId, AddStringTranslationRequest request)
ResponseObject<Vote>	addVote(java.lang.Long projectId, AddVoteRequest request)
AlignTranslationResponse	alignTranslation(java.lang.Long projectId, AlignTranslationRequest request)
ResponseList<Approval>	approvalBatchOperations(java.lang.Long projectId, java.util.List<PatchRequest> request)
void	cancelVote(java.lang.Long projectId, java.lang.Long voteId)
void	deleteStringTranslation(java.lang.Long projectId, java.lang.Long translationId)
void	deleteStringTranslations(java.lang.Long projectId, java.lang.Long stringId, java.lang.String languageId)
ResponseObject<Approval>	getApproval(java.lang.Long projectId, java.lang.Long approvalId)
ResponseObject<StringTranslation>	getStringTranslation(java.lang.Long projectId, java.lang.Long translationId)
ResponseObject<Vote>	getVote(java.lang.Long projectId, java.lang.Long voteId)
ResponseList<LanguageTranslations>	listLanguageTranslations(java.lang.Long projectId, java.lang.String languageId, ListLanguageTranslationsOptions options)
ResponseList<LanguageTranslations>	listLanguageTranslations(java.lang.Long projectId, java.lang.String languageId, java.lang.String stringIds, java.lang.String labelIds, java.lang.Long fileId, java.lang.Long branchId, java.lang.Long directoryId, java.lang.String croql, java.lang.Integer denormalizePlaceholders, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<LanguageTranslations>	listLanguageTranslations(java.lang.Long projectId, java.lang.String languageId, java.lang.String stringIds, java.lang.String labelIds, java.lang.Long fileId, java.lang.Long branchId, java.lang.Long directoryId, java.lang.String croql, java.lang.Integer denormalizePlaceholders, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<StringTranslation>	listStringTranslations(java.lang.Long projectId, ListStringTranslationsOptions options)
ResponseList<StringTranslation>	listStringTranslations(java.lang.Long projectId, java.lang.Long stringId, java.lang.String languageId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<StringTranslation>	listStringTranslations(java.lang.Long projectId, java.lang.Long stringId, java.lang.String languageId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<Approval>	listTranslationApprovals(java.lang.Long projectId, ListTranslationApprovalsOptions options)
ResponseList<Approval>	listTranslationApprovals(java.lang.Long projectId, java.lang.Long fileId, java.lang.Long stringId, java.lang.String languageId, java.lang.Long translationId, java.lang.String labelIds, java.lang.String excludeLabelIds, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Approval>	listTranslationApprovals(java.lang.Long projectId, java.lang.Long fileId, java.lang.Long stringId, java.lang.String languageId, java.lang.Long translationId, java.lang.String labelIds, java.lang.String excludeLabelIds, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<Vote>	listTranslationVotes(java.lang.Long projectId, ListTranslationVotesOptions options)
ResponseList<Vote>	listTranslationVotes(java.lang.Long projectId, java.lang.Long stringId, java.lang.String languageId, java.lang.Long translationId, java.lang.String labelIds, java.lang.String excludeLabelIds, java.lang.Integer limit, java.lang.Integer offset)
void	removeApproval(java.lang.Long projectId, java.lang.Long approvalId)
void	removeStringApprovals(java.lang.Long projectId, java.lang.Long stringId)
ResponseObject<StringTranslation>	restoreStringTranslation(java.lang.Long projectId, java.lang.Long translationId)
ResponseList<StringTranslation>	translationBatchOperations(java.lang.Long projectId, java.util.List<PatchRequest> 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

StringTranslationsApi

public StringTranslationsApi(Credentials credentials)

StringTranslationsApi

public StringTranslationsApi(Credentials credentials,
                             ClientConfig clientConfig)

Method Detail

alignTranslation

public AlignTranslationResponse alignTranslation(java.lang.Long projectId,
                                                 AlignTranslationRequest request)

Parameters:

projectId - project identifier

request - request body

Returns:

align-translation response

See Also:

• API Documentation
• Enterprise API Documentation

listTranslationApprovals

public ResponseList<Approval> listTranslationApprovals(java.lang.Long projectId,
                                                       java.lang.Long fileId,
                                                       java.lang.Long stringId,
                                                       java.lang.String languageId,
                                                       java.lang.Long translationId,
                                                       java.lang.String labelIds,
                                                       java.lang.String excludeLabelIds,
                                                       java.lang.Integer limit,
                                                       java.lang.Integer offset)
                                                throws HttpException,
                                                       HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

stringId - string identifier

languageId - language identifier

translationId - translation identifier

labelIds - filter approvals by labelIds

excludeLabelIds - exclude approvals by labelIds

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

offset - starting offset in the collection (default 0)

Returns:

list of approvals

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTranslationApprovals

public ResponseList<Approval> listTranslationApprovals(java.lang.Long projectId,
                                                       java.lang.Long fileId,
                                                       java.lang.Long stringId,
                                                       java.lang.String languageId,
                                                       java.lang.Long translationId,
                                                       java.lang.String labelIds,
                                                       java.lang.String excludeLabelIds,
                                                       java.lang.Integer limit,
                                                       java.lang.Integer offset,
                                                       java.util.List<OrderByField> orderBy)
                                                throws HttpException,
                                                       HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

stringId - string identifier

languageId - language identifier

translationId - translation identifier

labelIds - filter approvals by labelIds

excludeLabelIds - exclude approvals by labelIds

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of approvals

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTranslationApprovals

public ResponseList<Approval> listTranslationApprovals(java.lang.Long projectId,
                                                       ListTranslationApprovalsOptions options)
                                                throws HttpException,
                                                       HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addApproval

public ResponseObject<Approval> addApproval(java.lang.Long projectId,
                                            AddApprovalRequest request)
                                     throws HttpException,
                                            HttpBadRequestException

Parameters:

projectId - project identifier

request - request body

Returns:

newly created approval

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getApproval

public ResponseObject<Approval> getApproval(java.lang.Long projectId,
                                            java.lang.Long approvalId)
                                     throws HttpException,
                                            HttpBadRequestException

Parameters:

projectId - project identifier

approvalId - approval identifier

Returns:

approval

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

removeStringApprovals

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

Parameters:

projectId - project identifier

stringId - string identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

removeApproval

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

Parameters:

projectId - project identifier

approvalId - approval identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

approvalBatchOperations

public ResponseList<Approval> approvalBatchOperations(java.lang.Long projectId,
                                                      java.util.List<PatchRequest> request)

Parameters:

projectId - project identifier

See Also:

• API Documentation
• Enterprise API Documentation

translationBatchOperations

public ResponseList<StringTranslation> translationBatchOperations(java.lang.Long projectId,
                                                                  java.util.List<PatchRequest> request)

Parameters:

projectId - project identifier

See Also:

• API Documentation
• Enterprise API Documentation

listLanguageTranslations

public ResponseList<LanguageTranslations> listLanguageTranslations(java.lang.Long projectId,
                                                                   java.lang.String languageId,
                                                                   java.lang.String stringIds,
                                                                   java.lang.String labelIds,
                                                                   java.lang.Long fileId,
                                                                   java.lang.Long branchId,
                                                                   java.lang.Long directoryId,
                                                                   java.lang.String croql,
                                                                   java.lang.Integer denormalizePlaceholders,
                                                                   java.lang.Integer limit,
                                                                   java.lang.Integer offset)
                                                            throws HttpException,
                                                                   HttpBadRequestException

Parameters:

projectId - project identifier

languageId - language identifier

stringIds - filter translations by stringIds

labelIds - filter translations by labelIds

fileId - filter translations by file identifier

branchId - filter translations by branchId

directoryId - filter translations by directoryId

croql - filter translations by croql

denormalizePlaceholders - enable denormalize placeholders

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

offset - starting offset in the collection (default 0)

Returns:

list of language translations

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listLanguageTranslations

public ResponseList<LanguageTranslations> listLanguageTranslations(java.lang.Long projectId,
                                                                   java.lang.String languageId,
                                                                   java.lang.String stringIds,
                                                                   java.lang.String labelIds,
                                                                   java.lang.Long fileId,
                                                                   java.lang.Long branchId,
                                                                   java.lang.Long directoryId,
                                                                   java.lang.String croql,
                                                                   java.lang.Integer denormalizePlaceholders,
                                                                   java.lang.Integer limit,
                                                                   java.lang.Integer offset,
                                                                   java.util.List<OrderByField> orderBy)
                                                            throws HttpException,
                                                                   HttpBadRequestException

Parameters:

projectId - project identifier

languageId - language identifier

stringIds - filter translations by stringIds

labelIds - filter translations by labelIds

fileId - filter translations by file identifier

branchId - filter translations by branchId

directoryId - filter translations by directoryId

croql - filter translations by croql

denormalizePlaceholders - enable denormalize placeholders

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of language translations

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listLanguageTranslations

public ResponseList<LanguageTranslations> listLanguageTranslations(java.lang.Long projectId,
                                                                   java.lang.String languageId,
                                                                   ListLanguageTranslationsOptions options)
                                                            throws HttpException,
                                                                   HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

listStringTranslations

public ResponseList<StringTranslation> listStringTranslations(java.lang.Long projectId,
                                                              java.lang.Long stringId,
                                                              java.lang.String languageId,
                                                              java.lang.Integer limit,
                                                              java.lang.Integer offset)
                                                       throws HttpException,
                                                              HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

languageId - language identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of string translations

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listStringTranslations

public ResponseList<StringTranslation> listStringTranslations(java.lang.Long projectId,
                                                              java.lang.Long stringId,
                                                              java.lang.String languageId,
                                                              java.lang.Integer limit,
                                                              java.lang.Integer offset,
                                                              java.util.List<OrderByField> orderBy)
                                                       throws HttpException,
                                                              HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

languageId - language identifier

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderBy field

Returns:

list of string translations

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listStringTranslations

public ResponseList<StringTranslation> listStringTranslations(java.lang.Long projectId,
                                                              ListStringTranslationsOptions options)
                                                       throws HttpException,
                                                              HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addTranslation

public ResponseObject<StringTranslation> addTranslation(java.lang.Long projectId,
                                                        AddStringTranslationRequest request)
                                                 throws HttpException,
                                                        HttpBadRequestException

Parameters:

projectId - project identifier

request - request body

Returns:

newly created translation

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteStringTranslations

public void deleteStringTranslations(java.lang.Long projectId,
                                     java.lang.Long stringId,
                                     java.lang.String languageId)
                              throws HttpException,
                                     HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

languageId - language identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getStringTranslation

public ResponseObject<StringTranslation> getStringTranslation(java.lang.Long projectId,
                                                              java.lang.Long translationId)
                                                       throws HttpException,
                                                              HttpBadRequestException

Parameters:

projectId - project identifier

translationId - translation identifier

Returns:

string translation

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteStringTranslation

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

Parameters:

projectId - project identifier

translationId - translation identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

restoreStringTranslation

public ResponseObject<StringTranslation> restoreStringTranslation(java.lang.Long projectId,
                                                                  java.lang.Long translationId)
                                                           throws HttpException,
                                                                  HttpBadRequestException

Parameters:

projectId - project identifier

translationId - translation identifier

Returns:

string translation

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTranslationVotes

public ResponseList<Vote> listTranslationVotes(java.lang.Long projectId,
                                               java.lang.Long stringId,
                                               java.lang.String languageId,
                                               java.lang.Long translationId,
                                               java.lang.String labelIds,
                                               java.lang.String excludeLabelIds,
                                               java.lang.Integer limit,
                                               java.lang.Integer offset)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

projectId - project identifier

stringId - string identifier

languageId - language identifier

translationId - translation identifier

labelIds - filter votes by labelIds

excludeLabelIds - exclude votes by labelIds

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

offset - starting offset in the collection (default 0)

Returns:

list of votes

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTranslationVotes

public ResponseList<Vote> listTranslationVotes(java.lang.Long projectId,
                                               ListTranslationVotesOptions options)
                                        throws HttpException,
                                               HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addVote

public ResponseObject<Vote> addVote(java.lang.Long projectId,
                                    AddVoteRequest request)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

request - request body

Returns:

newly created vote

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getVote

public ResponseObject<Vote> getVote(java.lang.Long projectId,
                                    java.lang.Long voteId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

projectId - project identifier

voteId - vote identifier

Returns:

vote

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

cancelVote

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

Parameters:

projectId - project identifier

voteId - vote identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation