From 11889b81ec400bcb1bd5010437710826ee54db6c Mon Sep 17 00:00:00 2001 From: Bernhard Schandl Date: Mon, 8 Nov 2021 22:18:54 +0100 Subject: [PATCH 1/3] Add type attribute to Comment model --- .../java/org/zendesk/client/v2/model/Comment.java | 11 +++++++++++ .../org/zendesk/client/v2/model/CommentType.java | 13 +++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 src/main/java/org/zendesk/client/v2/model/CommentType.java diff --git a/src/main/java/org/zendesk/client/v2/model/Comment.java b/src/main/java/org/zendesk/client/v2/model/Comment.java index 4ec6c2b46..64dbf27f4 100644 --- a/src/main/java/org/zendesk/client/v2/model/Comment.java +++ b/src/main/java/org/zendesk/client/v2/model/Comment.java @@ -23,6 +23,8 @@ public class Comment implements Serializable { private List attachments; private Date createdAt; private Boolean publicComment; + private CommentType type; + public Comment() { } @@ -104,6 +106,15 @@ public void setPublic(Boolean isPublic) { this.publicComment = isPublic; } + @JsonProperty("type") + public CommentType getType() { + return type; + } + + public void setType(CommentType type) { + this.type = type; + } + @Override public String toString() { return "Comment{" + "id=" + id + diff --git a/src/main/java/org/zendesk/client/v2/model/CommentType.java b/src/main/java/org/zendesk/client/v2/model/CommentType.java new file mode 100644 index 000000000..7dcca09ac --- /dev/null +++ b/src/main/java/org/zendesk/client/v2/model/CommentType.java @@ -0,0 +1,13 @@ +package org.zendesk.client.v2.model; + +import com.fasterxml.jackson.annotation.JsonProperty; + +/** + * https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/ + */ +public enum CommentType { + + @JsonProperty("Comment") COMMENT, + @JsonProperty("VoiceComment") VOICE_COMMENT; + +} From e8243dbb6285c65d937c71dd9aeee1152bef4cd0 Mon Sep 17 00:00:00 2001 From: Arnaud HERITIER Date: Fri, 12 Nov 2021 16:06:09 +0100 Subject: [PATCH 2/3] [fix] A @JsonProperty cannot be used for enums I applied the same pattern than others enum --- .../org/zendesk/client/v2/model/CommentType.java | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/zendesk/client/v2/model/CommentType.java b/src/main/java/org/zendesk/client/v2/model/CommentType.java index 7dcca09ac..c5d550d23 100644 --- a/src/main/java/org/zendesk/client/v2/model/CommentType.java +++ b/src/main/java/org/zendesk/client/v2/model/CommentType.java @@ -1,13 +1,21 @@ package org.zendesk.client.v2.model; -import com.fasterxml.jackson.annotation.JsonProperty; - /** * https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/ */ public enum CommentType { - @JsonProperty("Comment") COMMENT, - @JsonProperty("VoiceComment") VOICE_COMMENT; + COMMENT("Comment"), + VOICE_COMMENT("VoiceComment"); + + private final String name; + + CommentType(String name) { + this.name = name; + } + @Override + public String toString() { + return name; + } } From 7b190bb071f260a0e41d45a9f64f539232e0c34d Mon Sep 17 00:00:00 2001 From: Arnaud HERITIER Date: Fri, 12 Nov 2021 16:10:12 +0100 Subject: [PATCH 3/3] [chore] Update existing integration tests to validate the comment type We can write/read the field --- .../java/org/zendesk/client/v2/RealSmokeTest.java | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/test/java/org/zendesk/client/v2/RealSmokeTest.java b/src/test/java/org/zendesk/client/v2/RealSmokeTest.java index bed19b03a..6c43a8eaf 100644 --- a/src/test/java/org/zendesk/client/v2/RealSmokeTest.java +++ b/src/test/java/org/zendesk/client/v2/RealSmokeTest.java @@ -17,6 +17,7 @@ import org.zendesk.client.v2.model.Brand; import org.zendesk.client.v2.model.Collaborator; import org.zendesk.client.v2.model.Comment; +import org.zendesk.client.v2.model.CommentType; import org.zendesk.client.v2.model.ComplianceDeletionStatus; import org.zendesk.client.v2.model.DeletedTicket; import org.zendesk.client.v2.model.Field; @@ -1646,14 +1647,18 @@ public void getTicketCommentsShouldBeAscending() throws Exception { Ticket ticket = null; try { ticket = instance.createTicket(t); - instance.createComment(ticket.getId(), new Comment(TICKET_COMMENT2)); + final Comment comment = new Comment(TICKET_COMMENT2); + comment.setType(CommentType.COMMENT); + instance.createComment(ticket.getId(), comment); Iterable ticketCommentsIt = instance.getTicketComments(ticket.getId()); List comments = new ArrayList<>(); ticketCommentsIt.forEach(comments::add); assertThat(comments.size(), is(2)); assertThat(comments.get(0).getBody(), containsString(TICKET_COMMENT1)); + assertThat(comments.get(0).getType(), is(CommentType.COMMENT)); assertThat(comments.get(1).getBody(), containsString(TICKET_COMMENT2)); + assertThat(comments.get(1).getType(), is(CommentType.COMMENT)); } finally { if (ticket != null) { instance.deleteTicket(ticket.getId()); @@ -1669,14 +1674,18 @@ public void getTicketCommentsDescending() throws Exception { Ticket ticket = null; try { ticket = instance.createTicket(t); - instance.createComment(ticket.getId(), new Comment(TICKET_COMMENT2)); + final Comment comment = new Comment(TICKET_COMMENT2); + comment.setType(CommentType.COMMENT); + instance.createComment(ticket.getId(), comment); Iterable ticketCommentsIt = instance.getTicketComments(ticket.getId(), SortOrder.DESCENDING); List comments = new ArrayList<>(); ticketCommentsIt.forEach(comments::add); assertThat(comments.size(), is(2)); assertThat(comments.get(0).getBody(), containsString(TICKET_COMMENT2)); + assertThat(comments.get(0).getType(), is(CommentType.COMMENT)); assertThat(comments.get(1).getBody(), containsString(TICKET_COMMENT1)); + assertThat(comments.get(1).getType(), is(CommentType.COMMENT)); } finally { if (ticket != null) { instance.deleteTicket(ticket.getId());