SDK-2521: Support detected document_type in IDV Sandbox SDK

getyoti · Sep 23, 2024 · 1421c8e · 1421c8e
1 parent 1538ee0
commit 1421c8e
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 2 deletions.
diff --git a/...sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/SandboxDocumentFilter.java b/...sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/SandboxDocumentFilter.java
@@ -5,6 +5,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 public class SandboxDocumentFilter {

diff --git a/...x/src/main/java/com/yoti/api/client/sandbox/docs/request/task/SandboxDocumentIdPhoto.java b/...x/src/main/java/com/yoti/api/client/sandbox/docs/request/task/SandboxDocumentIdPhoto.java
@@ -1,7 +1,9 @@
 package com.yoti.api.client.sandbox.docs.request.task;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class SandboxDocumentIdPhoto {
 
     @JsonProperty("content_type")

diff --git a/.../com/yoti/api/client/sandbox/docs/request/task/SandboxDocumentTextDataExtractionTask.java b/.../com/yoti/api/client/sandbox/docs/request/task/SandboxDocumentTextDataExtractionTask.java
@@ -46,6 +46,7 @@ public static class Builder {
         private SandboxDocumentFilter documentFilter;
         private SandboxDocumentIdPhoto documentIdPhoto;
         private String detectedCountry;
+        private String detectedDocumentType;
         private SandboxTextExtractionTaskRecommendation recommendation;
 
         private Builder() {
@@ -82,14 +83,22 @@ public Builder withDetectedCountry(String detectedCountry) {
             return this;
         }
 
+        public Builder withDetectedDocumentType(String detectedDocumentType) {
+            this.detectedDocumentType = detectedDocumentType;
+            return this;
+        }
+
         public Builder withRecommendation(SandboxTextExtractionTaskRecommendation recommendation) {
             this.recommendation = recommendation;
             return this;
         }
 
         public SandboxDocumentTextDataExtractionTask build() {
-            SandboxDocumentTextDataExtractionTaskResult result = new SandboxDocumentTextDataExtractionTaskResult(documentFields, this.documentIdPhoto,
-                    detectedCountry, recommendation);
+            SandboxDocumentTextDataExtractionTaskResult result = new SandboxDocumentTextDataExtractionTaskResult(documentFields,
+                    documentIdPhoto,
+                    detectedCountry,
+                    detectedDocumentType,
+                    recommendation);
             return new SandboxDocumentTextDataExtractionTask(result, documentFilter);
         }
     }

diff --git a/...oti/api/client/sandbox/docs/request/task/SandboxDocumentTextDataExtractionTaskResult.java b/...oti/api/client/sandbox/docs/request/task/SandboxDocumentTextDataExtractionTaskResult.java
@@ -2,8 +2,10 @@
 
 import java.util.Map;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class SandboxDocumentTextDataExtractionTaskResult {
 
     @JsonProperty("document_fields")
@@ -15,16 +17,21 @@ public class SandboxDocumentTextDataExtractionTaskResult {
     @JsonProperty("detected_country")
     private final String detectedCountry;
 
+    @JsonProperty("detected_document_type")
+    private final String detectedDocumentType;
+
     @JsonProperty("recommendation")
     private final SandboxTextExtractionTaskRecommendation recommendation;
 
     SandboxDocumentTextDataExtractionTaskResult(Map<String, Object> documentFields,
             SandboxDocumentIdPhoto documentIdPhoto,
             String detectedCountry,
+            String detectedDocumentType,
             SandboxTextExtractionTaskRecommendation recommendation) {
         this.documentFields = documentFields;
         this.documentIdPhoto = documentIdPhoto;
         this.detectedCountry = detectedCountry;
+        this.detectedDocumentType = detectedDocumentType;
         this.recommendation = recommendation;
     }
 
@@ -40,6 +47,10 @@ public String getDetectedCountry() {
         return detectedCountry;
     }
 
+    public String getDetectedDocumentType() {
+        return detectedDocumentType;
+    }
+
     public SandboxTextExtractionTaskRecommendation getRecommendation() {
         return recommendation;
     }

diff --git a/...client/sandbox/docs/request/task/SandboxSupplementaryDocTextDataExtractionTaskResult.java b/...client/sandbox/docs/request/task/SandboxSupplementaryDocTextDataExtractionTaskResult.java
@@ -2,8 +2,10 @@
 
 import java.util.Map;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class SandboxSupplementaryDocTextDataExtractionTaskResult {
 
     @JsonProperty("document_fields")

diff --git a/...n/java/com/yoti/api/client/sandbox/docs/request/task/SandboxTextExtractionTaskReason.java b/...n/java/com/yoti/api/client/sandbox/docs/request/task/SandboxTextExtractionTaskReason.java
@@ -2,8 +2,10 @@
 
 import com.yoti.api.client.sandbox.docs.SandboxDocScanConstants;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class SandboxTextExtractionTaskReason {
 
     @JsonProperty("value")