@getbrevo/brevo 5.0.4 → 6.0.2

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 (640) hide show
  1. package/README.md +99 -37
  2. package/dist/cjs/BaseClient.d.ts +13 -0
  3. package/dist/cjs/BaseClient.js +17 -2
  4. package/dist/cjs/Client.d.ts +6 -0
  5. package/dist/cjs/Client.js +68 -58
  6. package/dist/cjs/api/errors/BadRequestError.js +1 -1
  7. package/dist/cjs/api/errors/ConflictError.js +1 -1
  8. package/dist/cjs/api/errors/ExpectationFailedError.js +1 -1
  9. package/dist/cjs/api/errors/FailedDependencyError.js +1 -1
  10. package/dist/cjs/api/errors/ForbiddenError.js +1 -1
  11. package/dist/cjs/api/errors/InternalServerError.js +1 -1
  12. package/dist/cjs/api/errors/MethodNotAllowedError.js +1 -1
  13. package/dist/cjs/api/errors/NotFoundError.js +1 -1
  14. package/dist/cjs/api/errors/PaymentRequiredError.js +1 -1
  15. package/dist/cjs/api/errors/PreconditionFailedError.js +1 -1
  16. package/dist/cjs/api/errors/TooEarlyError.js +1 -1
  17. package/dist/cjs/api/errors/TooManyRequestsError.js +1 -1
  18. package/dist/cjs/api/errors/UnauthorizedError.js +1 -1
  19. package/dist/cjs/api/errors/UnprocessableEntityError.js +1 -1
  20. package/dist/cjs/api/errors/UnsupportedMediaTypeError.js +1 -1
  21. package/dist/cjs/api/resources/account/client/Client.d.ts +5 -6
  22. package/dist/cjs/api/resources/account/client/Client.js +21 -13
  23. package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +4 -17
  24. package/dist/cjs/api/resources/balance/client/Client.d.ts +9 -8
  25. package/dist/cjs/api/resources/balance/client/Client.js +70 -33
  26. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts +21 -11
  27. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js +9 -0
  28. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts +11 -3
  29. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js +9 -0
  30. package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +13 -1
  31. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +7 -6
  32. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +6 -6
  33. package/dist/cjs/api/resources/balance/client/requests/index.d.ts +2 -2
  34. package/dist/cjs/api/resources/balance/client/requests/index.js +5 -1
  35. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts +5 -0
  36. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js +8 -0
  37. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts +5 -0
  38. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js +8 -0
  39. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts +5 -0
  40. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js +8 -0
  41. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts +30 -0
  42. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +10 -0
  43. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js +15 -0
  44. package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +7 -2
  45. package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +14 -14
  46. package/dist/cjs/api/resources/balance/types/index.d.ts +4 -0
  47. package/dist/cjs/api/resources/balance/types/index.js +4 -0
  48. package/dist/cjs/api/resources/companies/client/Client.d.ts +22 -0
  49. package/dist/cjs/api/resources/companies/client/Client.js +49 -18
  50. package/dist/cjs/api/resources/companies/client/requests/GetCompaniesRequest.d.ts +4 -4
  51. package/dist/cjs/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.ts +1 -1
  52. package/dist/cjs/api/resources/companies/client/requests/PostCompaniesImportRequest.d.ts +1 -1
  53. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.d.ts +2 -2
  54. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.js +1 -1
  55. package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +20 -4
  56. package/dist/cjs/api/resources/consentGroups/client/Client.d.ts +108 -0
  57. package/dist/cjs/api/resources/consentGroups/client/Client.js +383 -0
  58. package/dist/cjs/api/resources/consentGroups/client/index.d.ts +1 -0
  59. package/dist/cjs/api/resources/{event/types → consentGroups/client}/index.js +1 -1
  60. package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.ts +25 -0
  61. package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.js +12 -0
  62. package/dist/cjs/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.ts +10 -0
  63. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.ts +10 -0
  64. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.js +3 -0
  65. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.ts +17 -0
  66. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.js +3 -0
  67. package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.ts +24 -0
  68. package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.js +12 -0
  69. package/dist/cjs/api/resources/consentGroups/client/requests/index.d.ts +5 -0
  70. package/dist/cjs/api/resources/consentGroups/client/requests/index.js +7 -0
  71. package/dist/cjs/api/resources/consentGroups/exports.d.ts +2 -0
  72. package/dist/cjs/api/resources/consentGroups/exports.js +21 -0
  73. package/dist/cjs/api/resources/consentGroups/index.d.ts +2 -0
  74. package/dist/cjs/api/resources/consentGroups/index.js +18 -0
  75. package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.ts +5 -0
  76. package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.js +8 -0
  77. package/dist/cjs/api/resources/consentGroups/types/index.d.ts +1 -0
  78. package/dist/cjs/api/resources/consentGroups/types/index.js +17 -0
  79. package/dist/cjs/api/resources/contacts/client/Client.d.ts +37 -0
  80. package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
  81. package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
  82. package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
  83. package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
  84. package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
  85. package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
  86. package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +2 -0
  87. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +4 -2
  88. package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
  89. package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +8 -3
  90. package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +1 -1
  91. package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +2 -2
  92. package/dist/cjs/api/resources/conversations/client/Client.d.ts +18 -8
  93. package/dist/cjs/api/resources/conversations/client/Client.js +28 -18
  94. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.ts +8 -8
  95. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.ts +12 -10
  96. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.ts +11 -9
  97. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.ts +1 -1
  98. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.ts +2 -2
  99. package/dist/cjs/api/resources/coupons/client/Client.d.ts +10 -0
  100. package/dist/cjs/api/resources/coupons/client/Client.js +19 -5
  101. package/dist/cjs/api/resources/customObjects/client/Client.d.ts +101 -21
  102. package/dist/cjs/api/resources/customObjects/client/Client.js +108 -26
  103. package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts +2 -2
  104. package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts +1 -1
  105. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +114 -25
  106. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js +21 -0
  107. package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts +1 -1
  108. package/dist/cjs/api/resources/customObjects/client/requests/index.js +3 -0
  109. package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +14 -5
  110. package/dist/cjs/api/resources/deals/client/Client.d.ts +22 -0
  111. package/dist/cjs/api/resources/deals/client/Client.js +62 -22
  112. package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +11 -3
  113. package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
  114. package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
  115. package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
  116. package/dist/cjs/api/resources/domains/client/Client.js +5 -5
  117. package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +30 -1
  118. package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
  119. package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
  120. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
  121. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
  122. package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
  123. package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
  124. package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +2 -2
  125. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
  126. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +2 -2
  127. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts +7 -0
  128. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js +10 -0
  129. package/dist/cjs/api/resources/ecommerce/types/index.d.ts +1 -0
  130. package/dist/cjs/api/resources/ecommerce/types/index.js +1 -0
  131. package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +22 -1
  132. package/dist/cjs/api/resources/emailCampaigns/client/Client.js +51 -15
  133. package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +7 -7
  134. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +1 -1
  135. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts +6 -4
  136. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +28 -5
  137. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +9 -0
  138. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +27 -4
  139. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +9 -0
  140. package/dist/cjs/api/resources/event/client/Client.d.ts +8 -6
  141. package/dist/cjs/api/resources/event/client/Client.js +14 -8
  142. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.d.ts +76 -0
  143. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.js +3 -0
  144. package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +3 -3
  145. package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
  146. package/dist/cjs/api/resources/event/index.d.ts +0 -1
  147. package/dist/cjs/api/resources/event/index.js +0 -1
  148. package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
  149. package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
  150. package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
  151. package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
  152. package/dist/cjs/api/resources/files/client/Client.js +19 -5
  153. package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
  154. package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
  155. package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
  156. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
  157. package/dist/cjs/api/resources/index.d.ts +5 -1
  158. package/dist/cjs/api/resources/index.js +6 -2
  159. package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
  160. package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
  161. package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
  162. package/dist/cjs/api/resources/notes/client/Client.js +21 -7
  163. package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
  164. package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
  165. package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
  166. package/dist/cjs/api/resources/payments/client/Client.js +9 -3
  167. package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
  168. package/dist/cjs/api/resources/process/client/Client.js +19 -20
  169. package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +19 -36
  170. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
  171. package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
  172. package/dist/cjs/api/resources/program/client/Client.js +26 -14
  173. package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
  174. package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
  175. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
  176. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
  177. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
  178. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
  179. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
  180. package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
  181. package/dist/cjs/api/resources/program/types/index.js +1 -0
  182. package/dist/cjs/api/resources/reward/client/Client.js +26 -10
  183. package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
  184. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
  185. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
  186. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
  187. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
  188. package/dist/cjs/api/resources/senders/client/Client.js +11 -7
  189. package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
  190. package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
  191. package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
  192. package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
  193. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
  194. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
  195. package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
  196. package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
  197. package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
  198. package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
  199. package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
  200. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
  201. package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
  202. package/dist/cjs/api/resources/tasks/types/index.js +1 -1
  203. package/dist/cjs/api/resources/tier/client/Client.js +22 -10
  204. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
  205. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
  206. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
  207. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
  208. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
  209. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
  210. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
  211. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
  212. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
  213. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
  214. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
  215. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
  216. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
  217. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
  218. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
  219. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +1 -1
  220. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
  221. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
  222. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
  223. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
  224. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
  225. package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
  226. package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
  227. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
  228. package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
  229. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
  230. package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
  231. package/dist/cjs/api/resources/user/client/Client.js +14 -6
  232. package/dist/cjs/api/resources/wallet/client/Client.d.ts +34 -0
  233. package/dist/cjs/api/resources/wallet/client/Client.js +126 -0
  234. package/dist/cjs/api/resources/wallet/client/index.d.ts +1 -0
  235. package/dist/cjs/api/resources/wallet/client/index.js +17 -0
  236. package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.ts +13 -0
  237. package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.js +3 -0
  238. package/dist/cjs/api/resources/wallet/client/requests/index.d.ts +1 -0
  239. package/dist/cjs/api/resources/wallet/client/requests/index.js +2 -0
  240. package/dist/cjs/api/resources/wallet/exports.d.ts +2 -0
  241. package/dist/cjs/api/resources/wallet/exports.js +21 -0
  242. package/dist/cjs/api/resources/wallet/index.d.ts +1 -0
  243. package/dist/cjs/api/resources/wallet/index.js +17 -0
  244. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
  245. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
  246. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
  247. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
  248. package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
  249. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
  250. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
  251. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
  252. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
  253. package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
  254. package/dist/cjs/api/types/BalanceDefinition.js +46 -2
  255. package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
  256. package/dist/cjs/api/types/BalanceLimit.js +22 -0
  257. package/dist/cjs/api/types/Company.d.ts +1 -1
  258. package/dist/cjs/api/types/ConsentGroup.d.ts +29 -0
  259. package/dist/cjs/api/types/ConsentGroup.js +12 -0
  260. package/dist/cjs/api/types/ConsentGroupItem.d.ts +17 -0
  261. package/dist/cjs/api/types/ConsentGroupItem.js +12 -0
  262. package/dist/cjs/api/types/ConsentGroupsListResponse.d.ts +14 -0
  263. package/dist/cjs/api/types/ConsentGroupsListResponse.js +3 -0
  264. package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
  265. package/dist/cjs/api/types/Deal.d.ts +4 -4
  266. package/dist/cjs/api/types/FileData.d.ts +8 -6
  267. package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
  268. package/dist/cjs/api/types/GetCampaignStats.d.ts +15 -15
  269. package/dist/cjs/api/types/GetContactDetails.d.ts +5 -0
  270. package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
  271. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
  272. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
  273. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
  274. package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
  275. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
  276. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
  277. package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
  278. package/dist/cjs/api/types/GetWebhook.js +2 -6
  279. package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
  280. package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
  281. package/dist/cjs/api/types/Note.d.ts +10 -8
  282. package/dist/cjs/api/types/NoteData.d.ts +1 -1
  283. package/dist/cjs/api/types/Order.d.ts +1 -1
  284. package/dist/cjs/api/types/Pipeline.d.ts +3 -3
  285. package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
  286. package/dist/cjs/api/types/Task.d.ts +20 -8
  287. package/dist/cjs/api/types/TierGroup.d.ts +66 -0
  288. package/dist/cjs/api/types/TierGroup.js +30 -0
  289. package/dist/cjs/api/types/Transaction.d.ts +36 -17
  290. package/dist/cjs/api/types/Transaction.js +17 -0
  291. package/dist/cjs/api/types/WalletPassInstallUrl.d.ts +4 -0
  292. package/dist/cjs/api/types/WalletPassInstallUrl.js +3 -0
  293. package/dist/cjs/api/types/index.d.ts +4 -0
  294. package/dist/cjs/api/types/index.js +4 -0
  295. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  296. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  297. package/dist/cjs/core/auth/index.d.ts +1 -1
  298. package/dist/cjs/core/auth/index.js +3 -1
  299. package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
  300. package/dist/cjs/core/fetcher/Fetcher.js +9 -8
  301. package/dist/cjs/core/fetcher/getResponseBody.js +11 -0
  302. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  303. package/dist/cjs/core/fetcher/signals.js +9 -1
  304. package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
  305. package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
  306. package/dist/cjs/core/url/index.d.ts +1 -0
  307. package/dist/cjs/core/url/index.js +3 -1
  308. package/dist/cjs/core/url/qs.d.ts +2 -1
  309. package/dist/cjs/core/url/qs.js +25 -13
  310. package/dist/cjs/errors/BrevoError.d.ts +1 -0
  311. package/dist/cjs/errors/BrevoError.js +5 -1
  312. package/dist/cjs/errors/BrevoTimeoutError.d.ts +2 -2
  313. package/dist/cjs/errors/BrevoTimeoutError.js +40 -6
  314. package/dist/cjs/version.d.ts +1 -1
  315. package/dist/cjs/version.js +1 -1
  316. package/dist/esm/BaseClient.d.mts +13 -0
  317. package/dist/esm/BaseClient.mjs +17 -2
  318. package/dist/esm/Client.d.mts +6 -0
  319. package/dist/esm/Client.mjs +10 -0
  320. package/dist/esm/api/errors/BadRequestError.mjs +1 -1
  321. package/dist/esm/api/errors/ConflictError.mjs +1 -1
  322. package/dist/esm/api/errors/ExpectationFailedError.mjs +1 -1
  323. package/dist/esm/api/errors/FailedDependencyError.mjs +1 -1
  324. package/dist/esm/api/errors/ForbiddenError.mjs +1 -1
  325. package/dist/esm/api/errors/InternalServerError.mjs +1 -1
  326. package/dist/esm/api/errors/MethodNotAllowedError.mjs +1 -1
  327. package/dist/esm/api/errors/NotFoundError.mjs +1 -1
  328. package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -1
  329. package/dist/esm/api/errors/PreconditionFailedError.mjs +1 -1
  330. package/dist/esm/api/errors/TooEarlyError.mjs +1 -1
  331. package/dist/esm/api/errors/TooManyRequestsError.mjs +1 -1
  332. package/dist/esm/api/errors/UnauthorizedError.mjs +1 -1
  333. package/dist/esm/api/errors/UnprocessableEntityError.mjs +1 -1
  334. package/dist/esm/api/errors/UnsupportedMediaTypeError.mjs +1 -1
  335. package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
  336. package/dist/esm/api/resources/account/client/Client.mjs +21 -13
  337. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
  338. package/dist/esm/api/resources/balance/client/Client.d.mts +9 -8
  339. package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
  340. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
  341. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
  342. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
  343. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
  344. package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
  345. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
  346. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
  347. package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
  348. package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
  349. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
  350. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
  351. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
  352. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
  353. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
  354. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
  355. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
  356. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
  357. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
  358. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
  359. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
  360. package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
  361. package/dist/esm/api/resources/balance/types/index.mjs +4 -0
  362. package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
  363. package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
  364. package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
  365. package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
  366. package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
  367. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
  368. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
  369. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
  370. package/dist/esm/api/resources/consentGroups/client/Client.d.mts +108 -0
  371. package/dist/esm/api/resources/consentGroups/client/Client.mjs +346 -0
  372. package/dist/esm/api/resources/consentGroups/client/index.d.mts +1 -0
  373. package/dist/esm/api/resources/consentGroups/client/index.mjs +1 -0
  374. package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.mts +25 -0
  375. package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.mjs +9 -0
  376. package/dist/esm/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.mts +10 -0
  377. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.mts +10 -0
  378. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.mjs +2 -0
  379. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.mts +17 -0
  380. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.mjs +2 -0
  381. package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.mts +24 -0
  382. package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.mjs +9 -0
  383. package/dist/esm/api/resources/consentGroups/client/requests/index.d.mts +5 -0
  384. package/dist/esm/api/resources/consentGroups/client/requests/index.mjs +2 -0
  385. package/dist/esm/api/resources/consentGroups/exports.d.mts +2 -0
  386. package/dist/esm/api/resources/consentGroups/exports.mjs +3 -0
  387. package/dist/esm/api/resources/consentGroups/index.d.mts +2 -0
  388. package/dist/esm/api/resources/consentGroups/index.mjs +2 -0
  389. package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.mts +5 -0
  390. package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.mjs +5 -0
  391. package/dist/esm/api/resources/consentGroups/types/index.d.mts +1 -0
  392. package/dist/esm/api/resources/consentGroups/types/index.mjs +1 -0
  393. package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
  394. package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
  395. package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
  396. package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
  397. package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
  398. package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
  399. package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
  400. package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +2 -0
  401. package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
  402. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
  403. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +8 -3
  404. package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +1 -1
  405. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
  406. package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
  407. package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
  408. package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
  409. package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
  410. package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
  411. package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
  412. package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
  413. package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
  414. package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
  415. package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
  416. package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
  417. package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
  418. package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
  419. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
  420. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
  421. package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
  422. package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
  423. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
  424. package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
  425. package/dist/esm/api/resources/deals/client/Client.mjs +62 -22
  426. package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +11 -3
  427. package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
  428. package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
  429. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
  430. package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
  431. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
  432. package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
  433. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
  434. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
  435. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
  436. package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
  437. package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
  438. package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +2 -2
  439. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  440. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
  441. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
  442. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
  443. package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
  444. package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
  445. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
  446. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
  447. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
  448. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
  449. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
  450. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
  451. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
  452. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
  453. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
  454. package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
  455. package/dist/esm/api/resources/event/client/Client.mjs +14 -8
  456. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
  457. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.mjs +2 -0
  458. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
  459. package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
  460. package/dist/esm/api/resources/event/index.d.mts +0 -1
  461. package/dist/esm/api/resources/event/index.mjs +0 -1
  462. package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
  463. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
  464. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
  465. package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
  466. package/dist/esm/api/resources/files/client/Client.mjs +19 -5
  467. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
  468. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
  469. package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
  470. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
  471. package/dist/esm/api/resources/index.d.mts +5 -1
  472. package/dist/esm/api/resources/index.mjs +5 -1
  473. package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
  474. package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
  475. package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
  476. package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
  477. package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
  478. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  479. package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
  480. package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
  481. package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
  482. package/dist/esm/api/resources/process/client/Client.mjs +19 -20
  483. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
  484. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
  485. package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
  486. package/dist/esm/api/resources/program/client/Client.mjs +26 -14
  487. package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
  488. package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
  489. package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
  490. package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
  491. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
  492. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
  493. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
  494. package/dist/esm/api/resources/program/types/index.d.mts +1 -0
  495. package/dist/esm/api/resources/program/types/index.mjs +1 -0
  496. package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
  497. package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
  498. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
  499. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
  500. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
  501. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
  502. package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
  503. package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
  504. package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
  505. package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
  506. package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
  507. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
  508. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
  509. package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
  510. package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
  511. package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
  512. package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
  513. package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
  514. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
  515. package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
  516. package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
  517. package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
  518. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
  519. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
  520. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
  521. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
  522. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
  523. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
  524. package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
  525. package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
  526. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
  527. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
  528. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
  529. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
  530. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
  531. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
  532. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
  533. package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +1 -1
  534. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
  535. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
  536. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
  537. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
  538. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
  539. package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
  540. package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
  541. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
  542. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
  543. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
  544. package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
  545. package/dist/esm/api/resources/user/client/Client.mjs +14 -6
  546. package/dist/esm/api/resources/wallet/client/Client.d.mts +34 -0
  547. package/dist/esm/api/resources/wallet/client/Client.mjs +89 -0
  548. package/dist/esm/api/resources/wallet/client/index.d.mts +1 -0
  549. package/dist/esm/api/resources/wallet/client/index.mjs +1 -0
  550. package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.mts +13 -0
  551. package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.mjs +2 -0
  552. package/dist/esm/api/resources/wallet/client/requests/index.d.mts +1 -0
  553. package/dist/esm/api/resources/wallet/client/requests/index.mjs +1 -0
  554. package/dist/esm/api/resources/wallet/exports.d.mts +2 -0
  555. package/dist/esm/api/resources/wallet/exports.mjs +3 -0
  556. package/dist/esm/api/resources/wallet/index.d.mts +1 -0
  557. package/dist/esm/api/resources/wallet/index.mjs +1 -0
  558. package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
  559. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
  560. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
  561. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
  562. package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
  563. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
  564. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
  565. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
  566. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
  567. package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
  568. package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
  569. package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
  570. package/dist/esm/api/types/BalanceLimit.mjs +21 -1
  571. package/dist/esm/api/types/Company.d.mts +1 -1
  572. package/dist/esm/api/types/ConsentGroup.d.mts +29 -0
  573. package/dist/esm/api/types/ConsentGroup.mjs +9 -0
  574. package/dist/esm/api/types/ConsentGroupItem.d.mts +17 -0
  575. package/dist/esm/api/types/ConsentGroupItem.mjs +9 -0
  576. package/dist/esm/api/types/ConsentGroupsListResponse.d.mts +14 -0
  577. package/dist/esm/api/types/ConsentGroupsListResponse.mjs +2 -0
  578. package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
  579. package/dist/esm/api/types/Deal.d.mts +4 -4
  580. package/dist/esm/api/types/FileData.d.mts +8 -6
  581. package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
  582. package/dist/esm/api/types/GetCampaignStats.d.mts +15 -15
  583. package/dist/esm/api/types/GetContactDetails.d.mts +5 -0
  584. package/dist/esm/api/types/GetEventsList.d.mts +0 -2
  585. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
  586. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
  587. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
  588. package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
  589. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
  590. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
  591. package/dist/esm/api/types/GetWebhook.d.mts +5 -10
  592. package/dist/esm/api/types/GetWebhook.mjs +2 -6
  593. package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
  594. package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
  595. package/dist/esm/api/types/Note.d.mts +10 -8
  596. package/dist/esm/api/types/NoteData.d.mts +1 -1
  597. package/dist/esm/api/types/Order.d.mts +1 -1
  598. package/dist/esm/api/types/Pipeline.d.mts +3 -3
  599. package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
  600. package/dist/esm/api/types/Task.d.mts +20 -8
  601. package/dist/esm/api/types/TierGroup.d.mts +66 -0
  602. package/dist/esm/api/types/TierGroup.mjs +30 -0
  603. package/dist/esm/api/types/Transaction.d.mts +36 -17
  604. package/dist/esm/api/types/Transaction.mjs +16 -1
  605. package/dist/esm/api/types/WalletPassInstallUrl.d.mts +4 -0
  606. package/dist/esm/api/types/WalletPassInstallUrl.mjs +2 -0
  607. package/dist/esm/api/types/index.d.mts +4 -0
  608. package/dist/esm/api/types/index.mjs +4 -0
  609. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  610. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  611. package/dist/esm/core/auth/index.d.mts +1 -1
  612. package/dist/esm/core/auth/index.mjs +1 -0
  613. package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
  614. package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
  615. package/dist/esm/core/fetcher/getResponseBody.mjs +11 -0
  616. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  617. package/dist/esm/core/fetcher/signals.mjs +9 -1
  618. package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
  619. package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
  620. package/dist/esm/core/url/index.d.mts +1 -0
  621. package/dist/esm/core/url/index.mjs +1 -0
  622. package/dist/esm/core/url/qs.d.mts +2 -1
  623. package/dist/esm/core/url/qs.mjs +25 -13
  624. package/dist/esm/errors/BrevoError.d.mts +1 -0
  625. package/dist/esm/errors/BrevoError.mjs +5 -1
  626. package/dist/esm/errors/BrevoTimeoutError.d.mts +2 -2
  627. package/dist/esm/errors/BrevoTimeoutError.mjs +7 -6
  628. package/dist/esm/version.d.mts +1 -1
  629. package/dist/esm/version.mjs +1 -1
  630. package/package.json +24 -2
  631. package/reference.md +2301 -170
  632. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
  633. package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
  634. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
  635. package/dist/esm/api/resources/event/types/index.d.mts +0 -1
  636. package/dist/esm/api/resources/event/types/index.mjs +0 -1
  637. /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
  638. /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → consentGroups/client/requests/DeleteConsentGroupRequest.js} +0 -0
  639. /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
  640. /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → consentGroups/client/requests/DeleteConsentGroupRequest.mjs} +0 -0
