feat: Add fields api support (#245)

Author: DecarteAdam

src/main/java/com/crowdin/client/Client.java

@@ -9,6 +9,7 @@
 import com.crowdin.client.core.model.Credentials;
 import com.crowdin.client.dictionaries.DictionariesApi;
 import com.crowdin.client.distributions.DistributionsApi;
+import com.crowdin.client.fields.FieldsApi;
 import com.crowdin.client.glossaries.GlossariesApi;
 import com.crowdin.client.issues.IssuesApi;
 import com.crowdin.client.labels.LabelsApi;
@@ -61,6 +62,7 @@ public class Client extends CrowdinApi {
     private final OrganizationWebhooksApi organizationWebhooksApi;
     private final TeamsApi teamsApi;
     private final DistributionsApi distributionsApi;
+    private final FieldsApi fieldsApi;
     private final DictionariesApi dictionariesApi;
     private final LabelsApi labelsApi;
     private final StringCommentsApi stringCommentsApi;
@@ -95,6 +97,7 @@ public Client(Credentials credentials) {
         this.organizationWebhooksApi = new OrganizationWebhooksApi(credentials);
         this.teamsApi = new TeamsApi(credentials);
         this.distributionsApi = new DistributionsApi(credentials);
+        this.fieldsApi = new FieldsApi(credentials);
         this.dictionariesApi = new DictionariesApi(credentials);
         this.labelsApi = new LabelsApi(credentials);
         this.stringCommentsApi = new StringCommentsApi(credentials);
@@ -130,6 +133,7 @@ public Client(Credentials credentials, ClientConfig clientConfig) {
         this.organizationWebhooksApi = new OrganizationWebhooksApi(credentials, clientConfig);
         this.teamsApi = new TeamsApi(credentials, clientConfig);
         this.distributionsApi = new DistributionsApi(credentials, clientConfig);
+        this.fieldsApi = new FieldsApi(credentials, clientConfig);
         this.dictionariesApi = new DictionariesApi(credentials, clientConfig);
         this.labelsApi = new LabelsApi(credentials, clientConfig);
         this.stringCommentsApi = new StringCommentsApi(credentials, clientConfig);

src/main/java/com/crowdin/client/fields/FieldsApi.java

@@ -0,0 +1,98 @@
+package com.crowdin.client.fields;
+
+import com.crowdin.client.core.CrowdinApi;
+import com.crowdin.client.core.http.HttpRequestConfig;
+import com.crowdin.client.core.http.exceptions.HttpBadRequestException;
+import com.crowdin.client.core.http.exceptions.HttpException;
+import com.crowdin.client.core.model.ClientConfig;
+import com.crowdin.client.core.model.Credentials;
+import com.crowdin.client.core.model.PatchRequest;
+import com.crowdin.client.core.model.ResponseList;
+import com.crowdin.client.core.model.ResponseObject;
+import com.crowdin.client.fields.model.Field;
+import com.crowdin.client.fields.model.FieldRequest;
+import com.crowdin.client.fields.model.FieldResponseObject;
+import com.crowdin.client.fields.model.FieldResponseObjectList;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+public class FieldsApi extends CrowdinApi {
+
+    public FieldsApi(Credentials credentials) {
+        super(credentials);
+    }
+
+    public FieldsApi(Credentials credentials, ClientConfig clientConfig) {
+        super(credentials, clientConfig);
+    }
+
+    /**
+     * @param entity Filter fields by entity {@link com.crowdin.client.fields.model.enums.EntityType}
+     * @param search Search fields by slug or name
+     * @param limit  maximum number of items to retrieve (default 25)
+     * @param offset starting offset in the collection (default 0)
+     * @return list of distributions
+     * @see <ul>
+     * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.getMany" target="_blank"><b>API Documentation</b></a></li>
+     * </ul>
+     */
+    public ResponseList<Field> listFields(String entity, String search, Integer limit, Integer offset) throws HttpException, HttpBadRequestException {
+        Map<String, Optional<Object>> queryParams = HttpRequestConfig.buildUrlParams(
+                "entity", Optional.ofNullable(entity),
+                "search", Optional.ofNullable(search),
+                "limit", Optional.ofNullable(limit),
+                "offset", Optional.ofNullable(offset)
+        );
+        FieldResponseObjectList responseObject = this.httpClient.get(this.url + "/fields", new HttpRequestConfig(queryParams), FieldResponseObjectList.class);
+        return FieldResponseObjectList.to(responseObject);
+    }
+
+    /**
+     * @param request object {@link com.crowdin.client.fields.model.FieldRequest}
+     * @return Field object
+     * @see <ul>
+     * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.post" target="_blank"><b>API Documentation</b></a></li>
+     * </ul>
+     */
+    public ResponseObject<Field> addField(FieldRequest request) throws HttpException, HttpBadRequestException {
+        FieldResponseObject reportStatusResponseObject = this.httpClient.post(this.url + "/fields", request, new HttpRequestConfig(), FieldResponseObject.class);
+        return ResponseObject.of(reportStatusResponseObject.getData());
+    }
+
+    /**
+     * @param fieldId field identifier
+     * @return field object according to id
+     * @see <ul>
+     * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.get" target="_blank"><b>API Documentation</b></a></li>
+     * </ul>
+     */
+    public ResponseList<Field> getField(Long fieldId) throws HttpException, HttpBadRequestException {
+        FieldResponseObjectList responseObject = this.httpClient.get(this.url + "/fields/" + fieldId, new HttpRequestConfig(), FieldResponseObjectList.class);
+        return FieldResponseObjectList.to(responseObject);
+    }
+
+    /**
+     * @param fieldId field identifier
+     * @see <ul>
+     * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.delete" target="_blank"><b>API Documentation</b></a></li>
+     * </ul>
+     */
+    public void deleteField(Long fieldId) throws HttpException, HttpBadRequestException {
+        this.httpClient.delete(this.url + "/fields/" + fieldId, new HttpRequestConfig(), Void.class);
+    }
+
+    /**
+     * @param fieldId field identifier
+     * @param request object
+     * @return field object
+     * @see <ul>
+     * <li><a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.fields.patch" target="_blank"><b>API Documentation</b></a></li>
+     * </ul>
+     */
+    public ResponseObject<Field> editField(Long fieldId, List<PatchRequest> request) throws HttpException, HttpBadRequestException {
+        FieldResponseObject responseObject = this.httpClient.patch(this.url + "/fields/" + fieldId, request, new HttpRequestConfig(), FieldResponseObject.class);
+        return ResponseObject.of(responseObject.getData());
+    }
+}

src/main/java/com/crowdin/client/fields/model/Config.java

@@ -0,0 +1,22 @@
+package com.crowdin.client.fields.model;
+
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class Config {
+    private List<Option> options;
+    private List<Location> locations;
+
+    @Data
+    public static class Option {
+        private String label;
+        private String value;
+    }
+
+    @Data
+    public static class Location {
+        private String place;
+    }
+}

src/main/java/com/crowdin/client/fields/model/Field.java

@@ -0,0 +1,23 @@
+package com.crowdin.client.fields.model;
+
+import com.crowdin.client.fields.model.enums.EntityType;
+import com.crowdin.client.fields.model.enums.FieldType;
+import lombok.Data;
+
+import java.util.Date;
+import java.util.List;
+
+@Data
+public class Field  {
+
+    private Long id;
+    private String name;
+    private String slug;
+    private String description;
+    private FieldType type;
+    private Config config;
+    private List<EntityType> entities;
+    private Date createdAt;
+    private Date updatedAt;
+
+}

src/main/java/com/crowdin/client/fields/model/FieldRequest.java

@@ -0,0 +1,16 @@
+package com.crowdin.client.fields.model;
+
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class FieldRequest {
+    private String name;
+    private String slug;
+    private String type;
+    private String description;
+    private List<String> entities;
+    private Config config;
+
+}

src/main/java/com/crowdin/client/fields/model/FieldResponseObject.java

@@ -0,0 +1,8 @@
+package com.crowdin.client.fields.model;
+
+import lombok.Data;
+
+@Data
+public class FieldResponseObject {
+    private Field data;
+}

src/main/java/com/crowdin/client/fields/model/FieldResponseObjectList.java

@@ -0,0 +1,25 @@
+package com.crowdin.client.fields.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 FieldResponseObjectList {
+    private List<FieldResponseObject> data;
+    private Pagination pagination;
+
+    public static ResponseList<Field> to(FieldResponseObjectList reportSettingsTemplateList) {
+        return ResponseList.of(
+                reportSettingsTemplateList.getData().stream()
+                        .map(FieldResponseObject::getData)
+                        .map(ResponseObject::of)
+                        .collect(Collectors.toList()),
+                reportSettingsTemplateList.getPagination()
+        );
+    }
+}

src/main/java/com/crowdin/client/fields/model/FiledPagination.java

@@ -0,0 +1,9 @@
+package com.crowdin.client.fields.model;
+
+import com.crowdin.client.core.model.Pagination;
+import lombok.Data;
+
+@Data
+public class FiledPagination extends Pagination {
+    private int total;
+}

src/main/java/com/crowdin/client/fields/model/enums/EntityType.java

@@ -0,0 +1,22 @@
+package com.crowdin.client.fields.model.enums;
+
+import com.crowdin.client.core.model.EnumConverter;
+
+public enum EntityType implements EnumConverter<EntityType> {
+
+    PROJECT,
+    USER,
+    TASK,
+    FILE,
+    TRANSLATION,
+    STRING;
+
+    public static EntityType from(String value) {
+        return EntityType.valueOf(value.toUpperCase());
+    };
+
+    @Override
+    public Object to(EntityType v) {
+        return v.name().toLowerCase();
+    }
+}

src/main/java/com/crowdin/client/fields/model/enums/FieldType.java

@@ -0,0 +1,27 @@
+package com.crowdin.client.fields.model.enums;
+
+import com.crowdin.client.core.model.EnumConverter;
+
+public enum FieldType implements EnumConverter<FieldType> {
+
+    CHECKBOX,
+    RADIOBUTTONS,
+    DATE,
+    DATETIME,
+    NUMBER,
+    LABELS,
+    SELECT,
+    MULTISELECT,
+    TEXT,
+    TEXTAREA,
+    URL;
+
+    public static FieldType from(String value) {
+        return FieldType.valueOf(value.toUpperCase());
+    }
+
+    @Override
+    public Object to(FieldType v) {
+        return v.name().toLowerCase();
+    }
+}