@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
@@ -38,8 +38,12 @@ export declare namespace GetEmailCampaignsResponse {
38
38
  winnerCriteria?: string | undefined;
39
39
  /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */
40
40
  winnerDelay?: number | undefined;
41
+ /** URL of the attachment file associated with the campaign. Empty string if no attachment is present. */
42
+ attachmentUrl?: string | undefined;
41
43
  /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
42
44
  createdAt: string;
45
+ /** Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry. */
46
+ emailExpirationDate?: Item.EmailExpirationDate | undefined;
43
47
  /** Footer of the campaign */
44
48
  footer: string;
45
49
  /** Header of the campaign */
@@ -71,12 +75,13 @@ export declare namespace GetEmailCampaignsResponse {
71
75
  testSent: boolean;
72
76
  /** Customisation of the "to" field of the campaign */
73
77
  toField?: string | undefined;
74
- /** utm parameter associated with campaign */
78
+ /** The utm_campaign value associated with the campaign. Only present if a UTM campaign value was set. */
75
79
  utmCampaignValue?: string | undefined;
76
- /** utm id active */
77
- utmIDActive?: boolean | undefined;
80
+ /** The campaign ID used as utm_id parameter. Only present if UTM campaign tracking with ID is enabled. */
81
+ utmID?: number | undefined;
82
+ /** The utm_medium value. Set to "EMAIL" when UTM campaign tracking is enabled. */
78
83
  utmMedium?: string | undefined;
79
- /** source of utm */
84
+ /** The utm_source value. Set to "Brevo" when UTM campaign tracking is enabled. */
80
85
  utmSource?: string | undefined;
81
86
  recipients: Brevo.GetCampaignRecipients;
82
87
  statistics: Brevo.GetExtendedCampaignStats;
@@ -101,6 +106,24 @@ export declare namespace GetEmailCampaignsResponse {
101
106
  readonly Trigger: "trigger";
102
107
  };
103
108
  type Type = (typeof Type)[keyof typeof Type];
109
+ /**
110
+ * Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry.
111
+ */
112
+ interface EmailExpirationDate {
113
+ /** Duration of the email expiry */
114
+ duration?: number | undefined;
115
+ /** Unit of the duration */
116
+ unit?: EmailExpirationDate.Unit | undefined;
117
+ }
118
+ namespace EmailExpirationDate {
119
+ /** Unit of the duration */
120
+ const Unit: {
121
+ readonly Days: "days";
122
+ readonly Weeks: "weeks";
123
+ readonly Months: "months";
124
+ };
125
+ type Unit = (typeof Unit)[keyof typeof Unit];
126
+ }
104
127
  interface Sender {
105
128
  /** Sender email of the campaign */
106
129
  email?: string | undefined;
@@ -22,6 +22,15 @@ export var GetEmailCampaignsResponse;
22
22
  Classic: "classic",
23
23
  Trigger: "trigger",
24
24
  };
25
+ let EmailExpirationDate;
26
+ (function (EmailExpirationDate) {
27
+ /** Unit of the duration */
28
+ EmailExpirationDate.Unit = {
29
+ Days: "days",
30
+ Weeks: "weeks",
31
+ Months: "months",
32
+ };
33
+ })(EmailExpirationDate = Item.EmailExpirationDate || (Item.EmailExpirationDate = {}));
25
34
  })(Item = Campaigns.Item || (Campaigns.Item = {}));
26
35
  })(Campaigns = GetEmailCampaignsResponse.Campaigns || (GetEmailCampaignsResponse.Campaigns = {}));
27
36
  })(GetEmailCampaignsResponse || (GetEmailCampaignsResponse = {}));
