com.crowdin.client.stringcorrections

Class StringCorrectionsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.stringcorrections.StringCorrectionsApi

public class StringCorrectionsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Correction>	addCorrection(java.lang.Long projectId, AddCorrectionRequest request)
void	deleteCorrection(java.lang.Long projectId, java.lang.Long correctionId)
void	deleteCorrections(java.lang.Long projectId, java.lang.Long stringId)
ResponseObject<Correction>	getCorrection(java.lang.Long projectId, java.lang.Long correctionId)
ResponseList<Correction>	listCorrections(java.lang.Long projectId, ListCorrectionsQueryParams params)
ResponseObject<Correction>	restoreCorrection(java.lang.Long projectId, java.lang.Long correctionId)

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

StringCorrectionsApi

public StringCorrectionsApi(Credentials credentials)

StringCorrectionsApi

public StringCorrectionsApi(Credentials credentials,
                            ClientConfig clientConfig)

Method Detail

listCorrections

public ResponseList<Correction> listCorrections(java.lang.Long projectId,
                                                ListCorrectionsQueryParams params)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

params - query params

Returns:

list of corrections

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

addCorrection

public ResponseObject<Correction> addCorrection(java.lang.Long projectId,
                                                AddCorrectionRequest request)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created correction

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getCorrection

public ResponseObject<Correction> getCorrection(java.lang.Long projectId,
                                                java.lang.Long correctionId)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

projectId - project identifier

correctionId - correction identifier

Returns:

correction object

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteCorrections

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

Parameters:

projectId - project identifier

stringId - string identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

restoreCorrection

public ResponseObject<Correction> restoreCorrection(java.lang.Long projectId,
                                                    java.lang.Long correctionId)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

correctionId - correction identifier

Returns:

newly created correction

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteCorrection

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

Parameters:

projectId - project identifier

correctionId - correction identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation