Merge pull request #309 from crowdin/reports-api-updates

feat: reports api updates
crowdin · Jan 25, 2025 · aa2ac4a · aa2ac4a
2 parents 7565f3c + 49424a2
commit aa2ac4a
Show file tree

Hide file tree

Showing 25 changed files with 468 additions and 161 deletions.
diff --git a/src/main/java/com/crowdin/client/core/http/impl/json/DateDeserializer.java b/src/main/java/com/crowdin/client/core/http/impl/json/DateDeserializer.java
@@ -19,6 +19,11 @@ public Date deserialize(JsonParser p, DeserializationContext ctxt) throws IOExce
             return null;
         }
 
+        return deserializeDate(date);
+    }
+
+    @SneakyThrows
+    public static Date deserializeDate(String date) {
         try {
             SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
             return format.parse(date);

diff --git a/src/main/java/com/crowdin/client/core/http/impl/json/JacksonJsonTransformer.java b/src/main/java/com/crowdin/client/core/http/impl/json/JacksonJsonTransformer.java
@@ -72,4 +72,7 @@ public <T> String convert(T obj) {
         return this.objectMapper.writeValueAsString(obj);
     }
 
+    public ObjectMapper getObjectMapper() {
+        return this.objectMapper;
+    }
 }
diff --git a/src/main/java/com/crowdin/client/reports/ReportsApi.java b/src/main/java/com/crowdin/client/reports/ReportsApi.java
@@ -101,6 +101,70 @@ public ResponseObject<DownloadLink> downloadOrganizationReport(String reportId)
         return ResponseObject.of(responseObject.getData());
     }
 
+    /**
+     * @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>
+     * </ul>
+     */
+    public ResponseList<ReportSettingsTemplate.OrganizationReportSettingsTemplate> listOrganizationReportSettingsTemplates(ListOrganizationReportSettingsParams params) throws HttpException, HttpBadRequestException {
+        Map<String, Optional<Object>> queryParams = HttpRequestConfig.buildUrlParams(
+                "projectId", Optional.ofNullable(params.getProjectId()),
+                "groupId", Optional.ofNullable(params.getGroupId()),
+                "limit", Optional.ofNullable(params.getLimit()),
+                "offset", Optional.ofNullable(params.getOffset())
+        );
+        OrganizationReportSettingsTemplateList reportSettingsTemplateList = this.httpClient.get(this.url + "/reports/settings-templates", new HttpRequestConfig(queryParams), OrganizationReportSettingsTemplateList.class);
+        return OrganizationReportSettingsTemplateList.to(reportSettingsTemplateList);
+    }
+
+    /**
+     * @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>
+     * </ul>
+     */
+    public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> addOrganizationReportSettingsTemplate(ReportSettingsTemplate.OrganizationReportSettingsTemplate request) throws HttpException, HttpBadRequestException {
+        OrganizationReportSettingsTemplateResponseObject responseObject = this.httpClient.post(this.url + "/reports/settings-templates", request, new HttpRequestConfig(), OrganizationReportSettingsTemplateResponseObject.class);
+        return ResponseObject.of(responseObject.getData());
+    }
+
+    /**
+     * @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>
+     * </ul>
+     */
+    public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> getOrganizationReportSettingsTemplate(Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
+        OrganizationReportSettingsTemplateResponseObject responseObject = this.httpClient.get(this.url + "/reports/settings-templates/" + reportSettingsTemplateId, new HttpRequestConfig(), OrganizationReportSettingsTemplateResponseObject.class);
+        return ResponseObject.of(responseObject.getData());
+    }
+
+    /**
+     * @param reportSettingsTemplateId report settings template identifier
+     * @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>
+     * </ul>
+     */
+    public ResponseObject<ReportSettingsTemplate.OrganizationReportSettingsTemplate> editOrganizationReportSettingsTemplate(Long reportSettingsTemplateId, List<PatchRequest> request) throws HttpException, HttpBadRequestException {
+        OrganizationReportSettingsTemplateResponseObject responseObject = this.httpClient.patch(this.url + "/reports/settings-templates/" + reportSettingsTemplateId, request, new HttpRequestConfig(), OrganizationReportSettingsTemplateResponseObject.class);
+        return ResponseObject.of(responseObject.getData());
+    }
+
+    /**
+     * @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>
+     * </ul>
+     */
+    public void deleteOrganizationReportSettingsTemplate(Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
+        this.httpClient.delete(this.url + "/reports/settings-templates/" + reportSettingsTemplateId, new HttpRequestConfig(), Void.class);
+    }
+
     /**
      * @param projectId project identifier
      * @param request   request object
@@ -214,7 +278,7 @@ public ResponseObject<ReportSettingsTemplate> editReportSettingsTemplate(Long pr
      * </ul>
      */
     public void deleteReportSettingsTemplate(Long projectId, Long reportSettingsTemplateId) throws HttpException, HttpBadRequestException {
-        this.httpClient.delete(this.url + "/projects/" + projectId + "/settings-templates/" + reportSettingsTemplateId, new HttpRequestConfig(), Void.class);
+        this.httpClient.delete(this.url + "/projects/" + projectId + "/reports/settings-templates/" + reportSettingsTemplateId, new HttpRequestConfig(), Void.class);
     }
 
     // -- USER REPORTS -- //

