Update dependency @getbrevo/brevo to v6#3499
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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.



This PR contains the following updates:
5.0.4→6.0.2Release Notes
getbrevo/brevo-node (@getbrevo/brevo)
v6.0.2: - Empty Object Serialization FixCompare Source
Node.js SDK v6.0.2
What's New
🔧 Bug Fix: Empty Object Serialization
{}instead of[]✨ New Features: Consent Groups Management
📲 Extended Operations
consentGroupIdsfield to add imported contacts to specified consent groupsconsentGroupsarray showing subscription status (when feature enabled)💳 New Wallet Feature
Bug Fixes
Compatibility
Installation
v6.0.1Compare Source
v6.0.1
First stable release of the v6 line. This is a major release with breaking changes — see the migration notes below before upgrading. v5.x remains supported and continues to receive wire-compatibility fixes.
Why this release
Most of the breaking changes in v6 come from an internal effort at Brevo to make our API endpoints, parameters and models more self-descriptive. The goal is to make the public surface easier to read at a glance — both for developers and for AI agents working against the Brevo API — so that names, shapes and required fields convey intent without needing to cross-reference external docs. Concretely, this means consistent camelCase parameters, payload wrappers that reflect what the endpoint actually does (e.g.
{ events: [...] }), filter keys that match the wire format, and model fields renamed or removed where the previous names were ambiguous or misleading.We're aware that renaming costs callers a one-time migration, and we've kept v5.x supported so you can adopt v6 on your own timeline.
Companies —
getCompaniesfilter parameter renamedclient.companies.getCompanies({ filters })— thefiltersparameter is renamed to the bracketed literal"filters[attributes.name]"to match the wire format.filtersname still compiles but the filter is silently dropped server-side and you get an unfiltered list. Audit every call site.Events —
createBatchEventspayload shape changedclient.event.createBatchEventsnow wraps events in{ events: [...] }instead of accepting a raw array.Balance —
getActiveBalancesApiresponse and parameter renameBalanceLimit→GetLoyaltyBalanceProgramsPidActiveBalanceResponse.contact_id→contactId,balance_definition_id→balanceDefinitionId,sort_field→sortField.Balance —
getContactBalancesrequiresbalanceDefinitionIdbalanceDefinitionIdis now a required parameter.CRM —
getCrmTasktypesreturns an arrayclient.tasks.getCrmTasktypesreturn type changed from a single object toGetCrmTasktypesResponseItem[].Model fields removed
GetWebhook.channelGetProcessResponseInfo.exportGetEventsList.events[].sourceGetExtendedCampaignOverview.utmIDActive— replaced byutmID: numberModel fields renamed
ConversationsMessage.File.filename→nameConversationsMessage.File.url→linkSendTransacSms.tagis nowstring | string[](previously an object{ field?: ... })Now-required fields
GetContactDetails.whatsappBlacklistedNote.textTask.dateAdded
BrevoClientauthoption — inject a customAuthProviderfor advanced auth scenarios (OAuth, dynamic tokens, key rotation). The existingapiKeyconstructor option continues to work unchanged.contacts.createContact,contacts.updateContact,emailCampaigns.getEmailCampaigns,ecommerce.getProducts, and several other endpoints.Migration
See the Upgrading from v5.x guide for full migration details, including a one-line rollback pin if you need to hold on v5.x temporarily.
Documentation
What's Changed
Full Changelog: getbrevo/brevo-node@v5.0.4...v6.0.0
What's Changed
Full Changelog: getbrevo/brevo-node@v3.0.1...v6.0.0
Configuration
📅 Schedule: (in timezone Europe/Sofia)
* * * * 0,6)🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.