Skip to content

Conversation

@ChiragAgg5k
Copy link
Member

@ChiragAgg5k ChiragAgg5k commented Nov 28, 2025

This PR contains updates to the Flutter SDK for version 20.3.2.

Summary by CodeRabbit

  • New Features

    • Avatars now support screenshot capture with customizable theme, timezone and output format options.
  • Documentation

    • Example usage updated with realistic defaults for headers, viewport, locale, geolocation, and output settings.
  • Bug Fixes

    • Multi-factor authentication (MFA) flows updated to use corrected endpoints for more reliable MFA operations.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Nov 28, 2025

Walkthrough

Adds a new getScreenshot() method to the Avatars service and introduces three public enums: Theme, Timezone, and Output. Updates documentation examples for getScreenshot() with concrete parameter values (headers, viewport, scale, userAgent, fullpage, locale, geolocation, permissions, sleep, dimensions, quality, output). Also changes MFA-related API endpoint paths in account service methods from /account/mfa/challenge to /account/mfa/challenges. No public method signatures were removed.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Inspect the getScreenshot() implementation for request construction, parameter validation, and error handling.
  • Verify the definitions and intended values of Theme, Timezone, and Output enums.
  • Review updated docs/examples (docs/examples/avatars/get-screenshot.md) for accuracy and consistency with the implementation.
  • Check lib/services/account.dart changes: ensure the updated MFA endpoint paths are correct and consistent with server expectations.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title references a version number (20.3.2) but the actual changes include getScreenshot() method addition, new enums (Theme, Timezone, Output), MFA endpoint updates, and documentation examples—none of which are specific to that version. The title is too generic for the scope of changes. Consider a more specific title like 'feat: Add Avatars getScreenshot() method and update MFA endpoints' to better describe the actual modifications.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dev

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c8b2f7 and fefb9fd.

📒 Files selected for processing (2)
  • docs/examples/avatars/get-screenshot.md (2 hunks)
  • lib/services/account.dart (4 hunks)
🔇 Additional comments (3)
lib/services/account.dart (1)

372-389: All MFA challenge methods updated consistently.

The non-deprecated updateMFAChallenge method completes the consistent update of all four MFA challenge methods (both create and update, both deprecated and current versions).

docs/examples/avatars/get-screenshot.md (2)

10-34: Documentation example values look realistic and helpful.

The updated parameter values provide a comprehensive, realistic example:

  • Headers include authentication (common use case)
  • Viewport dimensions (1920x1080) represent Full HD
  • San Francisco coordinates for geolocation demo
  • Quality set to 85 (typical JPEG quality)
  • Permissions array aligns with geolocation usage

40-71: Consistent parameter values across both examples.

The FutureBuilder example uses the same parameter values as the file download example, which maintains consistency and helps users understand that the same API call can be used for different purposes (downloading to file vs displaying in-app).


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 948b14b and 9c8b2f7.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🔇 Additional comments (1)
CHANGELOG.md (1)

3-11: Verify semantic versioning aligns with feature scope.

Adding new public methods and enums to the API surface is typically a feature addition, which warrants a minor version bump (20.4.0) rather than a patch release (20.3.2). Patch releases conventionally contain only bug fixes. If these features are intended as part of 20.3.2, confirm this is the maintainers' intentional versioning strategy; otherwise, consider bumping to 20.4.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants