@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
@@ -4,7 +4,7 @@ import type * as Brevo from "../../../../index.js";
4
4
  * {
5
5
  * id: "id",
6
6
  * body: {
7
- * text: "In communication with client_dev for resolution of queries."
7
+ * text: "<p>Meeting notes: <b>Action item</b> - visit <a href=\"https://www.brevo.com/\">Brevo</a> for details.</p>"
8
8
  * }
9
9
  * }
10
10
  */
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Updated Note ID
2
+ * Created Note ID
3
3
  */
4
4
  export interface PostCrmNotesResponse {
5
5
  /** Unique note Id */
@@ -11,6 +11,8 @@ export declare class PaymentsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<PaymentsClient.Options>;
12
12
  constructor(options: PaymentsClient.Options);
13
13
  /**
14
+ * Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders. Returns the payment request ID and its public payment URL. A `403` error is returned if Brevo Payments is not activated or the account is not validated.
15
+ *
14
16
  * @param {Brevo.CreatePaymentRequestRequest} request
15
17
  * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -31,6 +33,8 @@ export declare class PaymentsClient {
31
33
  createPaymentRequest(request: Brevo.CreatePaymentRequestRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreatePaymentRequestResponse>;
32
34
  private __createPaymentRequest;
33
35
  /**
36
+ * Retrieve the details of a specific payment request by its ID. The response includes the reference, status (created, sent, reminderSent, or paid), cart details, notification configuration, contact ID, and the number of reminders sent. Returns a `404` error if no payment request matches the provided ID.
37
+ *
34
38
  * @param {Brevo.GetPaymentRequestRequest} request
35
39
  * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
36
40
  *
@@ -47,6 +51,8 @@ export declare class PaymentsClient {
47
51
  getPaymentRequest(request: Brevo.GetPaymentRequestRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetPaymentRequestResponse>;
48
52
  private __getPaymentRequest;
49
53
  /**
54
+ * Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a `404` error if no payment request matches the provided ID, and a `403` error if Brevo Payments is not activated or the account is not validated.
55
+ *
50
56
  * @param {Brevo.DeletePaymentRequestRequest} request
51
57
  * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
52
58
  *
@@ -56,6 +56,8 @@ class PaymentsClient {
56
56
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
57
57
  }
58
58
  /**
59
+ * Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders. Returns the payment request ID and its public payment URL. A `403` error is returned if Brevo Payments is not activated or the account is not validated.
60
+ *
59
61
  * @param {Brevo.CreatePaymentRequestRequest} request
60
62
  * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
61
63
  *
@@ -86,7 +88,7 @@ class PaymentsClient {
86
88
  method: "POST",
87
89
  headers: _headers,
88
90
  contentType: "application/json",
89
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
91
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
90
92
  requestType: "json",
91
93
  body: request,
92
94
  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,
@@ -118,6 +120,8 @@ class PaymentsClient {
118
120
  });
119
121
  }
120
122
  /**
123
+ * Retrieve the details of a specific payment request by its ID. The response includes the reference, status (created, sent, reminderSent, or paid), cart details, notification configuration, contact ID, and the number of reminders sent. Returns a `404` error if no payment request matches the provided ID.
124
+ *
121
125
  * @param {Brevo.GetPaymentRequestRequest} request
122
126
  * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
123
127
  *
@@ -144,7 +148,7 @@ class PaymentsClient {
144
148
  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, `payments/requests/${core.url.encodePathParam(id)}`),
145
149
  method: "GET",
146
150
  headers: _headers,
147
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
151
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
148
152
  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,
149
153
  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,
150
154
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -176,6 +180,8 @@ class PaymentsClient {
176
180
  });
177
181
  }
178
182
  /**
183
+ * Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a `404` error if no payment request matches the provided ID, and a `403` error if Brevo Payments is not activated or the account is not validated.
184
+ *
179
185
  * @param {Brevo.DeletePaymentRequestRequest} request
180
186
  * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.
181
187
  *
@@ -201,7 +207,7 @@ class PaymentsClient {
201
207
  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, `payments/requests/${core.url.encodePathParam(id)}`),
202
208
  method: "DELETE",
203
209
  headers: _headers,
204
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
210
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
205
211
  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,
206
212
  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,
207
213
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -21,20 +21,19 @@ export declare class ProcessClient {
21
21
  * - Identify failed or stuck processes for troubleshooting
22
22
  *
23
23
  * **Key information returned:**
24
- * - Process details (ID, name, type, status)
25
- * - Process creation and completion timestamps
26
- * - Process progress and completion status
27
- * - Error information for failed processes
28
- * - Process result data and download links
24
+ * - Process details (ID, name, status)
25
+ * - Export download URLs for completed export processes
26
+ * - Import details with CSV report URLs for completed import processes
27
+ * - Total count of processes for pagination
29
28
  *
30
29
  * **Important considerations:**
31
30
  * - Background processes handle long-running operations like imports and exports
32
- * - Process status indicates current state (queued, processing, completed, failed, cancelled)
31
+ * - Process status indicates current state (queued, processing, completed)
33
32
  * - Export processes provide download URLs when completed
34
- * - Failed processes include error messages for troubleshooting
33
+ * - Import processes provide CSV report URLs with details about problematic records
35
34
  * - Use pagination for accounts with many historical processes
36
35
  * - Sort options available for creation order (ascending or descending)
37
- * - Different process types handle specific operations (imports, exports, calculations)
36
+ * - Default limit is 10 results per page, maximum is 50
38
37
  *
39
38
  * @param {Brevo.GetProcessesRequest} request
40
39
  * @param {ProcessClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,18 +56,14 @@ export declare class ProcessClient {
57
56
  * - Track process execution times
58
57
  *
59
58
  * **Key information returned:**
60
- * - Complete process details and status
61
- * - Import/export statistics and results
62
- * - Error information for troubleshooting
63
- * - Download URLs for export processes
64
- * - Process timing and performance data
59
+ * - Complete process details (ID, name, status)
60
+ * - Download URLs for completed export processes
61
+ * - Import details with CSV report URLs for completed import processes
65
62
  *
66
63
  * **Important considerations:**
67
- * - Process ID must exist in your account
68
- * - Completed processes provide detailed statistics and results
69
- * - Export processes include download URLs when successful
70
- * - Failed processes contain error messages for debugging
71
- * - Timing information helps with performance analysis
64
+ * - Process ID must exist in your account and not be deleted
65
+ * - Completed export processes include download URLs
66
+ * - Completed import processes include CSV report URLs with details about problematic records
72
67
  * - Different process types return different result structures
73
68
  *
74
69
  * @param {Brevo.GetProcessRequest} request
@@ -66,20 +66,19 @@ class ProcessClient {
66
66
  * - Identify failed or stuck processes for troubleshooting
67
67
  *
68
68
  * **Key information returned:**
69
- * - Process details (ID, name, type, status)
70
- * - Process creation and completion timestamps
71
- * - Process progress and completion status
72
- * - Error information for failed processes
73
- * - Process result data and download links
69
+ * - Process details (ID, name, status)
70
+ * - Export download URLs for completed export processes
71
+ * - Import details with CSV report URLs for completed import processes
72
+ * - Total count of processes for pagination
74
73
  *
75
74
  * **Important considerations:**
76
75
  * - Background processes handle long-running operations like imports and exports
77
- * - Process status indicates current state (queued, processing, completed, failed, cancelled)
76
+ * - Process status indicates current state (queued, processing, completed)
78
77
  * - Export processes provide download URLs when completed
79
- * - Failed processes include error messages for troubleshooting
78
+ * - Import processes provide CSV report URLs with details about problematic records
80
79
  * - Use pagination for accounts with many historical processes
81
80
  * - Sort options available for creation order (ascending or descending)
82
- * - Different process types handle specific operations (imports, exports, calculations)
81
+ * - Default limit is 10 results per page, maximum is 50
83
82
  *
84
83
  * @param {Brevo.GetProcessesRequest} request
85
84
  * @param {ProcessClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -107,7 +106,11 @@ class ProcessClient {
107
106
  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, "processes"),
108
107
  method: "GET",
109
108
  headers: _headers,
110
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
109
+ queryString: core.url
110
+ .queryBuilder()
111
+ .addMany(_queryParams)
112
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
113
+ .build(),
111
114
  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,
112
115
  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,
113
116
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -143,18 +146,14 @@ class ProcessClient {
143
146
  * - Track process execution times
144
147
  *
145
148
  * **Key information returned:**
146
- * - Complete process details and status
147
- * - Import/export statistics and results
148
- * - Error information for troubleshooting
149
- * - Download URLs for export processes
150
- * - Process timing and performance data
149
+ * - Complete process details (ID, name, status)
150
+ * - Download URLs for completed export processes
151
+ * - Import details with CSV report URLs for completed import processes
151
152
  *
152
153
  * **Important considerations:**
153
- * - Process ID must exist in your account
154
- * - Completed processes provide detailed statistics and results
155
- * - Export processes include download URLs when successful
156
- * - Failed processes contain error messages for debugging
157
- * - Timing information helps with performance analysis
154
+ * - Process ID must exist in your account and not be deleted
155
+ * - Completed export processes include download URLs
156
+ * - Completed import processes include CSV report URLs with details about problematic records
158
157
  * - Different process types return different result structures
159
158
  *
160
159
  * @param {Brevo.GetProcessRequest} request
@@ -181,7 +180,7 @@ class ProcessClient {
181
180
  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, `processes/${core.url.encodePathParam(processId)}`),
182
181
  method: "GET",
183
182
  headers: _headers,
184
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
183
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
185
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,
186
185
  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,
187
186
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -5,16 +5,10 @@ export interface GetProcessResponse {
5
5
  name: GetProcessResponse.Name;
6
6
  /** Current status of the process */
7
7
  status: GetProcessResponse.Status;
8
- /** Additional process information (for completed processes) */
9
- info?: (GetProcessResponse.Info | null) | undefined;
10
- /** Download URL for completed export processes */
11
- export_url?: (string | null) | undefined;
12
- /** Error message for failed processes */
13
- error?: (string | null) | undefined;
14
- /** Process creation timestamp */
15
- created_at?: (string | null) | undefined;
16
- /** Process completion timestamp */
17
- completed_at?: (string | null) | undefined;
8
+ /** Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records. */
9
+ info?: GetProcessResponse.Info | undefined;
10
+ /** Download URL for completed export processes (returned for SEARCH_EXPORT_USERS, SEARCH_EXPORT_USERS_API, CAMPAIGN_USER_DETAILS, and EXPORT_WEBHOOK process types) */
11
+ export_url?: string | undefined;
18
12
  }
