[feat] Add support for the execute view endpoint

https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#execute-view

Author: PierreBtz

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

@@ -6,6 +6,7 @@
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.ObjectReader;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.databind.util.StdDateFormat;
 import java.io.Closeable;
@@ -103,6 +104,8 @@
 import org.zendesk.client.v2.model.targets.Target;
 import org.zendesk.client.v2.model.targets.TwitterTarget;
 import org.zendesk.client.v2.model.targets.UrlTarget;
+import org.zendesk.client.v2.model.views.ExecutedViewPage;
+import org.zendesk.client.v2.model.views.ViewRow;
 
 /**
  * @author stephenc
@@ -1033,6 +1036,17 @@ public Iterable<Ticket> getView(long id) {
         tmpl("/views/{id}/tickets.json").set("id", id), handleList(Ticket.class, "tickets"));
   }
 
+  @SuppressWarnings("unchecked")
+  public <V extends ViewRow> Optional<ExecutedViewPage<V>> executeView(long id, Class<V> clazz) {
+    var objectReader =
+        mapper.readerFor(
+            mapper.getTypeFactory().constructParametricType(ExecutedViewPage.class, clazz));
+    return Optional.of(
+        complete(
+            submit(
+                req("GET", tmpl("/views/{id}/execute.json").set("id", id)), handle(objectReader))));
+  }
+
   // Automations
   public Iterable<Automation> getAutomations() {
     return new PagedIterable<>(
@@ -3519,12 +3533,17 @@ public Void onCompleted(Response response) throws Exception {
 
   @SuppressWarnings("unchecked")
   protected <T> ZendeskAsyncCompletionHandler<T> handle(final Class<T> clazz) {
+    return handle(mapper.readerFor(clazz));
+  }
+
+  @SuppressWarnings("unchecked")
+  protected <T> ZendeskAsyncCompletionHandler<T> handle(ObjectReader reader) {
     return new ZendeskAsyncCompletionHandler<T>() {
       @Override
       public T onCompleted(Response response) throws Exception {
         logResponse(response);
         if (isStatus2xx(response)) {
-          return (T) mapper.readerFor(clazz).readValue(response.getResponseBodyAsStream());
+          return reader.readValue(response.getResponseBodyAsStream());
         } else if (isRateLimitResponse(response)) {
           throw new ZendeskResponseRateLimitException(response);
         }

src/main/java/org/zendesk/client/v2/model/views/ExecutedViewPage.java

@@ -0,0 +1,99 @@
+package org.zendesk.client.v2.model.views;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import java.util.List;
+import java.util.Objects;
+
+// this is somewhat similar to a Page but with a single ExecuteView object and not a list
+// hence why we cannot inherite Page<?>
+public class ExecutedViewPage<V extends ViewRow> implements Serializable {
+  private static final long serialVersionUID = -7683989282890282540L;
+
+  private @JsonProperty("next_page") String nextPage;
+  private @JsonProperty("previous_page") String previousPage;
+  private int count;
+
+  private List<ViewColumn> columns;
+  private List<V> rows;
+
+  public List<ViewColumn> getColumns() {
+    return columns;
+  }
+
+  public void setColumns(List<ViewColumn> columns) {
+    this.columns = columns;
+  }
+
+  public List<V> getRows() {
+    return rows;
+  }
+
+  public void setRows(List<V> rows) {
+    this.rows = rows;
+  }
+
+  public String getNextPage() {
+    return nextPage;
+  }
+
+  public void setNextPage(final String nextPage) {
+    this.nextPage = nextPage;
+  }
+
+  public String getPreviousPage() {
+    return previousPage;
+  }
+
+  public void setPreviousPage(final String previousPage) {
+    this.previousPage = previousPage;
+  }
+
+  public int getCount() {
+    return count;
+  }
+
+  public void setCount(final int count) {
+    this.count = count;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) return false;
+
+    ExecutedViewPage<?> that = (ExecutedViewPage<?>) o;
+    return count == that.count
+        && Objects.equals(nextPage, that.nextPage)
+        && Objects.equals(previousPage, that.previousPage)
+        && Objects.equals(columns, that.columns)
+        && Objects.equals(rows, that.rows);
+  }
+
+  @Override
+  public int hashCode() {
+    int result = Objects.hashCode(nextPage);
+    result = 31 * result + Objects.hashCode(previousPage);
+    result = 31 * result + count;
+    result = 31 * result + Objects.hashCode(columns);
+    result = 31 * result + Objects.hashCode(rows);
+    return result;
+  }
+
+  @Override
+  public String toString() {
+    return "ExecutedViewPage{"
+        + "nextPage='"
+        + nextPage
+        + '\''
+        + ", previousPage='"
+        + previousPage
+        + '\''
+        + ", count="
+        + count
+        + ", columns="
+        + columns
+        + ", rows="
+        + rows
+        + '}';
+  }
+}

src/main/java/org/zendesk/client/v2/model/views/ViewColumn.java

@@ -0,0 +1,81 @@
+package org.zendesk.client.v2.model.views;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+public class ViewColumn implements Serializable {
+  private static final long serialVersionUID = 5250249523833634470L;
+
+  private String id;
+  private String title;
+  private boolean filterable;
+  private boolean sortable;
+
+  public String getId() {
+    return id;
+  }
+
+  public void setId(String id) {
+    this.id = id;
+  }
+
+  public String getTitle() {
+    return title;
+  }
+
+  public void setTitle(String title) {
+    this.title = title;
+  }
+
+  public boolean isFilterable() {
+    return filterable;
+  }
+
+  public void setFilterable(boolean filterable) {
+    this.filterable = filterable;
+  }
+
+  public boolean isSortable() {
+    return sortable;
+  }
+
+  public void setSortable(boolean sortable) {
+    this.sortable = sortable;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) return false;
+
+    ViewColumn that = (ViewColumn) o;
+    return filterable == that.filterable
+        && sortable == that.sortable
+        && Objects.equals(id, that.id)
+        && Objects.equals(title, that.title);
+  }
+
+  @Override
+  public int hashCode() {
+    int result = Objects.hashCode(id);
+    result = 31 * result + Objects.hashCode(title);
+    result = 31 * result + Boolean.hashCode(filterable);
+    result = 31 * result + Boolean.hashCode(sortable);
+    return result;
+  }
+
+  @Override
+  public String toString() {
+    return "ViewColumn{"
+        + "id='"
+        + id
+        + '\''
+        + ", title='"
+        + title
+        + '\''
+        + ", filterable="
+        + filterable
+        + ", sortable="
+        + sortable
+        + '}';
+  }
+}

src/main/java/org/zendesk/client/v2/model/views/ViewRow.java

@@ -0,0 +1,36 @@
+package org.zendesk.client.v2.model.views;
+
+import java.io.Serializable;
+import java.util.Objects;
+import org.zendesk.client.v2.model.Ticket;
+
+public abstract class ViewRow implements Serializable {
+  private static final long serialVersionUID = -5436397225795525024L;
+  private Ticket ticket;
+
+  public Ticket getTicket() {
+    return ticket;
+  }
+
+  public void setTicket(Ticket ticket) {
+    this.ticket = ticket;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) return false;
+
+    ViewRow viewRow = (ViewRow) o;
+    return Objects.equals(ticket, viewRow.ticket);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hashCode(ticket);
+  }
+
+  @Override
+  public String toString() {
+    return "ViewRow{" + "ticket=" + ticket + '}';
+  }
+}

src/test/java/org/zendesk/client/v2/RealSmokeTest.java

@@ -28,6 +28,7 @@
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assume.assumeThat;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Calendar;
@@ -107,6 +108,7 @@
 import org.zendesk.client.v2.model.schedules.Interval;
 import org.zendesk.client.v2.model.schedules.Schedule;
 import org.zendesk.client.v2.model.targets.Target;
+import org.zendesk.client.v2.model.views.ViewRow;
 
 /**
  * @author stephenc
@@ -2848,6 +2850,32 @@ public void getLocalesReturnsLocales() throws Exception {
     assertThat(numLocales, greaterThan(0));
   }
 
+  @Test
+  public void executeView() throws Exception {
+    // a view specifically created for this test, that is supposed to stay on our test instance
+    var ispView = 37058613923611L;
+    createClientWithTokenOrPassword();
+    var maybeViewPage = instance.executeView(ispView, ViewRowWithSatisfactionScore.class);
+    assertThat(maybeViewPage.isPresent(), is(true));
+    assertThat(maybeViewPage.get().getCount(), is(2));
+    assertThat(maybeViewPage.get().getRows().get(0).getSatisfactionScore(), is("Unoffered"));
+  }
+
+  static class ViewRowWithSatisfactionScore extends ViewRow {
+    private static final long serialVersionUID = 1L;
+
+    @JsonProperty("satisfaction_score")
+    private String satisfactionScore;
+
+    public String getSatisfactionScore() {
+      return satisfactionScore;
+    }
+
+    public void setSatisfactionScore(String satisfactionScore) {
+      this.satisfactionScore = satisfactionScore;
+    }
+  }
+
   // UTILITIES
 
   /**