@getbrevo/brevo 5.0.4 → 6.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (640) hide show
  1. package/README.md +99 -37
  2. package/dist/cjs/BaseClient.d.ts +13 -0
  3. package/dist/cjs/BaseClient.js +17 -2
  4. package/dist/cjs/Client.d.ts +6 -0
  5. package/dist/cjs/Client.js +68 -58
  6. package/dist/cjs/api/errors/BadRequestError.js +1 -1
  7. package/dist/cjs/api/errors/ConflictError.js +1 -1
  8. package/dist/cjs/api/errors/ExpectationFailedError.js +1 -1
  9. package/dist/cjs/api/errors/FailedDependencyError.js +1 -1
  10. package/dist/cjs/api/errors/ForbiddenError.js +1 -1
  11. package/dist/cjs/api/errors/InternalServerError.js +1 -1
  12. package/dist/cjs/api/errors/MethodNotAllowedError.js +1 -1
  13. package/dist/cjs/api/errors/NotFoundError.js +1 -1
  14. package/dist/cjs/api/errors/PaymentRequiredError.js +1 -1
  15. package/dist/cjs/api/errors/PreconditionFailedError.js +1 -1
  16. package/dist/cjs/api/errors/TooEarlyError.js +1 -1
  17. package/dist/cjs/api/errors/TooManyRequestsError.js +1 -1
  18. package/dist/cjs/api/errors/UnauthorizedError.js +1 -1
  19. package/dist/cjs/api/errors/UnprocessableEntityError.js +1 -1
  20. package/dist/cjs/api/errors/UnsupportedMediaTypeError.js +1 -1
  21. package/dist/cjs/api/resources/account/client/Client.d.ts +5 -6
  22. package/dist/cjs/api/resources/account/client/Client.js +21 -13
  23. package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +4 -17
  24. package/dist/cjs/api/resources/balance/client/Client.d.ts +9 -8
  25. package/dist/cjs/api/resources/balance/client/Client.js +70 -33
  26. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts +21 -11
  27. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js +9 -0
  28. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts +11 -3
  29. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js +9 -0
  30. package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +13 -1
  31. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +7 -6
  32. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +6 -6
  33. package/dist/cjs/api/resources/balance/client/requests/index.d.ts +2 -2
  34. package/dist/cjs/api/resources/balance/client/requests/index.js +5 -1
  35. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts +5 -0
  36. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js +8 -0
  37. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts +5 -0
  38. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js +8 -0
  39. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts +5 -0
  40. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js +8 -0
  41. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts +30 -0
  42. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +10 -0
  43. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js +15 -0
  44. package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +7 -2
  45. package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +14 -14
  46. package/dist/cjs/api/resources/balance/types/index.d.ts +4 -0
  47. package/dist/cjs/api/resources/balance/types/index.js +4 -0
  48. package/dist/cjs/api/resources/companies/client/Client.d.ts +22 -0
  49. package/dist/cjs/api/resources/companies/client/Client.js +49 -18
  50. package/dist/cjs/api/resources/companies/client/requests/GetCompaniesRequest.d.ts +4 -4
  51. package/dist/cjs/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.ts +1 -1
  52. package/dist/cjs/api/resources/companies/client/requests/PostCompaniesImportRequest.d.ts +1 -1
  53. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.d.ts +2 -2
  54. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.js +1 -1
  55. package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +20 -4
  56. package/dist/cjs/api/resources/consentGroups/client/Client.d.ts +108 -0
  57. package/dist/cjs/api/resources/consentGroups/client/Client.js +383 -0
  58. package/dist/cjs/api/resources/consentGroups/client/index.d.ts +1 -0
  59. package/dist/cjs/api/resources/{event/types → consentGroups/client}/index.js +1 -1
  60. package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.ts +25 -0
  61. package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.js +12 -0
  62. package/dist/cjs/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.ts +10 -0
  63. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.ts +10 -0
  64. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.js +3 -0
  65. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.ts +17 -0
  66. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.js +3 -0
  67. package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.ts +24 -0
  68. package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.js +12 -0
  69. package/dist/cjs/api/resources/consentGroups/client/requests/index.d.ts +5 -0
  70. package/dist/cjs/api/resources/consentGroups/client/requests/index.js +7 -0
  71. package/dist/cjs/api/resources/consentGroups/exports.d.ts +2 -0
  72. package/dist/cjs/api/resources/consentGroups/exports.js +21 -0
  73. package/dist/cjs/api/resources/consentGroups/index.d.ts +2 -0
  74. package/dist/cjs/api/resources/consentGroups/index.js +18 -0
  75. package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.ts +5 -0
  76. package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.js +8 -0
  77. package/dist/cjs/api/resources/consentGroups/types/index.d.ts +1 -0
  78. package/dist/cjs/api/resources/consentGroups/types/index.js +17 -0
  79. package/dist/cjs/api/resources/contacts/client/Client.d.ts +37 -0
  80. package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
  81. package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
  82. package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
  83. package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
  84. package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
  85. package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
  86. package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +2 -0
  87. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +4 -2
  88. package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
  89. package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +8 -3
  90. package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +1 -1
  91. package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +2 -2
  92. package/dist/cjs/api/resources/conversations/client/Client.d.ts +18 -8
  93. package/dist/cjs/api/resources/conversations/client/Client.js +28 -18
  94. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.ts +8 -8
  95. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.ts +12 -10
  96. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.ts +11 -9
  97. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.ts +1 -1
  98. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.ts +2 -2
  99. package/dist/cjs/api/resources/coupons/client/Client.d.ts +10 -0
  100. package/dist/cjs/api/resources/coupons/client/Client.js +19 -5
  101. package/dist/cjs/api/resources/customObjects/client/Client.d.ts +101 -21
  102. package/dist/cjs/api/resources/customObjects/client/Client.js +108 -26
  103. package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts +2 -2
  104. package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts +1 -1
  105. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +114 -25
  106. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js +21 -0
  107. package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts +1 -1
  108. package/dist/cjs/api/resources/customObjects/client/requests/index.js +3 -0
  109. package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +14 -5
  110. package/dist/cjs/api/resources/deals/client/Client.d.ts +22 -0
  111. package/dist/cjs/api/resources/deals/client/Client.js +62 -22
  112. package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +11 -3
  113. package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
  114. package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
  115. package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
  116. package/dist/cjs/api/resources/domains/client/Client.js +5 -5
  117. package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +30 -1
  118. package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
  119. package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
  120. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
  121. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
  122. package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
  123. package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
  124. package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +2 -2
  125. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
  126. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +2 -2
  127. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts +7 -0
  128. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js +10 -0
  129. package/dist/cjs/api/resources/ecommerce/types/index.d.ts +1 -0
  130. package/dist/cjs/api/resources/ecommerce/types/index.js +1 -0
  131. package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +22 -1
  132. package/dist/cjs/api/resources/emailCampaigns/client/Client.js +51 -15
  133. package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +7 -7
  134. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +1 -1
  135. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts +6 -4
  136. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +28 -5
  137. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +9 -0
  138. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +27 -4
  139. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +9 -0
  140. package/dist/cjs/api/resources/event/client/Client.d.ts +8 -6
  141. package/dist/cjs/api/resources/event/client/Client.js +14 -8
  142. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.d.ts +76 -0
  143. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.js +3 -0
  144. package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +3 -3
  145. package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
  146. package/dist/cjs/api/resources/event/index.d.ts +0 -1
  147. package/dist/cjs/api/resources/event/index.js +0 -1
  148. package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
  149. package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
  150. package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
  151. package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
  152. package/dist/cjs/api/resources/files/client/Client.js +19 -5
  153. package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
  154. package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
  155. package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
  156. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
  157. package/dist/cjs/api/resources/index.d.ts +5 -1
  158. package/dist/cjs/api/resources/index.js +6 -2
  159. package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
  160. package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
  161. package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
  162. package/dist/cjs/api/resources/notes/client/Client.js +21 -7
  163. package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
  164. package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
  165. package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
  166. package/dist/cjs/api/resources/payments/client/Client.js +9 -3
  167. package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
  168. package/dist/cjs/api/resources/process/client/Client.js +19 -20
  169. package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +19 -36
  170. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
  171. package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
  172. package/dist/cjs/api/resources/program/client/Client.js +26 -14
  173. package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
  174. package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
  175. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
  176. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
  177. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
  178. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
  179. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
  180. package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
  181. package/dist/cjs/api/resources/program/types/index.js +1 -0
  182. package/dist/cjs/api/resources/reward/client/Client.js +26 -10
  183. package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
  184. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
  185. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
  186. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
  187. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
  188. package/dist/cjs/api/resources/senders/client/Client.js +11 -7
  189. package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
  190. package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
  191. package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
  192. package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
  193. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
  194. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
  195. package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
  196. package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
  197. package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
  198. package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
  199. package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
  200. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
  201. package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
  202. package/dist/cjs/api/resources/tasks/types/index.js +1 -1
  203. package/dist/cjs/api/resources/tier/client/Client.js +22 -10
  204. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
  205. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
  206. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
  207. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
  208. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
  209. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
  210. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
  211. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
  212. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
  213. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
  214. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
  215. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
  216. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
  217. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
  218. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
  219. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +1 -1
  220. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
  221. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
  222. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
  223. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
  224. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
  225. package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
  226. package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
  227. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
  228. package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
  229. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
  230. package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
  231. package/dist/cjs/api/resources/user/client/Client.js +14 -6
  232. package/dist/cjs/api/resources/wallet/client/Client.d.ts +34 -0
  233. package/dist/cjs/api/resources/wallet/client/Client.js +126 -0
  234. package/dist/cjs/api/resources/wallet/client/index.d.ts +1 -0
  235. package/dist/cjs/api/resources/wallet/client/index.js +17 -0
  236. package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.ts +13 -0
  237. package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.js +3 -0
  238. package/dist/cjs/api/resources/wallet/client/requests/index.d.ts +1 -0
  239. package/dist/cjs/api/resources/wallet/client/requests/index.js +2 -0
  240. package/dist/cjs/api/resources/wallet/exports.d.ts +2 -0
  241. package/dist/cjs/api/resources/wallet/exports.js +21 -0
  242. package/dist/cjs/api/resources/wallet/index.d.ts +1 -0
  243. package/dist/cjs/api/resources/wallet/index.js +17 -0
  244. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
  245. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
  246. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
  247. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
  248. package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
  249. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
  250. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
  251. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
  252. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
  253. package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
  254. package/dist/cjs/api/types/BalanceDefinition.js +46 -2
  255. package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
  256. package/dist/cjs/api/types/BalanceLimit.js +22 -0
  257. package/dist/cjs/api/types/Company.d.ts +1 -1
  258. package/dist/cjs/api/types/ConsentGroup.d.ts +29 -0
  259. package/dist/cjs/api/types/ConsentGroup.js +12 -0
  260. package/dist/cjs/api/types/ConsentGroupItem.d.ts +17 -0
  261. package/dist/cjs/api/types/ConsentGroupItem.js +12 -0
  262. package/dist/cjs/api/types/ConsentGroupsListResponse.d.ts +14 -0
  263. package/dist/cjs/api/types/ConsentGroupsListResponse.js +3 -0
  264. package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
  265. package/dist/cjs/api/types/Deal.d.ts +4 -4
  266. package/dist/cjs/api/types/FileData.d.ts +8 -6
  267. package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
  268. package/dist/cjs/api/types/GetCampaignStats.d.ts +15 -15
  269. package/dist/cjs/api/types/GetContactDetails.d.ts +5 -0
  270. package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
  271. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
  272. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
  273. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
  274. package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
  275. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
  276. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
  277. package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
  278. package/dist/cjs/api/types/GetWebhook.js +2 -6
  279. package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
  280. package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
  281. package/dist/cjs/api/types/Note.d.ts +10 -8
  282. package/dist/cjs/api/types/NoteData.d.ts +1 -1
  283. package/dist/cjs/api/types/Order.d.ts +1 -1
  284. package/dist/cjs/api/types/Pipeline.d.ts +3 -3
  285. package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
  286. package/dist/cjs/api/types/Task.d.ts +20 -8
  287. package/dist/cjs/api/types/TierGroup.d.ts +66 -0
  288. package/dist/cjs/api/types/TierGroup.js +30 -0
  289. package/dist/cjs/api/types/Transaction.d.ts +36 -17
  290. package/dist/cjs/api/types/Transaction.js +17 -0
  291. package/dist/cjs/api/types/WalletPassInstallUrl.d.ts +4 -0
  292. package/dist/cjs/api/types/WalletPassInstallUrl.js +3 -0
  293. package/dist/cjs/api/types/index.d.ts +4 -0
  294. package/dist/cjs/api/types/index.js +4 -0
  295. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  296. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  297. package/dist/cjs/core/auth/index.d.ts +1 -1
  298. package/dist/cjs/core/auth/index.js +3 -1
  299. package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
  300. package/dist/cjs/core/fetcher/Fetcher.js +9 -8
  301. package/dist/cjs/core/fetcher/getResponseBody.js +11 -0
  302. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  303. package/dist/cjs/core/fetcher/signals.js +9 -1
  304. package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
  305. package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
  306. package/dist/cjs/core/url/index.d.ts +1 -0
  307. package/dist/cjs/core/url/index.js +3 -1
  308. package/dist/cjs/core/url/qs.d.ts +2 -1
  309. package/dist/cjs/core/url/qs.js +25 -13
  310. package/dist/cjs/errors/BrevoError.d.ts +1 -0
  311. package/dist/cjs/errors/BrevoError.js +5 -1
  312. package/dist/cjs/errors/BrevoTimeoutError.d.ts +2 -2
  313. package/dist/cjs/errors/BrevoTimeoutError.js +40 -6
  314. package/dist/cjs/version.d.ts +1 -1
  315. package/dist/cjs/version.js +1 -1
  316. package/dist/esm/BaseClient.d.mts +13 -0
  317. package/dist/esm/BaseClient.mjs +17 -2
  318. package/dist/esm/Client.d.mts +6 -0
  319. package/dist/esm/Client.mjs +10 -0
  320. package/dist/esm/api/errors/BadRequestError.mjs +1 -1
  321. package/dist/esm/api/errors/ConflictError.mjs +1 -1
  322. package/dist/esm/api/errors/ExpectationFailedError.mjs +1 -1
  323. package/dist/esm/api/errors/FailedDependencyError.mjs +1 -1
  324. package/dist/esm/api/errors/ForbiddenError.mjs +1 -1
  325. package/dist/esm/api/errors/InternalServerError.mjs +1 -1
  326. package/dist/esm/api/errors/MethodNotAllowedError.mjs +1 -1
  327. package/dist/esm/api/errors/NotFoundError.mjs +1 -1
  328. package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -1
  329. package/dist/esm/api/errors/PreconditionFailedError.mjs +1 -1
  330. package/dist/esm/api/errors/TooEarlyError.mjs +1 -1
  331. package/dist/esm/api/errors/TooManyRequestsError.mjs +1 -1
  332. package/dist/esm/api/errors/UnauthorizedError.mjs +1 -1
  333. package/dist/esm/api/errors/UnprocessableEntityError.mjs +1 -1
  334. package/dist/esm/api/errors/UnsupportedMediaTypeError.mjs +1 -1
  335. package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
  336. package/dist/esm/api/resources/account/client/Client.mjs +21 -13
  337. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
  338. package/dist/esm/api/resources/balance/client/Client.d.mts +9 -8
  339. package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
  340. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
  341. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
  342. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
  343. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
  344. package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
  345. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
  346. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
  347. package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
  348. package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
  349. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
  350. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
  351. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
  352. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
  353. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
  354. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
  355. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
  356. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
  357. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
  358. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
  359. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
  360. package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
  361. package/dist/esm/api/resources/balance/types/index.mjs +4 -0
  362. package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
  363. package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
  364. package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
  365. package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
  366. package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
  367. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
  368. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
  369. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
  370. package/dist/esm/api/resources/consentGroups/client/Client.d.mts +108 -0
  371. package/dist/esm/api/resources/consentGroups/client/Client.mjs +346 -0
  372. package/dist/esm/api/resources/consentGroups/client/index.d.mts +1 -0
  373. package/dist/esm/api/resources/consentGroups/client/index.mjs +1 -0
  374. package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.mts +25 -0
  375. package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.mjs +9 -0
  376. package/dist/esm/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.mts +10 -0
  377. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.mts +10 -0
  378. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.mjs +2 -0
  379. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.mts +17 -0
  380. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.mjs +2 -0
  381. package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.mts +24 -0
  382. package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.mjs +9 -0
  383. package/dist/esm/api/resources/consentGroups/client/requests/index.d.mts +5 -0
  384. package/dist/esm/api/resources/consentGroups/client/requests/index.mjs +2 -0
  385. package/dist/esm/api/resources/consentGroups/exports.d.mts +2 -0
  386. package/dist/esm/api/resources/consentGroups/exports.mjs +3 -0
  387. package/dist/esm/api/resources/consentGroups/index.d.mts +2 -0
  388. package/dist/esm/api/resources/consentGroups/index.mjs +2 -0
  389. package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.mts +5 -0
  390. package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.mjs +5 -0
  391. package/dist/esm/api/resources/consentGroups/types/index.d.mts +1 -0
  392. package/dist/esm/api/resources/consentGroups/types/index.mjs +1 -0
  393. package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
  394. package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
  395. package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
  396. package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
  397. package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
  398. package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
  399. package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
  400. package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +2 -0
  401. package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
  402. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
  403. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +8 -3
  404. package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +1 -1
  405. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
  406. package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
  407. package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
  408. package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
  409. package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
  410. package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
  411. package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
  412. package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
  413. package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
  414. package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
  415. package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
  416. package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
  417. package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
  418. package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
  419. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
  420. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
  421. package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
  422. package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
  423. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
  424. package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
  425. package/dist/esm/api/resources/deals/client/Client.mjs +62 -22
  426. package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +11 -3
  427. package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
  428. package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
  429. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
  430. package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
  431. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
  432. package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
  433. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
  434. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
  435. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
  436. package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
  437. package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
  438. package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +2 -2
  439. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  440. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
  441. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
  442. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
  443. package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
  444. package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
  445. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
  446. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
  447. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
  448. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
  449. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
  450. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
  451. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
  452. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
  453. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
  454. package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
  455. package/dist/esm/api/resources/event/client/Client.mjs +14 -8
  456. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
  457. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.mjs +2 -0
  458. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
  459. package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
  460. package/dist/esm/api/resources/event/index.d.mts +0 -1
  461. package/dist/esm/api/resources/event/index.mjs +0 -1
  462. package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
  463. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
  464. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
  465. package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
  466. package/dist/esm/api/resources/files/client/Client.mjs +19 -5
  467. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
  468. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
  469. package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
  470. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
  471. package/dist/esm/api/resources/index.d.mts +5 -1
  472. package/dist/esm/api/resources/index.mjs +5 -1
  473. package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
  474. package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
  475. package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
  476. package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
  477. package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
  478. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  479. package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
  480. package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
  481. package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
  482. package/dist/esm/api/resources/process/client/Client.mjs +19 -20
  483. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
  484. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
  485. package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
  486. package/dist/esm/api/resources/program/client/Client.mjs +26 -14
  487. package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
  488. package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
  489. package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
  490. package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
  491. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
  492. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
  493. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
  494. package/dist/esm/api/resources/program/types/index.d.mts +1 -0
  495. package/dist/esm/api/resources/program/types/index.mjs +1 -0
  496. package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
  497. package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
  498. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
  499. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
  500. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
  501. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
  502. package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
  503. package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
  504. package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
  505. package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
  506. package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
  507. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
  508. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
  509. package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
  510. package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
  511. package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
  512. package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
  513. package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
  514. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
  515. package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
  516. package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
  517. package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
  518. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
  519. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
  520. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
  521. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
  522. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
  523. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
  524. package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
  525. package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
  526. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
  527. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
  528. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
  529. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
  530. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
  531. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
  532. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
  533. package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +1 -1
  534. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
  535. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
  536. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
  537. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
  538. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
  539. package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
  540. package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
  541. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
  542. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
  543. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
  544. package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
  545. package/dist/esm/api/resources/user/client/Client.mjs +14 -6
  546. package/dist/esm/api/resources/wallet/client/Client.d.mts +34 -0
  547. package/dist/esm/api/resources/wallet/client/Client.mjs +89 -0
  548. package/dist/esm/api/resources/wallet/client/index.d.mts +1 -0
  549. package/dist/esm/api/resources/wallet/client/index.mjs +1 -0
  550. package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.mts +13 -0
  551. package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.mjs +2 -0
  552. package/dist/esm/api/resources/wallet/client/requests/index.d.mts +1 -0
  553. package/dist/esm/api/resources/wallet/client/requests/index.mjs +1 -0
  554. package/dist/esm/api/resources/wallet/exports.d.mts +2 -0
  555. package/dist/esm/api/resources/wallet/exports.mjs +3 -0
  556. package/dist/esm/api/resources/wallet/index.d.mts +1 -0
  557. package/dist/esm/api/resources/wallet/index.mjs +1 -0
  558. package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
  559. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
  560. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
  561. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
  562. package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
  563. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
  564. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
  565. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
  566. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
  567. package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
  568. package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
  569. package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
  570. package/dist/esm/api/types/BalanceLimit.mjs +21 -1
  571. package/dist/esm/api/types/Company.d.mts +1 -1
  572. package/dist/esm/api/types/ConsentGroup.d.mts +29 -0
  573. package/dist/esm/api/types/ConsentGroup.mjs +9 -0
  574. package/dist/esm/api/types/ConsentGroupItem.d.mts +17 -0
  575. package/dist/esm/api/types/ConsentGroupItem.mjs +9 -0
  576. package/dist/esm/api/types/ConsentGroupsListResponse.d.mts +14 -0
  577. package/dist/esm/api/types/ConsentGroupsListResponse.mjs +2 -0
  578. package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
  579. package/dist/esm/api/types/Deal.d.mts +4 -4
  580. package/dist/esm/api/types/FileData.d.mts +8 -6
  581. package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
  582. package/dist/esm/api/types/GetCampaignStats.d.mts +15 -15
  583. package/dist/esm/api/types/GetContactDetails.d.mts +5 -0
  584. package/dist/esm/api/types/GetEventsList.d.mts +0 -2
  585. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
  586. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
  587. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
  588. package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
  589. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
  590. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
  591. package/dist/esm/api/types/GetWebhook.d.mts +5 -10
  592. package/dist/esm/api/types/GetWebhook.mjs +2 -6
  593. package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
  594. package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
  595. package/dist/esm/api/types/Note.d.mts +10 -8
  596. package/dist/esm/api/types/NoteData.d.mts +1 -1
  597. package/dist/esm/api/types/Order.d.mts +1 -1
  598. package/dist/esm/api/types/Pipeline.d.mts +3 -3
  599. package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
  600. package/dist/esm/api/types/Task.d.mts +20 -8
  601. package/dist/esm/api/types/TierGroup.d.mts +66 -0
  602. package/dist/esm/api/types/TierGroup.mjs +30 -0
  603. package/dist/esm/api/types/Transaction.d.mts +36 -17
  604. package/dist/esm/api/types/Transaction.mjs +16 -1
  605. package/dist/esm/api/types/WalletPassInstallUrl.d.mts +4 -0
  606. package/dist/esm/api/types/WalletPassInstallUrl.mjs +2 -0
  607. package/dist/esm/api/types/index.d.mts +4 -0
  608. package/dist/esm/api/types/index.mjs +4 -0
  609. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  610. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  611. package/dist/esm/core/auth/index.d.mts +1 -1
  612. package/dist/esm/core/auth/index.mjs +1 -0
  613. package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
  614. package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
  615. package/dist/esm/core/fetcher/getResponseBody.mjs +11 -0
  616. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  617. package/dist/esm/core/fetcher/signals.mjs +9 -1
  618. package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
  619. package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
  620. package/dist/esm/core/url/index.d.mts +1 -0
  621. package/dist/esm/core/url/index.mjs +1 -0
  622. package/dist/esm/core/url/qs.d.mts +2 -1
  623. package/dist/esm/core/url/qs.mjs +25 -13
  624. package/dist/esm/errors/BrevoError.d.mts +1 -0
  625. package/dist/esm/errors/BrevoError.mjs +5 -1
  626. package/dist/esm/errors/BrevoTimeoutError.d.mts +2 -2
  627. package/dist/esm/errors/BrevoTimeoutError.mjs +7 -6
  628. package/dist/esm/version.d.mts +1 -1
  629. package/dist/esm/version.mjs +1 -1
  630. package/package.json +24 -2
  631. package/reference.md +2301 -170
  632. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
  633. package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
  634. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
  635. package/dist/esm/api/resources/event/types/index.d.mts +0 -1
  636. package/dist/esm/api/resources/event/types/index.mjs +0 -1
  637. /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
  638. /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → consentGroups/client/requests/DeleteConsentGroupRequest.js} +0 -0
  639. /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
  640. /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → consentGroups/client/requests/DeleteConsentGroupRequest.mjs} +0 -0
package/reference.md CHANGED
@@ -19,25 +19,22 @@ Retrieves details of your Brevo account.
19
19
  - Check plan details (type, credits, expiration)
20
20
  - Get relay information (for transactional emails)
21
21
  - Check Marketing Automation status
22
- - View date/time preferences and account settings
23
22
  - Access organization and user identifiers
24
23
 
25
24
  **Key information returned:**
26
25
  - Complete account details (organization ID, user ID, company information)
27
26
  - Address and contact information
28
27
  - Plan configurations and credit allocations across different verticals
29
- - Marketing Automation settings and tracker key
28
+ - Marketing Automation settings and tracker key (when enabled)
30
29
  - SMTP relay configuration for transactional emails
31
- - Date/time preferences and account settings
32
30
  - Enterprise features availability status
33
31
 
34
32
  **Important considerations:**
35
33
  - Provides comprehensive account overview for billing and configuration management
36
34
  - Essential for understanding current plan limitations and feature availability
37
- - Marketing Automation key required for advanced automation features
38
- - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories
35
+ - Marketing Automation key is only returned when Marketing Automation is enabled on the account
36
+ - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available)
39
37
  - Relay configuration crucial for transactional email setup and deliverability
40
- - Date/time preferences affect campaign scheduling and reporting displays
41
38
  - Enterprise status determines access to advanced features and sub-account management
42
39
  </dd>
43
40
  </dl>
