com.crowdin.client.sourcefiles

Class SourceFilesApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.sourcefiles.SourceFilesApi

public class SourceFilesApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<Branch>	addBranch(java.lang.Long projectId, AddBranchRequest request)
ResponseObject<Directory>	addDirectory(java.lang.Long projectId, AddDirectoryRequest request)
ResponseObject<? extends FileInfo>	addFile(java.lang.Long projectId, AddFileRequest request)
ResponseObject<ReviewedStringsBuild>	buildReviewedSourceFiles(java.lang.Long projectId, BuildReviewedSourceFilesRequest request)
ResponseObject<ReviewedStringsBuild>	checkReviewedSourceFilesBuildStatus(java.lang.Long projectId, java.lang.Long buildId)
void	deleteBranch(java.lang.Long projectId, java.lang.Long branchId)
void	deleteDirectory(java.lang.Long projectId, java.lang.Long directoryId)
void	deleteFile(java.lang.Long projectId, java.lang.Long fileId)
ResponseObject<DownloadLink>	downloadFile(java.lang.Long projectId, java.lang.Long fileId)
ResponseObject<DownloadLink>	downloadFilePreview(java.lang.Long projectId, java.lang.Long fileId)
ResponseObject<DownloadLink>	downloadReviewedSourceFiles(java.lang.Long projectId, java.lang.Long buildId)
ResponseObject<Branch>	editBranch(java.lang.Long projectId, java.lang.Long branchId, java.util.List<PatchRequest> request)
ResponseObject<Directory>	editDirectory(java.lang.Long projectId, java.lang.Long directoryId, java.util.List<PatchRequest> request)
ResponseObject<? extends FileInfo>	editFile(java.lang.Long projectId, java.lang.Long fileId, java.util.List<PatchRequest> request)
ResponseObject<Branch>	getBranch(java.lang.Long projectId, java.lang.Long branchId)
ResponseObject<Directory>	getDirectory(java.lang.Long projectId, java.lang.Long directoryId)
ResponseObject<? extends FileInfo>	getFile(java.lang.Long projectId, java.lang.Long fileId)
ResponseObject<FileRevision>	getFileRevision(java.lang.Long projectId, java.lang.Long fileId, java.lang.Long revisionId)
ResponseList<Branch>	listBranches(java.lang.Long projectId, java.lang.String name, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Directory>	listDirectories(java.lang.Long projectId, java.lang.Long branchId, java.lang.Long directoryId, java.lang.String filter, java.lang.Object recursion, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<FileRevision>	listFileRevisions(java.lang.Long projectId, java.lang.Long fileId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<? extends FileInfo>	listFiles(java.lang.Long projectId, java.lang.Long branchId, java.lang.Long directoryId, java.lang.String filter, java.lang.Object recursion, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<ReviewedStringsBuild>	listReviewedSourceFilesBuilds(java.lang.Long projectId, java.lang.Long branchId, java.lang.Integer limit, java.lang.Integer offset)
ResponseObject<? extends FileInfo>	updateOrRestoreFile(java.lang.Long projectId, java.lang.Long fileId, UpdateOrRestoreFileRequest 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

SourceFilesApi

public SourceFilesApi(Credentials credentials)

SourceFilesApi

public SourceFilesApi(Credentials credentials,
                      ClientConfig clientConfig)

Method Detail

listBranches

public ResponseList<Branch> listBranches(java.lang.Long projectId,
                                         java.lang.String name,
                                         java.lang.Integer limit,
                                         java.lang.Integer offset)
                                  throws HttpException,
                                         HttpBadRequestException

Parameters:

projectId - project identifier

name - filter by branch name

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

offset - starting offset in the collection (default 0)

Returns:

list of branches

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addBranch

public ResponseObject<Branch> addBranch(java.lang.Long projectId,
                                        AddBranchRequest request)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created branch

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getBranch

public ResponseObject<Branch> getBranch(java.lang.Long projectId,
                                        java.lang.Long branchId)
                                 throws HttpException,
                                        HttpBadRequestException

Parameters:

projectId - project identifier

branchId - branch identifier

Returns:

branch

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteBranch

public void deleteBranch(java.lang.Long projectId,
                         java.lang.Long branchId)
                  throws HttpException,
                         HttpBadRequestException

Parameters:

projectId - project identifier

branchId - branch identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editBranch

public ResponseObject<Branch> editBranch(java.lang.Long projectId,
                                         java.lang.Long branchId,
                                         java.util.List<PatchRequest> request)
                                  throws HttpException,
                                         HttpBadRequestException

Parameters:

projectId - project identifier

branchId - branch identifier

request - request object

Returns:

updated branch

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listDirectories

public ResponseList<Directory> listDirectories(java.lang.Long projectId,
                                               java.lang.Long branchId,
                                               java.lang.Long directoryId,
                                               java.lang.String filter,
                                               java.lang.Object recursion,
                                               java.lang.Integer limit,
                                               java.lang.Integer offset)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

projectId - project identifier

branchId - filter by branch id

directoryId - filter by directory id

filter - filter directories by name

recursion - use to list directories recursively

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

offset - starting offset in the collection (default 0)

Returns:

list of directories

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addDirectory

public ResponseObject<Directory> addDirectory(java.lang.Long projectId,
                                              AddDirectoryRequest request)
                                       throws HttpException,
                                              HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created directory

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getDirectory

public ResponseObject<Directory> getDirectory(java.lang.Long projectId,
                                              java.lang.Long directoryId)
                                       throws HttpException,
                                              HttpBadRequestException

Parameters:

projectId - project identifier

directoryId - directory identifier

Returns:

directory

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteDirectory

public void deleteDirectory(java.lang.Long projectId,
                            java.lang.Long directoryId)
                     throws HttpException,
                            HttpBadRequestException

Parameters:

projectId - project identifier

directoryId - directory identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editDirectory

public ResponseObject<Directory> editDirectory(java.lang.Long projectId,
                                               java.lang.Long directoryId,
                                               java.util.List<PatchRequest> request)
                                        throws HttpException,
                                               HttpBadRequestException

Parameters:

projectId - project identifier

directoryId - directory identifier

request - request object

Returns:

updated directory

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listFiles

public ResponseList<? extends FileInfo> listFiles(java.lang.Long projectId,
                                                  java.lang.Long branchId,
                                                  java.lang.Long directoryId,
                                                  java.lang.String filter,
                                                  java.lang.Object recursion,
                                                  java.lang.Integer limit,
                                                  java.lang.Integer offset)
                                           throws HttpException,
                                                  HttpBadRequestException

Parameters:

projectId - project identifier

branchId - filter by branch id

directoryId - filter by directory id

filter - filter files by name

recursion - use to list directories recursively

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

offset - starting offset in the collection (default 0)

Returns:

list of files

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addFile

public ResponseObject<? extends FileInfo> addFile(java.lang.Long projectId,
                                                  AddFileRequest request)
                                           throws HttpException,
                                                  HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

newly created file

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getFile

public ResponseObject<? extends FileInfo> getFile(java.lang.Long projectId,
                                                  java.lang.Long fileId)
                                           throws HttpException,
                                                  HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

Returns:

file

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

updateOrRestoreFile

public ResponseObject<? extends FileInfo> updateOrRestoreFile(java.lang.Long projectId,
                                                              java.lang.Long fileId,
                                                              UpdateOrRestoreFileRequest request)
                                                       throws HttpException,
                                                              HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

request - request object

Returns:

updated file

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteFile

public void deleteFile(java.lang.Long projectId,
                       java.lang.Long fileId)
                throws HttpException,
                       HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editFile

public ResponseObject<? extends FileInfo> editFile(java.lang.Long projectId,
                                                   java.lang.Long fileId,
                                                   java.util.List<PatchRequest> request)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

request - request object

Returns:

updated file

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadFile

public ResponseObject<DownloadLink> downloadFile(java.lang.Long projectId,
                                                 java.lang.Long fileId)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

Returns:

file download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listFileRevisions

public ResponseList<FileRevision> listFileRevisions(java.lang.Long projectId,
                                                    java.lang.Long fileId,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of file revisions

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getFileRevision

public ResponseObject<FileRevision> getFileRevision(java.lang.Long projectId,
                                                    java.lang.Long fileId,
                                                    java.lang.Long revisionId)
                                             throws HttpException,
                                                    HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

revisionId - revision identifier

Returns:

file revision

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listReviewedSourceFilesBuilds

public ResponseList<ReviewedStringsBuild> listReviewedSourceFilesBuilds(java.lang.Long projectId,
                                                                        java.lang.Long branchId,
                                                                        java.lang.Integer limit,
                                                                        java.lang.Integer offset)
                                                                 throws HttpException,
                                                                        HttpBadRequestException

Parameters:

projectId - project identifier

branchId - branch identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of reviewed strings build statuses

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

buildReviewedSourceFiles

public ResponseObject<ReviewedStringsBuild> buildReviewedSourceFiles(java.lang.Long projectId,
                                                                     BuildReviewedSourceFilesRequest request)

Parameters:

projectId - project identifier

request - request object

Returns:

reviewed strings build status

See Also:

• Enterprise API Documentation

checkReviewedSourceFilesBuildStatus

public ResponseObject<ReviewedStringsBuild> checkReviewedSourceFilesBuildStatus(java.lang.Long projectId,
                                                                                java.lang.Long buildId)

Parameters:

projectId - project identifier

buildId - build identifier

Returns:

reviewed strings build status

See Also:

• Enterprise API Documentation

downloadReviewedSourceFiles

public ResponseObject<DownloadLink> downloadReviewedSourceFiles(java.lang.Long projectId,
                                                                java.lang.Long buildId)

Parameters:

projectId - project identifier

buildId - build identifier

Returns:

download link

See Also:

• Enterprise API Documentation

downloadFilePreview

public ResponseObject<DownloadLink> downloadFilePreview(java.lang.Long projectId,
                                                        java.lang.Long fileId)
                                                 throws HttpException,
                                                        HttpBadRequestException

Parameters:

projectId - project identifier

fileId - file identifier

Returns:

file download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation