docs(readme): align with v5 SDK surface#131
Merged
Merged
Conversation
- Fix broken banner image (was pointing to a non-existent `brevo-node@v4/banner.png`); use the `banner.png` in this repo. - Add an "Upgrading from v4.x" section reflecting the actual v5 breaking changes (filters rename, `createBatchEvents` payload wrap, balance/CRM/model changes, type tightening). - Update v1.x migration callout to recommend v5.x and rename the example accordingly. - Fix Custom Client example — `apiKey` is required, the previous snippet was invalid PHP. - Correct the Timeouts section — the SDK does not default to 30s; it inherits the HTTP client's default. Clarify Guzzle/Symfony forwarding. - Add a Logging section explaining how to plug in any PSR-3 logger via Guzzle's `Middleware::log`, with an `api-key` redaction warning. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|
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
1 participant
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
Aligns the v5 branch README with the actual v5 SDK surface and the published v5.0.0 release notes.
Why the banner wasn't rendering
The README referenced `https://raw.githubusercontent.com/getbrevo/brevo-node/v4/banner.png\` — that's the node repo on a v4 branch that no longer exists (the node repo branches are now `main`, `v6`, and `v3-(legacy)`). Switched to the in-repo `banner.png` (which is present at the repo root).
Other fixes
Test plan
🤖 Generated with Claude Code