feat!: improve developer experience with breaking API changes (v0.20.0)

[franccesco]

Summary

This release contains breaking changes that significantly improve the developer experience across the SDK.

Breaking Changes

• client.user.all() renamed to client.user.list() for consistency with other SDK patterns
• client.user.details(all=True) renamed to client.user.details(include_all=True) for parameter clarity
• client.issue.solve() renamed to client.issue.complete() and now returns IssueDetails instead of bool
• client.todo.complete() now returns Todo object instead of bool
• client.goal.update/delete/archive/restore() now return None instead of bool
• client.headline.update/delete() now return None instead of bool
• Client raises ConfigurationError instead of ValueError for missing API key

New Features

• Added client.issue.update() method for updating existing issues
• Added client.scorecard.get() method for retrieving scorecard details
• Added GoalStatus enum for type-safe status values (ON_TRACK, AT_RISK, COMPLETE)
• Added base_url and timeout parameters to sync Client for configuration flexibility
• AsyncClient now validates API key at initialization (consistent with sync Client)

Documentation

• All API documentation updated to reflect breaking changes
• Added examples for new methods and enums
• Updated error handling guide with new exception types

Test Plan

• All existing tests pass with updated method names
• New tests cover issue update functionality
• New tests cover scorecard get functionality
• GoalStatus enum tests pass
• Client configuration tests pass (base_url, timeout, ConfigurationError)
• AsyncClient validation tests pass

Migration Guide

# Before (v0.19.x)
users = client.user.all()
user = client.user.details(user_id=123, all=True)
client.issue.solve(issue_id=456)
success = client.todo.complete(todo_id=789)  # bool
success = client.goal.update(goal_id=101, status="on")  # bool

# After (v0.20.0)
users = client.user.list()
user = client.user.details(user_id=123, include_all=True)
issue = client.issue.complete(issue_id=456)  # IssueDetails
todo = client.todo.complete(todo_id=789)  # Todo
client.goal.update(goal_id=101, status=GoalStatus.ON_TRACK)  # None

🤖 Generated with Claude Code