SDK-2340: Allow Relying Business to configure if expanded document fi…

…elds should be created for a text-extraction task
getyoti · Sep 23, 2024 · a3a77b1 · a3a77b1
1 parent e5c0b03
commit a3a77b1
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2 deletions.
diff --git a/...n/java/com/yoti/api/client/docs/session/create/task/RequestedIdDocTextExtractionTask.java b/...n/java/com/yoti/api/client/docs/session/create/task/RequestedIdDocTextExtractionTask.java
@@ -31,6 +31,7 @@ public static class Builder {
 
         private String manualCheck;
         private String chipData;
+        private Boolean createExpandedDocumentFields;
 
         public Builder withManualCheckAlways() {
             this.manualCheck = DocScanConstants.ALWAYS;
@@ -57,8 +58,13 @@ public Builder withChipDataIgnore() {
             return this;
         }
 
+        public Builder withCreateExpandedDocumentFields(boolean value) {
+            this.createExpandedDocumentFields = value;
+            return this;
+        }
+
         public RequestedIdDocTextExtractionTask build() {
-            RequestedIdDocTextExtractionTaskConfig config = new RequestedIdDocTextExtractionTaskConfig(manualCheck, chipData);
+            RequestedIdDocTextExtractionTaskConfig config = new RequestedIdDocTextExtractionTaskConfig(manualCheck, chipData, createExpandedDocumentFields);
             return new RequestedIdDocTextExtractionTask(config);
         }
 

diff --git a/.../com/yoti/api/client/docs/session/create/task/RequestedIdDocTextExtractionTaskConfig.java b/.../com/yoti/api/client/docs/session/create/task/RequestedIdDocTextExtractionTaskConfig.java
@@ -13,9 +13,13 @@ public class RequestedIdDocTextExtractionTaskConfig implements RequestedTaskConf
     @JsonProperty("chip_data")
     private final String chipData;
 
-    RequestedIdDocTextExtractionTaskConfig(String manualCheck, String chipData) {
+    @JsonProperty("create_expanded_document_fields")
+    private final Boolean createExpandedDocumentFields;
+
+    RequestedIdDocTextExtractionTaskConfig(String manualCheck, String chipData, Boolean createExpandedDocumentFields) {
         this.manualCheck = manualCheck;
         this.chipData = chipData;
+        this.createExpandedDocumentFields = createExpandedDocumentFields;
     }
 
     /**
@@ -37,4 +41,14 @@ public String getChipData() {
         return chipData;
     }
 
+    /**
+     * Describes if expanded document fields should be created for a text-extraction task
+     * in the session.
+     *
+     * @return if expanded document fields should be created
+     */
+    public Boolean getCreateExpandedDocumentFields() {
+        return createExpandedDocumentFields;
+    }
+
 }
diff --git a/...va/com/yoti/api/client/docs/session/create/task/RequestedIdDocTextExtractionTaskTest.java b/...va/com/yoti/api/client/docs/session/create/task/RequestedIdDocTextExtractionTaskTest.java
@@ -63,4 +63,14 @@ public void shouldBuildSimpleRequestedTextExtractionTaskWithChipDataIgnore() {
         assertThat(configResult.getChipData(), is("IGNORE"));
     }
 
+    @Test
+    public void shouldBuildSimpleRequestedTextExtractionTaskWithCreateExpandedDocumentFields() {
+        RequestedIdDocTextExtractionTask result = RequestedIdDocTextExtractionTask.builder()
+                .withCreateExpandedDocumentFields(true)
+                .build();
+
+        RequestedIdDocTextExtractionTaskConfig configResult = result.getConfig();
+        assertThat(configResult.getCreateExpandedDocumentFields(), is(true));
+    }
+
 }