@@ -1261,6 +1258,20 @@ await client.masterAccount.getSubAccountDetails({
1261
1258
  <dl>
1262
1259
  <dd>
1263
1260
 
1261
+ #### 📝 Description
1262
+
1263
+ <dl>
1264
+ <dd>
1265
+
1266
+ <dl>
1267
+ <dd>
1268
+
1269
+ Permanently deletes a sub-account from the corporate master account. Once deleted, all data associated with the sub-account organization is removed and cannot be recovered, so ensure the sub-account is no longer needed before proceeding.
1270
+ </dd>
1271
+ </dl>
1272
+ </dd>
1273
+ </dl>
1274
+
1264
1275
  #### 🔌 Usage
1265
1276
 
1266
1277
  <dl>
@@ -1931,6 +1942,20 @@ await client.masterAccount.changeAdminUserPermissions({
1931
1942
  <dl>
1932
1943
  <dd>
1933
1944
 
1945
+ #### 📝 Description
1946
+
1947
+ <dl>
1948
+ <dd>
1949
+
1950
+ <dl>
1951
+ <dd>
1952
+
1953
+ Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.
1954
+ </dd>
1955
+ </dl>
1956
+ </dd>
1957
+ </dl>
1958
+
1934
1959
  #### 🔌 Usage
1935
1960
 
1936
1961
  <dl>
@@ -1972,6 +1997,20 @@ await client.user.getInvitedUsersList();
1972
1997
  <dl>
1973
1998
  <dd>
1974
1999
 
2000
+ #### 📝 Description
2001
+
2002
+ <dl>
2003
+ <dd>
2004
+
2005
+ <dl>
2006
+ <dd>
2007
+
2008
+ Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user''s plan change generated credit notes, they are returned in the response for billing reconciliation.
2009
+ </dd>
2010
+ </dl>
2011
+ </dd>
2012
+ </dl>
2013
+
1975
2014
  #### 🔌 Usage
1976
2015
 
1977
2016
  <dl>
@@ -2157,6 +2196,20 @@ await client.user.inviteuser({
2157
2196
  <dl>
2158
2197
  <dd>
2159
2198
 
2199
+ #### 📝 Description
2200
+
2201
+ <dl>
2202
+ <dd>
2203
+
2204
+ <dl>
2205
+ <dd>
2206
+
2207
+ Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user''s pending access.
2208
+ </dd>
2209
+ </dl>
2210
+ </dd>
2211
+ </dl>
2212
+
2160
2213
  #### 🔌 Usage
2161
2214
 
2162
2215
  <dl>
@@ -2342,6 +2395,20 @@ await client.user.editUserPermission({
2342
2395
  <dl>
2343
2396
  <dd>
2344
2397
 
2398
+ #### 📝 Description
2399
+
2400
+ <dl>
2401
+ <dd>
2402
+
2403
+ <dl>
2404
+ <dd>
2405
+
2406
+ Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user''s current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.
2407
+ </dd>
2408
+ </dl>
2409
+ </dd>
2410
+ </dl>
2411
+
2345
2412
  #### 🔌 Usage
2346
2413
 
2347
2414
  <dl>
@@ -2412,20 +2479,19 @@ Retrieves a list of background processes from your Brevo account with filtering
2412
2479
  - Identify failed or stuck processes for troubleshooting
2413
2480
 
2414
2481
  **Key information returned:**
2415
- - Process details (ID, name, type, status)
2416
- - Process creation and completion timestamps
2417
- - Process progress and completion status
2418
- - Error information for failed processes
2419
- - Process result data and download links
2482
+ - Process details (ID, name, status)
2483
+ - Export download URLs for completed export processes
2484
+ - Import details with CSV report URLs for completed import processes
2485
+ - Total count of processes for pagination
2420
2486
 
2421
2487
  **Important considerations:**
2422
2488
  - Background processes handle long-running operations like imports and exports
2423
- - Process status indicates current state (queued, processing, completed, failed, cancelled)
2489
+ - Process status indicates current state (queued, processing, completed)
2424
2490
  - Export processes provide download URLs when completed
2425
- - Failed processes include error messages for troubleshooting
2491
+ - Import processes provide CSV report URLs with details about problematic records
2426
2492
  - Use pagination for accounts with many historical processes
2427
2493
  - Sort options available for creation order (ascending or descending)
2428
- - Different process types handle specific operations (imports, exports, calculations)
2494
+ - Default limit is 10 results per page, maximum is 50
2429
2495
  </dd>
2430
2496
  </dl>
2431
2497
  </dd>
@@ -2498,18 +2564,14 @@ Retrieves detailed information about a specific background process.
2498
2564
  - Track process execution times
2499
2565
 
2500
2566
  **Key information returned:**
2501
- - Complete process details and status
2502
- - Import/export statistics and results
2503
- - Error information for troubleshooting
2504
- - Download URLs for export processes
2505
- - Process timing and performance data
2567
+ - Complete process details (ID, name, status)
2568
+ - Download URLs for completed export processes
2569
+ - Import details with CSV report URLs for completed import processes
2506
2570
 
2507
2571
  **Important considerations:**
2508
- - Process ID must exist in your account
2509
- - Completed processes provide detailed statistics and results
2510
- - Export processes include download URLs when successful
2511
- - Failed processes contain error messages for debugging
2512
- - Timing information helps with performance analysis
2572
+ - Process ID must exist in your account and not be deleted
2573
+ - Completed export processes include download URLs
2574
+ - Completed import processes include CSV report URLs with details about problematic records
2513
2575
  - Different process types return different result structures
2514
2576
  </dd>
2515
2577
  </dl>
@@ -3588,7 +3650,6 @@ Key information returned:
3588
3650
 
3589
3651
  ```typescript
3590
3652
  await client.webhooks.createWebhook({
3591
- events: ["sent"],
3592
3653
  url: "http://requestb.in/173lyyx1"
3593
3654
  });
3594
3655
 
@@ -4377,24 +4438,51 @@ await client.externalFeeds.deleteExternalFeed({
4377
4438
 
4378
4439
  <Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
4379
4440
  This feature is in beta. These are subject to change.</Note>
4380
- This API allows bulk upsert of object records in a single request. Each object record may include
4381
- - Attributes
4382
- - Identifiers
4383
- - Associations
4384
- **Response:**
4385
- The API processes the request asynchronously and returns a processId that you can use to track the background process status.
4386
- **API and Schema Limitation:**
4387
- - Size:
4388
- - Max 1000 objects records per request
4389
- - Max request body size: 1 MB
4390
- - Max 500 attributes defined per object record upsert request
4391
- - This is coherent with schema limitation: an object cannot have more than 500 attributes.
4392
- - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
4393
- - Max 10 associations defined per associated object type, in each record of the request
4394
- - This is not a schema limitation. You can associate an object record to an unlimited number of other object records by running multiple requests.
4441
+ Performs bulk create or update (upsert) operations for object records in a single asynchronous request. This endpoint is optimized for high-volume data imports and synchronization scenarios.
4442
+
4443
+ **How Upsert Works:**
4444
+ - **Create**: Omit `identifiers`, or provide only `ext_id` (if it doesn't already exist). A new record is created with a Brevo-generated `id`.
4445
+ - **Update**: Provide `id` (Brevo internal ID) or an `ext_id` that already exists. The matching record is updated with the new attribute values.
4446
+ - **Important:** `id` is for **updates only**. Providing an `id` that does not belong to an existing record will fail during async processing (the HTTP response will still be 202, but the record will be rejected in the background). To create a new record with a stable external reference, use `ext_id` instead.
4447
+
4448
+ **Request Structure:**
4449
+ Each object record in the `records` array can include:
4450
+ - `identifiers`: Either `id` (internal Brevo ID) or `ext_id` (your external system ID) — required for updates. **Note:** use `id` (singular), not `ids`.
4451
+ - `attributes`: Key-value pairs where each key is the attribute **key** (e.g., `company_name`), not the attribute label (e.g., "Company Name").
4452
+ - `associations`: Controls linking and unlinking of associated records (optional). Each entry specifies:
4453
+ - `object_type`: The type of the associated object
4454
+ - `action`: `link` (default) to create the association, or `unlink` to remove it
4455
+ - `records`: The associated records to link or unlink (each identified by `ext_id` or `id`)
4456
+ - **Unlink is idempotent** — unlinking a non-existing association is a no-op (no error returned)
4457
+ - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry
4458
+ - Both associated records must already exist before a link can be created
4459
+
4460
+ > **Common mistake:** Passing the attribute **label** (the display name you see in the UI) instead of the attribute **key** will cause the attribute to be silently ignored and the record may not be created as expected.
4461
+
4462
+ **Asynchronous Processing:**
4463
+ - Returns immediately with a `processId` (HTTP 202 Accepted)
4464
+ - Use the processId to track status via the Get process API
4465
+
4466
+ **API and Schema Limitations:**
4467
+ - Max 1000 object records per request
4468
+ - Max request body size: 1 MB
4469
+ - Max 500 attributes per object record (matches the schema limit of 500 attributes per object)
4470
+ - Unknown attribute keys are silently ignored (no error, no attribute creation)
4471
+ - Max 10 association records per associated object-type in each record of the request. If you need more, send multiple requests.
4472
+
4473
+ **Important Behaviors:**
4474
+ - The object schema must be created before upserting records
4475
+ - Unknown attribute keys are silently ignored (no error, no creation)
4476
+ - Both associated object records must already exist before creating a link association
4477
+ - Unlink operations are idempotent: attempting to unlink a non-existing association returns success
4478
+ - `link` and `unlink` actions can be submitted for the same `object_type` in a single record entry
4479
+ - Contact objects cannot be created via this endpoint
4480
+ - For `category` and `multiple_category` attributes, pass the option **key** as the value (not the option label or option ID).
4481
+ - The `id` identifier (internal Brevo ID) can only be used for **updating** existing records. To create new records, either omit identifiers (Brevo auto-generates an ID) or provide an `ext_id`.
4482
+
4395
4483
  **Errors:**
4396
- - Make sure both object records exist before associating them, else the API will return an error.
4397
- - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
4484
+ - Make sure both object records exist before associating them, else the API will return an error.
4485
+ - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
4398
4486
  </dd>
4399
4487
  </dl>
4400
4488
  </dd>
@@ -4411,7 +4499,34 @@ This API allows bulk upsert of object records in a single request. Each object r
4411
4499
  ```typescript
4412
4500
  await client.customObjects.upsertrecords({
4413
4501
  object_type: "vehicle",
4414
- records: [{}]
4502
+ records: [{
4503
+ associations: [{
4504
+ object_type: "garage",
4505
+ action: "link",
4506
+ records: [{
4507
+ identifiers: {
4508
+ id: 435435
4509
+ }
4510
+ }]
4511
+ }, {
4512
+ object_type: "garage",
4513
+ action: "unlink",
4514
+ records: [{
4515
+ identifiers: {
4516
+ ext_id: "old-garage-001"
4517
+ }
4518
+ }]
4519
+ }],
4520
+ attributes: {
4521
+ "make": "Toyota",
4522
+ "model": "Camry",
4523
+ "year": 2020,
4524
+ "engine_type": "hybrid"
4525
+ },
4526
+ identifiers: {
4527
+ ext_id: "VIN123"
4528
+ }
4529
+ }]
4415
4530
  });
4416
4531
 
4417
4532
  ```
@@ -4530,8 +4645,8 @@ await client.customObjects.getrecords({
4530
4645
  <dd>
4531
4646
 
4532
4647
  Use this endpoint to delete multiple object records of the same object-type in one request.
4533
- The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**.
4534
- **API and Schema Limitations:** - Each request can contain up to **1000** object record identifiers - If more records must be deleted send multiple batch requests
4648
+ The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**.
4649
+ **Limitations:** - Each request can contain up to **1000** object record identifiers - Either `ids` or `ext_ids` must be provided, but **not both** in the same request - Deletion of Brevo standard object records is not supported via this endpoint - If more records must be deleted, send multiple batch requests
4535
4650
  </dd>
4536
4651
  </dl>
4537
4652
  </dd>
@@ -4592,6 +4707,20 @@ await client.customObjects.batchDeleteObjectRecords({
4592
4707
  <dl>
4593
4708
  <dd>
4594
4709
 
4710
+ #### 📝 Description
4711
+
4712
+ <dl>
4713
+ <dd>
4714
+
4715
+ <dl>
4716
+ <dd>
4717
+
4718
+ Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.
4719
+ </dd>
4720
+ </dl>
4721
+ </dd>
4722
+ </dl>
4723
+
4595
4724
  #### 🔌 Usage
4596
4725
 
4597
4726
  <dl>
@@ -4706,6 +4835,20 @@ await client.contacts.createContact();
4706
4835
  <dl>
4707
4836
  <dd>
4708
4837
 
4838
+ #### 📝 Description
4839
+
4840
+ <dl>
4841
+ <dd>
4842
+
4843
+ <dl>
4844
+ <dd>
4845
+
4846
+ Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.
4847
+ </dd>
4848
+ </dl>
4849
+ </dd>
4850
+ </dl>
4851
+
4709
4852
  #### 🔌 Usage
4710
4853
 
4711
4854
  <dl>
@@ -4747,6 +4890,20 @@ await client.contacts.getAttributes();
4747
4890
  <dl>
4748
4891
  <dd>
4749
4892
 
4893
+ #### 📝 Description
4894
+
4895
+ <dl>
4896
+ <dd>
4897
+
4898
+ <dl>
4899
+ <dd>
4900
+
4901
+ Create a new contact attribute under the specified category and name. The required body properties depend on the category: use "type" for normal, transactional, or category attributes; use "value" for calculated or global attributes; use "enumeration" for category attributes; and use "multiCategoryOptions" for normal multiple-choice attributes. None of the category or multicategory option values can exceed 200 characters.
4902
+ </dd>
4903
+ </dl>
4904
+ </dd>
4905
+ </dl>
4906
+
4750
4907
  #### 🔌 Usage
4751
4908
 
4752
4909
  <dl>
@@ -4799,6 +4956,20 @@ await client.contacts.createAttribute({
4799
4956
  <dl>
4800
4957
  <dd>
4801
4958
 
4959
+ #### 📝 Description
4960
+
4961
+ <dl>
4962
+ <dd>
4963
+
4964
+ <dl>
4965
+ <dd>
4966
+
4967
+ Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options. None of the category or multicategory option values can exceed 200 characters.
4968
+ </dd>
4969
+ </dl>
4970
+ </dd>
4971
+ </dl>
4972
+
4802
4973
  #### 🔌 Usage
4803
4974
 
4804
4975
  <dl>
@@ -4851,6 +5022,20 @@ await client.contacts.updateAttribute({
4851
5022
  <dl>
4852
5023
  <dd>
4853
5024
 
5025
+ #### 📝 Description
5026
+
5027
+ <dl>
5028
+ <dd>
5029
+
5030
+ <dl>
5031
+ <dd>
5032
+
5033
+ Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.
5034
+ </dd>
5035
+ </dl>
5036
+ </dd>
5037
+ </dl>
5038
+
4854
5039
  #### 🔌 Usage
4855
5040
 
4856
5041
  <dl>
@@ -4903,6 +5088,20 @@ await client.contacts.deleteAttribute({
4903
5088
  <dl>
4904
5089
  <dd>
4905
5090
 
5091
+ #### 📝 Description
5092
+
5093
+ <dl>
5094
+ <dd>
5095
+
5096
+ <dl>
5097
+ <dd>
5098
+
5099
+ Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.
5100
+ </dd>
5101
+ </dl>
5102
+ </dd>
5103
+ </dl>
5104
+
4906
5105
  #### 🔌 Usage
4907
5106
 
4908
5107
  <dl>
@@ -4956,6 +5155,20 @@ await client.contacts.deleteMultiAttributeOptions({
4956
5155
  <dl>
4957
5156
  <dd>
4958
5157
 
5158
+ #### 📝 Description
5159
+
5160
+ <dl>
5161
+ <dd>
5162
+
5163
+ <dl>
5164
+ <dd>
5165
+
5166
+ Update multiple contacts in a single API call by passing an array of contact objects. Each contact in the array must be identified by one of: email, id, or sms (only one identifier per contact). You can update attributes, blacklist status, list memberships, ext_id, and transactional email forbidden senders for each contact in the batch.
5167
+ </dd>
5168
+ </dl>
5169
+ </dd>
5170
+ </dl>
5171
+
4959
5172
  #### 🔌 Usage
4960
5173
 
4961
5174
  <dl>
@@ -5205,6 +5418,20 @@ await client.contacts.getFolders();
5205
5418
  <dl>
5206
5419
  <dd>
5207
5420
 
5421
+ #### 📝 Description
5422
+
5423
+ <dl>
5424
+ <dd>
5425
+
5426
+ <dl>
5427
+ <dd>
5428
+
5429
+ Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.
5430
+ </dd>
5431
+ </dl>
5432
+ </dd>
5433
+ </dl>
5434
+
5208
5435
  #### 🔌 Usage
5209
5436
 
5210
5437
  <dl>
@@ -5321,6 +5548,20 @@ await client.contacts.getFolder({
5321
5548
  <dl>
5322
5549
  <dd>
5323
5550
 
5551
+ #### 📝 Description
5552
+
5553
+ <dl>
5554
+ <dd>
5555
+
5556
+ <dl>
5557
+ <dd>
5558
+
5559
+ Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.
5560
+ </dd>
5561
+ </dl>
5562
+ </dd>
5563
+ </dl>
5564
+
5324
5565
  #### 🔌 Usage
5325
5566
 
5326
5567
  <dl>
@@ -5373,6 +5614,20 @@ await client.contacts.updateFolder({
5373
5614
  <dl>
5374
5615
  <dd>
5375
5616
 
5617
+ #### 📝 Description
5618
+
5619
+ <dl>
5620
+ <dd>
5621
+
5622
+ <dl>
5623
+ <dd>
5624
+
5625
+ Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.
5626
+ </dd>
5627
+ </dl>
5628
+ </dd>
5629
+ </dl>
5630
+
5376
5631
  #### 🔌 Usage
5377
5632
 
5378
5633
  <dl>
@@ -5619,6 +5874,20 @@ await client.contacts.getLists();
5619
5874
  <dl>
5620
5875
  <dd>
5621
5876
 
5877
+ #### 📝 Description
5878
+
5879
+ <dl>
5880
+ <dd>
5881
+
5882
+ <dl>
5883
+ <dd>
5884
+
5885
+ Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.
5886
+ </dd>
5887
+ </dl>
5888
+ </dd>
5889
+ </dl>
5890
+
5622
5891
  #### 🔌 Usage
5623
5892
 
5624
5893
  <dl>
@@ -5671,6 +5940,20 @@ await client.contacts.createList({
5671
5940
  <dl>
5672
5941
  <dd>
5673
5942
 
5943
+ #### 📝 Description
5944
+
5945
+ <dl>
5946
+ <dd>
5947
+
5948
+ <dl>
5949
+ <dd>
5950
+
5951
+ Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).
5952
+ </dd>
5953
+ </dl>
5954
+ </dd>
5955
+ </dl>
5956
+
5674
5957
  #### 🔌 Usage
5675
5958
 
5676
5959
  <dl>
@@ -5722,6 +6005,20 @@ await client.contacts.getList({
5722
6005
  <dl>
5723
6006
  <dd>
5724
6007
 
6008
+ #### 📝 Description
6009
+
6010
+ <dl>
6011
+ <dd>
6012
+
6013
+ <dl>
6014
+ <dd>
6015
+
6016
+ Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.
6017
+ </dd>
6018
+ </dl>
6019
+ </dd>
6020
+ </dl>
6021
+
5725
6022
  #### 🔌 Usage
5726
6023
 
5727
6024
  <dl>
@@ -5773,6 +6070,20 @@ await client.contacts.updateList({
5773
6070
  <dl>
5774
6071
  <dd>
5775
6072
 
6073
+ #### 📝 Description
6074
+
6075
+ <dl>
6076
+ <dd>
6077
+
6078
+ <dl>
6079
+ <dd>
6080
+
6081
+ Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.
6082
+ </dd>
6083
+ </dl>
6084
+ </dd>
6085
+ </dl>
6086
+
5776
6087
  #### 🔌 Usage
5777
6088
 
5778
6089
  <dl>
@@ -5824,7 +6135,7 @@ await client.contacts.deleteList({
5824
6135
  <dl>
5825
6136
  <dd>
5826
6137
 
5827
- #### 🔌 Usage
6138
+ #### 📝 Description
5828
6139
 
5829
6140
  <dl>
5830
6141
  <dd>
@@ -5832,10 +6143,24 @@ await client.contacts.deleteList({
5832
6143
  <dl>
5833
6144
  <dd>
5834
6145
 
5835
- ```typescript
5836
- await client.contacts.getContactsFromList({
5837
- listId: 1000000
5838
- });
6146
+ Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.
6147
+ </dd>
6148
+ </dl>
6149
+ </dd>
6150
+ </dl>
6151
+
6152
+ #### 🔌 Usage
6153
+
6154
+ <dl>
6155
+ <dd>
6156
+
6157
+ <dl>
6158
+ <dd>
6159
+
6160
+ ```typescript
6161
+ await client.contacts.getContactsFromList({
6162
+ listId: 1000000
6163
+ });
5839
6164
 
5840
6165
  ```
5841
6166
  </dd>
@@ -5983,6 +6308,20 @@ await client.contacts.removeContactFromList({
5983
6308
  <dl>
5984
6309
  <dd>
5985
6310
 
6311
+ #### 📝 Description
6312
+
6313
+ <dl>
6314
+ <dd>
6315
+
6316
+ <dl>
6317
+ <dd>
6318
+
6319
+ Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.
6320
+ </dd>
6321
+ </dl>
6322
+ </dd>
6323
+ </dl>
6324
+
5986
6325
  #### 🔌 Usage
5987
6326
 
5988
6327
  <dl>
@@ -6231,6 +6570,20 @@ await client.contacts.deleteContact({
6231
6570
  <dl>
6232
6571
  <dd>
6233
6572
 
6573
+ #### 📝 Description
6574
+
6575
+ <dl>
6576
+ <dd>
6577
+
6578
+ <dl>
6579
+ <dd>
6580
+
6581
+ Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes. By default, data covers the last 90 days; use startDate and endDate parameters (YYYY-MM-DD) to specify a custom range with a maximum span of 90 days.
6582
+ </dd>
6583
+ </dl>
6584
+ </dd>
6585
+ </dl>
6586
+
6234
6587
  #### 🔌 Usage
6235
6588
 
6236
6589
  <dl>
@@ -6278,8 +6631,8 @@ await client.contacts.getContactStats({
6278
6631
  </dl>
6279
6632
  </details>
6280
6633
 
6281
- ## Conversations
6282
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">setsAgentsStatusToOnlineFor23Minutes</a>({ ...params }) -> void</code></summary>
6634
+ ## ConsentGroups
6635
+ <details><summary><code>client.consentGroups.<a href="/src/api/resources/consentGroups/client/Client.ts">getConsentGroups</a>({ ...params }) -> Brevo.ConsentGroupsListResponse</code></summary>
6283
6636
  <dl>
6284
6637
  <dd>
6285
6638
 
@@ -6291,7 +6644,9 @@ await client.contacts.getContactStats({
6291
6644
  <dl>
6292
6645
  <dd>
6293
6646
 
6294
- We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
6647
+ Returns a paginated list of consent groups for the account.
6648
+
6649
+ <Note>This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated.</Note>
6295
6650
  </dd>
6296
6651
  </dl>
6297
6652
  </dd>
@@ -6306,9 +6661,7 @@ We recommend pinging this endpoint every minute for as long as the agent has to
6306
6661
  <dd>
6307
6662
 
6308
6663
  ```typescript
6309
- await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
6310
- agentId: "d9nKoegKSjmCtyK78"
6311
- });
6664
+ await client.consentGroups.getConsentGroups();
6312
6665
 
6313
6666
  ```
6314
6667
  </dd>
@@ -6324,7 +6677,7 @@ await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
6324
6677
  <dl>
6325
6678
  <dd>
6326
6679
 
6327
- **request:** `Brevo.PostConversationsAgentOnlinePingRequest`
6680
+ **request:** `Brevo.GetConsentGroupsRequest`
6328
6681
 
6329
6682
  </dd>
6330
6683
  </dl>
@@ -6332,7 +6685,7 @@ await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
6332
6685
  <dl>
6333
6686
  <dd>
6334
6687
 
6335
- **requestOptions:** `ConversationsClient.RequestOptions`
6688
+ **requestOptions:** `ConsentGroupsClient.RequestOptions`
6336
6689
 
6337
6690
  </dd>
6338
6691
  </dl>
@@ -6344,10 +6697,26 @@ await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
6344
6697
  </dl>
6345
6698
  </details>
6346
6699
 
6347
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">sendAMessageAsAnAgent</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
6700
+ <details><summary><code>client.consentGroups.<a href="/src/api/resources/consentGroups/client/Client.ts">createConsentGroup</a>({ ...params }) -> Brevo.ConsentGroup</code></summary>
6701
+ <dl>
6702
+ <dd>
6703
+
6704
+ #### 📝 Description
6705
+
6706
+ <dl>
6707
+ <dd>
6708
+
6348
6709
  <dl>
6349
6710
  <dd>
6350
6711
 
6712
+ Creates a new consent group for the account.
6713
+
6714
+ <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
6715
+ </dd>
6716
+ </dl>
6717
+ </dd>
6718
+ </dl>
6719
+
6351
6720
  #### 🔌 Usage
6352
6721
 
6353
6722
  <dl>
@@ -6357,10 +6726,9 @@ await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
6357
6726
  <dd>
6358
6727
 
6359
6728
  ```typescript
6360
- await client.conversations.sendAMessageAsAnAgent({
6361
- agentId: "d9nKoegKSjmCtyK78",
6362
- text: "Hello! How can I help you?",
6363
- visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
6729
+ await client.consentGroups.createConsentGroup({
6730
+ name: "Newsletter EU",
6731
+ signupMode: "manual"
6364
6732
  });
6365
6733
 
6366
6734
  ```
@@ -6377,7 +6745,7 @@ await client.conversations.sendAMessageAsAnAgent({
6377
6745
  <dl>
6378
6746
  <dd>
6379
6747
 
6380
- **request:** `Brevo.PostConversationsMessagesRequest`
6748
+ **request:** `Brevo.CreateConsentGroupRequest`
6381
6749
 
6382
6750
  </dd>
6383
6751
  </dl>
@@ -6385,7 +6753,7 @@ await client.conversations.sendAMessageAsAnAgent({
6385
6753
  <dl>
6386
6754
  <dd>
6387
6755
 
6388
- **requestOptions:** `ConversationsClient.RequestOptions`
6756
+ **requestOptions:** `ConsentGroupsClient.RequestOptions`
6389
6757
 
6390
6758
  </dd>
6391
6759
  </dl>
@@ -6397,10 +6765,26 @@ await client.conversations.sendAMessageAsAnAgent({
6397
6765
  </dl>
6398
6766
  </details>
6399
6767
 
6400
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getAMessage</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
6768
+ <details><summary><code>client.consentGroups.<a href="/src/api/resources/consentGroups/client/Client.ts">getConsentGroup</a>({ ...params }) -> Brevo.ConsentGroup</code></summary>
6769
+ <dl>
6770
+ <dd>
6771
+
6772
+ #### 📝 Description
6773
+
6774
+ <dl>
6775
+ <dd>
6776
+
6401
6777
  <dl>
6402
6778
  <dd>
6403
6779
 
6780
+ Returns a single consent group by ID for the account.
6781
+
6782
+ <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
6783
+ </dd>
6784
+ </dl>
6785
+ </dd>
6786
+ </dl>
6787
+
6404
6788
  #### 🔌 Usage
6405
6789
 
6406
6790
  <dl>
@@ -6410,8 +6794,8 @@ await client.conversations.sendAMessageAsAnAgent({
6410
6794
  <dd>
6411
6795
 
6412
6796
  ```typescript
6413
- await client.conversations.getAMessage({
6414
- id: "id"
6797
+ await client.consentGroups.getConsentGroup({
6798
+ id: 1000000
6415
6799
  });
6416
6800
 
6417
6801
  ```
@@ -6428,7 +6812,7 @@ await client.conversations.getAMessage({
6428
6812
  <dl>
6429
6813
  <dd>
6430
6814
 
6431
- **request:** `Brevo.GetConversationsMessagesIdRequest`
6815
+ **request:** `Brevo.GetConsentGroupRequest`
6432
6816
 
6433
6817
  </dd>
6434
6818
  </dl>
@@ -6436,7 +6820,7 @@ await client.conversations.getAMessage({
6436
6820
  <dl>
6437
6821
  <dd>
6438
6822
 
6439
- **requestOptions:** `ConversationsClient.RequestOptions`
6823
+ **requestOptions:** `ConsentGroupsClient.RequestOptions`
6440
6824
 
6441
6825
  </dd>
6442
6826
  </dl>
@@ -6448,7 +6832,7 @@ await client.conversations.getAMessage({
6448
6832
  </dl>
6449
6833
  </details>
6450
6834
 
6451
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">updateAMessageSentByAnAgent</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
6835
+ <details><summary><code>client.consentGroups.<a href="/src/api/resources/consentGroups/client/Client.ts">updateConsentGroup</a>({ ...params }) -> Brevo.ConsentGroup</code></summary>
6452
6836
  <dl>
6453
6837
  <dd>
6454
6838
 
@@ -6460,7 +6844,9 @@ await client.conversations.getAMessage({
6460
6844
  <dl>
6461
6845
  <dd>
6462
6846
 
6463
- Only agents’ messages can be edited.
6847
+ Updates name, description, or signupMode of a consent group. At least one field must be provided.
6848
+
6849
+ <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
6464
6850
  </dd>
6465
6851
  </dl>
6466
6852
  </dd>
@@ -6475,9 +6861,8 @@ Only agents’ messages can be edited.
6475
6861
  <dd>
6476
6862
 
6477
6863
  ```typescript
6478
- await client.conversations.updateAMessageSentByAnAgent({
6479
- id: "id",
6480
- text: "Good morning! How can I help you?"
6864
+ await client.consentGroups.updateConsentGroup({
6865
+ id: 1000000
6481
6866
  });
6482
6867
 
6483
6868
  ```
@@ -6494,7 +6879,7 @@ await client.conversations.updateAMessageSentByAnAgent({
6494
6879
  <dl>
6495
6880
  <dd>
6496
6881
 
6497
- **request:** `Brevo.PutConversationsMessagesIdRequest`
6882
+ **request:** `Brevo.UpdateConsentGroupRequest`
6498
6883
 
6499
6884
  </dd>
6500
6885
  </dl>
@@ -6502,7 +6887,7 @@ await client.conversations.updateAMessageSentByAnAgent({
6502
6887
  <dl>
6503
6888
  <dd>
6504
6889
 
6505
- **requestOptions:** `ConversationsClient.RequestOptions`
6890
+ **requestOptions:** `ConsentGroupsClient.RequestOptions`
6506
6891
 
6507
6892
  </dd>
6508
6893
  </dl>
@@ -6514,7 +6899,7 @@ await client.conversations.updateAMessageSentByAnAgent({
6514
6899
  </dl>
6515
6900
  </details>
6516
6901
 
6517
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">deleteAMessageSentByAnAgent</a>({ ...params }) -> void</code></summary>
6902
+ <details><summary><code>client.consentGroups.<a href="/src/api/resources/consentGroups/client/Client.ts">deleteConsentGroup</a>({ ...params }) -> void</code></summary>
6518
6903
  <dl>
6519
6904
  <dd>
6520
6905
 
@@ -6526,7 +6911,9 @@ await client.conversations.updateAMessageSentByAnAgent({
6526
6911
  <dl>
6527
6912
  <dd>
6528
6913
 
6529
- Only agents’ messages can be deleted.
6914
+ Deletes a consent group by ID and removes it from all associated contacts.
6915
+
6916
+ <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
6530
6917
  </dd>
6531
6918
  </dl>
6532
6919
  </dd>
@@ -6541,8 +6928,8 @@ Only agents’ messages can be deleted.
6541
6928
  <dd>
6542
6929
 
6543
6930
  ```typescript
6544
- await client.conversations.deleteAMessageSentByAnAgent({
6545
- id: "id"
6931
+ await client.consentGroups.deleteConsentGroup({
6932
+ id: 1000000
6546
6933
  });
6547
6934
 
6548
6935
  ```
@@ -6559,7 +6946,7 @@ await client.conversations.deleteAMessageSentByAnAgent({
6559
6946
  <dl>
6560
6947
  <dd>
6561
6948
 
6562
- **request:** `Brevo.DeleteConversationsMessagesIdRequest`
6949
+ **request:** `Brevo.DeleteConsentGroupRequest`
6563
6950
 
6564
6951
  </dd>
6565
6952
  </dl>
@@ -6567,7 +6954,7 @@ await client.conversations.deleteAMessageSentByAnAgent({
6567
6954
  <dl>
6568
6955
  <dd>
6569
6956
 
6570
- **requestOptions:** `ConversationsClient.RequestOptions`
6957
+ **requestOptions:** `ConsentGroupsClient.RequestOptions`
6571
6958
 
6572
6959
  </dd>
6573
6960
  </dl>
@@ -6579,7 +6966,8 @@ await client.conversations.deleteAMessageSentByAnAgent({
6579
6966
  </dl>
6580
6967
  </details>
6581
6968
 
6582
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">sendAnAutomatedMessageToAVisitor</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
6969
+ ## Conversations
6970
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">setsAgentsStatusToOnlineFor23Minutes</a>({ ...params }) -> void</code></summary>
6583
6971
  <dl>
6584
6972
  <dd>
6585
6973
 
@@ -6591,7 +6979,7 @@ await client.conversations.deleteAMessageSentByAnAgent({
6591
6979
  <dl>
6592
6980
  <dd>
6593
6981
 
6594
- Example of automated messages: order status, announce new features in your web app, etc.
6982
+ Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom`.
6595
6983
  </dd>
6596
6984
  </dl>
6597
6985
  </dd>
@@ -6606,10 +6994,8 @@ Example of automated messages: order status, announce new features in your web a
6606
6994
  <dd>
6607
6995
 
6608
6996
  ```typescript
6609
- await client.conversations.sendAnAutomatedMessageToAVisitor({
6610
- groupId: "PjRBMhWGen6aRHjif",
6611
- text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 3325 9667 4328 88",
6612
- visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
6997
+ await client.conversations.setsAgentsStatusToOnlineFor23Minutes({
6998
+ agentId: "d9nKoegKSjmCtyK78"
6613
6999
  });
6614
7000
 
6615
7001
  ```
@@ -6626,7 +7012,7 @@ await client.conversations.sendAnAutomatedMessageToAVisitor({
6626
7012
  <dl>
6627
7013
  <dd>
6628
7014
 
6629
- **request:** `Brevo.PostConversationsPushedMessagesRequest`
7015
+ **request:** `Brevo.PostConversationsAgentOnlinePingRequest`
6630
7016
 
6631
7017
  </dd>
6632
7018
  </dl>
@@ -6646,10 +7032,24 @@ await client.conversations.sendAnAutomatedMessageToAVisitor({
6646
7032
  </dl>
6647
7033
  </details>
6648
7034
 
6649
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getAnAutomatedMessage</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7035
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">sendAMessageAsAnAgent</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7036
+ <dl>
7037
+ <dd>
7038
+
7039
+ #### 📝 Description
7040
+
6650
7041
  <dl>
6651
7042
  <dd>
6652
7043
 
7044
+ <dl>
7045
+ <dd>
7046
+
7047
+ Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.
7048
+ </dd>
7049
+ </dl>
7050
+ </dd>
7051
+ </dl>
7052
+
6653
7053
  #### 🔌 Usage
6654
7054
 
6655
7055
  <dl>
@@ -6659,8 +7059,10 @@ await client.conversations.sendAnAutomatedMessageToAVisitor({
6659
7059
  <dd>
6660
7060
 
6661
7061
  ```typescript
6662
- await client.conversations.getAnAutomatedMessage({
6663
- id: "id"
7062
+ await client.conversations.sendAMessageAsAnAgent({
7063
+ agentId: "d9nKoegKSjmCtyK78",
7064
+ text: "Hello! How can I help you?",
7065
+ visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
6664
7066
  });
6665
7067
 
6666
7068
  ```
@@ -6677,7 +7079,7 @@ await client.conversations.getAnAutomatedMessage({
6677
7079
  <dl>
6678
7080
  <dd>
6679
7081
 
6680
- **request:** `Brevo.GetConversationsPushedMessagesIdRequest`
7082
+ **request:** `Brevo.PostConversationsMessagesRequest`
6681
7083
 
6682
7084
  </dd>
6683
7085
  </dl>
@@ -6697,10 +7099,24 @@ await client.conversations.getAnAutomatedMessage({
6697
7099
  </dl>
6698
7100
  </details>
6699
7101
 
6700
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">updateAnAutomatedMessage</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7102
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getAMessage</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7103
+ <dl>
7104
+ <dd>
7105
+
7106
+ #### 📝 Description
7107
+
7108
+ <dl>
7109
+ <dd>
7110
+
6701
7111
  <dl>
6702
7112
  <dd>
6703
7113
 
7114
+ Retrieve a single message by its ID.
7115
+ </dd>
7116
+ </dl>
7117
+ </dd>
7118
+ </dl>
7119
+
6704
7120
  #### 🔌 Usage
6705
7121
 
6706
7122
  <dl>
@@ -6710,9 +7126,8 @@ await client.conversations.getAnAutomatedMessage({
6710
7126
  <dd>
6711
7127
 
6712
7128
  ```typescript
6713
- await client.conversations.updateAnAutomatedMessage({
6714
- id: "id",
6715
- text: "Your order has shipped! Here\u2019s your tracking number: 9114 5847 4668 7775 9233 54"
7129
+ await client.conversations.getAMessage({
7130
+ id: "id"
6716
7131
  });
6717
7132
 
6718
7133
  ```
@@ -6729,7 +7144,7 @@ await client.conversations.updateAnAutomatedMessage({
6729
7144
  <dl>
6730
7145
  <dd>
6731
7146
 
6732
- **request:** `Brevo.PutConversationsPushedMessagesIdRequest`
7147
+ **request:** `Brevo.GetConversationsMessagesIdRequest`
6733
7148
 
6734
7149
  </dd>
6735
7150
  </dl>
@@ -6749,10 +7164,24 @@ await client.conversations.updateAnAutomatedMessage({
6749
7164
  </dl>
6750
7165
  </details>
6751
7166
 
6752
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">deleteAnAutomatedMessage</a>({ ...params }) -> void</code></summary>
7167
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">updateAMessageSentByAnAgent</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7168
+ <dl>
7169
+ <dd>
7170
+
7171
+ #### 📝 Description
7172
+
6753
7173
  <dl>
6754
7174
  <dd>
6755
7175
 
7176
+ <dl>
7177
+ <dd>
7178
+
7179
+ Update the text of a message sent by an agent. Only messages of type `agent` can be edited. The `text` and `html` fields of the message will be updated.
7180
+ </dd>
7181
+ </dl>
7182
+ </dd>
7183
+ </dl>
7184
+
6756
7185
  #### 🔌 Usage
6757
7186
 
6758
7187
  <dl>
@@ -6762,8 +7191,9 @@ await client.conversations.updateAnAutomatedMessage({
6762
7191
  <dd>
6763
7192
 
6764
7193
  ```typescript
6765
- await client.conversations.deleteAnAutomatedMessage({
6766
- id: "id"
7194
+ await client.conversations.updateAMessageSentByAnAgent({
7195
+ id: "id",
7196
+ text: "Good morning! How can I help you?"
6767
7197
  });
6768
7198
 
6769
7199
  ```
@@ -6780,7 +7210,7 @@ await client.conversations.deleteAnAutomatedMessage({
6780
7210
  <dl>
6781
7211
  <dd>
6782
7212
 
6783
- **request:** `Brevo.DeleteConversationsPushedMessagesIdRequest`
7213
+ **request:** `Brevo.PutConversationsMessagesIdRequest`
6784
7214
 
6785
7215
  </dd>
6786
7216
  </dl>
@@ -6800,7 +7230,7 @@ await client.conversations.deleteAnAutomatedMessage({
6800
7230
  </dl>
6801
7231
  </details>
6802
7232
 
6803
- <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">setVisitorGroupAssignment</a>({ ...params }) -> Brevo.PutConversationsVisitorGroupResponse</code></summary>
7233
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">deleteAMessageSentByAnAgent</a>({ ...params }) -> void</code></summary>
6804
7234
  <dl>
6805
7235
  <dd>
6806
7236
 
@@ -6812,7 +7242,7 @@ await client.conversations.deleteAnAutomatedMessage({
6812
7242
  <dl>
6813
7243
  <dd>
6814
7244
 
6815
- Assigns a visitor to a specific agent group or removes them from their current group.
7245
+ Delete a message sent by an agent. Only messages of type `agent` can be deleted.
6816
7246
  </dd>
6817
7247
  </dl>
6818
7248
  </dd>
@@ -6827,8 +7257,8 @@ Assigns a visitor to a specific agent group or removes them from their current g
6827
7257
  <dd>
6828
7258
 
6829
7259
  ```typescript
6830
- await client.conversations.setVisitorGroupAssignment({
6831
- groupId: "PjRBMhWGen6aRHjif"
7260
+ await client.conversations.deleteAMessageSentByAnAgent({
7261
+ id: "id"
6832
7262
  });
6833
7263
 
6834
7264
  ```
@@ -6845,7 +7275,7 @@ await client.conversations.setVisitorGroupAssignment({
6845
7275
  <dl>
6846
7276
  <dd>
6847
7277
 
6848
- **request:** `Brevo.PutConversationsVisitorGroupRequest`
7278
+ **request:** `Brevo.DeleteConversationsMessagesIdRequest`
6849
7279
 
6850
7280
  </dd>
6851
7281
  </dl>
@@ -6865,11 +7295,24 @@ await client.conversations.setVisitorGroupAssignment({
6865
7295
  </dl>
6866
7296
  </details>
6867
7297
 
6868
- ## Ecommerce
6869
- <details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">getCategories</a>({ ...params }) -> Brevo.GetCategoriesResponse</code></summary>
7298
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">sendAnAutomatedMessageToAVisitor</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7299
+ <dl>
7300
+ <dd>
7301
+
7302
+ #### 📝 Description
7303
+
6870
7304
  <dl>
6871
7305
  <dd>
6872
7306
 
7307
+ <dl>
7308
+ <dd>
7309
+
7310
+ Send an automated (pushed) message to a visitor on behalf of an agent. Example use cases: order status updates, announcing new features in your web app, etc.
7311
+ </dd>
7312
+ </dl>
7313
+ </dd>
7314
+ </dl>
7315
+
6873
7316
  #### 🔌 Usage
6874
7317
 
6875
7318
  <dl>
@@ -6879,7 +7322,11 @@ await client.conversations.setVisitorGroupAssignment({
6879
7322
  <dd>
6880
7323
 
6881
7324
  ```typescript
6882
- await client.ecommerce.getCategories();
7325
+ await client.conversations.sendAnAutomatedMessageToAVisitor({
7326
+ groupId: "PjRBMhWGen6aRHjif",
7327
+ text: "Your order has shipped! Here's your tracking number: 9114 5847 3325 9667 4328 88",
7328
+ visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
7329
+ });
6883
7330
 
6884
7331
  ```
6885
7332
  </dd>
@@ -6895,7 +7342,7 @@ await client.ecommerce.getCategories();
6895
7342
  <dl>
6896
7343
  <dd>
6897
7344
 
6898
- **request:** `Brevo.GetCategoriesRequest`
7345
+ **request:** `Brevo.PostConversationsPushedMessagesRequest`
6899
7346
 
6900
7347
  </dd>
6901
7348
  </dl>
@@ -6903,7 +7350,7 @@ await client.ecommerce.getCategories();
6903
7350
  <dl>
6904
7351
  <dd>
6905
7352
 
6906
- **requestOptions:** `EcommerceClient.RequestOptions`
7353
+ **requestOptions:** `ConversationsClient.RequestOptions`
6907
7354
 
6908
7355
  </dd>
6909
7356
  </dl>
@@ -6915,10 +7362,24 @@ await client.ecommerce.getCategories();
6915
7362
  </dl>
6916
7363
  </details>
6917
7364
 
6918
- <details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">createUpdateCategory</a>({ ...params }) -> Brevo.CreateUpdateCategoryResponse | undefined</code></summary>
7365
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getAnAutomatedMessage</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
7366
+ <dl>
7367
+ <dd>
7368
+
7369
+ #### 📝 Description
7370
+
6919
7371
  <dl>
6920
7372
  <dd>
6921
7373
 
7374
+ <dl>
7375
+ <dd>
7376
+
7377
+ Retrieve a single automated (pushed) message by its ID.
7378
+ </dd>
7379
+ </dl>
7380
+ </dd>
7381
+ </dl>
7382
+
6922
7383
  #### 🔌 Usage
6923
7384
 
6924
7385
  <dl>
@@ -6928,8 +7389,8 @@ await client.ecommerce.getCategories();
6928
7389
  <dd>
6929
7390
 
6930
7391
  ```typescript
6931
- await client.ecommerce.createUpdateCategory({
6932
- id: "CAT123"
7392
+ await client.conversations.getAnAutomatedMessage({
7393
+ id: "id"
6933
7394
  });
6934
7395
 
6935
7396
  ```
@@ -6946,7 +7407,7 @@ await client.ecommerce.createUpdateCategory({
6946
7407
  <dl>
6947
7408
  <dd>
6948
7409
 
6949
- **request:** `Brevo.CreateUpdateCategoryRequest`
7410
+ **request:** `Brevo.GetConversationsPushedMessagesIdRequest`
6950
7411
 
6951
7412
  </dd>
6952
7413
  </dl>
@@ -6954,7 +7415,7 @@ await client.ecommerce.createUpdateCategory({
6954
7415
  <dl>
6955
7416
  <dd>
6956
7417
 
6957
- **requestOptions:** `EcommerceClient.RequestOptions`
7418
+ **requestOptions:** `ConversationsClient.RequestOptions`
6958
7419
 
6959
7420
  </dd>
6960
7421
  </dl>
@@ -6966,11 +7427,11 @@ await client.ecommerce.createUpdateCategory({
6966
7427
  </dl>
6967
7428
  </details>
6968
7429
 
6969
- <details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">createUpdateBatchCategory</a>({ ...params }) -> Brevo.CreateUpdateBatchCategoryResponse</code></summary>
7430
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">updateAnAutomatedMessage</a>({ ...params }) -> Brevo.ConversationsMessage</code></summary>
6970
7431
  <dl>
6971
7432
  <dd>
6972
7433
 
6973
- #### 🔌 Usage
7434
+ #### 📝 Description
6974
7435
 
6975
7436
  <dl>
6976
7437
  <dd>
@@ -6978,20 +7439,13 @@ await client.ecommerce.createUpdateCategory({
6978
7439
  <dl>
6979
7440
  <dd>
6980
7441
 
6981
- ```typescript
6982
- await client.ecommerce.createUpdateBatchCategory({
6983
- categories: [{
6984
- id: "CAT123"
6985
- }]
6986
- });
6987
-
6988
- ```
7442
+ Update the text of an automated (pushed) message. The `text` and `html` fields of the message will be updated.
6989
7443
  </dd>
6990
7444
  </dl>
6991
7445
  </dd>
6992
7446
  </dl>
6993
7447
 
6994
- #### ⚙️ Parameters
7448
+ #### 🔌 Usage
6995
7449
 
6996
7450
  <dl>
6997
7451
  <dd>
@@ -6999,8 +7453,354 @@ await client.ecommerce.createUpdateBatchCategory({
6999
7453
  <dl>
7000
7454
  <dd>
7001
7455
 
7002
- **request:** `Brevo.CreateUpdateBatchCategoryRequest`
7003
-
7456
+ ```typescript
7457
+ await client.conversations.updateAnAutomatedMessage({
7458
+ id: "id",
7459
+ text: "Your order has shipped! Here's your tracking number: 9114 5847 4668 7775 9233 54"
7460
+ });
7461
+
7462
+ ```
7463
+ </dd>
7464
+ </dl>
7465
+ </dd>
7466
+ </dl>
7467
+
7468
+ #### ⚙️ Parameters
7469
+
7470
+ <dl>
7471
+ <dd>
7472
+
7473
+ <dl>
7474
+ <dd>
7475
+
7476
+ **request:** `Brevo.PutConversationsPushedMessagesIdRequest`
7477
+
7478
+ </dd>
7479
+ </dl>
7480
+
7481
+ <dl>
7482
+ <dd>
7483
+
7484
+ **requestOptions:** `ConversationsClient.RequestOptions`
7485
+
7486
+ </dd>
7487
+ </dl>
7488
+ </dd>
7489
+ </dl>
7490
+
7491
+
7492
+ </dd>
7493
+ </dl>
7494
+ </details>
7495
+
7496
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">deleteAnAutomatedMessage</a>({ ...params }) -> void</code></summary>
7497
+ <dl>
7498
+ <dd>
7499
+
7500
+ #### 📝 Description
7501
+
7502
+ <dl>
7503
+ <dd>
7504
+
7505
+ <dl>
7506
+ <dd>
7507
+
7508
+ Delete an automated (pushed) message by its ID.
7509
+ </dd>
7510
+ </dl>
7511
+ </dd>
7512
+ </dl>
7513
+
7514
+ #### 🔌 Usage
7515
+
7516
+ <dl>
7517
+ <dd>
7518
+
7519
+ <dl>
7520
+ <dd>
7521
+
7522
+ ```typescript
7523
+ await client.conversations.deleteAnAutomatedMessage({
7524
+ id: "id"
7525
+ });
7526
+
7527
+ ```
7528
+ </dd>
7529
+ </dl>
7530
+ </dd>
7531
+ </dl>
7532
+
7533
+ #### ⚙️ Parameters
7534
+
7535
+ <dl>
7536
+ <dd>
7537
+
7538
+ <dl>
7539
+ <dd>
7540
+
7541
+ **request:** `Brevo.DeleteConversationsPushedMessagesIdRequest`
7542
+
7543
+ </dd>
7544
+ </dl>
7545
+
7546
+ <dl>
7547
+ <dd>
7548
+
7549
+ **requestOptions:** `ConversationsClient.RequestOptions`
7550
+
7551
+ </dd>
7552
+ </dl>
7553
+ </dd>
7554
+ </dl>
7555
+
7556
+
7557
+ </dd>
7558
+ </dl>
7559
+ </details>
7560
+
7561
+ <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">setVisitorGroupAssignment</a>({ ...params }) -> Brevo.PutConversationsVisitorGroupResponse</code></summary>
7562
+ <dl>
7563
+ <dd>
7564
+
7565
+ #### 📝 Description
7566
+
7567
+ <dl>
7568
+ <dd>
7569
+
7570
+ <dl>
7571
+ <dd>
7572
+
7573
+ Assigns a visitor to a specific agent group or removes them from their current group.
7574
+ </dd>
7575
+ </dl>
7576
+ </dd>
7577
+ </dl>
7578
+
7579
+ #### 🔌 Usage
7580
+
7581
+ <dl>
7582
+ <dd>
7583
+
7584
+ <dl>
7585
+ <dd>
7586
+
7587
+ ```typescript
7588
+ await client.conversations.setVisitorGroupAssignment({
7589
+ groupId: "PjRBMhWGen6aRHjif"
7590
+ });
7591
+
7592
+ ```
7593
+ </dd>
7594
+ </dl>
7595
+ </dd>
7596
+ </dl>
7597
+
7598
+ #### ⚙️ Parameters
7599
+
7600
+ <dl>
7601
+ <dd>
7602
+
7603
+ <dl>
7604
+ <dd>
7605
+
7606
+ **request:** `Brevo.PutConversationsVisitorGroupRequest`
7607
+
7608
+ </dd>
7609
+ </dl>
7610
+
7611
+ <dl>
7612
+ <dd>
7613
+
7614
+ **requestOptions:** `ConversationsClient.RequestOptions`
7615
+
7616
+ </dd>
7617
+ </dl>
7618
+ </dd>
7619
+ </dl>
7620
+
7621
+
7622
+ </dd>
7623
+ </dl>
7624
+ </details>
7625
+
7626
+ ## Ecommerce
7627
+ <details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">getCategories</a>({ ...params }) -> Brevo.GetCategoriesResponse</code></summary>
7628
+ <dl>
7629
+ <dd>
7630
+
7631
+ #### 📝 Description
7632
+
7633
+ <dl>
7634
+ <dd>
7635
+
7636
+ <dl>
7637
+ <dd>
7638
+
7639
+ Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status. The response includes a `count` field with the total number of matching categories, and pagination defaults to 50 categories per page (maximum 100).
7640
+ </dd>
7641
+ </dl>
7642
+ </dd>
7643
+ </dl>
7644
+
7645
+ #### 🔌 Usage
7646
+
7647
+ <dl>
7648
+ <dd>
7649
+
7650
+ <dl>
7651
+ <dd>
7652
+
7653
+ ```typescript
7654
+ await client.ecommerce.getCategories();
7655
+
7656
+ ```
7657
+ </dd>
7658
+ </dl>
7659
+ </dd>
7660
+ </dl>
7661
+
7662
+ #### ⚙️ Parameters
7663
+
7664
+ <dl>
7665
+ <dd>
7666
+
7667
+ <dl>
7668
+ <dd>
7669
+
7670
+ **request:** `Brevo.GetCategoriesRequest`
7671
+
7672
+ </dd>
7673
+ </dl>
7674
+
7675
+ <dl>
7676
+ <dd>
7677
+
7678
+ **requestOptions:** `EcommerceClient.RequestOptions`
7679
+
7680
+ </dd>
7681
+ </dl>
7682
+ </dd>
7683
+ </dl>
7684
+
7685
+
7686
+ </dd>
7687
+ </dl>
7688
+ </details>
7689
+
7690
+ <details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">createUpdateCategory</a>({ ...params }) -> Brevo.CreateUpdateCategoryResponse | undefined</code></summary>
7691
+ <dl>
7692
+ <dd>
7693
+
7694
+ #### 📝 Description
7695
+
7696
+ <dl>
7697
+ <dd>
7698
+
7699
+ <dl>
7700
+ <dd>
7701
+
7702
+ Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new category or `204` when an existing category is updated. The `name` field is mandatory for creation but optional for updates.
7703
+ </dd>
7704
+ </dl>
7705
+ </dd>
7706
+ </dl>
7707
+
7708
+ #### 🔌 Usage
7709
+
7710
+ <dl>
7711
+ <dd>
7712
+
7713
+ <dl>
7714
+ <dd>
7715
+
7716
+ ```typescript
7717
+ await client.ecommerce.createUpdateCategory({
7718
+ id: "CAT123"
7719
+ });
7720
+
7721
+ ```
7722
+ </dd>
7723
+ </dl>
7724
+ </dd>
7725
+ </dl>
7726
+
7727
+ #### ⚙️ Parameters
7728
+
7729
+ <dl>
7730
+ <dd>
7731
+
7732
+ <dl>
7733
+ <dd>
7734
+
7735
+ **request:** `Brevo.CreateUpdateCategoryRequest`
7736
+
7737
+ </dd>
7738
+ </dl>
7739
+
7740
+ <dl>
7741
+ <dd>
7742
+
7743
+ **requestOptions:** `EcommerceClient.RequestOptions`
7744
+
7745
+ </dd>
7746
+ </dl>
7747
+ </dd>
7748
+ </dl>
7749
+
7750
+
7751
+ </dd>
7752
+ </dl>
7753
+ </details>
7754
+
7755
+ <details><summary><code>client.ecommerce.<a href="/src/api/resources/ecommerce/client/Client.ts">createUpdateBatchCategory</a>({ ...params }) -> Brevo.CreateUpdateBatchCategoryResponse</code></summary>
7756
+ <dl>
7757
+ <dd>
7758
+
7759
+ #### 📝 Description
7760
+
7761
+ <dl>
7762
+ <dd>
7763
+
7764
+ <dl>
7765
+ <dd>
7766
+
7767
+ Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing categories are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated categories.
7768
+ </dd>
7769
+ </dl>
7770
+ </dd>
7771
+ </dl>
7772
+
7773
+ #### 🔌 Usage
7774
+
7775
+ <dl>
7776
+ <dd>
7777
+
7778
+ <dl>
7779
+ <dd>
7780
+
7781
+ ```typescript
7782
+ await client.ecommerce.createUpdateBatchCategory({
7783
+ categories: [{
7784
+ id: "CAT123"
7785
+ }]
7786
+ });
7787
+
7788
+ ```
7789
+ </dd>
7790
+ </dl>
7791
+ </dd>
7792
+ </dl>
7793
+
7794
+ #### ⚙️ Parameters
7795
+
7796
+ <dl>
7797
+ <dd>
7798
+
7799
+ <dl>
7800
+ <dd>
7801
+
7802
+ **request:** `Brevo.CreateUpdateBatchCategoryRequest`
7803
+
7004
7804
  </dd>
7005
7805
  </dl>
7006
7806
 
@@ -7023,6 +7823,20 @@ await client.ecommerce.createUpdateBatchCategory({
7023
7823
  <dl>
7024
7824
  <dd>
7025
7825
 
7826
+ #### 📝 Description
7827
+
7828
+ <dl>
7829
+ <dd>
7830
+
7831
+ <dl>
7832
+ <dd>
7833
+
7834
+ Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.
7835
+ </dd>
7836
+ </dl>
7837
+ </dd>
7838
+ </dl>
7839
+
7026
7840
  #### 🔌 Usage
7027
7841
 
7028
7842
  <dl>
@@ -7129,6 +7943,20 @@ await client.ecommerce.activateTheECommerceApp();
7129
7943
  <dl>
7130
7944
  <dd>
7131
7945
 
7946
+ #### 📝 Description
7947
+
7948
+ <dl>
7949
+ <dd>
7950
+
7951
+ <dl>
7952
+ <dd>
7953
+
7954
+ Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format. The response includes per-source metrics (orders count, revenue, and average basket) as well as aggregated totals across all requested sources.
7955
+ </dd>
7956
+ </dl>
7957
+ </dd>
7958
+ </dl>
7959
+
7132
7960
  #### 🔌 Usage
7133
7961
 
7134
7962
  <dl>
@@ -7140,7 +7968,8 @@ await client.ecommerce.activateTheECommerceApp();
7140
7968
  ```typescript
7141
7969
  await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({
7142
7970
  periodFrom: "2022-01-02T00:00:00Z",
7143
- periodTo: "2022-01-03T00:00:00Z"
7971
+ periodTo: "2022-01-03T00:00:00Z",
7972
+ "emailCampaignId[]": ["sale"]
7144
7973
  });
7145
7974
 
7146
7975
  ```
@@ -7181,6 +8010,20 @@ await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflow
7181
8010
  <dl>
7182
8011
  <dd>
7183
8012
 
8013
+ #### 📝 Description
8014
+
8015
+ <dl>
8016
+ <dd>
8017
+
8018
+ <dl>
8019
+ <dd>
8020
+
8021
+ Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.
8022
+ </dd>
8023
+ </dl>
8024
+ </dd>
8025
+ </dl>
8026
+
7184
8027
  #### 🔌 Usage
7185
8028
 
7186
8029
  <dl>
@@ -7233,6 +8076,20 @@ await client.ecommerce.getDetailedAttributionMetricsForASingleBrevoCampaignOrWor
7233
8076
  <dl>
7234
8077
  <dd>
7235
8078
 
8079
+ #### 📝 Description
8080
+
8081
+ <dl>
8082
+ <dd>
8083
+
8084
+ <dl>
8085
+ <dd>
8086
+
8087
+ Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count. The conversion source type must be one of `email_campaign`, `sms_campaign`, `automation_workflow_email`, or `automation_workflow_sms`.
8088
+ </dd>
8089
+ </dl>
8090
+ </dd>
8091
+ </dl>
8092
+
7236
8093
  #### 🔌 Usage
7237
8094
 
7238
8095
  <dl>
@@ -7285,6 +8142,20 @@ await client.ecommerce.getAttributedProductSalesForASingleBrevoCampaignOrWorkflo
7285
8142
  <dl>
7286
8143
  <dd>
7287
8144
 
8145
+ #### 📝 Description
8146
+
8147
+ <dl>
8148
+ <dd>
8149
+
8150
+ <dl>
8151
+ <dd>
8152
+
8153
+ Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.
8154
+ </dd>
8155
+ </dl>
8156
+ </dd>
8157
+ </dl>
8158
+
7288
8159
  #### 🔌 Usage
7289
8160
 
7290
8161
  <dl>
@@ -7326,6 +8197,20 @@ await client.ecommerce.getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAcco
7326
8197
  <dl>
7327
8198
  <dd>
7328
8199
 
8200
+ #### 📝 Description
8201
+
8202
+ <dl>
8203
+ <dd>
8204
+
8205
+ <dl>
8206
+ <dd>
8207
+
8208
+ Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error. Returns a `403` error if ecommerce is not activated on the account.
8209
+ </dd>
8210
+ </dl>
8211
+ </dd>
8212
+ </dl>
8213
+
7329
8214
  #### 🔌 Usage
7330
8215
 
7331
8216
  <dl>
@@ -7588,6 +8473,20 @@ await client.ecommerce.createBatchOrder({
7588
8473
  <dl>
7589
8474
  <dd>
7590
8475
 
8476
+ #### 📝 Description
8477
+
8478
+ <dl>
8479
+ <dd>
8480
+
8481
+ <dl>
8482
+ <dd>
8483
+
8484
+ Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Use the `search` parameter to query across SKU, name, and ID simultaneously — results are prioritized as exact SKU match > SKU prefix match > name match > ID match. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.
8485
+ </dd>
8486
+ </dl>
8487
+ </dd>
8488
+ </dl>
8489
+
7591
8490
  #### 🔌 Usage
7592
8491
 
7593
8492
  <dl>
@@ -7637,6 +8536,20 @@ await client.ecommerce.getProducts();
7637
8536
  <dl>
7638
8537
  <dd>
7639
8538
 
8539
+ #### 📝 Description
8540
+
8541
+ <dl>
8542
+ <dd>
8543
+
8544
+ <dl>
8545
+ <dd>
8546
+
8547
+ Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new product or `204` for an update. The `name` field is mandatory for creation but optional for updates. Product images are downloaded, validated (max 5 MB, formats: jpeg, jpg, png, bmp, gif, webp), and re-hosted on S3. The `metaInfo` object supports up to 20 keys with a cumulative size limit of approximately 1000 KB.
8548
+ </dd>
8549
+ </dl>
8550
+ </dd>
8551
+ </dl>
8552
+
7640
8553
  #### 🔌 Usage
7641
8554
 
7642
8555
  <dl>
@@ -7689,6 +8602,20 @@ await client.ecommerce.createUpdateProduct({
7689
8602
  <dl>
7690
8603
  <dd>
7691
8604
 
8605
+ #### 📝 Description
8606
+
8607
+ <dl>
8608
+ <dd>
8609
+
8610
+ <dl>
8611
+ <dd>
8612
+
8613
+ Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit). Each product requires a unique `id` and `name` (name is mandatory for creation only). When `updateEnabled` is `false`, all products are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing products are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated products.
8614
+ </dd>
8615
+ </dl>
8616
+ </dd>
8617
+ </dl>
8618
+
7692
8619
  #### 🔌 Usage
7693
8620
 
7694
8621
  <dl>
@@ -7743,6 +8670,20 @@ await client.ecommerce.createUpdateBatchProducts({
7743
8670
  <dl>
7744
8671
  <dd>
7745
8672
 
8673
+ #### 📝 Description
8674
+
8675
+ <dl>
8676
+ <dd>
8677
+
8678
+ <dl>
8679
+ <dd>
8680
+
8681
+ Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status. Returns a `404` error if no product matches the provided ID.
8682
+ </dd>
8683
+ </dl>
8684
+ </dd>
8685
+ </dl>
8686
+
7746
8687
  #### 🔌 Usage
7747
8688
 
7748
8689
  <dl>
@@ -7794,6 +8735,20 @@ await client.ecommerce.getProductInfo({
7794
8735
  <dl>
7795
8736
  <dd>
7796
8737
 
8738
+ #### 📝 Description
8739
+
8740
+ <dl>
8741
+ <dd>
8742
+
8743
+ <dl>
8744
+ <dd>
8745
+
8746
+ Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`. Returns a `404` error if the product ID does not exist, and a `403` error if product alerts are not enabled for the account.
8747
+ </dd>
8748
+ </dl>
8749
+ </dd>
8750
+ </dl>
8751
+
7797
8752
  #### 🔌 Usage
7798
8753
 
7799
8754
  <dl>
@@ -7847,6 +8802,20 @@ await client.ecommerce.createProductAlert({
7847
8802
  <dl>
7848
8803
  <dd>
7849
8804
 
8805
+ #### 📝 Description
8806
+
8807
+ <dl>
8808
+ <dd>
8809
+
8810
+ <dl>
8811
+ <dd>
8812
+
8813
+ Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).
8814
+ </dd>
8815
+ </dl>
8816
+ </dd>
8817
+ </dl>
8818
+
7850
8819
  #### 🔌 Usage
7851
8820
 
7852
8821
  <dl>
@@ -7896,6 +8865,20 @@ await client.coupons.getCouponCollections();
7896
8865
  <dl>
7897
8866
  <dd>
7898
8867
 
8868
+ #### 📝 Description
8869
+
8870
+ <dl>
8871
+ <dd>
8872
+
8873
+ <dl>
8874
+ <dd>
8875
+
8876
+ Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.
8877
+ </dd>
8878
+ </dl>
8879
+ </dd>
8880
+ </dl>
8881
+
7899
8882
  #### 🔌 Usage
7900
8883
 
7901
8884
  <dl>
@@ -7948,6 +8931,20 @@ await client.coupons.createCouponCollection({
7948
8931
  <dl>
7949
8932
  <dd>
7950
8933
 
8934
+ #### 📝 Description
8935
+
8936
+ <dl>
8937
+ <dd>
8938
+
8939
+ <dl>
8940
+ <dd>
8941
+
8942
+ Retrieve the details of a single coupon collection by its UUID. The response includes the collection name, default coupon value, total and remaining coupon counts, and creation timestamp. Returns a `404` error if no collection matches the provided ID.
8943
+ </dd>
8944
+ </dl>
8945
+ </dd>
8946
+ </dl>
8947
+
7951
8948
  #### 🔌 Usage
7952
8949
 
7953
8950
  <dl>
@@ -7999,6 +8996,20 @@ await client.coupons.getCouponCollection({
7999
8996
  <dl>
8000
8997
  <dd>
8001
8998
 
8999
+ #### 📝 Description
9000
+
9001
+ <dl>
9002
+ <dd>
9003
+
9004
+ <dl>
9005
+ <dd>
9006
+
9007
+ Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass `null` to remove), and configure or disable alert thresholds for remaining coupons or remaining days. Only the fields included in the request body are updated; omitted fields remain unchanged.
9008
+ </dd>
9009
+ </dl>
9010
+ </dd>
9011
+ </dl>
9012
+
8002
9013
  #### 🔌 Usage
8003
9014
 
8004
9015
  <dl>
@@ -8050,6 +9061,20 @@ await client.coupons.updateCouponCollection({
8050
9061
  <dl>
8051
9062
  <dd>
8052
9063
 
9064
+ #### 📝 Description
9065
+
9066
+ <dl>
9067
+ <dd>
9068
+
9069
+ <dl>
9070
+ <dd>
9071
+
9072
+ Add coupons to an existing coupon collection. The `coupons` array must contain between 1 and 10,000 unique coupon code strings, all associated with the specified `collectionId`. Coupon creation is processed asynchronously and a `204` status is returned immediately upon acceptance. Returns a `404` error if the specified coupon collection does not exist.
9073
+ </dd>
9074
+ </dl>
9075
+ </dd>
9076
+ </dl>
9077
+
8053
9078
  #### 🔌 Usage
8054
9079
 
8055
9080
  <dl>
@@ -8103,6 +9128,20 @@ await client.coupons.createCoupons({
8103
9128
  <dl>
8104
9129
  <dd>
8105
9130
 
9131
+ #### 📝 Description
9132
+
9133
+ <dl>
9134
+ <dd>
9135
+
9136
+ <dl>
9137
+ <dd>
9138
+
9139
+ Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders. Returns the payment request ID and its public payment URL. A `403` error is returned if Brevo Payments is not activated or the account is not validated.
9140
+ </dd>
9141
+ </dl>
9142
+ </dd>
9143
+ </dl>
9144
+
8106
9145
  #### 🔌 Usage
8107
9146
 
8108
9147
  <dl>
@@ -8159,6 +9198,20 @@ await client.payments.createPaymentRequest({
8159
9198
  <dl>
8160
9199
  <dd>
8161
9200
 
9201
+ #### 📝 Description
9202
+
9203
+ <dl>
9204
+ <dd>
9205
+
9206
+ <dl>
9207
+ <dd>
9208
+
9209
+ Retrieve the details of a specific payment request by its ID. The response includes the reference, status (created, sent, reminderSent, or paid), cart details, notification configuration, contact ID, and the number of reminders sent. Returns a `404` error if no payment request matches the provided ID.
9210
+ </dd>
9211
+ </dl>
9212
+ </dd>
9213
+ </dl>
9214
+
8162
9215
  #### 🔌 Usage
8163
9216
 
8164
9217
  <dl>
@@ -8204,11 +9257,25 @@ await client.payments.getPaymentRequest({
8204
9257
 
8205
9258
  </dd>
8206
9259
  </dl>
8207
- </details>
8208
-
8209
- <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">deletePaymentRequest</a>({ ...params }) -> void</code></summary>
8210
- <dl>
8211
- <dd>
9260
+ </details>
9261
+
9262
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">deletePaymentRequest</a>({ ...params }) -> void</code></summary>
9263
+ <dl>
9264
+ <dd>
9265
+
9266
+ #### 📝 Description
9267
+
9268
+ <dl>
9269
+ <dd>
9270
+
9271
+ <dl>
9272
+ <dd>
9273
+
9274
+ Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a `404` error if no payment request matches the provided ID, and a `403` error if Brevo Payments is not activated or the account is not validated.
9275
+ </dd>
9276
+ </dl>
9277
+ </dd>
9278
+ </dl>
8212
9279
 
8213
9280
  #### 🔌 Usage
8214
9281
 
@@ -8418,10 +9485,12 @@ Create multiple events to track contacts' interactions in a single request.
8418
9485
  <dd>
8419
9486
 
8420
9487
  ```typescript
8421
- await client.event.createBatchEvents([{
8422
- event_name: "order_created",
8423
- identifiers: {}
8424
- }]);
9488
+ await client.event.createBatchEvents({
9489
+ events: [{
9490
+ event_name: "order_created",
9491
+ identifiers: {}
9492
+ }]
9493
+ });
8425
9494
 
8426
9495
  ```
8427
9496
  </dd>
@@ -8437,7 +9506,7 @@ await client.event.createBatchEvents([{
8437
9506
  <dl>
8438
9507
  <dd>
8439
9508
 
8440
- **request:** `Brevo.CreateBatchEventsRequestItem[]`
9509
+ **request:** `Brevo.CreateBatchEventsRequest`
8441
9510
 
8442
9511
  </dd>
8443
9512
  </dl>
@@ -8470,7 +9539,7 @@ await client.event.createBatchEvents([{
8470
9539
  <dl>
8471
9540
  <dd>
8472
9541
 
8473
- This endpoint will show the list of all the events for the received emails.
9542
+ This endpoint will show the list of all the events for the received emails. When no date range is provided, the last 30 days of events are returned by default.
8474
9543
  </dd>
8475
9544
  </dl>
8476
9545
  </dd>
@@ -8652,7 +9721,7 @@ await client.inboundParsing.getInboundEmailAttachment({
8652
9721
  </details>
8653
9722
 
8654
9723
  ## Balance
8655
- <details><summary><code>client.balance.<a href="/src/api/resources/balance/client/Client.ts">getActiveBalancesApi</a>({ ...params }) -> Brevo.BalanceLimit</code></summary>
9724
+ <details><summary><code>client.balance.<a href="/src/api/resources/balance/client/Client.ts">getActiveBalancesApi</a>({ ...params }) -> Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceResponse</code></summary>
8656
9725
  <dl>
8657
9726
  <dd>
8658
9727
 
@@ -8681,8 +9750,8 @@ Returns Active Balances
8681
9750
  ```typescript
8682
9751
  await client.balance.getActiveBalancesApi({
8683
9752
  pid: "pid",
8684
- contact_id: 1,
8685
- balance_definition_id: "balance_definition_id"
9753
+ contactId: 1000000,
9754
+ balanceDefinitionId: "balanceDefinitionId"
8686
9755
  });
8687
9756
 
8688
9757
  ```
@@ -8719,7 +9788,7 @@ await client.balance.getActiveBalancesApi({
8719
9788
  </dl>
8720
9789
  </details>
8721
9790
 
8722
- <details><summary><code>client.balance.<a href="/src/api/resources/balance/client/Client.ts">getBalanceDefinitionList</a>({ ...params }) -> Brevo.GetBalanceDefinitionListResponse</code></summary>
9791
+ <details><summary><code>client.balance.<a href="/src/api/resources/balance/client/Client.ts">getBalanceDefinitionList</a>({ ...params }) -> Brevo.GetBalanceDefinitionListResponse | undefined</code></summary>
8723
9792
  <dl>
8724
9793
  <dd>
8725
9794
 
@@ -9340,7 +10409,7 @@ await client.balance.deleteBalanceLimit({
9340
10409
  <dl>
9341
10410
  <dd>
9342
10411
 
9343
- Returns balance list
10412
+ Returns contact balances for a given balance definition across all subscriptions.
9344
10413
  </dd>
9345
10414
  </dl>
9346
10415
  </dd>
@@ -9356,7 +10425,8 @@ Returns balance list
9356
10425
 
9357
10426
  ```typescript
9358
10427
  await client.balance.getContactBalances({
9359
- pid: "pid"
10428
+ pid: "pid",
10429
+ balanceDefinitionId: "balanceDefinitionId"
9360
10430
  });
9361
10431
 
9362
10432
  ```
@@ -9426,7 +10496,7 @@ await client.balance.createBalanceOrder({
9426
10496
  balanceDefinitionId: "balanceDefinitionId",
9427
10497
  contactId: 1,
9428
10498
  dueAt: "dueAt",
9429
- source: "source"
10499
+ source: "engine"
9430
10500
  });
9431
10501
 
9432
10502
  ```
@@ -9625,7 +10695,7 @@ Returns transaction history
9625
10695
  ```typescript
9626
10696
  await client.balance.getTransactionHistoryApi({
9627
10697
  pid: "pid",
9628
- contactId: 1,
10698
+ contactId: 1000000,
9629
10699
  balanceDefinitionId: "balanceDefinitionId"
9630
10700
  });
9631
10701
 
@@ -10609,7 +11679,7 @@ Subscribes to a loyalty program
10609
11679
  ```typescript
10610
11680
  await client.program.subscribeToLoyaltyProgram({
10611
11681
  pid: "pid",
10612
- contactId: 1
11682
+ contactId: 1000000
10613
11683
  });
10614
11684
 
10615
11685
  ```
@@ -11968,6 +13038,73 @@ await client.tier.deleteTier({
11968
13038
  </dl>
11969
13039
 
11970
13040
 
13041
+ </dd>
13042
+ </dl>
13043
+ </details>
13044
+
13045
+ ## Wallet
13046
+ <details><summary><code>client.wallet.<a href="/src/api/resources/wallet/client/Client.ts">getWalletPassInstallUrl</a>({ ...params }) -> Brevo.WalletPassInstallUrl</code></summary>
13047
+ <dl>
13048
+ <dd>
13049
+
13050
+ #### 📝 Description
13051
+
13052
+ <dl>
13053
+ <dd>
13054
+
13055
+ <dl>
13056
+ <dd>
13057
+
13058
+ Generate a wallet installation URL for a specific contact. The returned URL points to the pass installation page and encodes the pass, contact and organization identifiers as an encrypted token, so it can be shared with the contact (email, SMS, QR code, ...) to add the pass to their Apple Wallet or Google Wallet.
13059
+ </dd>
13060
+ </dl>
13061
+ </dd>
13062
+ </dl>
13063
+
13064
+ #### 🔌 Usage
13065
+
13066
+ <dl>
13067
+ <dd>
13068
+
13069
+ <dl>
13070
+ <dd>
13071
+
13072
+ ```typescript
13073
+ await client.wallet.getWalletPassInstallUrl({
13074
+ passId: "passId",
13075
+ contactId: 1000000
13076
+ });
13077
+
13078
+ ```
13079
+ </dd>
13080
+ </dl>
13081
+ </dd>
13082
+ </dl>
13083
+
13084
+ #### ⚙️ Parameters
13085
+
13086
+ <dl>
13087
+ <dd>
13088
+
13089
+ <dl>
13090
+ <dd>
13091
+
13092
+ **request:** `Brevo.GetWalletPassInstallUrlRequest`
13093
+
13094
+ </dd>
13095
+ </dl>
13096
+
13097
+ <dl>
13098
+ <dd>
13099
+
13100
+ **requestOptions:** `WalletClient.RequestOptions`
13101
+
13102
+ </dd>
13103
+ </dl>
13104
+ </dd>
13105
+ </dl>
13106
+
13107
+
11971
13108
  </dd>
11972
13109
  </dl>
11973
13110
  </details>
@@ -11986,7 +13123,7 @@ await client.tier.deleteTier({
11986
13123
  <dd>
11987
13124
 
11988
13125
  <Note>The response payload for this endpoint has changed
11989
- You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).</Note>
13126
+ You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/2023/2/7).</Note>
11990
13127
  </dd>
11991
13128
  </dl>
11992
13129
  </dd>
@@ -12041,6 +13178,20 @@ await client.emailCampaigns.getEmailCampaigns();
12041
13178
  <dl>
12042
13179
  <dd>
12043
13180
 
13181
+ #### 📝 Description
13182
+
13183
+ <dl>
13184
+ <dd>
13185
+
13186
+ <dl>
13187
+ <dd>
13188
+
13189
+ Create a new email campaign. The campaign requires at minimum a name and sender details, and is created in draft status by default. You must provide email content via one of three mutually exclusive options: htmlContent (inline HTML), htmlUrl (remote URL), or templateId (existing template); additionally, A/B testing can be enabled by setting abTesting to true with subjectA and subjectB, but this is incompatible with sendAtBestTime.
13190
+ </dd>
13191
+ </dl>
13192
+ </dd>
13193
+ </dl>
13194
+
12044
13195
  #### 🔌 Usage
12045
13196
 
12046
13197
  <dl>
@@ -12093,6 +13244,20 @@ await client.emailCampaigns.createEmailCampaign({
12093
13244
  <dl>
12094
13245
  <dd>
12095
13246
 
13247
+ #### 📝 Description
13248
+
13249
+ <dl>
13250
+ <dd>
13251
+
13252
+ <dl>
13253
+ <dd>
13254
+
13255
+ Upload an image to your account''s image gallery by providing an absolute URL to the image. The maximum allowed image size is 2MB and supported formats are jpeg, jpg, png, bmp, and gif; local file uploads are not supported.
13256
+ </dd>
13257
+ </dl>
13258
+ </dd>
13259
+ </dl>
13260
+
12096
13261
  #### 🔌 Usage
12097
13262
 
12098
13263
  <dl>
@@ -12144,6 +13309,20 @@ await client.emailCampaigns.uploadImageToGallery({
12144
13309
  <dl>
12145
13310
  <dd>
12146
13311
 
13312
+ #### 📝 Description
13313
+
13314
+ <dl>
13315
+ <dd>
13316
+
13317
+ <dl>
13318
+ <dd>
13319
+
13320
+ Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content. Use the statistics query parameter to select which statistics to include (globalStats, linksStats, statsByDomain, statsByDevice, or statsByBrowser); statsByDevice and statsByBrowser are only available on this single-campaign endpoint. You can exclude HTML content from the response by setting excludeHtmlContent to true.
13321
+ </dd>
13322
+ </dl>
13323
+ </dd>
13324
+ </dl>
13325
+
12147
13326
  #### 🔌 Usage
12148
13327
 
12149
13328
  <dl>
@@ -12195,6 +13374,20 @@ await client.emailCampaigns.getEmailCampaign({
12195
13374
  <dl>
12196
13375
  <dd>
12197
13376
 
13377
+ #### 📝 Description
13378
+
13379
+ <dl>
13380
+ <dd>
13381
+
13382
+ <dl>
13383
+ <dd>
13384
+
13385
+ Update an existing email campaign''s properties such as name, subject, content, sender, recipients, schedule, and A/B testing configuration. The campaign must exist and the request body must contain at least one valid field to update. Only draft or scheduled campaigns can be modified; if sendAtBestTime is enabled, IP warmup will be automatically disabled.
13386
+ </dd>
13387
+ </dl>
13388
+ </dd>
13389
+ </dl>
13390
+
12198
13391
  #### 🔌 Usage
12199
13392
 
12200
13393
  <dl>
@@ -12246,6 +13439,20 @@ await client.emailCampaigns.updateEmailCampaign({
12246
13439
  <dl>
12247
13440
  <dd>
12248
13441
 
13442
+ #### 📝 Description
13443
+
13444
+ <dl>
13445
+ <dd>
13446
+
13447
+ <dl>
13448
+ <dd>
13449
+
13450
+ Delete an email campaign by its campaign ID. Only campaigns that have not been scheduled can be deleted; attempting to delete a campaign that has already been scheduled will return a 403 permission denied error. Related data in templates, newsletter builder, and schedule collections is also cleaned up.
13451
+ </dd>
13452
+ </dl>
13453
+ </dd>
13454
+ </dl>
13455
+
12249
13456
  #### 🔌 Usage
12250
13457
 
12251
13458
  <dl>
@@ -12362,6 +13569,20 @@ await client.emailCampaigns.getAbTestCampaignResult({
12362
13569
  <dl>
12363
13570
  <dd>
12364
13571
 
13572
+ #### 📝 Description
13573
+
13574
+ <dl>
13575
+ <dd>
13576
+
13577
+ <dl>
13578
+ <dd>
13579
+
13580
+ Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g. openers, clickers, hardBounces). The recipientsType field is required and determines which subset of recipients to export. An optional notifyURL webhook will be called once the export is complete, and the response returns a processId to track the export status.
13581
+ </dd>
13582
+ </dl>
13583
+ </dd>
13584
+ </dl>
13585
+
12365
13586
  #### 🔌 Usage
12366
13587
 
12367
13588
  <dl>
@@ -12414,6 +13635,20 @@ await client.emailCampaigns.emailExportRecipients({
12414
13635
  <dl>
12415
13636
  <dd>
12416
13637
 
13638
+ #### 📝 Description
13639
+
13640
+ <dl>
13641
+ <dd>
13642
+
13643
+ <dl>
13644
+ <dd>
13645
+
13646
+ Send an existing email campaign immediately by scheduling it for the current time. The campaign must have valid recipients and content configured before sending. The system verifies your account''s send limit and credit balance before dispatching; if credits are insufficient, a 402 error is returned.
13647
+ </dd>
13648
+ </dl>
13649
+ </dd>
13650
+ </dl>
13651
+
12417
13652
  #### 🔌 Usage
12418
13653
 
12419
13654
  <dl>
@@ -12536,6 +13771,20 @@ await client.emailCampaigns.sendReport({
12536
13771
  <dl>
12537
13772
  <dd>
12538
13773
 
13774
+ #### 📝 Description
13775
+
13776
+ <dl>
13777
+ <dd>
13778
+
13779
+ <dl>
13780
+ <dd>
13781
+
13782
+ Send a test version of an email campaign to specified email addresses or your entire test list. If the emailTo array is left empty, the test mail will be sent to all addresses in your test list. You can send a maximum of 50 test emails per day.
13783
+ </dd>
13784
+ </dl>
13785
+ </dd>
13786
+ </dl>
13787
+
12539
13788
  #### 🔌 Usage
12540
13789
 
12541
13790
  <dl>
@@ -12653,6 +13902,20 @@ await client.emailCampaigns.getSharedTemplateUrl({
12653
13902
  <dl>
12654
13903
  <dd>
12655
13904
 
13905
+ #### 📝 Description
13906
+
13907
+ <dl>
13908
+ <dd>
13909
+
13910
+ <dl>
13911
+ <dd>
13912
+
13913
+ Update the status of an email campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
13914
+ </dd>
13915
+ </dl>
13916
+ </dd>
13917
+ </dl>
13918
+
12656
13919
  #### 🔌 Usage
12657
13920
 
12658
13921
  <dl>
@@ -12706,6 +13969,20 @@ await client.emailCampaigns.updateCampaignStatus({
12706
13969
  <dl>
12707
13970
  <dd>
12708
13971
 
13972
+ #### 📝 Description
13973
+
13974
+ <dl>
13975
+ <dd>
13976
+
13977
+ <dl>
13978
+ <dd>
13979
+
13980
+ Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
13981
+ </dd>
13982
+ </dl>
13983
+ </dd>
13984
+ </dl>
13985
+
12709
13986
  #### 🔌 Usage
12710
13987
 
12711
13988
  <dl>
@@ -12755,6 +14032,20 @@ await client.smsCampaigns.getSmsCampaigns();
12755
14032
  <dl>
12756
14033
  <dd>
12757
14034
 
14035
+ #### 📝 Description
14036
+
14037
+ <dl>
14038
+ <dd>
14039
+
14040
+ <dl>
14041
+ <dd>
14042
+
14043
+ Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.
14044
+ </dd>
14045
+ </dl>
14046
+ </dd>
14047
+ </dl>
14048
+
12758
14049
  #### 🔌 Usage
12759
14050
 
12760
14051
  <dl>
@@ -12808,6 +14099,20 @@ await client.smsCampaigns.createSmsCampaign({
12808
14099
  <dl>
12809
14100
  <dd>
12810
14101
 
14102
+ #### 📝 Description
14103
+
14104
+ <dl>
14105
+ <dd>
14106
+
14107
+ <dl>
14108
+ <dd>
14109
+
14110
+ Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.
14111
+ </dd>
14112
+ </dl>
14113
+ </dd>
14114
+ </dl>
14115
+
12811
14116
  #### 🔌 Usage
12812
14117
 
12813
14118
  <dl>
@@ -12859,6 +14164,20 @@ await client.smsCampaigns.getSmsCampaign({
12859
14164
  <dl>
12860
14165
  <dd>
12861
14166
 
14167
+ #### 📝 Description
14168
+
14169
+ <dl>
14170
+ <dd>
14171
+
14172
+ <dl>
14173
+ <dd>
14174
+
14175
+ Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.
14176
+ </dd>
14177
+ </dl>
14178
+ </dd>
14179
+ </dl>
14180
+
12862
14181
  #### 🔌 Usage
12863
14182
 
12864
14183
  <dl>
@@ -12910,6 +14229,20 @@ await client.smsCampaigns.updateSmsCampaign({
12910
14229
  <dl>
12911
14230
  <dd>
12912
14231
 
14232
+ #### 📝 Description
14233
+
14234
+ <dl>
14235
+ <dd>
14236
+
14237
+ <dl>
14238
+ <dd>
14239
+
14240
+ Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.
14241
+ </dd>
14242
+ </dl>
14243
+ </dd>
14244
+ </dl>
14245
+
12913
14246
  #### 🔌 Usage
12914
14247
 
12915
14248
  <dl>
@@ -13027,6 +14360,20 @@ await client.smsCampaigns.requestSmsRecipientExport({
13027
14360
  <dl>
13028
14361
  <dd>
13029
14362
 
14363
+ #### 📝 Description
14364
+
14365
+ <dl>
14366
+ <dd>
14367
+
14368
+ <dl>
14369
+ <dd>
14370
+
14371
+ Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.
14372
+ </dd>
14373
+ </dl>
14374
+ </dd>
14375
+ </dl>
14376
+
13030
14377
  #### 🔌 Usage
13031
14378
 
13032
14379
  <dl>
@@ -13149,6 +14496,20 @@ await client.smsCampaigns.sendSmsReport({
13149
14496
  <dl>
13150
14497
  <dd>
13151
14498
 
14499
+ #### 📝 Description
14500
+
14501
+ <dl>
14502
+ <dd>
14503
+
14504
+ <dl>
14505
+ <dd>
14506
+
14507
+ Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).
14508
+ </dd>
14509
+ </dl>
14510
+ </dd>
14511
+ </dl>
14512
+
13152
14513
  #### 🔌 Usage
13153
14514
 
13154
14515
  <dl>
@@ -13200,6 +14561,20 @@ await client.smsCampaigns.sendTestSms({
13200
14561
  <dl>
13201
14562
  <dd>
13202
14563
 
14564
+ #### 📝 Description
14565
+
14566
+ <dl>
14567
+ <dd>
14568
+
14569
+ <dl>
14570
+ <dd>
14571
+
14572
+ Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
14573
+ </dd>
14574
+ </dl>
14575
+ </dd>
14576
+ </dl>
14577
+
13203
14578
  #### 🔌 Usage
13204
14579
 
13205
14580
  <dl>
@@ -13253,6 +14628,20 @@ await client.smsCampaigns.updateSmsCampaignStatus({
13253
14628
  <dl>
13254
14629
  <dd>
13255
14630
 
14631
+ #### 📝 Description
14632
+
14633
+ <dl>
14634
+ <dd>
14635
+
14636
+ <dl>
14637
+ <dd>
14638
+
14639
+ Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
14640
+ </dd>
14641
+ </dl>
14642
+ </dd>
14643
+ </dl>
14644
+
13256
14645
  #### 🔌 Usage
13257
14646
 
13258
14647
  <dl>
@@ -13499,6 +14888,20 @@ await client.whatsAppCampaigns.createWhatsAppTemplate({
13499
14888
  <dl>
13500
14889
  <dd>
13501
14890
 
14891
+ #### 📝 Description
14892
+
14893
+ <dl>
14894
+ <dd>
14895
+
14896
+ <dl>
14897
+ <dd>
14898
+
14899
+ Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
14900
+ </dd>
14901
+ </dl>
14902
+ </dd>
14903
+ </dl>
14904
+
13502
14905
  #### 🔌 Usage
13503
14906
 
13504
14907
  <dl>
@@ -13752,6 +15155,20 @@ await client.whatsAppCampaigns.updateWhatsAppCampaign({
13752
15155
  <dl>
13753
15156
  <dd>
13754
15157
 
15158
+ #### 📝 Description
15159
+
15160
+ <dl>
15161
+ <dd>
15162
+
15163
+ <dl>
15164
+ <dd>
15165
+
15166
+ Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.
15167
+ </dd>
15168
+ </dl>
15169
+ </dd>
15170
+ </dl>
15171
+
13755
15172
  #### 🔌 Usage
13756
15173
 
13757
15174
  <dl>
@@ -13804,6 +15221,20 @@ await client.whatsAppCampaigns.deleteWhatsAppCampaign({
13804
15221
  <dl>
13805
15222
  <dd>
13806
15223
 
15224
+ #### 📝 Description
15225
+
15226
+ <dl>
15227
+ <dd>
15228
+
15229
+ <dl>
15230
+ <dd>
15231
+
15232
+ Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default, and can be filtered by attributes, linked contacts, linked deals, or modification/creation timestamps.
15233
+ </dd>
15234
+ </dl>
15235
+ </dd>
15236
+ </dl>
15237
+
13807
15238
  #### 🔌 Usage
13808
15239
 
13809
15240
  <dl>
@@ -13853,6 +15284,20 @@ await client.companies.getAllCompanies();
13853
15284
  <dl>
13854
15285
  <dd>
13855
15286
 
15287
+ #### 📝 Description
15288
+
15289
+ <dl>
15290
+ <dd>
15291
+
15292
+ <dl>
15293
+ <dd>
15294
+
15295
+ Create a new CRM company with the specified name, attributes, and optional associations to contacts and deals. The company name is required, and you can optionally provide a country code when a phone number attribute is included.
15296
+ </dd>
15297
+ </dl>
15298
+ </dd>
15299
+ </dl>
15300
+
13856
15301
  #### 🔌 Usage
13857
15302
 
13858
15303
  <dl>
@@ -13967,6 +15412,20 @@ await client.companies.importCompaniesCreationAndUpdation({});
13967
15412
  <dl>
13968
15413
  <dd>
13969
15414
 
15415
+ #### 📝 Description
15416
+
15417
+ <dl>
15418
+ <dd>
15419
+
15420
+ <dl>
15421
+ <dd>
15422
+
15423
+ Link or unlink contacts and deals with a specific company in a single request. You can simultaneously link new contacts/deals and unlink existing ones by providing the respective ID arrays in the request body.
15424
+ </dd>
15425
+ </dl>
15426
+ </dd>
15427
+ </dl>
15428
+
13970
15429
  #### 🔌 Usage
13971
15430
 
13972
15431
  <dl>
@@ -14018,6 +15477,20 @@ await client.companies.linkAndUnlinkCompanyWithContactAndDeal({
14018
15477
  <dl>
14019
15478
  <dd>
14020
15479
 
15480
+ #### 📝 Description
15481
+
15482
+ <dl>
15483
+ <dd>
15484
+
15485
+ <dl>
15486
+ <dd>
15487
+
15488
+ Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals. Returns a 404 error if the company does not exist, or a 403 error if the user lacks permission to view the company.
15489
+ </dd>
15490
+ </dl>
15491
+ </dd>
15492
+ </dl>
15493
+
14021
15494
  #### 🔌 Usage
14022
15495
 
14023
15496
  <dl>
@@ -14069,6 +15542,20 @@ await client.companies.getACompany({
14069
15542
  <dl>
14070
15543
  <dd>
14071
15544
 
15545
+ #### 📝 Description
15546
+
15547
+ <dl>
15548
+ <dd>
15549
+
15550
+ <dl>
15551
+ <dd>
15552
+
15553
+ Permanently delete a company by its identifier. The requesting user must be the company owner or have manage permission on companies; otherwise, a 403 Forbidden error is returned.
15554
+ </dd>
15555
+ </dl>
15556
+ </dd>
15557
+ </dl>
15558
+
14072
15559
  #### 🔌 Usage
14073
15560
 
14074
15561
  <dl>
@@ -14120,6 +15607,20 @@ await client.companies.deleteACompany({
14120
15607
  <dl>
14121
15608
  <dd>
14122
15609
 
15610
+ #### 📝 Description
15611
+
15612
+ <dl>
15613
+ <dd>
15614
+
15615
+ <dl>
15616
+ <dd>
15617
+
15618
+ Update an existing company''s attributes, name, linked contacts, or linked deals. Note that passing `linkedContactsIds` or `linkedDealsIds` replaces the entire list of associations, so omitted IDs will be removed. The company name cannot be set to an empty string.
15619
+ </dd>
15620
+ </dl>
15621
+ </dd>
15622
+ </dl>
15623
+
14123
15624
  #### 🔌 Usage
14124
15625
 
14125
15626
  <dl>
@@ -14171,6 +15672,20 @@ await client.companies.updateACompany({
14171
15672
  <dl>
14172
15673
  <dd>
14173
15674
 
15675
+ #### 📝 Description
15676
+
15677
+ <dl>
15678
+ <dd>
15679
+
15680
+ <dl>
15681
+ <dd>
15682
+
15683
+ Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For `single-select` or `multi-choice` attribute types, you must also provide the `optionsLabels` array.
15684
+ </dd>
15685
+ </dl>
15686
+ </dd>
15687
+ </dl>
15688
+
14174
15689
  #### 🔌 Usage
14175
15690
 
14176
15691
  <dl>
@@ -14224,6 +15739,20 @@ await client.companies.createACompanyDealAttribute({
14224
15739
  <dl>
14225
15740
  <dd>
14226
15741
 
15742
+ #### 📝 Description
15743
+
15744
+ <dl>
15745
+ <dd>
15746
+
15747
+ <dl>
15748
+ <dd>
15749
+
15750
+ Delete an existing custom attribute by its identifier. This permanently removes the attribute definition and cleans up all references to it across companies or deals. System-default and non-editable attributes cannot be deleted.
15751
+ </dd>
15752
+ </dl>
15753
+ </dd>
15754
+ </dl>
15755
+
14227
15756
  #### 🔌 Usage
14228
15757
 
14229
15758
  <dl>
@@ -14275,6 +15804,20 @@ await client.companies.deleteAnAttribute({
14275
15804
  <dl>
14276
15805
  <dd>
14277
15806
 
15807
+ #### 📝 Description
15808
+
15809
+ <dl>
15810
+ <dd>
15811
+
15812
+ <dl>
15813
+ <dd>
15814
+
15815
+ Update an existing custom attribute''s label or options. You can rename the attribute label or modify the available options for `single-select` and `multi-choice` attribute types. System-default attributes cannot be modified except for specific editable fields.
15816
+ </dd>
15817
+ </dl>
15818
+ </dd>
15819
+ </dl>
15820
+
14278
15821
  #### 🔌 Usage
14279
15822
 
14280
15823
  <dl>
@@ -14326,6 +15869,20 @@ await client.companies.updateAnAttribute({
14326
15869
  <dl>
14327
15870
  <dd>
14328
15871
 
15872
+ #### 📝 Description
15873
+
15874
+ <dl>
15875
+ <dd>
15876
+
15877
+ <dl>
15878
+ <dd>
15879
+
15880
+ Retrieve the list of all attributes defined for companies, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.
15881
+ </dd>
15882
+ </dl>
15883
+ </dd>
15884
+ </dl>
15885
+
14329
15886
  #### 🔌 Usage
14330
15887
 
14331
15888
  <dl>
@@ -14368,6 +15925,20 @@ await client.companies.getCompanyAttributes();
14368
15925
  <dl>
14369
15926
  <dd>
14370
15927
 
15928
+ #### 📝 Description
15929
+
15930
+ <dl>
15931
+ <dd>
15932
+
15933
+ <dl>
15934
+ <dd>
15935
+
15936
+ Retrieve the list of all attributes defined for deals, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.
15937
+ </dd>
15938
+ </dl>
15939
+ </dd>
15940
+ </dl>
15941
+
14371
15942
  #### 🔌 Usage
14372
15943
 
14373
15944
  <dl>
@@ -14409,6 +15980,20 @@ await client.deals.getDealAttributes();
14409
15980
  <dl>
14410
15981
  <dd>
14411
15982
 
15983
+ #### 📝 Description
15984
+
15985
+ <dl>
15986
+ <dd>
15987
+
15988
+ <dl>
15989
+ <dd>
15990
+
15991
+ Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps. Default sort order is descending by creation date.
15992
+ </dd>
15993
+ </dl>
15994
+ </dd>
15995
+ </dl>
15996
+
14412
15997
  #### 🔌 Usage
14413
15998
 
14414
15999
  <dl>
@@ -14448,15 +16033,29 @@ await client.deals.getAllDeals();
14448
16033
  </dl>
14449
16034
  </dd>
14450
16035
  </dl>
14451
-
14452
-
16036
+
16037
+
16038
+ </dd>
16039
+ </dl>
16040
+ </details>
16041
+
16042
+ <details><summary><code>client.deals.<a href="/src/api/resources/deals/client/Client.ts">createADeal</a>({ ...params }) -> Brevo.PostCrmDealsResponse</code></summary>
16043
+ <dl>
16044
+ <dd>
16045
+
16046
+ #### 📝 Description
16047
+
16048
+ <dl>
16049
+ <dd>
16050
+
16051
+ <dl>
16052
+ <dd>
16053
+
16054
+ Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing `pipeline` and `deal_stage` attribute IDs, which can be retrieved from the pipeline details endpoint.
16055
+ </dd>
16056
+ </dl>
14453
16057
  </dd>
14454
16058
  </dl>
14455
- </details>
14456
-
14457
- <details><summary><code>client.deals.<a href="/src/api/resources/deals/client/Client.ts">createADeal</a>({ ...params }) -> Brevo.PostCrmDealsResponse</code></summary>
14458
- <dl>
14459
- <dd>
14460
16059
 
14461
16060
  #### 🔌 Usage
14462
16061
 
@@ -14572,6 +16171,20 @@ await client.deals.importDealsCreationAndUpdation({});
14572
16171
  <dl>
14573
16172
  <dd>
14574
16173
 
16174
+ #### 📝 Description
16175
+
16176
+ <dl>
16177
+ <dd>
16178
+
16179
+ <dl>
16180
+ <dd>
16181
+
16182
+ Link or unlink contacts and companies with a specific deal in a single request. You can simultaneously link new contacts/companies and unlink existing ones by providing the respective ID arrays in the request body.
16183
+ </dd>
16184
+ </dl>
16185
+ </dd>
16186
+ </dl>
16187
+
14575
16188
  #### 🔌 Usage
14576
16189
 
14577
16190
  <dl>
@@ -14623,6 +16236,20 @@ await client.deals.linkAndUnlinkADealWithContactsAndCompanies({
14623
16236
  <dl>
14624
16237
  <dd>
14625
16238
 
16239
+ #### 📝 Description
16240
+
16241
+ <dl>
16242
+ <dd>
16243
+
16244
+ <dl>
16245
+ <dd>
16246
+
16247
+ Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies. Returns a 404 error if the deal does not exist.
16248
+ </dd>
16249
+ </dl>
16250
+ </dd>
16251
+ </dl>
16252
+
14626
16253
  #### 🔌 Usage
14627
16254
 
14628
16255
  <dl>
@@ -14674,6 +16301,20 @@ await client.deals.getADeal({
14674
16301
  <dl>
14675
16302
  <dd>
14676
16303
 
16304
+ #### 📝 Description
16305
+
16306
+ <dl>
16307
+ <dd>
16308
+
16309
+ <dl>
16310
+ <dd>
16311
+
16312
+ Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission on deals; otherwise, a 403 Forbidden error is returned.
16313
+ </dd>
16314
+ </dl>
16315
+ </dd>
16316
+ </dl>
16317
+
14677
16318
  #### 🔌 Usage
14678
16319
 
14679
16320
  <dl>
@@ -14725,6 +16366,20 @@ await client.deals.deleteADeal({
14725
16366
  <dl>
14726
16367
  <dd>
14727
16368
 
16369
+ #### 📝 Description
16370
+
16371
+ <dl>
16372
+ <dd>
16373
+
16374
+ <dl>
16375
+ <dd>
16376
+
16377
+ Update an existing deal''s attributes, name, linked contacts, or linked companies. Note that passing `linkedContactsIds` or `linkedCompaniesIds` replaces the entire list of associations, so omitted IDs will be removed. To move a deal to a different pipeline or stage, provide both the `pipeline` and `deal_stage` attribute IDs.
16378
+ </dd>
16379
+ </dl>
16380
+ </dd>
16381
+ </dl>
16382
+
14728
16383
  #### 🔌 Usage
14729
16384
 
14730
16385
  <dl>
@@ -14831,6 +16486,20 @@ await client.deals.getPipelineStages();
14831
16486
  <dl>
14832
16487
  <dd>
14833
16488
 
16489
+ #### 📝 Description
16490
+
16491
+ <dl>
16492
+ <dd>
16493
+
16494
+ <dl>
16495
+ <dd>
16496
+
16497
+ Retrieve the list of all deal pipelines configured for your account, including each pipeline''s stages and settings. If no pipelines have been configured yet, a default pipeline is automatically created and returned.
16498
+ </dd>
16499
+ </dl>
16500
+ </dd>
16501
+ </dl>
16502
+
14834
16503
  #### 🔌 Usage
14835
16504
 
14836
16505
  <dl>
@@ -14872,6 +16541,20 @@ await client.deals.getAllPipelines();
14872
16541
  <dl>
14873
16542
  <dd>
14874
16543
 
16544
+ #### 📝 Description
16545
+
16546
+ <dl>
16547
+ <dd>
16548
+
16549
+ <dl>
16550
+ <dd>
16551
+
16552
+ Retrieve the details of a specific deal pipeline by its identifier, including its stages, stage ordering, and configuration. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals.
16553
+ </dd>
16554
+ </dl>
16555
+ </dd>
16556
+ </dl>
16557
+
14875
16558
  #### 🔌 Usage
14876
16559
 
14877
16560
  <dl>
@@ -14924,6 +16607,20 @@ await client.deals.getAPipeline({
14924
16607
  <dl>
14925
16608
  <dd>
14926
16609
 
16610
+ #### 📝 Description
16611
+
16612
+ <dl>
16613
+ <dd>
16614
+
16615
+ <dl>
16616
+ <dd>
16617
+
16618
+ Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.
16619
+ </dd>
16620
+ </dl>
16621
+ </dd>
16622
+ </dl>
16623
+
14927
16624
  #### 🔌 Usage
14928
16625
 
14929
16626
  <dl>
@@ -14973,6 +16670,20 @@ await client.files.getAllFiles();
14973
16670
  <dl>
14974
16671
  <dd>
14975
16672
 
16673
+ #### 📝 Description
16674
+
16675
+ <dl>
16676
+ <dd>
16677
+
16678
+ <dl>
16679
+ <dd>
16680
+
16681
+ Upload a file and associate it with a contact, company, or deal. The file must be sent as multipart form data with a maximum size of 10 MB. You can optionally link the file to a specific entity by providing the corresponding entity ID.
16682
+ </dd>
16683
+ </dl>
16684
+ </dd>
16685
+ </dl>
16686
+
14976
16687
  #### 🔌 Usage
14977
16688
 
14978
16689
  <dl>
@@ -15024,6 +16735,20 @@ await client.files.uploadAFile({
15024
16735
  <dl>
15025
16736
  <dd>
15026
16737
 
16738
+ #### 📝 Description
16739
+
16740
+ <dl>
16741
+ <dd>
16742
+
16743
+ <dl>
16744
+ <dd>
16745
+
16746
+ Get a temporary download URL for a CRM file by its identifier. The returned URL is valid for 5 minutes only and provides direct access to the file content.
16747
+ </dd>
16748
+ </dl>
16749
+ </dd>
16750
+ </dl>
16751
+
15027
16752
  #### 🔌 Usage
15028
16753
 
15029
16754
  <dl>
@@ -15075,6 +16800,20 @@ await client.files.downloadAFile({
15075
16800
  <dl>
15076
16801
  <dd>
15077
16802
 
16803
+ #### 📝 Description
16804
+
16805
+ <dl>
16806
+ <dd>
16807
+
16808
+ <dl>
16809
+ <dd>
16810
+
16811
+ Permanently delete a CRM file by its identifier. This removes the file from storage and unlinks it from any associated contacts, companies, or deals.
16812
+ </dd>
16813
+ </dl>
16814
+ </dd>
16815
+ </dl>
16816
+
15078
16817
  #### 🔌 Usage
15079
16818
 
15080
16819
  <dl>
@@ -15126,6 +16865,20 @@ await client.files.deleteAFile({
15126
16865
  <dl>
15127
16866
  <dd>
15128
16867
 
16868
+ #### 📝 Description
16869
+
16870
+ <dl>
16871
+ <dd>
16872
+
16873
+ <dl>
16874
+ <dd>
16875
+
16876
+ Retrieve the metadata and details of a specific CRM file by its identifier. This returns information such as the file name, size, type, creation date, and associated entities, but does not include the file content itself.
16877
+ </dd>
16878
+ </dl>
16879
+ </dd>
16880
+ </dl>
16881
+
15129
16882
  #### 🔌 Usage
15130
16883
 
15131
16884
  <dl>
@@ -15178,6 +16931,20 @@ await client.files.getFileDetails({
15178
16931
  <dl>
15179
16932
  <dd>
15180
16933
 
16934
+ #### 📝 Description
16935
+
16936
+ <dl>
16937
+ <dd>
16938
+
16939
+ <dl>
16940
+ <dd>
16941
+
16942
+ Retrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 notes per page.
16943
+ </dd>
16944
+ </dl>
16945
+ </dd>
16946
+ </dl>
16947
+
15181
16948
  #### 🔌 Usage
15182
16949
 
15183
16950
  <dl>
@@ -15227,6 +16994,20 @@ await client.notes.getAllNotes();
15227
16994
  <dl>
15228
16995
  <dd>
15229
16996
 
16997
+ #### 📝 Description
16998
+
16999
+ <dl>
17000
+ <dd>
17001
+
17002
+ <dl>
17003
+ <dd>
17004
+
17005
+ Create a new CRM note and optionally associate it with contacts, companies, or deals. The note text content is required, and you can link the note to multiple entities simultaneously during creation.
17006
+ </dd>
17007
+ </dl>
17008
+ </dd>
17009
+ </dl>
17010
+
15230
17011
  #### 🔌 Usage
15231
17012
 
15232
17013
  <dl>
@@ -15237,7 +17018,7 @@ await client.notes.getAllNotes();
15237
17018
 
15238
17019
  ```typescript
15239
17020
  await client.notes.createANote({
15240
- text: "In communication with client_dev for resolution of queries."
17021
+ text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
15241
17022
  });
15242
17023
 
15243
17024
  ```
@@ -15278,6 +17059,20 @@ await client.notes.createANote({
15278
17059
  <dl>
15279
17060
  <dd>
15280
17061
 
17062
+ #### 📝 Description
17063
+
17064
+ <dl>
17065
+ <dd>
17066
+
17067
+ <dl>
17068
+ <dd>
17069
+
17070
+ Retrieve the full details of a single CRM note by its identifier. The response includes the note''s text content, creation date, author, and any associated contacts, companies, or deals.
17071
+ </dd>
17072
+ </dl>
17073
+ </dd>
17074
+ </dl>
17075
+
15281
17076
  #### 🔌 Usage
15282
17077
 
15283
17078
  <dl>
@@ -15329,6 +17124,20 @@ await client.notes.getANote({
15329
17124
  <dl>
15330
17125
  <dd>
15331
17126
 
17127
+ #### 📝 Description
17128
+
17129
+ <dl>
17130
+ <dd>
17131
+
17132
+ <dl>
17133
+ <dd>
17134
+
17135
+ Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals.
17136
+ </dd>
17137
+ </dl>
17138
+ </dd>
17139
+ </dl>
17140
+
15332
17141
  #### 🔌 Usage
15333
17142
 
15334
17143
  <dl>
@@ -15380,6 +17189,20 @@ await client.notes.deleteANote({
15380
17189
  <dl>
15381
17190
  <dd>
15382
17191
 
17192
+ #### 📝 Description
17193
+
17194
+ <dl>
17195
+ <dd>
17196
+
17197
+ <dl>
17198
+ <dd>
17199
+
17200
+ Update an existing CRM note''s text content and its associations with contacts, companies, or deals. You can modify the note text, change the pinned status, or update the linked entities.
17201
+ </dd>
17202
+ </dl>
17203
+ </dd>
17204
+ </dl>
17205
+
15383
17206
  #### 🔌 Usage
15384
17207
 
15385
17208
  <dl>
@@ -15392,7 +17215,7 @@ await client.notes.deleteANote({
15392
17215
  await client.notes.updateANote({
15393
17216
  id: "id",
15394
17217
  body: {
15395
- text: "In communication with client_dev for resolution of queries."
17218
+ text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
15396
17219
  }
15397
17220
  });
15398
17221
 
@@ -15435,6 +17258,20 @@ await client.notes.updateANote({
15435
17258
  <dl>
15436
17259
  <dd>
15437
17260
 
17261
+ #### 📝 Description
17262
+
17263
+ <dl>
17264
+ <dd>
17265
+
17266
+ <dl>
17267
+ <dd>
17268
+
17269
+ Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies). Results are sorted by creation date in descending order by default, with a default limit of 50 tasks per page.
17270
+ </dd>
17271
+ </dl>
17272
+ </dd>
17273
+ </dl>
17274
+
15438
17275
  #### 🔌 Usage
15439
17276
 
15440
17277
  <dl>
@@ -15486,6 +17323,20 @@ await client.tasks.getAllTasks({
15486
17323
  <dl>
15487
17324
  <dd>
15488
17325
 
17326
+ #### 📝 Description
17327
+
17328
+ <dl>
17329
+ <dd>
17330
+
17331
+ <dl>
17332
+ <dd>
17333
+
17334
+ Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.
17335
+ </dd>
17336
+ </dl>
17337
+ </dd>
17338
+ </dl>
17339
+
15489
17340
  #### 🔌 Usage
15490
17341
 
15491
17342
  <dl>
@@ -15497,7 +17348,7 @@ await client.tasks.getAllTasks({
15497
17348
  ```typescript
15498
17349
  await client.tasks.createATask({
15499
17350
  date: "2021-11-01T17:44:54Z",
15500
- name: "Task: Connect with client_dev",
17351
+ name: "Task: Connect with client",
15501
17352
  taskTypeId: "61a5cd07ca1347c82306ad09"
15502
17353
  });
15503
17354
 
@@ -15533,11 +17384,25 @@ await client.tasks.createATask({
15533
17384
 
15534
17385
  </dd>
15535
17386
  </dl>
15536
- </details>
15537
-
15538
- <details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getATask</a>({ ...params }) -> Brevo.Task</code></summary>
15539
- <dl>
15540
- <dd>
17387
+ </details>
17388
+
17389
+ <details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getATask</a>({ ...params }) -> Brevo.Task</code></summary>
17390
+ <dl>
17391
+ <dd>
17392
+
17393
+ #### 📝 Description
17394
+
17395
+ <dl>
17396
+ <dd>
17397
+
17398
+ <dl>
17399
+ <dd>
17400
+
17401
+ Retrieve the full details of a single CRM task by its identifier. The response includes the task''s name, type, status, due date, duration, notes, assignee, reminder settings, and linked contacts, companies, or deals.
17402
+ </dd>
17403
+ </dl>
17404
+ </dd>
17405
+ </dl>
15541
17406
 
15542
17407
  #### 🔌 Usage
15543
17408
 
@@ -15590,6 +17455,20 @@ await client.tasks.getATask({
15590
17455
  <dl>
15591
17456
  <dd>
15592
17457
 
17458
+ #### 📝 Description
17459
+
17460
+ <dl>
17461
+ <dd>
17462
+
17463
+ <dl>
17464
+ <dd>
17465
+
17466
+ Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders. The requesting user must be the task assignee or have manage permission on tasks.
17467
+ </dd>
17468
+ </dl>
17469
+ </dd>
17470
+ </dl>
17471
+
15593
17472
  #### 🔌 Usage
15594
17473
 
15595
17474
  <dl>
@@ -15641,6 +17520,20 @@ await client.tasks.deleteATask({
15641
17520
  <dl>
15642
17521
  <dd>
15643
17522
 
17523
+ #### 📝 Description
17524
+
17525
+ <dl>
17526
+ <dd>
17527
+
17528
+ <dl>
17529
+ <dd>
17530
+
17531
+ Update an existing CRM task''s properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities. Only the fields provided in the request body will be updated; omitted fields remain unchanged.
17532
+ </dd>
17533
+ </dl>
17534
+ </dd>
17535
+ </dl>
17536
+
15644
17537
  #### 🔌 Usage
15645
17538
 
15646
17539
  <dl>
@@ -15688,10 +17581,24 @@ await client.tasks.updateATask({
15688
17581
  </dl>
15689
17582
  </details>
15690
17583
 
15691
- <details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getAllTaskTypes</a>() -> Brevo.GetCrmTasktypesResponse</code></summary>
17584
+ <details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">getAllTaskTypes</a>() -> Brevo.GetCrmTasktypesResponseItem[]</code></summary>
17585
+ <dl>
17586
+ <dd>
17587
+
17588
+ #### 📝 Description
17589
+
15692
17590
  <dl>
15693
17591
  <dd>
15694
17592
 
17593
+ <dl>
17594
+ <dd>
17595
+
17596
+ Retrieve the list of all available task types, such as Email, Call, Meeting, Todo, Lunch, Deadline, and LinkedIn. If no task types exist yet, the default set is automatically created and returned. Use the task type ID when creating or updating tasks.
17597
+ </dd>
17598
+ </dl>
17599
+ </dd>
17600
+ </dl>
17601
+
15695
17602
  #### 🔌 Usage
15696
17603
 
15697
17604
  <dl>
@@ -15867,6 +17774,20 @@ await client.transactionalWhatsApp.getWhatsappEventReport();
15867
17774
  <dl>
15868
17775
  <dd>
15869
17776
 
17777
+ #### 📝 Description
17778
+
17779
+ <dl>
17780
+ <dd>
17781
+
17782
+ <dl>
17783
+ <dd>
17784
+
17785
+ Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both `startDate` and `endDate` must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the `sort` parameter.
17786
+ </dd>
17787
+ </dl>
17788
+ </dd>
17789
+ </dl>
17790
+
15870
17791
  #### 🔌 Usage
15871
17792
 
15872
17793
  <dl>
@@ -15916,6 +17837,20 @@ await client.transactionalEmails.getTransacBlockedContacts();
15916
17837
  <dl>
15917
17838
  <dd>
15918
17839
 
17840
+ #### 📝 Description
17841
+
17842
+ <dl>
17843
+ <dd>
17844
+
17845
+ <dl>
17846
+ <dd>
17847
+
17848
+ Unblock or resubscribe a transactional contact by removing their email address from the blacklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.
17849
+ </dd>
17850
+ </dl>
17851
+ </dd>
17852
+ </dl>
17853
+
15919
17854
  #### 🔌 Usage
15920
17855
 
15921
17856
  <dl>
@@ -16215,6 +18150,20 @@ await client.transactionalEmails.deleteHardbounces();
16215
18150
  <dl>
16216
18151
  <dd>
16217
18152
 
18153
+ #### 📝 Description
18154
+
18155
+ <dl>
18156
+ <dd>
18157
+
18158
+ <dl>
18159
+ <dd>
18160
+
18161
+ Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`. You can schedule emails for future delivery using `scheduledAt` (UTC, up to 5-minute delay), send multiple personalized versions with `messageVersions` (max 2000 total recipients, 99 per version), and attach files via URL or base64-encoded content. A `sender` and `subject` are required when no `templateId` is provided; when a `templateId` is used, the template''s sender and subject are applied unless overridden.
18162
+ </dd>
18163
+ </dl>
18164
+ </dd>
18165
+ </dl>
18166
+
16218
18167
  #### 🔌 Usage
16219
18168
 
16220
18169
  <dl>
@@ -16537,6 +18486,20 @@ await client.transactionalEmails.getTransacEmailContent({
16537
18486
  <dl>
16538
18487
  <dd>
16539
18488
 
18489
+ #### 📝 Description
18490
+
18491
+ <dl>
18492
+ <dd>
18493
+
18494
+ <dl>
18495
+ <dd>
18496
+
18497
+ Delete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the deletion to a specific date range using `from_date` and `to_date` query parameters (YYYY-MM-DD format). The operation also removes any associated stored email preview content.
18498
+ </dd>
18499
+ </dl>
18500
+ </dd>
18501
+ </dl>
18502
+
16540
18503
  #### 🔌 Usage
16541
18504
 
16542
18505
  <dl>
@@ -16714,6 +18677,20 @@ await client.transactionalEmails.getEmailEventReport();
16714
18677
  <dl>
16715
18678
  <dd>
16716
18679
 
18680
+ #### 📝 Description
18681
+
18682
+ <dl>
18683
+ <dd>
18684
+
18685
+ <dl>
18686
+ <dd>
18687
+
18688
+ This endpoint will show the aggregated stats per day for the past 10 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 30 days.
18689
+ </dd>
18690
+ </dl>
18691
+ </dd>
18692
+ </dl>
18693
+
16717
18694
  #### 🔌 Usage
16718
18695
 
16719
18696
  <dl>
@@ -16763,6 +18740,20 @@ await client.transactionalEmails.getSmtpReport();
16763
18740
  <dl>
16764
18741
  <dd>
16765
18742
 
18743
+ #### 📝 Description
18744
+
18745
+ <dl>
18746
+ <dd>
18747
+
18748
+ <dl>
18749
+ <dd>
18750
+
18751
+ Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.
18752
+ </dd>
18753
+ </dl>
18754
+ </dd>
18755
+ </dl>
18756
+
16766
18757
  #### 🔌 Usage
16767
18758
 
16768
18759
  <dl>
@@ -16790,7 +18781,7 @@ await client.transactionalEmails.postPreviewSmtpEmailTemplates({
16790
18781
  <dl>
16791
18782
  <dd>
16792
18783
 
16793
- **request:** `unknown`
18784
+ **request:** `Brevo.PostPreviewSmtpEmailTemplatesRequest`
16794
18785
 
16795
18786
  </dd>
16796
18787
  </dl>
@@ -16814,6 +18805,20 @@ await client.transactionalEmails.postPreviewSmtpEmailTemplates({
16814
18805
  <dl>
16815
18806
  <dd>
16816
18807
 
18808
+ #### 📝 Description
18809
+
18810
+ <dl>
18811
+ <dd>
18812
+
18813
+ <dl>
18814
+ <dd>
18815
+
18816
+ Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden. You can filter by active/inactive status using `templateStatus` and by editor type using `editorType` (currently only `richTextEditor` is supported).
18817
+ </dd>
18818
+ </dl>
18819
+ </dd>
18820
+ </dl>
18821
+
16817
18822
  #### 🔌 Usage
16818
18823
 
16819
18824
  <dl>
@@ -16863,6 +18868,20 @@ await client.transactionalEmails.getSmtpTemplates();
16863
18868
  <dl>
16864
18869
  <dd>
16865
18870
 
18871
+ #### 📝 Description
18872
+
18873
+ <dl>
18874
+ <dd>
18875
+
18876
+ <dl>
18877
+ <dd>
18878
+
18879
+ Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied. Templates are created as inactive by default unless `isActive` is explicitly set to `true`.
18880
+ </dd>
18881
+ </dl>
18882
+ </dd>
18883
+ </dl>
18884
+
16866
18885
  #### 🔌 Usage
16867
18886
 
16868
18887
  <dl>
@@ -16916,6 +18935,20 @@ await client.transactionalEmails.createSmtpTemplate({
16916
18935
  <dl>
16917
18936
  <dd>
16918
18937
 
18938
+ #### 📝 Description
18939
+
18940
+ <dl>
18941
+ <dd>
18942
+
18943
+ <dl>
18944
+ <dd>
18945
+
18946
+ Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).
18947
+ </dd>
18948
+ </dl>
18949
+ </dd>
18950
+ </dl>
18951
+
16919
18952
  #### 🔌 Usage
16920
18953
 
16921
18954
  <dl>
@@ -16967,6 +19000,20 @@ await client.transactionalEmails.getSmtpTemplate({
16967
19000
  <dl>
16968
19001
  <dd>
16969
19002
 
19003
+ #### 📝 Description
19004
+
19005
+ <dl>
19006
+ <dd>
19007
+
19008
+ <dl>
19009
+ <dd>
19010
+
19011
+ Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated. You can update the template name, subject, sender, reply-to address, HTML content (via `htmlContent` or `htmlUrl`), active status, tag, attachment URL, and the personalized `toField`. Only one of sender email or sender ID should be provided per request.
19012
+ </dd>
19013
+ </dl>
19014
+ </dd>
19015
+ </dl>
19016
+
16970
19017
  #### 🔌 Usage
16971
19018
 
16972
19019
  <dl>
@@ -17018,6 +19065,20 @@ await client.transactionalEmails.updateSmtpTemplate({
17018
19065
  <dl>
17019
19066
  <dd>
17020
19067
 
19068
+ #### 📝 Description
19069
+
19070
+ <dl>
19071
+ <dd>
19072
+
19073
+ <dl>
19074
+ <dd>
19075
+
19076
+ Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`. Deletion also removes associated newsletter template data and triggers asynchronous cleanup of shared assets.
19077
+ </dd>
19078
+ </dl>
19079
+ </dd>
19080
+ </dl>
19081
+
17021
19082
  #### 🔌 Usage
17022
19083
 
17023
19084
  <dl>
@@ -17069,6 +19130,20 @@ await client.transactionalEmails.deleteSmtpTemplate({
17069
19130
  <dl>
17070
19131
  <dd>
17071
19132
 
19133
+ #### 📝 Description
19134
+
19135
+ <dl>
19136
+ <dd>
19137
+
19138
+ <dl>
19139
+ <dd>
19140
+
19141
+ Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your entire test list. You can send a maximum of 50 test emails per day, and all provided email addresses must be valid.
19142
+ </dd>
19143
+ </dl>
19144
+ </dd>
19145
+ </dl>
19146
+
17072
19147
  #### 🔌 Usage
17073
19148
 
17074
19149
  <dl>
@@ -17190,6 +19265,20 @@ await client.transactionalSms.sendAsyncTransactionalSms({
17190
19265
  <dl>
17191
19266
  <dd>
17192
19267
 
19268
+ #### 📝 Description
19269
+
19270
+ <dl>
19271
+ <dd>
19272
+
19273
+ <dl>
19274
+ <dd>
19275
+
19276
+ Send a transactional SMS message to a single mobile number. The `sender`, `recipient`, and either `content` or `templateId` fields are required. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the recipient must be a valid international phone number (6-15 digits, optional leading +). Tags can be a string or an array of up to 10 strings. The SMS type defaults to `transactional` but can be set to `marketing`; if the content includes a stop code, it is automatically treated as marketing. Returns the message ID, SMS count, credits used, and remaining credits.
19277
+ </dd>
19278
+ </dl>
19279
+ </dd>
19280
+ </dl>
19281
+
17193
19282
  #### 🔌 Usage
17194
19283
 
17195
19284
  <dl>
@@ -17242,6 +19331,20 @@ await client.transactionalSms.sendTransacSms({
17242
19331
  <dl>
17243
19332
  <dd>
17244
19333
 
19334
+ #### 📝 Description
19335
+
19336
+ <dl>
19337
+ <dd>
19338
+
19339
+ <dl>
19340
+ <dd>
19341
+
19342
+ Retrieve an aggregated report of your transactional SMS activity over a specified time period, including counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format) or by a number of past `days` (not compatible with date range). You can further narrow results by `tag`. If no date filter is provided, the report covers all available data and returns the auto-detected date range.
19343
+ </dd>
19344
+ </dl>
19345
+ </dd>
19346
+ </dl>
19347
+
17245
19348
  #### 🔌 Usage
17246
19349
 
17247
19350
  <dl>
@@ -17291,6 +19394,20 @@ await client.transactionalSms.getTransacAggregatedSmsReport();
17291
19394
  <dl>
17292
19395
  <dd>
17293
19396
 
19397
+ #### 📝 Description
19398
+
19399
+ <dl>
19400
+ <dd>
19401
+
19402
+ <dl>
19403
+ <dd>
19404
+
19405
+ Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden. Filter by date range (`startDate`/`endDate`), past `days` (not compatible with date range), specific `event` type (e.g. delivered, bounces, replies), `phoneNumber`, or `tags`. Bounce events include the failure reason, and reply events include the reply content.
19406
+ </dd>
19407
+ </dl>
19408
+ </dd>
19409
+ </dl>
19410
+
17294
19411
  #### 🔌 Usage
17295
19412
 
17296
19413
  <dl>
@@ -17340,6 +19457,20 @@ await client.transactionalSms.getSmsEvents();
17340
19457
  <dl>
17341
19458
  <dd>
17342
19459
 
19460
+ #### 📝 Description
19461
+
19462
+ <dl>
19463
+ <dd>
19464
+
19465
+ <dl>
19466
+ <dd>
19467
+
19468
+ Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format), by a number of past `days` (not compatible with date range), or by `tag`. Results are sorted in descending order by default unless overridden with the `sort` parameter.
19469
+ </dd>
19470
+ </dl>
19471
+ </dd>
19472
+ </dl>
19473
+
17343
19474
  #### 🔌 Usage
17344
19475
 
17345
19476
  <dl>