@@ -11,6 +11,8 @@ export declare class EcommerceClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<EcommerceClient.Options>;
12
12
  constructor(options: EcommerceClient.Options);
13
13
  /**
14
+ * Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status. The response includes a `count` field with the total number of matching categories, and pagination defaults to 50 categories per page (maximum 100).
15
+ *
14
16
  * @param {Brevo.GetCategoriesRequest} request
15
17
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -22,6 +24,8 @@ export declare class EcommerceClient {
22
24
  getCategories(request?: Brevo.GetCategoriesRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetCategoriesResponse>;
23
25
  private __getCategories;
24
26
  /**
27
+ * Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new category or `204` when an existing category is updated. The `name` field is mandatory for creation but optional for updates.
28
+ *
25
29
  * @param {Brevo.CreateUpdateCategoryRequest} request
26
30
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
27
31
  *
@@ -35,6 +39,8 @@ export declare class EcommerceClient {
35
39
  createUpdateCategory(request: Brevo.CreateUpdateCategoryRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateUpdateCategoryResponse | undefined>;
36
40
  private __createUpdateCategory;
37
41
  /**
42
+ * Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing categories are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated categories.
43
+ *
38
44
  * @param {Brevo.CreateUpdateBatchCategoryRequest} request
39
45
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
40
46
  *
@@ -50,6 +56,8 @@ export declare class EcommerceClient {
50
56
  createUpdateBatchCategory(request: Brevo.CreateUpdateBatchCategoryRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateUpdateBatchCategoryResponse>;
51
57
  private __createUpdateBatchCategory;
52
58
  /**
59
+ * Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.
60
+ *
53
61
  * @param {Brevo.GetCategoryInfoRequest} request
54
62
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
55
63
  *
@@ -77,6 +85,8 @@ export declare class EcommerceClient {
77
85
  activateTheECommerceApp(requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<void>;
78
86
  private __activateTheECommerceApp;
79
87
  /**
88
+ * Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format. The response includes per-source metrics (orders count, revenue, and average basket) as well as aggregated totals across all requested sources.
89
+ *
80
90
  * @param {Brevo.GetEcommerceAttributionMetricsRequest} request
81
91
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
82
92
  *
@@ -85,12 +95,15 @@ export declare class EcommerceClient {
85
95
  * @example
86
96
  * await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({
87
97
  * periodFrom: "2022-01-02T00:00:00Z",
88
- * periodTo: "2022-01-03T00:00:00Z"
98
+ * periodTo: "2022-01-03T00:00:00Z",
99
+ * "emailCampaignId[]": ["sale"]
89
100
  * })
90
101
  */
