Adding of features to be GDPR compliant (#257)

* added gdpr delete of users and tickets

* added gdpr delete of user

* added smoke tests

* moved delete methods to permanently methods because both need to be called

* fixed getTicketsById test

* set to 0.6.3-SNAPSHOT

* added method again, was removed by copy/paste error

* added single imports

* added single imports

* removed double deletion from user and tickets

* readded single imports

* added Show Compliance Deletion Statuses

Author: danielzimmermann

README.md

@@ -105,6 +105,7 @@ History
 
 * 0.5.x - ...
 
-* 0.6.x - Requires Java 8, Upgrade async-http-client to 2.2.0, Jackson to 2.9.3 (+ others updates), Add createTicketAsync method, Add method to inline an article attachment, Add created article,section,category translation, Add suspend user, Add ticket form creation functionality, From now custom field value is an array with multiple value due to Multi-select fields, Changed type of article attachment ID and article ID from int to Long, Include response body in stacktrace message.
+* 0.6.x - Requires Java 8, Upgrade async-http-client to 2.2.0, Jackson to 2.9.3 (+ others updates), Add createTicketAsync method, Add method to inline an article attachment, Add created article,section,category translation, Add suspend user, Add ticket form creation functionality, From now custom field value is an array with multiple value due to Multi-select fields, Changed type of article attachment ID and article ID from int to Long, Include response body in stacktrace message,
+Added permanently GDPR delete of Tickets and User
 
   [zd]: http://zendesk.com

src/main/java/org/zendesk/client/v2/Zendesk.java

@@ -27,6 +27,7 @@
 import org.zendesk.client.v2.model.Automation;
 import org.zendesk.client.v2.model.Brand;
 import org.zendesk.client.v2.model.Comment;
+import org.zendesk.client.v2.model.ComplianceDeletionStatus;
 import org.zendesk.client.v2.model.Field;
 import org.zendesk.client.v2.model.Forum;
 import org.zendesk.client.v2.model.Group;
@@ -267,6 +268,11 @@ public List<User> getTicketCollaborators(long id) {
                 handleList(User.class, "users")));
     }
 
+    public JobStatus permanentlyDeleteTicket(Ticket ticket) {
+        checkHasId(ticket);
+        return permanentlyDeleteTicket(ticket.getId());
+    }
+
     public void deleteTicket(Ticket ticket) {
         checkHasId(ticket);
         deleteTicket(ticket.getId());
@@ -276,6 +282,14 @@ public void deleteTicket(long id) {
         complete(submit(req("DELETE", tmpl("/tickets/{id}.json").set("id", id)), handleStatus()));
     }
 
+    public JobStatus permanentlyDeleteTicket(long id) {
+        deleteTicket(id);
+        return complete(submit(
+                req("DELETE", tmpl("/deleted_tickets/{id}.json").set("id", id)),
+                handleJobStatus(JobStatus.class))
+        );
+    }
+
     public ListenableFuture<JobStatus<Ticket>> queueCreateTicketAsync(Ticket ticket) {
         return submit(req("POST", cnst("/tickets.json?async=true"),
                 JSON, json(Collections.singletonMap("ticket", ticket))),
@@ -326,6 +340,16 @@ public void deleteTickets(long id, long... ids) {
                 handleStatus()));
     }
 
+    public JobStatus permanentlyDeleteTickets(long id, long... ids) {
+        deleteTickets(id, ids);
+
+        return complete(
+                submit(
+                        req("DELETE", tmpl("/deleted_tickets/destroy_many.json{?ids}").set("ids", idArray(id, ids))),
+                        handleJobStatus(JobStatus.class))
+        );
+    }
+
     public Iterable<Ticket> getTickets() {
         return new PagedIterable<>(cnst("/tickets.json"), handleList(Ticket.class, "tickets"));
     }
@@ -412,6 +436,11 @@ public Iterable<Ticket> getUserRequestedTickets(long userId) {
                 handleList(Ticket.class, "tickets"));
     }
 
+    public Iterable<ComplianceDeletionStatus> getComplianceDeletionStatuses(long userId) {
+        return new PagedIterable<>(tmpl("/users/{userId}/compliance_deletion_statuses.json").set("userId", userId),
+                handleList(ComplianceDeletionStatus.class, "compliance_deletion_statuses"));
+    }
+
     public Iterable<Ticket> getUserCCDTickets(long userId) {
         return new PagedIterable<>(tmpl("/users/{userId}/tickets/ccd.json").set("userId", userId),
                 handleList(Ticket.class, "tickets"));
@@ -773,6 +802,16 @@ public void deleteUser(long id) {
         complete(submit(req("DELETE", tmpl("/users/{id}.json").set("id", id)), handleStatus()));
     }
 
+    public User permanentlyDeleteUser(User user) {
+        checkHasId(user);
+        return permanentlyDeleteUser(user.getId());
+    }
+
+    public User permanentlyDeleteUser(long id) {
+        deleteUser(id);
+        return complete(submit(req("DELETE", tmpl("/deleted_users/{id}.json").set("id", id)), handle(User.class)));
+    }
+
     public User suspendUser(long id) {
         User user = new User();
         user.setId(id);

src/main/java/org/zendesk/client/v2/model/ComplianceDeletionStatus.java

@@ -0,0 +1,100 @@
+package org.zendesk.client.v2.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Date;
+
+/**
+ * https://developer.zendesk.com/rest_api/docs/core/users#show-compliance-deletion-statuses
+ */
+public class ComplianceDeletionStatus implements Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    private String action;
+    private String application;
+    @JsonProperty("account_subdomain")
+    private String accountSubdomain;
+    @JsonProperty("executer_id")
+    private long executerId;
+    @JsonProperty("user_id")
+    private long userId;
+    @JsonProperty("account_id")
+    private long accountId;
+    @JsonProperty("created_at")
+    private Date createdAt;
+
+    public static long getSerialVersionUID() {
+        return serialVersionUID;
+    }
+
+    public String getAction() {
+        return action;
+    }
+
+    public void setAction(String action) {
+        this.action = action;
+    }
+
+    public String getApplication() {
+        return application;
+    }
+
+    public void setApplication(String application) {
+        this.application = application;
+    }
+
+    public String getAccountSubdomain() {
+        return accountSubdomain;
+    }
+
+    public void setAccountSubdomain(String accountSubdomain) {
+        this.accountSubdomain = accountSubdomain;
+    }
+
+    public long getExecuterId() {
+        return executerId;
+    }
+
+    public void setExecuterId(long executerId) {
+        this.executerId = executerId;
+    }
+
+    public long getUserId() {
+        return userId;
+    }
+
+    public void setUserId(long userId) {
+        this.userId = userId;
+    }
+
+    public long getAccountId() {
+        return accountId;
+    }
+
+    public void setAccountId(long accountId) {
+        this.accountId = accountId;
+    }
+
+    public Date getCreatedAt() {
+        return new Date(createdAt.getTime());
+    }
+
+    public void setCreatedAt(Date createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    @Override
+    public String toString() {
+        return "ComplianceDeletionStatus{" +
+                "action='" + action + '\'' +
+                ", application='" + application + '\'' +
+                ", accountSubdomain='" + accountSubdomain + '\'' +
+                ", executerId=" + executerId +
+                ", userId=" + userId +
+                ", accountId=" + accountId +
+                ", createdAt=" + createdAt +
+                '}';
+    }
+}