Skip to content

feat(reports): update reports API to the latest docs #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Oct 27, 2026
Merged

feat(reports): update reports API to the latest docs #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 41 additions & 17 deletions src/main/java/com/crowdin/client/reports/ReportsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,10 @@ public ResponseObject<DownloadLink> downloadOrganizationReport(String reportId)
}

/**
* @param params query params
* @return list of report settings template
* @see <ul>
* <li><a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Reports/operation/api.reports.settings-templates.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.settings-templates.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseList<ReportSettingsTemplate.OrganizationReportSettingsTemplate> listOrganizationReportSettingsTemplates(ListOrganizationReportSettingsParams params) throws HttpException, HttpBadRequestException {
Expand All @@ -122,7 +123,7 @@ public ResponseList<ReportSettingsTemplate.OrganizationReportSettingsTemplate> l
* @param request request object
* @return report settings template
* @see <ul>
* <li><a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Reports/operation/api.reports.settings-templates.post" target="_blank"><b>Enterprise API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.settings-templates.post" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> addOrganizationReportSettingsTemplate(ReportSettingsTemplate.OrganizationReportSettingsTemplate request) throws HttpException, HttpBadRequestException {
Expand All @@ -134,7 +135,7 @@ public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate>
* @param reportSettingsTemplateId report settings template identifier
* @return report settings template
* @see <ul>
* <li><a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Reports/operation/api.reports.settings-templates.get" target="_blank"><b>Enterprise API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.settings-templates.get" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> getOrganizationReportSettingsTemplate(Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
Expand All @@ -147,7 +148,7 @@ public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate>
* @param request request object
* @return report settings template
* @see <ul>
* <li><a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Reports/operation/api.reports.settings-templates.patch" target="_blank"><b>Enterprise API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.settings-templates.patch" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> editOrganizationReportSettingsTemplate(Long reportSettingsTemplateId, List<PatchRequest> request) throws HttpException, HttpBadRequestException {
Expand All @@ -158,7 +159,7 @@ public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate>
/**
* @param reportSettingsTemplateId report settings template identifier
* @see <ul>
* <li><a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Reports/operation/api.reports.settings-templates.delete" target="_blank"><b>Enterprise API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.settings-templates.delete" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public void deleteOrganizationReportSettingsTemplate(Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
Expand Down Expand Up @@ -214,7 +215,6 @@ public ResponseObject<DownloadLink> downloadReport(Long projectId, String report
* @return list of report settings template
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.getMany" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseList<ReportSettingsTemplate> listReportSettingsTemplate(Long projectId, Integer limit, Integer offset) throws HttpException, HttpBadRequestException {
Expand All @@ -232,7 +232,6 @@ public ResponseList<ReportSettingsTemplate> listReportSettingsTemplate(Long proj
* @return report settings template
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.post" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.post" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<ReportSettingsTemplate> addReportSettingsTemplate(Long projectId, ReportSettingsTemplate request) throws HttpException, HttpBadRequestException {
Expand All @@ -246,7 +245,6 @@ public ResponseObject<ReportSettingsTemplate> addReportSettingsTemplate(Long pro
* @return report settings template
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.get" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.get" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<ReportSettingsTemplate> getReportSettingsTemplate(Long projectId, Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
Expand All @@ -261,7 +259,6 @@ public ResponseObject<ReportSettingsTemplate> getReportSettingsTemplate(Long pro
* @return report settings template
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.patch" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.reports.settings-templates.patch" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<ReportSettingsTemplate> editReportSettingsTemplate(Long projectId, Long reportSettingsTemplateId, List<PatchRequest> request) throws HttpException, HttpBadRequestException {
Expand All @@ -273,8 +270,7 @@ public ResponseObject<ReportSettingsTemplate> editReportSettingsTemplate(Long pr
* @param projectId project identifier
* @param reportSettingsTemplateId report settings template identifier
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.settings-templates.delete" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.settings-templates.delete" target="_blank"><b>Enterprise API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.projects.reports.settings-templates.delete" target="_blank"><b>API Documentation</b></a></li>
* </ul>
*/
public void deleteReportSettingsTemplate(Long projectId, Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
Expand Down Expand Up @@ -367,17 +363,17 @@ public void deleteUserReportSettingsTemplate(Long userId, Long reportSettingsTem
/**
* @param userId user identifier
* @param scopeType Filter only project report archives (scopeType=project)
* @param scopeId Filter archives by spicific scope id (default 25)
* @param scopeId Filter archives by specific scope id
* @param limit maximum number of items to retrieve (default 25)
* @param offset starting offset in the collection (default 0)
* @return list of report settings template
* @return list of report archives
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.reports.archives.getMany" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseList<ReportArchive> listReportArchives(Long userId, String scopeType, Long scopeId, Integer limit, Integer offset) throws HttpException, HttpBadRequestException {
String url = getReportArchivesPath(userId, "reports/archives/");
String url = getReportArchivesPath(userId, "reports/archives");
Map<String, Optional<Object>> queryParams = HttpRequestConfig.buildUrlParams(
"scopeType", Optional.ofNullable(scopeType),
"scopeId", Optional.ofNullable(scopeId),
Expand All @@ -388,6 +384,33 @@ public ResponseList<ReportArchive> listReportArchives(Long userId, String scopeT
return ReportArchiveList.to(responseObject);
}

/**
* @param userId user identifier (path parameter, Crowdin only; {@code null} for Crowdin Enterprise)
* @param params query params (scopeType, scopeId, userId, taskId, name, dateFrom, dateTo, limit, offset)
* @return list of report archives
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.reports.archives.getMany" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseList<ReportArchive> listReportArchives(Long userId, ListReportArchivesParams params) throws HttpException, HttpBadRequestException {
ListReportArchivesParams query = Optional.ofNullable(params).orElse(new ListReportArchivesParams());
String url = getReportArchivesPath(userId, "reports/archives");
Map<String, Optional<Object>> queryParams = HttpRequestConfig.buildUrlParams(
"scopeType", Optional.ofNullable(query.getScopeType()),
"scopeId", Optional.ofNullable(query.getScopeId()),
"userId", Optional.ofNullable(query.getUserId()),
"taskId", Optional.ofNullable(query.getTaskId()),
"name", Optional.ofNullable(query.getName()),
"dateFrom", Optional.ofNullable(query.getDateFrom()),
"dateTo", Optional.ofNullable(query.getDateTo()),
"limit", Optional.ofNullable(query.getLimit()),
"offset", Optional.ofNullable(query.getOffset())
);
ReportArchiveList responseObject = this.httpClient.get(url, new HttpRequestConfig(queryParams), ReportArchiveList.class);
return ReportArchiveList.to(responseObject);
}

/**
* @param userId user identifier
* @param archiveId archive identifier
Expand Down Expand Up @@ -433,11 +456,12 @@ public ResponseObject<GroupReportStatus> exportReportArchive(Long userId, Long a
}

/**
* @param userId user identifier (Crowdin only, {@code null} for Crowdin Enterprise)
* @param archiveId archive identifier
* @param exportId export identifier
* @return export report status
* @see <ul>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.get" target="_blank"><b> API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.get" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.get" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
Expand All @@ -453,12 +477,12 @@ public ResponseObject<GroupReportStatus> checkReportArchiveExportStatus(Long use
* @param exportId export identifier
* @return report archive download link
* @see <ul>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.download.get" target="_blank"><b> API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/api/v2/#operation/api.users.reports.archives.exports.download.get" target="_blank"><b>API Documentation</b></a></li>
* <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.reports.archives.exports.download.get" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseObject<DownloadLink> downloadReportArchive(Long userId, Long archiveId, String exportId) throws HttpException, HttpBadRequestException {
String url = getReportArchivesPath(userId, "reports/archives" + archiveId + "/exports/" + exportId + "/download");
String url = getReportArchivesPath(userId, "reports/archives/" + archiveId + "/exports/" + exportId + "/download");
DownloadLinkResponseObject responseObject = this.httpClient.get(url, new HttpRequestConfig(), DownloadLinkResponseObject.class);
return ResponseObject.of(responseObject.getData());
}
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/com/crowdin/client/reports/model/BaseRatesForm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,8 @@
public class BaseRatesForm {
private Float fullTranslation;
private Float proofread;
/**
* Hourly rate (used by hourly report settings templates and time-spent reports)
*/
private Float hourly;
}
6 changes: 6 additions & 0 deletions ...java/com/crowdin/client/reports/model/CostEstimationPostEditingGenerateReportRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ public static class Schema {
private NetRateSchemes netRateSchemes;
private Boolean calculateInternalMatches;
private Boolean includePreTranslatedStrings;
private Boolean skipArchiving;
}

@Data
Expand All @@ -41,6 +42,11 @@ public static class GeneralSchema extends Schema {
@Data
@EqualsAndHashCode(callSuper = true)
public static class ByTaskSchema extends Schema {
/**
* @deprecated deprecated in the API, use {@link #taskIds} instead
*/
@Deprecated
private Long taskId;
private List<Long> taskIds;
}
}
2 changes: 1 addition & 1 deletion src/main/java/com/crowdin/client/reports/model/Currency.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

public enum Currency implements EnumConverter<Currency> {

USD, EUR, JPY, GBP, AUD, CAD, CHF, CNY, SEK, NZD, MXN, SGD, HKD, NOK, KRW, TRY, RUB, INR, BRL, ZAR, GEL, UAH;
USD, EUR, JPY, GBP, AUD, CAD, CHF, CNY, SEK, NZD, MXN, SGD, HKD, NOK, KRW, TRY, RUB, INR, BRL, ZAR, GEL, UAH, DDK, PLN;

public static Currency from(String value) {
return Currency.valueOf(value);
Expand Down
Loading
Loading