Releases: getbrevo/brevo-ruby
v4.0.0
📦 SDK Updates
Added
🔹 Balance API
-
Endpoints for managing loyalty balances:
- Create, cancel, complete transactions
- Create, update, delete balance definitions and limits
- Retrieve active balances, contact balances, subscription balances, and transaction history
-
New models:
Balance,BalanceDefinition,BalanceLimit,BalanceOrder,AggregateBalance,ContactBalancesResp, etc.
🔹 Payments API
-
Endpoints for:
- Creating, deleting, and fetching payment requests
-
New models:
CreatePaymentRequest,CreatePaymentResponse,GetPaymentRequest
🔹 Program API (Loyalty Programs)
-
Endpoints for:
- Creating, updating, deleting, publishing, and managing loyalty programs, subscriptions, and members
-
New models:
CreateLoyaltyProgramPayload,PatchLoyaltyProgramPayload,LoyaltyProgram,LoyaltyProgramPage,MemberContact, etc.
🔹 Reward API
-
Endpoints for:
- Managing rewards, vouchers, and code pools
-
New models:
MainReward,MainRewardPage,MainRewardValidate,MainVoucherRevokePayload, etc.
🔹 Tier API
-
Endpoints for:
- Managing loyalty program tiers and tier groups
-
New models:
Tier,TierGroup,TierRequest,TierForContact, etc.
🔹 Ecommerce API
-
New endpoints for:
- Setting and getting display currency
- Attribution support for workflows
-
New models:
SetConfigDisplayCurrency,TemplatePreview
🔹 Contacts API
- Endpoint to delete multiple-choice attribute options
🔹 Companies and Deals API
-
Endpoints for:
- Importing companies and deals
- Managing CRM attributes
🔹 Transactional SMS API
- Endpoint for sending SMS messages asynchronously
🔹 Master Account API
-
Endpoints for:
- Associating/dissociating IPs
- Updating sub-account plans
- Managing user permissions
Changed
-
Enhanced Ecommerce API:
- Attribution endpoints now support workflows in addition to campaigns
-
Improved descriptions and parameter details across various endpoints for clarity and completeness
Removed
❌ Reseller API
-
Removed all endpoints and models related to the Reseller API:
- Credit management
- Child account/domain management
- Reseller statistics
-
Removed models:
AddCredits,CreateReseller,GetChildAccountCreationStatus,GetChildDomains,
GetChildInfo,GetChildInfoApiKeys,GetChildInfoApiKeysV2,GetChildInfoApiKeysV3,
GetChildInfoCredits,GetChildInfoStatistics,GetChildrenList,ManageIp,
RemoveCredits,RemainingCreditModel, etc.
What's Changed
- CONT-9905: update SDK to 4.0.0 by @NagendraSIB in #11
Full Changelog: v3.0.0...v4.0.0
v3.0.0
What's Changed
- CC-00: use swagger_definition_v3 by @NagendraSIB in #4
- CC-2795: update SDK by @NagendraSIB in #6
- Support new API events_api
- Modification in Get all the contacts, contact can be filtered by segmentId and listIds as well
segmentId | int| Id of the segment. Either listIds or segmentId can be passed. | [optional]
listIds | int[]| Ids of the list. Either listIds or segmentId can be passed. | [optional] - Modification in Get a list's details
startDate and endDate (YYYY-MM-DDTHH:mm:ss.SSSZ) support added. - Get order details route added in eCommerceAPI
- Below routes added MasterAccountAPI
Update a group of sub-accounts
Create a new group of sub-accounts - Below routes added In UsersApi
Update permission for a user
Send invitation to user
Revoke user permission
Resend / Cancel invitation - In Return all your created WhatsApp templates source parameters also now supported
source | string| source of the template | [optional]
Full Changelog: v2.0.0...v3.0.0
v2.0.0
What's Changed
- CC-1726: gem name updated from brevo-ruby to brevo by @NagendraSIB in #1
New Contributors
- @NagendraSIB made their first contribution in #1
Full Changelog: v1.0.0...v2.0.0
v1.0.0
API's changed from sendinblue.com domain to api brevo.com domain
For installation follow this process
Follow reference example in order to use this SDK