|
5 | 5 | * This java API is designed to follow closely the design of the SparkPost |
6 | 6 | * REST API. As a result, this java library is composed of 3 groups of java classes:<br> |
7 | 7 | * <ul> |
8 | | - * <li> com.sparkpost.resources.ResourceXXX classes |
9 | | - * <li> com.sparkpost.model classes (Data Transfer Objects) |
10 | | - * <li> REST mechanism classes. |
| 8 | + * <li>com.sparkpost.resources.ResourceXXX classes |
| 9 | + * <li>com.sparkpost.model classes (Data Transfer Objects) |
| 10 | + * <li>REST mechanism classes. |
11 | 11 | * </ul> |
12 | 12 | * <br> |
13 | 13 | * <br> |
14 | | - * <h1> Resources classes </h1><br> |
| 14 | + * <h2>Resources classes</h2><br> |
15 | 15 | * A resource class is a collection of static methods under one class.<br> |
16 | 16 | * All of the methods are a 1-to-1 match with an endpoint within a SparkPost REST API.<br> |
17 | 17 | * <br> |
18 | 18 | * For instance, the ResourceTransmissions class contains 3 methods: |
19 | 19 | * <ul> |
20 | | - * <li> create() matches the create endpoint in the transmission API |
21 | | - * <li> retrieve() matches the retrieve endpoint in the transmission API |
22 | | - * <li> list() matches the list endpoint in the transmission API |
| 20 | + * <li>create() matches the create endpoint in the transmission API |
| 21 | + * <li>retrieve() matches the retrieve endpoint in the transmission API |
| 22 | + * <li>list() matches the list endpoint in the transmission API |
23 | 23 | * </ul> |
24 | | - * See the |
25 | | - * <a href="https://www.sparkpost.com/api#/reference/transmissions"> SparkPost Transmission API</a>. <br> |
| 24 | + * See the |
| 25 | + * <a href="https://www.sparkpost.com/api#/reference/transmissions"> SparkPost Transmission API</a>. <br> |
26 | 26 | * <br> |
27 | | - * <h1> Data Transfer Objects </h1><br> |
| 27 | + * <h2>Data Transfer Objects</h2><br> |
28 | 28 | * A DTO class is a container of fields which intent is to be serialized into |
29 | 29 | * a JSON string when sending a request to a SparkPost API.<br> |
30 | 30 | * <br> |
31 | 31 | * For instance, the Sending Domains resource ( class ResourceSendingDomains ) |
32 | | - * has a create() method that matches the create endpoint in the SparkPost |
| 32 | + * has a create() method that matches the create endpoint in the SparkPost |
33 | 33 | * Sending Domains API.<br> |
34 | 34 | * To create a domain, the JSON request to the SparkPost API is made of 2 fields:<br> |
35 | 35 | * <ul> |
36 | | - * <li> the domain name |
37 | | - * <li> the DKIM information |
| 36 | + * <li>the domain name |
| 37 | + * <li>the DKIM information |
38 | 38 | * </ul> |
39 | | - * We could have designed this java library to merely accept these fields in the |
| 39 | + * We could have designed this java library to merely accept these fields in the |
40 | 40 | * method signature , for instance here ResourceSendingDomains.create would |
41 | 41 | * have become ResourceSendingDomains.create( String domain, String dkim_info).<br> |
42 | 42 | * Only in most cases the request parameters are numerous, and passing them |
|
46 | 46 | * ResourceSendingDomains.create( RestConnection connection, SendingDomain domain)<br> |
47 | 47 | * (connection is the server connection to use to make the request, see below)<br> |
48 | 48 | * <br> |
49 | | - * <h1>REST mechanism classes</h1><br> |
| 49 | + * <h2>REST mechanism classes</h2><br> |
50 | 50 | * There are 4 classes necessary to put in place our REST system : |
51 | 51 | * <ul> |
52 | | - * <li> Client |
53 | | - * <li> RestConnection |
54 | | - * <li> Response |
55 | | - * <li> SparkPostException |
| 52 | + * <li>Client |
| 53 | + * <li>RestConnection |
| 54 | + * <li>Response |
| 55 | + * <li>SparkPostException |
56 | 56 | * </ul> |
57 | 57 | * <br> |
58 | 58 | * Client define information specific to the SparkPost client: the |
|
69 | 69 | * It also implements a simple JSON-to-Java deserialization using Google's |
70 | 70 | * Gson class. |
71 | 71 | */ |
72 | | -package com.sparkpost ; |
73 | | - |
74 | 72 |
|
| 73 | +package com.sparkpost; |
0 commit comments