91
102
  getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows(request?: Brevo.GetEcommerceAttributionMetricsRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEcommerceAttributionMetricsResponse>;
92
103
  private __getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows;
93
104
  /**
105
+ * Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.
106
+ *
94
107
  * @param {Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdRequest} request
95
108
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
96
109
  *
@@ -105,6 +118,8 @@ export declare class EcommerceClient {
105
118
  getDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflow(request: Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdResponse>;
106
119
  private __getDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflow;
107
120
  /**
121
+ * Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count. The conversion source type must be one of `email_campaign`, `sms_campaign`, `automation_workflow_email`, or `automation_workflow_sms`.
122
+ *
108
123
  * @param {Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdRequest} request
109
124
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
110
125
  *
@@ -119,6 +134,8 @@ export declare class EcommerceClient {
119
134
  getAttributedProductSalesForASingleBrevoCampaignOrWorkflow(request: Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdResponse>;
120
135
  private __getAttributedProductSalesForASingleBrevoCampaignOrWorkflow;
121
136
  /**
137
+ * Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.
138
+ *
122
139
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
123
140
  *
124
141
  * @throws {@link Brevo.BadRequestError}
@@ -131,6 +148,8 @@ export declare class EcommerceClient {
131
148
  getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccount(requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEcommerceConfigDisplayCurrencyResponse>;
132
149
  private __getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccount;
133
150
  /**
151
+ * Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error. Returns a `403` error if ecommerce is not activated on the account.
152
+ *
134
153
  * @param {Brevo.SetConfigDisplayCurrencyRequest} request
135
154
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
136
155
  *
@@ -208,6 +227,8 @@ export declare class EcommerceClient {
208
227
  createBatchOrder(request: Brevo.CreateBatchOrderRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateBatchOrderResponse>;
209
228
  private __createBatchOrder;
210
229
  /**
230
+ * Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Use the `search` parameter to query across SKU, name, and ID simultaneously — results are prioritized as exact SKU match > SKU prefix match > name match > ID match. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.
231
+ *
211
232
  * @param {Brevo.GetProductsRequest} request
212
233
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
213
234
  *
@@ -219,6 +240,8 @@ export declare class EcommerceClient {
219
240
  getProducts(request?: Brevo.GetProductsRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetProductsResponse>;
220
241
  private __getProducts;
221
242
  /**
243
+ * Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new product or `204` for an update. The `name` field is mandatory for creation but optional for updates. Product images are downloaded, validated (max 5 MB, formats: jpeg, jpg, png, bmp, gif, webp), and re-hosted on S3. The `metaInfo` object supports up to 20 keys with a cumulative size limit of approximately 1000 KB.
244
+ *
222
245
  * @param {Brevo.CreateUpdateProductRequest} request
223
246
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
224
247
  *
@@ -233,6 +256,8 @@ export declare class EcommerceClient {
233
256
  createUpdateProduct(request: Brevo.CreateUpdateProductRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateUpdateProductResponse | undefined>;
234
257
  private __createUpdateProduct;
235
258
  /**
259
+ * Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit). Each product requires a unique `id` and `name` (name is mandatory for creation only). When `updateEnabled` is `false`, all products are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing products are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated products.
260
+ *
236
261
  * @param {Brevo.CreateUpdateBatchProductsRequest} request
237
262
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
238
263
  *
@@ -249,6 +274,8 @@ export declare class EcommerceClient {
249
274
  createUpdateBatchProducts(request: Brevo.CreateUpdateBatchProductsRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateUpdateBatchProductsResponse>;
250
275
  private __createUpdateBatchProducts;
251
276
  /**
277
+ * Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status. Returns a `404` error if no product matches the provided ID.
278
+ *
252
279
  * @param {Brevo.GetProductInfoRequest} request
253
280
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
254
281
  *
@@ -263,6 +290,8 @@ export declare class EcommerceClient {
263
290
  getProductInfo(request: Brevo.GetProductInfoRequest, requestOptions?: EcommerceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetProductDetails>;
264
291
  private __getProductInfo;
265
292
  /**
293
+ * Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`. Returns a `404` error if the product ID does not exist, and a `403` error if product alerts are not enabled for the account.
294
+ *
266
295
  * @param {Brevo.CreateProductAlertRequest} request
267
296
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
268
297
  *
@@ -67,6 +67,8 @@ class EcommerceClient {
67
67
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
68
68
  }
69
69
  /**
70
+ * Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status. The response includes a `count` field with the total number of matching categories, and pagination defaults to 50 categories per page (maximum 100).
71
+ *
70
72
  * @param {Brevo.GetCategoriesRequest} request
71
73
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
72
74
  *
@@ -98,7 +100,11 @@ class EcommerceClient {
98
100
  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, "categories"),
99
101
  method: "GET",
100
102
  headers: _headers,
101
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
103
+ queryString: core.url
104
+ .queryBuilder()
105
+ .addMany(_queryParams)
106
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
107
+ .build(),
102
108
  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,
103
109
  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,
104
110
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -124,6 +130,8 @@ class EcommerceClient {
124
130
  });
125
131
  }
126
132
  /**
133
+ * Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new category or `204` when an existing category is updated. The `name` field is mandatory for creation but optional for updates.
134
+ *
127
135
  * @param {Brevo.CreateUpdateCategoryRequest} request
128
136
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
129
137
  *
@@ -147,7 +155,7 @@ class EcommerceClient {
147
155
  method: "POST",
148
156
  headers: _headers,
149
157
  contentType: "application/json",
150
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
158
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
151
159
  requestType: "json",
152
160
  body: request,
153
161
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -178,6 +186,8 @@ class EcommerceClient {
178
186
  });
179
187
  }
180
188
  /**
189
+ * Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing categories are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated categories.
190
+ *
181
191
  * @param {Brevo.CreateUpdateBatchCategoryRequest} request
182
192
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
183
193
  *
@@ -203,7 +213,7 @@ class EcommerceClient {
203
213
  method: "POST",
204
214
  headers: _headers,
205
215
  contentType: "application/json",
206
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
216
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
207
217
  requestType: "json",
208
218
  body: request,
209
219
  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,
@@ -234,6 +244,8 @@ class EcommerceClient {
234
244
  });
235
245
  }
236
246
  /**
247
+ * Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.
248
+ *
237
249
  * @param {Brevo.GetCategoryInfoRequest} request
238
250
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
239
251
  *
@@ -258,7 +270,7 @@ class EcommerceClient {
258
270
  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, `categories/${core.url.encodePathParam(id)}`),
259
271
  method: "GET",
260
272
  headers: _headers,
261
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
273
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
262
274
  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,
263
275
  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,
264
276
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -308,7 +320,7 @@ class EcommerceClient {
308
320
  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, "ecommerce/activate"),
309
321
  method: "POST",
310
322
  headers: _headers,
311
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
323
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
312
324
  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,
313
325
  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,
314
326
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -336,6 +348,8 @@ class EcommerceClient {
336
348
  });
337
349
  }
338
350
  /**
351
+ * Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format. The response includes per-source metrics (orders count, revenue, and average basket) as well as aggregated totals across all requested sources.
352
+ *
339
353
  * @param {Brevo.GetEcommerceAttributionMetricsRequest} request
340
354
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
341
355
  *
@@ -344,7 +358,8 @@ class EcommerceClient {
344
358
  * @example
345
359
  * await client.ecommerce.getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows({
346
360
  * periodFrom: "2022-01-02T00:00:00Z",
347
- * periodTo: "2022-01-03T00:00:00Z"
361
+ * periodTo: "2022-01-03T00:00:00Z",
362
+ * "emailCampaignId[]": ["sale"]
348
363
  * })
349
364
  */
350
365
  getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows(request = {}, requestOptions) {
@@ -368,7 +383,11 @@ class EcommerceClient {
368
383
  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, "ecommerce/attribution/metrics"),
369
384
  method: "GET",
370
385
  headers: _headers,
371
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
386
+ queryString: core.url
387
+ .queryBuilder()
388
+ .addMany(_queryParams)
389
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
390
+ .build(),
372
391
  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,
373
392
  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,
374
393
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -397,6 +416,8 @@ class EcommerceClient {
397
416
  });
398
417
  }