diff --git a/src/main/java/com/crowdin/client/reports/model/ContributionRawDataGenerateReportRequest.java b/src/main/java/com/crowdin/client/reports/model/ContributionRawDataGenerateReportRequest.java
@@ -0,0 +1,42 @@
+package com.crowdin.client.reports.model;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+import java.util.Date;
+import java.util.List;
+
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class ContributionRawDataGenerateReportRequest extends GenerateReportRequest {
+    private String name = "contribution-raw-data";
+    private Schema schema;
+
+    @Data
+    public static class Schema {
+        private String mode;
+        private Unit unit;
+        private List<String> columns;
+        private List<Long> tmIds;
+        private List<Long> mtIds;
+        private List<Long> aiPromptIds;
+        private Date dateFrom;
+        private Date dateTo;
+    }
+
+    @Data
+    @EqualsAndHashCode(callSuper = true)
+    public static class GeneralSchema extends Schema {
+        private String languageId;
+        private Long userId;
+        private List<Long> fileIds;
+        private List<Long> directoryIds;
+        private List<Long> branchIds;
+    }
+
+    @Data
+    @EqualsAndHashCode(callSuper = true)
+    public static class ByTaskSchema extends Schema {
+        private Long taskId;
+    }
+}
diff --git a/...java/com/crowdin/client/reports/model/CostEstimationPostEditingGenerateReportRequest.java b/...java/com/crowdin/client/reports/model/CostEstimationPostEditingGenerateReportRequest.java
@@ -17,16 +17,16 @@ public static class Schema {
         private Unit unit;
         private Currency currency;
         private ReportsFormat format;
+        private BaseRatesForm baseRates;
+        private List<IndividualRate> individualRates;
+        private NetRateSchemes netRateSchemes;
         private Boolean calculateInternalMatches;
         private Boolean includePreTranslatedStrings;
     }
 
     @Data
     @EqualsAndHashCode(callSuper = true)
     public static class GeneralSchema extends Schema {
-        private BaseRatesForm baseRates;
-        private List<IndividualRate> individualRates;
-        private NetRateSchemes netRateSchemes;
         private String languageId;
         private List<Long> fileIds;
         private List<Long> directoryIds;
@@ -35,27 +35,12 @@ public static class GeneralSchema extends Schema {
         private Date dateTo;
         private List<Long> labelIds;
         private LabelIncludeType labelIncludeType;
+        private Long workflowStepId;
     }
 
     @Data
     @EqualsAndHashCode(callSuper = true)
     public static class ByTaskSchema extends Schema {
-        private BaseRatesForm baseRates;
-        private List<IndividualRate> individualRates;
-        private NetRateSchemes netRateSchemes;
         private Long taskId;
     }
-
-    @Data
-    public static class IndividualRate {
-        private List<String> languageIds;
-        private List<Long> userIds;
-        private float fullTranslation;
-        private float proofread;
-    }
-
-    @Data
-    public static class NetRateSchemes {
-        private List<Match> tmMatch;
-    }
 }
