SDK-2467: IDV Support Brand ID in session config

[mehmet-yoti]

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

[mehmet-yoti]

@copilot Do Below Task To implement support for the new brand_id property in the SDKs when creating a session, follow this detailed plan broken down into manageable subtasks. This will ensure a smooth integration and consistency across the board:

Preliminary Steps:

1. Understand Requirements:

   • Review documentation provided by the IDV team regarding the brand_id property.
   • Clarify any questions related to how the brand_id will affect the appearance or functional behavior of the IDV session.

2. Analyze Current Codebase:

   • Identify all SDKs (e.g., Android, iOS, Web) that need modification.
   • Review the existing session creation flow to determine integration points for the brand_id.

Implementation Plan:

Step 1: Update SDK Specifications

• Subtask 1.1: Update the SDK API documentation to include the brand_id field in the sdk_config object.
• Subtask 1.2: Create or update any UML diagrams or data flow diagrams to reflect the inclusion of brand_id.

Step 2: Modify SDK Codebase

For Each SDK:

• Subtask 2.1: Add brand_id Property

  • Extend the current session creation models to include the brand_id field.
  • Ensure that the brand_id is an optional string and is treated as such in the codebase.

• Subtask 2.2: Update Session Creation Logic

  • Modify the relevant service or utility that handles session creation to accept and include the brand_id in requests.
  • Update any necessary serialization and deserialization methods to handle brand_id.

• Subtask 2.3: Validate Input

  • Implement input validation to ensure that brand_id, if provided, conforms to expected formats (e.g., non-empty, within character length limits).

• Subtask 2.4: Update Error Handling

  • Modify error handling mechanisms to provide clear messages in the event of invalid brand_id usage.

Step 3: Testing Plan

• Subtask 3.1: Unit Testing

  • Write unit tests to cover all new code paths ensuring brand_id is correctly included, handled, and validated.
  • Test different scenarios including valid, invalid, and missing brand_id.

• Subtask 3.2: Integration Testing

  • Perform end-to-end testing with the updated SDK integrating with the IDV system.
  • Verify that brand_id correctly applies the appropriate theme as expected.

• Subtask 3.3: Regression Testing

  • Conduct regression tests to ensure existing functionality remains unaffected by the addition of brand_id.

Step 4: Documentation Update

• Subtask 4.1: User Guide

  • Update user guides or README files to instruct users on how to leverage the brand_id property.

• Subtask 4.2: Developer Documentation

  • Ensure internal documentation clearly outlines where and how brand_id is integrated into the SDK.

Step 5: Deployment and Monitoring

• Subtask 5.1: Deploy the updated SDK to appropriate repositories (e.g., Maven, npm, CocoaPods).
• Subtask 5.2: Monitor feedback channels and error logs for any issues related to brand_id usage post-deployment.

Final Review and Handoff

• Conduct a final code review to ensure coding standards and best practices are adhered to.
• Prepare and conduct a knowledge transfer session if needed for client-facing teams or support staff.

By following this comprehensive implementation plan, the SDKs will be successfully updated to support the new brand_id property, allowing businesses to implement a consistent theme across their IDV interactions.

[Copilot]

@mehmet-yoti I've opened a new pull request, #435, 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