@getbrevo/brevo 5.0.3 → 6.0.1

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 (515) hide show
  1. package/README.md +99 -37
  2. package/dist/cjs/BaseClient.d.ts +3 -0
  3. package/dist/cjs/BaseClient.js +17 -2
  4. package/dist/cjs/api/resources/account/client/Client.d.ts +5 -6
  5. package/dist/cjs/api/resources/account/client/Client.js +21 -13
  6. package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +4 -17
  7. package/dist/cjs/api/resources/balance/client/Client.d.ts +8 -7
  8. package/dist/cjs/api/resources/balance/client/Client.js +70 -33
  9. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts +21 -11
  10. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js +9 -0
  11. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts +11 -3
  12. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js +9 -0
  13. package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +13 -1
  14. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +7 -6
  15. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +6 -6
  16. package/dist/cjs/api/resources/balance/client/requests/index.d.ts +2 -2
  17. package/dist/cjs/api/resources/balance/client/requests/index.js +5 -1
  18. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts +5 -0
  19. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js +8 -0
  20. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts +5 -0
  21. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js +8 -0
  22. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts +5 -0
  23. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js +8 -0
  24. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts +30 -0
  25. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +10 -0
  26. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js +15 -0
  27. package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +7 -2
  28. package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +14 -14
  29. package/dist/cjs/api/resources/balance/types/index.d.ts +4 -0
  30. package/dist/cjs/api/resources/balance/types/index.js +4 -0
  31. package/dist/cjs/api/resources/companies/client/Client.d.ts +22 -0
  32. package/dist/cjs/api/resources/companies/client/Client.js +49 -18
  33. package/dist/cjs/api/resources/companies/client/requests/GetCompaniesRequest.d.ts +4 -4
  34. package/dist/cjs/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.ts +1 -1
  35. package/dist/cjs/api/resources/companies/client/requests/PostCompaniesImportRequest.d.ts +1 -1
  36. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.d.ts +2 -2
  37. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.js +1 -1
  38. package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +20 -4
  39. package/dist/cjs/api/resources/contacts/client/Client.d.ts +38 -1
  40. package/dist/cjs/api/resources/contacts/client/Client.js +129 -37
  41. package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +5 -1
  42. package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
  43. package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
  44. package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
  45. package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
  46. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +5 -3
  47. package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
  48. package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +4 -2
  49. package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +2 -2
  50. package/dist/cjs/api/resources/conversations/client/Client.d.ts +18 -8
  51. package/dist/cjs/api/resources/conversations/client/Client.js +28 -18
  52. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.ts +8 -8
  53. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.ts +12 -10
  54. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.ts +11 -9
  55. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.ts +1 -1
  56. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.ts +2 -2
  57. package/dist/cjs/api/resources/coupons/client/Client.d.ts +10 -0
  58. package/dist/cjs/api/resources/coupons/client/Client.js +19 -5
  59. package/dist/cjs/api/resources/customObjects/client/Client.d.ts +101 -21
  60. package/dist/cjs/api/resources/customObjects/client/Client.js +108 -26
  61. package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts +2 -2
  62. package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts +1 -1
  63. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +114 -25
  64. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js +21 -0
  65. package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts +1 -1
  66. package/dist/cjs/api/resources/customObjects/client/requests/index.js +3 -0
  67. package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +14 -5
  68. package/dist/cjs/api/resources/deals/client/Client.d.ts +22 -0
  69. package/dist/cjs/api/resources/deals/client/Client.js +59 -22
  70. package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +5 -3
  71. package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
  72. package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
  73. package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
  74. package/dist/cjs/api/resources/domains/client/Client.js +5 -5
  75. package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +32 -3
  76. package/dist/cjs/api/resources/ecommerce/client/Client.js +81 -22
  77. package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
  78. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
  79. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
  80. package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
  81. package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
  82. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
  83. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +2 -2
  84. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts +7 -0
  85. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js +10 -0
  86. package/dist/cjs/api/resources/ecommerce/types/index.d.ts +1 -0
  87. package/dist/cjs/api/resources/ecommerce/types/index.js +1 -0
  88. package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +22 -1
  89. package/dist/cjs/api/resources/emailCampaigns/client/Client.js +51 -15
  90. package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +7 -7
  91. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +1 -1
  92. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts +6 -4
  93. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +28 -5
  94. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +9 -0
  95. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +27 -4
  96. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +9 -0
  97. package/dist/cjs/api/resources/event/client/Client.d.ts +8 -6
  98. package/dist/cjs/api/resources/event/client/Client.js +14 -8
  99. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.d.ts +76 -0
  100. package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +5 -5
  101. package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
  102. package/dist/cjs/api/resources/event/index.d.ts +0 -1
  103. package/dist/cjs/api/resources/event/index.js +0 -1
  104. package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
  105. package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
  106. package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
  107. package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
  108. package/dist/cjs/api/resources/files/client/Client.js +19 -5
  109. package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
  110. package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
  111. package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
  112. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
  113. package/dist/cjs/api/resources/index.d.ts +0 -1
  114. package/dist/cjs/api/resources/index.js +0 -1
  115. package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
  116. package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
  117. package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
  118. package/dist/cjs/api/resources/notes/client/Client.js +21 -7
  119. package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
  120. package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
  121. package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
  122. package/dist/cjs/api/resources/payments/client/Client.js +9 -3
  123. package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
  124. package/dist/cjs/api/resources/process/client/Client.js +19 -20
  125. package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +22 -38
  126. package/dist/cjs/api/resources/process/types/GetProcessResponse.js +1 -0
  127. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +22 -38
  128. package/dist/cjs/api/resources/process/types/GetProcessesResponse.js +1 -0
  129. package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
  130. package/dist/cjs/api/resources/program/client/Client.js +26 -14
  131. package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
  132. package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
  133. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
  134. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
  135. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
  136. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
  137. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
  138. package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
  139. package/dist/cjs/api/resources/program/types/index.js +1 -0
  140. package/dist/cjs/api/resources/reward/client/Client.js +26 -10
  141. package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
  142. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
  143. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
  144. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
  145. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
  146. package/dist/cjs/api/resources/senders/client/Client.js +11 -7
  147. package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
  148. package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
  149. package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
  150. package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
  151. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
  152. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
  153. package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
  154. package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
  155. package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
  156. package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
  157. package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
  158. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
  159. package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
  160. package/dist/cjs/api/resources/tasks/types/index.js +1 -1
  161. package/dist/cjs/api/resources/tier/client/Client.js +22 -10
  162. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
  163. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
  164. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
  165. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
  166. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
  167. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
  168. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
  169. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
  170. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
  171. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
  172. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
  173. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
  174. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
  175. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
  176. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
  177. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
  178. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
  179. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
  180. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
  181. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
  182. package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
  183. package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
  184. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
  185. package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
  186. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
  187. package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
  188. package/dist/cjs/api/resources/user/client/Client.js +14 -6
  189. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
  190. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
  191. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
  192. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
  193. package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
  194. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
  195. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
  196. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
  197. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
  198. package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
  199. package/dist/cjs/api/types/BalanceDefinition.js +46 -2
  200. package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
  201. package/dist/cjs/api/types/BalanceLimit.js +22 -0
  202. package/dist/cjs/api/types/Company.d.ts +1 -1
  203. package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
  204. package/dist/cjs/api/types/Deal.d.ts +4 -4
  205. package/dist/cjs/api/types/FileData.d.ts +8 -6
  206. package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
  207. package/dist/cjs/api/types/GetCampaignStats.d.ts +4 -4
  208. package/dist/cjs/api/types/GetContactDetails.d.ts +2 -0
  209. package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
  210. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
  211. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
  212. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
  213. package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
  214. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
  215. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
  216. package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
  217. package/dist/cjs/api/types/GetWebhook.js +2 -6
  218. package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
  219. package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
  220. package/dist/cjs/api/types/Note.d.ts +10 -8
  221. package/dist/cjs/api/types/NoteData.d.ts +1 -1
  222. package/dist/cjs/api/types/Order.d.ts +1 -1
  223. package/dist/cjs/api/types/Pipeline.d.ts +3 -3
  224. package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
  225. package/dist/cjs/api/types/Task.d.ts +20 -8
  226. package/dist/cjs/api/types/TierGroup.d.ts +66 -0
  227. package/dist/cjs/api/types/TierGroup.js +30 -0
  228. package/dist/cjs/api/types/Transaction.d.ts +36 -17
  229. package/dist/cjs/api/types/Transaction.js +17 -0
  230. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  231. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  232. package/dist/cjs/core/auth/BasicAuth.d.ts +2 -2
  233. package/dist/cjs/core/auth/BasicAuth.js +7 -1
  234. package/dist/cjs/core/auth/index.d.ts +1 -1
  235. package/dist/cjs/core/auth/index.js +3 -1
  236. package/dist/cjs/core/fetcher/Fetcher.d.ts +8 -0
  237. package/dist/cjs/core/fetcher/Fetcher.js +13 -8
  238. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  239. package/dist/cjs/core/file/file.js +3 -2
  240. package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
  241. package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
  242. package/dist/cjs/core/url/index.d.ts +1 -0
  243. package/dist/cjs/core/url/index.js +3 -1
  244. package/dist/cjs/core/url/qs.d.ts +2 -1
  245. package/dist/cjs/core/url/qs.js +24 -12
  246. package/dist/cjs/errors/BrevoError.d.ts +3 -1
  247. package/dist/cjs/errors/BrevoError.js +4 -1
  248. package/dist/cjs/errors/BrevoTimeoutError.d.ts +4 -1
  249. package/dist/cjs/errors/BrevoTimeoutError.js +4 -1
  250. package/dist/cjs/errors/handleNonStatusCodeError.js +4 -1
  251. package/dist/cjs/version.d.ts +1 -1
  252. package/dist/cjs/version.js +1 -1
  253. package/dist/esm/BaseClient.d.mts +3 -0
  254. package/dist/esm/BaseClient.mjs +17 -2
  255. package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
  256. package/dist/esm/api/resources/account/client/Client.mjs +21 -13
  257. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
  258. package/dist/esm/api/resources/balance/client/Client.d.mts +8 -7
  259. package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
  260. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
  261. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
  262. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
  263. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
  264. package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
  265. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
  266. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
  267. package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
  268. package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
  269. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
  270. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
  271. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
  272. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
  273. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
  274. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
  275. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
  276. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
  277. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
  278. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
  279. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
  280. package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
  281. package/dist/esm/api/resources/balance/types/index.mjs +4 -0
  282. package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
  283. package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
  284. package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
  285. package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
  286. package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
  287. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
  288. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
  289. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
  290. package/dist/esm/api/resources/contacts/client/Client.d.mts +38 -1
  291. package/dist/esm/api/resources/contacts/client/Client.mjs +129 -37
  292. package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +5 -1
  293. package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
  294. package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
  295. package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
  296. package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
  297. package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +5 -3
  298. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
  299. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +4 -2
  300. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
  301. package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
  302. package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
  303. package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
  304. package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
  305. package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
  306. package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
  307. package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
  308. package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
  309. package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
  310. package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
  311. package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
  312. package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
  313. package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
  314. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
  315. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
  316. package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
  317. package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
  318. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
  319. package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
  320. package/dist/esm/api/resources/deals/client/Client.mjs +59 -22
  321. package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +5 -3
  322. package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
  323. package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
  324. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
  325. package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
  326. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +32 -3
  327. package/dist/esm/api/resources/ecommerce/client/Client.mjs +81 -22
  328. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
  329. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
  330. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
  331. package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
  332. package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
  333. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  334. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
  335. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
  336. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
  337. package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
  338. package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
  339. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
  340. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
  341. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
  342. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
  343. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
  344. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
  345. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
  346. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
  347. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
  348. package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
  349. package/dist/esm/api/resources/event/client/Client.mjs +14 -8
  350. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
  351. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +5 -5
  352. package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
  353. package/dist/esm/api/resources/event/index.d.mts +0 -1
  354. package/dist/esm/api/resources/event/index.mjs +0 -1
  355. package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
  356. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
  357. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
  358. package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
  359. package/dist/esm/api/resources/files/client/Client.mjs +19 -5
  360. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
  361. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
  362. package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
  363. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
  364. package/dist/esm/api/resources/index.d.mts +0 -1
  365. package/dist/esm/api/resources/index.mjs +0 -1
  366. package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
  367. package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
  368. package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
  369. package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
  370. package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
  371. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  372. package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
  373. package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
  374. package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
  375. package/dist/esm/api/resources/process/client/Client.mjs +19 -20
  376. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +22 -38
  377. package/dist/esm/api/resources/process/types/GetProcessResponse.mjs +1 -0
  378. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +22 -38
  379. package/dist/esm/api/resources/process/types/GetProcessesResponse.mjs +1 -0
  380. package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
  381. package/dist/esm/api/resources/program/client/Client.mjs +26 -14
  382. package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
  383. package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
  384. package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
  385. package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
  386. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
  387. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
  388. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
  389. package/dist/esm/api/resources/program/types/index.d.mts +1 -0
  390. package/dist/esm/api/resources/program/types/index.mjs +1 -0
  391. package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
  392. package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
  393. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
  394. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
  395. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
  396. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
  397. package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
  398. package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
  399. package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
  400. package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
  401. package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
  402. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
  403. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
  404. package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
  405. package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
  406. package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
  407. package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
  408. package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
  409. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
  410. package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
  411. package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
  412. package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
  413. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
  414. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
  415. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
  416. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
  417. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
  418. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
  419. package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
  420. package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
  421. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
  422. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
  423. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
  424. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
  425. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
  426. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
  427. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
  428. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
  429. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
  430. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
  431. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
  432. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
  433. package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
  434. package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
  435. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
  436. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
  437. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
  438. package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
  439. package/dist/esm/api/resources/user/client/Client.mjs +14 -6
  440. package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
  441. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
  442. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
  443. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
  444. package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
  445. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
  446. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
  447. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
  448. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
  449. package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
  450. package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
  451. package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
  452. package/dist/esm/api/types/BalanceLimit.mjs +21 -1
  453. package/dist/esm/api/types/Company.d.mts +1 -1
  454. package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
  455. package/dist/esm/api/types/Deal.d.mts +4 -4
  456. package/dist/esm/api/types/FileData.d.mts +8 -6
  457. package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
  458. package/dist/esm/api/types/GetCampaignStats.d.mts +4 -4
  459. package/dist/esm/api/types/GetContactDetails.d.mts +2 -0
  460. package/dist/esm/api/types/GetEventsList.d.mts +0 -2
  461. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
  462. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
  463. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
  464. package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
  465. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
  466. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
  467. package/dist/esm/api/types/GetWebhook.d.mts +5 -10
  468. package/dist/esm/api/types/GetWebhook.mjs +2 -6
  469. package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
  470. package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
  471. package/dist/esm/api/types/Note.d.mts +10 -8
  472. package/dist/esm/api/types/NoteData.d.mts +1 -1
  473. package/dist/esm/api/types/Order.d.mts +1 -1
  474. package/dist/esm/api/types/Pipeline.d.mts +3 -3
  475. package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
  476. package/dist/esm/api/types/Task.d.mts +20 -8
  477. package/dist/esm/api/types/TierGroup.d.mts +66 -0
  478. package/dist/esm/api/types/TierGroup.mjs +30 -0
  479. package/dist/esm/api/types/Transaction.d.mts +36 -17
  480. package/dist/esm/api/types/Transaction.mjs +16 -1
  481. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  482. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  483. package/dist/esm/core/auth/BasicAuth.d.mts +2 -2
  484. package/dist/esm/core/auth/BasicAuth.mjs +7 -1
  485. package/dist/esm/core/auth/index.d.mts +1 -1
  486. package/dist/esm/core/auth/index.mjs +1 -0
  487. package/dist/esm/core/fetcher/Fetcher.d.mts +8 -0
  488. package/dist/esm/core/fetcher/Fetcher.mjs +13 -8
  489. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  490. package/dist/esm/core/file/file.mjs +3 -2
  491. package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
  492. package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
  493. package/dist/esm/core/url/index.d.mts +1 -0
  494. package/dist/esm/core/url/index.mjs +1 -0
  495. package/dist/esm/core/url/qs.d.mts +2 -1
  496. package/dist/esm/core/url/qs.mjs +24 -12
  497. package/dist/esm/errors/BrevoError.d.mts +3 -1
  498. package/dist/esm/errors/BrevoError.mjs +4 -1
  499. package/dist/esm/errors/BrevoTimeoutError.d.mts +4 -1
  500. package/dist/esm/errors/BrevoTimeoutError.mjs +4 -1
  501. package/dist/esm/errors/handleNonStatusCodeError.mjs +4 -1
  502. package/dist/esm/version.d.mts +1 -1
  503. package/dist/esm/version.mjs +1 -1
  504. package/package.json +8 -8
  505. package/reference.md +1828 -99
  506. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
  507. package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
  508. package/dist/cjs/api/resources/event/types/index.js +0 -17
  509. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
  510. package/dist/esm/api/resources/event/types/index.d.mts +0 -1
  511. package/dist/esm/api/resources/event/types/index.mjs +0 -1
  512. /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
  513. /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → event/client/requests/CreateBatchEventsRequest.js} +0 -0
  514. /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
  515. /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → event/client/requests/CreateBatchEventsRequest.mjs} +0 -0
