fix: correct visibility option

[twangodev]

Summary by CodeRabbit

• Bug Fixes

  • Corrected visibility option naming from "unlisted" to "unlist" for API consistency.

• Tests

  • Updated unit tests to use and assert the "unlist" visibility value.

• Documentation

  • Adjusted docstrings and in-code documentation to reflect the "unlist" visibility option.

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

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

The pull request renames the visibility literal from "unlisted" to "unlist" in the shared types, updates the Voice model docstring to match, and adjusts unit tests to expect "unlist" instead of "unlisted".

Changes

Cohort / File(s)	Summary
Type definition src/fishaudio/types/shared.py	Changed Visibility literal from Literal["public", "unlisted", "private"] to Literal["public", "unlist", "private"].
Model documentation src/fishaudio/types/voices.py	Updated Voice model docstring to reference "unlist" instead of "unlisted".
Tests tests/unit/test_types.py	Renamed test and test data to expect "unlist" (assertions and sample response updated).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nibbled strings and found the twist,
"Unlist" now hops where "unlisted" missed.
A tiny change, a tidy track—
One short word and we're back on track. ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix: correct visibility option' directly refers to the main change in the PR: fixing the visibility type alias from 'unlisted' to 'unlist' across shared types, voice model documentation, and tests.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[Copilot]

Pull request overview

This pull request corrects the visibility option value from "unlisted" to "unlist" in the type definitions, aligning the newer fishaudio SDK with the legacy fish_audio_sdk which already uses "unlist".

Changes:

• Updated Visibility type literal in shared.py from "unlisted" to "unlist"
• Updated documentation comment in voices.py to reflect the corrected value

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/fishaudio/types/shared.py	Updated the Visibility type definition to use "unlist" instead of "unlisted"
src/fishaudio/types/voices.py	Updated the docstring comment to document "unlist" instead of "unlisted"

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/fishaudio/types/shared.py`:
- Line 30: The Visibility Literal was changed to accept "unlist" not "unlisted",
which breaks test_voice_with_unlisted_visibility; add a Pydantic validator on
the Voice model (e.g., a `@validator` or root_validator in the Voice class) that
accepts the legacy string "unlisted" and normalizes it to "unlist" before
validation (ensuring Visibility still uses
Literal["public","unlist","private"]), update tests/unit/test_types.py to either
send "unlist" or rely on the new normalization in
test_voice_with_unlisted_visibility, and finally bump the package version and
add a short changelog entry noting the Visibility value change and the
backward-compatible normalization.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines	Coverage Δ
src/fishaudio/types/shared.py	100.00% <100.00%> (ø)
src/fishaudio/types/voices.py	100.00% <ø> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.