Merge pull request #64 from messagebird/feature/grow-1086-call-flow-examples

Feature/grow 1086 call flow examples

Author: Dan Gurgui

api/src/main/java/com/messagebird/MessageBirdClient.java

@@ -6,8 +6,6 @@
 import com.messagebird.objects.*;
 import com.messagebird.objects.conversations.*;
 import com.messagebird.objects.voicecalls.*;
-import com.messagebird.objects.voicecalls.VoiceCallLeg;
-import com.messagebird.objects.voicecalls.VoiceCallLegResponse;
 
 import java.io.UnsupportedEncodingException;
 import java.math.BigInteger;
@@ -64,6 +62,7 @@ public class MessageBirdClient {
     static final String RECORDINGPATH = "/recordings";
     static final String TRANSCRIPTIONPATH = "/transcriptions";
     static final String WEBHOOKS = "/webhooks";
+    static final String VOICECALLFLOWPATH = "/call-flows";
     private static final String VOICELEGS_SUFFIX_PATH = "/legs";
 
     private MessageBirdService messageBirdService;
@@ -534,6 +533,97 @@ public LookupHlr viewLookupHlr(final BigInteger phoneNumber) throws Unauthorized
         return this.viewLookupHlr(lookupHlr);
     }
 
+    /**
+     * Convenient function to list all call flows 
+     *
+     * @param offset     
+     * @param limit       
+     * @return VoiceCallFlowList
+     * @throws UnauthorizedException if client is unauthorized
+     * @throws GeneralException      general exception
+     */
+    public VoiceCallFlowList listVoiceCallFlows(final Integer offset, final Integer limit) 
+        throws UnauthorizedException, GeneralException {
+        if (offset != null && offset < 0) {
+            throw new IllegalArgumentException("Offset must be > 0");
+        }
+        if (limit != null && limit < 0) {
+            throw new IllegalArgumentException("Limit must be > 0");
+        }
+        String url = String.format("%s%s", VOICE_CALLS_BASE_URL, VOICECALLFLOWPATH);
+
+        return messageBirdService.requestList(url, offset, limit, VoiceCallFlowList.class);
+    }
+
+    /**
+     * Retrieves the information of an existing Call Flow. You only need to supply
+     * the unique call flow ID that was returned upon creation or receiving.
+     * @param id String
+     * @return VoiceCallFlowResponse
+     * @throws NotFoundException
+     * @throws GeneralException
+     * @throws UnauthorizedException
+     */
+    public VoiceCallFlowResponse viewVoiceCallFlow(final String id) throws NotFoundException, GeneralException, UnauthorizedException {
+        if (id == null) {
+            throw new IllegalArgumentException("Call Flow ID must be specified.");
+        }
+        String url = String.format("%s%s", VOICE_CALLS_BASE_URL, VOICECALLFLOWPATH);
+
+        return messageBirdService.requestByID(url, id, VoiceCallFlowResponse.class);
+    }
+
+    /**
+     * Convenient function to create a call flow 
+     *
+     * @param voiceCallFlowRequest VoiceCallFlowRequest
+     * @return VoiceCallFlowResponse
+     * @throws UnauthorizedException if client is unauthorized
+     * @throws GeneralException      general exception
+     */
+    public VoiceCallFlowResponse sendVoiceCallFlow(final VoiceCallFlowRequest voiceCallFlowRequest)
+        throws UnauthorizedException, GeneralException {
+        String url = String.format("%s%s", VOICE_CALLS_BASE_URL, VOICECALLFLOWPATH);
+
+        return messageBirdService.sendPayLoad(url, voiceCallFlowRequest, VoiceCallFlowResponse.class);
+    }
+
+    /**
+     * Updates an existing Call Flow. You only need to supply the unique id that
+     * was returned upon creation.
+     * @param id String
+     * @param voiceCallFlowRequest VoiceCallFlowRequest
+     * @return VoiceCallFlowResponse
+     * @throws UnauthorizedException
+     * @throws GeneralException
+     */
+    public VoiceCallFlowResponse updateVoiceCallFlow(String id, VoiceCallFlowRequest voiceCallFlowRequest)
+        throws UnauthorizedException, GeneralException {
+        if (id == null) {
+            throw new IllegalArgumentException("Call Flow ID must be specified.");
+        }
+        String url = String.format("%s%s", VOICE_CALLS_BASE_URL, VOICECALLFLOWPATH);
+        String request = url + "/" + id;
+
+        return messageBirdService.sendPayLoad("PUT", request, voiceCallFlowRequest, VoiceCallFlowResponse.class);
+    }
+    
+    /**
+     * Convenient function to delete call flow 
+     *
+     * @param id String
+     * @return void
+     * @throws UnauthorizedException if client is unauthorized
+     * @throws GeneralException      general exception
+     */
+    public void deleteVoiceCallFlow(final String id) throws NotFoundException, GeneralException, UnauthorizedException {
+        if (id == null) {
+            throw new IllegalArgumentException("Voice Call Flow ID must be specified.");
+        }
+        String url = String.format("%s%s", VOICE_CALLS_BASE_URL, VOICECALLFLOWPATH);
+        messageBirdService.deleteByID(url, id);
+    }
+
     /**
      * Deletes an existing contact. You only need to supply the unique id that
      * was returned upon creation.

api/src/main/java/com/messagebird/MessageBirdServiceImpl.java

@@ -42,9 +42,10 @@ public class MessageBirdServiceImpl implements MessageBirdService {
     private static final String METHOD_GET = "GET";
     private static final String METHOD_PATCH = "PATCH";
     private static final String METHOD_POST = "POST";
+    private static final String METHOD_PUT = "PUT";
 
-    private static final List<String> REQUEST_METHODS = Arrays.asList(METHOD_DELETE, METHOD_GET, METHOD_PATCH, METHOD_POST);
-    private static final List<String> REQUEST_METHODS_WITH_PAYLOAD = Arrays.asList(METHOD_PATCH, METHOD_POST);
+    private static final List<String> REQUEST_METHODS = Arrays.asList(METHOD_DELETE, METHOD_GET, METHOD_PATCH, METHOD_POST, METHOD_PUT);
+    private static final List<String> REQUEST_METHODS_WITH_PAYLOAD = Arrays.asList(METHOD_PATCH, METHOD_POST, METHOD_PUT);
     private static final String[] PROTOCOL_LISTS = new String[]{"http://", "https://"};
     private static final List<String> PROTOCOLS = Arrays.asList(PROTOCOL_LISTS);
 
@@ -302,6 +303,7 @@ private static String[] getAllowedMethods(String[] existingMethods) {
 
         allowedMethods.addAll(Arrays.asList(existingMethods));
         allowedMethods.add(METHOD_PATCH);
+        allowedMethods.add(METHOD_PUT);
 
         return allowedMethods.toArray(new String[0]);
     }

api/src/main/java/com/messagebird/objects/VoiceStepOption.java

@@ -23,6 +23,7 @@ public class VoiceStepOption implements Serializable {
     private String ifMachine;
     private int machineTimeout;
     private String onFinish;
+    private boolean mask;
 
     public String getDestination() {
         return destination;
@@ -160,6 +161,14 @@ public void setOnFinish(String onFinish) {
         this.onFinish = onFinish;
     }
 
+    public boolean isMask() {
+        return mask;
+    }
+
+    public void setMask(boolean mask) {
+        this.mask = mask;
+    }
+
     @Override
     public String toString() {
         return "VoiceStepOption{" +
@@ -180,6 +189,7 @@ public String toString() {
                 ", ifMachine='" + ifMachine + '\'' +
                 ", machineTimeout=" + machineTimeout +
                 ", onFinish='" + onFinish + '\'' +
+                ", mask='" + mask + '\'' +
                 '}';
     }
 }

api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlow.java

@@ -1,10 +1,12 @@
 package com.messagebird.objects.voicecalls;
 
 import com.messagebird.objects.VoiceStep;
+import com.fasterxml.jackson.annotation.JsonProperty;
 
 import java.io.Serializable;
 import java.util.Date;
 import java.util.List;
+import java.util.Map;
 
 public class VoiceCallFlow implements Serializable {
 
@@ -14,10 +16,19 @@ public class VoiceCallFlow implements Serializable {
     private String title;
     private boolean record;
     private List<VoiceStep> steps;
+
+    /*
+     * default is reserved name in JAVA so we use alternate name
+     */
+    @JsonProperty("default")
     private boolean defaultCall;
