@getbrevo/brevo 5.0.4 → 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 (495) 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 +37 -0
  40. package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
  41. package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
  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 +4 -2
  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 +30 -1
  76. package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
  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 +3 -3
  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 +19 -36
  126. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
  127. package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
  128. package/dist/cjs/api/resources/program/client/Client.js +26 -14
  129. package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
  130. package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
  131. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
  132. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
  133. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
  134. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
  135. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
  136. package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
  137. package/dist/cjs/api/resources/program/types/index.js +1 -0
  138. package/dist/cjs/api/resources/reward/client/Client.js +26 -10
  139. package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
  140. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
  141. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
  142. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
  143. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
  144. package/dist/cjs/api/resources/senders/client/Client.js +11 -7
  145. package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
  146. package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
  147. package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
  148. package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
  149. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
  150. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
  151. package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
  152. package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
  153. package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
  154. package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
  155. package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
  156. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
  157. package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
  158. package/dist/cjs/api/resources/tasks/types/index.js +1 -1
  159. package/dist/cjs/api/resources/tier/client/Client.js +22 -10
  160. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
  161. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
  162. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
  163. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
  164. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
  165. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
  166. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
  167. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
  168. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
  169. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
  170. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
  171. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
  172. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
  173. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
  174. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
  175. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
  176. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
  177. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
  178. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
  179. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
  180. package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
  181. package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
  182. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
  183. package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
  184. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
  185. package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
  186. package/dist/cjs/api/resources/user/client/Client.js +14 -6
  187. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
  188. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
  189. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
  190. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
  191. package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
  192. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
  193. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
  194. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
  195. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
  196. package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
  197. package/dist/cjs/api/types/BalanceDefinition.js +46 -2
  198. package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
  199. package/dist/cjs/api/types/BalanceLimit.js +22 -0
  200. package/dist/cjs/api/types/Company.d.ts +1 -1
  201. package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
  202. package/dist/cjs/api/types/Deal.d.ts +4 -4
  203. package/dist/cjs/api/types/FileData.d.ts +8 -6
  204. package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
  205. package/dist/cjs/api/types/GetCampaignStats.d.ts +4 -4
  206. package/dist/cjs/api/types/GetContactDetails.d.ts +2 -0
  207. package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
  208. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
  209. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
  210. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
  211. package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
  212. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
  213. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
  214. package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
  215. package/dist/cjs/api/types/GetWebhook.js +2 -6
  216. package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
  217. package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
  218. package/dist/cjs/api/types/Note.d.ts +10 -8
  219. package/dist/cjs/api/types/NoteData.d.ts +1 -1
  220. package/dist/cjs/api/types/Order.d.ts +1 -1
  221. package/dist/cjs/api/types/Pipeline.d.ts +3 -3
  222. package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
  223. package/dist/cjs/api/types/Task.d.ts +20 -8
  224. package/dist/cjs/api/types/TierGroup.d.ts +66 -0
  225. package/dist/cjs/api/types/TierGroup.js +30 -0
  226. package/dist/cjs/api/types/Transaction.d.ts +36 -17
  227. package/dist/cjs/api/types/Transaction.js +17 -0
  228. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  229. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  230. package/dist/cjs/core/auth/index.d.ts +1 -1
  231. package/dist/cjs/core/auth/index.js +3 -1
  232. package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
  233. package/dist/cjs/core/fetcher/Fetcher.js +9 -8
  234. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  235. package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
  236. package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
  237. package/dist/cjs/core/url/index.d.ts +1 -0
  238. package/dist/cjs/core/url/index.js +3 -1
  239. package/dist/cjs/core/url/qs.d.ts +2 -1
  240. package/dist/cjs/core/url/qs.js +24 -12
  241. package/dist/cjs/version.d.ts +1 -1
  242. package/dist/cjs/version.js +1 -1
  243. package/dist/esm/BaseClient.d.mts +3 -0
  244. package/dist/esm/BaseClient.mjs +17 -2
  245. package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
  246. package/dist/esm/api/resources/account/client/Client.mjs +21 -13
  247. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
  248. package/dist/esm/api/resources/balance/client/Client.d.mts +8 -7
  249. package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
  250. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
  251. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
  252. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
  253. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
  254. package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
  255. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
  256. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
  257. package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
  258. package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
  259. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
  260. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
  261. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
  262. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
  263. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
  264. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
  265. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
  266. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
  267. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
  268. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
  269. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
  270. package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
  271. package/dist/esm/api/resources/balance/types/index.mjs +4 -0
  272. package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
  273. package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
  274. package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
  275. package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
  276. package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
  277. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
  278. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
  279. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
  280. package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
  281. package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
  282. package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
  283. package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
  284. package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
  285. package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
  286. package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
  287. package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
  288. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
  289. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +4 -2
  290. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
  291. package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
  292. package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
  293. package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
  294. package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
  295. package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
  296. package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
  297. package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
  298. package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
  299. package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
  300. package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
  301. package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
  302. package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
  303. package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
  304. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
  305. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
  306. package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
  307. package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
  308. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
  309. package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
  310. package/dist/esm/api/resources/deals/client/Client.mjs +59 -22
  311. package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +5 -3
  312. package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
  313. package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
  314. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
  315. package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
  316. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
  317. package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
  318. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
  319. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
  320. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
  321. package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
  322. package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
  323. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  324. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
  325. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
  326. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
  327. package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
  328. package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
  329. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
  330. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
  331. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
  332. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
  333. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
  334. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
  335. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
  336. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
  337. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
  338. package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
  339. package/dist/esm/api/resources/event/client/Client.mjs +14 -8
  340. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
  341. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
  342. package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
  343. package/dist/esm/api/resources/event/index.d.mts +0 -1
  344. package/dist/esm/api/resources/event/index.mjs +0 -1
  345. package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
  346. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
  347. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
  348. package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
  349. package/dist/esm/api/resources/files/client/Client.mjs +19 -5
  350. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
  351. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
  352. package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
  353. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
  354. package/dist/esm/api/resources/index.d.mts +0 -1
  355. package/dist/esm/api/resources/index.mjs +0 -1
  356. package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
  357. package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
  358. package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
  359. package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
  360. package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
  361. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  362. package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
  363. package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
  364. package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
  365. package/dist/esm/api/resources/process/client/Client.mjs +19 -20
  366. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
  367. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
  368. package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
  369. package/dist/esm/api/resources/program/client/Client.mjs +26 -14
  370. package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
  371. package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
  372. package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
  373. package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
  374. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
  375. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
  376. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
  377. package/dist/esm/api/resources/program/types/index.d.mts +1 -0
  378. package/dist/esm/api/resources/program/types/index.mjs +1 -0
  379. package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
  380. package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
  381. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
  382. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
  383. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
  384. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
  385. package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
  386. package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
  387. package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
  388. package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
  389. package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
  390. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
  391. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
  392. package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
  393. package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
  394. package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
  395. package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
  396. package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
  397. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
  398. package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
  399. package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
  400. package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
  401. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
  402. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
  403. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
  404. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
  405. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
  406. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
  407. package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
  408. package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
  409. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
  410. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
  411. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
  412. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
  413. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
  414. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
  415. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
  416. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
  417. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
  418. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
  419. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
  420. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
  421. package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
  422. package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
  423. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
  424. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
  425. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
  426. package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
  427. package/dist/esm/api/resources/user/client/Client.mjs +14 -6
  428. package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
  429. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
  430. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
  431. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
  432. package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
  433. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
  434. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
  435. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
  436. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
  437. package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
  438. package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
  439. package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
  440. package/dist/esm/api/types/BalanceLimit.mjs +21 -1
  441. package/dist/esm/api/types/Company.d.mts +1 -1
  442. package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
  443. package/dist/esm/api/types/Deal.d.mts +4 -4
  444. package/dist/esm/api/types/FileData.d.mts +8 -6
  445. package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
  446. package/dist/esm/api/types/GetCampaignStats.d.mts +4 -4
  447. package/dist/esm/api/types/GetContactDetails.d.mts +2 -0
  448. package/dist/esm/api/types/GetEventsList.d.mts +0 -2
  449. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
  450. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
  451. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
  452. package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
  453. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
  454. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
  455. package/dist/esm/api/types/GetWebhook.d.mts +5 -10
  456. package/dist/esm/api/types/GetWebhook.mjs +2 -6
  457. package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
  458. package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
  459. package/dist/esm/api/types/Note.d.mts +10 -8
  460. package/dist/esm/api/types/NoteData.d.mts +1 -1
  461. package/dist/esm/api/types/Order.d.mts +1 -1
  462. package/dist/esm/api/types/Pipeline.d.mts +3 -3
  463. package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
  464. package/dist/esm/api/types/Task.d.mts +20 -8
  465. package/dist/esm/api/types/TierGroup.d.mts +66 -0
  466. package/dist/esm/api/types/TierGroup.mjs +30 -0
  467. package/dist/esm/api/types/Transaction.d.mts +36 -17
  468. package/dist/esm/api/types/Transaction.mjs +16 -1
  469. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  470. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  471. package/dist/esm/core/auth/index.d.mts +1 -1
  472. package/dist/esm/core/auth/index.mjs +1 -0
  473. package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
  474. package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
  475. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  476. package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
  477. package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
  478. package/dist/esm/core/url/index.d.mts +1 -0
  479. package/dist/esm/core/url/index.mjs +1 -0
  480. package/dist/esm/core/url/qs.d.mts +2 -1
  481. package/dist/esm/core/url/qs.mjs +24 -12
  482. package/dist/esm/version.d.mts +1 -1
  483. package/dist/esm/version.mjs +1 -1
  484. package/package.json +2 -2
  485. package/reference.md +1825 -96
  486. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
  487. package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
  488. package/dist/cjs/api/resources/event/types/index.js +0 -17
  489. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
  490. package/dist/esm/api/resources/event/types/index.d.mts +0 -1
  491. package/dist/esm/api/resources/event/types/index.mjs +0 -1
  492. /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
  493. /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → event/client/requests/CreateBatchEventsRequest.js} +0 -0
  494. /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
  495. /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → event/client/requests/CreateBatchEventsRequest.mjs} +0 -0
