@getbrevo/brevo 4.0.1 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (645) hide show
  1. package/README.md +6 -6
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/api/resources/account/exports.d.ts +2 -0
  4. package/dist/cjs/api/resources/account/exports.js +21 -0
  5. package/dist/cjs/api/resources/account/types/GetAccountActivityResponse.d.ts +1 -1
  6. package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +7 -7
  7. package/dist/cjs/api/resources/balance/client/Client.d.ts +2 -2
  8. package/dist/cjs/api/resources/balance/client/Client.js +6 -6
  9. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +5 -5
  10. package/dist/cjs/api/resources/balance/exports.d.ts +2 -0
  11. package/dist/cjs/api/resources/balance/exports.js +21 -0
  12. package/dist/cjs/api/resources/balance/types/CreateBalanceOrderResponse.d.ts +6 -6
  13. package/dist/cjs/api/resources/balance/types/GetBalanceDefinitionListResponse.d.ts +1 -1
  14. package/dist/cjs/api/resources/balance/types/GetContactBalancesResponse.d.ts +8 -8
  15. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +15 -15
  16. package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +3 -3
  17. package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +9 -9
  18. package/dist/cjs/api/resources/balance/types/index.d.ts +0 -1
  19. package/dist/cjs/api/resources/balance/types/index.js +0 -1
  20. package/dist/cjs/api/resources/companies/client/Client.d.ts +28 -0
  21. package/dist/cjs/api/resources/companies/client/Client.js +107 -0
  22. package/dist/cjs/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.d.ts +10 -0
  23. package/dist/cjs/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.js +3 -0
  24. package/dist/cjs/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.d.ts +33 -0
  25. package/dist/cjs/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.js +12 -0
  26. package/dist/cjs/api/resources/companies/client/requests/index.d.ts +2 -0
  27. package/dist/cjs/api/resources/companies/client/requests/index.js +3 -1
  28. package/dist/cjs/api/resources/companies/exports.d.ts +2 -0
  29. package/dist/cjs/api/resources/companies/exports.js +21 -0
  30. package/dist/cjs/api/resources/companies/types/GetCompaniesResponse.d.ts +1 -1
  31. package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +5 -5
  32. package/dist/cjs/api/resources/companies/types/PostCompaniesImportResponse.d.ts +1 -1
  33. package/dist/cjs/api/resources/contacts/client/Client.d.ts +15 -45
  34. package/dist/cjs/api/resources/contacts/client/Client.js +15 -45
  35. package/dist/cjs/api/resources/contacts/client/requests/AddContactToListRequest.d.ts +0 -24
  36. package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +4 -4
  37. package/dist/cjs/api/resources/contacts/client/requests/RemoveContactFromListRequest.d.ts +0 -32
  38. package/dist/cjs/api/resources/contacts/client/requests/RequestContactExportRequest.d.ts +7 -7
  39. package/dist/cjs/api/resources/contacts/client/requests/UpdateBatchContactsRequest.d.ts +10 -10
  40. package/dist/cjs/api/resources/contacts/exports.d.ts +2 -0
  41. package/dist/cjs/api/resources/contacts/exports.js +21 -0
  42. package/dist/cjs/api/resources/contacts/types/CreateContactResponse.d.ts +1 -1
  43. package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +4 -4
  44. package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +13 -13
  45. package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +11 -11
  46. package/dist/cjs/api/resources/contacts/types/GetFolderListsResponse.d.ts +2 -2
  47. package/dist/cjs/api/resources/contacts/types/GetFoldersResponse.d.ts +2 -2
  48. package/dist/cjs/api/resources/contacts/types/GetListResponse.d.ts +2 -2
  49. package/dist/cjs/api/resources/contacts/types/GetListsResponse.d.ts +2 -2
  50. package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +3 -3
  51. package/dist/cjs/api/resources/conversations/exports.d.ts +2 -0
  52. package/dist/cjs/api/resources/conversations/exports.js +21 -0
  53. package/dist/cjs/api/resources/conversations/types/PutConversationsVisitorGroupResponse.d.ts +2 -2
  54. package/dist/cjs/api/resources/coupons/exports.d.ts +2 -0
  55. package/dist/cjs/api/resources/coupons/exports.js +21 -0
  56. package/dist/cjs/api/resources/customObjects/client/Client.d.ts +6 -14
  57. package/dist/cjs/api/resources/customObjects/client/Client.js +6 -14
  58. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +6 -6
  59. package/dist/cjs/api/resources/customObjects/exports.d.ts +2 -0
  60. package/dist/cjs/api/resources/customObjects/exports.js +21 -0
  61. package/dist/cjs/api/resources/customObjects/types/BatchDeleteObjectRecordsResponse.d.ts +2 -2
  62. package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +9 -9
  63. package/dist/cjs/api/resources/customObjects/types/UpsertrecordsResponse.d.ts +3 -3
  64. package/dist/cjs/api/resources/deals/client/Client.d.ts +2 -0
  65. package/dist/cjs/api/resources/deals/client/Client.js +2 -0
  66. package/dist/cjs/api/resources/deals/exports.d.ts +2 -0
  67. package/dist/cjs/api/resources/deals/exports.js +21 -0
  68. package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +5 -5
  69. package/dist/cjs/api/resources/deals/types/GetCrmDealsResponse.d.ts +1 -1
  70. package/dist/cjs/api/resources/deals/types/PostCrmDealsImportResponse.d.ts +1 -1
  71. package/dist/cjs/api/resources/domains/client/requests/AuthenticateDomainRequest.d.ts +0 -5
  72. package/dist/cjs/api/resources/domains/client/requests/CreateDomainRequest.d.ts +0 -10
  73. package/dist/cjs/api/resources/domains/client/requests/GetDomainConfigurationRequest.d.ts +0 -5
  74. package/dist/cjs/api/resources/domains/exports.d.ts +2 -0
  75. package/dist/cjs/api/resources/domains/exports.js +21 -0
  76. package/dist/cjs/api/resources/domains/types/CreateDomainResponse.d.ts +2 -2
  77. package/dist/cjs/api/resources/domains/types/GetDomainsResponse.d.ts +1 -1
  78. package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +2 -4
  79. package/dist/cjs/api/resources/ecommerce/client/Client.js +2 -4
  80. package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +1 -2
  81. package/dist/cjs/api/resources/ecommerce/client/requests/CreateProductAlertRequest.d.ts +3 -3
  82. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchCategoryRequest.d.ts +4 -4
  83. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +10 -10
  84. package/dist/cjs/api/resources/ecommerce/exports.d.ts +2 -0
  85. package/dist/cjs/api/resources/ecommerce/exports.js +21 -0
  86. package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +1 -1
  87. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateBatchCategoryResponse.d.ts +2 -2
  88. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateBatchProductsResponse.d.ts +2 -2
  89. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
  90. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +1 -1
  91. package/dist/cjs/api/resources/ecommerce/types/GetEcommerceAttributionProductsConversionSourceConversionSourceIdResponse.d.ts +7 -7
  92. package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +2 -5
  93. package/dist/cjs/api/resources/emailCampaigns/client/Client.js +4 -6
  94. package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +9 -9
  95. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +2 -0
  96. package/dist/cjs/api/resources/emailCampaigns/client/requests/UpdateEmailCampaignRequest.d.ts +9 -9
  97. package/dist/cjs/api/resources/emailCampaigns/exports.d.ts +2 -0
  98. package/dist/cjs/api/resources/emailCampaigns/exports.js +21 -0
  99. package/dist/cjs/api/resources/emailCampaigns/types/GetAbTestCampaignResultResponse.d.ts +8 -8
  100. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +32 -25
  101. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +3 -0
  102. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.d.ts +2 -0
  103. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.js +2 -0
  104. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +34 -27
  105. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +3 -0
  106. package/dist/cjs/api/resources/emailCampaigns/types/UploadImageToGalleryResponse.d.ts +1 -1
  107. package/dist/cjs/api/resources/event/client/Client.d.ts +17 -0
  108. package/dist/cjs/api/resources/event/client/Client.js +57 -0
  109. package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +10 -10
  110. package/dist/cjs/api/resources/event/exports.d.ts +2 -0
  111. package/dist/cjs/api/resources/event/exports.js +21 -0
  112. package/dist/cjs/api/resources/event/index.d.ts +1 -0
  113. package/dist/cjs/api/resources/event/index.js +1 -0
  114. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +59 -0
  115. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.js +3 -0
  116. package/dist/cjs/api/resources/event/types/index.d.ts +1 -0
  117. package/dist/cjs/api/resources/event/types/index.js +17 -0
  118. package/dist/cjs/api/resources/externalFeeds/client/requests/GetExternalFeedByUuidRequest.d.ts +0 -10
  119. package/dist/cjs/api/resources/externalFeeds/exports.d.ts +2 -0
  120. package/dist/cjs/api/resources/externalFeeds/exports.js +21 -0
  121. package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +4 -4
  122. package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +4 -4
  123. package/dist/cjs/api/resources/files/exports.d.ts +2 -0
  124. package/dist/cjs/api/resources/files/exports.js +21 -0
  125. package/dist/cjs/api/resources/files/types/GetCrmFilesIdResponse.d.ts +1 -1
  126. package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +1 -0
  127. package/dist/cjs/api/resources/inboundParsing/client/Client.js +1 -0
  128. package/dist/cjs/api/resources/inboundParsing/exports.d.ts +2 -0
  129. package/dist/cjs/api/resources/inboundParsing/exports.js +21 -0
  130. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +14 -14
  131. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsResponse.d.ts +1 -1
  132. package/dist/cjs/api/resources/index.d.ts +1 -0
  133. package/dist/cjs/api/resources/index.js +1 -0
  134. package/dist/cjs/api/resources/masterAccount/client/requests/InviteAdminUserRequest.d.ts +2 -2
  135. package/dist/cjs/api/resources/masterAccount/client/requests/PutCorporateSubAccountIdPlanRequest.d.ts +9 -9
  136. package/dist/cjs/api/resources/masterAccount/client/requests/PutCorporateSubAccountsPlanRequest.d.ts +8 -8
  137. package/dist/cjs/api/resources/masterAccount/client/requests/PutCorporateUserEmailPermissionsRequest.d.ts +2 -2
  138. package/dist/cjs/api/resources/masterAccount/exports.d.ts +2 -0
  139. package/dist/cjs/api/resources/masterAccount/exports.js +21 -0
  140. package/dist/cjs/api/resources/masterAccount/types/GetCorporateGroupIdResponse.d.ts +12 -12
  141. package/dist/cjs/api/resources/masterAccount/types/GetCorporateInvitedUsersListResponse.d.ts +11 -11
  142. package/dist/cjs/api/resources/masterAccount/types/GetCorporateIpResponseItem.d.ts +3 -3
  143. package/dist/cjs/api/resources/masterAccount/types/GetCorporateMasterAccountResponse.d.ts +31 -31
  144. package/dist/cjs/api/resources/masterAccount/types/GetCorporateSubAccountIdResponse.d.ts +37 -37
  145. package/dist/cjs/api/resources/masterAccount/types/GetCorporateSubAccountResponse.d.ts +4 -4
  146. package/dist/cjs/api/resources/masterAccount/types/GetCorporateUserPermissionResponse.d.ts +10 -10
  147. package/dist/cjs/api/resources/masterAccount/types/GetSubAccountGroupsResponseItem.d.ts +2 -2
  148. package/dist/cjs/api/resources/masterAccount/types/InviteAdminUserResponse.d.ts +1 -1
  149. package/dist/cjs/api/resources/masterAccount/types/PostCorporateGroupResponse.d.ts +1 -1
  150. package/dist/cjs/api/resources/masterAccount/types/PutCorporateUserInvitationActionEmailResponse.d.ts +1 -1
  151. package/dist/cjs/api/resources/notes/exports.d.ts +2 -0
  152. package/dist/cjs/api/resources/notes/exports.js +21 -0
  153. package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
  154. package/dist/cjs/api/resources/payments/exports.d.ts +2 -0
  155. package/dist/cjs/api/resources/payments/exports.js +21 -0
  156. package/dist/cjs/api/resources/payments/types/CreatePaymentRequestResponse.d.ts +1 -1
  157. package/dist/cjs/api/resources/payments/types/GetPaymentRequestResponse.d.ts +3 -3
  158. package/dist/cjs/api/resources/process/client/requests/GetProcessRequest.d.ts +0 -15
  159. package/dist/cjs/api/resources/process/exports.d.ts +2 -0
  160. package/dist/cjs/api/resources/process/exports.js +21 -0
  161. package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +16 -16
  162. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +16 -16
  163. package/dist/cjs/api/resources/program/client/Client.d.ts +21 -0
  164. package/dist/cjs/api/resources/program/client/Client.js +67 -0
  165. package/dist/cjs/api/resources/program/client/requests/DeleteContactSubscriptionRequest.d.ts +13 -0
  166. package/dist/cjs/api/resources/program/client/requests/DeleteContactSubscriptionRequest.js +3 -0
  167. package/dist/cjs/api/resources/program/client/requests/index.d.ts +1 -0
  168. package/dist/cjs/api/resources/program/exports.d.ts +2 -0
  169. package/dist/cjs/api/resources/program/exports.js +21 -0
  170. package/dist/cjs/api/resources/program/types/GetLpListResponse.d.ts +1 -1
  171. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +28 -28
  172. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +5 -5
  173. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +7 -7
  174. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +26 -26
  175. package/dist/cjs/api/resources/reward/exports.d.ts +2 -0
  176. package/dist/cjs/api/resources/reward/exports.js +21 -0
  177. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +8 -8
  178. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +11 -11
  179. package/dist/cjs/api/resources/reward/types/GetCodeCountResponse.d.ts +1 -1
  180. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidOffersResponse.d.ts +11 -11
  181. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidRewardsRidResponse.d.ts +81 -81
  182. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +15 -15
  183. package/dist/cjs/api/resources/reward/types/ValidateRewardResponse.d.ts +1 -1
  184. package/dist/cjs/api/resources/senders/client/requests/CreateSenderRequest.d.ts +1 -13
  185. package/dist/cjs/api/resources/senders/client/requests/GetIpsFromSenderRequest.d.ts +0 -5
  186. package/dist/cjs/api/resources/senders/client/requests/GetSendersRequest.d.ts +0 -3
  187. package/dist/cjs/api/resources/senders/client/requests/UpdateSenderRequest.d.ts +1 -1
  188. package/dist/cjs/api/resources/senders/exports.d.ts +2 -0
  189. package/dist/cjs/api/resources/senders/exports.js +21 -0
  190. package/dist/cjs/api/resources/senders/types/CreateSenderResponse.d.ts +2 -2
  191. package/dist/cjs/api/resources/senders/types/GetSendersResponse.d.ts +1 -1
  192. package/dist/cjs/api/resources/smsCampaigns/client/requests/CreateSmsCampaignRequest.d.ts +1 -1
  193. package/dist/cjs/api/resources/smsCampaigns/client/requests/UpdateSmsCampaignRequest.d.ts +1 -1
  194. package/dist/cjs/api/resources/smsCampaigns/exports.d.ts +2 -0
  195. package/dist/cjs/api/resources/smsCampaigns/exports.js +21 -0
  196. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +1 -1
  197. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +3 -3
  198. package/dist/cjs/api/resources/smsTemplates/exports.d.ts +2 -0
  199. package/dist/cjs/api/resources/smsTemplates/exports.js +21 -0
  200. package/dist/cjs/api/resources/smsTemplates/types/GetSmsTemplatesResponse.d.ts +17 -17
  201. package/dist/cjs/api/resources/tasks/exports.d.ts +2 -0
  202. package/dist/cjs/api/resources/tasks/exports.js +21 -0
  203. package/dist/cjs/api/resources/tasks/types/GetCrmTasksResponse.d.ts +1 -1
  204. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponse.d.ts +2 -2
  205. package/dist/cjs/api/resources/tier/client/Client.d.ts +2 -2
  206. package/dist/cjs/api/resources/tier/client/Client.js +2 -2
  207. package/dist/cjs/api/resources/tier/client/requests/CreateTierForTierGroupRequest.d.ts +3 -3
  208. package/dist/cjs/api/resources/tier/client/requests/UpdateTierRequest.d.ts +3 -3
  209. package/dist/cjs/api/resources/tier/exports.d.ts +2 -0
  210. package/dist/cjs/api/resources/tier/exports.js +21 -0
  211. package/dist/cjs/api/resources/tier/types/AddSubscriptionToTierResponse.d.ts +7 -7
  212. package/dist/cjs/api/resources/tier/types/GetListOfTierGroupsResponse.d.ts +1 -1
  213. package/dist/cjs/api/resources/tier/types/GetLoyaltyProgramTierResponse.d.ts +1 -1
  214. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +2 -6
  215. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +2 -6
  216. package/dist/cjs/api/resources/transactionalEmails/client/requests/CreateSmtpTemplateRequest.d.ts +3 -3
  217. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +0 -7
  218. package/dist/cjs/api/resources/transactionalEmails/client/requests/SendTransacEmailRequest.d.ts +21 -21
  219. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -3
  220. package/dist/cjs/api/resources/transactionalEmails/exports.d.ts +2 -0
  221. package/dist/cjs/api/resources/transactionalEmails/exports.js +21 -0
  222. package/dist/cjs/api/resources/transactionalEmails/types/GetAggregatedSmtpReportResponse.d.ts +13 -13
  223. package/dist/cjs/api/resources/transactionalEmails/types/GetEmailEventReportResponse.d.ts +8 -8
  224. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpReportResponse.d.ts +1 -1
  225. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplatesResponse.d.ts +2 -2
  226. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +4 -4
  227. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +1 -1
  228. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailsListResponse.d.ts +5 -5
  229. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesResponse.d.ts +6 -6
  230. package/dist/cjs/api/resources/transactionalEmails/types/SendTransacEmailResponse.d.ts +2 -2
  231. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +5 -9
  232. package/dist/cjs/api/resources/transactionalSms/client/Client.js +5 -9
  233. package/dist/cjs/api/resources/transactionalSms/exports.d.ts +2 -0
  234. package/dist/cjs/api/resources/transactionalSms/exports.js +21 -0
  235. package/dist/cjs/api/resources/transactionalSms/types/GetSmsEventsResponse.d.ts +8 -8
  236. package/dist/cjs/api/resources/transactionalSms/types/GetTransacAggregatedSmsReportResponse.d.ts +11 -11
  237. package/dist/cjs/api/resources/transactionalSms/types/GetTransacSmsReportResponse.d.ts +12 -12
  238. package/dist/cjs/api/resources/transactionalSms/types/SendTransacSmsResponse.d.ts +3 -3
  239. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.d.ts +2 -1
  240. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +2 -1
  241. package/dist/cjs/api/resources/transactionalWhatsApp/exports.d.ts +2 -0
  242. package/dist/cjs/api/resources/transactionalWhatsApp/exports.js +21 -0
  243. package/dist/cjs/api/resources/transactionalWhatsApp/types/GetWhatsappEventReportResponse.d.ts +4 -4
  244. package/dist/cjs/api/resources/user/exports.d.ts +2 -0
  245. package/dist/cjs/api/resources/user/exports.js +21 -0
  246. package/dist/cjs/api/resources/user/types/EditUserPermissionResponse.d.ts +2 -2
  247. package/dist/cjs/api/resources/user/types/GetInvitedUsersListResponse.d.ts +4 -4
  248. package/dist/cjs/api/resources/user/types/InviteuserResponse.d.ts +1 -1
  249. package/dist/cjs/api/resources/user/types/PutRevokeUserPermissionResponse.d.ts +1 -1
  250. package/dist/cjs/api/resources/user/types/PutresendcancelinvitationResponse.d.ts +1 -1
  251. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +7 -13
  252. package/dist/cjs/api/resources/webhooks/client/Client.js +7 -13
  253. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +6 -4
  254. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +1 -0
  255. package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.ts +6 -4
  256. package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.js +1 -0
  257. package/dist/cjs/api/resources/webhooks/exports.d.ts +2 -0
  258. package/dist/cjs/api/resources/webhooks/exports.js +21 -0
  259. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +19 -44
  260. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +19 -44
  261. package/dist/cjs/api/resources/whatsAppCampaigns/client/requests/CreateWhatsAppCampaignRequest.d.ts +3 -3
  262. package/dist/cjs/api/resources/whatsAppCampaigns/client/requests/UpdateWhatsAppCampaignRequest.d.ts +3 -3
  263. package/dist/cjs/api/resources/whatsAppCampaigns/exports.d.ts +2 -0
  264. package/dist/cjs/api/resources/whatsAppCampaigns/exports.js +21 -0
  265. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -15
  266. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignsResponse.d.ts +6 -6
  267. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppConfigResponse.d.ts +6 -6
  268. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +3 -3
  269. package/dist/cjs/api/types/BalanceDefinition.d.ts +20 -20
  270. package/dist/cjs/api/types/BalanceLimit.d.ts +8 -8
  271. package/dist/cjs/api/types/BatchEventsResponse.d.ts +26 -0
  272. package/dist/cjs/api/types/BatchEventsResponse.js +3 -0
  273. package/dist/cjs/api/types/Company.d.ts +4 -4
  274. package/dist/cjs/api/types/ContactErrorModel.d.ts +1 -1
  275. package/dist/cjs/api/types/ConversationsMessage.d.ts +53 -53
  276. package/dist/cjs/api/types/CreateUpdateFolder.d.ts +1 -1
  277. package/dist/cjs/api/types/Deal.d.ts +4 -4
  278. package/dist/cjs/api/types/ErrorModel.d.ts +1 -1
  279. package/dist/cjs/api/types/FileData.d.ts +7 -7
  280. package/dist/cjs/api/types/GetCampaignStats.d.ts +7 -7
  281. package/dist/cjs/api/types/GetCategoryDetails.d.ts +1 -1
  282. package/dist/cjs/api/types/GetContactDetails.d.ts +2 -2
  283. package/dist/cjs/api/types/GetCouponCollection.d.ts +3 -3
  284. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +32 -25
  285. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +3 -0
  286. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +4 -4
  287. package/dist/cjs/api/types/GetProductDetails.d.ts +10 -10
  288. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +1 -1
  289. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +4 -4
  290. package/dist/cjs/api/types/GetWebhook.d.ts +4 -4
  291. package/dist/cjs/api/types/Inviteuser.d.ts +2 -2
  292. package/dist/cjs/api/types/LoyaltyProgram.d.ts +12 -12
  293. package/dist/cjs/api/types/NodeResponse.d.ts +8 -8
  294. package/dist/cjs/api/types/Note.d.ts +6 -6
  295. package/dist/cjs/api/types/NoteData.d.ts +3 -3
  296. package/dist/cjs/api/types/Order.d.ts +30 -20
  297. package/dist/cjs/api/types/Pipeline.d.ts +5 -5
  298. package/dist/cjs/api/types/PostContactInfo.d.ts +4 -4
  299. package/dist/cjs/api/types/PostSendFailed.d.ts +3 -3
  300. package/dist/cjs/api/types/Redeem.d.ts +14 -14
  301. package/dist/cjs/api/types/RuleConditionResponse.d.ts +5 -5
  302. package/dist/cjs/api/types/SendReport.d.ts +1 -1
  303. package/dist/cjs/api/types/SendTestEmail.d.ts +1 -1
  304. package/dist/cjs/api/types/SendTransacSms.d.ts +10 -6
  305. package/dist/cjs/api/types/Task.d.ts +4 -4
  306. package/dist/cjs/api/types/Tier.d.ts +16 -16
  307. package/dist/cjs/api/types/TierGroup.d.ts +8 -8
  308. package/dist/cjs/api/types/Transaction.d.ts +15 -15
  309. package/dist/cjs/api/types/UpdateCampaignStatus.d.ts +2 -1
  310. package/dist/cjs/api/types/UpdateCampaignStatus.js +1 -0
  311. package/dist/cjs/api/types/ValueResponse.d.ts +8 -8
  312. package/dist/cjs/api/types/VariablesItems.d.ts +3 -3
  313. package/dist/cjs/api/types/index.d.ts +1 -0
  314. package/dist/cjs/api/types/index.js +1 -0
  315. package/dist/cjs/core/fetcher/Fetcher.js +8 -2
  316. package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
  317. package/dist/cjs/core/fetcher/makeRequest.js +30 -9
  318. package/dist/cjs/core/runtime/runtime.js +8 -7
  319. package/dist/cjs/version.d.ts +1 -1
  320. package/dist/cjs/version.js +1 -1
  321. package/dist/esm/BaseClient.mjs +2 -2
  322. package/dist/esm/api/resources/account/exports.d.mts +2 -0
  323. package/dist/esm/api/resources/account/exports.mjs +3 -0
  324. package/dist/esm/api/resources/account/types/GetAccountActivityResponse.d.mts +1 -1
  325. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +7 -7
  326. package/dist/esm/api/resources/balance/client/Client.d.mts +2 -2
  327. package/dist/esm/api/resources/balance/client/Client.mjs +6 -6
  328. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +5 -5
  329. package/dist/esm/api/resources/balance/exports.d.mts +2 -0
  330. package/dist/esm/api/resources/balance/exports.mjs +3 -0
  331. package/dist/esm/api/resources/balance/types/CreateBalanceOrderResponse.d.mts +6 -6
  332. package/dist/esm/api/resources/balance/types/GetBalanceDefinitionListResponse.d.mts +1 -1
  333. package/dist/esm/api/resources/balance/types/GetContactBalancesResponse.d.mts +8 -8
  334. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +15 -15
  335. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +3 -3
  336. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +9 -9
  337. package/dist/esm/api/resources/balance/types/index.d.mts +0 -1
  338. package/dist/esm/api/resources/balance/types/index.mjs +0 -1
  339. package/dist/esm/api/resources/companies/client/Client.d.mts +28 -0
  340. package/dist/esm/api/resources/companies/client/Client.mjs +107 -0
  341. package/dist/esm/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.d.mts +10 -0
  342. package/dist/esm/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.mjs +2 -0
  343. package/dist/esm/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.d.mts +33 -0
  344. package/dist/esm/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.mjs +9 -0
  345. package/dist/esm/api/resources/companies/client/requests/index.d.mts +2 -0
  346. package/dist/esm/api/resources/companies/client/requests/index.mjs +1 -0
  347. package/dist/esm/api/resources/companies/exports.d.mts +2 -0
  348. package/dist/esm/api/resources/companies/exports.mjs +3 -0
  349. package/dist/esm/api/resources/companies/types/GetCompaniesResponse.d.mts +1 -1
  350. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +5 -5
  351. package/dist/esm/api/resources/companies/types/PostCompaniesImportResponse.d.mts +1 -1
  352. package/dist/esm/api/resources/contacts/client/Client.d.mts +15 -45
  353. package/dist/esm/api/resources/contacts/client/Client.mjs +15 -45
  354. package/dist/esm/api/resources/contacts/client/requests/AddContactToListRequest.d.mts +0 -24
  355. package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +4 -4
  356. package/dist/esm/api/resources/contacts/client/requests/RemoveContactFromListRequest.d.mts +0 -32
  357. package/dist/esm/api/resources/contacts/client/requests/RequestContactExportRequest.d.mts +7 -7
  358. package/dist/esm/api/resources/contacts/client/requests/UpdateBatchContactsRequest.d.mts +10 -10
  359. package/dist/esm/api/resources/contacts/exports.d.mts +2 -0
  360. package/dist/esm/api/resources/contacts/exports.mjs +3 -0
  361. package/dist/esm/api/resources/contacts/types/CreateContactResponse.d.mts +1 -1
  362. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +4 -4
  363. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +13 -13
  364. package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +11 -11
  365. package/dist/esm/api/resources/contacts/types/GetFolderListsResponse.d.mts +2 -2
  366. package/dist/esm/api/resources/contacts/types/GetFoldersResponse.d.mts +2 -2
  367. package/dist/esm/api/resources/contacts/types/GetListResponse.d.mts +2 -2
  368. package/dist/esm/api/resources/contacts/types/GetListsResponse.d.mts +2 -2
  369. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +3 -3
  370. package/dist/esm/api/resources/conversations/exports.d.mts +2 -0
  371. package/dist/esm/api/resources/conversations/exports.mjs +3 -0
  372. package/dist/esm/api/resources/conversations/types/PutConversationsVisitorGroupResponse.d.mts +2 -2
  373. package/dist/esm/api/resources/coupons/exports.d.mts +2 -0
  374. package/dist/esm/api/resources/coupons/exports.mjs +3 -0
  375. package/dist/esm/api/resources/customObjects/client/Client.d.mts +6 -14
  376. package/dist/esm/api/resources/customObjects/client/Client.mjs +6 -14
  377. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +6 -6
  378. package/dist/esm/api/resources/customObjects/exports.d.mts +2 -0
  379. package/dist/esm/api/resources/customObjects/exports.mjs +3 -0
  380. package/dist/esm/api/resources/customObjects/types/BatchDeleteObjectRecordsResponse.d.mts +2 -2
  381. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +9 -9
  382. package/dist/esm/api/resources/customObjects/types/UpsertrecordsResponse.d.mts +3 -3
  383. package/dist/esm/api/resources/deals/client/Client.d.mts +2 -0
  384. package/dist/esm/api/resources/deals/client/Client.mjs +2 -0
  385. package/dist/esm/api/resources/deals/exports.d.mts +2 -0
  386. package/dist/esm/api/resources/deals/exports.mjs +3 -0
  387. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +5 -5
  388. package/dist/esm/api/resources/deals/types/GetCrmDealsResponse.d.mts +1 -1
  389. package/dist/esm/api/resources/deals/types/PostCrmDealsImportResponse.d.mts +1 -1
  390. package/dist/esm/api/resources/domains/client/requests/AuthenticateDomainRequest.d.mts +0 -5
  391. package/dist/esm/api/resources/domains/client/requests/CreateDomainRequest.d.mts +0 -10
  392. package/dist/esm/api/resources/domains/client/requests/GetDomainConfigurationRequest.d.mts +0 -5
  393. package/dist/esm/api/resources/domains/exports.d.mts +2 -0
  394. package/dist/esm/api/resources/domains/exports.mjs +3 -0
  395. package/dist/esm/api/resources/domains/types/CreateDomainResponse.d.mts +2 -2
  396. package/dist/esm/api/resources/domains/types/GetDomainsResponse.d.mts +1 -1
  397. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +2 -4
  398. package/dist/esm/api/resources/ecommerce/client/Client.mjs +2 -4
  399. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +1 -2
  400. package/dist/esm/api/resources/ecommerce/client/requests/CreateProductAlertRequest.d.mts +3 -3
  401. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchCategoryRequest.d.mts +4 -4
  402. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +10 -10
  403. package/dist/esm/api/resources/ecommerce/exports.d.mts +2 -0
  404. package/dist/esm/api/resources/ecommerce/exports.mjs +3 -0
  405. package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +1 -1
  406. package/dist/esm/api/resources/ecommerce/types/CreateUpdateBatchCategoryResponse.d.mts +2 -2
  407. package/dist/esm/api/resources/ecommerce/types/CreateUpdateBatchProductsResponse.d.mts +2 -2
  408. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  409. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +1 -1
  410. package/dist/esm/api/resources/ecommerce/types/GetEcommerceAttributionProductsConversionSourceConversionSourceIdResponse.d.mts +7 -7
  411. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +2 -5
  412. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +4 -6
  413. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +9 -9
  414. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +2 -0
  415. package/dist/esm/api/resources/emailCampaigns/client/requests/UpdateEmailCampaignRequest.d.mts +9 -9
  416. package/dist/esm/api/resources/emailCampaigns/exports.d.mts +2 -0
  417. package/dist/esm/api/resources/emailCampaigns/exports.mjs +3 -0
  418. package/dist/esm/api/resources/emailCampaigns/types/GetAbTestCampaignResultResponse.d.mts +8 -8
  419. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +32 -25
  420. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +3 -0
  421. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.d.mts +2 -0
  422. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.mjs +2 -0
  423. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +34 -27
  424. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +3 -0
  425. package/dist/esm/api/resources/emailCampaigns/types/UploadImageToGalleryResponse.d.mts +1 -1
  426. package/dist/esm/api/resources/event/client/Client.d.mts +17 -0
  427. package/dist/esm/api/resources/event/client/Client.mjs +57 -0
  428. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +10 -10
  429. package/dist/esm/api/resources/event/exports.d.mts +2 -0
  430. package/dist/esm/api/resources/event/exports.mjs +3 -0
  431. package/dist/esm/api/resources/event/index.d.mts +1 -0
  432. package/dist/esm/api/resources/event/index.mjs +1 -0
  433. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +59 -0
  434. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.mjs +2 -0
  435. package/dist/esm/api/resources/event/types/index.d.mts +1 -0
  436. package/dist/esm/api/resources/event/types/index.mjs +1 -0
  437. package/dist/esm/api/resources/externalFeeds/client/requests/GetExternalFeedByUuidRequest.d.mts +0 -10
  438. package/dist/esm/api/resources/externalFeeds/exports.d.mts +2 -0
  439. package/dist/esm/api/resources/externalFeeds/exports.mjs +3 -0
  440. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +4 -4
  441. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +4 -4
  442. package/dist/esm/api/resources/files/exports.d.mts +2 -0
  443. package/dist/esm/api/resources/files/exports.mjs +3 -0
  444. package/dist/esm/api/resources/files/types/GetCrmFilesIdResponse.d.mts +1 -1
  445. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +1 -0
  446. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +1 -0
  447. package/dist/esm/api/resources/inboundParsing/exports.d.mts +2 -0
  448. package/dist/esm/api/resources/inboundParsing/exports.mjs +3 -0
  449. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +14 -14
  450. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsResponse.d.mts +1 -1
  451. package/dist/esm/api/resources/index.d.mts +1 -0
  452. package/dist/esm/api/resources/index.mjs +1 -0
  453. package/dist/esm/api/resources/masterAccount/client/requests/InviteAdminUserRequest.d.mts +2 -2
  454. package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateSubAccountIdPlanRequest.d.mts +9 -9
  455. package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateSubAccountsPlanRequest.d.mts +8 -8
  456. package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateUserEmailPermissionsRequest.d.mts +2 -2
  457. package/dist/esm/api/resources/masterAccount/exports.d.mts +2 -0
  458. package/dist/esm/api/resources/masterAccount/exports.mjs +3 -0
  459. package/dist/esm/api/resources/masterAccount/types/GetCorporateGroupIdResponse.d.mts +12 -12
  460. package/dist/esm/api/resources/masterAccount/types/GetCorporateInvitedUsersListResponse.d.mts +11 -11
  461. package/dist/esm/api/resources/masterAccount/types/GetCorporateIpResponseItem.d.mts +3 -3
  462. package/dist/esm/api/resources/masterAccount/types/GetCorporateMasterAccountResponse.d.mts +31 -31
  463. package/dist/esm/api/resources/masterAccount/types/GetCorporateSubAccountIdResponse.d.mts +37 -37
  464. package/dist/esm/api/resources/masterAccount/types/GetCorporateSubAccountResponse.d.mts +4 -4
  465. package/dist/esm/api/resources/masterAccount/types/GetCorporateUserPermissionResponse.d.mts +10 -10
  466. package/dist/esm/api/resources/masterAccount/types/GetSubAccountGroupsResponseItem.d.mts +2 -2
  467. package/dist/esm/api/resources/masterAccount/types/InviteAdminUserResponse.d.mts +1 -1
  468. package/dist/esm/api/resources/masterAccount/types/PostCorporateGroupResponse.d.mts +1 -1
  469. package/dist/esm/api/resources/masterAccount/types/PutCorporateUserInvitationActionEmailResponse.d.mts +1 -1
  470. package/dist/esm/api/resources/notes/exports.d.mts +2 -0
  471. package/dist/esm/api/resources/notes/exports.mjs +3 -0
  472. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  473. package/dist/esm/api/resources/payments/exports.d.mts +2 -0
  474. package/dist/esm/api/resources/payments/exports.mjs +3 -0
  475. package/dist/esm/api/resources/payments/types/CreatePaymentRequestResponse.d.mts +1 -1
  476. package/dist/esm/api/resources/payments/types/GetPaymentRequestResponse.d.mts +3 -3
  477. package/dist/esm/api/resources/process/client/requests/GetProcessRequest.d.mts +0 -15
  478. package/dist/esm/api/resources/process/exports.d.mts +2 -0
  479. package/dist/esm/api/resources/process/exports.mjs +3 -0
  480. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +16 -16
  481. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +16 -16
  482. package/dist/esm/api/resources/program/client/Client.d.mts +21 -0
  483. package/dist/esm/api/resources/program/client/Client.mjs +67 -0
  484. package/dist/esm/api/resources/program/client/requests/DeleteContactSubscriptionRequest.d.mts +13 -0
  485. package/dist/esm/api/resources/program/client/requests/DeleteContactSubscriptionRequest.mjs +2 -0
  486. package/dist/esm/api/resources/program/client/requests/index.d.mts +1 -0
  487. package/dist/esm/api/resources/program/exports.d.mts +2 -0
  488. package/dist/esm/api/resources/program/exports.mjs +3 -0
  489. package/dist/esm/api/resources/program/types/GetLpListResponse.d.mts +1 -1
  490. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +28 -28
  491. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +5 -5
  492. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +7 -7
  493. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +26 -26
  494. package/dist/esm/api/resources/reward/exports.d.mts +2 -0
  495. package/dist/esm/api/resources/reward/exports.mjs +3 -0
  496. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +8 -8
  497. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +11 -11
  498. package/dist/esm/api/resources/reward/types/GetCodeCountResponse.d.mts +1 -1
  499. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidOffersResponse.d.mts +11 -11
  500. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidRewardsRidResponse.d.mts +81 -81
  501. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +15 -15
  502. package/dist/esm/api/resources/reward/types/ValidateRewardResponse.d.mts +1 -1
  503. package/dist/esm/api/resources/senders/client/requests/CreateSenderRequest.d.mts +1 -13
  504. package/dist/esm/api/resources/senders/client/requests/GetIpsFromSenderRequest.d.mts +0 -5
  505. package/dist/esm/api/resources/senders/client/requests/GetSendersRequest.d.mts +0 -3
  506. package/dist/esm/api/resources/senders/client/requests/UpdateSenderRequest.d.mts +1 -1
  507. package/dist/esm/api/resources/senders/exports.d.mts +2 -0
  508. package/dist/esm/api/resources/senders/exports.mjs +3 -0
  509. package/dist/esm/api/resources/senders/types/CreateSenderResponse.d.mts +2 -2
  510. package/dist/esm/api/resources/senders/types/GetSendersResponse.d.mts +1 -1
  511. package/dist/esm/api/resources/smsCampaigns/client/requests/CreateSmsCampaignRequest.d.mts +1 -1
  512. package/dist/esm/api/resources/smsCampaigns/client/requests/UpdateSmsCampaignRequest.d.mts +1 -1
  513. package/dist/esm/api/resources/smsCampaigns/exports.d.mts +2 -0
  514. package/dist/esm/api/resources/smsCampaigns/exports.mjs +3 -0
  515. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +1 -1
  516. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +3 -3
  517. package/dist/esm/api/resources/smsTemplates/exports.d.mts +2 -0
  518. package/dist/esm/api/resources/smsTemplates/exports.mjs +3 -0
  519. package/dist/esm/api/resources/smsTemplates/types/GetSmsTemplatesResponse.d.mts +17 -17
  520. package/dist/esm/api/resources/tasks/exports.d.mts +2 -0
  521. package/dist/esm/api/resources/tasks/exports.mjs +3 -0
  522. package/dist/esm/api/resources/tasks/types/GetCrmTasksResponse.d.mts +1 -1
  523. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponse.d.mts +2 -2
  524. package/dist/esm/api/resources/tier/client/Client.d.mts +2 -2
  525. package/dist/esm/api/resources/tier/client/Client.mjs +2 -2
  526. package/dist/esm/api/resources/tier/client/requests/CreateTierForTierGroupRequest.d.mts +3 -3
  527. package/dist/esm/api/resources/tier/client/requests/UpdateTierRequest.d.mts +3 -3
  528. package/dist/esm/api/resources/tier/exports.d.mts +2 -0
  529. package/dist/esm/api/resources/tier/exports.mjs +3 -0
  530. package/dist/esm/api/resources/tier/types/AddSubscriptionToTierResponse.d.mts +7 -7
  531. package/dist/esm/api/resources/tier/types/GetListOfTierGroupsResponse.d.mts +1 -1
  532. package/dist/esm/api/resources/tier/types/GetLoyaltyProgramTierResponse.d.mts +1 -1
  533. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +2 -6
  534. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +2 -6
  535. package/dist/esm/api/resources/transactionalEmails/client/requests/CreateSmtpTemplateRequest.d.mts +3 -3
  536. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +0 -7
  537. package/dist/esm/api/resources/transactionalEmails/client/requests/SendTransacEmailRequest.d.mts +21 -21
  538. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -3
  539. package/dist/esm/api/resources/transactionalEmails/exports.d.mts +2 -0
  540. package/dist/esm/api/resources/transactionalEmails/exports.mjs +3 -0
  541. package/dist/esm/api/resources/transactionalEmails/types/GetAggregatedSmtpReportResponse.d.mts +13 -13
  542. package/dist/esm/api/resources/transactionalEmails/types/GetEmailEventReportResponse.d.mts +8 -8
  543. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpReportResponse.d.mts +1 -1
  544. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplatesResponse.d.mts +2 -2
  545. package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +4 -4
  546. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +1 -1
  547. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailsListResponse.d.mts +5 -5
  548. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesResponse.d.mts +6 -6
  549. package/dist/esm/api/resources/transactionalEmails/types/SendTransacEmailResponse.d.mts +2 -2
  550. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +5 -9
  551. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +5 -9
  552. package/dist/esm/api/resources/transactionalSms/exports.d.mts +2 -0
  553. package/dist/esm/api/resources/transactionalSms/exports.mjs +3 -0
  554. package/dist/esm/api/resources/transactionalSms/types/GetSmsEventsResponse.d.mts +8 -8
  555. package/dist/esm/api/resources/transactionalSms/types/GetTransacAggregatedSmsReportResponse.d.mts +11 -11
  556. package/dist/esm/api/resources/transactionalSms/types/GetTransacSmsReportResponse.d.mts +12 -12
  557. package/dist/esm/api/resources/transactionalSms/types/SendTransacSmsResponse.d.mts +3 -3
  558. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.d.mts +2 -1
  559. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +2 -1
  560. package/dist/esm/api/resources/transactionalWhatsApp/exports.d.mts +2 -0
  561. package/dist/esm/api/resources/transactionalWhatsApp/exports.mjs +3 -0
  562. package/dist/esm/api/resources/transactionalWhatsApp/types/GetWhatsappEventReportResponse.d.mts +4 -4
  563. package/dist/esm/api/resources/user/exports.d.mts +2 -0
  564. package/dist/esm/api/resources/user/exports.mjs +3 -0
  565. package/dist/esm/api/resources/user/types/EditUserPermissionResponse.d.mts +2 -2
  566. package/dist/esm/api/resources/user/types/GetInvitedUsersListResponse.d.mts +4 -4
  567. package/dist/esm/api/resources/user/types/InviteuserResponse.d.mts +1 -1
  568. package/dist/esm/api/resources/user/types/PutRevokeUserPermissionResponse.d.mts +1 -1
  569. package/dist/esm/api/resources/user/types/PutresendcancelinvitationResponse.d.mts +1 -1
  570. package/dist/esm/api/resources/webhooks/client/Client.d.mts +7 -13
  571. package/dist/esm/api/resources/webhooks/client/Client.mjs +7 -13
  572. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +6 -4
  573. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +1 -0
  574. package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.mts +6 -4
  575. package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.mjs +1 -0
  576. package/dist/esm/api/resources/webhooks/exports.d.mts +2 -0
  577. package/dist/esm/api/resources/webhooks/exports.mjs +3 -0
  578. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +19 -44
  579. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +19 -44
  580. package/dist/esm/api/resources/whatsAppCampaigns/client/requests/CreateWhatsAppCampaignRequest.d.mts +3 -3
  581. package/dist/esm/api/resources/whatsAppCampaigns/client/requests/UpdateWhatsAppCampaignRequest.d.mts +3 -3
  582. package/dist/esm/api/resources/whatsAppCampaigns/exports.d.mts +2 -0
  583. package/dist/esm/api/resources/whatsAppCampaigns/exports.mjs +3 -0
  584. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -15
  585. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignsResponse.d.mts +6 -6
  586. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppConfigResponse.d.mts +6 -6
  587. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +3 -3
  588. package/dist/esm/api/types/BalanceDefinition.d.mts +20 -20
  589. package/dist/esm/api/types/BalanceLimit.d.mts +8 -8
  590. package/dist/esm/api/types/BatchEventsResponse.d.mts +26 -0
  591. package/dist/esm/api/types/BatchEventsResponse.mjs +2 -0
  592. package/dist/esm/api/types/Company.d.mts +4 -4
  593. package/dist/esm/api/types/ContactErrorModel.d.mts +1 -1
  594. package/dist/esm/api/types/ConversationsMessage.d.mts +53 -53
  595. package/dist/esm/api/types/CreateUpdateFolder.d.mts +1 -1
  596. package/dist/esm/api/types/Deal.d.mts +4 -4
  597. package/dist/esm/api/types/ErrorModel.d.mts +1 -1
  598. package/dist/esm/api/types/FileData.d.mts +7 -7
  599. package/dist/esm/api/types/GetCampaignStats.d.mts +7 -7
  600. package/dist/esm/api/types/GetCategoryDetails.d.mts +1 -1
  601. package/dist/esm/api/types/GetContactDetails.d.mts +2 -2
  602. package/dist/esm/api/types/GetCouponCollection.d.mts +3 -3
  603. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +32 -25
  604. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +3 -0
  605. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +4 -4
  606. package/dist/esm/api/types/GetProductDetails.d.mts +10 -10
  607. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +1 -1
  608. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +4 -4
  609. package/dist/esm/api/types/GetWebhook.d.mts +4 -4
  610. package/dist/esm/api/types/Inviteuser.d.mts +2 -2
  611. package/dist/esm/api/types/LoyaltyProgram.d.mts +12 -12
  612. package/dist/esm/api/types/NodeResponse.d.mts +8 -8
  613. package/dist/esm/api/types/Note.d.mts +6 -6
  614. package/dist/esm/api/types/NoteData.d.mts +3 -3
  615. package/dist/esm/api/types/Order.d.mts +30 -20
  616. package/dist/esm/api/types/Pipeline.d.mts +5 -5
  617. package/dist/esm/api/types/PostContactInfo.d.mts +4 -4
  618. package/dist/esm/api/types/PostSendFailed.d.mts +3 -3
  619. package/dist/esm/api/types/Redeem.d.mts +14 -14
  620. package/dist/esm/api/types/RuleConditionResponse.d.mts +5 -5
  621. package/dist/esm/api/types/SendReport.d.mts +1 -1
  622. package/dist/esm/api/types/SendTestEmail.d.mts +1 -1
  623. package/dist/esm/api/types/SendTransacSms.d.mts +10 -6
  624. package/dist/esm/api/types/Task.d.mts +4 -4
  625. package/dist/esm/api/types/Tier.d.mts +16 -16
  626. package/dist/esm/api/types/TierGroup.d.mts +8 -8
  627. package/dist/esm/api/types/Transaction.d.mts +15 -15
  628. package/dist/esm/api/types/UpdateCampaignStatus.d.mts +2 -1
  629. package/dist/esm/api/types/UpdateCampaignStatus.mjs +1 -0
  630. package/dist/esm/api/types/ValueResponse.d.mts +8 -8
  631. package/dist/esm/api/types/VariablesItems.d.mts +3 -3
  632. package/dist/esm/api/types/index.d.mts +1 -0
  633. package/dist/esm/api/types/index.mjs +1 -0
  634. package/dist/esm/core/fetcher/Fetcher.mjs +8 -2
  635. package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
  636. package/dist/esm/core/fetcher/makeRequest.mjs +28 -9
  637. package/dist/esm/core/runtime/runtime.mjs +8 -7
  638. package/dist/esm/version.d.mts +1 -1
  639. package/dist/esm/version.mjs +1 -1
  640. package/package.json +356 -4
  641. package/reference.md +297 -157
  642. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.d.ts +0 -6
  643. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.js +0 -9
  644. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.d.mts +0 -6
  645. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.mjs +0 -6