+
     private Date createdAt;
     private Date updatedAt;
 
+    @JsonProperty("_links")
+    private Map<String, String> links;
+
     public String getId() {
         return id;
     }
@@ -81,7 +92,7 @@ public String toString() {
                 ", title='" + title + '\'' +
                 ", record=" + record +
                 ", steps=" + steps +
-                ", defaultCall=" + defaultCall +
+                ", default=" + defaultCall +
                 ", createdAt=" + createdAt +
                 ", updatedAt=" + updatedAt +
                 '}';

api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlowList.java

@@ -0,0 +1,72 @@
+package com.messagebird.objects.voicecalls;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Represents a listing of VoiceCallFlow objects, along with pagination details.
+ * @TODO needs a little polishing (reorganise methods, rename properties, add
+ * missing properties)
+ */
+public class VoiceCallFlowList implements Serializable {
+
+    private Integer offset;
+    private Integer limit;
+    private Integer totalCount;
+
+    @JsonProperty("_links")
+    private Map<String, String> links;
+
+    private Pagination pagination;
+
+    private List<VoiceCallFlow> items;
+
+    @JsonCreator
+    public VoiceCallFlowList(@JsonProperty("data") List<VoiceCallFlow> data) {
+        this.items = data;
+    }
+
+    @Override
+    public String toString() {
+        return "ListBase{" +
+                "offset=" + offset +
+                ", limit=" + limit +
+                ", totalCount=" + totalCount +
+                ", items=" + items +
+                '}';
+    }
+
+    public void setPagination(Pagination pagination) {
+        this.pagination = pagination;
+    }
+
+    public Integer getTotalCount() {
+        return this.pagination.getTotalCount();
+    }
+
+    public Integer getPageCount() {
+        return this.pagination.getPageCount();
+    }
+
+    public Integer getCurrentPage() {
+        return this.pagination.getCurrentPage();
+    }
+
+    public Integer getPerPage() {
+        return this.pagination.getPerPage();
+    }
+
+
+    public List<VoiceCallFlow> getItems() {
+        return items;
+    }
+
+    public void setItems(List<VoiceCallFlow> items) {
+        this.items = items;
+    }
+}
+
+

api/src/main/java/com/messagebird/objects/voicecalls/VoiceCallFlowRequest.java

@@ -0,0 +1,80 @@
+package com.messagebird.objects.voicecalls;
+
+import java.util.List;
+import java.util.Date;
+import com.messagebird.objects.*;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Contains writable values for VoiceCallFlow objects.
+ */
+public class VoiceCallFlowRequest {
+
+ 
+    private String id;
+    private String title;
+    private boolean record;
+    private List<VoiceStep> steps;
+    
+    @JsonProperty("default")
+    private boolean defaultCall;
+
+    public VoiceCallFlowRequest(String id)
+    {
+        this.id = id;
+    }
+
+    public VoiceCallFlowRequest() 
+    {
+    }
+
+    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 isRecord() {
+        return record;
+    }
+
+    public void setRecord(boolean record) {
+        this.record = record;
+    }
+
+    public List<VoiceStep> getSteps() {
+        return steps;
+    }
+
+    public void setSteps(List<VoiceStep> steps) {
+        this.steps = steps;
+    }
+
+    public boolean isDefaultCall() {
+        return defaultCall;
+    }
+
+    public void setDefaultCall(boolean defaultCall) {
+        this.defaultCall = defaultCall;
+    }
+
+    @Override
+    public String toString() {
+        return "VoiceCallFlowRequest{" +
+                "title='" + title + '\'' +
+                ", record=" + record +
+                ", steps=" + steps +
+                ", default=" + defaultCall +
+                '}';
+    }
+}