@@ -67,6 +67,8 @@ class ContactsClient {
67
67
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
68
68
  }
69
69
  /**
70
+ * Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.
71
+ *
70
72
  * @param {Brevo.GetContactsRequest} request
71
73
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
72
74
  *
@@ -82,13 +84,14 @@ class ContactsClient {
82
84
  __getContacts() {
83
85
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
84
86
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
85
- const { limit, offset, modifiedSince, createdSince, sort, segmentId, listIds, filter } = request;
87
+ const { limit, offset, modifiedSince, createdSince, sort, ids, segmentId, listIds, filter } = request;
86
88
  const _queryParams = {
87
89
  limit,
88
90
  offset,
89
91
  modifiedSince,
90
92
  createdSince,
91
93
  sort: sort != null ? sort : undefined,
94
+ ids,
92
95
  segmentId,
93
96
  listIds,
94
97
  filter,
@@ -99,7 +102,11 @@ class ContactsClient {
99
102
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts"),
100
103
  method: "GET",
101
104
  headers: _headers,
102
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
105
+ queryString: core.url
106
+ .queryBuilder()
107
+ .addMany(_queryParams)
108
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
109
+ .build(),
103
110
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
104
111
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
105
112
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -153,7 +160,7 @@ class ContactsClient {
153
160
  method: "POST",
154
161
  headers: _headers,
155
162
  contentType: "application/json",
156
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
163
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
157
164
  requestType: "json",
158
165
  body: request,
159
166
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -186,8 +193,12 @@ class ContactsClient {
186
193
  });
187
194
  }
188
195
  /**
196
+ * Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.
197
+ *
189
198
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
190
199
  *
200
+ * @throws {@link Brevo.BadRequestError}
201
+ *
191
202
  * @example
192
203
  * await client.contacts.getAttributes()
193
204
  */
