@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
@@ -67,6 +67,8 @@ class ContactsClient {
67
67
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
68
68
  }
69
69
  /**
70
+ * 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.
71
+ *
70
72
  * @param {Brevo.GetContactsRequest} request
71
73
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
72
74
  *
@@ -82,13 +84,14 @@ class ContactsClient {
82
84
  __getContacts() {
83
85
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
84
86
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
85
- const { limit, offset, modifiedSince, createdSince, sort, segmentId, listIds, filter } = request;
87
+ const { limit, offset, modifiedSince, createdSince, sort, ids, segmentId, listIds, filter } = request;
86
88
  const _queryParams = {
87
89
  limit,
88
90
  offset,
89
91
  modifiedSince,
90
92
  createdSince,
91
93
  sort: sort != null ? sort : undefined,
94
+ ids,
92
95
  segmentId,
93
96
  listIds,
94
97
  filter,
@@ -99,7 +102,11 @@ class ContactsClient {
99
102
  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, "contacts"),
100
103
  method: "GET",
101
104
  headers: _headers,
102
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
105
+ queryString: core.url
106
+ .queryBuilder()
107
+ .addMany(_queryParams)
108
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
109
+ .build(),
103
110
  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,
104
111
  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,
105
112
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -153,7 +160,7 @@ class ContactsClient {
153
160
  method: "POST",
154
161
  headers: _headers,
155
162
  contentType: "application/json",
156
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
163
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
157
164
  requestType: "json",
158
165
  body: request,
159
166
  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,
@@ -163,7 +170,10 @@ class ContactsClient {
163
170
  logging: this._options.logging,
164
171
  });
165
172
  if (_response.ok) {
166
- return { data: _response.body, rawResponse: _response.rawResponse };
173
+ return {
174
+ data: _response.body,
175
+ rawResponse: _response.rawResponse,
176
+ };
167
177
  }
168
178
  if (_response.error.reason === "status-code") {
169
179
  switch (_response.error.statusCode) {
@@ -183,8 +193,12 @@ class ContactsClient {
183
193
  });
184
194
  }
185
195
  /**
196
+ * 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.
197
+ *
186
198
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
187
199
  *
200
+ * @throws {@link Brevo.BadRequestError}
201
+ *
188
202
  * @example
189
203
  * await client.contacts.getAttributes()
190
204
  */
@@ -200,7 +214,7 @@ class ContactsClient {
200
214
  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, "contacts/attributes"),
201
215
  method: "GET",
202
216
  headers: _headers,
203
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
217
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
204
218
  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,
205
219
  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,
206
220
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -211,16 +225,23 @@ class ContactsClient {
211
225
  return { data: _response.body, rawResponse: _response.rawResponse };
212
226
  }
213
227
  if (_response.error.reason === "status-code") {
214
- throw new errors.BrevoError({
215
- statusCode: _response.error.statusCode,
216
- body: _response.error.body,
217
- rawResponse: _response.rawResponse,
218
- });
228
+ switch (_response.error.statusCode) {
229
+ case 400:
230
+ throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
231
+ default:
232
+ throw new errors.BrevoError({
233
+ statusCode: _response.error.statusCode,
234
+ body: _response.error.body,
235
+ rawResponse: _response.rawResponse,
236
+ });
237
+ }
219
238
  }
220
239
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/contacts/attributes");
221
240
  });
222
241
  }