399
418
  /**
419
+ * Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.
420
+ *
400
421
  * @param {Brevo.GetEcommerceAttributionMetricsConversionSourceConversionSourceIdRequest} request
401
422
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
402
423
  *
@@ -421,7 +442,7 @@ class EcommerceClient {
421
442
  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, `ecommerce/attribution/metrics/${core.url.encodePathParam(conversionSource)}/${core.url.encodePathParam(conversionSourceId)}`),
422
443
  method: "GET",
423
444
  headers: _headers,
424
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
445
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
425
446
  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,
426
447
  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,
427
448
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -450,6 +471,8 @@ class EcommerceClient {
450
471
  });
451
472
  }
452
473
  /**
474
+ * Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count. The conversion source type must be one of `email_campaign`, `sms_campaign`, `automation_workflow_email`, or `automation_workflow_sms`.
475
+ *
453
476
  * @param {Brevo.GetEcommerceAttributionProductsConversionSourceConversionSourceIdRequest} request
454
477
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
455
478
  *
@@ -474,7 +497,7 @@ class EcommerceClient {
474
497
  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, `ecommerce/attribution/products/${core.url.encodePathParam(conversionSource)}/${core.url.encodePathParam(conversionSourceId)}`),
475
498
  method: "GET",
476
499
  headers: _headers,
477
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
500
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
478
501
  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,
479
502
  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,
480
503
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -503,6 +526,8 @@ class EcommerceClient {
503
526
  });
504
527
  }
505
528
  /**
529
+ * Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.
530
+ *
506
531
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
507
532
  *
508
533
  * @throws {@link Brevo.BadRequestError}
@@ -524,7 +549,7 @@ class EcommerceClient {
524
549
  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, "ecommerce/config/displayCurrency"),
525
550
  method: "GET",
526
551
  headers: _headers,
527
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
552
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
528
553
  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,
529
554
  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,
530
555
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -557,6 +582,8 @@ class EcommerceClient {
557
582
  });
558
583
  }
559
584
  /**
585
+ * Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error. Returns a `403` error if ecommerce is not activated on the account.
586
+ *
560
587
  * @param {Brevo.SetConfigDisplayCurrencyRequest} request
561
588
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
562
589
  *
@@ -583,7 +610,7 @@ class EcommerceClient {
583
610
  method: "POST",
584
611
  headers: _headers,
585
612
  contentType: "application/json",
586
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
613
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
587
614
  requestType: "json",
588
615
  body: request,
589
616
  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,
@@ -650,7 +677,11 @@ class EcommerceClient {
650
677
  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, "orders"),
651
678
  method: "GET",
652
679
  headers: _headers,
653
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
680
+ queryString: core.url
681
+ .queryBuilder()
682
+ .addMany(_queryParams)
683
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
684
+ .build(),
654
685
  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,
655
686
  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,
656
687
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -709,7 +740,7 @@ class EcommerceClient {
709
740
  method: "POST",
710
741
  headers: _headers,
711
742
  contentType: "application/json",
712
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
743
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
713
744
  requestType: "json",
714
745
  body: request,
715
746
  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,
@@ -772,7 +803,7 @@ class EcommerceClient {
772
803
  method: "POST",
773
804
  headers: _headers,
774
805
  contentType: "application/json",
775
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
806
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
776
807
  requestType: "json",
777
808
  body: request,
778
809
  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,
@@ -800,6 +831,8 @@ class EcommerceClient {
800
831
  });
801
832
  }
802
833
  /**
834
+ * Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status. Use the `search` parameter to query across SKU, name, and ID simultaneously — results are prioritized as exact SKU match > SKU prefix match > name match > ID match. Pagination defaults to 50 products per page (maximum 1000), and the response includes a `count` field with the total number of matching products.
835
+ *
803
836
  * @param {Brevo.GetProductsRequest} request
804
837
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
805
838
  *
@@ -814,12 +847,13 @@ class EcommerceClient {
814
847
  __getProducts() {
815
848
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
816
849
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
817
- const { limit, offset, sort, ids, name, "price[lte]": priceLte, "price[gte]": priceGte, "price[lt]": priceLt, "price[gt]": priceGt, "price[eq]": priceEq, "price[ne]": priceNe, categories, modifiedSince, createdSince, isDeleted, } = request;
850
+ const { limit, offset, sort, ids, search, name, "price[lte]": priceLte, "price[gte]": priceGte, "price[lt]": priceLt, "price[gt]": priceGt, "price[eq]": priceEq, "price[ne]": priceNe, "alternativePrice[lte]": alternativePriceLte, "alternativePrice[gte]": alternativePriceGte, "alternativePrice[lt]": alternativePriceLt, "alternativePrice[gt]": alternativePriceGt, "alternativePrice[eq]": alternativePriceEq, "alternativePrice[ne]": alternativePriceNe, categories, modifiedSince, createdSince, sortByField, isDeleted, } = request;
818
851
  const _queryParams = {
819
852
  limit,
820
853
  offset,
821
854
  sort: sort != null ? sort : undefined,
822
855
  ids,
856
+ search,
823
857
  name,
824
858
  "price[lte]": priceLte,
825
859
  "price[gte]": priceGte,
@@ -827,9 +861,16 @@ class EcommerceClient {
827
861
  "price[gt]": priceGt,
828
862
  "price[eq]": priceEq,
829
863
  "price[ne]": priceNe,
864
+ "alternativePrice[lte]": alternativePriceLte,
865
+ "alternativePrice[gte]": alternativePriceGte,
866
+ "alternativePrice[lt]": alternativePriceLt,
867
+ "alternativePrice[gt]": alternativePriceGt,
868
+ "alternativePrice[eq]": alternativePriceEq,
869
+ "alternativePrice[ne]": alternativePriceNe,
830
870
  categories,
831
871
  modifiedSince,
832
872
  createdSince,
873
+ sortByField: sortByField != null ? sortByField : undefined,
833
874
  isDeleted,
834
875
  };
835
876
  const _authRequest = yield this._options.authProvider.getAuthRequest();
@@ -838,7 +879,11 @@ class EcommerceClient {
838
879
  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, "products"),
839
880
  method: "GET",
840
881
  headers: _headers,
841
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
882
+ queryString: core.url
883
+ .queryBuilder()
884
+ .addMany(_queryParams)
885
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
886
+ .build(),
842
887
  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,
843
888
  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,
844
889
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -864,6 +909,8 @@ class EcommerceClient {
864
909
  });
865
910
  }
866
911
  /**
912
+ * Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new product or `204` for an update. The `name` field is mandatory for creation but optional for updates. Product images are downloaded, validated (max 5 MB, formats: jpeg, jpg, png, bmp, gif, webp), and re-hosted on S3. The `metaInfo` object supports up to 20 keys with a cumulative size limit of approximately 1000 KB.
913
+ *
867
914
  * @param {Brevo.CreateUpdateProductRequest} request
868
915
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
869
916
  *
@@ -888,7 +935,7 @@ class EcommerceClient {
888
935
  method: "POST",
889
936
  headers: _headers,
890
937
  contentType: "application/json",
891
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
938
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
892
939
  requestType: "json",
893
940
  body: request,
894
941
  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,
@@ -919,6 +966,8 @@ class EcommerceClient {
919
966
  });
920
967
  }
921
968
  /**
969
+ * Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit). Each product requires a unique `id` and `name` (name is mandatory for creation only). When `updateEnabled` is `false`, all products are inserted as new; if any ID already exists, a `400` error is returned. When `updateEnabled` is `true`, existing products are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated products.
970
+ *
922
971
  * @param {Brevo.CreateUpdateBatchProductsRequest} request
923
972
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
924
973
  *
@@ -945,7 +994,7 @@ class EcommerceClient {
945
994
  method: "POST",
946
995
  headers: _headers,
947
996
  contentType: "application/json",
948
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
997
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
949
998
  requestType: "json",
950
999
  body: request,
951
1000
  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,
@@ -976,6 +1025,8 @@ class EcommerceClient {
976
1025
  });
977
1026
  }
978
1027
  /**
1028
+ * Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status. Returns a `404` error if no product matches the provided ID.
1029
+ *
979
1030
  * @param {Brevo.GetProductInfoRequest} request
980
1031
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
981
1032
  *
@@ -1000,7 +1051,7 @@ class EcommerceClient {
1000
1051
  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, `products/${core.url.encodePathParam(id)}`),
1001
1052
  method: "GET",
1002
1053
  headers: _headers,
1003
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1054
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1004
1055
  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,
1005
1056
  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,
1006
1057
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1028,6 +1079,8 @@ class EcommerceClient {
1028
1079
  });
1029
1080
  }
1030
1081
  /**
1082
+ * Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`. Returns a `404` error if the product ID does not exist, and a `403` error if product alerts are not enabled for the account.
1083
+ *
1031
1084
  * @param {Brevo.CreateProductAlertRequest} request
1032
1085
  * @param {EcommerceClient.RequestOptions} requestOptions - Request-specific configuration.
1033
1086
  *
@@ -1056,7 +1109,7 @@ class EcommerceClient {
1056
1109
  method: "POST",
1057
1110
  headers: _headers,
1058
1111
  contentType: "application/json",
1059
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
1112
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
1060
1113
  requestType: "json",
1061
1114
  body: _body,
1062
1115
  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,
@@ -16,9 +16,9 @@ import type * as Brevo from "../../../../index.js";
16
16
  * }
17
17
  */
