Merge pull request #527 from Vonage/verify-cap

feat: Add Verify capability to Application API

Author: SMadani

CHANGELOG.md

@@ -4,9 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-# [8.6.0] - 2024-04-19
+# [8.6.0] - 2024-04-18
 - Added Experience Composer to Video API
-- Fixed regression in `createSession` endpoint which caused the API to return XML instead of JSON.
+- Fixed regression in `createSession` Video endpoint
+- `muteSession` Video endpoint now returns `ProjectDetails`
+- Added Verify capability to Application API
 
 # [8.5.0] - 2024-04-12
 - Added Live Captions and Audio Connector endpoints to Video API

src/main/java/com/vonage/client/application/Application.java

@@ -225,7 +225,7 @@ public Application build() {
      *
      * @since 7.7.0
      */
-            public static class Privacy extends JsonableBaseObject {
+    public static class Privacy extends JsonableBaseObject {
         private Boolean improveAi;
 
         /**
@@ -244,7 +244,7 @@ public Boolean getImproveAi() {
     /**
      * Represents the cryptographic keys of an Application.
      */
-            public static class Keys extends JsonableBaseObject {
+    public static class Keys extends JsonableBaseObject {
         private String publicKey, privateKey;
 
         /**
@@ -273,6 +273,7 @@ public static class Capabilities extends JsonableBaseObject {
         private Messages messages;
         private Rtc rtc;
         private Vbc vbc;
+        private Verify verify;
 
         /**
          * Voice capability.
@@ -314,6 +315,18 @@ public Vbc getVbc() {
             return vbc;
         }
 
+        /**
+         * Verify capability.
+         *
+         * @return The Verify capability, or {@code null} if absent.
+         *
+         * @since 8.6.0
+         */
+        @JsonProperty("verify")
+        public Verify getVerify() {
+            return verify;
+        }
+
         private void setCapability(Capability.Type type, Capability capability) {
             switch (type) {
                 case VOICE:
@@ -328,6 +341,9 @@ private void setCapability(Capability.Type type, Capability capability) {
                 case VBC:
                     vbc = (Vbc) capability;
                     break;
+                case VERIFY:
+                    verify = (Verify) capability;
+                    break;
             }
         }
 

src/main/java/com/vonage/client/application/capabilities/Capability.java

@@ -18,7 +18,6 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.vonage.client.JsonableBaseObject;
 import com.vonage.client.common.HttpMethod;
 import com.vonage.client.common.Webhook;
@@ -28,15 +27,15 @@
 /**
  * Represents a capability of a Vonage Application
  */
+@JsonInclude(JsonInclude.Include.NON_ABSENT)
 public abstract class Capability extends JsonableBaseObject {
     protected Map<Webhook.Type, Webhook> webhooks;
 
     protected Capability() {
     }
 
-    @Override
-    protected ObjectMapper createJsonObjectMapper() {
-        return super.createJsonObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_ABSENT);
+    protected Capability(Builder<?, ?> builder) {
+        webhooks = builder.webhooks;
     }
 
     /**
@@ -57,20 +56,46 @@ public Map<Webhook.Type, Webhook> getWebhooks() {
         return webhooks;
     }
 
+    /**
+     * Represents the API this capability relates to.
+     */
     public enum Type {
+
+        /**
+         * Voice API
+         */
         VOICE,
+
+        /**
+         * RTC
+         */
         RTC,
+
+        /**
+         * Messages API
+         */
         MESSAGES,
-        VBC
+
+        /**
+         * VBC
+         */
+        VBC,
+
+        /**
+         * Verify API
+         *
+         * @since 8.6.0
+         */
+        VERIFY
     }
 
     @SuppressWarnings("unchecked")
-    static abstract class Builder<C extends Capability, B extends Builder<C, B>> {
+    protected static abstract class Builder<C extends Capability, B extends Builder<C, B>> {
         Map<Webhook.Type, Webhook> webhooks;
 
         /**
          * Add a webhook for the Vonage API to use. Each Capability can only have a single webhook of each type.
-         * See <a href="https://developer.nexmo.com/concepts/guides/webhooks"> the webhooks guide</a> for details.
+         * See <a href="https://developer.vonage.com/concepts/guides/webhooks"> the webhooks guide</a> for details.
          *
          * @param type    The {@link Webhook.Type} of webhook to add.
          * @param webhook The webhook containing the URL and {@link HttpMethod}.

src/main/java/com/vonage/client/application/capabilities/Messages.java

@@ -20,13 +20,13 @@
 /**
  * Messages capability configuration settings.
  */
-public class Messages extends Capability {
+public final class Messages extends Capability {
 
     private Messages() {
     }
 
     private Messages(Builder builder) {
-        webhooks = builder.webhooks;
+        super(builder);
     }
 
     @Override

src/main/java/com/vonage/client/application/capabilities/Rtc.java

@@ -20,13 +20,13 @@
 /**
  * Rtc capability configuration settings.
  */
-public class Rtc extends Capability {
+public final class Rtc extends Capability {
 
     private Rtc() {
     }
 
     private Rtc(Builder builder) {
-        webhooks = builder.webhooks;
+        super(builder);
     }
 
     @Override

src/main/java/com/vonage/client/application/capabilities/Vbc.java

@@ -19,13 +19,13 @@
 /**
  * VBC capability configuration settings.
  */
-public class Vbc extends Capability {
+public final class Vbc extends Capability {
 
     private Vbc() {
     }
 
     private Vbc(Builder builder) {
-
+        super(builder);
     }
 
     @Override

src/main/java/com/vonage/client/application/capabilities/Verify.java

@@ -0,0 +1,67 @@
+/*
+ *   Copyright 2024 Vonage
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+package com.vonage.client.application.capabilities;
+
+import com.vonage.client.common.Webhook;
+
+/**
+ * Verify capability configuration settings.
+ *
+ * @since 8.6.0
+ */
+public final class Verify extends Capability {
+
+    private Verify() {
+    }
+
+    private Verify(Builder builder) {
+        super(builder);
+    }
+
+    @Override
+    public Type getType() {
+        return Type.VERIFY;
+    }
+
+    /**
+     * Entry point for constructing an instance of this class.
+     *
+     * @return A new Builder.
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static final class Builder extends Capability.Builder<Verify, Builder> {
+
+        private Builder() {}
+
+        @Override
+        public Builder addWebhook(Webhook.Type type, Webhook webhook) {
+            return super.addWebhook(type, webhook);
+        }
+
+        /**
+         * Builds the Verify object with this builder's properties.
+         *
+         * @return A new Verify capability.
+         */
+        @Override
+        public Verify build() {
+            return new Verify(this);
+        }
+    }
+}

src/main/java/com/vonage/client/application/capabilities/Voice.java

@@ -21,7 +21,7 @@
 /**
  * Voice capability configuration settings.
  */
-public class Voice extends Capability {
+public final class Voice extends Capability {
     private Region region;
     private Boolean signedCallbacks;
     private Integer conversationsTtl;
@@ -30,7 +30,7 @@ private Voice() {
     }
 
     private Voice(Builder builder) {
-        webhooks = builder.webhooks;
+        super(builder);
         region = builder.region;
         signedCallbacks = builder.signedCallbacks;
         if ((conversationsTtl = builder.conversationsTtl) != null && (conversationsTtl < 0 || conversationsTtl > 744)) {

src/main/java/com/vonage/client/video/MuteSessionResponse.java

@@ -16,10 +16,8 @@
 package com.vonage.client.video;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import com.vonage.client.Jsonable;
 import com.vonage.client.JsonableBaseObject;
-import com.vonage.client.VonageUnexpectedException;
-import java.io.IOException;
 
 /**
  * Represents properties of a video project.
@@ -72,7 +70,7 @@ public ProjectEnvironment getEnvironment() {
 	public Long getCreatedAt() {
 		return createdAt;
 	}
-	
+
 	/**
 	 * Creates an instance of this class from a JSON payload.
 	 *
@@ -83,12 +81,6 @@ public static ProjectDetails fromJson(String json) {
 		if (json == null || json.trim().isEmpty()) {
 			return new ProjectDetails();
 		}
-		try {
-			ObjectMapper mapper = new ObjectMapper();
-			return mapper.readValue(json, ProjectDetails.class);
-		}
-		catch (IOException ex) {
-			throw new VonageUnexpectedException("Failed to produce MuteResponse from json.", ex);
-		}
+		return Jsonable.fromJson(json);
 	}
 }