@@ -203,7 +214,7 @@ class ContactsClient {
203
214
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts/attributes"),
204
215
  method: "GET",
205
216
  headers: _headers,
206
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
217
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
207
218
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
208
219
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
209
220
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -214,16 +225,23 @@ class ContactsClient {
214
225
  return { data: _response.body, rawResponse: _response.rawResponse };
215
226
  }
216
227
  if (_response.error.reason === "status-code") {
217
- throw new errors.BrevoError({
218
- statusCode: _response.error.statusCode,
219
- body: _response.error.body,
220
- rawResponse: _response.rawResponse,
221
- });
228
+ switch (_response.error.statusCode) {
229
+ case 400:
230
+ throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
231
+ default:
232
+ throw new errors.BrevoError({
233
+ statusCode: _response.error.statusCode,
234
+ body: _response.error.body,
235
+ rawResponse: _response.rawResponse,
236
+ });
237
+ }
222
238
  }
223
239
  return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/contacts/attributes");
224
240
  });
225
241
  }
226
242
  /**
243
+ * Create a new contact attribute under the specified category and name. The required body properties depend on the category: use "type" for normal, transactional, or category attributes; use "value" for calculated or global attributes; use "enumeration" for category attributes; and use "multiCategoryOptions" for normal multiple-choice attributes. None of the category or multicategory option values can exceed 200 characters.
244
+ *
227
245
  * @param {Brevo.CreateAttributeRequest} request
228
246
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
229
247
  *
@@ -249,7 +267,7 @@ class ContactsClient {
249
267
  method: "POST",
250
268
  headers: _headers,
251
269
  contentType: "application/json",
252
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
270
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
253
271
  requestType: "json",
254
272
  body: _body,
255
273
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -277,6 +295,8 @@ class ContactsClient {
277
295
  });
278
296
  }
279
297
  /**
298
+ * Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options. None of the category or multicategory option values can exceed 200 characters.
299
+ *
280
300
  * @param {Brevo.UpdateAttributeRequest} request
281
301
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
282
302
  *
@@ -303,7 +323,7 @@ class ContactsClient {
303
323
  method: "PUT",
304
324
  headers: _headers,
305
325
  contentType: "application/json",
306
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
326
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
307
327
  requestType: "json",
308
328
  body: _body,
309
329
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -333,6 +353,8 @@ class ContactsClient {
333
353
  });
334
354
  }
335
355
  /**
356
+ * Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.
357
+ *
336
358
  * @param {Brevo.DeleteAttributeRequest} request
337
359
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
338
360
  *
@@ -358,7 +380,7 @@ class ContactsClient {
358
380
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/attributes/${core.url.encodePathParam(attributeCategory)}/${core.url.encodePathParam(attributeName)}`),
359
381
  method: "DELETE",
360
382
  headers: _headers,
361
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
383
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
362
384
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
363
385
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
364
386
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -386,6 +408,8 @@ class ContactsClient {
386
408
  });
387
409
  }
388
410
  /**
411
+ * Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.
412
+ *
389
413
  * @param {Brevo.DeleteMultiAttributeOptionsRequest} request
390
414
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
391
415
  *
@@ -412,7 +436,7 @@ class ContactsClient {
412
436
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/attributes/${core.url.encodePathParam(attributeType)}/${core.url.encodePathParam(multipleChoiceAttribute)}/${core.url.encodePathParam(multipleChoiceAttributeOption)}`),
413
437
  method: "DELETE",
414
438
  headers: _headers,
415
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
439
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
416
440
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
417
441
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
418
442
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -440,6 +464,8 @@ class ContactsClient {
440
464
  });
441
465
  }
442
466
  /**
467
+ * Update multiple contacts in a single API call by passing an array of contact objects. Each contact in the array must be identified by one of: email, id, or sms (only one identifier per contact). You can update attributes, blacklist status, list memberships, ext_id, and transactional email forbidden senders for each contact in the batch.
468
+ *
443
469
  * @param {Brevo.UpdateBatchContactsRequest} request
444
470
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
445
471
  *
@@ -461,7 +487,7 @@ class ContactsClient {
461
487
  method: "POST",
462
488
  headers: _headers,
463
489
  contentType: "application/json",
464
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
490
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
465
491
  requestType: "json",
466
492
  body: request,
467
493
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -517,7 +543,7 @@ class ContactsClient {
517
543
  method: "POST",
518
544
  headers: _headers,
519
545
  contentType: "application/json",
520
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
546
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
521
547
  requestType: "json",
522
548
  body: request,
523
549
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -571,7 +597,7 @@ class ContactsClient {
571
597
  method: "POST",
572
598
  headers: _headers,
573
599
  contentType: "application/json",
574
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
600
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
575
601
  requestType: "json",
576
602
  body: request,
577
603
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -633,7 +659,11 @@ class ContactsClient {
633
659
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts/folders"),
634
660
  method: "GET",
635
661
  headers: _headers,
636
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
662
+ queryString: core.url
663
+ .queryBuilder()
664
+ .addMany(_queryParams)
665
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
666
+ .build(),
637
667
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
638
668
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
639
669
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -659,6 +689,8 @@ class ContactsClient {
659
689
  });
660
690
  }
661
691
  /**
692
+ * Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.
693
+ *
662
694
  * @param {Brevo.CreateUpdateFolder} request
663
695
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
664
696
  *
@@ -680,7 +712,7 @@ class ContactsClient {
680
712
  method: "POST",
681
713
  headers: _headers,
682
714
  contentType: "application/json",
683
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
715
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
684
716
  requestType: "json",
685
717
  body: request,
686
718
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -736,7 +768,7 @@ class ContactsClient {
736
768
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/folders/${core.url.encodePathParam(folderId)}`),
737
769
  method: "GET",
738
770
  headers: _headers,
739
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
771
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
740
772
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
741
773
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
742
774
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -764,6 +796,8 @@ class ContactsClient {
764
796
  });
765
797
  }
766
798
  /**
799
+ * Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.
800
+ *
767
801
  * @param {Brevo.UpdateFolderRequest} request
768
802
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
769
803
  *
@@ -790,7 +824,7 @@ class ContactsClient {
790
824
  method: "PUT",
791
825
  headers: _headers,
792
826
  contentType: "application/json",
793
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
827
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
794
828
  requestType: "json",
795
829
  body: _body,
796
830
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -820,6 +854,8 @@ class ContactsClient {
820
854
  });
821
855
  }
822
856
  /**
857
+ * Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.
858
+ *
823
859
  * @param {Brevo.DeleteFolderRequest} request
824
860
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
825
861
  *
@@ -844,7 +880,7 @@ class ContactsClient {
844
880
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/folders/${core.url.encodePathParam(folderId)}`),
845
881
  method: "DELETE",
846
882
  headers: _headers,
847
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
883
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
848
884
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
849
885
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
850
886
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -905,7 +941,11 @@ class ContactsClient {
905
941
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/folders/${core.url.encodePathParam(folderId)}/lists`),
906
942
  method: "GET",
907
943
  headers: _headers,
908
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
944
+ queryString: core.url
945
+ .queryBuilder()
946
+ .addMany(_queryParams)
947
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
948
+ .build(),
909
949
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
910
950
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
911
951
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -956,7 +996,7 @@ class ContactsClient {
956
996
  method: "POST",
957
997
  headers: _headers,
958
998
  contentType: "application/json",
959
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
999
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
960
1000
  requestType: "json",
961
1001
  body: request,
962
1002
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1014,7 +1054,11 @@ class ContactsClient {
1014
1054
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts/lists"),
1015
1055
  method: "GET",
1016
1056
  headers: _headers,
1017
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1057
+ queryString: core.url
1058
+ .queryBuilder()
1059
+ .addMany(_queryParams)
1060
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1061
+ .build(),
1018
1062
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1019
1063
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1020
1064
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1040,6 +1084,8 @@ class ContactsClient {
1040
1084
  });
1041
1085
  }
1042
1086
  /**
1087
+ * Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.
1088
+ *
1043
1089
  * @param {Brevo.CreateListRequest} request
1044
1090
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1045
1091
  *
@@ -1064,7 +1110,7 @@ class ContactsClient {
1064
1110
  method: "POST",
1065
1111
  headers: _headers,
1066
1112
  contentType: "application/json",
1067
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1113
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1068
1114
  requestType: "json",
1069
1115
  body: request,
1070
1116
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1092,6 +1138,8 @@ class ContactsClient {
1092
1138
  });
1093
1139
  }
1094
1140
  /**
1141
+ * Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).
1142
+ *
1095
1143
  * @param {Brevo.GetListRequest} request
1096
1144
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1097
1145
  *
@@ -1120,7 +1168,11 @@ class ContactsClient {
1120
1168
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/lists/${core.url.encodePathParam(listId)}`),
1121
1169
  method: "GET",
1122
1170
  headers: _headers,
1123
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1171
+ queryString: core.url
1172
+ .queryBuilder()
1173
+ .addMany(_queryParams)
1174
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1175
+ .build(),
1124
1176
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1125
1177
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1126
1178
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1148,6 +1200,8 @@ class ContactsClient {
1148
1200
  });
1149
1201
  }
1150
1202
  /**
1203
+ * Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.
1204
+ *
1151
1205
  * @param {Brevo.UpdateListRequest} request
1152
1206
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1153
1207
  *
@@ -1173,7 +1227,7 @@ class ContactsClient {
1173
1227
  method: "PUT",
1174
1228
  headers: _headers,
1175
1229
  contentType: "application/json",
1176
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1230
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1177
1231
  requestType: "json",
1178
1232
  body: _body,
1179
1233
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1203,6 +1257,8 @@ class ContactsClient {
1203
1257
  });
1204
1258
  }
1205
1259
  /**
1260
+ * Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.
1261
+ *
1206
1262
  * @param {Brevo.DeleteListRequest} request
1207
1263
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1208
1264
  *
@@ -1227,7 +1283,7 @@ class ContactsClient {
1227
1283
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/lists/${core.url.encodePathParam(listId)}`),
1228
1284
  method: "DELETE",
1229
1285
  headers: _headers,
1230
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1286
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1231
1287
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1232
1288
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1233
1289
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1255,11 +1311,14 @@ class ContactsClient {
1255
1311
  });
1256
1312
  }
1257
1313
  /**
1314
+ * Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.
1315
+ *
1258
1316
  * @param {Brevo.GetContactsFromListRequest} request
1259
1317
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1260
1318
  *
1261
1319
  * @throws {@link Brevo.BadRequestError}
1262
1320
  * @throws {@link Brevo.NotFoundError}
1321
+ * @throws {@link Brevo.TooManyRequestsError}
1263
1322
  *
1264
1323
  * @example
1265
1324
  * await client.contacts.getContactsFromList({
@@ -1285,7 +1344,11 @@ class ContactsClient {
1285
1344
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/lists/${core.url.encodePathParam(listId)}/contacts`),
1286
1345
  method: "GET",
1287
1346
  headers: _headers,
1288
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1347
+ queryString: core.url
1348
+ .queryBuilder()
1349
+ .addMany(_queryParams)
1350
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1351
+ .build(),
1289
1352
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1290
1353
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1291
1354
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1301,6 +1364,8 @@ class ContactsClient {
1301
1364
  throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
1302
1365
  case 404:
1303
1366
  throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
1367
+ case 429:
1368
+ throw new Brevo.TooManyRequestsError(_response.error.body, _response.rawResponse);
1304
1369
  default:
1305
1370
  throw new errors.BrevoError({
1306
1371
  statusCode: _response.error.statusCode,
@@ -1357,7 +1422,7 @@ class ContactsClient {
1357
1422
  method: "POST",
1358
1423
  headers: _headers,
1359
1424
  contentType: "application/json",
1360
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1425
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1361
1426
  requestType: "json",
1362
1427
  body: _body,
1363
1428
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1439,7 +1504,7 @@ class ContactsClient {
1439
1504
  method: "POST",
1440
1505
  headers: _headers,
1441
1506
  contentType: "application/json",
1442
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1507
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1443
1508
  requestType: "json",
1444
1509
  body: _body,
1445
1510
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1469,6 +1534,8 @@ class ContactsClient {
1469
1534
  });
1470
1535
  }
1471
1536
  /**
1537
+ * Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.
1538
+ *
1472
1539
  * @param {Brevo.GetSegmentsRequest} request
1473
1540
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1474
1541
  *
@@ -1495,7 +1562,11 @@ class ContactsClient {
1495
1562
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts/segments"),
1496
1563
  method: "GET",
1497
1564
  headers: _headers,
1498
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1565
+ queryString: core.url
1566
+ .queryBuilder()
1567
+ .addMany(_queryParams)
1568
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1569
+ .build(),
1499
1570
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1500
1571
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1501
1572
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1554,7 +1625,11 @@ class ContactsClient {
1554
1625
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/${core.url.encodePathParam(identifier)}`),
1555
1626
  method: "GET",
1556
1627
  headers: _headers,
1557
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1628
+ queryString: core.url
1629
+ .queryBuilder()
1630
+ .addMany(_queryParams)
1631
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1632
+ .build(),
1558
1633
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1559
1634
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1560
1635
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1615,7 +1690,11 @@ class ContactsClient {
1615
1690
  method: "PUT",
1616
1691
  headers: _headers,
1617
1692
  contentType: "application/json",
1618
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1693
+ queryString: core.url
1694
+ .queryBuilder()
1695
+ .addMany(_queryParams)
1696
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1697
+ .build(),
1619
1698
  requestType: "json",
1620
1699
  body: _body,
1621
1700
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -1677,7 +1756,11 @@ class ContactsClient {
1677
1756
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/${core.url.encodePathParam(identifier)}`),
1678
1757
  method: "DELETE",
1679
1758
  headers: _headers,
1680
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1759
+ queryString: core.url
1760
+ .queryBuilder()
1761
+ .addMany(_queryParams)
1762
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1763
+ .build(),
1681
1764
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1682
1765
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1683
1766
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1707,6 +1790,8 @@ class ContactsClient {
1707
1790
  });
1708
1791
  }
1709
1792
  /**
1793
+ * Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes. By default, data covers the last 90 days; use startDate and endDate parameters (YYYY-MM-DD) to specify a custom range with a maximum span of 90 days.
1794
+ *
1710
1795
  * @param {Brevo.GetContactStatsRequest} request
1711
1796
  * @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
1712
1797
  *
@@ -1735,7 +1820,11 @@ class ContactsClient {
1735
1820
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/${core.url.encodePathParam(identifier)}/campaignStats`),
1736
1821
  method: "GET",
1737
1822
  headers: _headers,
1738
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1823
+ queryString: core.url
1824
+ .queryBuilder()
1825
+ .addMany(_queryParams)
1826
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
1827
+ .build(),
1739
1828
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
1740
1829
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
1741
1830
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -19,6 +19,10 @@ export interface CreateContactRequest {
19
19
  smtpBlacklistSender?: string[];
20
20
  /** Facilitate to update the existing contact in the same request (updateEnabled = true) */
