vmalinovskiy: added dnc apis

Author: vmalinovskiy

Changelog.txt

@@ -1,5 +1,8 @@
 Callfire API client Changelog
 =============================
+Version 1.7.14 - Jan 27 2017
+- added dnc apis
+
 Version 1.7.13 - Dec 30 2016
 - minor fixes for get contacts history api
 

gradle.properties

@@ -1,3 +1,3 @@
 group = com.callfire
 baseName = callfire-api-client
-version = 1.7.13
+version = 1.7.14

src/itest/java/com/callfire/api/client/integration/campaigns/TextAutoRepliesApiTest.java

@@ -38,16 +38,10 @@ public void testCrudOperations() throws Exception {
             .build();
         Page<TextAutoReply> textAutoReplies = api.find(request);
         System.out.println(textAutoReplies);
-
         assertTrue(textAutoReplies.getTotalCount() > 0);
         assertTrue(textAutoReplies.getItems().size() > 0);
-        TextAutoReply savedTextAutoReply = textAutoReplies.getItems().get(textAutoReplies.getItems().size() - 1);
-        assertEquals(resourceId.getId(), savedTextAutoReply.getId());
-        assertEquals(textAutoReply.getNumber(), savedTextAutoReply.getNumber());
-        assertEquals(textAutoReply.getMessage(), savedTextAutoReply.getMessage());
-        assertEquals(textAutoReply.getMatch(), savedTextAutoReply.getMatch());
 
-        savedTextAutoReply = api.get(resourceId.getId(), "number,message");
+        TextAutoReply savedTextAutoReply = api.get(resourceId.getId(), "number,message");
         System.out.println(savedTextAutoReply);
 
         assertNull(savedTextAutoReply.getId());

src/itest/java/com/callfire/api/client/integration/contacts/DncApiTest.java

@@ -1,14 +1,26 @@
 package com.callfire.api.client.integration.contacts;
 
+import com.callfire.api.client.CallfireClient;
+import com.callfire.api.client.api.common.model.Page;
+import com.callfire.api.client.api.contacts.model.DoNotContact;
+import com.callfire.api.client.api.contacts.model.UniversalDnc;
+import com.callfire.api.client.api.contacts.model.request.CreateDncsRequest;
+import com.callfire.api.client.api.contacts.model.request.FindDncNumbersRequest;
+import com.callfire.api.client.api.contacts.model.request.FindUniversalDncsRequest;
+import com.callfire.api.client.api.contacts.model.request.UpdateDncRequest;
 import com.callfire.api.client.integration.AbstractIntegrationTest;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.Arrays;
+import java.util.List;
 
 /**
  * integration tests for /contacts/dncs api endpoint
  */
 public class DncApiTest extends AbstractIntegrationTest {
 
-    // TODO vmalinovskiy: uncomment when dnc apis will be tested and available on docs site
-    /*@Test
+    @Test
     public void testFind() throws Exception {
         CallfireClient client = getCallfireClient();
         FindDncNumbersRequest request = FindDncNumbersRequest.create()
@@ -98,6 +110,6 @@ public void testFindUniversalDncs() throws Exception {
         Assert.assertNotNull(uDncs.get(0).isOutboundCall());
         Assert.assertNotNull(uDncs.get(0).isInboundText());
         Assert.assertNotNull(uDncs.get(0).isOutboundText());
-    }*/
+    }
 
 }

src/main/java/com/callfire/api/client/CallfireClient.java

