@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
@@ -17,15 +17,15 @@ export declare namespace CreateUpdateBatchCategoryRequest {
17
17
  namespace Categories {
18
18
  interface Item {
19
19
  /** UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database */
20
- deletedAt?: string;
20
+ deletedAt?: string | undefined;
21
21
  /** Unique Category ID as saved in the shop */
22
22
  id: string;
23
23
  /** category deleted from the shop's database */
24
- isDeleted?: boolean;
24
+ isDeleted?: boolean | undefined;
25
25
  /** **Mandatory in case of creation**. Name of the Category, as displayed in the shop */
26
- name?: string;
26
+ name?: string | undefined;
27
27
  /** URL to the category */
28
- url?: string;
28
+ url?: string | undefined;
29
29
  }
30
30
  }
31
31
  }
@@ -18,29 +18,29 @@ export declare namespace CreateUpdateBatchProductsRequest {
18
18
  namespace Products {
19
19
  interface Item {
20
20
  /** Category ID-s of the product */
21
- categories?: string[];
21
+ categories?: string[] | undefined;
22
22
  /** UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database */
23
- deletedAt?: string;
23
+ deletedAt?: string | undefined;
24
24
  /** Product ID for which you requested the details */
25
25
  id: string;
26
26
  /** Absolute URL to the cover image of the product */
27
- imageUrl?: string;
27
+ imageUrl?: string | undefined;
28
28
  /** product deleted from the shop's database */
29
- isDeleted?: boolean;
29
+ isDeleted?: boolean | undefined;
30
30
  /** Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 20. */
31
- metaInfo?: Record<string, Item.MetaInfo.Value>;
31
+ metaInfo?: Record<string, Item.MetaInfo.Value> | undefined;
32
32
  /** Mandatory in case of creation**. Name of the product for which you requested the details */
33
33
  name: string;
34
34
  /** Parent product id of the product */
35
- parentId?: string;
35
+ parentId?: string | undefined;
36
36
  /** Price of the product */
37
- price?: number;
37
+ price?: number | undefined;
38
38
  /** Product identifier from the shop */
39
- sku?: string;
39
+ sku?: string | undefined;
40
40
  /** Current stock value of the product from the shop's database */
41
- stock?: number;
41
+ stock?: number | undefined;
42
42
  /** URL to the product */
43
- url?: string;
43
+ url?: string | undefined;
44
44
  }
45
45
  namespace Item {
46
46
  namespace MetaInfo {
@@ -0,0 +1,2 @@
1
+ export { EcommerceClient } from "./client/Client.js";
2
+ export * from "./client/index.js";
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
+ };
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.EcommerceClient = void 0;
19
+ var Client_js_1 = require("./client/Client.js");
20
+ Object.defineProperty(exports, "EcommerceClient", { enumerable: true, get: function () { return Client_js_1.EcommerceClient; } });
21
+ __exportStar(require("./client/index.js"), exports);
@@ -2,5 +2,5 @@ export interface CreateBatchOrderResponse {
2
2
  /** Batch ID of the request */
3
3
  batchId: number;
4
4
  /** Number of orders */
5
- count?: number;
5
+ count?: number | undefined;
6
6
  }
@@ -1,6 +1,6 @@
1
1
  export interface CreateUpdateBatchCategoryResponse {
2
2
  /** Number of the new created categories */
3
- createdCount?: number;
3
+ createdCount?: number | undefined;
4
4
  /** Number of the existing categories updated */
5
- updatedCount?: number;
5
+ updatedCount?: number | undefined;
6
6
  }
@@ -1,6 +1,6 @@
1
1
  export interface CreateUpdateBatchProductsResponse {
2
2
  /** Number of the new created products */
3
- createdCount?: number;
3
+ createdCount?: number | undefined;
4
4
  /** Number of the existing products updated */
5
- updatedCount?: number;
5
+ updatedCount?: number | undefined;
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;
3
+ id?: number | undefined;
4
4
  }
@@ -1,4 +1,4 @@
1
1
  export interface CreateUpdateProductResponse {
2
2
  /** ID of the Product when a new product is created */
3
- id?: number;
3
+ id?: number | undefined;
4
4
  }
@@ -7,13 +7,13 @@ export declare namespace GetEcommerceAttributionProductsConversionSourceConversi
7
7
  namespace Products {
8
8
  interface Item {
9
9
  id: string;
10
- imageUrl?: string;
11
- name?: string;
12
- ordersCount?: number;
13
- price?: number;
14
- revenue?: number;
15
- sku?: string;
16
- url?: string;
10
+ imageUrl?: string | undefined;
11
+ name?: string | undefined;
12
+ ordersCount?: number | undefined;
13
+ price?: number | undefined;
14
+ revenue?: number | undefined;
15
+ sku?: string | undefined;
16
+ url?: string | undefined;
17
17
  }
18
18
  }
19
19
  }
@@ -11,11 +11,8 @@ export declare class EmailCampaignsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<EmailCampaignsClient.Options>;
12
12
  constructor(options: EmailCampaignsClient.Options);
13
13
  /**
14
- * <Note>
15
- * The response payload for this endpoint has changed
16
- *
17
- * 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).
18
- * </Note>
14
+ * <Note>The response payload for this endpoint has changed
15
+ * 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>
19
16
  *
20
17
  * @param {Brevo.GetEmailCampaignsRequest} request
21
18
  * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -67,11 +67,8 @@ class EmailCampaignsClient {
67
67
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
68
68
  }
69
69
  /**
70
- * <Note>
71
- * The response payload for this endpoint has changed
72
- *
73
- * 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).
74
- * </Note>
70
+ * <Note>The response payload for this endpoint has changed
71
+ * 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>
75
72
  *
76
73
  * @param {Brevo.GetEmailCampaignsRequest} request
77
74
  * @param {EmailCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -251,9 +248,10 @@ class EmailCampaignsClient {
251
248
  __getEmailCampaign(request, requestOptions) {
252
249
  return __awaiter(this, void 0, void 0, function* () {
253
250
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
254
- const { campaignId, statistics } = request;
251
+ const { campaignId, statistics, excludeHtmlContent } = request;
255
252
  const _queryParams = {
256
253
  statistics: statistics != null ? statistics : undefined,
254
+ excludeHtmlContent,
257
255
  };
258
256
  const _authRequest = yield this._options.authProvider.getAuthRequest();
259
257
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -77,9 +77,9 @@ export declare namespace CreateEmailCampaignRequest {
77
77
  */
78
78
  interface EmailExpirationDate {
79
79
  /** Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months. */
80
- duration?: number;
80
+ duration?: number | undefined;
81
81
  /** unit of the duration */
82
- unit?: EmailExpirationDate.Unit;
82
+ unit?: EmailExpirationDate.Unit | undefined;
83
83
  }
84
84
  namespace EmailExpirationDate {
85
85
  /** unit of the duration */
@@ -95,24 +95,24 @@ export declare namespace CreateEmailCampaignRequest {
95
95
  */
96
96
  interface Recipients {
97
97
  /** List ids to exclude from the campaign */
98
- exclusionListIds?: number[];
98
+ exclusionListIds?: number[] | undefined;
99
99
  /** Segment ids which have to be excluded from a campaign. */
100
- exclusionSegmentIds?: number[];
100
+ exclusionSegmentIds?: number[] | undefined;
101
101
  /** **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to */
102
- listIds?: number[];
102
+ listIds?: number[] | undefined;
103
103
  /** **Mandatory if listIds are not used**. Segment ids to send the campaign to. */
104
- segmentIds?: number[];
104
+ segmentIds?: number[] | undefined;
105
105
  }
106
106
  /**
107
107
  * Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
108
108
  */
109
109
  interface Sender {
110
110
  /** Sender email */
111
- email?: string;
111
+ email?: string | undefined;
112
112
  /** Select the sender for the campaign on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_. */
113
- id?: number;
113
+ id?: number | undefined;
114
114
  /** Sender Name */
115
- name?: string;
115
+ name?: string | undefined;
116
116
  }
117
117
  /** Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed */
118
118
  const WinnerCriteria: {
@@ -10,4 +10,6 @@ export interface GetEmailCampaignRequest {
10
10
  campaignId: number;
11
11
  /** Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. */
12
12
  statistics?: Brevo.GetEmailCampaignRequestStatistics;
13
+ /** Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body */
14
+ excludeHtmlContent?: boolean;
13
15
  }
@@ -78,9 +78,9 @@ export declare namespace UpdateEmailCampaignRequest {
78
78
  */
79
79
  interface EmailExpirationDate {
80
80
  /** Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months. */
81
- duration?: number;
81
+ duration?: number | undefined;
82
82
  /** unit of the duration */
83
- unit?: EmailExpirationDate.Unit;
83
+ unit?: EmailExpirationDate.Unit | undefined;
84
84
  }
85
85
  namespace EmailExpirationDate {
86
86
  /** unit of the duration */
@@ -96,24 +96,24 @@ export declare namespace UpdateEmailCampaignRequest {
96
96
  */
97
97
  interface Recipients {
98
98
  /** List ids which have to be excluded from a campaign */
99
- exclusionListIds?: number[];
99
+ exclusionListIds?: number[] | undefined;
100
100
  /** Segment ids which have to be excluded from a campaign. */
101
- exclusionSegmentIds?: number[];
101
+ exclusionSegmentIds?: number[] | undefined;
102
102
  /** Lists Ids to send the campaign to. **Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty** */
103
- listIds?: number[];
103
+ listIds?: number[] | undefined;
104
104
  /** **Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it.** Segment ids to send the campaign to. */
105
- segmentIds?: number[];
105
+ segmentIds?: number[] | undefined;
106
106
  }
107
107
  /**
108
108
  * Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
109
109
  */
110
110
  interface Sender {
111
111
  /** Sender email from which the campaign emails are sent */
112
- email?: string;
112
+ email?: string | undefined;
113
113
  /** Select the sender for the campaign on the basis of sender id. **In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)**. */
114
- id?: number;
114
+ id?: number | undefined;
115
115
  /** Sender Name from which the campaign emails are sent */
116
- name?: string;
116
+ name?: string | undefined;
117
117
  }
118
118
  /** Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed */
119
119
  const WinnerCriteria: {
@@ -0,0 +1,2 @@
1
+ export { EmailCampaignsClient } from "./client/Client.js";
2
+ export * from "./client/index.js";
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
+ };
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.EmailCampaignsClient = void 0;
19
+ var Client_js_1 = require("./client/Client.js");
20
+ Object.defineProperty(exports, "EmailCampaignsClient", { enumerable: true, get: function () { return Client_js_1.EmailCampaignsClient; } });
21
+ __exportStar(require("./client/index.js"), exports);
@@ -1,19 +1,19 @@
1
1
  import type * as Brevo from "../../../index.js";
2
2
  export interface GetAbTestCampaignResultResponse {
3
3
  /** Click rate for current winning version */
4
- clickRate?: string;
5
- clickedLinks?: GetAbTestCampaignResultResponse.ClickedLinks;
4
+ clickRate?: string | undefined;
5
+ clickedLinks?: GetAbTestCampaignResultResponse.ClickedLinks | undefined;
6
6
  /** Open rate for current winning version */
7
- openRate?: string;
8
- statistics?: GetAbTestCampaignResultResponse.Statistics;
7
+ openRate?: string | undefined;
8
+ statistics?: GetAbTestCampaignResultResponse.Statistics | undefined;
9
9
  /** Criteria chosen for winning version (Open/Click) */
10
- winningCriteria?: GetAbTestCampaignResultResponse.WinningCriteria;
10
+ winningCriteria?: GetAbTestCampaignResultResponse.WinningCriteria | undefined;
11
11
  /** Subject Line of current winning version */
12
- winningSubjectLine?: string;
12
+ winningSubjectLine?: string | undefined;
13
13
  /** Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. */
14
- winningVersion?: GetAbTestCampaignResultResponse.WinningVersion;
14
+ winningVersion?: GetAbTestCampaignResultResponse.WinningVersion | undefined;
15
15
  /** Open/Click rate for the winner version */
16
- winningVersionRate?: string;
16
+ winningVersionRate?: string | undefined;
17
17
  }
18
18
  export declare namespace GetAbTestCampaignResultResponse {
19
19
  interface ClickedLinks {
@@ -1,33 +1,35 @@
1
1
  import type * as Brevo from "../../../index.js";
2
2
  export interface GetEmailCampaignResponse {
3
+ /** Url of the attachment file. Only available if the campaign has an attachment. */
4
+ attachmentFile?: string | undefined;
3
5
  /** Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. */
4
- abTesting?: boolean;
6
+ abTesting?: boolean | undefined;
5
7
  /** ID of the campaign */
6
8
  id: number;
7
9
  /** Name of the campaign */
8
10
  name: string;
9
11
  /** Preview text or preheader of the email campaign */
10
- previewText?: string;
12
+ previewText?: string | undefined;
11
13
  /** UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) */
12
- scheduledAt?: string;
14
+ scheduledAt?: string | undefined;
13
15
  /** It is true if you have chosen to send your campaign at best time, otherwise it is false */
14
- sendAtBestTime?: boolean;
16
+ sendAtBestTime?: boolean | undefined;
15
17
  /** The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` */
16
- splitRule?: number;
18
+ splitRule?: number | undefined;
17
19
  /** Status of the campaign */
18
20
  status: GetEmailCampaignResponse.Status;
19
21
  /** Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` */
20
- subject?: string;
22
+ subject?: string | undefined;
21
23
  /** Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` */
22
- subjectA?: string;
24
+ subjectA?: string | undefined;
23
25
  /** Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` */
24
- subjectB?: string;
26
+ subjectB?: string | undefined;
25
27
  /** Type of campaign */
26
28
  type: GetEmailCampaignResponse.Type;
27
29
  /** Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` */
28
- winnerCriteria?: string;
30
+ winnerCriteria?: string | undefined;
29
31
  /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */
30
- winnerDelay?: number;
32
+ winnerDelay?: number | undefined;
31
33
  /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
32
34
  createdAt: string;
33
35
  /** Footer of the campaign */
@@ -37,35 +39,37 @@ export interface GetEmailCampaignResponse {
37
39
  /** HTML content of the campaign */
38
40
  htmlContent: string;
39
41
  /** Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. */
40
- inlineImageActivation?: boolean;
42
+ inlineImageActivation?: boolean | undefined;
41
43
  /** Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign */
42
- mirrorActive?: boolean;
44
+ mirrorActive?: boolean | undefined;
43
45
  /** UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
44
46
  modifiedAt: string;
45
47
  /** FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times */
46
- recurring?: boolean;
48
+ recurring?: boolean | undefined;
47
49
  /** Email defined as the "Reply to" of the campaign */
48
50
  replyTo: string;
49
51
  /** Total number of non-delivered campaigns for a particular campaign id. */
50
- returnBounce?: number;
52
+ returnBounce?: number | undefined;
51
53
  sender: GetEmailCampaignResponse.Sender;
52
54
  /** Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' */
53
- sentDate?: string;
55
+ sentDate?: string | undefined;
54
56
  /** Link to share the campaign on social medias */
55
- shareLink?: string;
57
+ shareLink?: string | undefined;
56
58
  /** Tag of the campaign */
57
- tag?: string;
59
+ tag?: string | undefined;
60
+ /** List of tags of the campaign */
61
+ tags?: string[] | undefined;
58
62
  /** Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) */
59
63
  testSent: boolean;
60
64
  /** Customisation of the "to" field of the campaign */
61
- toField?: string;
65
+ toField?: string | undefined;
62
66
  /** utm parameter associated with campaign */
63
- utmCampaignValue?: string;
67
+ utmCampaignValue?: string | undefined;
64
68
  /** utm id active */
65
- utmIDActive?: boolean;
66
- utmMedium?: string;
69
+ utmIDActive?: boolean | undefined;
70
+ utmMedium?: string | undefined;
67
71
  /** source of utm */
68
- utmSource?: string;
72
+ utmSource?: string | undefined;
69
73
  recipients: Brevo.GetCampaignRecipients;
70
74
  statistics: Brevo.GetExtendedCampaignStats;
71
75
  }
@@ -78,6 +82,9 @@ export declare namespace GetEmailCampaignResponse {
78
82
  readonly Queued: "queued";
79
83
  readonly Suspended: "suspended";
80
84
  readonly InProcess: "in_process";
85
+ readonly InReview: "in_review";
86
+ readonly Cancelling: "cancelling";
87
+ readonly Cancelled: "cancelled";
81
88
  };
82
89
  type Status = (typeof Status)[keyof typeof Status];
83
90
  /** Type of campaign */
@@ -88,10 +95,10 @@ export declare namespace GetEmailCampaignResponse {
88
95
  type Type = (typeof Type)[keyof typeof Type];
89
96
  interface Sender {
90
97
  /** Sender email of the campaign */
91
- email?: string;
98
+ email?: string | undefined;
92
99
  /** Sender id of the campaign */
93
- id?: number;
100
+ id?: number | undefined;
94
101
  /** Sender name of the campaign */
95
- name?: string;
102
+ name?: string | undefined;
96
103
  }
97
104
  }
@@ -12,6 +12,9 @@ var GetEmailCampaignResponse;
12
12
  Queued: "queued",
13
13
  Suspended: "suspended",
14
14
  InProcess: "in_process",
15
+ InReview: "in_review",
16
+ Cancelling: "cancelling",
17
+ Cancelled: "cancelled",
15
18
  };
16
19
  /** Type of campaign */
17
20
  GetEmailCampaignResponse.Type = {
@@ -6,5 +6,7 @@ export declare const GetEmailCampaignsRequestStatus: {
6
6
  readonly Draft: "draft";
7
7
  readonly InProcess: "inProcess";
8
8
  readonly InReview: "inReview";
9
+ readonly Cancelling: "cancelling";
10
+ readonly Cancelled: "cancelled";
9
11
  };
10
12
  export type GetEmailCampaignsRequestStatus = (typeof GetEmailCampaignsRequestStatus)[keyof typeof GetEmailCampaignsRequestStatus];
@@ -10,4 +10,6 @@ exports.GetEmailCampaignsRequestStatus = {
10
10
  Draft: "draft",
11
11
  InProcess: "inProcess",
12
12
  InReview: "inReview",
13
+ Cancelling: "cancelling",
14
+ Cancelled: "cancelled",
13
15
  };
@@ -1,41 +1,43 @@
1
1
  import type * as Brevo from "../../../index.js";
2
2
  export interface GetEmailCampaignsResponse {
3
- campaigns?: GetEmailCampaignsResponse.Campaigns.Item[];
3
+ campaigns?: GetEmailCampaignsResponse.Campaigns.Item[] | undefined;
4
4
  /** Number of Email campaigns retrieved */
5
- count?: number;
5
+ count?: number | undefined;
6
6
  }
7
7
  export declare namespace GetEmailCampaignsResponse {
8
8
  type Campaigns = Campaigns.Item[];
9
9
  namespace Campaigns {
10
10
  interface Item {
11
+ /** Url of the attachment file. Only available if the campaign has an attachment. */
12
+ attachmentFile?: string | undefined;
11
13
  /** Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. */
12
- abTesting?: boolean;
14
+ abTesting?: boolean | undefined;
13
15
  /** ID of the campaign */
14
16
  id: number;
15
17
  /** Name of the campaign */
16
18
  name: string;
17
19
  /** Preview text or preheader of the email campaign */
18
- previewText?: string;
20
+ previewText?: string | undefined;
19
21
  /** UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) */
20
- scheduledAt?: string;
22
+ scheduledAt?: string | undefined;
21
23
  /** It is true if you have chosen to send your campaign at best time, otherwise it is false */
22
- sendAtBestTime?: boolean;
24
+ sendAtBestTime?: boolean | undefined;
23
25
  /** The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` */
24
- splitRule?: number;
26
+ splitRule?: number | undefined;
25
27
  /** Status of the campaign */
26
28
  status: Item.Status;
27
29
  /** Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` */
28
- subject?: string;
30
+ subject?: string | undefined;
29
31
  /** Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` */
30
- subjectA?: string;
32
+ subjectA?: string | undefined;
31
33
  /** Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` */
32
- subjectB?: string;
34
+ subjectB?: string | undefined;
33
35
  /** Type of campaign */
34
36
  type: Item.Type;
35
37
  /** Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` */
36
- winnerCriteria?: string;
38
+ winnerCriteria?: string | undefined;
37
39
  /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */
38
- winnerDelay?: number;
40
+ winnerDelay?: number | undefined;
39
41
  /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
40
42
  createdAt: string;
41
43
  /** Footer of the campaign */
@@ -45,35 +47,37 @@ export declare namespace GetEmailCampaignsResponse {
45
47
  /** HTML content of the campaign */
46
48
  htmlContent: string;
47
49
  /** Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. */
48
- inlineImageActivation?: boolean;
50
+ inlineImageActivation?: boolean | undefined;
49
51
  /** Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign */
50
- mirrorActive?: boolean;
52
+ mirrorActive?: boolean | undefined;
51
53
  /** UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
52
54
  modifiedAt: string;
53
55
  /** FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times */
54
- recurring?: boolean;
56
+ recurring?: boolean | undefined;
55
57
  /** Email defined as the "Reply to" of the campaign */
56
58
  replyTo: string;
57
59
  /** Total number of non-delivered campaigns for a particular campaign id. */
58
- returnBounce?: number;
60
+ returnBounce?: number | undefined;
59
61
  sender: Item.Sender;
60
62
  /** Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' */
61
- sentDate?: string;
63
+ sentDate?: string | undefined;
62
64
  /** Link to share the campaign on social medias */
63
- shareLink?: string;
65
+ shareLink?: string | undefined;
64
66
  /** Tag of the campaign */
65
- tag?: string;
67
+ tag?: string | undefined;
68
+ /** List of tags of the campaign */
69
+ tags?: string[] | undefined;
66
70
  /** Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) */
67
71
  testSent: boolean;
68
72
  /** Customisation of the "to" field of the campaign */
69
- toField?: string;
73
+ toField?: string | undefined;
70
74
  /** utm parameter associated with campaign */
71
- utmCampaignValue?: string;
75
+ utmCampaignValue?: string | undefined;
72
76
  /** utm id active */
73
- utmIDActive?: boolean;
74
- utmMedium?: string;
77
+ utmIDActive?: boolean | undefined;
78
+ utmMedium?: string | undefined;
75
79
  /** source of utm */
76
- utmSource?: string;
80
+ utmSource?: string | undefined;
77
81
  recipients: Brevo.GetCampaignRecipients;
78
82
  statistics: Brevo.GetExtendedCampaignStats;
79
83
  }
@@ -86,6 +90,9 @@ export declare namespace GetEmailCampaignsResponse {
86
90
  readonly Queued: "queued";
87
91
  readonly Suspended: "suspended";
88
92
  readonly InProcess: "in_process";
93
+ readonly InReview: "in_review";
94
+ readonly Cancelling: "cancelling";
95
+ readonly Cancelled: "cancelled";
89
96
  };
90
97
  type Status = (typeof Status)[keyof typeof Status];
91
98
  /** Type of campaign */
@@ -96,11 +103,11 @@ export declare namespace GetEmailCampaignsResponse {
96
103
  type Type = (typeof Type)[keyof typeof Type];
97
104
  interface Sender {
98
105
  /** Sender email of the campaign */
99
- email?: string;
106
+ email?: string | undefined;
100
107
  /** Sender id of the campaign */
101
- id?: number;
108
+ id?: number | undefined;
102
109
  /** Sender name of the campaign */
103
- name?: string;
110
+ name?: string | undefined;
104
111
  }
105
112
  }
106
113
  }
@@ -16,6 +16,9 @@ var GetEmailCampaignsResponse;
16
16
  Queued: "queued",
17
17
  Suspended: "suspended",
18
18
  InProcess: "in_process",
19
+ InReview: "in_review",
20
+ Cancelling: "cancelling",
21
+ Cancelled: "cancelled",
19
22
  };
20
23
  /** Type of campaign */
21
24
  Item.Type = {