@@ -49,18 +49,20 @@ export declare class EventClient {
49
49
  /**
50
50
  * Create multiple events to track contacts' interactions in a single request.
51
51
  *
52
- * @param {Brevo.CreateBatchEventsRequestItem[]} request
52
+ * @param {Brevo.CreateBatchEventsRequest} request
53
53
  * @param {EventClient.RequestOptions} requestOptions - Request-specific configuration.
54
54
  *
55
55
  * @throws {@link Brevo.BadRequestError}
56
56
  * @throws {@link Brevo.UnauthorizedError}
57
57
  *
58
58
  * @example
59
- * await client.event.createBatchEvents([{
60
- * event_name: "order_created",
61
- * identifiers: {}
62
- * }])
59
+ * await client.event.createBatchEvents({
60
+ * events: [{
61
+ * event_name: "order_created",
62
+ * identifiers: {}
63
+ * }]
64
+ * })
63
65
  */
64
- createBatchEvents(request: Brevo.CreateBatchEventsRequestItem[], requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<Brevo.BatchAcceptedResponse>;
66
+ createBatchEvents(request: Brevo.CreateBatchEventsRequest, requestOptions?: EventClient.RequestOptions): core.HttpResponsePromise<Brevo.BatchAcceptedResponse>;
65
67
  private __createBatchEvents;
66
68
  }
@@ -58,7 +58,11 @@ export class EventClient {
58
58
  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, "events"),
59
59
  method: "GET",
60
60
  headers: _headers,
61
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
61
+ queryString: core.url
62
+ .queryBuilder()
63
+ .addMany(_queryParams)
64
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
65
+ .build(),
62
66
  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,
63
67
  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,
64
68
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -115,7 +119,7 @@ export class EventClient {
115
119
  method: "POST",
116
120
  headers: _headers,
117
121
  contentType: "application/json",
118
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
122
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
119
123
  requestType: "json",
120
124
  body: request,
121
125
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -147,17 +151,19 @@ export class EventClient {
147
151
  /**
148
152
  * Create multiple events to track contacts' interactions in a single request.
149
153
  *
150
- * @param {Brevo.CreateBatchEventsRequestItem[]} request
154
+ * @param {Brevo.CreateBatchEventsRequest} request
151
155
  * @param {EventClient.RequestOptions} requestOptions - Request-specific configuration.
152
156
  *
153
157
  * @throws {@link Brevo.BadRequestError}
154
158
  * @throws {@link Brevo.UnauthorizedError}
155
159
  *
156
160
  * @example
157
- * await client.event.createBatchEvents([{
158
- * event_name: "order_created",
159
- * identifiers: {}
160
- * }])
161
+ * await client.event.createBatchEvents({
162
+ * events: [{
163
+ * event_name: "order_created",
164
+ * identifiers: {}
165
+ * }]
166
+ * })
161
167
  */
162
168
  createBatchEvents(request, requestOptions) {
163
169
  return core.HttpResponsePromise.fromPromise(this.__createBatchEvents(request, requestOptions));
@@ -172,7 +178,7 @@ export class EventClient {
172
178
  method: "POST",
173
179
  headers: _headers,
174
180
  contentType: "application/json",
175
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
181
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
176
182
  requestType: "json",
177
183
  body: request,
178
184
  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,
@@ -0,0 +1,76 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * events: [{
5
+ * event_name: "order_created",
6
+ * identifiers: {}
7
+ * }]
8
+ * }
9
+ */
10
+ export interface CreateBatchEventsRequest {
11
+ events: CreateBatchEventsRequest.Events.Item[];
12
+ }
13
+ export declare namespace CreateBatchEventsRequest {
14
+ type Events = Events.Item[];
15
+ namespace Events {
16
+ interface Item {
17
+ /** Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **"FIRSTNAME": "Jane" , "AGE": 37** */
18
+ contact_properties?: Record<string, Item.ContactProperties.Value> | undefined;
19
+ /** Timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). If no value is passed, the timestamp of the event creation is used. */
20
+ event_date?: string | undefined;
21
+ /** The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only. */
22
+ event_name: string;
23
+ /** Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb. */
24
+ event_properties?: Record<string, Item.EventProperties.Value> | undefined;
25
+ /** Identifies the contact associated with the event. At least one identifier is required. */
26
+ identifiers: Item.Identifiers;
27
+ /** Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account. */
28
+ object?: Item.Object_ | undefined;
29
+ }
30
+ namespace Item {
31
+ namespace ContactProperties {
32
+ type Value = string | number;
33
+ }
34
+ namespace EventProperties {
35
+ type Value = string | number | Record<string, unknown> | unknown[];
36
+ }
37
+ /**
38
+ * Identifies the contact associated with the event. At least one identifier is required.
39
+ */
40
+ interface Identifiers {
41
+ /** Internal unique contact ID. When present, this takes priority over all other identifiers for event attribution and contact resolution. */
42
+ contact_id?: number | undefined;
43
+ /** Email Id associated with the event */
44
+ email_id?: string | undefined;
45
+ /** ext_id associated with the event */
46
+ ext_id?: string | undefined;
47
+ /** landline_number associated with the event */
48
+ landline_number_id?: string | undefined;
49
+ /** SMS associated with the event */
50
+ phone_id?: string | undefined;
51
+ /** whatsapp associated with the event */
52
+ whatsapp_id?: string | undefined;
53
+ }
54
+ /**
55
+ * Identifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account.
56
+ */
57
+ interface Object_ {
58
+ /** Identifiers for the object. */
59
+ identifiers?: Object_.Identifiers | undefined;
60
+ /** Type of object (e.g., subscription, vehicle, etc.) */
61
+ type?: string | undefined;
62
+ }
63
+ namespace Object_ {
64
+ /**
65
+ * Identifiers for the object.
66
+ */
67
+ interface Identifiers {
68
+ /** External object ID */
69
+ ext_id?: string | undefined;
70
+ /** Internal object ID */
71
+ id?: string | undefined;
72
+ }
73
+ }
74
+ }
75
+ }
76
+ }
@@ -8,11 +8,11 @@
8
8
  export interface CreateEventRequest {
9
9
  /** Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **"FIRSTNAME": "Jane" , "AGE": 37** */
10
10
  contact_properties?: Record<string, CreateEventRequest.ContactProperties.Value>;
11
- /** Timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). If no value is passed, the timestamp of the event creation is used. */
11
+ /** ISO 8601 timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). If no value is passed, the timestamp of the event creation is used. */
12
12
  event_date?: string;
13
- /** The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only. */
13
+ /** The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters; only alphanumeric characters, hyphens (-), and underscores (_) are allowed. */
14
14
  event_name: string;
15
- /** Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb. */
15
+ /** Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field types are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50KB. */
16
16
  event_properties?: Record<string, CreateEventRequest.EventProperties.Value>;
17
17
  /** Identifies the contact associated with the event. At least one identifier is required. */
18
18
  identifiers: CreateEventRequest.Identifiers;
@@ -21,10 +21,10 @@ export interface CreateEventRequest {
21
21
  }
22
22
  export declare namespace CreateEventRequest {
23
23
  namespace ContactProperties {
24
- type Value = string | number;
24
+ type Value = string | number | boolean;
25
25
  }
26
26
  namespace EventProperties {
27
- type Value = string | number | Record<string, unknown> | unknown[];
27
+ type Value = string | number | boolean | Record<string, unknown> | unknown[];
28
28
  }
29
29
  /**
30
30
  * Identifies the contact associated with the event. At least one identifier is required.
@@ -1,2 +1,3 @@
1
+ export type { CreateBatchEventsRequest } from "./CreateBatchEventsRequest.mjs";
1
2
  export type { CreateEventRequest } from "./CreateEventRequest.mjs";
2
3
  export type { GetEventsRequest } from "./GetEventsRequest.mjs";
@@ -1,2 +1 @@
1
1
  export * from "./client/index.mjs";
2
- export * from "./types/index.mjs";
@@ -1,2 +1 @@
1
1
  export * from "./client/index.mjs";
2
- export * from "./types/index.mjs";
@@ -92,7 +92,11 @@ export class ExternalFeedsClient {
92
92
  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, "feeds"),
93
93
  method: "GET",
94
94
  headers: _headers,
95
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
95
+ queryString: core.url
96
+ .queryBuilder()
97
+ .addMany(_queryParams)
98
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
99
+ .build(),
96
100
  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,
97
101
  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,
98
102
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -187,7 +191,7 @@ export class ExternalFeedsClient {
187
191
  method: "POST",
188
192
  headers: _headers,
189
193
  contentType: "application/json",
190
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
194
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
191
195
  requestType: "json",
192
196
  body: request,
193
197
  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,
@@ -262,7 +266,7 @@ export class ExternalFeedsClient {
262
266
  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, `feeds/${core.url.encodePathParam(uuid)}`),
263
267
  method: "GET",
264
268
  headers: _headers,
265
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
269
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
266
270
  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,
267
271
  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,
268
272
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -380,7 +384,7 @@ export class ExternalFeedsClient {
380
384
  method: "PUT",
381
385
  headers: _headers,
382
386
  contentType: "application/json",
383
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
387
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
384
388
  requestType: "json",
385
389
  body: _body,
386
390
  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,
@@ -452,7 +456,7 @@ export class ExternalFeedsClient {
452
456
  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, `feeds/${core.url.encodePathParam(uuid)}`),
453
457
  method: "DELETE",
454
458
  headers: _headers,
455
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
459
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
456
460
  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,
457
461
  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,
458
462
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -12,24 +12,20 @@ export declare namespace GetAllExternalFeedsResponse {
12
12
  id: string;
13
13
  /** Name of the feed */
14
14
  name: string;
15
- /** URL-friendly alias for the feed */
16
- alias: string;
17
15
  /** URL of the external data source */
18
16
  url: string;
19
17
  /** Authentication type for accessing the feed */
20
18
  authType: Item.AuthType;
21
- /** Username for basic authentication */
19
+ /** Username for basic authentication. Only returned when authType is 'basic'. Excluded when authType is 'token'. */
22
20
  username?: string | undefined;
23
- /** Password for basic authentication */
21
+ /** Password for basic authentication. Only returned when authType is 'basic'. Excluded when authType is 'token'. */
24
22
  password?: string | undefined;
25
- /** Token for token-based authentication */
23
+ /** Token for token-based authentication. Only returned when authType is 'token'. Excluded when authType is 'basic' or 'noAuth'. */
26
24
  token?: string | undefined;
27
25
  /** Maximum number of retry attempts for failed requests */
28
26
  maxRetries: number;
29
27
  /** Whether to cache the feed response */
30
28
  cache: boolean;
31
- /** Whether this is an internal Brevo system feed */
32
- isInternal: boolean;
33
29
  /** Custom HTTP headers for the feed request */
34
30
  headers?: (Item.Headers.Item[] | null) | undefined;
35
31
  /** Feed creation timestamp */
@@ -7,18 +7,12 @@ export interface GetExternalFeedByUuidResponse {
7
7
  url: string;
8
8
  /** Authentication type for accessing the feed */
9
9
  authType: GetExternalFeedByUuidResponse.AuthType;
10
- /** Username for basic authentication (null if not using basic auth) */
10
+ /** Username for basic authentication. Only returned when authType is 'basic'. Excluded from response when authType is 'token'. */
11
11
  username?: (string | null) | undefined;
12
- /** Password for basic authentication (null if not using basic auth) */
12
+ /** Password for basic authentication. Only returned when authType is 'basic'. Excluded from response when authType is 'token'. */
13
13
  password?: (string | null) | undefined;
14
- /** Token for token-based authentication (null if not using token auth) */
14
+ /** Token for token-based authentication. Only returned when authType is 'token'. Excluded from response when authType is 'basic' or 'noAuth'. */
15
15
  token?: (string | null) | undefined;
16
- /** Whether personalization is enabled for this feed */
17
- personalization: boolean;
18
- /** Default attribute name for personalization fallback (empty string if not set) */
19
- defaultAttr: string;
20
- /** Default contact email for personalization fallback (empty string if not set) */
21
- defaultContact: string;
22
16
  /** Custom HTTP headers for the feed request */
23
17
  headers?: (GetExternalFeedByUuidResponse.Headers.Item[] | null) | undefined;
24
18
  /** Maximum number of retry attempts for failed requests */
@@ -11,6 +11,8 @@ export declare class FilesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<FilesClient.Options>;
12
12
  constructor(options: FilesClient.Options);
13
13
  /**
14
+ * Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.
15
+ *
14
16
  * @param {Brevo.GetCrmFilesRequest} request
15
17
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -22,6 +24,8 @@ export declare class FilesClient {
22
24
  getAllFiles(request?: Brevo.GetCrmFilesRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Brevo.FileData[]>;
23
25
  private __getAllFiles;
24
26
  /**
27
+ * Upload a file and associate it with a contact, company, or deal. The file must be sent as multipart form data with a maximum size of 10 MB. You can optionally link the file to a specific entity by providing the corresponding entity ID.
28
+ *
25
29
  * @param {Brevo.PostCrmFilesRequest} request
26
30
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
27
31
  *
@@ -36,6 +40,8 @@ export declare class FilesClient {
36
40
  uploadAFile(request: Brevo.PostCrmFilesRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Brevo.FileData>;
37
41
  private __uploadAFile;
38
42
  /**
43
+ * Get a temporary download URL for a CRM file by its identifier. The returned URL is valid for 5 minutes only and provides direct access to the file content.
44
+ *
39
45
  * @param {Brevo.GetCrmFilesIdRequest} request
40
46
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
41
47
  *
@@ -50,6 +56,8 @@ export declare class FilesClient {
50
56
  downloadAFile(request: Brevo.GetCrmFilesIdRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCrmFilesIdResponse>;
51
57
  private __downloadAFile;
52
58
  /**
59
+ * Permanently delete a CRM file by its identifier. This removes the file from storage and unlinks it from any associated contacts, companies, or deals.
60
+ *
53
61
  * @param {Brevo.DeleteCrmFilesIdRequest} request
54
62
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
55
63
  *
@@ -64,6 +72,8 @@ export declare class FilesClient {
64
72
  deleteAFile(request: Brevo.DeleteCrmFilesIdRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
65
73
  private __deleteAFile;
66
74
  /**
75
+ * Retrieve the metadata and details of a specific CRM file by its identifier. This returns information such as the file name, size, type, creation date, and associated entities, but does not include the file content itself.
76
+ *
67
77
  * @param {Brevo.GetCrmFilesIdDataRequest} request
68
78
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
69
79
  *
@@ -20,6 +20,8 @@ export class FilesClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
+ * Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.
24
+ *
23
25
  * @param {Brevo.GetCrmFilesRequest} request
24
26
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
25
27
  *
@@ -50,7 +52,11 @@ export class FilesClient {
50
52
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "crm/files"),
51
53
  method: "GET",
52
54
  headers: _headers,
53
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
55
+ queryString: core.url
56
+ .queryBuilder()
57
+ .addMany(_queryParams)
58
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
59
+ .build(),
54
60
  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,
55
61
  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,
56
62
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -76,6 +82,8 @@ export class FilesClient {
76
82
  });
77
83
  }
78
84
  /**
85
+ * Upload a file and associate it with a contact, company, or deal. The file must be sent as multipart form data with a maximum size of 10 MB. You can optionally link the file to a specific entity by providing the corresponding entity ID.
86
+ *
79
87
  * @param {Brevo.PostCrmFilesRequest} request
80
88
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
81
89
  *
@@ -111,7 +119,7 @@ export class FilesClient {
111
119
  url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.BrevoEnvironment.Default, "crm/files"),
112
120
  method: "POST",
113
121
  headers: _headers,
114
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
122
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
115
123
  requestType: "file",
116
124
  duplex: _maybeEncodedRequest.duplex,
117
125
  body: _maybeEncodedRequest.body,
@@ -140,6 +148,8 @@ export class FilesClient {
140
148
  });
141
149
  }
142
150
  /**
151
+ * Get a temporary download URL for a CRM file by its identifier. The returned URL is valid for 5 minutes only and provides direct access to the file content.
152
+ *
143
153
  * @param {Brevo.GetCrmFilesIdRequest} request
144
154
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
145
155
  *
@@ -164,7 +174,7 @@ export class FilesClient {
164
174
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/files/${core.url.encodePathParam(id)}`),
165
175
  method: "GET",
166
176
  headers: _headers,
167
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
177
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
168
178
  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,
169
179
  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,
170
180
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -192,6 +202,8 @@ export class FilesClient {
192
202
  });
193
203
  }
194
204
  /**
205
+ * Permanently delete a CRM file by its identifier. This removes the file from storage and unlinks it from any associated contacts, companies, or deals.
206
+ *
195
207
  * @param {Brevo.DeleteCrmFilesIdRequest} request
196
208
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
197
209
  *
@@ -216,7 +228,7 @@ export class FilesClient {
216
228
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/files/${core.url.encodePathParam(id)}`),
217
229
  method: "DELETE",
218
230
  headers: _headers,
219
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
231
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
220
232
  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,
221
233
  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,
222
234
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -244,6 +256,8 @@ export class FilesClient {
244
256
  });
245
257
  }
246
258
  /**
259
+ * Retrieve the metadata and details of a specific CRM file by its identifier. This returns information such as the file name, size, type, creation date, and associated entities, but does not include the file content itself.
260
+ *
247
261
  * @param {Brevo.GetCrmFilesIdDataRequest} request
248
262
  * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
249
263
  *
@@ -268,7 +282,7 @@ export class FilesClient {
268
282
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `crm/files/${core.url.encodePathParam(id)}/data`),
269
283
  method: "GET",
270
284
  headers: _headers,
271
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
285
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
272
286
  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,
273
287
  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,
274
288
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -11,7 +11,7 @@ export declare class InboundParsingClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<InboundParsingClient.Options>;
12
12
  constructor(options: InboundParsingClient.Options);
13
13
  /**
14
- * This endpoint will show the list of all the events for the received emails.
14
+ * This endpoint will show the list of all the events for the received emails. When no date range is provided, the last 30 days of events are returned by default.
15
15
  *
16
16
  * @param {Brevo.GetInboundEmailEventsRequest} request
17
17
  * @param {InboundParsingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -30,6 +30,7 @@ export declare class InboundParsingClient {
30
30
  * @param {InboundParsingClient.RequestOptions} requestOptions - Request-specific configuration.
31
31
  *
32
32
  * @throws {@link Brevo.BadRequestError}
33
+ * @throws {@link Brevo.NotFoundError}
33
34
  *
34
35
  * @example
35
36
  * await client.inboundParsing.getInboundEmailEventsByUuid({
@@ -20,7 +20,7 @@ export class InboundParsingClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
- * This endpoint will show the list of all the events for the received emails.
23
+ * This endpoint will show the list of all the events for the received emails. When no date range is provided, the last 30 days of events are returned by default.
24
24
  *
25
25
  * @param {Brevo.GetInboundEmailEventsRequest} request
26
26
  * @param {InboundParsingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,7 +51,11 @@ export class InboundParsingClient {
51
51
  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, "inbound/events"),
52
52
  method: "GET",
53
53
  headers: _headers,
54
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
54
+ queryString: core.url
55
+ .queryBuilder()
56
+ .addMany(_queryParams)
57
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
58
+ .build(),
55
59
  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,
56
60
  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,
57
61
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -83,6 +87,7 @@ export class InboundParsingClient {
83
87
  * @param {InboundParsingClient.RequestOptions} requestOptions - Request-specific configuration.
84
88
  *
85
89
  * @throws {@link Brevo.BadRequestError}
90
+ * @throws {@link Brevo.NotFoundError}
86
91
  *
87
92
  * @example
88
93
  * await client.inboundParsing.getInboundEmailEventsByUuid({
@@ -102,7 +107,7 @@ export class InboundParsingClient {
102
107
  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, `inbound/events/${core.url.encodePathParam(uuid)}`),
103
108
  method: "GET",
104
109
  headers: _headers,
105
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
110
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
106
111
  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,
107
112
  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,
108
113
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -119,6 +124,8 @@ export class InboundParsingClient {
119
124
  switch (_response.error.statusCode) {
120
125
  case 400:
121
126
  throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
127
+ case 404:
128
+ throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
122
129
  default:
123
130
  throw new errors.BrevoError({
124
131
  statusCode: _response.error.statusCode,
@@ -149,7 +156,7 @@ export class InboundParsingClient {
149
156
  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, `inbound/attachments/${core.url.encodePathParam(downloadToken)}`),
150
157
  method: "GET",
151
158
  headers: _headers,
152
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
159
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
153
160
  responseType: "binary-response",
154
161
  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,
155
162
  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,
@@ -6,9 +6,9 @@ import type * as Brevo from "../../../../index.mjs";
6
6
  export interface GetInboundEmailEventsRequest {
7
7
  /** Email address of the sender. */
8
8
  sender?: string;
9
- /** Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. */
9
+ /** Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future. */
10
10
  startDate?: string;
11
- /** Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. */
11
+ /** Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future. */
12
12
  endDate?: string;
13
13
  /** Number of documents returned per page */
14
14
  limit?: number;