Embedded signing has been implemented to java library

client-lib/pom.xml

@@ -5,14 +5,14 @@
 
     <groupId>com.signnow</groupId>
     <artifactId>api-client-lib</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.1-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <java.version>1.8</java.version>
-        <maven.compiler.source>1.8</maven.compiler.source>
-        <maven.compiler.target>1.8</maven.compiler.target>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
     </properties>
 
     <dependencies>

client-lib/src/main/java/com/signnow/library/SNClient.java

@@ -110,10 +110,16 @@ public <E, T> T delete(String path, Map<String, String> parameters, Class<T> ret
         return response.readEntity(returnType);
     }
 
+    public int delete(String path, Map<String, String> parameters) throws SNException {
+        Response response = buildRequest(path, parameters).delete();
+        checkAPIException(response);
+        return response.getStatus();
+    }
+
     private Invocation.Builder buildRequest(String path, Map<String, String> parameters) {
         WebTarget target = apiWebTarget.path(path);
         if (parameters != null) {
-            for (String key : parameters.keySet()){
+            for (String key : parameters.keySet()) {
                 WebTarget targetUpd = target.resolveTemplate(key, parameters.get(key));
                 if (!targetUpd.toString().equals(target.toString())) {
                     target = targetUpd;

client-lib/src/main/java/com/signnow/library/dto/Document.java

@@ -3,7 +3,9 @@
 import com.fasterxml.jackson.annotation.*;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class Document extends GenericId {
@@ -17,6 +19,15 @@ public class Document extends GenericId {
     public String updated;
     @JsonProperty("original_filename")
     public String originalFilename;
+    @JsonProperty("origin_document_id")
+    public String originDocumentId;
+    public String owner;
+    @JsonProperty(value = "template", defaultValue = "false")
+    public boolean template;
+    public Thumbnail thumbnail;
+    public List<Signature> signatures;
+    public List<Tag> tags;
+    public List<DocumentField> fields;
     @JsonProperty("version_time")
     public String versionTime;
     /**
@@ -28,6 +39,7 @@ public class Document extends GenericId {
      * Free form invites info
      */
     public List<DocumentSignRequestInfo> requests;
+    public List<Role> roles;
 
     public static class SigningLinkRequest {
         @JsonProperty("document_id")
@@ -38,6 +50,75 @@ public SigningLinkRequest(String documentId) {
         }
     }
 
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class Thumbnail {
+        public String small;
+        public String medium;
+        public String large;
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class Signature {
+        public String id;
+        @JsonProperty("user_id")
+        public String userId;
+        public String email;
+        @JsonProperty("page_number")
+        public String pageNumber;
+        public String width;
+        public String height;
+        public String x;
+        public String y;
+        public String created;
+        public String data;
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class DocumentField {
+        public String id;
+        public FieldType type;
+        @JsonProperty("role_id")
+        public String roleId;
+        public String role;
+        public String originator;
+        public String fulfiller;
+        @JsonProperty("field_request_id")
+        public String fieldRequestId;
+        @JsonProperty("element_id")
+        public String elementId;
+        @JsonProperty("field_request_canceled")
+        public String fieldRequestCanceled;
+        @JsonProperty("template_field_id")
+        public String fieldTemplateId;
+        @JsonProperty("field_id")
+        public String fieldId;
+        @JsonIgnore
+        public Map<String, String> attributes = new HashMap<>();
+
+        @JsonAnyGetter
+        public void setAttribute(final String key, final Object value) {
+            if (value == null) {
+                attributes.put(key, null);
+            } else {
+                attributes.put(key, value.toString());
+            }
+        }
+    }
+
+    public static class Role {
+        @JsonProperty("unique_id")
+        public String uniqueId;
+        @JsonProperty("signing_order")
+        public String signingOrder;
+        public String name;
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class Tag {
+        public String type;
+        public String name;
+    }
+
     @JsonIgnoreProperties(ignoreUnknown = true)
     public static class SigningLinkResponce {
         public String url;
@@ -110,7 +191,6 @@ public enum FieldType {
             this.name = name;
         }
 
-        @JsonSetter
         public static FieldType typeOf(String name) {
             for (FieldType type : values()) {
                 if (type.name.equalsIgnoreCase(name)) {
@@ -120,6 +200,11 @@ public static FieldType typeOf(String name) {
             throw new IllegalArgumentException(name + " field not supported.");
         }
 
+        @JsonValue
+        public String getType() {
+            return name;
+        }
+
         @JsonCreator
         @Override
         public String toString() {
@@ -175,4 +260,91 @@ public static class DocumentDownloadLink {
         public String link;
     }
 
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class EmbeddedInviteResponse {
+        public List<EmbeddedInviteResult> data = new ArrayList<>();
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class EmbeddedInviteResult {
+        public String id;
+        public String email;
+        public String role_id;
+        public int order;
+        public String status;
+    }
+
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public static class EmbeddedInviteRequest {
+        public List<EmbeddedInvite> invites = new ArrayList<>();
+    }
+
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public static class EmbeddedInvite {
+        public String email;
+        public String role_id;
+        public int order;
+        public String auth_method;
+
+        public EmbeddedInvite() {
+        }
+
+        public EmbeddedInvite(String email, String role_id, int order, String auth_method) {
+            this.email = email;
+            this.role_id = role_id;
+            this.order = order;
+            this.auth_method = auth_method;
+        }
+    }
+
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public static class GenerateEmbeddedSigningLinkRequest {
+        public String auth_method;
+        public int link_expiration;
+    }
+
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public static class GenerateEmbeddedSigningLinkResponse {
+        public LinkData data;
+    }
+
+    public static class LinkData {
+        public String link;
+    }
+
+    public enum AuthMethod {
+        PASSWORD("password"),
+        EMAIL("email"),
+        MFA("mfa"),
+        SOCIAL("social"),
+        BIOMETRIC("biometric"),
+        OTHER("other"),
+        NONE("none");
+
+        private final String method;
+
+        AuthMethod(String method) {
+            this.method = method;
+        }
+
+        public static AuthMethod getAuthMethod(final String authMethod) {
+            for (AuthMethod value : values()) {
+                if (value.method.equalsIgnoreCase(authMethod)) {
+                    return value;
+                }
+            }
+            throw new EnumConstantNotPresentException(AuthMethod.class, authMethod);
+        }
+
+        @JsonValue
+        public String getAuthMethod() {
+            return method;
+        }
+
+        @JsonCreator
+        @Override
+        public String toString() {
+            return method;
+        }
+    }
 }

client-lib/src/main/java/com/signnow/library/facades/Documents.java

@@ -29,4 +29,20 @@ public interface Documents {
     void deleteDocument(String documentId) throws SNException;
 
     String getDownloadLink(String documentId) throws SNException;
+
+    Document.EmbeddedInviteResponse createEmbeddedInvites(final String documentId,
+                                                          final Document.EmbeddedInviteRequest request) throws SNException;
+
+    Document.GenerateEmbeddedSigningLinkResponse generateEmbeddedInviteLink(final String documentId,
+                                                                            final String fieldId,
+                                                                            final Document.GenerateEmbeddedSigningLinkRequest request) throws SNException;
+
+    /**
+     * All embedded invites created for the document will be deleted.
+     *
+     * @param documentId the documentId of the document containing embedded invites.
+     * @return the 204 status code will be return if the embedded invites have been deleted successfully.
+     * @throws SNException
+     */
+    int deleteEmbeddedInvite(final String documentId) throws SNException;
 }

client-lib/src/main/java/com/signnow/library/services/DocumentsService.java

@@ -15,6 +15,7 @@
 import java.io.InputStream;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 
 public class DocumentsService extends ApiService implements Documents {
     public DocumentsService(SNClient client) {
@@ -109,4 +110,32 @@ public String getDownloadLink(String documentId) throws SNException {
                 Document.DocumentDownloadLink.class
         ).link;
     }
+
+    @Override
+    public Document.EmbeddedInviteResponse createEmbeddedInvites(String documentId, Document.EmbeddedInviteRequest request) throws SNException {
+        return client.post(
+                "/v2/documents/{documentUniqueId}/embedded-invites",
+                Collections.singletonMap("documentUniqueId", documentId),
+                request,
+                Document.EmbeddedInviteResponse.class
+        );
+    }
+
+    @Override
+    public Document.GenerateEmbeddedSigningLinkResponse generateEmbeddedInviteLink(String documentId, String fieldId, Document.GenerateEmbeddedSigningLinkRequest request) throws SNException {
+        return client.post(
+                "/v2/documents/{document_id}/embedded-invites/{fieldInviteUniqueId}/link",
+                Map.of("document_id", documentId, "fieldInviteUniqueId", fieldId),
+                request,
+                Document.GenerateEmbeddedSigningLinkResponse.class
+        );
+    }
+
+    @Override
+    public int deleteEmbeddedInvite(String documentId) throws SNException {
+        return client.delete(
+                "/v2/documents/{document_id}/embedded-invites",
+                Collections.singletonMap("document_id", documentId)
+        );
+    }
 }

client-lib/src/test/java/com/signnow/library/services/DocumentsServiceTest.java

@@ -7,7 +7,6 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentMatchers;
-import org.mockito.Matchers;
 
 import javax.ws.rs.client.WebTarget;
 import javax.ws.rs.core.GenericType;
@@ -19,7 +18,7 @@
 import java.util.List;
 import java.util.Random;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.Mockito.*;
 
 class DocumentsServiceTest extends CommonServiceTestCase {
@@ -162,6 +161,16 @@ void getDownloadLink() throws SNException {
                 , eq(Document.DocumentDownloadLink.class));
     }
 
+    @Test
+    void createEmbeddedInvites() throws SNException {
+        Document.EmbeddedInviteResponse response = mock(Document.EmbeddedInviteResponse.class);
+        Document.EmbeddedInviteRequest request = mock(Document.EmbeddedInviteRequest.class);
+        when(clientMock.post(anyString(), anyMap(), eq(request), eq(Document.EmbeddedInviteResponse.class))).thenReturn(response);
+        service.createEmbeddedInvites("1", request);
+        verify(clientMock, times(1))
+                .post(anyString(), anyMap(), eq(request), eq(Document.EmbeddedInviteResponse.class));
+    }
+
     private InputStream getSomeInputStream() {
         byte[] bytes = new byte[25];
         Random rnd = new Random();
@@ -204,4 +213,4 @@ private void verify_uploadDocument() {
         verify(builderMock, times(1)).header(anyString(), any());
         verify(builderMock, times(1)).post(any());
     }
-}
+}

example-app/pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>com.signnow</groupId>
     <artifactId>api-example-app</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.1-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <parent>
@@ -17,7 +17,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <java.version>1.8</java.version>
+        <java.version>11</java.version>
     </properties>
 
     <dependencies>
@@ -40,6 +40,17 @@
             <version>${project.version}</version>
         </dependency>
 
+        <!-- https://mvnrepository.com/artifact/org.webjars/highlightjs -->
+        <dependency>
+            <groupId>org.webjars</groupId>
+            <artifactId>highlightjs</artifactId>
+            <version>10.1.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.webjars</groupId>
+            <artifactId>webjars-locator-core</artifactId>
+        </dependency>
+
     </dependencies>
 
     <build>