21
21
  updateEnabled?: boolean;
22
+ /** When true, if the contact being created shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. */
23
+ forceMerge?: boolean;
24
+ /** When true, the response returns the `id` of the surviving contact after merge. */
25
+ getId?: boolean;
22
26
  }
23
27
  export declare namespace CreateContactRequest {
24
28
  namespace Attributes {
@@ -10,8 +10,8 @@ export interface GetContactInfoRequest {
10
10
  identifier: Brevo.GetContactInfoRequestIdentifier;
11
11
  /** email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute */
12
12
  identifierType?: Brevo.GetContactInfoRequestIdentifierType;
13
- /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate */
13
+ /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. */
14
14
  startDate?: string;
15
- /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. */
15
+ /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. */
16
16
  endDate?: string;
17
17
  }
@@ -8,8 +8,8 @@ import type * as Brevo from "../../../../index.js";
8
8
  export interface GetContactStatsRequest {
9
9
  /** Email (urlencoded) OR ID of the contact */
10
10
  identifier: Brevo.GetContactStatsRequestIdentifier;
11
- /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate */
11
+ /** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. */
12
12
  startDate?: string;
13
- /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days */
13
+ /** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days. */
14
14
  endDate?: string;
15
15
  }
@@ -14,7 +14,9 @@ export interface GetContactsRequest {
14
14
  createdSince?: string;
15
15
  /** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed */
16
16
  sort?: Brevo.GetContactsRequestSort;
17
- /** Id of the segment. **Either listIds or segmentId can be passed.** */
17
+ /** Filter by a list of contact IDs. You can pass a **maximum of 20 IDs**. All elements must be integers. */
18
+ ids?: number | number[];
19
+ /** Id of the segment. **Either listIds or segmentId can be passed.** Must be a positive integer (minimum value of 1). */
18
20
  segmentId?: number;
19
21
  /** Ids of the list. **Either listIds or segmentId can be passed.** */
20
22
  listIds?: number | number[];
@@ -7,7 +7,7 @@
7
7
  export interface GetListRequest {
8
8
  /** Id of the list */
9
9
  listId: number;
10
- /** **Mandatory if endDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
10
+ /** **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
11
11
  startDate?: string;
12
12
  /** **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
13
13
  endDate?: string;
@@ -6,9 +6,9 @@ import type * as Brevo from "../../../../index.js";
6
6
  * }
7
7
  */
8
8
  export interface UpdateContactRequest {
9
- /** Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE attribute value */
9
+ /** Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE_NUMBER attribute value */
10
10
  identifier: Brevo.UpdateContactRequestIdentifier;
11
- /** email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute */
11
+ /** email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute */
12
12
  identifierType?: Brevo.UpdateContactRequestIdentifierType;
13
13
  /** Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, **{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger", "COUNTRIES":["India","China"]}**. The attribute's parameter should be passed in capital letter while updating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored .Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}** */
14
14
  attributes?: Record<string, UpdateContactRequest.Attributes.Value>;
@@ -24,6 +24,8 @@ export interface UpdateContactRequest {
24
24
  smtpBlacklistSender?: string[];
25
25
  /** Ids of the lists to remove the contact from */
26
26
  unlinkListIds?: number[];
27
+ /** When true, if the contact being updated shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. */
28
+ forceMerge?: boolean;
27
29
  }
28
30
  export declare namespace UpdateContactRequest {
29
31
  namespace Attributes {
@@ -34,8 +34,10 @@ export declare namespace GetAttributesResponse {
34
34
  interface Item {
35
35
  /** Label of the "category" type attribute */
36
36
  label: string;
37
- /** ID of Value of the "category" type attribute */
37
+ /** Numeric ID of the "category" type attribute value. Set to 0 when the raw value cannot be converted to an integer (for example non-numeric values such as "en" or "fr"). Refer to `valueStr` for the original string representation. */
38
38
  value: number;
39
+ /** String representation of the "category" type attribute value. Always contains the original value as stored. Use this field when the attribute value is non-numeric (e.g. "en", "fr") or when you need the exact string form alongside the numeric `value`. */
40
+ valueStr: string;
39
41
  }
40
42
  }
41
43
  /** Type of the attribute */