@@ -1,9 +1,9 @@
1
1
  export interface GetInboundEmailEventsByUuidResponse {
2
2
  /** List of attachments of the email. This will be present only after the processing is done. */
3
3
  attachments?: GetInboundEmailEventsByUuidResponse.Attachments.Item[] | undefined;
4
- /** Date when email was delivered successfully to client_dev’s webhook */
4
+ /** Date when email was delivered successfully to the client’s webhook */
5
5
  deliveredAt?: (string | null) | undefined;
6
- /** List of events/logs that describe the lifecycle of the email on SIB platform */
6
+ /** List of events/logs that describe the lifecycle of the email on the Brevo platform */
7
7
  logs?: GetInboundEmailEventsByUuidResponse.Logs.Item[] | undefined;
8
8
  /** Value of the Message-ID header. This will be present only after the processing is done. */
9
9
  messageId?: string | undefined;
@@ -33,7 +33,6 @@ export * as emailCampaigns from "./emailCampaigns/index.js";
33
33
  export * from "./emailCampaigns/types/index.js";
34
34
  export * from "./event/client/requests/index.js";
35
35
  export * as event from "./event/index.js";
36
- export * from "./event/types/index.js";
37
36
  export * from "./externalFeeds/client/requests/index.js";
38
37
  export * as externalFeeds from "./externalFeeds/index.js";
39
38
  export * from "./externalFeeds/types/index.js";
@@ -72,7 +72,6 @@ exports.emailCampaigns = __importStar(require("./emailCampaigns/index.js"));
72
72
  __exportStar(require("./emailCampaigns/types/index.js"), exports);
73
73
  __exportStar(require("./event/client/requests/index.js"), exports);
74
74
  exports.event = __importStar(require("./event/index.js"));
75
- __exportStar(require("./event/types/index.js"), exports);
76
75
  __exportStar(require("./externalFeeds/client/requests/index.js"), exports);
77
76
  exports.externalFeeds = __importStar(require("./externalFeeds/index.js"));
78
77
  __exportStar(require("./externalFeeds/types/index.js"), exports);
@@ -48,6 +48,8 @@ export declare class MasterAccountClient {
48
48
  * @param {Brevo.GetCorporateGroupIdRequest} request
49
49
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
50
50
  *
51
+ * @throws {@link Brevo.BadRequestError}
52
+ *
51
53
  * @example
52
54
  * await client.masterAccount.getAGroupDetails({
53
55
  * id: "id"
@@ -93,6 +95,8 @@ export declare class MasterAccountClient {
93
95
  *
94
96
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
95
97
  *
98
+ * @throws {@link Brevo.BadRequestError}
99
+ *
96
100
  * @example
97
101
  * await client.masterAccount.getSubAccountGroups()
98
102
  */
@@ -106,6 +110,8 @@ export declare class MasterAccountClient {
106
110
  * @param {Brevo.GetCorporateInvitedUsersListRequest} request
107
111
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
108
112
  *
113
+ * @throws {@link Brevo.BadRequestError}
114
+ *
109
115
  * @example
110
116
  * await client.masterAccount.getCorporateInvitedUsersList()
111
117
  */
@@ -117,6 +123,8 @@ export declare class MasterAccountClient {
117
123
  *
118
124
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
119
125
  *
126
+ * @throws {@link Brevo.BadRequestError}
127
+ *
120
128
  * @example
121
129
  * await client.masterAccount.listOfAllIPs()
122
130
  */
@@ -272,6 +280,8 @@ export declare class MasterAccountClient {
272
280
  getSubAccountDetails(request: Brevo.GetCorporateSubAccountIdRequest, requestOptions?: MasterAccountClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCorporateSubAccountIdResponse>;
273
281
  private __getSubAccountDetails;
274
282
  /**
283
+ * 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.
284
+ *
275
285
  * @param {Brevo.DeleteCorporateSubAccountIdRequest} request
276
286
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
277
287
  *
@@ -92,7 +92,7 @@ class MasterAccountClient {
92
92
  method: "POST",
93
93
  headers: _headers,
94
94
  contentType: "application/json",
95
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
95
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
96
96
  requestType: "json",
97
97
  body: request,
98
98
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -147,7 +147,7 @@ class MasterAccountClient {
147
147
  method: "PUT",
148
148
  headers: _headers,
149
149
  contentType: "application/json",
150
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
150
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
151
151
  requestType: "json",
152
152
  body: _body,
153
153
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -181,6 +181,8 @@ class MasterAccountClient {
181
181
  * @param {Brevo.GetCorporateGroupIdRequest} request
182
182
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
183
183
  *
184
+ * @throws {@link Brevo.BadRequestError}
185
+ *
184
186
  * @example
185
187
  * await client.masterAccount.getAGroupDetails({
186
188
  * id: "id"
@@ -199,7 +201,7 @@ class MasterAccountClient {
199
201
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/group/${core.url.encodePathParam(id)}`),
200
202
  method: "GET",
201
203
  headers: _headers,
202
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
204
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
203
205
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
204
206
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
205
207
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -210,11 +212,16 @@ class MasterAccountClient {
210
212
  return { data: _response.body, rawResponse: _response.rawResponse };
211
213
  }
212
214
  if (_response.error.reason === "status-code") {
213
- throw new errors.BrevoError({
214
- statusCode: _response.error.statusCode,
215
- body: _response.error.body,
216
- rawResponse: _response.rawResponse,
217
- });
215
+ switch (_response.error.statusCode) {
216
+ case 400:
217
+ throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
218
+ default:
219
+ throw new errors.BrevoError({
220
+ statusCode: _response.error.statusCode,
221
+ body: _response.error.body,
222
+ rawResponse: _response.rawResponse,
223
+ });
224
+ }
218
225
  }
219
226
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/corporate/group/{id}");
220
227
  });
@@ -246,7 +253,7 @@ class MasterAccountClient {
246
253
  method: "PUT",
247
254
  headers: _headers,
248
255
  contentType: "application/json",
249
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
256
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
250
257
  requestType: "json",
251
258
  body: _body,
252
259
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -302,7 +309,7 @@ class MasterAccountClient {
302
309
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/group/${core.url.encodePathParam(id)}`),
303
310
  method: "DELETE",
304
311
  headers: _headers,
305
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
312
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
306
313
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
307
314
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
308
315
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -332,6 +339,8 @@ class MasterAccountClient {
332
339
  *
333
340
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
334
341
  *
342
+ * @throws {@link Brevo.BadRequestError}
343
+ *
335
344
  * @example
336
345
  * await client.masterAccount.getSubAccountGroups()
337
346
  */
@@ -347,7 +356,7 @@ class MasterAccountClient {
347
356
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "corporate/groups"),
348
357
  method: "GET",
349
358
  headers: _headers,
350
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
359
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
351
360
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
352
361
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
353
362
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -361,11 +370,16 @@ class MasterAccountClient {
361
370
  };
362
371
  }
363
372
  if (_response.error.reason === "status-code") {
364
- throw new errors.BrevoError({
365
- statusCode: _response.error.statusCode,
366
- body: _response.error.body,
367
- rawResponse: _response.rawResponse,
368
- });
373
+ switch (_response.error.statusCode) {
374
+ case 400:
375
+ throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
376
+ default:
377
+ throw new errors.BrevoError({
378
+ statusCode: _response.error.statusCode,
379
+ body: _response.error.body,
380
+ rawResponse: _response.rawResponse,
381
+ });
382
+ }
369
383
  }
370
384
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/corporate/groups");
371
385
  });
@@ -378,6 +392,8 @@ class MasterAccountClient {
378
392
  * @param {Brevo.GetCorporateInvitedUsersListRequest} request
379
393
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
380
394
  *
395
+ * @throws {@link Brevo.BadRequestError}
396
+ *
381
397
  * @example
382
398
  * await client.masterAccount.getCorporateInvitedUsersList()
383
399
  */
@@ -399,7 +415,11 @@ class MasterAccountClient {
399
415
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "corporate/invited/users"),
400
416
  method: "GET",
401
417
  headers: _headers,
402
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
418
+ queryString: core.url
419
+ .queryBuilder()
420
+ .addMany(_queryParams)
421
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
422
+ .build(),
403
423
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
404
424
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
405
425
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -413,11 +433,16 @@ class MasterAccountClient {
413
433
  };
414
434
  }
415
435
  if (_response.error.reason === "status-code") {
416
- throw new errors.BrevoError({
417
- statusCode: _response.error.statusCode,
418
- body: _response.error.body,
419
- rawResponse: _response.rawResponse,
420
- });
436
+ switch (_response.error.statusCode) {
437
+ case 400:
438
+ throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
439
+ default:
440
+ throw new errors.BrevoError({
441
+ statusCode: _response.error.statusCode,
442
+ body: _response.error.body,
443
+ rawResponse: _response.rawResponse,
444
+ });
445
+ }
421
446
  }
422
447
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/corporate/invited/users");
423
448
  });
@@ -428,6 +453,8 @@ class MasterAccountClient {
428
453
  *
429
454
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
430
455
  *
456
+ * @throws {@link Brevo.BadRequestError}
457
+ *
431
458
  * @example
432
459
  * await client.masterAccount.listOfAllIPs()
433
460
  */
@@ -443,7 +470,7 @@ class MasterAccountClient {
443
470
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "corporate/ip"),
444
471
  method: "GET",
445
472
  headers: _headers,
446
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
473
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
447
474
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
448
475
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
449
476
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -454,11 +481,16 @@ class MasterAccountClient {
454
481
  return { data: _response.body, rawResponse: _response.rawResponse };
455
482
  }
456
483
  if (_response.error.reason === "status-code") {
457
- throw new errors.BrevoError({
458
- statusCode: _response.error.statusCode,
459
- body: _response.error.body,
460
- rawResponse: _response.rawResponse,
461
- });
484
+ switch (_response.error.statusCode) {
485
+ case 400:
486
+ throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
487
+ default:
488
+ throw new errors.BrevoError({
489
+ statusCode: _response.error.statusCode,
490
+ body: _response.error.body,
491
+ rawResponse: _response.rawResponse,
492
+ });
493
+ }
462
494
  }
463
495
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/corporate/ip");
464
496
  });
@@ -485,7 +517,7 @@ class MasterAccountClient {
485
517
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "corporate/masterAccount"),
486
518
  method: "GET",
487
519
  headers: _headers,
488
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
520
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
489
521
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
490
522
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
491
523
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -543,7 +575,7 @@ class MasterAccountClient {
543
575
  method: "POST",
544
576
  headers: _headers,
545
577
  contentType: "application/json",
546
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
578
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
547
579
  requestType: "json",
548
580
  body: request,
549
581
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -604,7 +636,11 @@ class MasterAccountClient {
604
636
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "corporate/subAccount"),
605
637
  method: "GET",
606
638
  headers: _headers,
607
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
639
+ queryString: core.url
640
+ .queryBuilder()
641
+ .addMany(_queryParams)
642
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
643
+ .build(),
608
644
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
609
645
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
610
646
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -659,7 +695,7 @@ class MasterAccountClient {
659
695
  method: "POST",
660
696
  headers: _headers,
661
697
  contentType: "application/json",
662
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
698
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
663
699
  requestType: "json",
664
700
  body: request,
665
701
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -716,7 +752,7 @@ class MasterAccountClient {
716
752
  method: "POST",
717
753
  headers: _headers,
718
754
  contentType: "application/json",
719
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
755
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
720
756
  requestType: "json",
721
757
  body: request,
722
758
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -770,7 +806,7 @@ class MasterAccountClient {
770
806
  method: "PUT",
771
807
  headers: _headers,
772
808
  contentType: "application/json",
773
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
809
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
774
810
  requestType: "json",
775
811
  body: request,
776
812
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -824,7 +860,7 @@ class MasterAccountClient {
824
860
  method: "POST",
825
861
  headers: _headers,
826
862
  contentType: "application/json",
827
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
863
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
828
864
  requestType: "json",
829
865
  body: request,
830
866
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -884,7 +920,7 @@ class MasterAccountClient {
884
920
  method: "POST",
885
921
  headers: _headers,
886
922
  contentType: "application/json",
887
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
923
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
888
924
  requestType: "json",
889
925
  body: request,
890
926
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -939,7 +975,7 @@ class MasterAccountClient {
939
975
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/subAccount/${core.url.encodePathParam(id)}`),
940
976
  method: "GET",
941
977
  headers: _headers,
942
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
978
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
943
979
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
944
980
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
945
981
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -968,6 +1004,8 @@ class MasterAccountClient {
968
1004
  });
969
1005
  }
970
1006
  /**
1007
+ * 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.
1008
+ *
971
1009
  * @param {Brevo.DeleteCorporateSubAccountIdRequest} request
972
1010
  * @param {MasterAccountClient.RequestOptions} requestOptions - Request-specific configuration.
973
1011
  *
@@ -992,7 +1030,7 @@ class MasterAccountClient {
992
1030
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/subAccount/${core.url.encodePathParam(id)}`),
993
1031
  method: "DELETE",
994
1032
  headers: _headers,
995
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1033
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
996
1034
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
997
1035
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
998
1036
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1053,7 +1091,7 @@ class MasterAccountClient {
1053
1091
  method: "PUT",
1054
1092
  headers: _headers,
1055
1093
  contentType: "application/json",
1056
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1094
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1057
1095
  requestType: "json",
1058
1096
  body: _body,
1059
1097
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1126,7 +1164,7 @@ class MasterAccountClient {
1126
1164
  method: "PUT",
1127
1165
  headers: _headers,
1128
1166
  contentType: "application/json",
1129
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1167
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1130
1168
  requestType: "json",
1131
1169
  body: _body,
1132
1170
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1197,7 +1235,7 @@ class MasterAccountClient {
1197
1235
  method: "PUT",
1198
1236
  headers: _headers,
1199
1237
  contentType: "application/json",
1200
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1238
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1201
1239
  requestType: "json",
1202
1240
  body: request,
1203
1241
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1279,7 +1317,7 @@ class MasterAccountClient {
1279
1317
  method: "POST",
1280
1318
  headers: _headers,
1281
1319
  contentType: "application/json",
1282
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1320
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1283
1321
  requestType: "json",
1284
1322
  body: request,
1285
1323
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1335,7 +1373,7 @@ class MasterAccountClient {
1335
1373
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/user/invitation/${core.url.encodePathParam(action)}/${core.url.encodePathParam(email)}`),
1336
1374
  method: "PUT",
1337
1375
  headers: _headers,
1338
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1376
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1339
1377
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1340
1378
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1341
1379
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1390,7 +1428,7 @@ class MasterAccountClient {
1390
1428
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/user/revoke/${core.url.encodePathParam(email)}`),
1391
1429
  method: "DELETE",
1392
1430
  headers: _headers,
1393
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1431
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1394
1432
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1395
1433
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1396
1434
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1441,7 +1479,7 @@ class MasterAccountClient {
1441
1479
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `corporate/user/${core.url.encodePathParam(email)}/permissions`),
1442
1480
  method: "GET",
1443
1481
  headers: _headers,
1444
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1482
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1445
1483
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1446
1484
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1447
1485
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1526,7 +1564,7 @@ class MasterAccountClient {
1526
1564
  method: "PUT",
1527
1565
  headers: _headers,
1528
1566
  contentType: "application/json",
1529
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1567
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1530
1568
  requestType: "json",
1531
1569
  body: _body,
1532
1570
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -11,6 +11,8 @@ export declare class NotesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<NotesClient.Options>;
12
12
  constructor(options: NotesClient.Options);
13
13
  /**
14
+ * 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.
15
+ *
14
16
  * @param {Brevo.GetCrmNotesRequest} request
15
17
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -22,6 +24,8 @@ export declare class NotesClient {
22
24
  getAllNotes(request?: Brevo.GetCrmNotesRequest, requestOptions?: NotesClient.RequestOptions): core.HttpResponsePromise<Brevo.Note[]>;
23
25
  private __getAllNotes;
24
26
  /**
27
+ * 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.
28
+ *
25
29
  * @param {Brevo.NoteData} request
26
30
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
27
31
  *
@@ -30,12 +34,14 @@ export declare class NotesClient {
30
34
  *
31
35
  * @example
32
36
  * await client.notes.createANote({
33
- * text: "In communication with client_dev for resolution of queries."
37
+ * text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
34
38
  * })
35
39
  */
36
40
  createANote(request: Brevo.NoteData, requestOptions?: NotesClient.RequestOptions): core.HttpResponsePromise<Brevo.PostCrmNotesResponse>;
37
41
  private __createANote;
38
42
  /**
43
+ * 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.
44
+ *
39
45
  * @param {Brevo.GetCrmNotesIdRequest} request
40
46
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
41
47
  *
@@ -50,6 +56,8 @@ export declare class NotesClient {
50
56
  getANote(request: Brevo.GetCrmNotesIdRequest, requestOptions?: NotesClient.RequestOptions): core.HttpResponsePromise<Brevo.Note>;
51
57
  private __getANote;
52
58
  /**
59
+ * Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals.
60
+ *
53
61
  * @param {Brevo.DeleteCrmNotesIdRequest} request
54
62
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
55
63
  *
@@ -64,6 +72,8 @@ export declare class NotesClient {
64
72
  deleteANote(request: Brevo.DeleteCrmNotesIdRequest, requestOptions?: NotesClient.RequestOptions): core.HttpResponsePromise<void>;
65
73
  private __deleteANote;
66
74
  /**
75
+ * 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.
76
+ *
67
77
  * @param {Brevo.PatchCrmNotesIdRequest} request
68
78
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
69
79
  *
@@ -75,7 +85,7 @@ export declare class NotesClient {
75
85
  * await client.notes.updateANote({
76
86
  * id: "id",
77
87
  * body: {
78
- * text: "In communication with client_dev for resolution of queries."
88
+ * text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
79
89
  * }
80
90
  * })
81
91
  */
@@ -56,6 +56,8 @@ class NotesClient {
56
56
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
57
57
  }
58
58
  /**
59
+ * 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.
60
+ *
59
61
  * @param {Brevo.GetCrmNotesRequest} request
60
62
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
61
63
  *
@@ -86,7 +88,11 @@ class NotesClient {
86
88
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "crm/notes"),
87
89
  method: "GET",
88
90
  headers: _headers,
89
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
91
+ queryString: core.url
92
+ .queryBuilder()
93
+ .addMany(_queryParams)
94
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
95
+ .build(),
90
96
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
91
97
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
92
98
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -112,6 +118,8 @@ class NotesClient {
112
118
  });
113
119
  }
114
120
  /**
121
+ * 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.
122
+ *
115
123
  * @param {Brevo.NoteData} request
116
124
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
117
125
  *
@@ -120,7 +128,7 @@ class NotesClient {
120
128
  *
121
129
  * @example
122
130
  * await client.notes.createANote({
123
- * text: "In communication with client_dev for resolution of queries."
131
+ * text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
124
132
  * })
125
133
  */
126
134
  createANote(request, requestOptions) {
@@ -136,7 +144,7 @@ class NotesClient {
136
144
  method: "POST",
137
145
  headers: _headers,
138
146
  contentType: "application/json",
139
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
147
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
140
148
  requestType: "json",
141
149
  body: request,
142
150
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -166,6 +174,8 @@ class NotesClient {
166
174
  });
167
175
  }
168
176
  /**
177
+ * 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.
178
+ *
169
179
  * @param {Brevo.GetCrmNotesIdRequest} request
170
180
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
171
181
  *
@@ -190,7 +200,7 @@ class NotesClient {
190
200
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/notes/${core.url.encodePathParam(id)}`),
191
201
  method: "GET",
192
202
  headers: _headers,
193
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
203
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
194
204
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
195
205
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
196
206
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -218,6 +228,8 @@ class NotesClient {
218
228
  });
219
229
  }
220
230
  /**
231
+ * Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals.
232
+ *
221
233
  * @param {Brevo.DeleteCrmNotesIdRequest} request
222
234
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
223
235
  *
@@ -242,7 +254,7 @@ class NotesClient {
242
254
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/notes/${core.url.encodePathParam(id)}`),
243
255
  method: "DELETE",
244
256
  headers: _headers,
245
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
257
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
246
258
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
247
259
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
248
260
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -270,6 +282,8 @@ class NotesClient {
270
282
  });
271
283
  }
272
284
  /**
285
+ * 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.
286
+ *
273
287
  * @param {Brevo.PatchCrmNotesIdRequest} request
274
288
  * @param {NotesClient.RequestOptions} requestOptions - Request-specific configuration.
275
289
  *
@@ -281,7 +295,7 @@ class NotesClient {
281
295
  * await client.notes.updateANote({
282
296
  * id: "id",
283
297
  * body: {
284
- * text: "In communication with client_dev for resolution of queries."
298
+ * text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
285
299
  * }
286
300
  * })
287
301
  */
@@ -299,7 +313,7 @@ class NotesClient {
299
313
  method: "PATCH",
300
314
  headers: _headers,
301
315
  contentType: "application/json",
302
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
316
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
303
317
  requestType: "json",
304
318
  body: _body,
305
319
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,