start implementing Prospect end point

Author: stephen powis

src/main/java/com/darksci/pardot/api/Example.java

@@ -6,8 +6,6 @@
 import com.darksci.pardot.api.response.account.Account;
 import com.darksci.pardot.api.response.campaign.CampaignQueryResponse;
 
-import java.io.IOException;
-
 /**
  * Just a simple example code showing basic usage.
  */

src/main/java/com/darksci/pardot/api/PardotClient.java

@@ -8,6 +8,7 @@
 import com.darksci.pardot.api.parser.email.EmailReadResponseParser;
 import com.darksci.pardot.api.parser.email.EmailStatsResponseParser;
 import com.darksci.pardot.api.parser.login.LoginResponseParser;
+import com.darksci.pardot.api.parser.prospect.ProspectReadResponseParser;
 import com.darksci.pardot.api.parser.user.UserAbilitiesParser;
 import com.darksci.pardot.api.parser.user.UserQueryResponseParser;
 import com.darksci.pardot.api.parser.user.UserReadResponseParser;
@@ -22,6 +23,7 @@
 import com.darksci.pardot.api.request.email.EmailSendOneToOneRequest;
 import com.darksci.pardot.api.request.email.EmailStatsRequest;
 import com.darksci.pardot.api.request.login.LoginRequest;
+import com.darksci.pardot.api.request.prospect.ProspectReadRequest;
 import com.darksci.pardot.api.request.user.UserAbilitiesRequest;
 import com.darksci.pardot.api.request.user.UserQueryRequest;
 import com.darksci.pardot.api.request.user.UserReadRequest;
@@ -32,6 +34,7 @@
 import com.darksci.pardot.api.response.email.Email;
 import com.darksci.pardot.api.response.email.EmailStatsResponse;
 import com.darksci.pardot.api.response.login.LoginResponse;
+import com.darksci.pardot.api.response.prospect.Prospect;
 import com.darksci.pardot.api.response.user.User;
 import com.darksci.pardot.api.response.user.UserAbilitiesResponse;
 import com.darksci.pardot.api.response.user.UserQueryResponse;
@@ -285,6 +288,15 @@ public Email emailSendList(final EmailSendListRequest request) {
         return submitRequest(request, new EmailReadResponseParser());
     }
 
+    /**
+     * Make API request to read a prospect.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Prospect prospectRead(final ProspectReadRequest request) {
+        return submitRequest(request, new ProspectReadResponseParser());
+    }
+
     /**
      * Clean up instance, releasing any resources held internally.
      */

src/main/java/com/darksci/pardot/api/ParserException.java

@@ -1,8 +1,5 @@
 package com.darksci.pardot.api;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * Thrown when a parser implementation has an error.
  */

src/main/java/com/darksci/pardot/api/parser/prospect/ProspectReadResponseParser.java

@@ -0,0 +1,25 @@
+package com.darksci.pardot.api.parser.prospect;
+
+import com.darksci.pardot.api.parser.JacksonFactory;
+import com.darksci.pardot.api.parser.ResponseParser;
+import com.darksci.pardot.api.response.prospect.Prospect;
+import com.darksci.pardot.api.response.prospect.ProspectReadResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+/**
+ * Parses Prospect Read API response.
+ */
+public class ProspectReadResponseParser implements ResponseParser<Prospect> {
+    private static final Logger logger = LoggerFactory.getLogger(ProspectReadResponseParser.class);
+
+    @Override
+    public Prospect parseResponse(final String responseStr) throws IOException {
+        logger.info("{}", responseStr);
+        return JacksonFactory
+            .newInstance()
+            .readValue(responseStr, ProspectReadResponse.class).getProspect();
+    }
+}

src/main/java/com/darksci/pardot/api/request/prospect/ProspectReadRequest.java

@@ -0,0 +1,56 @@
+package com.darksci.pardot.api.request.prospect;
+
+import com.darksci.pardot.api.request.BaseRequest;
+
+/**
+ * Defines a Prospect Read Request.
+ */
+public class ProspectReadRequest extends BaseRequest<ProspectReadRequest> {
+    public ProspectReadRequest() {
+        super();
+
+        // Default to full output
+        setParam("output", "full");
+    }
+
+    @Override
+    public String getApiEndpoint() {
+        return "prospect/do/read";
+    }
+
+    /**
+     * Returns data for the prospect specified by id.
+     * @param id Prospect Id to read.
+     * @return RequestBuilder
+     */
+    public ProspectReadRequest selectById(final Long id) {
+        setParam("email", null);
+        return setParam("id", id);
+    }
+
+    /**
+     * Returns data for the prospect specified by email.
+     * @param email Prospect Email to read.
+     * @return RequestBuilder
+     */
+    public ProspectReadRequest selectByEmail(final String email) {
+        setParam("id", null);
+        return setParam("email", email);
+    }
+
+    /**
+     * Get Response in 'Full' format.
+     * @return RequestBuilder
+     */
+    public ProspectReadRequest withFullOutputFormat() {
+        return setParam("output", "full");
+    }
+
+    /**
+     * Get Response in 'Simple' format.
+     * @return RequestBuilder
+     */
+    public ProspectReadRequest withSimpleOutputFormat() {
+        return setParam("output", "simple");
+    }
+}

src/main/java/com/darksci/pardot/api/response/account/Account.java

@@ -1,6 +1,7 @@
 package com.darksci.pardot.api.response.account;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 import org.joda.time.DateTime;
 
 /**
@@ -14,8 +15,10 @@ public class Account {
     private String vanityDomain;
     private Long pluginCampaignId;
     private String trackingCodeTemplate;
-    private String address1;
-    private String address2;
+    @JacksonXmlProperty(localName = "address1")
+    private String addressOne;
+    @JacksonXmlProperty(localName = "address2")
+    private String addressTwo;
     private String city;
     private String state;
     private String territory;
@@ -56,12 +59,12 @@ public String getTrackingCodeTemplate() {
         return trackingCodeTemplate;
     }
 
-    public String getAddress1() {
-        return address1;
+    public String getAddressOne() {
+        return addressOne;
     }
 
-    public String getAddress2() {
-        return address2;
+    public String getAddressTwo() {
+        return addressTwo;
     }
 
     public String getCity() {
@@ -110,8 +113,8 @@ public String toString() {
             + ", vanityDomain='" + vanityDomain + '\''
             + ", pluginCampaignId=" + pluginCampaignId
             + ", trackingCodeTemplate='" + trackingCodeTemplate + '\''
-            + ", address1='" + address1 + '\''
-            + ", address2='" + address2 + '\''
+            + ", addressOne='" + addressOne + '\''
+            + ", addressTwo='" + addressTwo + '\''
             + ", city='" + city + '\''
             + ", state='" + state + '\''
             + ", territory='" + territory + '\''

src/main/java/com/darksci/pardot/api/response/list/List.java

@@ -0,0 +1,72 @@
+package com.darksci.pardot.api.response.list;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import org.joda.time.LocalDateTime;
+
+/**
+ * Represents a Pardot List.
+ */
+public class List {
+    private Long id;
+    private String name;
+    private String title;
+    private String description;
+    private Boolean isPublic;
+    private Boolean isDynamic;
+    private Boolean isCrmVisible;
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private LocalDateTime createdAt;
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private LocalDateTime updatedAt;
+
+    public Long getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public Boolean getPublic() {
+        return isPublic;
+    }
+
+    public Boolean getDynamic() {
+        return isDynamic;
+    }
+
+    public Boolean getCrmVisible() {
+        return isCrmVisible;
+    }
+
+    public LocalDateTime getCreatedAt() {
+        return createdAt;
+    }
+
+    public LocalDateTime getUpdatedAt() {
+        return updatedAt;
+    }
+
+    @Override
+    public String toString() {
+        return "List{"
+            + "id=" + id
+            + ", name='" + name + '\''
+            + ", title='" + title + '\''
+            + ", description='" + description + '\''
+            + ", isPublic=" + isPublic
+            + ", isDynamic=" + isDynamic
+            + ", isCrmVisible=" + isCrmVisible
+            + ", createdAt=" + createdAt
+            + ", updatedAt=" + updatedAt
+            + '}';
+    }
+}

src/main/java/com/darksci/pardot/api/response/list/ListSubscription.java

@@ -0,0 +1,54 @@
+package com.darksci.pardot.api.response.list;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import org.joda.time.LocalDateTime;
+
+/**
+ * Represents a membership of a list.
+ */
+public class ListSubscription {
+    private Long id;
+    private Boolean didOptIn;
+    private Boolean didOptOut;
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private LocalDateTime createdAt;
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private LocalDateTime updatedAt;
+    private List list;
+
+    public Long getId() {
+        return id;
+    }
+
+    public Boolean getDidOptIn() {
+        return didOptIn;
+    }
+
+    public Boolean getDidOptOut() {
+        return didOptOut;
+    }
+
+    public LocalDateTime getCreatedAt() {
+        return createdAt;
+    }
+
+    public LocalDateTime getUpdatedAt() {
+        return updatedAt;
+    }
+
+    public List getList() {
+        return list;
+    }
+
+    @Override
+    public String toString() {
+        return "ListSubscription{"
+            + "id=" + id
+            + ", didOptIn=" + didOptIn
+            + ", didOptOut=" + didOptOut
+            + ", createdAt=" + createdAt
+            + ", updatedAt=" + updatedAt
+            + ", list=" + list
+            + '}';
+    }
+}

src/main/java/com/darksci/pardot/api/response/profile/Profile.java

@@ -0,0 +1,33 @@
+package com.darksci.pardot.api.response.profile;
+
+import java.util.List;
+
+/**
+ * Represents a Pardot profile.
+ */
+public class Profile {
+    private Long id;
+    private String name;
+    private List<ProfileCriteria> profileCriteria;
+
+    public Long getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public List<ProfileCriteria> getProfileCriteria() {
+        return profileCriteria;
+    }
+
+    @Override
+    public String toString() {
+        return "Profile{"
+            + "id=" + id
+            + ", name='" + name + '\''
+            + ", profileCriteria=" + profileCriteria
+            + '}';
+    }
+}

src/main/java/com/darksci/pardot/api/response/profile/ProfileCriteria.java

@@ -0,0 +1,31 @@
+package com.darksci.pardot.api.response.profile;
+
+/**
+ * Represents a Pardot Profile Criteria.
+ */
+public class ProfileCriteria {
+    private Long id;
+    private String name;
+    private String matches;
+
+    public Long getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getMatches() {
+        return matches;
+    }
+
+    @Override
+    public String toString() {
+        return "ProfileCriteria{"
+            + "id=" + id
+            + ", name='" + name + '\''
+            + ", matches='" + matches + '\''
+            + '}';
+    }
+}