223
242
  /**
243
+ * 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.
244
+ *
224
245
  * @param {Brevo.CreateAttributeRequest} request
225
246
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
226
247
  *
@@ -246,7 +267,7 @@ class ContactsClient {
246
267
  method: "POST",
247
268
  headers: _headers,
248
269
  contentType: "application/json",
249
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
270
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
250
271
  requestType: "json",
251
272
  body: _body,
252
273
  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,
@@ -274,6 +295,8 @@ class ContactsClient {
274
295
  });
275
296
  }
276
297
  /**
298
+ * 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.
299
+ *
277
300
  * @param {Brevo.UpdateAttributeRequest} request
278
301
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
279
302
  *
@@ -300,7 +323,7 @@ class ContactsClient {
300
323
  method: "PUT",
301
324
  headers: _headers,
302
325
  contentType: "application/json",
303
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
326
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
304
327
  requestType: "json",
305
328
  body: _body,
306
329
  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,
@@ -330,6 +353,8 @@ class ContactsClient {
330
353
  });
331
354
  }
332
355
  /**
356
+ * 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.
357
+ *
333
358
  * @param {Brevo.DeleteAttributeRequest} request
334
359
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
335
360
  *
@@ -355,7 +380,7 @@ class ContactsClient {
355
380
  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, `contacts/attributes/${core.url.encodePathParam(attributeCategory)}/${core.url.encodePathParam(attributeName)}`),
356
381
  method: "DELETE",
357
382
  headers: _headers,
358
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
383
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
359
384
  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,
360
385
  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,
361
386
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -383,6 +408,8 @@ class ContactsClient {
383
408
  });
384
409
  }
385
410
  /**
411
+ * 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.
412
+ *
386
413
  * @param {Brevo.DeleteMultiAttributeOptionsRequest} request
387
414
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
388
415
  *
@@ -409,7 +436,7 @@ class ContactsClient {
409
436
  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, `contacts/attributes/${core.url.encodePathParam(attributeType)}/${core.url.encodePathParam(multipleChoiceAttribute)}/${core.url.encodePathParam(multipleChoiceAttributeOption)}`),
410
437
  method: "DELETE",
411
438
  headers: _headers,
412
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
439
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
413
440
  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,
414
441
  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,
415
442
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -437,6 +464,8 @@ class ContactsClient {
437
464
  });
438
465
  }
439
466
  /**
467
+ * 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.
468
+ *
440
469
  * @param {Brevo.UpdateBatchContactsRequest} request
441
470
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
442
471
  *
@@ -458,7 +487,7 @@ class ContactsClient {
458
487
  method: "POST",
459
488
  headers: _headers,
460
489
  contentType: "application/json",
461
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
490
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
462
491
  requestType: "json",
463
492
  body: request,
464
493
  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,
@@ -514,7 +543,7 @@ class ContactsClient {
514
543
  method: "POST",
515
544
  headers: _headers,
516
545
  contentType: "application/json",
517
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
546
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
518
547
  requestType: "json",
519
548
  body: request,
520
549
  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,
@@ -568,7 +597,7 @@ class ContactsClient {
568
597
  method: "POST",
569
598
  headers: _headers,
570
599
  contentType: "application/json",
571
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
600
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
572
601
  requestType: "json",
573
602
  body: request,
574
603
  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,
@@ -630,7 +659,11 @@ class ContactsClient {
630
659
  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, "contacts/folders"),
631
660
  method: "GET",
632
661
  headers: _headers,
633
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
662
+ queryString: core.url
663
+ .queryBuilder()
664
+ .addMany(_queryParams)
665
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
666
+ .build(),
634
667
  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,
635
668
  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,
636
669
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -656,6 +689,8 @@ class ContactsClient {
656
689
  });
657
690
  }
658
691
  /**
692
+ * 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.
693
+ *
659
694
  * @param {Brevo.CreateUpdateFolder} request
660
695
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
661
696
  *
@@ -677,7 +712,7 @@ class ContactsClient {
677
712
  method: "POST",
678
713
  headers: _headers,
679
714
  contentType: "application/json",
680
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
715
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
681
716
  requestType: "json",
682
717
  body: request,
683
718
  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,
@@ -733,7 +768,7 @@ class ContactsClient {
733
768
  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, `contacts/folders/${core.url.encodePathParam(folderId)}`),
734
769
  method: "GET",
735
770
  headers: _headers,
736
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
771
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
737
772
  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,
738
773
  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,
739
774
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -761,6 +796,8 @@ class ContactsClient {
761
796
  });
762
797
  }
763
798
  /**
799
+ * 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.
800
+ *
764
801
  * @param {Brevo.UpdateFolderRequest} request
765
802
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
766
803
  *
@@ -787,7 +824,7 @@ class ContactsClient {
787
824
  method: "PUT",
788
825
  headers: _headers,
789
826
  contentType: "application/json",
790
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
827
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
791
828
  requestType: "json",
792
829
  body: _body,
793
830
  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,
@@ -817,6 +854,8 @@ class ContactsClient {
817
854
  });
818
855
  }
819
856
  /**
857
+ * 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.
858
+ *
820
859
  * @param {Brevo.DeleteFolderRequest} request
821
860
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
822
861
  *
@@ -841,7 +880,7 @@ class ContactsClient {
841
880
  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, `contacts/folders/${core.url.encodePathParam(folderId)}`),
842
881
  method: "DELETE",
843
882
  headers: _headers,
844
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
883
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
845
884
  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,
846
885
  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,
847
886
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -902,7 +941,11 @@ class ContactsClient {
902
941
  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, `contacts/folders/${core.url.encodePathParam(folderId)}/lists`),
903
942
  method: "GET",
904
943
  headers: _headers,
905
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
944
+ queryString: core.url
945
+ .queryBuilder()
946
+ .addMany(_queryParams)
947
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
948
+ .build(),
906
949
  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,
907
950
  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,
908
951
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -953,7 +996,7 @@ class ContactsClient {
953
996
  method: "POST",
954
997
  headers: _headers,
955
998
  contentType: "application/json",
956
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
999
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
957
1000
  requestType: "json",
958
1001
  body: request,
959
1002
  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,
@@ -1011,7 +1054,11 @@ class ContactsClient {
1011
1054
  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, "contacts/lists"),
1012
1055
  method: "GET",
1013
1056
  headers: _headers,
1014
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1057
+ queryString: core.url
1058
+ .queryBuilder()
1059
+ .addMany(_queryParams)
1060
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1061
+ .build(),
1015
1062
  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,
1016
1063
  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,
1017
1064
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1037,6 +1084,8 @@ class ContactsClient {
1037
1084
  });
1038
1085
  }
1039
1086
  /**
1087
+ * 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.
1088
+ *
1040
1089
  * @param {Brevo.CreateListRequest} request
1041
1090
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1042
1091
  *
@@ -1061,7 +1110,7 @@ class ContactsClient {
1061
1110
  method: "POST",
1062
1111
  headers: _headers,
1063
1112
  contentType: "application/json",
1064
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1113
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1065
1114
  requestType: "json",
1066
1115
  body: request,
1067
1116
  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,
@@ -1089,6 +1138,8 @@ class ContactsClient {
1089
1138
  });
1090
1139
  }
1091
1140
  /**
1141
+ * 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).
1142
+ *
1092
1143
  * @param {Brevo.GetListRequest} request
1093
1144
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1094
1145
  *
@@ -1117,7 +1168,11 @@ class ContactsClient {
1117
1168
  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, `contacts/lists/${core.url.encodePathParam(listId)}`),
1118
1169
  method: "GET",
1119
1170
  headers: _headers,
1120
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1171
+ queryString: core.url
1172
+ .queryBuilder()
1173
+ .addMany(_queryParams)
1174
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1175
+ .build(),
1121
1176
  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,
1122
1177
  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,
1123
1178
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1145,6 +1200,8 @@ class ContactsClient {
1145
1200
  });
1146
1201
  }
1147
1202
  /**
1203
+ * 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.
1204
+ *
1148
1205
  * @param {Brevo.UpdateListRequest} request
1149
1206
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1150
1207
  *
@@ -1170,7 +1227,7 @@ class ContactsClient {
1170
1227
  method: "PUT",
1171
1228
  headers: _headers,
1172
1229
  contentType: "application/json",
1173
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1230
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1174
1231
  requestType: "json",
1175
1232
  body: _body,
1176
1233
  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,
@@ -1200,6 +1257,8 @@ class ContactsClient {
1200
1257
  });
1201
1258
  }
1202
1259
  /**
1260
+ * 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.
1261
+ *
1203
1262
  * @param {Brevo.DeleteListRequest} request
1204
1263
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1205
1264
  *
@@ -1224,7 +1283,7 @@ class ContactsClient {
1224
1283
  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, `contacts/lists/${core.url.encodePathParam(listId)}`),
1225
1284
  method: "DELETE",
1226
1285
  headers: _headers,
1227
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1286
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1228
1287
  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,
1229
1288
  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,
1230
1289
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1252,11 +1311,14 @@ class ContactsClient {
1252
1311
  });
1253
1312
  }
1254
1313
  /**
1314
+ * 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.
1315
+ *
1255
1316
  * @param {Brevo.GetContactsFromListRequest} request
1256
1317
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1257
1318
  *
1258
1319
  * @throws {@link Brevo.BadRequestError}
1259
1320
  * @throws {@link Brevo.NotFoundError}
1321
+ * @throws {@link Brevo.TooManyRequestsError}
1260
1322
  *
1261
1323
  * @example
1262
1324
  * await client.contacts.getContactsFromList({
@@ -1282,7 +1344,11 @@ class ContactsClient {
1282
1344
  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, `contacts/lists/${core.url.encodePathParam(listId)}/contacts`),
1283
1345
  method: "GET",
1284
1346
  headers: _headers,
1285
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1347
+ queryString: core.url
1348
+ .queryBuilder()
1349
+ .addMany(_queryParams)
1350
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1351
+ .build(),
1286
1352
  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,
1287
1353
  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,
1288
1354
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1298,6 +1364,8 @@ class ContactsClient {
1298
1364
  throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
1299
1365
  case 404:
1300
1366
  throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
1367
+ case 429:
1368
+ throw new Brevo.TooManyRequestsError(_response.error.body, _response.rawResponse);
1301
1369
  default:
1302
1370
  throw new errors.BrevoError({
1303
1371
  statusCode: _response.error.statusCode,
@@ -1354,7 +1422,7 @@ class ContactsClient {
1354
1422
  method: "POST",
1355
1423
  headers: _headers,
1356
1424
  contentType: "application/json",
1357
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1425
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1358
1426
  requestType: "json",
1359
1427
  body: _body,
1360
1428
  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,
@@ -1436,7 +1504,7 @@ class ContactsClient {
1436
1504
  method: "POST",
1437
1505
  headers: _headers,
1438
1506
  contentType: "application/json",
1439
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1507
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1440
1508
  requestType: "json",
1441
1509
  body: _body,
1442
1510
  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,
@@ -1466,6 +1534,8 @@ class ContactsClient {
1466
1534
  });
1467
1535
  }
1468
1536
  /**
1537
+ * 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.
1538
+ *
1469
1539
  * @param {Brevo.GetSegmentsRequest} request
1470
1540
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1471
1541
  *
@@ -1492,7 +1562,11 @@ class ContactsClient {
1492
1562
  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, "contacts/segments"),
1493
1563
  method: "GET",
1494
1564
  headers: _headers,
1495
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1565
+ queryString: core.url
1566
+ .queryBuilder()
1567
+ .addMany(_queryParams)
1568
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1569
+ .build(),
1496
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,
1497
1571
  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,
1498
1572
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1551,7 +1625,11 @@ class ContactsClient {
1551
1625
  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, `contacts/${core.url.encodePathParam(identifier)}`),
1552
1626
  method: "GET",
1553
1627
  headers: _headers,
1554
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1628
+ queryString: core.url
1629
+ .queryBuilder()
1630
+ .addMany(_queryParams)
1631
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1632
+ .build(),
1555
1633
  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,
1556
1634
  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,
1557
1635
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1612,7 +1690,11 @@ class ContactsClient {
1612
1690
  method: "PUT",
1613
1691
  headers: _headers,
1614
1692
  contentType: "application/json",
1615
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1693
+ queryString: core.url
1694
+ .queryBuilder()
1695
+ .addMany(_queryParams)
1696
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1697
+ .build(),
1616
1698
  requestType: "json",
1617
1699
  body: _body,
1618
1700
  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,
@@ -1674,7 +1756,11 @@ class ContactsClient {
1674
1756
  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, `contacts/${core.url.encodePathParam(identifier)}`),
1675
1757
  method: "DELETE",
1676
1758
  headers: _headers,
1677
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1759
+ queryString: core.url
1760
+ .queryBuilder()
1761
+ .addMany(_queryParams)
1762
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1763
+ .build(),
1678
1764
  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,
1679
1765
  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,
1680
1766
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1704,6 +1790,8 @@ class ContactsClient {
1704
1790
  });
1705
1791
  }
1706
1792
  /**
1793
+ * 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.
1794
+ *
1707
1795
  * @param {Brevo.GetContactStatsRequest} request
1708
1796
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1709
1797
  *
@@ -1732,7 +1820,11 @@ class ContactsClient {
1732
1820
  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, `contacts/${core.url.encodePathParam(identifier)}/campaignStats`),
1733
1821
  method: "GET",
1734
1822
  headers: _headers,
1735
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1823
+ queryString: core.url
1824
+ .queryBuilder()
1825
+ .addMany(_queryParams)
1826
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1827
+ .build(),
1736
1828
  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,
1737
1829
  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,
1738
1830
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -19,9 +19,13 @@ export interface CreateContactRequest {
19
19
  smtpBlacklistSender?: string[];
20
20
  /** Facilitate to update the existing contact in the same request (updateEnabled = true) */
