Repository navigation
feat: add a search filter to messages.list - #27
Merged
Merged
Conversation
`messages.list` / `messages.iter` (and their async equivalents) accept a `search` argument, forwarded as the `search` query param — a case-insensitive substring match over a message's public id, recipient, template slug, and metadata keys/values. Use `metadata` for an exact match; terms are capped at 512 characters by the API. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018sQnT9HQ2y7oiMdygaPPdv
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Mirrors the new
searchfilter on the messages list endpoint(
GET /v1/messages) for the Python SDK, keeping it in sync with theTypeScript and PHP clients.
searchis a case-insensitive substring match over a message's public id,recipient, template slug, and metadata keys/values. It composes with the
existing filters and cursor pagination; use
metadatafor an exact match.Terms are capped at 512 characters by the API.
Changes
messages.list()andmessages.iter()(and their async equivalents,AsyncMessages.list()/aiter()) accept asearchkeyword argument.list_messages_query()serializes it as thesearchquery param (omittedwhen
None).searchis forwarded on the request.Verified locally:
pytest(82 passed),ruff check, andmypy srcall pass.🤖 Generated with Claude Code
Generated by Claude Code