diff --git a/src/main/java/com/crowdin/client/reports/model/GenerateGroupReportRequest.java b/src/main/java/com/crowdin/client/reports/model/GenerateGroupReportRequest.java
@@ -19,81 +19,20 @@ public static abstract class Schema {
 
     @Data
     @EqualsAndHashCode(callSuper = true)
-    public static class GroupTranslationCostsPerEditingSchema extends Schema {
+    public static class GroupTranslationCostsPostEditingSchema extends Schema {
         private List<Long> projectIds;
         private Unit unit;
         private Currency currency;
         private ReportsFormat format;
         private BaseRatesForm baseRates;
         private List<IndividualRate> individualRates;
         private NetRateSchemes netRateSchemes;
+        private Boolean excludeApprovalsForEditedTranslations;
+        private Boolean preTranslatedStringsCategorizationAdjustment;
         private GroupingParameter groupBy;
         private Date dateFrom;
         private Date dateTo;
-        private List<String> languageId;
         private List<Long> userIds;
-        private List<Long> branchIds;
-        private List<Long> labelIds;
-        private LabelIncludeType labelIncludeType;
-    }
-
-    @Data
-    @EqualsAndHashCode(callSuper = true)
-    public static class GroupTranslationCostsPerEditingByTaskSchema extends Schema {
-        private Unit unit;
-        private Currency currency;
-        private ReportsFormat format;
-        private BaseRatesForm baseRates;
-        private List<IndividualRate> individualRates;
-        private NetRateSchemes netRateSchemes;
-        private Long taskId;
-    }
-
-    @Data
-    @EqualsAndHashCode(callSuper = true)
-    public static class CostsEstimationSchema extends Schema {
-        private List<Long> projectIds;
-        private Unit unit;
-        private Currency currency;
-        private ReportsFormat format;
-        private BaseRatesForm baseRates;
-        private List<IndividualRate> individualRates;
-        private NetRateSchemes netRateSchemes;
-        private Boolean calculateInternalMatches;
-        private Boolean includePreTranslatedStrings;
-        private String languageId;
-        private List<Long> branchIds;
-        private Date dateFrom;
-        private Date dateTo;
-        private List<Long> labelIds;
-        private LabelIncludeType labelIncludeType;
-    }
-
-    @Data
-    @EqualsAndHashCode(callSuper = true)
-    public static class CostsEstimationByTaskSchema extends Schema {
-        private List<Long> projectIds;
-        private Unit unit;
-        private Currency currency;
-        private ReportsFormat format;
-        private BaseRatesForm baseRates;
-        private List<IndividualRate> individualRates;
-        private NetRateSchemes netRateSchemes;
-        private Boolean calculateInternalMatches;
-        private Boolean includePreTranslatedStrings;
-        private Long taskId;
-    }
-
-    @Data
-    @EqualsAndHashCode(callSuper = true)
-    public static class GroupTranslationCostSchema extends Schema {
-        private List<Long> projectIds;
-        private Unit unit;
-        private Currency currency;
-        private ReportsFormat format;
-        private GroupingParameter groupBy;
-        private Date dateFrom;
-        private Date dateTo;
     }
 
     @Data
@@ -107,19 +46,4 @@ public static class GroupTopMembersSchema extends Schema {
         private Date dateFrom;
         private Date dateTo;
     }
-
-    @Data
-    public static class IndividualRate {
-        private List<String> languageIds;
-        private List<Long> userIds;
-        private Float fullTranslation;
-        private Float proofread;
-    }
-
-    @Data
-    public static class NetRateSchemes {
-        private List<Match> tmMatch;
-        private List<Match> mtMatch;
-        private List<Match> suggestionMatch;
-    }
 }
diff --git a/src/main/java/com/crowdin/client/reports/model/IndividualRate.java b/src/main/java/com/crowdin/client/reports/model/IndividualRate.java
@@ -0,0 +1,13 @@
+package com.crowdin.client.reports.model;
+
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class IndividualRate {
+    private List<String> languageIds;
+    private List<Long> userIds;
+    private Float fullTranslation;
+    private Float proofread;
+}
diff --git a/src/main/java/com/crowdin/client/reports/model/ListOrganizationReportSettingsParams.java b/src/main/java/com/crowdin/client/reports/model/ListOrganizationReportSettingsParams.java
@@ -0,0 +1,13 @@
+package com.crowdin.client.reports.model;
+
+import com.crowdin.client.core.model.Pagination;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@EqualsAndHashCode(callSuper = true)
+@Data
+public class ListOrganizationReportSettingsParams extends Pagination {
+
+    private Long projectId;
+    private Long groupId;
+}
diff --git a/src/main/java/com/crowdin/client/reports/model/MatchType.java b/src/main/java/com/crowdin/client/reports/model/MatchType.java
@@ -6,7 +6,13 @@ public enum MatchType implements EnumConverter<MatchType> {
     PERFECT("perfect"),
     OPTION_100("100"),
     OPTION_99_82("99-82"),
-    OPTION_81_60("81-60");
+    OPTION_99_95("99-95"),
+    OPTION_94_90("94-90"),
+    OPTION_89_80("89-80"),
+    OPTION_81_60("81-60"),
+    TM_MATCH("tm_match"),
+    APPROVAL("approval"),
+    NO_MATCH("no_match");
 
     private String value;
 

diff --git a/src/main/java/com/crowdin/client/reports/model/NetRateSchemes.java b/src/main/java/com/crowdin/client/reports/model/NetRateSchemes.java
@@ -0,0 +1,13 @@
+package com.crowdin.client.reports.model;
+
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class NetRateSchemes {
+    private List<Match> tmMatch;
+    private List<Match> mtMatch;
+    private List<Match> suggestionMatch;
+    private List<Match> aiMatch;
+}
diff --git a/src/main/java/com/crowdin/client/reports/model/OrganizationReportSettingsTemplateList.java b/src/main/java/com/crowdin/client/reports/model/OrganizationReportSettingsTemplateList.java
@@ -0,0 +1,26 @@
+package com.crowdin.client.reports.model;
+
+import com.crowdin.client.core.model.Pagination;
+import com.crowdin.client.core.model.ResponseList;
+import com.crowdin.client.core.model.ResponseObject;
+import lombok.Data;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+@Data
+public class OrganizationReportSettingsTemplateList {
+
+    private List<OrganizationReportSettingsTemplateResponseObject> data;
+    private Pagination pagination;
+
+    public static ResponseList<ReportSettingsTemplate.OrganizationReportSettingsTemplate> to(OrganizationReportSettingsTemplateList reportSettingsTemplateList) {
+        return ResponseList.of(
+                reportSettingsTemplateList.getData().stream()
+                        .map(OrganizationReportSettingsTemplateResponseObject::getData)
+                        .map(ResponseObject::of)
+                        .collect(Collectors.toList()),
+                reportSettingsTemplateList.getPagination()
+        );
+    }
+}
diff --git a/...va/com/crowdin/client/reports/model/OrganizationReportSettingsTemplateResponseObject.java b/...va/com/crowdin/client/reports/model/OrganizationReportSettingsTemplateResponseObject.java
@@ -0,0 +1,9 @@
+package com.crowdin.client.reports.model;
+
+import lombok.Data;
+
+@Data
+public class OrganizationReportSettingsTemplateResponseObject {
+
+    private ReportSettingsTemplate.OrganizationReportSettingsTemplate data;
+}