19
13
  export declare namespace GetProcessResponse {
20
14
  /** Name/type of the process */
@@ -31,6 +25,7 @@ export declare namespace GetProcessResponse {
31
25
  /** Current status of the process */
32
26
  const Status: {
33
27
  readonly Queued: "queued";
28
+ readonly InProcess: "in_process";
34
29
  readonly Processing: "processing";
35
30
  readonly Completed: "completed";
36
31
  readonly Failed: "failed";
@@ -38,42 +33,31 @@ export declare namespace GetProcessResponse {
38
33
  };
39
34
  type Status = (typeof Status)[keyof typeof Status];
40
35
  /**
41
- * Additional process information (for completed processes)
36
+ * Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records.
42
37
  */
43
38
  interface Info {
44
- /** Import process details */
39
+ /** Import process details with URLs to CSV reports */
45
40
  import?: Info.Import | undefined;
46
- /** Export process details */
47
- export?: Info.Export | undefined;
48
41
  }
49
42
  namespace Info {
50
43
  /**
51
- * Import process details
44
+ * Import process details with URLs to CSV reports
52
45
  */
53
46
  interface Import {
54
- /** Number of invalid email addresses */
55
- invalid_emails?: (number | null) | undefined;
56
- /** Number of duplicate contact IDs */
57
- duplicate_contact_id?: (number | null) | undefined;
58
- /** Number of duplicate external IDs */
59
- duplicate_ext_id?: (number | null) | undefined;
60
- /** Number of duplicate email IDs */
61
- duplicate_email_id?: (number | null) | undefined;
62
- /** Number of duplicate phone numbers */
63
- duplicate_phone_id?: (number | null) | undefined;
64
- /** Number of duplicate WhatsApp numbers */
65
- duplicate_whatsapp_id?: (number | null) | undefined;
66
- /** Number of duplicate landline numbers */
67
- duplicate_landline_number_id?: (number | null) | undefined;
68
- }
69
- /**
70
- * Export process details
71
- */
72
- interface Export {
73
- /** Total number of exported records */
74
- total_records?: number | undefined;
75
- /** Size of exported file in bytes */
76
- file_size?: number | undefined;
47
+ /** URL to CSV file containing invalid email addresses, or null if none */
48
+ invalid_emails?: (string | null) | undefined;
49
+ /** URL to CSV file containing duplicate contact IDs, or null if none */
50
+ duplicate_contact_id?: (string | null) | undefined;
51
+ /** URL to CSV file containing duplicate external IDs, or null if none */
52
+ duplicate_ext_id?: (string | null) | undefined;
53
+ /** URL to CSV file containing duplicate email IDs, or null if none */
54
+ duplicate_email_id?: (string | null) | undefined;
55
+ /** URL to CSV file containing duplicate phone numbers, or null if none */
56
+ duplicate_phone_id?: (string | null) | undefined;
57
+ /** URL to CSV file containing duplicate WhatsApp numbers, or null if none */
58
+ duplicate_whatsapp_id?: (string | null) | undefined;
59
+ /** URL to CSV file containing duplicate landline numbers, or null if none */
60
+ duplicate_landline_number_id?: (string | null) | undefined;
77
61
  }
78
62
  }
79
63
  }
@@ -17,6 +17,7 @@ var GetProcessResponse;
17
17
  /** Current status of the process */
18
18
  GetProcessResponse.Status = {
19
19
  Queued: "queued",
20
+ InProcess: "in_process",
20
21
  Processing: "processing",
21
22
  Completed: "completed",
22
23
  Failed: "failed",
@@ -14,16 +14,10 @@ export declare namespace GetProcessesResponse {
14
14
  name: Item.Name;
15
15
  /** Current status of the process */
16
16
  status: Item.Status;
17
- /** Additional process information (for completed processes) */
18
- info?: (Item.Info | null) | undefined;
19
- /** Download URL for completed export processes */
20
- export_url?: (string | null) | undefined;
21
- /** Error message for failed processes */
22
- error?: (string | null) | undefined;
23
- /** Process creation timestamp */
24
- created_at?: (string | null) | undefined;
25
- /** Process completion timestamp */
26
- completed_at?: (string | null) | undefined;
17
+ /** Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records. */
18
+ info?: Item.Info | undefined;
19
+ /** Download URL for completed export processes (returned for SEARCH_EXPORT_USERS, SEARCH_EXPORT_USERS_API, CAMPAIGN_USER_DETAILS, and EXPORT_WEBHOOK process types) */
20
+ export_url?: string | undefined;
27
21
  }
28
22
  namespace Item {
29
23
  /** Name/type of the process */
@@ -40,6 +34,7 @@ export declare namespace GetProcessesResponse {
40
34
  /** Current status of the process */
41
35
  const Status: {
42
36
  readonly Queued: "queued";
37
+ readonly InProcess: "in_process";
43
38
  readonly Processing: "processing";
44
39
  readonly Completed: "completed";
45
40
  readonly Failed: "failed";
@@ -47,42 +42,31 @@ export declare namespace GetProcessesResponse {
47
42
  };
48
43
  type Status = (typeof Status)[keyof typeof Status];
49
44
  /**
50
- * Additional process information (for completed processes)
45
+ * Additional process information, only returned for completed IMPORTUSER processes. Contains URLs to CSV files with details about problematic records.
51
46
  */
52
47
  interface Info {
53
- /** Import process details */
48
+ /** Import process details with URLs to CSV reports */
54
49
  import?: Info.Import | undefined;
55
- /** Export process details */
56
- export?: Info.Export | undefined;
57
50
  }
58
51
  namespace Info {
59
52
  /**
60
- * Import process details
53
+ * Import process details with URLs to CSV reports
61
54
  */
62
55
  interface Import {
63
- /** Number of invalid email addresses */
64
- invalid_emails?: (number | null) | undefined;
65
- /** Number of duplicate contact IDs */
66
- duplicate_contact_id?: (number | null) | undefined;
67
- /** Number of duplicate external IDs */
68
- duplicate_ext_id?: (number | null) | undefined;
69
- /** Number of duplicate email IDs */
70
- duplicate_email_id?: (number | null) | undefined;
71
- /** Number of duplicate phone numbers */
72
- duplicate_phone_id?: (number | null) | undefined;
73
- /** Number of duplicate WhatsApp numbers */
74
- duplicate_whatsapp_id?: (number | null) | undefined;
75
- /** Number of duplicate landline numbers */
76
- duplicate_landline_number_id?: (number | null) | undefined;
77
- }
78
- /**
79
- * Export process details
80
- */
81
- interface Export {
82
- /** Total number of exported records */
83
- total_records?: number | undefined;
84
- /** Size of exported file in bytes */
85
- file_size?: number | undefined;
56
+ /** URL to CSV file containing invalid email addresses, or null if none */
57
+ invalid_emails?: (string | null) | undefined;
58
+ /** URL to CSV file containing duplicate contact IDs, or null if none */
59
+ duplicate_contact_id?: (string | null) | undefined;
60
+ /** URL to CSV file containing duplicate external IDs, or null if none */
61
+ duplicate_ext_id?: (string | null) | undefined;
62
+ /** URL to CSV file containing duplicate email IDs, or null if none */
63
+ duplicate_email_id?: (string | null) | undefined;
64
+ /** URL to CSV file containing duplicate phone numbers, or null if none */
65
+ duplicate_phone_id?: (string | null) | undefined;
66
+ /** URL to CSV file containing duplicate WhatsApp numbers, or null if none */
67
+ duplicate_whatsapp_id?: (string | null) | undefined;
68
+ /** URL to CSV file containing duplicate landline numbers, or null if none */
69
+ duplicate_landline_number_id?: (string | null) | undefined;
86
70
  }
87
71
  }
88
72
  }
@@ -21,6 +21,7 @@ var GetProcessesResponse;
21
21
  /** Current status of the process */
22
22
  Item.Status = {
23
23
  Queued: "queued",
24
+ InProcess: "in_process",
24
25
  Processing: "processing",
25
26
  Completed: "completed",
26
27
  Failed: "failed",
@@ -243,7 +243,7 @@ export declare class ProgramClient {
243
243
  * @example
244
244
  * await client.program.subscribeToLoyaltyProgram({
245
245
  * pid: "pid",
246
- * contactId: 1
246
+ * contactId: 1000000
247
247
  * })
248
248
  */
249
249
  subscribeToLoyaltyProgram(request: Brevo.SubscribeToLoyaltyProgramRequest, requestOptions?: ProgramClient.RequestOptions): core.HttpResponsePromise<Brevo.SubscribeToLoyaltyProgramResponse>;
@@ -93,7 +93,7 @@ class ProgramClient {
93
93
  limit,
94
94
  offset,
95
95
  sort_field: sortField != null ? sortField : undefined,
96
- sort,
96
+ sort: sort != null ? sort : undefined,
97
97
  };
98
98
  const _authRequest = yield this._options.authProvider.getAuthRequest();
99
99
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -101,7 +101,11 @@ class ProgramClient {
101
101
  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, "loyalty/config/programs"),
102
102
  method: "GET",
103
103
  headers: _headers,
104
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
104
+ queryString: core.url
105
+ .queryBuilder()
106
+ .addMany(_queryParams)
107
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
108
+ .build(),
105
109
  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,
106
110
  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,
107
111
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -166,7 +170,7 @@ class ProgramClient {
166
170
  method: "POST",
167
171
  headers: _headers,
168
172
  contentType: "application/json",
169
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
173
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
170
174
  requestType: "json",
171
175
  body: request,
172
176
  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,
@@ -231,7 +235,7 @@ class ProgramClient {
231
235
  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, `loyalty/config/programs/${core.url.encodePathParam(pid)}`),
232
236
  method: "GET",
233
237
  headers: _headers,
234
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
238
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
235
239
  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,
236
240
  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,
237
241
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -297,7 +301,7 @@ class ProgramClient {
297
301
  method: "PUT",
298
302
  headers: _headers,
299
303
  contentType: "application/json",
300
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
304
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
301
305
  requestType: "json",
302
306
  body: _body,
303
307
  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,
@@ -364,7 +368,7 @@ class ProgramClient {
364
368
  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, `loyalty/config/programs/${core.url.encodePathParam(pid)}`),
365
369
  method: "DELETE",
366
370
  headers: _headers,
367
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
371
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
368
372
  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,
369
373
  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,
370
374
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -429,7 +433,7 @@ class ProgramClient {
429
433
  method: "PATCH",
430
434
  headers: _headers,
431
435
  contentType: "application/json",
432
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
436
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
433
437
  requestType: "json",
434
438
  body: _body,
435
439
  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,
@@ -502,7 +506,11 @@ class ProgramClient {
502
506
  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, `loyalty/config/programs/${core.url.encodePathParam(pid)}/account-info`),
503
507
  method: "GET",
504
508
  headers: _headers,
505
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
509
+ queryString: core.url
510
+ .queryBuilder()
511
+ .addMany(_queryParams)
512
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
513
+ .build(),
506
514
  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,
507
515
  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,
508
516
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -570,7 +578,7 @@ class ProgramClient {
570
578
  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, `loyalty/config/programs/${core.url.encodePathParam(pid)}/contact/${core.url.encodePathParam(cid)}`),
571
579
  method: "DELETE",
572
580
  headers: _headers,
573
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
581
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
574
582
  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,
575
583
  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,
576
584
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -635,7 +643,7 @@ class ProgramClient {
635
643
  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, `loyalty/config/programs/${core.url.encodePathParam(pid)}/publish`),
636
644
  method: "POST",
637
645
  headers: _headers,
638
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
646
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
639
647
  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,
640
648
  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,
641
649
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -701,7 +709,7 @@ class ProgramClient {
701
709
  method: "POST",
702
710
  headers: _headers,
703
711
  contentType: "application/json",
704
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
712
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
705
713
  requestType: "json",
706
714
  body: _body,
707
715
  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,
@@ -776,7 +784,11 @@ class ProgramClient {
776
784
  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, `loyalty/config/programs/${core.url.encodePathParam(pid)}/subscription-members`),
777
785
  method: "DELETE",
778
786
  headers: _headers,
779
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
787
+ queryString: core.url
788
+ .queryBuilder()
789
+ .addMany(_queryParams)
790
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
791
+ .build(),
780
792
  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,
781
793
  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,
782
794
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -827,7 +839,7 @@ class ProgramClient {
827
839
  * @example
828
840
  * await client.program.subscribeToLoyaltyProgram({
829
841
  * pid: "pid",
830
- * contactId: 1
842
+ * contactId: 1000000
831
843
  * })
832
844
  */
833
845
  subscribeToLoyaltyProgram(request, requestOptions) {
@@ -844,7 +856,7 @@ class ProgramClient {
844
856
  method: "POST",
845
857
  headers: _headers,
846
858
  contentType: "application/json",
847
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
859
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
848
860
  requestType: "json",
849
861
  body: _body,
850
862
  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,
@@ -10,6 +10,6 @@ export interface GetLpListRequest {
10
10
  offset?: number;
11
11
  /** Sort documents by field */
12
12
  sort_field?: Brevo.GetLpListRequestSortField;
13
- /** Sort documents by field */
14
- sort?: string;
13
+ /** Sort order */
14
+ sort?: Brevo.GetLpListRequestSort;
15
15
  }
@@ -2,7 +2,7 @@
2
2
  * @example
3
3
  * {
4
4
  * pid: "pid",
5
- * contactId: 1
5
+ * contactId: 1000000
6
6
  * }
7
7
  */
8
8
  export interface SubscribeToLoyaltyProgramRequest {
@@ -10,8 +10,10 @@ export interface SubscribeToLoyaltyProgramRequest {
10
10
  pid: string;
11
11
  /** Required contact ID; must be greater than 0. */
12
12
  contactId: number;
13
- /** Optional custom date-time format. */
14
- creationDate?: string;
15
13
  /** Optional subscription ID (max length 64). */
16
14
  loyaltySubscriptionId?: string;
15
+ /** Optional creation date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.ffffff+HH:MM). Must be in the past. */
16
+ creationDate?: string;
17
+ /** Optional metadata associated with the subscription. */
18
+ meta?: Record<string, unknown>;
17
19
  }
@@ -0,0 +1,5 @@
1
+ export declare const GetLpListRequestSort: {
2
+ readonly Asc: "asc";
3
+ readonly Desc: "desc";
4
+ };
5
+ export type GetLpListRequestSort = (typeof GetLpListRequestSort)[keyof typeof GetLpListRequestSort];