Merge branch 'master' into feature-user-related-info

Author: aheritier

README.md

@@ -106,6 +106,9 @@ 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
+
+* 0.7.x - The Help Center Section creation was fixed, Macro DTO was updated (Id is long), Permanent deletion of a handful of Items was added ( GDPR compliancy )
 
   [zd]: http://zendesk.com

migration2Codeship.md

@@ -0,0 +1,44 @@
+## Migration to Codeship
+
+It is a temporal file to track the migration steps of moving this project from Jenkins D@C to Codeship Basic project
+
+**Notes**:
+
+* Codeship currently does’t trigger builds for PRs from forked repositories. We have created a RFE for that [PROD-1600](https://cloudbees.atlassian.net/browse/PROD-1600)
+* Sonar configuration needs to be move from the `Manage Jenkins > Configure system` to `Codeship Basic > Enviroment Section`
+* Maven options has been moved to Setup Commands `export MAVEN_OPTS="-Xmx512m -Djava.awt.headless=true"`
+* Sonar configuration is passed by parameters: https://docs.sonarqube.org/display/SONAR/Analysis+Parameters
+* Replacing Jenkins `env.BRANCH_NAME` for Codeship `CI_BRANCH`
+* Pushing a first commit to your repository to trigger your first build in Codeship
+* All groovy needs to be converted into shell format
+* Shell format multiline is not supported
+* To check line 13 `_ bash: [: too many arguments`
+* BUILD SUCCESS but with mvn `verify` goal default
+
+### Setup Commands
+
+```
+# We currently support OpenJDK 7, as well as Oracle JDK 7 & 8.
+jdk_switcher use oraclejdk8
+# Maven
+export MAVEN_OPTS="-Xmx512m -Djava.awt.headless=true"
+```
+
+### Pipeline
+
+```
+export pom_version=$(xmllint --xpath '/*[local-name()="project"]/*[local-name()="version"]/text()' pom.xml)
+export isSnapshot=false
+export deployOrVerity='verify'
+if [ "$pom_version" =~ "-SNAPSHOT" ]; then isSnapshot=true; fi
+if [ [ "$CI_BRANCH" = "master" ] && [ isSnapshot ] ]; then deployOrVerity='deploy -DdeployAtEnd=true'; fi
+## DEBUG
+echo "Running: mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent ${deployOrVerity} sonar:sonar -Dsonar.organization=cloudbees -Dsonar.branch.name=${CI_BRANCH} -Dsonar.host.url=${SONAR_URL} -Dsonar.login=${SONAR_TOKEN} -Dmaven.test.failure.ignore=true"
+## END DEBUG
+mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent ${deployOrVerity} sonar:sonar -Dsonar.organization=cloudbees -Dsonar.branch.name=${CI_BRANCH} -Dsonar.host.url=${SONAR_URL} -Dsonar.login=${SONAR_TOKEN} -Dmaven.test.failure.ignore=true
+```
+
+### Enviroment Variables: 
+
+* `SONAR_URL`
+* `SONAR_TOKEN`

pom.xml

@@ -25,7 +25,7 @@
 
   <groupId>com.cloudbees.thirdparty</groupId>
   <artifactId>zendesk-java-client</artifactId>
-  <version>0.6.3-SNAPSHOT</version>
+  <version>0.7.1-SNAPSHOT</version>
 
   <name>zendesk-java-client</name>
   <description>Java client for the Zendesk API</description>

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;
@@ -268,6 +269,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());
@@ -277,6 +283,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))),
@@ -327,6 +341,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"));
     }
@@ -413,6 +437,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"));
@@ -779,6 +808,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 +
+                '}';
+    }
+}

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

@@ -17,7 +17,7 @@ public class Macro implements Serializable {
 
     private static final long serialVersionUID = 1L;
 
-    private int id;
+    private long id;
     private String title;
     private boolean active;
     private List<Action> actions;
@@ -26,11 +26,11 @@ public class Macro implements Serializable {
 
     public Macro() {}
 
-    public int getId() {
+    public long getId() {
         return id;
     }
 
-    public void setId(int id) {
+    public void setId(long id) {
         this.id = id;
     }