SDK-2533: Change IdentityProfileResponse to use a stronly typed object for the report

Author: MrBurtyyy

examples/doc-scan/src/main/resources/templates/success.html

@@ -965,6 +965,14 @@ <h2>Identity Profile</h2>
             </div>
         </div>
 
+        <th:block th:if="${sessionResult.getIdentityProfile().getIdentityProfileReport()() != null}">
+            <div th:if="${sessionResult.getIdentityProfile().getIdentityProfileReport().getMedia() != null}">
+                Generated Profile Media: <a th:href="${'/media?mediaId=' + sessionResult.getIdentityProfile().getIdentityProfileReport().getMedia().getId()}"
+                                            th:text="${sessionResult.getIdentityProfile().getIdentityProfileReport().getMedia().getId()}">
+                </a>
+            </div>
+        </th:block>
+
         <!-- Identity Profile Failure Reason -->
         <th:block th:if="${sessionResult.getIdentityProfile().getFailureReason() != null}">
             <div class="row pt-4">

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/retrieve/IdentityProfileReportResponse.java

@@ -0,0 +1,45 @@
+package com.yoti.api.client.docs.session.retrieve;
+
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class IdentityProfileReportResponse {
+
+    @JsonProperty("trust_framework")
+    private String trustFramework;
+
+    @JsonProperty("media")
+    private MediaResponse media;
+
+    @JsonProperty("schemes_compliance")
+    private List<IdentityProfileSchemeComplianceReportResponse> schemesCompliance;
+
+    /**
+     * The trust framework the report was generated for
+     *
+     * @return the trust framework
+     */
+    public String getTrustFramework() {
+        return trustFramework;
+    }
+
+    /**
+     * The media object containing the report
+     *
+     * @return the report media
+     */
+    public MediaResponse getMedia() {
+        return media;
+    }
+
+    /**
+     * The list of schemes used in the trust framework
+     *
+     * @return the list of schemes
+     */
+    public List<IdentityProfileSchemeComplianceReportResponse> getSchemesCompliance() {
+        return schemesCompliance;
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/retrieve/IdentityProfileResponse.java

@@ -1,7 +1,5 @@
 package com.yoti.api.client.docs.session.retrieve;
 
-import java.util.Map;
-
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 public class IdentityProfileResponse {
@@ -16,7 +14,7 @@ public class IdentityProfileResponse {
     private IdentityProfileFailureResponse failureReason;
 
     @JsonProperty(Property.IDENTITY_PROFILE_REPORT)
-    private Map<String, Object> identityProfileReport;
+    private IdentityProfileReportResponse identityProfileReport;
 
     public String getSubjectId() {
         return subjectId;
@@ -30,7 +28,7 @@ public IdentityProfileFailureResponse getFailureReason() {
         return failureReason;
     }
 
-    public Map<String, Object> getIdentityProfileReport() {
+    public IdentityProfileReportResponse getIdentityProfileReport() {
         return identityProfileReport;
     }
 

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/retrieve/IdentityProfileSchemeComplianceReportResponse.java

@@ -0,0 +1,43 @@
+package com.yoti.api.client.docs.session.retrieve;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class IdentityProfileSchemeComplianceReportResponse {
+
+    @JsonProperty("scheme")
+    private IdentityProfileSchemeResponse scheme;
+
+    @JsonProperty("requirements_met")
+    private Boolean requirementsMet;
+
+    @JsonProperty("requirements_not_met_info")
+    private String requirementsNotMetInfo;
+
+    /**
+     * The Identity Profile scheme
+     *
+     * @return the scheme
+     */
+    public IdentityProfileSchemeResponse getScheme() {
+        return scheme;
+    }
+
+    /**
+     * Whether or not the requirements for the scheme were met
+     *
+     * @return boolean
+     */
+    public Boolean getRequirementsMet() {
+        return requirementsMet;
+    }
+
+    /**
+     * Information about why the requirements for the scheme were not met
+     *
+     * @return string
+     */
+    public String getRequirementsNotMetInfo() {
+        return requirementsNotMetInfo;
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/retrieve/IdentityProfileSchemeResponse.java

@@ -0,0 +1,31 @@
+package com.yoti.api.client.docs.session.retrieve;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class IdentityProfileSchemeResponse {
+
+    @JsonProperty("type")
+    private String type;
+
+    @JsonProperty("objective")
+    private String objective;
+
+    /**
+     * The type of the scheme
+     *
+     * @return the type
+     */
+    public String getType() {
+        return type;
+    }
+
+    /**
+     * The objective of the scheme
+     *
+     * @return the objective
+     */
+    public String getObjective() {
+        return objective;
+    }
+
+}