Skip to content

Commit 317a740

Browse files
committed
Corrected javadocs
1 parent b9ed976 commit 317a740

6 files changed

Lines changed: 12 additions & 11 deletions

File tree

pom.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,10 @@
126126
<plugin>
127127
<groupId>org.apache.maven.plugins</groupId>
128128
<artifactId>maven-javadoc-plugin</artifactId>
129-
<version>2.9.1</version>
129+
<version>3.11.3</version>
130130
<configuration>
131-
<source>8</source>
131+
<source>17</source>
132+
132133
</configuration>
133134
<executions>
134135
<execution>

src/main/java/com/twikey/DocumentGateway.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public DocumentResponse.MandateCreationResponse create(DocumentRequests.InviteRe
7979
}
8080

8181
/**
82-
* See <a href="https://www.twikey.com/api/#invite-a-customer">Twikey API - Mandate Invite</a></p>
82+
* See <a href="https://www.twikey.com/api/#invite-a-customer">Twikey API - Mandate Invite</a>
8383
*
8484
* Same parameters as invite, but some extra might be required depending on the method
8585
* <ul>
@@ -178,7 +178,7 @@ public void action(DocumentRequests.MandateActionRequest action) throws IOExcept
178178
* or <code>email</code> is required.</p>
179179
* @return A list of {@link DocumentResponse.Document} objects containing mandate details
180180
* that match the query.
181-
* @throws Exception if the request fails
181+
* @throws IOException if the request fails
182182
* @throws TwikeyClient.UserException if the API returns a user-related error
183183
*/
184184
public List<DocumentResponse.Document> query(DocumentRequests.MandateQuery action) throws IOException, TwikeyClient.UserException {
@@ -255,7 +255,7 @@ public void cancel(String mandateNumber, String reason, boolean notify) throws I
255255
*
256256
* @param fetch An object representing information for identifying the mandate.
257257
* @return A structured response object representing the server’s reply.
258-
* @throws Exception If the API call fails or the identifier is invalid.
258+
* @throws IOException If the API call fails or the identifier is invalid.
259259
* @throws TwikeyClient.UserException If the API returns an error.
260260
*/
261261
public DocumentResponse.Document fetch(DocumentRequests.MandateDetailRequest fetch) throws IOException, TwikeyClient.UserException {

src/main/java/com/twikey/InvoiceGateway.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ public String createBatch(InvoiceRequests.BulkInvoiceRequest batch) throws IOExc
282282
* whether invoices were successfully created or failed during batch upload.
283283
*
284284
* @param batchId The unique batch ID returned when the bulk invoice upload was created.
285-
* @return Map<String, String> A mapping of invoice identifiers to their respective statuses.
285+
* @return BulkInvoiceDetail containing invoice identifiers to their respective statuses.
286286
* @throws IOException If a network error occurs while making the request.
287287
* @throws TwikeyClient.UserException If the API rejects the request or returns a user-related error.
288288
*/

src/main/java/com/twikey/modal/DocumentRequests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ public InviteRequest(long ct) {
238238
}
239239

240240
/**
241-
* Convert this request to a flat Map<String,String> suitable for the API.
241+
* Convert this request to a flat Map suitable for the API.
242242
*/
243243
public Map<String, String> toRequest() {
244244
Map<String, String> result = new HashMap<>();
@@ -327,7 +327,7 @@ public InviteRequest setPrefix(String prefix) {
327327
return this;
328328
}
329329

330-
public InviteRequest setExpiryd(long epoch) {
330+
public InviteRequest setExpiry(long epoch) {
331331
this.ed = ed;
332332
return this;
333333
}
@@ -764,7 +764,7 @@ public UpdateMandateRequest(String mndtId) {
764764
}
765765

766766
/**
767-
* Convert this request to a flat Map<String,String> suitable for the API.
767+
* Convert this request to a flat Map suitable for the API.
768768
*/
769769
public Map<String, String> toRequest() {
770770
Map<String, String> result = new HashMap<>();

src/main/java/com/twikey/modal/InvoiceRequests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ private static void putIfNotNull(JSONObject json, String key, Object value) {
288288
}
289289

290290
/**
291-
* Convert this request to a flat Map<String,String> suitable for the API.
291+
* Convert this request to a flat JSONObject suitable for the API.
292292
*/
293293
public JSONObject toRequest() {
294294
JSONObject result = new JSONObject();

src/main/java/com/twikey/modal/TransactionRequests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ public Map<String, String> toRequest() {
311311
* <p>Typical usage:</p>
312312
* <pre>
313313
* ActionRequest request = new ActionRequest("345", ActionRequest.Action.REOFFER);
314-
* Map<String, String> params = request.toRequest();
314+
* var params = request.toRequest();
315315
* // pass params into your OkHttp FormBody builder
316316
* </pre>
317317
*

0 commit comments

Comments
 (0)