@@ -93,10 +93,7 @@ public class CallfireClient {
     // contacts
     private ContactsApi contactsApi;
     private ContactListsApi contactListsApi;
-
-    // TODO vmalinovskiy: uncomment when dnc apis will be tested and available on docs site
     private DncApi dncApi;
-
     // webhooks
     private SubscriptionsApi subscriptionsApi;
     private WebhooksApi webhooksApi;
@@ -401,18 +398,17 @@ public BatchesApi batchesApi() {
         return batchesApi;
     }
 
-    // TODO vmalinovskiy: uncomment when dnc apis will be tested and available on docs site
     /**
      * Get /contacts/do-not-calls api endpoint
      *
      * @return endpoint object
-     *//*
+     */
     public DncApi dncApi() {
         if (dncApi == null) {
             dncApi = new DncApi(restApiClient);
         }
         return dncApi;
-    }*/
+    }
 
     /**
      * Get /contacts/lists api endpoint

src/main/java/com/callfire/api/client/api/contacts/DncApi.java

@@ -1,6 +1,19 @@
 package com.callfire.api.client.api.contacts;
 
 import com.callfire.api.client.*;
+import com.callfire.api.client.api.common.model.Page;
+import com.callfire.api.client.api.contacts.model.DoNotContact;
+import com.callfire.api.client.api.contacts.model.UniversalDnc;
+import com.callfire.api.client.api.contacts.model.request.CreateDncsRequest;
+import com.callfire.api.client.api.contacts.model.request.FindDncNumbersRequest;
+import com.callfire.api.client.api.contacts.model.request.FindUniversalDncsRequest;
+import com.callfire.api.client.api.contacts.model.request.UpdateDncRequest;
+import org.apache.commons.lang3.Validate;
+
+import java.util.List;
+
+import static com.callfire.api.client.ClientConstants.PLACEHOLDER;
+import static com.callfire.api.client.ModelType.*;
 
 /**
  * Represents /contacts/dncs endpoint
@@ -9,8 +22,7 @@
  */
 public class DncApi {
 
-    // TODO vmalinovskiy: uncomment when dnc apis will be tested and available on docs site
-    /*private static final String DNC_PATH = "/contacts/dncs";
+    private static final String DNC_PATH = "/contacts/dncs";
     private static final String DNC_SOURCES_PATH = "/contacts/dncs/sources/{}";
     private static final String UNIVERSAL_DNC_PATH = "/contacts/dncs/universals/{}";
     private static final String DNC_NUMBER_PATH = "/contacts/dncs/{}";
@@ -21,7 +33,7 @@ public DncApi(RestApiClient client) {
         this.client = client;
     }
 
-    *//**
+    /**
      * Find all Do Not Contact (DNC) objects created by the user.
      * These DoNotContact entries only affect calls/texts/campaigns on this account.
      *
@@ -34,12 +46,12 @@ public DncApi(RestApiClient client) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public Page<DoNotContact> find(FindDncNumbersRequest request) {
         return client.get(DNC_PATH, pageOf(DoNotContact.class), request);
     }
 
-    *//**
+    /**
      * Get do not contact (dnc).
      *
      * @param number DNC number to get dnc for
@@ -51,12 +63,12 @@ public Page<DoNotContact> find(FindDncNumbersRequest request) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public DoNotContact get(String number) {
         return client.get(DNC_NUMBER_PATH.replaceFirst(PLACEHOLDER, number), of(DoNotContact.class));
     }
 
-    *//**
+    /**
      * Add Do Not Contact (DNC) entries.
      *
      * @param request DNC items to create
@@ -67,12 +79,12 @@ public DoNotContact get(String number) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public void create(CreateDncsRequest request) {
         client.post(DNC_PATH, null, request);
     }
 
-    *//**
+    /**
      * Update a Do Not Contact (DNC) value. Can toggle whether the DNC is enabled for calls/texts.
      *
      * @param request DNC update request
@@ -83,12 +95,12 @@ public void create(CreateDncsRequest request) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public void update(UpdateDncRequest request) {
         client.put(DNC_NUMBER_PATH.replaceFirst(PLACEHOLDER, request.getNumber()), null, request);
     }
 
-    *//**
+    /**
      * Delete a Do Not Contact (DNC) value.
      *
      * @param number DNC number to remove dnc for
@@ -99,13 +111,13 @@ public void update(UpdateDncRequest request) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public void delete(String number) {
         Validate.notNull(number, "number cannot be null");
         client.delete(DNC_NUMBER_PATH.replaceFirst(PLACEHOLDER, number));
     }
 
-    *//**
+    /**
      * Find universal do not contacts (udnc) associated with toNumber
      *
      * @param request find request with different properties to filter
@@ -117,12 +129,12 @@ public void delete(String number) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public List<UniversalDnc> findUniversalDncs(FindUniversalDncsRequest request) {
         return client.get(UNIVERSAL_DNC_PATH.replaceFirst(PLACEHOLDER, request.getToNumber()), listHolderOf(UniversalDnc.class), request).getItems();
     }
 
-    *//**
+    /**
      * Delete do not contact (dnc) numbers contained in source.
      *
      * @param source Source associated with Do Not Contact (DNC) entry.
@@ -133,10 +145,10 @@ public List<UniversalDnc> findUniversalDncs(FindUniversalDncsRequest request) {
      * @throws InternalServerErrorException in case HTTP response code is 500 - Internal Server Error.
      * @throws CallfireApiException         in case HTTP response code is something different from codes listed above.
      * @throws CallfireClientException      in case error has occurred in client.
-     *//*
+     */
     public void deleteDncsFromSource(String source) {
         Validate.notNull(source, "number cannot be null");
         client.delete(DNC_SOURCES_PATH.replaceFirst(PLACEHOLDER, source));
-    }*/
+    }
 
 }

