add tests

Author: JW Wesson

src/main/java/com/textkernel/tx/TxClient.java

@@ -45,6 +45,7 @@
 import com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponse;
 import com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponse;
 import com.textkernel.tx.models.api.formatter.FormatResumeRequest;
+import com.textkernel.tx.models.api.formatter.FormatResumeResponse;
 import com.textkernel.tx.models.api.geocoding.*;
 import com.textkernel.tx.models.api.indexes.*;
 import com.textkernel.tx.models.api.jobdescription.GenerateJobRequest;
@@ -289,6 +290,12 @@ public GetAccountInfoResponse getAccountInfo() throws TxException {
         return response.getData();
     }
 
+    /**
+     * Format a resume into a standardized template that you provide
+     * @param request The request body
+     * @return The API response body
+     * @throws TxException Thrown when an API error occurs
+     */
     public FormatResumeResponse formatResume(FormatResumeRequest request) throws TxException {
         RequestBody body = createJsonBody(request);
         Request apiRequest = new Request.Builder()

src/main/java/com/textkernel/tx/models/api/formatter/FormatResumeRequest.java

@@ -21,7 +21,7 @@ public class FormatResumeRequest {
     /** 
      * A base64-encoded string of the DOCX template document file bytes. This should use the standard 'base64'
      * encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant).
-     * <p>Java users can use {@link java.util.Base64#getEncoder()} and then {@link java.util.Base64.Encoder#encodeToString(byte[])}
+     * <p>Java users can use {@link java.util.Base64.Encoder#encodeToString(byte[])}
      * <p>For more information on creating custom templates, see
      * <a href="https://developer.textkernel.com/tx-platform/v10/resume-formatter/creating-custom-templates/">here</a>
      */

src/main/java/com/textkernel/tx/models/api/formatter/FormatResumeResponseValue.java

@@ -13,8 +13,8 @@
 public class FormatResumeResponseValue {
     /**
      * The formatted resume document (either PDF or DOCX).
-     * This is a byte[] as a Base64-encoded string. You can use
-     * {@link java.util.Base64.Decoder#decode(String)} to get a byte[] to save to disk.
+     * This is a {@code byte[]} as a Base64-encoded string. You can use
+     * {@link java.util.Base64.Decoder#decode(String)} to get a {@code byte[]} to save to disk.
      */
     public String DocumentAsBase64String;
 }

src/test/java/com/textkernel/tx/integration/FormatterTests.java

@@ -0,0 +1,31 @@
+// Copyright © 2023 Textkernel BV. All rights reserved.
+// This file is provided for use by, or on behalf of, Textkernel licensees
+// within the terms of their license of Textkernel products or Textkernel customers
+// within the Terms of Service pertaining to the Textkernel SaaS products.
+
+package com.textkernel.tx.integration;
+
+import com.textkernel.tx.TestBase;
+import com.textkernel.tx.models.api.formatter.FormatResumeRequest;
+import com.textkernel.tx.models.api.formatter.FormatResumeResponse;
+import com.textkernel.tx.models.api.formatter.OutputDocumentFormat;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+public class FormatterTests extends TestBase {
+    @Test
+    public void testFormatResume() {
+        assertDoesNotThrow(() -> {
+
+            String templateStr = getTestFileAsDocument("template1.docx").getAsBase64();
+            byte[] templateBytes = java.util.Base64.getDecoder().decode(templateStr);
+
+            FormatResumeRequest request = new FormatResumeRequest(TestParsedResume, templateBytes, OutputDocumentFormat.DOCX);
+            FormatResumeResponse response = Client.formatResume(request);
+
+            assertNotNull(response.Value.DocumentAsBase64String);
+        });
+    }
+}