21
21
  updateEnabled?: boolean;
22
+ /** When true, if the contact being created shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. */
23
+ forceMerge?: boolean;
24
+ /** When true, the response returns the `id` of the surviving contact after merge. */
25
+ getId?: boolean;
22
26
  }
23
27
  export declare namespace CreateContactRequest {
24
28
  namespace Attributes {
25
- type Value = number | string | boolean | string[];
29
+ type Value = number | number | string | boolean | string[];
26
30
  }
27
31
  }
@@ -10,8 +10,8 @@ export interface GetContactInfoRequest {
10
10
  identifier: Brevo.GetContactInfoRequestIdentifier;
11
11
  /** email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute */
12
12
  identifierType?: Brevo.GetContactInfoRequestIdentifierType;
13
- /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate */
13
+ /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. */
14
14
  startDate?: string;
15
- /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. */
15
+ /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. */
16
16
  endDate?: string;
17
17
  }
@@ -8,8 +8,8 @@ import type * as Brevo from "../../../../index.js";
8
8
  export interface GetContactStatsRequest {
9
9
  /** Email (urlencoded) OR ID of the contact */
10
10
  identifier: Brevo.GetContactStatsRequestIdentifier;
11
- /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate */
11
+ /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. */
12
12
  startDate?: string;
13
- /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days */
13
+ /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days. */
14
14
  endDate?: string;
15
15
  }
@@ -14,7 +14,9 @@ export interface GetContactsRequest {
14
14
  createdSince?: string;
15
15
  /** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed */
16
16
  sort?: Brevo.GetContactsRequestSort;
17
- /** Id of the segment. **Either listIds or segmentId can be passed.** */
17
+ /** Filter by a list of contact IDs. You can pass a **maximum of 20 IDs**. All elements must be integers. */
18
+ ids?: number | number[];
19
+ /** Id of the segment. **Either listIds or segmentId can be passed.** Must be a positive integer (minimum value of 1). */
18
20
  segmentId?: number;
19
21
  /** Ids of the list. **Either listIds or segmentId can be passed.** */
20
22
  listIds?: number | number[];
@@ -7,7 +7,7 @@
7
7
  export interface GetListRequest {
8
8
  /** Id of the list */
9
9
  listId: number;
10
- /** **Mandatory if endDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
10
+ /** **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
11
11
  startDate?: string;
12
12
  /** **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
13
13
  endDate?: string;