src/main/java/com/callfire/api/client/api/contacts/model/DoNotContact.java

@@ -3,14 +3,15 @@
 import com.callfire.api.client.api.common.model.CallfireModel;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 
+import java.util.Date;
+
 public class DoNotContact extends CallfireModel {
     private String number;
     private Boolean call;
     private Boolean text;
-    //private String source;
-    //private Long campaignId;
-    //private Date created;
-
+    private String source;
+    private Long campaignId;
+    private Date created;
 
     public String getNumber() {
         return number;
@@ -24,12 +25,16 @@ public Boolean getText() {
         return text;
     }
 
-    public void setCall(Boolean call) {
-        this.call = call;
+    public String getSource() {
+        return source;
+    }
+
+    public Long getCampaignId() {
+        return campaignId;
     }
 
-    public void setText(Boolean text) {
-        this.text = text;
+    public Date getCreated() {
+        return created;
     }
 
     @Override
@@ -39,6 +44,9 @@ public String toString() {
             .append("number", number)
             .append("call", call)
             .append("text", text)
+            .append("source", source)
+            .append("campaignId", campaignId)
+            .append("created", created)
             .toString();
     }
 }

src/test/java/com/callfire/api/client/api/contacts/DncApiTest.java

@@ -1,11 +1,30 @@
 package com.callfire.api.client.api.contacts;
 
 import com.callfire.api.client.api.AbstractApiTest;
+import com.callfire.api.client.api.common.model.ListHolder;
+import com.callfire.api.client.api.common.model.Page;
+import com.callfire.api.client.api.contacts.model.DoNotContact;
+import com.callfire.api.client.api.contacts.model.UniversalDnc;
+import com.callfire.api.client.api.contacts.model.request.CreateDncsRequest;
+import com.callfire.api.client.api.contacts.model.request.FindDncNumbersRequest;
+import com.callfire.api.client.api.contacts.model.request.FindUniversalDncsRequest;
+import com.callfire.api.client.api.contacts.model.request.UpdateDncRequest;
+import org.apache.http.client.methods.*;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.MockitoAnnotations;
+
+import java.util.Arrays;
+import java.util.List;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.equalToIgnoringWhiteSpace;
+import static org.junit.Assert.*;
 
 public class DncApiTest extends AbstractApiTest {
 
-    // TODO vmalinovskiy: uncomment when dnc apis will be tested and available on docs site
-    /* protected static final String RESPONSES_PATH = "/contacts/dncApi/response/";
+    protected static final String RESPONSES_PATH = "/contacts/dncApi/response/";
     protected static final String REQUESTS_PATH = "/contacts/dncApi/request/";
 
     @Before
@@ -146,5 +165,5 @@ public void testFindUniversalDncs() throws Exception {
         assertThat(arg.getURI().toString(), containsString("toNumber=12135551188"));
         assertThat(arg.getURI().toString(), containsString("fromNumber=18442800143"));
         assertThat(arg.getURI().toString(), containsString(ENCODED_FIELDS));
-    }*/
+    }
 }