18
18
  export interface CreateBatchOrderRequest {
19
- /** Defines wether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual. */
19
+ /** Defines whether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual. */
20
20
  historical?: boolean;
21
- /** Notify Url provided by client_dev to get the status of batch request */
21
+ /** Webhook URL to receive the status of the batch request */
22
22
  notifyUrl?: string;
23
23
  /** array of order objects */
24
24
  orders: Brevo.Order[];
@@ -10,7 +10,7 @@
10
10
  export interface CreateUpdateBatchProductsRequest {
11
11
  /** array of products objects */
12
12
  products: CreateUpdateBatchProductsRequest.Products.Item[];
13
- /** Facilitate to update the existing categories in the same request (updateEnabled = true) */
13
+ /** Facilitate to update the existing products in the same request (updateEnabled = true) */
14
14
  updateEnabled?: boolean;
15
15
  }
16
16
  export declare namespace CreateUpdateBatchProductsRequest {
@@ -33,12 +33,14 @@ export declare namespace CreateUpdateBatchProductsRequest {
33
33
  isDeleted?: boolean | undefined;
34
34
  /** Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. */
35
35
  metaInfo?: Record<string, Item.MetaInfo.Value> | undefined;
36
- /** Mandatory in case of creation**. Name of the product for which you requested the details */
36
+ /** **Mandatory in case of creation**. Name of the product, as displayed in the shop */
37
37
  name: string;
38
38
  /** Parent product id of the product */
39
39
  parentId?: string | undefined;
40
40
  /** Price of the product */
41
41
  price?: number | undefined;
42
+ /** Alternative price of the product */
43
+ alternativePrice?: number | undefined;
42
44
  /** Product identifier from the shop */
43
45
  sku?: string | undefined;
44
46
  /** Current stock value of the product from the shop's database */
@@ -22,17 +22,19 @@ export interface CreateUpdateProductRequest {
22
22
  isDeleted?: boolean;
23
23
  /** Meta data of product such as description, vendor, producer, stock level. The total characters of cumulative metaInfo shall not exceed **20000 characters**. */
24
24
  metaInfo?: Record<string, CreateUpdateProductRequest.MetaInfo.Value>;
25
- /** Mandatory in case of creation**. Name of the product for which you requested the details */
25
+ /** **Mandatory in case of creation**. Name of the product, as displayed in the shop */
26
26
  name: string;
27
27
  /** Parent product id of the product */
28
28
  parentId?: string;
29
29
  /** Price of the product */
30
30
  price?: number;
31
+ /** Alternative price of the product */
32
+ alternativePrice?: number;
31
33
  /** Product identifier from the shop */
32
34
  sku?: string;
33
35
  /** Current stock value of the product from the shop's database */
34
36
  stock?: number;
35
- /** Facilitate to update the existing category in the same request (updateEnabled = true) */
37
+ /** Facilitate to update the existing product in the same request (updateEnabled = true) */
36
38
  updateEnabled?: boolean;
37
39
  /** URL to the product */
38
40
  url?: string;
@@ -2,7 +2,8 @@
2
2
  * @example
3
3
  * {
4
4
  * periodFrom: "2022-01-02T00:00:00Z",
5
- * periodTo: "2022-01-03T00:00:00Z"
5
+ * periodTo: "2022-01-03T00:00:00Z",
6
+ * "emailCampaignId[]": ["sale"]
6
7
  * }
7
8
  */
8
9
  export interface GetEcommerceAttributionMetricsRequest {
@@ -12,6 +12,8 @@ export interface GetProductsRequest {
12
12
  sort?: Brevo.GetProductsRequestSort;
13
13
  /** Filter by product ids */
14
14
  ids?: string | string[];
15
+ /** Search products simultaneously across SKU, name, and ID fields. Results are returned in the following priority order: **exact SKU match** > **SKU prefix match** > **name match** > **ID match**. For example, `?search=123` on products with `{sku: "123"}` and `{sku: "123456"}` returns the exact SKU match first. */
16
+ search?: string;
15
17
  /** Filter by product name, minimum 3 characters should be present for search. */
16
18
  name?: string;
17
19
  /** Price filter for products less than and equals to particular amount */
@@ -26,12 +28,26 @@ export interface GetProductsRequest {
26
28
  "price[eq]"?: number;
27
29
  /** Price filter for products not equals to particular amount */
28
30
  "price[ne]"?: number;
31
+ /** Alternative price filter for products less than and equals to particular amount */
32
+ "alternativePrice[lte]"?: number;
33
+ /** Alternative price filter for products greater than and equals to particular amount */
34
+ "alternativePrice[gte]"?: number;
35
+ /** Alternative price filter for products less than particular amount */
36
+ "alternativePrice[lt]"?: number;
37
+ /** Alternative price filter for products greater than particular amount */
38
+ "alternativePrice[gt]"?: number;
39
+ /** Alternative price filter for products equals to particular amount */
40
+ "alternativePrice[eq]"?: number;
41
+ /** Alternative price filter for products not equals to particular amount */
42
+ "alternativePrice[ne]"?: number;
29
43
  /** Filter by categories ids */
30
44
  categories?: string | string[];
31
- /** Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** */
45
+ /** Filter (urlencoded) the products modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** */
32
46
  modifiedSince?: string;
33
- /** Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** */
47
+ /** Filter (urlencoded) the products created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** */
34
48
  createdSince?: string;
49
+ /** Sort the results by a specific field. Default sort field is `created_at` when not passed. */
50
+ sortByField?: Brevo.GetProductsRequestSortByField;
35
51
  /** Filter products by their deletion status. If `false` is passed, only products that are not deleted will be returned. */
36
52
  isDeleted?: string;
37
53
  }
@@ -1,6 +1,6 @@
1
1
  export interface CreateBatchOrderResponse {
2
- /** Batch ID of the request */
3
- batchId: number;
4
2
  /** Number of orders */
5
3
  count?: number | undefined;
4
+ /** Batch ID of the request */
5
+ batch_id: number | null;
6
6
  }
@@ -1,4 +1,4 @@
1
1
  export interface CreateUpdateCategoryResponse {
2
2
  /** ID of the category when a new category is created */
3
- id?: number | undefined;
3
+ id?: string | undefined;
4
4
  }
@@ -1,4 +1,4 @@
1
1
  export interface CreateUpdateProductResponse {
2
- /** ID of the Product when a new product is created */
3
- id?: number | undefined;
2
+ /** ID of the product when a new product is created */
3
+ id?: string | undefined;
4
4
  }