com.crowdin.client.distributions

Class DistributionsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.distributions.DistributionsApi

public class DistributionsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Distribution>	addDistribution(java.lang.Long projectId, AddDistributionRequest request)
ResponseObject<Distribution>	addDistributionStringsBased(java.lang.Long projectId, AddDistributionStringsBasedRequest request)
ResponseObject<DistributionRelease>	createDistributionRelease(java.lang.Long projectId, java.lang.String hash)
ResponseObject<DistributionStringsBasedRelease>	createDistributionStringsBasedRelease(java.lang.Long projectId, java.lang.String hash)
void	deleteDistribution(java.lang.Long projectId, java.lang.String hash)
ResponseObject<Distribution>	editDistribution(java.lang.Long projectId, java.lang.String hash, java.util.List<PatchRequest> request)
ResponseObject<Distribution>	getDistribution(java.lang.Long projectId, java.lang.String hash)
ResponseObject<DistributionRelease>	getDistributionRelease(java.lang.Long projectId, java.lang.String hash)
ResponseObject<DistributionStringsBasedRelease>	getDistributionStringsBasedRelease(java.lang.Long projectId, java.lang.String hash)
ResponseList<Distribution>	listDistributions(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Distribution>	listDistributions(java.lang.Long projectId, Pagination options)

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

DistributionsApi

public DistributionsApi(Credentials credentials)

DistributionsApi

public DistributionsApi(Credentials credentials,
                        ClientConfig clientConfig)

Method Detail

listDistributions

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

Parameters:

projectId - project identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of distributions

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listDistributions

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

Throws:

HttpException

HttpBadRequestException

addDistribution

public ResponseObject<Distribution> addDistribution(java.lang.Long projectId,
                                                    AddDistributionRequest request)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created distribution

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addDistributionStringsBased

public ResponseObject<Distribution> addDistributionStringsBased(java.lang.Long projectId,
                                                                AddDistributionStringsBasedRequest request)
                                                         throws HttpException,
                                                                HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

getDistribution

public ResponseObject<Distribution> getDistribution(java.lang.Long projectId,
                                                    java.lang.String hash)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

hash - hash

Returns:

distribution

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteDistribution

public void deleteDistribution(java.lang.Long projectId,
                               java.lang.String hash)
                        throws HttpException,
                               HttpBadRequestException

Parameters:

projectId - project identifier

hash - hash

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editDistribution

public ResponseObject<Distribution> editDistribution(java.lang.Long projectId,
                                                     java.lang.String hash,
                                                     java.util.List<PatchRequest> request)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

projectId - project identifier

hash - hash

request - request object

Returns:

updated distribution

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getDistributionRelease

public ResponseObject<DistributionRelease> getDistributionRelease(java.lang.Long projectId,
                                                                  java.lang.String hash)
                                                           throws HttpException,
                                                                  HttpBadRequestException

Parameters:

projectId - project identifier

hash - hash

Returns:

distribution release

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getDistributionStringsBasedRelease

public ResponseObject<DistributionStringsBasedRelease> getDistributionStringsBasedRelease(java.lang.Long projectId,
                                                                                          java.lang.String hash)
                                                                                   throws HttpException,
                                                                                          HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

createDistributionRelease

public ResponseObject<DistributionRelease> createDistributionRelease(java.lang.Long projectId,
                                                                     java.lang.String hash)
                                                              throws HttpException,
                                                                     HttpBadRequestException

Parameters:

projectId - project identifier

hash - hash

Returns:

distribution release

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

createDistributionStringsBasedRelease

public ResponseObject<DistributionStringsBasedRelease> createDistributionStringsBasedRelease(java.lang.Long projectId,
                                                                                             java.lang.String hash)
                                                                                      throws HttpException,
                                                                                             HttpBadRequestException

Throws:

HttpException

HttpBadRequestException