Webhooks resourceresponses, WebhookDescription class

Author: kalnik-a-a

libs/sparkpost-lib/src/main/java/com/sparkpost/model/Webhook.java

@@ -1,33 +1,17 @@
-
 package com.sparkpost.model;
 
-import java.util.Arrays;
-import java.util.List;
-
 import com.google.gson.annotations.SerializedName;
 import com.yepher.jsondoc.annotations.Description;
-
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
-/**
- * DTO for storing info about a webhook.
- *
- * @author grava
- */
 @Data
 @EqualsAndHashCode(callSuper = true)
-public class Webhook extends Base {
+public class Webhook extends WebhookDescription {
 
     @Description(value = "Webhook id")
     private String id;
 
-    @Description(value = "User-friendly name", sample = {"Inbound Customer Replies"})
-    private String name;
-
-    @Description(value = "URL of the target to which to POST relay batches", sample = {"https://webhooks.customer.example/replies"})
-    private String target;
-
     @Description(value = "Type of authentication to be used during POST requests to target.", sample = {"none", "basic", "oauth2"})
     @SerializedName("auth_type")
     private String authType;
@@ -41,19 +25,4 @@ public class Webhook extends Base {
     @SerializedName("auth_credentials")
     private AuthCredentials authCredentials;
 
-    @Deprecated
-    @Description(
-            value = "Authentication token to present in the X-MessageSystems-Webhook-Token header of POST requests to target",
-            sample = {"5ebe2294ecd0e0f08eab7690d2a6ee69"})
-    @SerializedName("auth_token")
-    private String authToken;
-
-    @Description(value = "Array of events", sample = {""})
-    private List<String> events;
-
-    @Description(
-            value = "Restrict which inbound messages will be relayed to the target",
-            sample = {"\"match\": { \"protocol\": \"SMTP\", \"domain\": \"replies.customer.example\" }"})
-    private Match match;
-
 }

libs/sparkpost-lib/src/main/java/com/sparkpost/model/WebhookDescription.java

@@ -0,0 +1,43 @@
+
+package com.sparkpost.model;
+
+import java.util.Arrays;
+import java.util.List;
+
+import com.google.gson.annotations.SerializedName;
+import com.yepher.jsondoc.annotations.Description;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * DTO for storing info about a webhook.
+ *
+ * @author grava
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WebhookDescription extends Base {
+
+    @Description(value = "User-friendly name", sample = {"Inbound Customer Replies"})
+    private String name;
+
+    @Description(value = "URL of the target to which to POST relay batches", sample = {"https://webhooks.customer.example/replies"})
+    private String target;
+
+    @Deprecated
+    @Description(
+            value = "Authentication token to present in the X-MessageSystems-Webhook-Token header of POST requests to target",
+            sample = {"5ebe2294ecd0e0f08eab7690d2a6ee69"})
+    @SerializedName("auth_token")
+    private String authToken;
+
+    @Description(value = "Array of events", sample = {""})
+    private List<String> events;
+
+    @Description(
+            value = "Restrict which inbound messages will be relayed to the target",
+            sample = {"\"match\": { \"protocol\": \"SMTP\", \"domain\": \"replies.customer.example\" }"})
+    private Match match;
+
+}

libs/sparkpost-lib/src/main/java/com/sparkpost/model/WebhookCreateResponseEntry.java renamed to libs/sparkpost-lib/src/main/java/com/sparkpost/model/WebhookIdResponseEntry.java

@@ -6,8 +6,8 @@
 
 @Data
 @EqualsAndHashCode(callSuper = true)
-public class WebhookCreateResponseEntry extends Base {
+public class WebhookIdResponseEntry extends Base {
 
-    @Description(value = "Created webhook id.")
+    @Description(value = "Created or updated webhook id.")
     private String id;
 }

libs/sparkpost-lib/src/main/java/com/sparkpost/model/responses/WebhookCreateResponse.java

@@ -0,0 +1,14 @@
+package com.sparkpost.model.responses;
+
+import com.sparkpost.model.Webhook;
+import com.yepher.jsondoc.annotations.Description;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WebhookDescribeResponse extends Response {
+
+    @Description(value = "", sample = "")
+    private Webhook results;
+}

libs/sparkpost-lib/src/main/java/com/sparkpost/model/responses/WebhookDescribeResponse.java

@@ -0,0 +1,15 @@
+package com.sparkpost.model.responses;
+
+import com.sparkpost.model.WebhookIdResponseEntry;
+import com.yepher.jsondoc.annotations.Description;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WebhookIdContainerResponse extends Response {
+
+
+    @Description(value = "Created or updated webhook id description")
+    WebhookIdResponseEntry results;
+}

libs/sparkpost-lib/src/main/java/com/sparkpost/model/responses/WebhookIdContainerResponse.java

@@ -0,0 +1,15 @@
+package com.sparkpost.resources;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+public class ResourceBase {
+
+    private static final String DATE_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss";
+    private static final Gson GSON = new GsonBuilder().setDateFormat(DATE_TIME_FORMAT).create();
+
+    protected static String getObjectAsJsonForClass(final Object object, final Class tClass) {
+        return GSON.toJson(object, tClass);
+    }
+
+}

libs/sparkpost-lib/src/main/java/com/sparkpost/resources/ResourceBase.java

@@ -3,8 +3,10 @@
 
 import com.sparkpost.exception.SparkPostException;
 import com.sparkpost.model.Webhook;
+import com.sparkpost.model.WebhookDescription;
 import com.sparkpost.model.responses.Response;
-import com.sparkpost.model.responses.WebhookCreateResponse;
+import com.sparkpost.model.responses.WebhookDescribeResponse;
+import com.sparkpost.model.responses.WebhookIdContainerResponse;
 import com.sparkpost.model.responses.WebhookListAllResponse;
 import com.sparkpost.transport.RestConnection;
 
@@ -16,7 +18,9 @@
  *
  * @author grava
  */
-public class ResourceWebhooks {
+public class ResourceWebhooks extends ResourceBase {
+
+    private static final String DEFAULT_TIMEZONE = "UTC";
 
     public static Response listSampleValuesAndEvents(RestConnection conn) throws SparkPostException {
         Response response = conn.get("webhooks/events/documentation");
@@ -31,6 +35,10 @@ public static Response getSamplePayloadForEvents(RestConnection conn, String eve
         return response;
     }
 
+    public static WebhookListAllResponse listAll(RestConnection conn) throws SparkPostException {
+        return listAll(conn, DEFAULT_TIMEZONE);
+    }
+
     public static WebhookListAllResponse listAll(RestConnection conn, String timezone) throws SparkPostException {
 
         Endpoint ep = new Endpoint("webhooks");
@@ -40,27 +48,39 @@ public static WebhookListAllResponse listAll(RestConnection conn, String timezon
         return allWebhooks;
     }
 
-    public static WebhookCreateResponse create(RestConnection conn, Webhook webhook) throws SparkPostException {
+    public static WebhookIdContainerResponse create(RestConnection conn, Webhook webhook) throws SparkPostException {
 
         String json = webhook.toJson();
         Response response = conn.post("webhooks", json);
-        WebhookCreateResponse webhookCreateResponse = WebhookCreateResponse.decode(response, WebhookCreateResponse.class);
-        return webhookCreateResponse;
+        WebhookIdContainerResponse webhookIdContainerResponse = WebhookIdContainerResponse.decode(
+                response,
+                WebhookIdContainerResponse.class
+        );
+        return webhookIdContainerResponse;
+    }
+
+    public static WebhookDescribeResponse describe(RestConnection conn, String id) throws SparkPostException {
+        return describe(conn, id, DEFAULT_TIMEZONE);
     }
 
-    public static Response describe(RestConnection conn, String id, String timezone) throws SparkPostException {
+    public static WebhookDescribeResponse describe(RestConnection conn, String id, String timezone) throws SparkPostException {
 
         Endpoint ep = new Endpoint("webhooks/" + id);
         ep.addParam("timezone", timezone);
         Response response = conn.get(ep.toString());
-        return response;
+        WebhookDescribeResponse webhookDescribeResponse = WebhookDescribeResponse.decode(response, WebhookDescribeResponse.class);
+        return webhookDescribeResponse;
     }
 
-    public static Response update(RestConnection conn, String id, Webhook webhook) throws SparkPostException {
+    public static WebhookIdContainerResponse update(RestConnection conn, String id, WebhookDescription webhookDescription) throws SparkPostException {
 
-        String json = webhook.toJson();
-        Response response = conn.post("webhooks/" + id, json);
-        return response;
+        String json = getObjectAsJsonForClass(webhookDescription, WebhookDescription.class);
+        Response response = conn.put("webhooks/" + id, json);
+        WebhookIdContainerResponse webhookIdContainerResponse = WebhookIdContainerResponse.decode(
+                response,
+                WebhookIdContainerResponse.class
+        );
+        return webhookIdContainerResponse;
     }
 
     public static Response delete(RestConnection conn, String id) throws SparkPostException {