package/reference.md CHANGED
@@ -3638,22 +3638,16 @@ await client.webhooks.createWebhook({
3638
3638
  <dl>
3639
3639
  <dd>
3640
3640
 
3641
- <Note title="This feature is available for Professional and Enterprise plans">
3642
- To have it activated please send us a request and we will activate it for your account.
3641
+ <Note>
3642
+ This is an enterprise feature. Contact us to activate it for your account.
3643
3643
  </Note>
3644
3644
 
3645
- Exports webhook event history to CSV format for analysis and reporting.
3646
-
3647
- Use this to:
3648
- - Generate comprehensive webhook event reports
3649
- - Analyze webhook delivery patterns and success rates
3650
- - Export event data for external analysis tools
3651
- - Create historical reports for compliance and auditing
3652
- - Track webhook performance and reliability metrics
3645
+ Submits a request to export webhook event history as a CSV file. The download link is sent to the `notifyURL` you provide in the request body.
3653
3646
 
3654
- Key information returned:
3655
- - Process ID for tracking export completion
3656
- - CSV file will be delivered to specified webhook URL
3647
+ Use this endpoint to:
3648
+ - Export webhook event history filtered by date range, event type, or email address
3649
+ - Generate reports for compliance, auditing, or performance analysis
3650
+ - Track delivery patterns and webhook reliability over time
3657
3651
  </dd>
3658
3652
  </dl>
3659
3653
  </dd>
@@ -4381,12 +4375,8 @@ await client.externalFeeds.deleteExternalFeed({
4381
4375
  <dl>
4382
4376
  <dd>
4383
4377
 
4384
- <Note title="Enterprise access only">
4385
- Custom objects are only available to Enterprise plans.
4386
-
4387
- This feature is in beta. These are subject to change.
4388
- </Note>
4389
-
4378
+ <Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
4379
+ This feature is in beta. These are subject to change.</Note>
4390
4380
  This API allows bulk upsert of object records in a single request. Each object record may include
4391
4381
  - Attributes
4392
4382
  - Identifiers
@@ -4400,8 +4390,8 @@ This API allows bulk upsert of object records in a single request. Each object r
4400
4390
  - Max 500 attributes defined per object record upsert request
4401
4391
  - This is coherent with schema limitation: an object cannot have more than 500 attributes.
4402
4392
  - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
4403
- - Max 10 associations defined per object record upsert request
4404
- - This is coherent with schema limitation: an object cannot have more than 10 associations with other objects. and each object record can be linked to max 10 other records.
4393
+ - Max 10 associations defined per associated object type, in each record of the request
4394
+ - This is not a schema limitation. You can associate an object record to an unlimited number of other object records by running multiple requests.
4405
4395
  **Errors:**
4406
4396
  - Make sure both object records exist before associating them, else the API will return an error.
4407
4397
  - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
@@ -4470,12 +4460,8 @@ await client.customObjects.upsertrecords({
4470
4460
  <dl>
4471
4461
  <dd>
4472
4462
 
4473
- <Note title="Enterprise access only">
4474
- Custom objects are only available to Enterprise plans.
4475
-
4476
- This feature is in beta. These are subject to change.
4477
- </Note>
4478
-
4463
+ <Note title="Enterprise access only">Custom objects are only available to Enterprise plans.
4464
+ This feature is in beta. These are subject to change.</Note>
4479
4465
  This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.
4480
4466
  </dd>
4481
4467
  </dl>
@@ -4606,26 +4592,6 @@ await client.customObjects.batchDeleteObjectRecords({
4606
4592
  <dl>
4607
4593
  <dd>
4608
4594
 
4609
- #### 📝 Description
4610
-
4611
- <dl>
4612
- <dd>
4613
-
4614
- <dl>
4615
- <dd>
4616
-
4617
- <Note title="Follow this format when passing a SMS phone number as an attribute">
4618
- Accepted Number Formats
4619
-
4620
- 91xxxxxxxxxx
4621
- +91xxxxxxxxxx
4622
- 0091xxxxxxxxxx
4623
- </Note>
4624
- </dd>
4625
- </dl>
4626
- </dd>
4627
- </dl>
4628
-
4629
4595
  #### 🔌 Usage
4630
4596
 
4631
4597
  <dl>
@@ -4683,6 +4649,8 @@ await client.contacts.getContacts();
4683
4649
  <dl>
4684
4650
  <dd>
4685
4651
 
4652
+ <Note>Follow this format when passing a "SMS" phone number as an attribute.
4653
+ Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
4686
4654
  Creates new contacts on Brevo. Contacts can be created by passing either - <br><br> 1. email address of the contact (email_id), <br> 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} <br> 3. ext_id <br>
4687
4655
  </dd>
4688
4656
  </dl>
@@ -5045,9 +5013,7 @@ await client.contacts.updateBatchContacts();
5045
5013
  <dl>
5046
5014
  <dd>
5047
5015
 
5048
- <Note title="How to use attributes param?">
5049
- attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.
5050
- </Note>
5016
+ <Note title="How to use attributes param?">attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.</Note>
5051
5017
  </dd>
5052
5018
  </dl>
5053
5019
  </dd>
@@ -5180,17 +5146,11 @@ await client.contacts.requestContactExport({
5180
5146
  <dl>
5181
5147
  <dd>
5182
5148
 
5183
- <Note>
5184
- Ongoing changes for this endpoint
5185
-
5149
+ <Note>Ongoing changes for this endpoint
5186
5150
  We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
5187
-
5188
5151
  These are non breaking changes.
5189
-
5190
5152
  The default value for the attributes will be 0.
5191
-
5192
- The uniqueSubscribers field is deprecated
5193
- </Note>
5153
+ The uniqueSubscribers field is deprecated</Note>
5194
5154
  </dd>
5195
5155
  </dl>
5196
5156
  </dd>
@@ -5302,13 +5262,9 @@ await client.contacts.createFolder({});
5302
5262
  <dl>
5303
5263
  <dd>
5304
5264
 
5305
- <Note>
5306
- Ongoing changes for this endpoint.
5307
-
5265
+ <Note>Ongoing changes for this endpoint.
5308
5266
  We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
5309
-
5310
- These are non breaking changes. The default value for the attributes will be 0.
5311
- </Note>
5267
+ These are non breaking changes. The default value for the attributes will be 0.</Note>
5312
5268
  </dd>
5313
5269
  </dl>
5314
5270
  </dd>
@@ -5476,13 +5432,9 @@ await client.contacts.deleteFolder({
5476
5432
  <dl>
5477
5433
  <dd>
5478
5434
 
5479
- <Note>
5480
- Ongoing changes for this endpoint.
5481
-
5435
+ <Note>Ongoing changes for this endpoint.
5482
5436
  We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
5483
-
5484
- These are non breaking changes. The default value for the attributes will be 0.
5485
- </Note>
5437
+ These are non breaking changes. The default value for the attributes will be 0.</Note>
5486
5438
  </dd>
5487
5439
  </dl>
5488
5440
  </dd>
@@ -5610,13 +5562,9 @@ await client.contacts.importContacts();
5610
5562
  <dl>
5611
5563
  <dd>
5612
5564
 
5613
- <Note>
5614
- Ongoing changes for this endpoint.
5615
-
5565
+ <Note>Ongoing changes for this endpoint.
5616
5566
  We're dropping support for the response attributes totalSubscribers and totalBlacklisted.
5617
-
5618
- These are non breaking changes. The default value for the attributes will be 0.
5619
- </Note>
5567
+ These are non breaking changes. The default value for the attributes will be 0.</Note>
5620
5568
  </dd>
5621
5569
  </dl>
5622
5570
  </dd>
@@ -6092,14 +6040,8 @@ await client.contacts.getSegments();
6092
6040
  <dl>
6093
6041
  <dd>
6094
6042
 
6095
- <Note title="Follow this format when passing a SMS phone number as an attribute">
6096
- Accepted Number Formats
6097
-
6098
- 91xxxxxxxxxx
6099
- +91xxxxxxxxxx
6100
- 0091xxxxxxxxxx
6101
- </Note>
6102
-
6043
+ <Note>Follow this format when passing a "SMS" phone number as an attribute.
6044
+ Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
6103
6045
  There are 2 ways to get a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact. <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute <br><br>Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
6104
6046
  </dd>
6105
6047
  </dl>
@@ -6165,6 +6107,8 @@ await client.contacts.getContactInfo({
6165
6107
  <dl>
6166
6108
  <dd>
6167
6109
 
6110
+ <Note>Follow this format when passing a "SMS" phone number as an attribute.
6111
+ Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxx</Note>
6168
6112
  There are 2 ways to update a contact <br><br> Option 1- https://api.brevo.com/v3/contacts/{identifier} <br><br> Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} <br> <br> Option 1 only works if identifierType is email_id (for EMAIL) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL and ID of the contact. <br><br> Option 2 works for all identifierType, use email_id for EMAIL attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE attribute
6169
6113
  </dd>
6170
6114
  </dl>
@@ -7525,8 +7469,7 @@ await client.ecommerce.createOrder({
7525
7469
  id: "14",
7526
7470
  products: [{
7527
7471
  price: 99.99,
7528
- productId: "P1",
7529
- quantity: 10
7472
+ productId: "P1"
7530
7473
  }],
7531
7474
  status: "completed",
7532
7475
  updatedAt: "2021-07-30T10:59:23.383Z"
@@ -7600,8 +7543,7 @@ await client.ecommerce.createBatchOrder({
7600
7543
  id: "14",
7601
7544
  products: [{
7602
7545
  price: 99.99,
7603
- productId: "P1",
7604
- quantity: 10
7546
+ productId: "P1"
7605
7547
  }],
7606
7548
  status: "completed",
7607
7549
  updatedAt: "2021-07-30T10:59:23.383Z"
@@ -8378,6 +8320,72 @@ await client.event.createEvent({
8378
8320
  </dl>
8379
8321
 
8380
8322
 
8323
+ </dd>
8324
+ </dl>
8325
+ </details>
8326
+
8327
+ <details><summary><code>client.event.<a href="/src/api/resources/event/client/Client.ts">createBatchEvents</a>({ ...params }) -> void</code></summary>
8328
+ <dl>
8329
+ <dd>
8330
+
8331
+ #### 📝 Description
8332
+
8333
+ <dl>
8334
+ <dd>
8335
+
8336
+ <dl>
8337
+ <dd>
8338
+
8339
+ Create multiple events to track contacts' interactions in a single request.
8340
+ </dd>
8341
+ </dl>
8342
+ </dd>
8343
+ </dl>
8344
+
8345
+ #### 🔌 Usage
8346
+
8347
+ <dl>
8348
+ <dd>
8349
+
8350
+ <dl>
8351
+ <dd>
8352
+
8353
+ ```typescript
8354
+ await client.event.createBatchEvents([{
8355
+ event_name: "order_created",
8356
+ identifiers: {}
8357
+ }]);
8358
+
8359
+ ```
8360
+ </dd>
8361
+ </dl>
8362
+ </dd>
8363
+ </dl>
8364
+
8365
+ #### ⚙️ Parameters
8366
+
8367
+ <dl>
8368
+ <dd>
8369
+
8370
+ <dl>
8371
+ <dd>
8372
+
8373
+ **request:** `Brevo.CreateBatchEventsRequestItem[]`
8374
+
8375
+ </dd>
8376
+ </dl>
8377
+
8378
+ <dl>
8379
+ <dd>
8380
+
8381
+ **requestOptions:** `EventClient.RequestOptions`
8382
+
8383
+ </dd>
8384
+ </dl>
8385
+ </dd>
8386
+ </dl>
8387
+
8388
+
8381
8389
  </dd>
8382
8390
  </dl>
8383
8391
  </details>
@@ -9550,8 +9558,8 @@ Returns transaction history
9550
9558
  ```typescript
9551
9559
  await client.balance.getTransactionHistoryApi({
9552
9560
  pid: "pid",
9553
- contact_id: 1,
9554
- balance_definition_id: "balance_definition_id"
9561
+ contactId: 1,
9562
+ balanceDefinitionId: "balanceDefinitionId"
9555
9563
  });
9556
9564
 
9557
9565
  ```
@@ -10238,6 +10246,72 @@ await client.program.getParameterSubscriptionInfo({
10238
10246
  </dl>
10239
10247
 
10240
10248
 
10249
+ </dd>
10250
+ </dl>
10251
+ </details>
10252
+
10253
+ <details><summary><code>client.program.<a href="/src/api/resources/program/client/Client.ts">deleteContactSubscription</a>({ ...params }) -> void</code></summary>
10254
+ <dl>
10255
+ <dd>
10256
+
10257
+ #### 📝 Description
10258
+
10259
+ <dl>
10260
+ <dd>
10261
+
10262
+ <dl>
10263
+ <dd>
10264
+
10265
+ Delete subscription for a contact
10266
+ </dd>
10267
+ </dl>
10268
+ </dd>
10269
+ </dl>
10270
+
10271
+ #### 🔌 Usage
10272
+
10273
+ <dl>
10274
+ <dd>
10275
+
10276
+ <dl>
10277
+ <dd>
10278
+
10279
+ ```typescript
10280
+ await client.program.deleteContactSubscription({
10281
+ pid: "pid",
10282
+ cid: 1
10283
+ });
10284
+
10285
+ ```
10286
+ </dd>
10287
+ </dl>
10288
+ </dd>
10289
+ </dl>
10290
+
10291
+ #### ⚙️ Parameters
10292
+
10293
+ <dl>
10294
+ <dd>
10295
+
10296
+ <dl>
10297
+ <dd>
10298
+
10299
+ **request:** `Brevo.DeleteContactSubscriptionRequest`
10300
+
10301
+ </dd>
10302
+ </dl>
10303
+
10304
+ <dl>
10305
+ <dd>
10306
+
10307
+ **requestOptions:** `ProgramClient.RequestOptions`
10308
+
10309
+ </dd>
10310
+ </dl>
10311
+ </dd>
10312
+ </dl>
10313
+
10314
+
10241
10315
  </dd>
10242
10316
  </dl>
10243
10317
  </details>
@@ -11497,7 +11571,7 @@ await client.tier.updateTierGroup({
11497
11571
  </dl>
11498
11572
  </details>
11499
11573
 
11500
- <details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTierGroup</a>({ ...params }) -> string</code></summary>
11574
+ <details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTierGroup</a>({ ...params }) -> void</code></summary>
11501
11575
  <dl>
11502
11576
  <dd>
11503
11577
 
@@ -11765,7 +11839,7 @@ await client.tier.updateTier({
11765
11839
  </dl>
11766
11840
  </details>
11767
11841
 
11768
- <details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTier</a>({ ...params }) -> string</code></summary>
11842
+ <details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTier</a>({ ...params }) -> void</code></summary>
11769
11843
  <dl>
11770
11844
  <dd>
11771
11845
 
@@ -11844,11 +11918,8 @@ await client.tier.deleteTier({
11844
11918
  <dl>
11845
11919
  <dd>
11846
11920
 
11847
- <Note>
11848
- The response payload for this endpoint has changed
11849
-
11850
- You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).
11851
- </Note>
11921
+ <Note>The response payload for this endpoint has changed
11922
+ You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).</Note>
11852
11923
  </dd>
11853
11924
  </dl>
11854
11925
  </dd>
@@ -13172,19 +13243,11 @@ await client.whatsAppCampaigns.getWhatsAppCampaigns();
13172
13243
  <dl>
13173
13244
  <dd>
13174
13245
 
13175
- <Note>
13176
- You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13177
-
13178
- [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
13179
- </Note>
13180
-
13181
- <Note>
13182
- This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
13183
-
13246
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13247
+ [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
13248
+ <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
13184
13249
  [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
13185
-
13186
- [Get all the Segments](https://developers.brevo.com/reference/getsegments)
13187
- </Note>
13250
+ [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
13188
13251
  </dd>
13189
13252
  </dl>
13190
13253
  </dd>
@@ -13252,11 +13315,8 @@ await client.whatsAppCampaigns.createWhatsAppCampaign({
13252
13315
  <dl>
13253
13316
  <dd>
13254
13317
 
13255
- <Note>
13256
- You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13257
-
13258
- [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
13259
- </Note>
13318
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13319
+ [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
13260
13320
  </dd>
13261
13321
  </dl>
13262
13322
  </dd>
@@ -13311,11 +13371,8 @@ await client.whatsAppCampaigns.getWhatsAppConfig();
13311
13371
  <dl>
13312
13372
  <dd>
13313
13373
 
13314
- <Note>
13315
- You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13316
-
13317
- [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
13318
- </Note>
13374
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13375
+ [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
13319
13376
  </dd>
13320
13377
  </dl>
13321
13378
  </dd>
@@ -13432,11 +13489,8 @@ await client.whatsAppCampaigns.getWhatsAppTemplates();
13432
13489
  <dl>
13433
13490
  <dd>
13434
13491
 
13435
- <Note>
13436
- You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13437
-
13438
- [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
13439
- </Note>
13492
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13493
+ [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
13440
13494
  </dd>
13441
13495
  </dl>
13442
13496
  </dd>
@@ -13501,11 +13555,11 @@ await client.whatsAppCampaigns.sendWhatsAppTemplateApproval({
13501
13555
  <dl>
13502
13556
  <dd>
13503
13557
 
13504
- <Note>
13505
- You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13506
-
13507
- [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
13508
- </Note>
13558
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13559
+ [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
13560
+ <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
13561
+ [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
13562
+ [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
13509
13563
  </dd>
13510
13564
  </dl>
13511
13565
  </dd>
@@ -13570,19 +13624,11 @@ await client.whatsAppCampaigns.getWhatsAppCampaign({
13570
13624
  <dl>
13571
13625
  <dd>
13572
13626
 
13573
- <Note>
13574
- You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13575
-
13576
- [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
13577
- </Note>
13578
-
13579
- <Note>
13580
- This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
13581
-
13627
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
13628
+ [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
13629
+ <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
13582
13630
  [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
13583
-
13584
- [Get all the Segments](https://developers.brevo.com/reference/getsegments)
13585
- </Note>
13631
+ [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
13586
13632
  </dd>
13587
13633
  </dl>
13588
13634
  </dd>
@@ -14103,6 +14149,108 @@ await client.companies.createACompanyDealAttribute({
14103
14149
  </dl>
14104
14150
 
14105
14151
 
14152
+ </dd>
14153
+ </dl>
14154
+ </details>
14155
+
14156
+ <details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteAnAttribute</a>({ ...params }) -> void</code></summary>
14157
+ <dl>
14158
+ <dd>
14159
+
14160
+ #### 🔌 Usage
14161
+
14162
+ <dl>
14163
+ <dd>
14164
+
14165
+ <dl>
14166
+ <dd>
14167
+
14168
+ ```typescript
14169
+ await client.companies.deleteAnAttribute({
14170
+ id: "id"
14171
+ });
14172
+
14173
+ ```
14174
+ </dd>
14175
+ </dl>
14176
+ </dd>
14177
+ </dl>
14178
+
14179
+ #### ⚙️ Parameters
14180
+
14181
+ <dl>
14182
+ <dd>
14183
+
14184
+ <dl>
14185
+ <dd>
14186
+
14187
+ **request:** `Brevo.DeleteCrmAttributesIdRequest`
14188
+
14189
+ </dd>
14190
+ </dl>
14191
+
14192
+ <dl>
14193
+ <dd>
14194
+
14195
+ **requestOptions:** `CompaniesClient.RequestOptions`
14196
+
14197
+ </dd>
14198
+ </dl>
14199
+ </dd>
14200
+ </dl>
14201
+
14202
+
14203
+ </dd>
14204
+ </dl>
14205
+ </details>
14206
+
14207
+ <details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">updateAnAttribute</a>({ ...params }) -> void</code></summary>
14208
+ <dl>
14209
+ <dd>
14210
+
14211
+ #### 🔌 Usage
14212
+
14213
+ <dl>
14214
+ <dd>
14215
+
14216
+ <dl>
14217
+ <dd>
14218
+
14219
+ ```typescript
14220
+ await client.companies.updateAnAttribute({
14221
+ id: "id"
14222
+ });
14223
+
14224
+ ```
14225
+ </dd>
14226
+ </dl>
14227
+ </dd>
14228
+ </dl>
14229
+
14230
+ #### ⚙️ Parameters
14231
+
14232
+ <dl>
14233
+ <dd>
14234
+
14235
+ <dl>
14236
+ <dd>
14237
+
14238
+ **request:** `Brevo.PatchCrmAttributesIdRequest`
14239
+
14240
+ </dd>
14241
+ </dl>
14242
+
14243
+ <dl>
14244
+ <dd>
14245
+
14246
+ **requestOptions:** `CompaniesClient.RequestOptions`
14247
+
14248
+ </dd>
14249
+ </dl>
14250
+ </dd>
14251
+ </dl>
14252
+
14253
+
14106
14254
  </dd>
14107
14255
  </dl>
14108
14256
  </details>
@@ -15527,7 +15675,8 @@ await client.tasks.getAllTaskTypes();
15527
15675
  <dl>
15528
15676
  <dd>
15529
15677
 
15530
- <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below. [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
15678
+ <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
15679
+ [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
15531
15680
  This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**)
15532
15681
  </dd>
15533
15682
  </dl>
@@ -16262,13 +16411,9 @@ await client.transactionalEmails.getTransacEmailsList();
16262
16411
  <dl>
16263
16412
  <dd>
16264
16413
 
16265
- <Note title="How to get uuid?">
16266
- You can get the uuid using either of the following methods:
16267
-
16414
+ <Note title="How to get uuid">You can get the uuid using either of the following methods:
16268
16415
  Send a GET request to https://api.brevo.com/v3/smtp/emails and pass the message_id in the url. Use your api-key to authenticate the request and you will get your uuid as a response.
16269
-
16270
- The uuid can also be fetched from the transactional logs page in your Brevo account, from the address URL.
16271
- </Note>
16416
+ The uuid can also be fetched from the transactional logs page in your Brevo account, from the address URL.</Note>
16272
16417
  </dd>
16273
16418
  </dl>
16274
16419
  </dd>
@@ -16918,15 +17063,9 @@ await client.transactionalEmails.sendTestTemplate({
16918
17063
  <dl>
16919
17064
  <dd>
16920
17065
 
16921
- <Note>
16922
- If the user includes stop code in the Transactional SMS, then it will be switched to Marketing SMS automatically and it will be interpreted as a Marketing SMS. To send Transactional SMS as Transactional, it is important not to use stop code.
16923
-
16924
- Note: For adding a stop code, client has to add reply STOP to [STOP_CODE] and the [STOP_CODE] will be replaced with the number.
16925
- </Note>
16926
-
16927
- <Note title="For end users in France">
16928
- Transactional SMS can be sent at any time without time restrictions. However, if a message is categorized as Marketing, it must adhere to specific time restrictions. Messages sent outside of these restricted hours will experience delays and will be processed during allowable times. Specifically, Marketing SMS cannot be processed between 10pm and 8am, on Sundays, and on French public holidays.
16929
- </Note>
17066
+ <Note>If the user includes stop code in the Transactional SMS, then it will be switched to Marketing SMS automatically and it will be interpreted as a Marketing SMS. To send Transactional SMS as Transactional, it is important not to use stop code.
17067
+ Note: For adding a stop code, client has to add reply STOP to [STOP_CODE] and the [STOP_CODE] will be replaced with the number.</Note>
17068
+ <Note title="For end users in France">Transactional SMS can be sent at any time without time restrictions. However, if a message is categorized as Marketing, it must adhere to specific time restrictions. Messages sent outside of these restricted hours will experience delays and will be processed during allowable times. Specifically, Marketing SMS cannot be processed between 10pm and 8am, on Sundays, and on French public holidays.</Note>
16930
17069
  </dd>
16931
17070
  </dl>
16932
17071
  </dd>
@@ -17228,3 +17367,4 @@ await client.smsTemplates.getSmsTemplates();
17228
17367
  </dd>
17229
17368
  </dl>
17230
17369
  </details>
17370
+
@@ -1,6 +0,0 @@
1
- export declare const GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField: {
2
- readonly Name: "name";
3
- readonly CreatedAt: "created_at";
4
- readonly UpdatedAt: "updated_at";
5
- };
6
- export type GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField = (typeof GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField)[keyof typeof GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField];