SDK-2752: Add support for requesting and retrieving SHARE_CODE resources + tasks - Task-2

[mehmet-yoti]

Automated PR created by n8n. Related Jira Issue: SDK-2752

[mehmet-yoti]

@copilot do To implement support for the new SHARE_CODE resource type in the SDKs, we need to make enhancements to both the session creation process and the session retrieval process. Here's a detailed implementation plan broken down into specific subtasks:

1. Analysis and Design

• Review the Existing SDK Architecture: Understand how the SDK currently handles other resource types (e.g., id_documents, supplementary_documents) during session creation and retrieval.
• Define Data Structures: Identify and define new data structures in the SDK for the SHARE_CODE resource that align with the given API specifications.
• Back-End Coordination: Confirm with the back-end team that the endpoints for SHARE_CODE handling are stable and ready for integration.

2. Update Session Creation Process

• Modify Session Creation Request Model:

  • Extend the model that represents session creation requests to include a required_share_codes array.
  • Ensure this array accommodates multiple SHARE_CODE objects each with issuer and scheme strings.

• Adjust API Client Method:

  • Update the method responsible for constructing session creation requests to support adding required_share_codes to the request payload.
  • Additional checks should verify that this array is correctly serialized/structured in outgoing requests.

• Testing:

  • Develop unit tests that ensure the SDK correctly builds requests including one or more SHARE_CODE entries.
  • Validate that improper inclusion of data in required_share_codes (e.g., data validation) is not being performed by the SDK as per requirements.

3. Update Session Retrieval Process

• Enhance Session Retrieval Response Model:

  • Extend the session retrieval response handler to parse and extract share_codes details into an accessible structure.
  • This structure should capture all fields including id, source, created_at, last_updated, and associated media models (lookup_profile, returned_profile, id_photo, file).

• Implement Task Handling for VERIFY_SHARE_CODE_TASK:

  • Ensure the SDK can handle tasks of type VERIFY_SHARE_CODE_TASK, capturing its id, state, created, last_updated, and generated_media.
  • Extend task-related logic to process and relay this data appropriately to the consumers of the SDK.

• Testing:

  • Implement and run integration tests to verify that the SDK correctly handles session data containing share_codes.
  • Test the ability to interpret tasks associated with SHARE_CODE resources.
  • Conduct regression tests to ensure no breakage occurs in existing session retrieval processes.

4. Documentation and Examples

• Update SDK Documentation:

  • Amend the SDK documentation to include examples and descriptions of how to include SHARE_CODE resources when creating a session and how to handle them when retrieving a session.

• Create Usage Examples:

  • Integrate examples in the SDK documentation showing typical usage scenarios that involve SHARE_CODE in both creating and retrieving sessions.
  • Ensure code snippets are provided in all officially supported languages.

5. Deployment and Release

• Prepare Deployment Plan:

  • Plan a phased rollout in the SDK, potentially starting with a beta version for selected partners to gather early feedback.

• Continuous Integration and Deployment:

  • Ensure CI/CD pipelines are updated to accommodate new tests and include validation for SHARE_CODE resources.

• Announce Feature Availability:

  • Prepare communications for stakeholders and customers highlighting the new SHARE_CODE capabilities and provide guidance on how to leverage it effectively.

This plan covers the necessary steps from design through to deployment, ensuring that support for the new SHARE_CODE resource is implemented efficiently and effectively into the SDKs.

[Copilot]

@mehmet-yoti I've opened a new pull request, #440, to work on those changes. Once the pull request is ready, I'll request review from you.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud