com.crowdin.client.reports

Class ReportsApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.reports.ReportsApi

public class ReportsApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate>	addOrganizationReportSettingsTemplate(ReportSettingsTemplate.OrganizationReportSettingsTemplate request)
ResponseObject<ReportSettingsTemplate>	addReportSettingsTemplate(java.lang.Long projectId, ReportSettingsTemplate request)
ResponseObject<ReportSettingsTemplate>	addUserReportSettingsTemplate(java.lang.Long userId, ReportSettingsTemplate request)
ResponseObject<GroupReportStatus>	checkGroupReportGenerationStatus(java.lang.Long groupId, java.lang.String reportId)
ResponseObject<GroupReportStatus>	checkOrganizationReportGenerationStatus(java.lang.String reportId)
ResponseObject<GroupReportStatus>	checkReportArchiveExportStatus(java.lang.Long userId, java.lang.Long archiveId, java.lang.String exportId)
ResponseObject<ReportStatus>	checkReportGenerationStatus(java.lang.Long projectId, java.lang.String reportId)
void	deleteOrganizationReportSettingsTemplate(java.lang.Long reportSettingsTemplateId)
void	deleteReportArchive(java.lang.Long userId, java.lang.Long archiveId)
void	deleteReportSettingsTemplate(java.lang.Long projectId, java.lang.Long reportSettingsTemplateId)
void	deleteUserReportSettingsTemplate(java.lang.Long userId, java.lang.Long reportSettingsTemplateId)
ResponseObject<DownloadLink>	downloadGroupReport(java.lang.Long groupId, java.lang.String reportId)
ResponseObject<DownloadLink>	downloadOrganizationReport(java.lang.String reportId)
ResponseObject<DownloadLink>	downloadReport(java.lang.Long projectId, java.lang.String reportId)
ResponseObject<DownloadLink>	downloadReportArchive(java.lang.Long userId, java.lang.Long archiveId, java.lang.String exportId)
ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate>	editOrganizationReportSettingsTemplate(java.lang.Long reportSettingsTemplateId, java.util.List<PatchRequest> request)
ResponseObject<ReportSettingsTemplate>	editReportSettingsTemplate(java.lang.Long projectId, java.lang.Long reportSettingsTemplateId, java.util.List<PatchRequest> request)
ResponseObject<ReportSettingsTemplate>	editUserReportSettingsTemplate(java.lang.Long userId, java.lang.Long reportSettingsTemplateId, java.util.List<PatchRequest> request)
ResponseObject<GroupReportStatus>	exportReportArchive(java.lang.Long userId, java.lang.Long archiveId, ExportReportRequest request)
ResponseObject<GroupReportStatus>	generateGroupReport(java.lang.Long groupId, GenerateGroupReportRequest request)
ResponseObject<GroupReportStatus>	generateOrganizationReport(GenerateGroupReportRequest request)
ResponseObject<ReportStatus>	generateReport(java.lang.Long projectId, GenerateReportRequest request)
ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate>	getOrganizationReportSettingsTemplate(java.lang.Long reportSettingsTemplateId)
ResponseObject<ReportArchive>	getReportArchive(java.lang.Long userId, java.lang.Long archiveId)
ResponseObject<ReportSettingsTemplate>	getReportSettingsTemplate(java.lang.Long projectId, java.lang.Long reportSettingsTemplateId)
ResponseObject<ReportSettingsTemplate>	getUserReportSettingsTemplate(java.lang.Long userId, java.lang.Long reportSettingsTemplateId)
ResponseList<ReportSettingsTemplate.OrganizationReportSettingsTemplate>	listOrganizationReportSettingsTemplates(ListOrganizationReportSettingsParams params)
ResponseList<ReportArchive>	listReportArchives(java.lang.Long userId, java.lang.String scopeType, java.lang.Long scopeId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<ReportSettingsTemplate>	listReportSettingsTemplate(java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<ReportSettingsTemplate>	listUserReportSettingsTemplate(java.lang.Long userId, java.lang.Integer limit, java.lang.Integer offset)

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

ReportsApi

public ReportsApi(Credentials credentials)

ReportsApi

public ReportsApi(Credentials credentials,
                  ClientConfig clientConfig)

Method Detail

generateGroupReport

public ResponseObject<GroupReportStatus> generateGroupReport(java.lang.Long groupId,
                                                             GenerateGroupReportRequest request)
                                                      throws HttpException,
                                                             HttpBadRequestException

Parameters:

groupId - group identifier

request - request object

Returns:

group report status

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

checkGroupReportGenerationStatus

public ResponseObject<GroupReportStatus> checkGroupReportGenerationStatus(java.lang.Long groupId,
                                                                          java.lang.String reportId)
                                                                   throws HttpException,
                                                                          HttpBadRequestException

Parameters:

groupId - group identifier

reportId - report identifier

Returns:

group report status

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

downloadGroupReport

public ResponseObject<DownloadLink> downloadGroupReport(java.lang.Long groupId,
                                                        java.lang.String reportId)
                                                 throws HttpException,
                                                        HttpBadRequestException

Parameters:

groupId - group identifier

reportId - report identifier

Returns:

report download link

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

generateOrganizationReport

public ResponseObject<GroupReportStatus> generateOrganizationReport(GenerateGroupReportRequest request)
                                                             throws HttpException,
                                                                    HttpBadRequestException

Parameters:

request - request object

Returns:

organization report status

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

checkOrganizationReportGenerationStatus

public ResponseObject<GroupReportStatus> checkOrganizationReportGenerationStatus(java.lang.String reportId)
                                                                          throws HttpException,
                                                                                 HttpBadRequestException

Parameters:

reportId - report identifier

Returns:

organization report status

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

downloadOrganizationReport

public ResponseObject<DownloadLink> downloadOrganizationReport(java.lang.String reportId)
                                                        throws HttpException,
                                                               HttpBadRequestException

Parameters:

reportId - report identifier

Returns:

report download link

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

listOrganizationReportSettingsTemplates

public ResponseList<ReportSettingsTemplate.OrganizationReportSettingsTemplate> listOrganizationReportSettingsTemplates(ListOrganizationReportSettingsParams params)
                                                                                                                throws HttpException,
                                                                                                                       HttpBadRequestException

Returns:

list of report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

addOrganizationReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> addOrganizationReportSettingsTemplate(ReportSettingsTemplate.OrganizationReportSettingsTemplate request)
                                                                                                                throws HttpException,
                                                                                                                       HttpBadRequestException

Parameters:

request - request object

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

getOrganizationReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> getOrganizationReportSettingsTemplate(java.lang.Long reportSettingsTemplateId)
                                                                                                                throws HttpException,
                                                                                                                       HttpBadRequestException

Parameters:

reportSettingsTemplateId - report settings template identifier

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

editOrganizationReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> editOrganizationReportSettingsTemplate(java.lang.Long reportSettingsTemplateId,
                                                                                                                        java.util.List<PatchRequest> request)
                                                                                                                 throws HttpException,
                                                                                                                        HttpBadRequestException

Parameters:

reportSettingsTemplateId - report settings template identifier

request - request object

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

deleteOrganizationReportSettingsTemplate

public void deleteOrganizationReportSettingsTemplate(java.lang.Long reportSettingsTemplateId)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

reportSettingsTemplateId - report settings template identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• Enterprise API Documentation

generateReport

public ResponseObject<ReportStatus> generateReport(java.lang.Long projectId,
                                                   GenerateReportRequest request)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

report status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkReportGenerationStatus

public ResponseObject<ReportStatus> checkReportGenerationStatus(java.lang.Long projectId,
                                                                java.lang.String reportId)
                                                         throws HttpException,
                                                                HttpBadRequestException

Parameters:

projectId - project identifier

reportId - report identifier

Returns:

report status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadReport

public ResponseObject<DownloadLink> downloadReport(java.lang.Long projectId,
                                                   java.lang.String reportId)
                                            throws HttpException,
                                                   HttpBadRequestException

Parameters:

projectId - project identifier

reportId - report identifier

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listReportSettingsTemplate

public ResponseList<ReportSettingsTemplate> listReportSettingsTemplate(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 report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate> addReportSettingsTemplate(java.lang.Long projectId,
                                                                        ReportSettingsTemplate request)
                                                                 throws HttpException,
                                                                        HttpBadRequestException

Parameters:

projectId - project identifier

request - request object

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate> getReportSettingsTemplate(java.lang.Long projectId,
                                                                        java.lang.Long reportSettingsTemplateId)
                                                                 throws HttpException,
                                                                        HttpBadRequestException

Parameters:

projectId - project identifier

reportSettingsTemplateId - report settings template identifier

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate> editReportSettingsTemplate(java.lang.Long projectId,
                                                                         java.lang.Long reportSettingsTemplateId,
                                                                         java.util.List<PatchRequest> request)
                                                                  throws HttpException,
                                                                         HttpBadRequestException

Parameters:

projectId - project identifier

reportSettingsTemplateId - report settings template identifier

request - request object

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteReportSettingsTemplate

public void deleteReportSettingsTemplate(java.lang.Long projectId,
                                         java.lang.Long reportSettingsTemplateId)
                                  throws HttpException,
                                         HttpBadRequestException

Parameters:

projectId - project identifier

reportSettingsTemplateId - report settings template identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listUserReportSettingsTemplate

public ResponseList<ReportSettingsTemplate> listUserReportSettingsTemplate(java.lang.Long userId,
                                                                           java.lang.Integer limit,
                                                                           java.lang.Integer offset)
                                                                    throws HttpException,
                                                                           HttpBadRequestException

Parameters:

userId - user identifier

limit - (default 25)

offset - (default 0)

Returns:

list of user report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addUserReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate> addUserReportSettingsTemplate(java.lang.Long userId,
                                                                            ReportSettingsTemplate request)
                                                                     throws HttpException,
                                                                            HttpBadRequestException

Parameters:

userId - user identifier

request - request object

Returns:

user report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getUserReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate> getUserReportSettingsTemplate(java.lang.Long userId,
                                                                            java.lang.Long reportSettingsTemplateId)
                                                                     throws HttpException,
                                                                            HttpBadRequestException

Parameters:

userId - user identifier

reportSettingsTemplateId - report settings template identifier

Returns:

user report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editUserReportSettingsTemplate

public ResponseObject<ReportSettingsTemplate> editUserReportSettingsTemplate(java.lang.Long userId,
                                                                             java.lang.Long reportSettingsTemplateId,
                                                                             java.util.List<PatchRequest> request)
                                                                      throws HttpException,
                                                                             HttpBadRequestException

Parameters:

userId - user identifier

reportSettingsTemplateId - report settings template identifier

request - request object

Returns:

user report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteUserReportSettingsTemplate

public void deleteUserReportSettingsTemplate(java.lang.Long userId,
                                             java.lang.Long reportSettingsTemplateId)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

userId - user identifier

reportSettingsTemplateId - report settings template identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listReportArchives

public ResponseList<ReportArchive> listReportArchives(java.lang.Long userId,
                                                      java.lang.String scopeType,
                                                      java.lang.Long scopeId,
                                                      java.lang.Integer limit,
                                                      java.lang.Integer offset)
                                               throws HttpException,
                                                      HttpBadRequestException

Parameters:

userId - user identifier

scopeType - Filter only project report archives (scopeType=project)

scopeId - Filter archives by spicific scope id (default 25)

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

offset - starting offset in the collection (default 0)

Returns:

list of report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getReportArchive

public ResponseObject<ReportArchive> getReportArchive(java.lang.Long userId,
                                                      java.lang.Long archiveId)
                                               throws HttpException,
                                                      HttpBadRequestException

Parameters:

userId - user identifier

archiveId - archive identifier

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteReportArchive

public void deleteReportArchive(java.lang.Long userId,
                                java.lang.Long archiveId)
                         throws HttpException,
                                HttpBadRequestException

Parameters:

userId - user identifier

archiveId - archive identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

exportReportArchive

public ResponseObject<GroupReportStatus> exportReportArchive(java.lang.Long userId,
                                                             java.lang.Long archiveId,
                                                             ExportReportRequest request)
                                                      throws HttpException,
                                                             HttpBadRequestException

Parameters:

userId - user identifier

archiveId - archive identifier

request - request object

Returns:

report settings template

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkReportArchiveExportStatus

public ResponseObject<GroupReportStatus> checkReportArchiveExportStatus(java.lang.Long userId,
                                                                        java.lang.Long archiveId,
                                                                        java.lang.String exportId)
                                                                 throws HttpException,
                                                                        HttpBadRequestException

Parameters:

archiveId - archive identifier

exportId - export identifier

Returns:

export report status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadReportArchive

public ResponseObject<DownloadLink> downloadReportArchive(java.lang.Long userId,
                                                          java.lang.Long archiveId,
                                                          java.lang.String exportId)
                                                   throws HttpException,
                                                          HttpBadRequestException

Parameters:

userId - user identifier

archiveId - archive identifier

exportId - export identifier

Returns:

report archive download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation