finish javadocs

Author: stephen powis

pom.xml

@@ -246,6 +246,22 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <!-- GPG Signing of Artifacts -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <version>1.6</version>
+                <executions>
+                    <execution>
+                        <id>sign-artifacts</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>sign</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
 
         <pluginManagement>

src/main/java/com/darksci/pardot/api/request/BaseQueryRequest.java

@@ -11,6 +11,7 @@ public abstract class BaseQueryRequest<T> extends BaseRequest<T> {
     /**
      * Add constraint where Id is greater than the specified value.
      * @param idGreaterThan Id constraint.
+     * @return BaseQueryRequest
      */
     public T withIdGreaterThan(final Integer idGreaterThan) {
         return setParam("id_greater_than", idGreaterThan);
@@ -19,6 +20,7 @@ public T withIdGreaterThan(final Integer idGreaterThan) {
     /**
      * Add constraint where Id is less than the specified value.
      * @param idLessThan Id constraint.
+     * @return BaseQueryRequest
      */
     public T withIdLessThan(final Integer idLessThan) {
         return setParam("id_less_than", idLessThan);
@@ -27,6 +29,7 @@ public T withIdLessThan(final Integer idLessThan) {
     /**
      * Add constraint where CreatedAt field is after than the specified time value.
      * @param createdAfter date constraint.
+     * @return BaseQueryRequest
      */
     public T withCreatedAfter(DateParameter createdAfter) {
         return setParam("created_after", createdAfter);
@@ -35,6 +38,7 @@ public T withCreatedAfter(DateParameter createdAfter) {
     /**
      * Add constraint where CreatedAt field is before than the specified time value.
      * @param createdBefore date constraint.
+     * @return BaseQueryRequest
      */
     public T withCreatedBefore(final DateParameter createdBefore) {
         return setParam("created_before", createdBefore);
@@ -43,6 +47,7 @@ public T withCreatedBefore(final DateParameter createdBefore) {
     /**
      * Add constraint where UpdatedAt field is after than the specified time value.
      * @param updatedAfter date constraint.
+     * @return BaseQueryRequest
      */
     protected T withUpdatedAfter(final DateParameter updatedAfter) {
         return setParam("updated_after", updatedAfter);
@@ -51,6 +56,7 @@ protected T withUpdatedAfter(final DateParameter updatedAfter) {
     /**
      * Add constraint where UpdatedAt field is before than the specified time value.
      * @param updatedBefore date constraint.
+     * @return BaseQueryRequest
      */
     protected T withUpdatedBefore(final DateParameter updatedBefore) {
         return setParam("updated_before", updatedBefore);
@@ -76,27 +82,31 @@ public Integer getIdLessThan() {
 
     /**
      * Sort by CreatedAt.
+     * @return BaseQueryRequest
      */
     protected T withSortByCreatedAt() {
         return withSortBy("created_at");
     }
 
     /**
      * Sort results by UpdatedAt.
+     * @return BaseQueryRequest
      */
     protected T withSortByUpdatedAt() {
         return withSortBy("updated_at");
     }
 
     /**
      * Sort results by Name.
+     * @return BaseQueryRequest
      */
     protected T withSortByName() {
         return withSortBy("name");
     }
 
     /**
      * Sort results by Id.
+     * @return BaseQueryRequest
      */
     protected T withSortById() {
         return withSortBy("id");
@@ -111,6 +121,7 @@ public Integer getLimit() {
     /**
      * Add limit on how many results are returned.
      * @param limit Limit of how many results to return.
+     * @return BaseQueryRequest
      */
     public T withLimit(final Integer limit) {
         return setParam("limit", limit);
@@ -127,6 +138,7 @@ public Integer getOffset() {
      * Example:
      *   Specifying offset=10 will return the results starting with the 11th campaign matched by the provided criteria
      * @param offset Offset to use.
+     * @return BaseQueryRequest
      */
     public T withOffset(final Integer offset) {
         return setParam("offset", offset);
@@ -158,12 +170,10 @@ public T withSortOrderAscending() {
 
     /**
      * Marked as protected because I'm not sure if all objects support this or not.
+     * @param onlyReturnArchived True to only get returned archived entries.
+     * @return BaseQueryRequest
      */
-    protected T withArchivedOnly(boolean archivedOnly) {
-        String value = "false";
-        if (archivedOnly) {
-            value = "true";
-        }
-        return setParam("deleted", archivedOnly);
+    protected T withArchivedOnly(boolean onlyReturnArchived) {
+        return setBooleanParam("deleted", onlyReturnArchived);
     }
 }

src/main/java/com/darksci/pardot/api/request/BaseRequest.java

@@ -16,7 +16,7 @@ protected <T> T getParam(final String name) {
         return (T) params.getOrDefault(name, null);
     }
 
-    protected <T> T setParam(final String name, Object value) {
+    protected T setParam(final String name, Object value) {
         if (value == null) {
             params.remove(name);
         } else {
@@ -29,8 +29,9 @@ protected <T> T setParam(final String name, Object value) {
      * Utility method to set a boolean parameter, converts boolean into string "true"/"false"
      * @param parameterName Name of the parameter to set.
      * @param booleanValue Boolean value to store.
+     * @return BaseRequest
      */
-    protected <T> T setBooleanParam(final String parameterName, final boolean booleanValue) {
+    protected T setBooleanParam(final String parameterName, final boolean booleanValue) {
         String value = "true";
         if (!booleanValue) {
             value = "false";
@@ -40,6 +41,7 @@ protected <T> T setBooleanParam(final String parameterName, final boolean boolea
 
     /**
      * Returns all set RequestParameters for the Request.
+     * @return All set Request Parameters generated from Request builder.
      */
     @Override
     public Map<String, String> getRequestParameters() {

src/main/java/com/darksci/pardot/api/request/DateParameter.java

@@ -43,7 +43,14 @@ public static DateParameter custom(final int year, final int month, final int da
     }
 
     /**
-     * Define a custom date & time.
+     * Define a custom date and time.
+     * @param year Four digit year, ex. 2017.
+     * @param month Month, 1 through 12.
+     * @param day Day of month.
+     * @param hour Hour of day, 24 time, 0 through 23.
+     * @param min Minute of hour, 0 through 59.
+     * @param sec Second of minute, 0 through 59.
+     * @return Configured DateParameter.
      */
     public static DateParameter custom(final int year, final int month, final int day, final int hour, final int min, final int sec) {
         String gnuDateStr = year + "-" + month + "-" + day + " ";

src/main/java/com/darksci/pardot/api/request/campaign/CampaignCreateRequest.java

@@ -15,6 +15,7 @@ public String getApiEndpoint() {
     /**
      * Define the campaign you want to create in pardot.
      * @param campaign The campaign you want to create in pardot.
+     * @return CampaignCreateRequest builder.
      */
     public CampaignCreateRequest withCampaign(final Campaign campaign) {
         setParam("name", campaign.getName());

src/main/java/com/darksci/pardot/api/request/campaign/CampaignUpdateRequest.java

@@ -15,6 +15,7 @@ public String getApiEndpoint() {
     /**
      * Define the campaign you want to update in pardot.
      * @param campaign The campaign you want to update in pardot.
+     * @return CampaignUpdateRequest builder.
      */
     public CampaignUpdateRequest withCampaign(final Campaign campaign) {
         setParam("id", campaign.getId());

src/main/java/com/darksci/pardot/api/request/email/EmailReadRequest.java

@@ -21,6 +21,7 @@ public EmailReadRequest selectById(final Long id) {
      * When set to false, the email will not include the html nor text body message.
      * Defaults to true.
      * @param includeMessage Should the response include the html and text bodies.
+     * @return EmailReadRequest builder.
      */
     public EmailReadRequest withIncludeMessageInResponse(boolean includeMessage) {
         String value = "true";

src/main/java/com/darksci/pardot/api/request/email/EmailSendOneToOneRequest.java

@@ -93,7 +93,7 @@ public EmailSendOneToOneRequest withFromAssignedUser(final boolean sendFromAssig
      * @param sendFromAccountOwner True to send from Prospect's account owner, false if not.
      * @return RequestBuilder
      */
-    public EmailSendListRequest withFromAccountOwner(final boolean sendFromAccountOwner) {
+    public EmailSendOneToOneRequest withFromAccountOwner(final boolean sendFromAccountOwner) {
         return setBooleanParam("from_account_owner", sendFromAccountOwner);
     }
 

src/main/java/com/darksci/pardot/api/request/user/UserReadRequest.java

@@ -15,6 +15,7 @@ public String getApiEndpoint() {
     /**
      * Returns the data for the user specified by email.
      * @param email The email address of the target user.
+     * @return UserReadRequest builder.
      */
     public UserReadRequest selectByEmail(final String email) {
         if (email != null) {
@@ -26,6 +27,7 @@ public UserReadRequest selectByEmail(final String email) {
     /**
      * Returns the data for the user specified by id.
      * @param id The Pardot ID of the target user.
+     * @return UserReadRequest builder.
      */
     public UserReadRequest selectById(final Long id) {
         if (id != null) {

src/main/java/com/darksci/pardot/api/rest/HttpClientRestClient.java

@@ -300,76 +300,109 @@ public LoginResponse authenticate() {
 
     /**
      * Make API request to query one or more users.
+     * @param request Request definition.
+     * @return Parsed user query response.
+     * @throws IOException on parse errors.
      */
-    public UserQueryResponse.Result userQuery(final UserQueryRequest userQueryRequest) throws IOException {
-        return post(userQueryRequest, new UserQueryResponseHandler());
+    public UserQueryResponse.Result userQuery(final UserQueryRequest request) throws IOException {
+        return post(request, new UserQueryResponseHandler());
     }
 
     /**
      * Make API request to read the abilities of the currently authenticated user.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
-    public UserAbilitiesResponse.Result userAbilities(final UserAbilitiesRequest userAbilitiesRequest) throws IOException {
-        return post(userAbilitiesRequest, new UserAbilitiesHandler());
+    public UserAbilitiesResponse.Result userAbilities(final UserAbilitiesRequest request) throws IOException {
+        return post(request, new UserAbilitiesHandler());
     }
 
     /**
      * Make API request to read a specific user.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
-    public User userRead(final UserReadRequest readRequest) throws IOException {
-        return post(readRequest, new UserReadResponseHandler());
+    public User userRead(final UserReadRequest request) throws IOException {
+        return post(request, new UserReadResponseHandler());
     }
 
     /**
      * Make API request to query for one or more campaigns.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public CampaignQueryResponse.Result campaignQuery(final CampaignQueryRequest request) throws IOException {
         return post(request, new CampaignQueryResponseHandler());
     }
 
     /**
      * Make API request to read a specific campaign.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public Campaign campaignRead(final CampaignReadRequest request) throws IOException {
         return post(request, new CampaignReadResponseHandler());
     }
 
     /**
      * Make API request to create a new Campaign.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public Campaign campaignCreate(final CampaignCreateRequest request) throws IOException {
         return post(request, new CampaignReadResponseHandler());
     }
 
     /**
      * Make API request to update an existing Campaign.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public Campaign campaignUpdate(final CampaignUpdateRequest request) throws IOException {
         return post(request, new CampaignReadResponseHandler());
     }
 
     /**
      * Make API request to read a specific Email.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public Email emailRead(final EmailReadRequest request) throws IOException {
         return post(request, new EmailReadResponseHandler());
     }
 
     /**
      * Make API request to retrieve stats about a List Email Send.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public EmailStatsResponse.Stats emailStats(final EmailStatsRequest request) throws IOException {
         return post(request, new EmailStatsResponseHandler());
     }
 
     /**
      * Make API request to send a 1-to-1 prospect email.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public Email emailSendOneToOne(final EmailSendOneToOneRequest request) throws IOException {
         return post(request, new EmailReadResponseHandler());
     }
 
     /**
      * Make API request to send a list email.
+     * @param request Request definition.
+     * @return Parsed api response.
+     * @throws IOException on parse errors.
      */
     public Email emailSendList(final EmailSendListRequest request) throws IOException {
         return post(request, new EmailReadResponseHandler());