com.crowdin.client.bundles

Class BundlesApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.bundles.BundlesApi

public class BundlesApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Bundle>	addBundle(java.lang.Long projectId, AddBundleRequest request)
ResponseObject<BundleExport>	checkBundleExportStatus(java.lang.Long projectId, java.lang.Long bundleId, java.lang.String exportId)
void	deleteBundle(java.lang.Long projectId, java.lang.Long bundleId)
ResponseObject<DownloadLink>	downloadBundle(java.lang.Long projectId, java.lang.Long bundleId, java.lang.String exportId)
ResponseObject<Bundle>	editBundle(java.lang.Long projectId, java.lang.Long bundleId, java.util.List<PatchRequest> request)
ResponseObject<BundleExport>	exportBundle(java.lang.Long projectId, java.lang.Long bundleId)
ResponseObject<Bundle>	getBundle(java.lang.Long projectId, java.lang.Long bundleId)
ResponseList<Branch>	listBundleBranches(java.lang.Long projectId, java.lang.Long bundleId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<? extends FileInfo>	listBundleFiles(java.lang.Long projectId, java.lang.Long bundleId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Bundle>	listBundles(java.lang.Long projectId)
ResponseList<Bundle>	listBundles(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

BundlesApi

public BundlesApi(Credentials credentials)

BundlesApi

public BundlesApi(Credentials credentials,
                  ClientConfig clientConfig)

Method Detail

listBundles

public ResponseList<Bundle> listBundles(java.lang.Long projectId)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

projectId - project identifier

Returns:

list of bundles

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listBundles

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

Throws:

HttpException

HttpBadRequestException

addBundle

public ResponseObject<Bundle> addBundle(java.lang.Long projectId,
                                        AddBundleRequest request)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created bundle

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getBundle

public ResponseObject<Bundle> getBundle(java.lang.Long projectId,
                                        java.lang.Long bundleId)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

Returns:

bundle object

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteBundle

public void deleteBundle(java.lang.Long projectId,
                         java.lang.Long bundleId)
                  throws HttpException,
                         HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editBundle

public ResponseObject<Bundle> editBundle(java.lang.Long projectId,
                                         java.lang.Long bundleId,
                                         java.util.List<PatchRequest> request)
                                  throws HttpException,
                                         HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

request - request object

Returns:

updated bundle

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listBundleFiles

public ResponseList<? extends FileInfo> listBundleFiles(java.lang.Long projectId,
                                                        java.lang.Long bundleId,
                                                        java.lang.Integer limit,
                                                        java.lang.Integer offset)
                                                 throws HttpException,
                                                        HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of bundles file resource

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listBundleBranches

public ResponseList<Branch> listBundleBranches(java.lang.Long projectId,
                                               java.lang.Long bundleId,
                                               java.lang.Integer limit,
                                               java.lang.Integer offset)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

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

offset - starting offset in the collection (default 0)

Throws:

HttpException

HttpBadRequestException

downloadBundle

public ResponseObject<DownloadLink> downloadBundle(java.lang.Long projectId,
                                                   java.lang.Long bundleId,
                                                   java.lang.String exportId)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

exportId - export identifier, consists of 36 characters

Returns:

download link to bundle

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

exportBundle

public ResponseObject<BundleExport> exportBundle(java.lang.Long projectId,
                                                 java.lang.Long bundleId)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

projectId - project identifier

bundleId - bundle identifier

Returns:

freshly created bundle export object

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkBundleExportStatus

public ResponseObject<BundleExport> checkBundleExportStatus(java.lang.Long projectId,
                                                            java.lang.Long bundleId,
                                                            java.lang.String exportId)

Parameters:

projectId - project identifier

bundleId - bundle identifier

exportId - export identifier, consists of 36 characters

Returns:

requested bundle export object

See Also:

• API Documentation
• Enterprise API Documentation