Merge pull request #170 from olimpias/add-query-param-list-messages

Add query param list messages

Author: denizkilic

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

@@ -117,6 +117,9 @@ public class MessageBirdClient {
     private static final String[] MESSAGE_LIST_FILTERS_VALS = {"originator", "recipient", "direction", "searchterm", "type", "contact_id", "status", "from", "until"};
     private static final Set<String> MESSAGE_LIST_FILTERS = new HashSet<>(Arrays.asList(MESSAGE_LIST_FILTERS_VALS));
 
+    private static final String[] CONVERSATION_MESSAGE_LIST_FILTERS_VALS = {"ids", "from"};
+    private static final Set<String> CONVERSATION_MESSAGE_LIST_FILTERS = new HashSet<>(Arrays.asList(CONVERSATION_MESSAGE_LIST_FILTERS_VALS));
+
     private final String DOWNLOADS = "Downloads";
 
     private MessageBirdService messageBirdService;
@@ -1006,6 +1009,23 @@ public ConversationMessage viewConversationMessage(final String messageId)
         return messageBirdService.requestByID(url, messageId, ConversationMessage.class);
     }
 
+    /**
+     * Gets conversation messages based on query param.
+     *
+     * @param queryParams only `ids` and `from` is available as an option
+     * @return The retrieved messages.
+     */
+    public ConversationMessageList listConversationMessagesWithQueryParam(Map<String, Object> queryParams)
+        throws NotFoundException, GeneralException, UnauthorizedException {
+        for (String queryParam : queryParams.keySet()) {
+            if (!CONVERSATION_MESSAGE_LIST_FILTERS.contains(queryParam)) {
+                throw new IllegalArgumentException("Invalid filter name: " + queryParam);
+            }
+        }
+        String url = CONVERSATIONS_BASE_URL + CONVERSATION_MESSAGE_PATH;
+        return messageBirdService.requestByID(url, null, queryParams, ConversationMessageList.class);
+    }
+
     /**
      * Sends a message to an existing Conversation.
      *

examples/src/main/java/ExampleListConversationMessagesWithQueryParam.java

@@ -0,0 +1,43 @@
+import com.messagebird.MessageBirdClient;
+import com.messagebird.MessageBirdService;
+import com.messagebird.MessageBirdServiceImpl;
+import com.messagebird.exceptions.GeneralException;
+import com.messagebird.exceptions.NotFoundException;
+import com.messagebird.exceptions.UnauthorizedException;
+import com.messagebird.objects.conversations.ConversationMessageList;
+import java.util.HashMap;
+
+public class ExampleListConversationMessagesWithQueryParam {
+  public static void main(String[] args) {
+
+    if (args.length == 0) {
+      System.out.println("Please specify your access key example : java -jar <this jar file> test_accesskey");
+      return;
+    }
+
+    // First create your service object
+    final MessageBirdService wsr = new MessageBirdServiceImpl(args[0]);
+
+    // Add the service to the client
+    final MessageBirdClient messageBirdClient = new MessageBirdClient(wsr);
+
+    try {
+      // Get list of conversation messages with query param
+      System.out.println("Retrieving message list");
+      final ConversationMessageList conversationMessageList = messageBirdClient.listConversationMessagesWithQueryParam(
+          new HashMap<String, Object>() {
+            {
+              put("ids", "9f0b413e79e24d76b01b895381b12a6d,d46054ee0f7245bcbc7ba586878d0ab4");
+            }
+          });
+
+      // Display conversation Message list
+      System.out.println(conversationMessageList.toString());
+    } catch (UnauthorizedException | GeneralException | NotFoundException exception) {
+      if (exception.getErrors() != null) {
+        System.out.println(exception.getErrors().toString());
+      }
+      exception.printStackTrace();
+    }
+  }
+}