Skip to content

Commit

Permalink
prepares release
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Wilson committed Dec 14, 2021
1 parent 58fc6c9 commit 7c770b2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 deletions.
41 changes: 20 additions & 21 deletions libs/sparkpost-lib/src/main/java/com/sparkpost/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,38 @@
* This java API is designed to follow closely the design of the SparkPost
* REST API. As a result, this java library is composed of 3 groups of java classes:<br>
* <ul>
* <li> com.sparkpost.resources.ResourceXXX classes
* <li> com.sparkpost.model classes (Data Transfer Objects)
* <li> REST mechanism classes.
* <li>com.sparkpost.resources.ResourceXXX classes
* <li>com.sparkpost.model classes (Data Transfer Objects)
* <li>REST mechanism classes.
* </ul>
* <br>
* <br>
* <h1> Resources classes </h1><br>
* <h2>Resources classes</h2><br>
* A resource class is a collection of static methods under one class.<br>
* All of the methods are a 1-to-1 match with an endpoint within a SparkPost REST API.<br>
* <br>
* For instance, the ResourceTransmissions class contains 3 methods:
* <ul>
* <li> create() matches the create endpoint in the transmission API
* <li> retrieve() matches the retrieve endpoint in the transmission API
* <li> list() matches the list endpoint in the transmission API
* <li>create() matches the create endpoint in the transmission API
* <li>retrieve() matches the retrieve endpoint in the transmission API
* <li>list() matches the list endpoint in the transmission API
* </ul>
* See the
* <a href="https://www.sparkpost.com/api#/reference/transmissions"> SparkPost Transmission API</a>. <br>
* See the
* <a href="https://www.sparkpost.com/api#/reference/transmissions"> SparkPost Transmission API</a>. <br>
* <br>
* <h1> Data Transfer Objects </h1><br>
* <h2>Data Transfer Objects</h2><br>
* A DTO class is a container of fields which intent is to be serialized into
* a JSON string when sending a request to a SparkPost API.<br>
* <br>
* For instance, the Sending Domains resource ( class ResourceSendingDomains )
* has a create() method that matches the create endpoint in the SparkPost
* has a create() method that matches the create endpoint in the SparkPost
* Sending Domains API.<br>
* To create a domain, the JSON request to the SparkPost API is made of 2 fields:<br>
* <ul>
* <li> the domain name
* <li> the DKIM information
* <li>the domain name
* <li>the DKIM information
* </ul>
* We could have designed this java library to merely accept these fields in the
* We could have designed this java library to merely accept these fields in the
* method signature , for instance here ResourceSendingDomains.create would
* have become ResourceSendingDomains.create( String domain, String dkim_info).<br>
* Only in most cases the request parameters are numerous, and passing them
Expand All @@ -46,13 +46,13 @@
* ResourceSendingDomains.create( RestConnection connection, SendingDomain domain)<br>
* (connection is the server connection to use to make the request, see below)<br>
* <br>
* <h1>REST mechanism classes</h1><br>
* <h2>REST mechanism classes</h2><br>
* There are 4 classes necessary to put in place our REST system :
* <ul>
* <li> Client
* <li> RestConnection
* <li> Response
* <li> SparkPostException
* <li>Client
* <li>RestConnection
* <li>Response
* <li>SparkPostException
* </ul>
* <br>
* Client define information specific to the SparkPost client: the
Expand All @@ -69,6 +69,5 @@
* It also implements a simple JSON-to-Java deserialization using Google's
* Gson class.
*/
package com.sparkpost ;


package com.sparkpost;
2 changes: 1 addition & 1 deletion tools/bin/collectJars.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Do everything relative to the tools/bin directory
cd "$(dirname $0)"

VERSION=0.23
VERSION=0.24

cd ../..

Expand Down

0 comments on commit 7c770b2

Please sign in to comment.