SDK-2703: Add support for configuring check result, for WATCHLIST_ADVANCED_CA check in the sandbox

Author: MrBurtyyy

yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/SandboxCheckReports.java

@@ -10,6 +10,7 @@
 import static com.yoti.api.client.docs.DocScanConstants.SYNECTICS_IDENTITY_FRAUD;
 import static com.yoti.api.client.docs.DocScanConstants.THIRD_PARTY_IDENTITY;
 import static com.yoti.api.client.docs.DocScanConstants.THIRD_PARTY_IDENTITY_FRAUD_ONE;
+import static com.yoti.api.client.docs.DocScanConstants.WATCHLIST_ADVANCED_CA;
 import static com.yoti.api.client.docs.DocScanConstants.WATCHLIST_SCREENING;
 
 import java.util.ArrayList;
@@ -25,6 +26,7 @@
 import com.yoti.api.client.sandbox.docs.request.check.SandboxSynecticsIdentityFraudCheck;
 import com.yoti.api.client.sandbox.docs.request.check.SandboxThirdPartyIdentityCheck;
 import com.yoti.api.client.sandbox.docs.request.check.SandboxThirdPartyIdentityFraudOneCheck;
+import com.yoti.api.client.sandbox.docs.request.check.SandboxWatchlistAdvancedCaCheck;
 import com.yoti.api.client.sandbox.docs.request.check.SandboxWatchlistScreeningCheck;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -66,6 +68,9 @@ public class SandboxCheckReports {
     @JsonProperty(WATCHLIST_SCREENING)
     private final SandboxWatchlistScreeningCheck watchlistScreeningCheck;
 
+    @JsonProperty(WATCHLIST_ADVANCED_CA)
+    private final List<SandboxWatchlistAdvancedCaCheck> watchlistAdvancedCaChecks;
+
     @JsonProperty("async_report_delay")
     private final Integer asyncReportDelay;
 
@@ -80,6 +85,7 @@ public class SandboxCheckReports {
             List<SandboxSynecticsIdentityFraudCheck> synecticsIdentityFraudChecks,
             SandboxThirdPartyIdentityFraudOneCheck thirdPartyIdentityFraudOneCheck,
             SandboxWatchlistScreeningCheck watchlistScreeningCheck,
+            List<SandboxWatchlistAdvancedCaCheck> watchlistAdvancedCaChecks,
             Integer asyncReportsDelay) {
         this.documentTextDataChecks = documentTextDataChecks;
         this.documentAuthenticityChecks = documentAuthenticityChecks;
@@ -92,6 +98,7 @@ public class SandboxCheckReports {
         this.synecticsIdentityFraudChecks = synecticsIdentityFraudChecks;
         this.thirdPartyIdentityFraudOneCheck = thirdPartyIdentityFraudOneCheck;
         this.watchlistScreeningCheck = watchlistScreeningCheck;
+        this.watchlistAdvancedCaChecks = watchlistAdvancedCaChecks;
         this.asyncReportDelay = asyncReportsDelay;
     }
 
@@ -141,6 +148,10 @@ public SandboxWatchlistScreeningCheck getWatchlistScreeningCheck() {
         return watchlistScreeningCheck;
     }
 
+    public List<SandboxWatchlistAdvancedCaCheck> getWatchlistAdvancedCaChecks() {
+        return watchlistAdvancedCaChecks;
+    }
+
     public Integer getAsyncReportDelay() {
         return asyncReportDelay;
     }
@@ -172,6 +183,8 @@ public static class Builder {
 
         private SandboxWatchlistScreeningCheck watchlistScreeningCheck;
 
+        private List<SandboxWatchlistAdvancedCaCheck> watchlistAdvancedCaChecks = new ArrayList<>();
+
         private Integer asyncReportDelay;
 
         private Builder() {}
@@ -231,6 +244,11 @@ public Builder withWatchlistScreeningCheck(SandboxWatchlistScreeningCheck watchl
             return this;
         }
 
+        public Builder withWatchlistAdvancedCaCheck(SandboxWatchlistAdvancedCaCheck watchlistAdvancedCaCheck) {
+            this.watchlistAdvancedCaChecks.add(watchlistAdvancedCaCheck);
+            return this;
+        }
+
         public Builder withAsyncReportDelay(int asyncReportDelay) {
             this.asyncReportDelay = asyncReportDelay;
             return this;
@@ -239,7 +257,7 @@ public Builder withAsyncReportDelay(int asyncReportDelay) {
         public SandboxCheckReports build() {
             return new SandboxCheckReports(textDataCheck, documentAuthenticityCheck, livenessCheck, documentFaceMatchCheck, idDocumentComparisonCheck,
                     supplementaryDocumentTextDataCheck, thirdPartyIdentityCheck, faceComparisonCheck, synecticsIdentityFraudChecks,
-                    thirdPartyIdentityFraudOneCheck, watchlistScreeningCheck, asyncReportDelay);
+                    thirdPartyIdentityFraudOneCheck, watchlistScreeningCheck, watchlistAdvancedCaChecks, asyncReportDelay);
         }
 
     }

yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCaProfileSourcesFilter.java

@@ -0,0 +1,18 @@
+package com.yoti.api.client.sandbox.docs.request.check;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class SandboxCaProfileSourcesFilter extends SandboxCaSourcesFilter {
+
+    @JsonProperty("search_profile")
+    private String searchProfile;
+
+    SandboxCaProfileSourcesFilter(String searchProfile) {
+        this.searchProfile = searchProfile;
+    }
+
+    public String getSearchProfile() {
+        return searchProfile;
+    }
+
+}

yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCaSourcesFilter.java

@@ -0,0 +1,13 @@
+package com.yoti.api.client.sandbox.docs.request.check;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
+@JsonSubTypes({
+        @JsonSubTypes.Type(value = SandboxCaTypeListSourcesFilter.class, name = "TYPE_LIST"),
+        @JsonSubTypes.Type(value = SandboxCaProfileSourcesFilter.class, name = "PROFILE")
+})
+public abstract class SandboxCaSourcesFilter {
+
+}

yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCaTypeListSourcesFilter.java

@@ -0,0 +1,20 @@
+package com.yoti.api.client.sandbox.docs.request.check;
+
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class SandboxCaTypeListSourcesFilter extends SandboxCaSourcesFilter {
+
+    @JsonProperty("types")
+    private final List<String> types;
+
+    SandboxCaTypeListSourcesFilter(List<String> types) {
+        this.types = types;
+    }
+
+    public List<String> getTypes() {
+        return types;
+    }
+
+}

yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxWatchlistAdvancedCaCheck.java

@@ -0,0 +1,60 @@
+package com.yoti.api.client.sandbox.docs.request.check;
+
+import java.util.List;
+
+import com.yoti.api.client.sandbox.docs.request.check.report.SandboxCheckReport;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class SandboxWatchlistAdvancedCaCheck extends SandboxCheck {
+
+    @JsonProperty("sources_filter")
+    private final SandboxCaSourcesFilter sourcesFilter;
+
+    SandboxWatchlistAdvancedCaCheck(SandboxCheckResult result, SandboxCaSourcesFilter sourcesFilter) {
+        super(result);
+        this.sourcesFilter = sourcesFilter;
+    }
+
+    public SandboxCaSourcesFilter getSourcesFilter() {
+        return sourcesFilter;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    /**
+     * Builder for {@link SandboxWatchlistAdvancedCaCheck}
+     */
+    public static class Builder extends SandboxCheck.Builder<Builder> {
+
+        private SandboxCaSourcesFilter sourcesFilter;
+
+        private Builder() {}
+
+        public Builder withTypeListFilter(List<String> types) {
+            this.sourcesFilter = new SandboxCaTypeListSourcesFilter(types);
+            return self();
+        }
+
+        public Builder withProfileFilter(String searchProfile) {
+            this.sourcesFilter = new SandboxCaProfileSourcesFilter(searchProfile);
+            return self();
+        }
+
+        @Override
+        protected Builder self() {
+            return this;
+        }
+
+        @Override
+        public SandboxWatchlistAdvancedCaCheck build() {
+            SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
+            SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
+
+            return new SandboxWatchlistAdvancedCaCheck(result, sourcesFilter);
+        }
+
+    }
+}

yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/SandboxCheckReportsTest.java

@@ -14,6 +14,7 @@
 import com.yoti.api.client.sandbox.docs.request.check.SandboxSynecticsIdentityFraudCheck;
 import com.yoti.api.client.sandbox.docs.request.check.SandboxThirdPartyIdentityCheck;
 import com.yoti.api.client.sandbox.docs.request.check.SandboxThirdPartyIdentityFraudOneCheck;
+import com.yoti.api.client.sandbox.docs.request.check.SandboxWatchlistAdvancedCaCheck;
 import com.yoti.api.client.sandbox.docs.request.check.SandboxWatchlistScreeningCheck;
 
 import org.junit.Test;
@@ -35,6 +36,7 @@ public class SandboxCheckReportsTest {
     @Mock SandboxSynecticsIdentityFraudCheck synecticsIdentityFraudCheckMock;
     @Mock SandboxThirdPartyIdentityFraudOneCheck thirdPartyIdentityFraudOneCheckMock;
     @Mock SandboxWatchlistScreeningCheck watchlistScreeningCheckMock;
+    @Mock SandboxWatchlistAdvancedCaCheck watchlistAdvancedCaCheckMock;
 
     @Test
     public void builder_shouldAllowDocumentAuthenticityChecks() {
@@ -142,6 +144,16 @@ public void builder_shouldAllowWatchlistScreeningCheck() {
         assertThat(result.getWatchlistScreeningCheck(), is(watchlistScreeningCheckMock));
     }
 
+    @Test
+    public void builder_shouldAllowWatchlistAdvancedCaChecks() {
+        SandboxCheckReports result = SandboxCheckReports.builder()
+                .withWatchlistAdvancedCaCheck(watchlistAdvancedCaCheckMock)
+                .build();
+
+        assertThat(result.getWatchlistAdvancedCaChecks(), hasSize(1));
+        assertThat(result.getWatchlistAdvancedCaChecks().get(0), is(watchlistAdvancedCaCheckMock));
+    }
+
     @Test
     public void builder_shouldAllowOverridingOfAsyncReportDelay() {
         SandboxCheckReports result = SandboxCheckReports.builder()