@getbrevo/brevo 2.5.0 → 3.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 (675) hide show
  1. package/README.md +178 -100
  2. package/api/accountApi.ts +5 -5
  3. package/api/companiesApi.ts +15 -15
  4. package/api/contactsApi.ts +148 -151
  5. package/api/conversationsApi.ts +46 -47
  6. package/api/couponsApi.ts +11 -11
  7. package/api/dealsApi.ts +51 -52
  8. package/api/domainsApi.ts +11 -11
  9. package/api/ecommerceApi.ts +86 -87
  10. package/api/emailCampaignsApi.ts +82 -105
  11. package/api/eventsApi.ts +3 -3
  12. package/api/externalFeedsApi.ts +11 -11
  13. package/api/filesApi.ts +11 -11
  14. package/api/inboundParsingApi.ts +7 -7
  15. package/api/masterAccountApi.ts +49 -49
  16. package/api/notesApi.ts +11 -11
  17. package/api/paymentsApi.ts +7 -7
  18. package/api/processApi.ts +5 -5
  19. package/api/resellerApi.ts +33 -33
  20. package/api/sMSCampaignsApi.ts +51 -52
  21. package/api/sendersApi.ts +15 -15
  22. package/api/tasksApi.ts +13 -13
  23. package/api/transactionalEmailsApi.ts +45 -45
  24. package/api/transactionalSMSApi.ts +9 -9
  25. package/api/transactionalWhatsAppApi.ts +5 -5
  26. package/api/userApi.ts +13 -13
  27. package/api/webhooksApi.ts +13 -13
  28. package/api/whatsAppCampaignsApi.ts +19 -19
  29. package/dist/api/accountApi.d.ts +2 -1
  30. package/dist/api/accountApi.js +10 -14
  31. package/dist/api/accountApi.js.map +1 -1
  32. package/dist/api/apis.d.ts +4 -9
  33. package/dist/api/apis.js +3 -9
  34. package/dist/api/apis.js.map +1 -1
  35. package/dist/api/companiesApi.d.ts +10 -29
  36. package/dist/api/companiesApi.js +70 -219
  37. package/dist/api/companiesApi.js.map +1 -1
  38. package/dist/api/contactsApi.d.ts +35 -43
  39. package/dist/api/contactsApi.js +155 -232
  40. package/dist/api/contactsApi.js.map +1 -1
  41. package/dist/api/conversationsApi.d.ts +10 -10
  42. package/dist/api/conversationsApi.js +47 -47
  43. package/dist/api/conversationsApi.js.map +1 -1
  44. package/dist/api/couponsApi.d.ts +1 -0
  45. package/dist/api/couponsApi.js +22 -22
  46. package/dist/api/couponsApi.js.map +1 -1
  47. package/dist/api/dealsApi.d.ts +12 -32
  48. package/dist/api/dealsApi.js +52 -201
  49. package/dist/api/dealsApi.js.map +1 -1
  50. package/dist/api/domainsApi.d.ts +1 -0
  51. package/dist/api/domainsApi.js +22 -22
  52. package/dist/api/domainsApi.js.map +1 -1
  53. package/dist/api/ecommerceApi.d.ts +21 -21
  54. package/dist/api/ecommerceApi.js +88 -97
  55. package/dist/api/ecommerceApi.js.map +1 -1
  56. package/dist/api/emailCampaignsApi.d.ts +15 -15
  57. package/dist/api/emailCampaignsApi.js +86 -108
  58. package/dist/api/emailCampaignsApi.js.map +1 -1
  59. package/dist/api/eventsApi.d.ts +1 -0
  60. package/dist/api/eventsApi.js +6 -6
  61. package/dist/api/eventsApi.js.map +1 -1
  62. package/dist/api/externalFeedsApi.d.ts +1 -0
  63. package/dist/api/externalFeedsApi.js +22 -22
  64. package/dist/api/externalFeedsApi.js.map +1 -1
  65. package/dist/api/filesApi.d.ts +1 -0
  66. package/dist/api/filesApi.js +22 -22
  67. package/dist/api/filesApi.js.map +1 -1
  68. package/dist/api/inboundParsingApi.d.ts +2 -0
  69. package/dist/api/inboundParsingApi.js +14 -14
  70. package/dist/api/inboundParsingApi.js.map +1 -1
  71. package/dist/api/masterAccountApi.d.ts +2 -27
  72. package/dist/api/masterAccountApi.js +98 -299
  73. package/dist/api/masterAccountApi.js.map +1 -1
  74. package/dist/api/notesApi.d.ts +1 -0
  75. package/dist/api/notesApi.js +22 -22
  76. package/dist/api/notesApi.js.map +1 -1
  77. package/dist/api/paymentsApi.d.ts +1 -0
  78. package/dist/api/paymentsApi.js +14 -14
  79. package/dist/api/paymentsApi.js.map +1 -1
  80. package/dist/api/processApi.d.ts +1 -0
  81. package/dist/api/processApi.js +10 -10
  82. package/dist/api/processApi.js.map +1 -1
  83. package/dist/api/resellerApi.d.ts +1 -0
  84. package/dist/api/resellerApi.js +66 -66
  85. package/dist/api/resellerApi.js.map +1 -1
  86. package/dist/api/sMSCampaignsApi.d.ts +11 -11
  87. package/dist/api/sMSCampaignsApi.js +52 -52
  88. package/dist/api/sMSCampaignsApi.js.map +1 -1
  89. package/dist/api/sendersApi.d.ts +1 -0
  90. package/dist/api/sendersApi.js +30 -30
  91. package/dist/api/sendersApi.js.map +1 -1
  92. package/dist/api/tasksApi.d.ts +1 -0
  93. package/dist/api/tasksApi.js +26 -26
  94. package/dist/api/tasksApi.js.map +1 -1
  95. package/dist/api/transactionalEmailsApi.d.ts +1 -10
  96. package/dist/api/transactionalEmailsApi.js +90 -157
  97. package/dist/api/transactionalEmailsApi.js.map +1 -1
  98. package/dist/api/transactionalSMSApi.d.ts +1 -8
  99. package/dist/api/transactionalSMSApi.js +18 -73
  100. package/dist/api/transactionalSMSApi.js.map +1 -1
  101. package/dist/api/transactionalWhatsAppApi.d.ts +1 -0
  102. package/dist/api/transactionalWhatsAppApi.js +10 -10
  103. package/dist/api/transactionalWhatsAppApi.js.map +1 -1
  104. package/dist/api/userApi.d.ts +1 -0
  105. package/dist/api/userApi.js +26 -26
  106. package/dist/api/userApi.js.map +1 -1
  107. package/dist/api/webhooksApi.d.ts +1 -0
  108. package/dist/api/webhooksApi.js +26 -26
  109. package/dist/api/webhooksApi.js.map +1 -1
  110. package/dist/api/whatsAppCampaignsApi.d.ts +1 -0
  111. package/dist/api/whatsAppCampaignsApi.js +38 -38
  112. package/dist/api/whatsAppCampaignsApi.js.map +1 -1
  113. package/dist/model/abTestCampaignResult.js +1 -1
  114. package/dist/model/abTestCampaignResult.js.map +1 -1
  115. package/dist/model/addContactToList.d.ts +0 -1
  116. package/dist/model/addContactToList.js +0 -5
  117. package/dist/model/addContactToList.js.map +1 -1
  118. package/dist/model/cart.js +1 -1
  119. package/dist/model/cart.js.map +1 -1
  120. package/dist/model/companiesIdPatchRequest.d.ts +0 -2
  121. package/dist/model/companiesIdPatchRequest.js +0 -10
  122. package/dist/model/companiesIdPatchRequest.js.map +1 -1
  123. package/dist/model/conversationsMessage.d.ts +0 -20
  124. package/dist/model/conversationsMessage.js +1 -76
  125. package/dist/model/conversationsMessage.js.map +1 -1
  126. package/dist/model/conversionSourceMetrics.d.ts +2 -5
  127. package/dist/model/conversionSourceMetrics.js +2 -5
  128. package/dist/model/conversionSourceMetrics.js.map +1 -1
  129. package/dist/model/createAttribute.d.ts +1 -3
  130. package/dist/model/createAttribute.js +1 -7
  131. package/dist/model/createAttribute.js.map +1 -1
  132. package/dist/model/createChild.js +1 -1
  133. package/dist/model/createChild.js.map +1 -1
  134. package/dist/model/createContact.d.ts +1 -3
  135. package/dist/model/createContact.js +1 -1
  136. package/dist/model/createContact.js.map +1 -1
  137. package/dist/model/createDoiContact.d.ts +1 -3
  138. package/dist/model/createDoiContact.js +1 -1
  139. package/dist/model/createDoiContact.js.map +1 -1
  140. package/dist/model/createEmailCampaign.d.ts +0 -2
  141. package/dist/model/createEmailCampaign.js +1 -6
  142. package/dist/model/createEmailCampaign.js.map +1 -1
  143. package/dist/model/createEmailCampaignRecipients.d.ts +0 -1
  144. package/dist/model/createEmailCampaignRecipients.js +0 -5
  145. package/dist/model/createEmailCampaignRecipients.js.map +1 -1
  146. package/dist/model/createExternalFeed.js +1 -1
  147. package/dist/model/createExternalFeed.js.map +1 -1
  148. package/dist/model/createSmsCampaign.js.map +1 -1
  149. package/dist/model/createSubAccount.js +1 -1
  150. package/dist/model/createSubAccount.js.map +1 -1
  151. package/dist/model/createUpdateCategory.js.map +1 -1
  152. package/dist/model/createUpdateProduct.js.map +1 -1
  153. package/dist/model/createWebhook.d.ts +0 -5
  154. package/dist/model/createWebhook.js +1 -12
  155. package/dist/model/createWebhook.js.map +1 -1
  156. package/dist/model/createWhatsAppTemplate.js +1 -1
  157. package/dist/model/createWhatsAppTemplate.js.map +1 -1
  158. package/dist/model/crmDealsIdPatchRequest.d.ts +0 -2
  159. package/dist/model/crmDealsIdPatchRequest.js +0 -10
  160. package/dist/model/crmDealsIdPatchRequest.js.map +1 -1
  161. package/dist/model/ecommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response.d.ts +2 -5
  162. package/dist/model/ecommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response.js +2 -5
  163. package/dist/model/ecommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response.js.map +1 -1
  164. package/dist/model/emailExportRecipients.js +1 -1
  165. package/dist/model/emailExportRecipients.js.map +1 -1
  166. package/dist/model/errorModel.d.ts +1 -0
  167. package/dist/model/errorModel.js +2 -1
  168. package/dist/model/errorModel.js.map +1 -1
  169. package/dist/model/exportWebhooksHistory.js +1 -1
  170. package/dist/model/exportWebhooksHistory.js.map +1 -1
  171. package/dist/model/getAccountAllOfPlan.d.ts +3 -1
  172. package/dist/model/getAccountAllOfPlan.js +7 -1
  173. package/dist/model/getAccountAllOfPlan.js.map +1 -1
  174. package/dist/model/getAllExternalFeedsFeedsInner.js +1 -1
  175. package/dist/model/getAllExternalFeedsFeedsInner.js.map +1 -1
  176. package/dist/model/getAttributesAttributesInner.d.ts +1 -4
  177. package/dist/model/getAttributesAttributesInner.js +1 -8
  178. package/dist/model/getAttributesAttributesInner.js.map +1 -1
  179. package/dist/model/getCampaignOverview.js +1 -1
  180. package/dist/model/getCampaignOverview.js.map +1 -1
  181. package/dist/model/getCampaignStats.d.ts +0 -2
  182. package/dist/model/getCampaignStats.js +0 -10
  183. package/dist/model/getCampaignStats.js.map +1 -1
  184. package/dist/model/getContactCampaignStats.d.ts +6 -6
  185. package/dist/model/getContactCampaignStats.js +5 -5
  186. package/dist/model/getContactCampaignStats.js.map +1 -1
  187. package/dist/model/getContactCampaignStatsClickedInner.d.ts +2 -2
  188. package/dist/model/getContactCampaignStatsClickedInner.js +1 -1
  189. package/dist/model/getContactCampaignStatsUnsubscriptions.d.ts +4 -4
  190. package/dist/model/getContactCampaignStatsUnsubscriptions.js +2 -2
  191. package/dist/model/getContactCampaignStatsUnsubscriptions.js.map +1 -1
  192. package/dist/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.d.ts +0 -5
  193. package/dist/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.js +0 -25
  194. package/dist/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.js.map +1 -1
  195. package/dist/model/getCorporateUserPermissionFeatureAccess.d.ts +0 -5
  196. package/dist/model/getCorporateUserPermissionFeatureAccess.js +0 -25
  197. package/dist/model/getCorporateUserPermissionFeatureAccess.js.map +1 -1
  198. package/dist/model/getEmailCampaign.d.ts +4 -2
  199. package/dist/model/getEmailCampaign.js +3 -3
  200. package/dist/model/getEmailCampaign.js.map +1 -1
  201. package/dist/model/getEmailCampaignsCampaignsInner.js +1 -1
  202. package/dist/model/getEmailCampaignsCampaignsInner.js.map +1 -1
  203. package/dist/model/getEmailEventReportEventsInner.js +1 -1
  204. package/dist/model/getEmailEventReportEventsInner.js.map +1 -1
  205. package/dist/model/getExtendedCampaignOverview.js +1 -1
  206. package/dist/model/getExtendedCampaignOverview.js.map +1 -1
  207. package/dist/model/getExtendedCampaignStats.js.map +1 -1
  208. package/dist/model/getExternalFeedByUUID.js +1 -1
  209. package/dist/model/getExternalFeedByUUID.js.map +1 -1
  210. package/dist/model/getInboundEmailEventsByUuidLogsInner.js +1 -1
  211. package/dist/model/getInboundEmailEventsByUuidLogsInner.js.map +1 -1
  212. package/dist/model/getOrdersOrdersInner.d.ts +1 -6
  213. package/dist/model/getOrdersOrdersInner.js +5 -15
  214. package/dist/model/getOrdersOrdersInner.js.map +1 -1
  215. package/dist/model/getPaymentRequest.js +1 -1
  216. package/dist/model/getPaymentRequest.js.map +1 -1
  217. package/dist/model/getProcess.js +1 -1
  218. package/dist/model/getProcess.js.map +1 -1
  219. package/dist/model/getScheduledEmailByBatchIdBatchesInner.js +1 -1
  220. package/dist/model/getScheduledEmailByBatchIdBatchesInner.js.map +1 -1
  221. package/dist/model/getScheduledEmailByMessageId.js +1 -1
  222. package/dist/model/getScheduledEmailByMessageId.js.map +1 -1
  223. package/dist/model/getSegments.d.ts +2 -2
  224. package/dist/model/getSegments.js +1 -1
  225. package/dist/model/getSegments.js.map +1 -1
  226. package/dist/model/getSmsCampaign.d.ts +4 -2
  227. package/dist/model/getSmsCampaign.js +3 -3
  228. package/dist/model/getSmsCampaign.js.map +1 -1
  229. package/dist/model/getSmsCampaignOverview.js +1 -1
  230. package/dist/model/getSmsCampaignOverview.js.map +1 -1
  231. package/dist/model/getSmsCampaignsCampaignsInner.js +1 -1
  232. package/dist/model/getSmsCampaignsCampaignsInner.js.map +1 -1
  233. package/dist/model/getSmsEventReportEventsInner.js +1 -1
  234. package/dist/model/getSmsEventReportEventsInner.js.map +1 -1
  235. package/dist/model/getTransacBlockedContactsContactsInnerReason.js +1 -1
  236. package/dist/model/getTransacBlockedContactsContactsInnerReason.js.map +1 -1
  237. package/dist/model/getWebhook.js +1 -1
  238. package/dist/model/getWebhook.js.map +1 -1
  239. package/dist/model/getWhatsAppConfig.js +1 -1
  240. package/dist/model/getWhatsAppConfig.js.map +1 -1
  241. package/dist/model/getWhatsappCampaignOverview.js +1 -1
  242. package/dist/model/getWhatsappCampaignOverview.js.map +1 -1
  243. package/dist/model/getWhatsappCampaignsCampaignsInner.js +1 -1
  244. package/dist/model/getWhatsappCampaignsCampaignsInner.js.map +1 -1
  245. package/dist/model/getWhatsappEventReportEventsInner.js +1 -1
  246. package/dist/model/getWhatsappEventReportEventsInner.js.map +1 -1
  247. package/dist/model/inviteAdminUserPrivilegesInner.d.ts +2 -11
  248. package/dist/model/inviteAdminUserPrivilegesInner.js +1 -10
  249. package/dist/model/inviteAdminUserPrivilegesInner.js.map +1 -1
  250. package/dist/model/inviteuserPrivilegesInner.d.ts +3 -5
  251. package/dist/model/inviteuserPrivilegesInner.js +4 -6
  252. package/dist/model/inviteuserPrivilegesInner.js.map +1 -1
  253. package/dist/model/masterDetailsResponsePlanInfo.js +1 -1
  254. package/dist/model/masterDetailsResponsePlanInfo.js.map +1 -1
  255. package/dist/model/models.d.ts +33 -117
  256. package/dist/model/models.js +75 -412
  257. package/dist/model/models.js.map +1 -1
  258. package/dist/model/notification.js +1 -1
  259. package/dist/model/notification.js.map +1 -1
  260. package/dist/model/order.d.ts +1 -6
  261. package/dist/model/order.js +5 -15
  262. package/dist/model/order.js.map +1 -1
  263. package/dist/model/orderBatch.js.map +1 -1
  264. package/dist/model/removeContactFromList.d.ts +0 -1
  265. package/dist/model/removeContactFromList.js +0 -5
  266. package/dist/model/removeContactFromList.js.map +1 -1
  267. package/dist/model/requestContactExport.d.ts +0 -4
  268. package/dist/model/requestContactExport.js +0 -24
  269. package/dist/model/requestContactExport.js.map +1 -1
  270. package/dist/model/requestContactExportCustomContactFilter.d.ts +0 -1
  271. package/dist/model/requestContactExportCustomContactFilter.js +1 -6
  272. package/dist/model/requestContactExportCustomContactFilter.js.map +1 -1
  273. package/dist/model/requestContactImport.js.map +1 -1
  274. package/dist/model/requestSmsRecipientExport.js +1 -1
  275. package/dist/model/requestSmsRecipientExport.js.map +1 -1
  276. package/dist/model/sendReport.js +1 -1
  277. package/dist/model/sendReport.js.map +1 -1
  278. package/dist/model/sendTransacSms.d.ts +1 -2
  279. package/dist/model/sendTransacSms.js +2 -2
  280. package/dist/model/sendTransacSms.js.map +1 -1
  281. package/dist/model/ssoTokenRequest.js +1 -1
  282. package/dist/model/ssoTokenRequest.js.map +1 -1
  283. package/dist/model/subAccountDetailsResponsePlanInfoCredits.d.ts +0 -4
  284. package/dist/model/subAccountDetailsResponsePlanInfoCredits.js +0 -10
  285. package/dist/model/subAccountDetailsResponsePlanInfoCredits.js.map +1 -1
  286. package/dist/model/subAccountDetailsResponsePlanInfoFeatures.d.ts +0 -2
  287. package/dist/model/subAccountDetailsResponsePlanInfoFeatures.js +0 -5
  288. package/dist/model/subAccountDetailsResponsePlanInfoFeatures.js.map +1 -1
  289. package/dist/model/subAccountUpdatePlanRequestCredits.d.ts +0 -2
  290. package/dist/model/subAccountUpdatePlanRequestCredits.js +0 -10
  291. package/dist/model/subAccountUpdatePlanRequestCredits.js.map +1 -1
  292. package/dist/model/subAccountUpdatePlanRequestFeatures.d.ts +0 -1
  293. package/dist/model/subAccountUpdatePlanRequestFeatures.js +0 -5
  294. package/dist/model/subAccountUpdatePlanRequestFeatures.js.map +1 -1
  295. package/dist/model/taskReminder.js +1 -1
  296. package/dist/model/taskReminder.js.map +1 -1
  297. package/dist/model/updateAttribute.d.ts +0 -1
  298. package/dist/model/updateAttribute.js +0 -5
  299. package/dist/model/updateAttribute.js.map +1 -1
  300. package/dist/model/updateCampaignStatus.js +1 -1
  301. package/dist/model/updateCampaignStatus.js.map +1 -1
  302. package/dist/model/updateContact.d.ts +1 -3
  303. package/dist/model/updateContact.js +1 -1
  304. package/dist/model/updateContact.js.map +1 -1
  305. package/dist/model/updateEmailCampaign.d.ts +0 -2
  306. package/dist/model/updateEmailCampaign.js +1 -6
  307. package/dist/model/updateEmailCampaign.js.map +1 -1
  308. package/dist/model/updateEmailCampaignRecipients.d.ts +0 -1
  309. package/dist/model/updateEmailCampaignRecipients.js +0 -5
  310. package/dist/model/updateEmailCampaignRecipients.js.map +1 -1
  311. package/dist/model/updateExternalFeed.js +1 -1
  312. package/dist/model/updateExternalFeed.js.map +1 -1
  313. package/dist/model/updateSmsCampaign.js.map +1 -1
  314. package/dist/model/updateWebhook.js +1 -1
  315. package/dist/model/updateWebhook.js.map +1 -1
  316. package/dist/model/updateWhatsAppCampaign.js +1 -1
  317. package/dist/model/updateWhatsAppCampaign.js.map +1 -1
  318. package/dist/requestCompat.d.ts +29 -0
  319. package/dist/requestCompat.js +110 -0
  320. package/dist/requestCompat.js.map +1 -0
  321. package/model/models.ts +8 -8
  322. package/package.json +2 -3
  323. package/requestCompat.ts +138 -0
  324. package/tsconfig.json +0 -1
  325. package/dist/api/balanceApi.d.ts +0 -187
  326. package/dist/api/balanceApi.js +0 -1434
  327. package/dist/api/balanceApi.js.map +0 -1
  328. package/dist/api/programApi.d.ts +0 -125
  329. package/dist/api/programApi.js +0 -847
  330. package/dist/api/programApi.js.map +0 -1
  331. package/dist/api/rewardApi.d.ts +0 -119
  332. package/dist/api/rewardApi.js +0 -814
  333. package/dist/api/rewardApi.js.map +0 -1
  334. package/dist/api/tierApi.d.ts +0 -116
  335. package/dist/api/tierApi.js +0 -801
  336. package/dist/api/tierApi.js.map +0 -1
  337. package/dist/base.d.ts +0 -66
  338. package/dist/base.js +0 -65
  339. package/dist/base.js.map +0 -1
  340. package/dist/common.d.ts +0 -65
  341. package/dist/common.js +0 -161
  342. package/dist/common.js.map +0 -1
  343. package/dist/configuration.d.ts +0 -91
  344. package/dist/configuration.js +0 -44
  345. package/dist/configuration.js.map +0 -1
  346. package/dist/index.d.ts +0 -13
  347. package/dist/index.js +0 -31
  348. package/dist/index.js.map +0 -1
  349. package/dist/model/addSubscriptionMemberPayload.d.ts +0 -16
  350. package/dist/model/addSubscriptionMemberPayload.js +0 -28
  351. package/dist/model/addSubscriptionMemberPayload.js.map +0 -1
  352. package/dist/model/aggregateBalance.d.ts +0 -15
  353. package/dist/model/aggregateBalance.js +0 -23
  354. package/dist/model/aggregateBalance.js.map +0 -1
  355. package/dist/model/balance.d.ts +0 -22
  356. package/dist/model/balance.js +0 -58
  357. package/dist/model/balance.js.map +0 -1
  358. package/dist/model/balanceDataPerContact.d.ts +0 -17
  359. package/dist/model/balanceDataPerContact.js +0 -33
  360. package/dist/model/balanceDataPerContact.js.map +0 -1
  361. package/dist/model/balanceDefinition.d.ts +0 -42
  362. package/dist/model/balanceDefinition.js +0 -121
  363. package/dist/model/balanceDefinition.js.map +0 -1
  364. package/dist/model/balanceDefinitionPage.d.ts +0 -15
  365. package/dist/model/balanceDefinitionPage.js +0 -18
  366. package/dist/model/balanceDefinitionPage.js.map +0 -1
  367. package/dist/model/balanceLimit.d.ts +0 -23
  368. package/dist/model/balanceLimit.js +0 -63
  369. package/dist/model/balanceLimit.js.map +0 -1
  370. package/dist/model/balanceOrder.d.ts +0 -27
  371. package/dist/model/balanceOrder.js +0 -73
  372. package/dist/model/balanceOrder.js.map +0 -1
  373. package/dist/model/companiesImportPost200Response.d.ts +0 -14
  374. package/dist/model/companiesImportPost200Response.js +0 -18
  375. package/dist/model/companiesImportPost200Response.js.map +0 -1
  376. package/dist/model/companiesImportPost400Response.d.ts +0 -14
  377. package/dist/model/companiesImportPost400Response.js +0 -18
  378. package/dist/model/companiesImportPost400Response.js.map +0 -1
  379. package/dist/model/contactBalancesResp.d.ts +0 -18
  380. package/dist/model/contactBalancesResp.js +0 -33
  381. package/dist/model/contactBalancesResp.js.map +0 -1
  382. package/dist/model/contactErrorModel.d.ts +0 -27
  383. package/dist/model/contactErrorModel.js +0 -40
  384. package/dist/model/contactErrorModel.js.map +0 -1
  385. package/dist/model/conversationsMessageAttachmentsInner.d.ts +0 -19
  386. package/dist/model/conversationsMessageAttachmentsInner.js +0 -43
  387. package/dist/model/conversationsMessageAttachmentsInner.js.map +0 -1
  388. package/dist/model/conversationsMessageForwardedToSourceStatus.d.ts +0 -15
  389. package/dist/model/conversationsMessageForwardedToSourceStatus.js +0 -23
  390. package/dist/model/conversationsMessageForwardedToSourceStatus.js.map +0 -1
  391. package/dist/model/conversationsMessageFrom.d.ts +0 -15
  392. package/dist/model/conversationsMessageFrom.js +0 -23
  393. package/dist/model/conversationsMessageFrom.js.map +0 -1
  394. package/dist/model/conversationsMessageReplyTo.d.ts +0 -15
  395. package/dist/model/conversationsMessageReplyTo.js +0 -23
  396. package/dist/model/conversationsMessageReplyTo.js.map +0 -1
  397. package/dist/model/conversationsMessageToInner.d.ts +0 -15
  398. package/dist/model/conversationsMessageToInner.js +0 -23
  399. package/dist/model/conversationsMessageToInner.js.map +0 -1
  400. package/dist/model/corporateUserEmailPermissionsPutRequest.d.ts +0 -16
  401. package/dist/model/corporateUserEmailPermissionsPutRequest.js +0 -23
  402. package/dist/model/corporateUserEmailPermissionsPutRequest.js.map +0 -1
  403. package/dist/model/corporateUserEmailPermissionsPutRequestPrivilegesInner.d.ts +0 -38
  404. package/dist/model/corporateUserEmailPermissionsPutRequestPrivilegesInner.js +0 -48
  405. package/dist/model/corporateUserEmailPermissionsPutRequestPrivilegesInner.js.map +0 -1
  406. package/dist/model/createBalanceDefinitionPayload.d.ts +0 -75
  407. package/dist/model/createBalanceDefinitionPayload.js +0 -145
  408. package/dist/model/createBalanceDefinitionPayload.js.map +0 -1
  409. package/dist/model/createBalanceLimitPayload.d.ts +0 -35
  410. package/dist/model/createBalanceLimitPayload.js +0 -62
  411. package/dist/model/createBalanceLimitPayload.js.map +0 -1
  412. package/dist/model/createBalancePayload.d.ts +0 -14
  413. package/dist/model/createBalancePayload.js +0 -18
  414. package/dist/model/createBalancePayload.js.map +0 -1
  415. package/dist/model/createEmailCampaignEmailExpirationDate.d.ts +0 -22
  416. package/dist/model/createEmailCampaignEmailExpirationDate.js +0 -31
  417. package/dist/model/createEmailCampaignEmailExpirationDate.js.map +0 -1
  418. package/dist/model/createLoyaltyProgramPayload.d.ts +0 -19
  419. package/dist/model/createLoyaltyProgramPayload.js +0 -33
  420. package/dist/model/createLoyaltyProgramPayload.js.map +0 -1
  421. package/dist/model/createOrderPayload.d.ts +0 -22
  422. package/dist/model/createOrderPayload.js +0 -48
  423. package/dist/model/createOrderPayload.js.map +0 -1
  424. package/dist/model/createSubscriptionPayload.d.ts +0 -16
  425. package/dist/model/createSubscriptionPayload.js +0 -28
  426. package/dist/model/createSubscriptionPayload.js.map +0 -1
  427. package/dist/model/createSubscriptionResponse.d.ts +0 -20
  428. package/dist/model/createSubscriptionResponse.js +0 -48
  429. package/dist/model/createSubscriptionResponse.js.map +0 -1
  430. package/dist/model/createTierGroupRequest.d.ts +0 -29
  431. package/dist/model/createTierGroupRequest.js +0 -51
  432. package/dist/model/createTierGroupRequest.js.map +0 -1
  433. package/dist/model/createTransactionPayload.d.ts +0 -24
  434. package/dist/model/createTransactionPayload.js +0 -58
  435. package/dist/model/createTransactionPayload.js.map +0 -1
  436. package/dist/model/crmAttributesPost200Response.d.ts +0 -14
  437. package/dist/model/crmAttributesPost200Response.js +0 -18
  438. package/dist/model/crmAttributesPost200Response.js.map +0 -1
  439. package/dist/model/crmAttributesPostRequest.d.ts +0 -33
  440. package/dist/model/crmAttributesPostRequest.js +0 -55
  441. package/dist/model/crmAttributesPostRequest.js.map +0 -1
  442. package/dist/model/errorResponse.d.ts +0 -14
  443. package/dist/model/errorResponse.js +0 -18
  444. package/dist/model/errorResponse.js.map +0 -1
  445. package/dist/model/fetchTemplatePreview.d.ts +0 -16
  446. package/dist/model/fetchTemplatePreview.js +0 -28
  447. package/dist/model/fetchTemplatePreview.js.map +0 -1
  448. package/dist/model/getSegment.d.ts +0 -17
  449. package/dist/model/getSegment.js +0 -33
  450. package/dist/model/getSegment.js.map +0 -1
  451. package/dist/model/loyaltyProgram.d.ts +0 -33
  452. package/dist/model/loyaltyProgram.js +0 -80
  453. package/dist/model/loyaltyProgram.js.map +0 -1
  454. package/dist/model/loyaltyProgramPage.d.ts +0 -15
  455. package/dist/model/loyaltyProgramPage.js +0 -18
  456. package/dist/model/loyaltyProgramPage.js.map +0 -1
  457. package/dist/model/loyaltyProgramValidationError.d.ts +0 -16
  458. package/dist/model/loyaltyProgramValidationError.js +0 -28
  459. package/dist/model/loyaltyProgramValidationError.js.map +0 -1
  460. package/dist/model/loyaltyTierPage.d.ts +0 -15
  461. package/dist/model/loyaltyTierPage.js +0 -18
  462. package/dist/model/loyaltyTierPage.js.map +0 -1
  463. package/dist/model/mainAttributeRewardPayload.d.ts +0 -22
  464. package/dist/model/mainAttributeRewardPayload.js +0 -48
  465. package/dist/model/mainAttributeRewardPayload.js.map +0 -1
  466. package/dist/model/mainBillingPayload.d.ts +0 -20
  467. package/dist/model/mainBillingPayload.js +0 -48
  468. package/dist/model/mainBillingPayload.js.map +0 -1
  469. package/dist/model/mainCodeCountHttpResponse.d.ts +0 -14
  470. package/dist/model/mainCodeCountHttpResponse.js +0 -18
  471. package/dist/model/mainCodeCountHttpResponse.js.map +0 -1
  472. package/dist/model/mainCreateRedeemPayload.d.ts +0 -24
  473. package/dist/model/mainCreateRedeemPayload.js +0 -53
  474. package/dist/model/mainCreateRedeemPayload.js.map +0 -1
  475. package/dist/model/mainCreateRewardPayload.d.ts +0 -17
  476. package/dist/model/mainCreateRewardPayload.js +0 -33
  477. package/dist/model/mainCreateRewardPayload.js.map +0 -1
  478. package/dist/model/mainCreateRewardResponse.d.ts +0 -21
  479. package/dist/model/mainCreateRewardResponse.js +0 -53
  480. package/dist/model/mainCreateRewardResponse.js.map +0 -1
  481. package/dist/model/mainErrorResponse.d.ts +0 -14
  482. package/dist/model/mainErrorResponse.js +0 -18
  483. package/dist/model/mainErrorResponse.js.map +0 -1
  484. package/dist/model/mainFilter.d.ts +0 -15
  485. package/dist/model/mainFilter.js +0 -23
  486. package/dist/model/mainFilter.js.map +0 -1
  487. package/dist/model/mainGenerator.d.ts +0 -19
  488. package/dist/model/mainGenerator.js +0 -43
  489. package/dist/model/mainGenerator.js.map +0 -1
  490. package/dist/model/mainGetContactRewardsPayload.d.ts +0 -31
  491. package/dist/model/mainGetContactRewardsPayload.js +0 -60
  492. package/dist/model/mainGetContactRewardsPayload.js.map +0 -1
  493. package/dist/model/mainIdentifiersPayload.d.ts +0 -15
  494. package/dist/model/mainIdentifiersPayload.js +0 -23
  495. package/dist/model/mainIdentifiersPayload.js.map +0 -1
  496. package/dist/model/mainLimit.d.ts +0 -21
  497. package/dist/model/mainLimit.js +0 -53
  498. package/dist/model/mainLimit.js.map +0 -1
  499. package/dist/model/mainModelContactReward.d.ts +0 -25
  500. package/dist/model/mainModelContactReward.js +0 -63
  501. package/dist/model/mainModelContactReward.js.map +0 -1
  502. package/dist/model/mainModelContactRewardsResp.d.ts +0 -19
  503. package/dist/model/mainModelContactRewardsResp.js +0 -38
  504. package/dist/model/mainModelContactRewardsResp.js.map +0 -1
  505. package/dist/model/mainNodeResponse.d.ts +0 -21
  506. package/dist/model/mainNodeResponse.js +0 -53
  507. package/dist/model/mainNodeResponse.js.map +0 -1
  508. package/dist/model/mainOrderPayload.d.ts +0 -28
  509. package/dist/model/mainOrderPayload.js +0 -73
  510. package/dist/model/mainOrderPayload.js.map +0 -1
  511. package/dist/model/mainProduct.d.ts +0 -17
  512. package/dist/model/mainProduct.js +0 -33
  513. package/dist/model/mainProduct.js.map +0 -1
  514. package/dist/model/mainProductPayload.d.ts +0 -18
  515. package/dist/model/mainProductPayload.js +0 -38
  516. package/dist/model/mainProductPayload.js.map +0 -1
  517. package/dist/model/mainRedeem.d.ts +0 -29
  518. package/dist/model/mainRedeem.js +0 -83
  519. package/dist/model/mainRedeem.js.map +0 -1
  520. package/dist/model/mainResultParameterResponse.d.ts +0 -16
  521. package/dist/model/mainResultParameterResponse.js +0 -23
  522. package/dist/model/mainResultParameterResponse.js.map +0 -1
  523. package/dist/model/mainReward.d.ts +0 -67
  524. package/dist/model/mainReward.js +0 -224
  525. package/dist/model/mainReward.js.map +0 -1
  526. package/dist/model/mainRewardAttribution.d.ts +0 -26
  527. package/dist/model/mainRewardAttribution.js +0 -68
  528. package/dist/model/mainRewardAttribution.js.map +0 -1
  529. package/dist/model/mainRewardConfigurations.d.ts +0 -16
  530. package/dist/model/mainRewardConfigurations.js +0 -28
  531. package/dist/model/mainRewardConfigurations.js.map +0 -1
  532. package/dist/model/mainRewardPage.d.ts +0 -16
  533. package/dist/model/mainRewardPage.js +0 -23
  534. package/dist/model/mainRewardPage.js.map +0 -1
  535. package/dist/model/mainRewardPageObj.d.ts +0 -22
  536. package/dist/model/mainRewardPageObj.js +0 -58
  537. package/dist/model/mainRewardPageObj.js.map +0 -1
  538. package/dist/model/mainRewardValidate.d.ts +0 -14
  539. package/dist/model/mainRewardValidate.js +0 -18
  540. package/dist/model/mainRewardValidate.js.map +0 -1
  541. package/dist/model/mainRule.d.ts +0 -31
  542. package/dist/model/mainRule.js +0 -78
  543. package/dist/model/mainRule.js.map +0 -1
  544. package/dist/model/mainRuleConditionResponse.d.ts +0 -19
  545. package/dist/model/mainRuleConditionResponse.js +0 -38
  546. package/dist/model/mainRuleConditionResponse.js.map +0 -1
  547. package/dist/model/mainRuleEventResponse.d.ts +0 -15
  548. package/dist/model/mainRuleEventResponse.js +0 -23
  549. package/dist/model/mainRuleEventResponse.js.map +0 -1
  550. package/dist/model/mainRuleResultResponse.d.ts +0 -17
  551. package/dist/model/mainRuleResultResponse.js +0 -28
  552. package/dist/model/mainRuleResultResponse.js.map +0 -1
  553. package/dist/model/mainValidateRewardPayload.d.ts +0 -19
  554. package/dist/model/mainValidateRewardPayload.js +0 -43
  555. package/dist/model/mainValidateRewardPayload.js.map +0 -1
  556. package/dist/model/mainValueResponse.d.ts +0 -22
  557. package/dist/model/mainValueResponse.js +0 -53
  558. package/dist/model/mainValueResponse.js.map +0 -1
  559. package/dist/model/mainVoucherRevokePayload.d.ts +0 -14
  560. package/dist/model/mainVoucherRevokePayload.js +0 -18
  561. package/dist/model/mainVoucherRevokePayload.js.map +0 -1
  562. package/dist/model/memberContact.d.ts +0 -16
  563. package/dist/model/memberContact.js +0 -28
  564. package/dist/model/memberContact.js.map +0 -1
  565. package/dist/model/modelSubscriptionBalanceResp.d.ts +0 -15
  566. package/dist/model/modelSubscriptionBalanceResp.js +0 -18
  567. package/dist/model/modelSubscriptionBalanceResp.js.map +0 -1
  568. package/dist/model/orderIdentifiers.d.ts +0 -17
  569. package/dist/model/orderIdentifiers.js +0 -33
  570. package/dist/model/orderIdentifiers.js.map +0 -1
  571. package/dist/model/patchLoyaltyProgramPayload.d.ts +0 -16
  572. package/dist/model/patchLoyaltyProgramPayload.js +0 -28
  573. package/dist/model/patchLoyaltyProgramPayload.js.map +0 -1
  574. package/dist/model/sendTransacSmsTag.d.ts +0 -14
  575. package/dist/model/sendTransacSmsTag.js +0 -18
  576. package/dist/model/sendTransacSmsTag.js.map +0 -1
  577. package/dist/model/subAccountDetailsResponsePlanInfoCreditsExternalFeeds.d.ts +0 -15
  578. package/dist/model/subAccountDetailsResponsePlanInfoCreditsExternalFeeds.js +0 -23
  579. package/dist/model/subAccountDetailsResponsePlanInfoCreditsExternalFeeds.js.map +0 -1
  580. package/dist/model/subAccountDetailsResponsePlanInfoCreditsWhatsapp.d.ts +0 -15
  581. package/dist/model/subAccountDetailsResponsePlanInfoCreditsWhatsapp.js +0 -23
  582. package/dist/model/subAccountDetailsResponsePlanInfoCreditsWhatsapp.js.map +0 -1
  583. package/dist/model/subAccountDetailsResponsePlanInfoFeaturesSalesUsers.d.ts +0 -15
  584. package/dist/model/subAccountDetailsResponsePlanInfoFeaturesSalesUsers.js +0 -23
  585. package/dist/model/subAccountDetailsResponsePlanInfoFeaturesSalesUsers.js.map +0 -1
  586. package/dist/model/subAccountsUpdatePlanRequest.d.ts +0 -18
  587. package/dist/model/subAccountsUpdatePlanRequest.js +0 -28
  588. package/dist/model/subAccountsUpdatePlanRequest.js.map +0 -1
  589. package/dist/model/subAccountsUpdatePlanRequestCredits.d.ts +0 -18
  590. package/dist/model/subAccountsUpdatePlanRequestCredits.js +0 -38
  591. package/dist/model/subAccountsUpdatePlanRequestCredits.js.map +0 -1
  592. package/dist/model/subAccountsUpdatePlanRequestFeatures.d.ts +0 -16
  593. package/dist/model/subAccountsUpdatePlanRequestFeatures.js +0 -28
  594. package/dist/model/subAccountsUpdatePlanRequestFeatures.js.map +0 -1
  595. package/dist/model/subscription.d.ts +0 -20
  596. package/dist/model/subscription.js +0 -48
  597. package/dist/model/subscription.js.map +0 -1
  598. package/dist/model/subscriptionAggregateBalance.d.ts +0 -15
  599. package/dist/model/subscriptionAggregateBalance.js +0 -23
  600. package/dist/model/subscriptionAggregateBalance.js.map +0 -1
  601. package/dist/model/subscriptionAttributedReward.d.ts +0 -24
  602. package/dist/model/subscriptionAttributedReward.js +0 -58
  603. package/dist/model/subscriptionAttributedReward.js.map +0 -1
  604. package/dist/model/subscriptionBalances.d.ts +0 -17
  605. package/dist/model/subscriptionBalances.js +0 -28
  606. package/dist/model/subscriptionBalances.js.map +0 -1
  607. package/dist/model/subscriptionHandlerInfo.d.ts +0 -21
  608. package/dist/model/subscriptionHandlerInfo.js +0 -33
  609. package/dist/model/subscriptionHandlerInfo.js.map +0 -1
  610. package/dist/model/subscriptionMember.d.ts +0 -18
  611. package/dist/model/subscriptionMember.js +0 -38
  612. package/dist/model/subscriptionMember.js.map +0 -1
  613. package/dist/model/subscriptionTier.d.ts +0 -22
  614. package/dist/model/subscriptionTier.js +0 -48
  615. package/dist/model/subscriptionTier.js.map +0 -1
  616. package/dist/model/templatePreview.d.ts +0 -19
  617. package/dist/model/templatePreview.js +0 -43
  618. package/dist/model/templatePreview.js.map +0 -1
  619. package/dist/model/tier.d.ts +0 -24
  620. package/dist/model/tier.js +0 -58
  621. package/dist/model/tier.js.map +0 -1
  622. package/dist/model/tierAccessConditionsInner.d.ts +0 -17
  623. package/dist/model/tierAccessConditionsInner.js +0 -33
  624. package/dist/model/tierAccessConditionsInner.js.map +0 -1
  625. package/dist/model/tierForContact.d.ts +0 -22
  626. package/dist/model/tierForContact.js +0 -48
  627. package/dist/model/tierForContact.js.map +0 -1
  628. package/dist/model/tierGroup.d.ts +0 -33
  629. package/dist/model/tierGroup.js +0 -71
  630. package/dist/model/tierGroup.js.map +0 -1
  631. package/dist/model/tierGroupPage.d.ts +0 -15
  632. package/dist/model/tierGroupPage.js +0 -18
  633. package/dist/model/tierGroupPage.js.map +0 -1
  634. package/dist/model/tierRequest.d.ts +0 -19
  635. package/dist/model/tierRequest.js +0 -33
  636. package/dist/model/tierRequest.js.map +0 -1
  637. package/dist/model/tierRequestAccessConditionsInner.d.ts +0 -15
  638. package/dist/model/tierRequestAccessConditionsInner.js +0 -23
  639. package/dist/model/tierRequestAccessConditionsInner.js.map +0 -1
  640. package/dist/model/tierRequestPutPayload.d.ts +0 -19
  641. package/dist/model/tierRequestPutPayload.js +0 -33
  642. package/dist/model/tierRequestPutPayload.js.map +0 -1
  643. package/dist/model/tierRequestTierRewardsInner.d.ts +0 -14
  644. package/dist/model/tierRequestTierRewardsInner.js +0 -18
  645. package/dist/model/tierRequestTierRewardsInner.js.map +0 -1
  646. package/dist/model/tierTierRewardsInner.d.ts +0 -16
  647. package/dist/model/tierTierRewardsInner.js +0 -28
  648. package/dist/model/tierTierRewardsInner.js.map +0 -1
  649. package/dist/model/transaction.d.ts +0 -30
  650. package/dist/model/transaction.js +0 -88
  651. package/dist/model/transaction.js.map +0 -1
  652. package/dist/model/transactionHistory.d.ts +0 -25
  653. package/dist/model/transactionHistory.js +0 -63
  654. package/dist/model/transactionHistory.js.map +0 -1
  655. package/dist/model/transactionHistoryResp.d.ts +0 -19
  656. package/dist/model/transactionHistoryResp.js +0 -38
  657. package/dist/model/transactionHistoryResp.js.map +0 -1
  658. package/dist/model/unauthorizedResponse.d.ts +0 -14
  659. package/dist/model/unauthorizedResponse.js +0 -18
  660. package/dist/model/unauthorizedResponse.js.map +0 -1
  661. package/dist/model/updateBalanceDefinitionPayload.d.ts +0 -77
  662. package/dist/model/updateBalanceDefinitionPayload.js +0 -145
  663. package/dist/model/updateBalanceDefinitionPayload.js.map +0 -1
  664. package/dist/model/updateBalanceLimitPayload.d.ts +0 -35
  665. package/dist/model/updateBalanceLimitPayload.js +0 -62
  666. package/dist/model/updateBalanceLimitPayload.js.map +0 -1
  667. package/dist/model/updateEmailCampaignEmailExpirationDate.d.ts +0 -22
  668. package/dist/model/updateEmailCampaignEmailExpirationDate.js +0 -31
  669. package/dist/model/updateEmailCampaignEmailExpirationDate.js.map +0 -1
  670. package/dist/model/updateLoyaltyProgramPayload.d.ts +0 -16
  671. package/dist/model/updateLoyaltyProgramPayload.js +0 -28
  672. package/dist/model/updateLoyaltyProgramPayload.js.map +0 -1
  673. package/dist/model/updateTierGroupRequest.d.ts +0 -29
  674. package/dist/model/updateTierGroupRequest.js +0 -51
  675. package/dist/model/updateTierGroupRequest.js.map +0 -1
package/README.md CHANGED
@@ -1,156 +1,234 @@
1
- # Brevo typescript
1
+ # Brevo Node SDK
2
2
 
3
- Brevo's API v3 TypeScript-Node Library
3
+ > ⚠️ **Important Notice**: This is the current stable version but we are currently working on rebuilding our Node library from scratch.
4
4
 
5
- Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) to learn more.
5
+ ## Overview
6
6
 
7
- This is the wrapper for the API. It implements all the features of the API v3. It supports promises.
7
+ Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) to see all the supported operations.
8
8
 
9
9
  Brevo's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/swagger_definition_v3.yml).
10
10
 
11
- ## Installation
11
+ Our current library is not fully compatible with all modern Node.js and TypeScript environments. To help you integrate Brevo into your applications, we're providing both plain Node.js and TypeScript-specific implementation approaches below while we work on the next generation of our SDK.
12
12
 
13
- ### For [Node.js](https://nodejs.org/)
13
+ ## Table of Contents
14
14
 
15
- #### npm
15
+ - [Node.js Implementation](#nodejs-implementation)
16
+ - [Send Transactional Email](#send-transactional-email)
17
+ - [Create Contact](#create-contact)
18
+ - [TypeScript Implementation](#typescript-implementation)
19
+ - [Send Transactional Email](#send-transactional-email-1)
20
+ - [Create Contact](#create-contact-1)
21
+ - [Support](#support)
22
+ - [License](#license)
16
23
 
17
- The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/).
24
+ ## Node.js Implementation
18
25
 
19
- Then install it via:
26
+ ### Send Transactional Email
20
27
 
21
- ```shell
28
+ #### Installation
29
+
30
+ ```bash
22
31
  npm i @getbrevo/brevo --save
23
- # or
24
- yarn add @getbrevo/brevo
25
32
  ```
26
33
 
27
- ## Getting Started
28
-
34
+ #### Import packages
29
35
 
36
+ ```javascript
37
+ import { TransactionalEmailsApi, SendSmtpEmail } from "@getbrevo/brevo";
38
+ ```
30
39
 
31
- # We have two options:
32
- - First example is where **typescript is not supported** i.e. [v1.0.1]([url](https://www.npmjs.com/package/@getbrevo/brevo/v/1.0.1))
33
- - Second example is where **typescript is supported** i.e. [v2.1.1]([url](https://www.npmjs.com/package/@getbrevo/brevo/v/2.1.1))
40
+ #### Instantiate API with your credentials
34
41
 
42
+ ```javascript
43
+ let emailAPI = new TransactionalEmailsApi();
44
+ emailAPI.authentications.apiKey.apiKey = "xkeysib-xxxxxxxxxxxxxxxxxxxxx"
45
+ ```
35
46
 
36
- ```shell
37
- -------------------------------------------------------------------------------------------------------------------------
38
- ---------------------------------------------- Typescript not supported v1.0.1 ---------------------------------------
39
- -------------------------------------------------------------------------------------------------------------------------
40
- const brevo = require('@getbrevo/brevo');
41
- let defaultClient = brevo.ApiClient.instance;
47
+ #### Build your message
42
48
 
43
- let apiKey = defaultClient.authentications['api-key'];
44
- apiKey.apiKey = 'YOUR API KEY';
49
+ ```javascript
50
+ let message = new SendSmtpEmail();
51
+ message.subject = "First email";
52
+ message.textContent = "Hello world!";
53
+ message.sender = { name: "John Doe", email: "john.doe@example.com" };
54
+ message.to = [{ email: "jane.smith@example.com", name: "Jane Smith" }];
55
+ ```
45
56
 
46
- let apiInstance = new brevo.TransactionalEmailsApi();
47
- let sendSmtpEmail = new brevo.SendSmtpEmail();
57
+ #### Send the message
48
58
 
49
- sendSmtpEmail.subject = "My {{params.subject}}";
50
- sendSmtpEmail.htmlContent = "<html><body><h1>Common: This is my first transactional email {{params.parameter}}</h1></body></html>";
51
- sendSmtpEmail.sender = { "name": "John", "email": "example@example.com" };
52
- sendSmtpEmail.to = [
53
- { "email": "example@brevo.com", "name": "sample-name" }
54
- ];
55
- sendSmtpEmail.replyTo = { "email": "example@brevo.com", "name": "sample-name" };
56
- sendSmtpEmail.headers = { "Some-Custom-Name": "unique-id-1234" };
57
- sendSmtpEmail.params = { "parameter": "My param value", "subject": "common subject" };
59
+ ```javascript
60
+ emailAPI.sendTransacEmail(message)
61
+ ```
58
62
 
63
+ #### (Optional) Log the response
59
64
 
60
- apiInstance.sendTransacEmail(sendSmtpEmail).then(function (data) {
61
- console.log('API called successfully. Returned data: ' + JSON.stringify(data));
62
- }, function (error) {
63
- console.error(error);
65
+ ```javascript
66
+ emailAPI.sendTransacEmail(message).then(res => {
67
+ console.log(JSON.stringify(res.body));
68
+ }).catch(err => {
69
+ console.error("Error sending email:", err.body);
64
70
  });
71
+ ```
72
+
73
+ ### Create Contact
65
74
 
75
+ #### Installation
76
+
77
+ ```bash
78
+ npm i @getbrevo/brevo --save
66
79
  ```
67
- -------------------------------------------------------------------------------------------------------------------------
68
- ## Typescript supported with version v2.1.1
69
80
 
70
- ```shell
71
- -------------------------------------------------------------------------------------------------------------------------
72
- ---------------------------------------------- Typescript supported with v2.1.1 --------------------------------------
73
- -------------------------------------------------------------------------------------------------------------------------
74
- const brevo = require('@getbrevo/brevo');
75
- let apiInstance = new brevo.TransactionalEmailsApi();
81
+ #### Import packages
76
82
 
77
- let apiKey = apiInstance.authentications['api-key'];
78
- apiKey.apiKey = 'YOUR API KEY';
83
+ ```javascript
84
+ import { CreateContact, ContactsApi } from "@getbrevo/brevo";
85
+ ```
86
+
87
+ #### Instantiate API with your credentials
79
88
 
80
- let sendSmtpEmail = new brevo.SendSmtpEmail();
89
+ ```javascript
90
+ let contactAPI = new ContactsApi();
91
+ contactAPI.authentications.apiKey.apiKey = "xkeysib-xxxxxx"
92
+ ```
81
93
 
82
- sendSmtpEmail.subject = "My {{params.subject}}";
83
- sendSmtpEmail.htmlContent = "<html><body><h1>Common: This is my first transactional email {{params.parameter}}</h1></body></html>";
84
- sendSmtpEmail.sender = { "name": "John", "email": "shubham.upadhyay@sendinblue.com" };
85
- sendSmtpEmail.to = [
86
- { "email": "shubham.upadhyay@sendinblue.com", "name": "shubham upadhyay" }
87
- ];
88
- sendSmtpEmail.replyTo = { "email": "shubham.upadhyay@sendinblue.com", "name": "Shubham Upadhyay" };
89
- sendSmtpEmail.headers = { "Some-Custom-Name": "unique-id-1234" };
90
- sendSmtpEmail.params = { "parameter": "My param value", "subject": "common subject" };
94
+ #### Build your contact
95
+
96
+ ```javascript
97
+ let contact = new CreateContact();
98
+ contact.email = "alice.johnson@example.com";
99
+ contact.attributes = {
100
+ FIRSTNAME: "Alice",
101
+ LASTNAME: "Johnson",
102
+ };
103
+ ```
91
104
 
105
+ #### Create the contact
92
106
 
93
- apiInstance.sendTransacEmail(sendSmtpEmail).then(function (data) {
94
- console.log('API called successfully. Returned data: ' + JSON.stringify(data));
95
- }, function (error) {
96
- console.error(error);
107
+ ```javascript
108
+ contactAPI.createContact(contact).then(res => {
109
+ console.log(JSON.stringify(res.body));
110
+ }).catch(err => {
111
+ console.error("Error creating contact:", err.body);
97
112
  });
113
+ ```
98
114
 
115
+ ## TypeScript Implementation
116
+
117
+ ### Recommended tsconfig.json Settings
118
+
119
+ We recommend using the following TypeScript configuration for optimal compatibility:
120
+
121
+ ```json
122
+ {
123
+ "compilerOptions": {
124
+ "target": "es2020",
125
+ "module": "commonjs",
126
+ "outDir": "dist",
127
+ "rootDir": "src",
128
+ "strict": true,
129
+ "esModuleInterop": true,
130
+ "skipLibCheck": true
131
+ },
132
+ "include": ["src"]
133
+ }
99
134
  ```
100
- -------------------------------------------------------------------------------------------------------------------------
101
- ## Get Contact attributes API example:
102
135
 
103
- ```shell
104
- const brevo = require('@getbrevo/brevo');
136
+ ### Send Transactional Email
105
137
 
106
- let apiInstance = new brevo.ContactsApi()
138
+ #### Installation
107
139
 
108
- let apiKey = apiInstance.authentications['api-key'];
109
- apiKey.apiKey = 'YOUR API KEY';
140
+ ```bash
141
+ npm i @getbrevo/brevo --save
142
+ ```
110
143
 
111
- apiInstance.getAttributes().then(function(data) {
112
- console.log('API called successfully. Returned data: ' + JSON.stringify(data));
144
+ #### Import packages
113
145
 
114
- }, function(error) {
115
- console.error(error);
116
- });
146
+ ```typescript
147
+ import { TransactionalEmailsApi, SendSmtpEmail } from "@getbrevo/brevo";
148
+ ```
149
+
150
+ #### Instantiate API with your credentials
117
151
 
152
+ ```typescript
153
+ let emailAPI = new TransactionalEmailsApi();
154
+ (emailAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxxxxxxxxxxxxxx";
118
155
  ```
119
- -------------------------------------------------------------------------------------------------------------------------
120
- ## Get Account API example:
121
156
 
122
- ```shell
123
- const brevo = require('@getbrevo/brevo');
157
+ #### Build your message
124
158
 
125
- let apiInstance = new brevo.AccountApi()
159
+ ```typescript
160
+ let message = new SendSmtpEmail();
161
+ message.subject = "First email";
162
+ message.textContent = "Hello world!";
163
+ message.sender = { name: "Bob Wilson", email: "bob.wilson@example.com" };
164
+ message.to = [{ email: "sarah.davis@example.com", name: "Sarah Davis" }];
165
+ ```
126
166
 
127
- let apiKey = apiInstance.authentications['api-key'];
128
- apiKey.apiKey = 'YOUR API KEY';
167
+ #### Send the message
129
168
 
130
- apiInstance.getAccount().then(function(data) {
131
- console.log('API called successfully. Returned data: ' + JSON.stringify(data));
169
+ ```typescript
170
+ emailAPI.sendTransacEmail(message)
171
+ ```
132
172
 
133
- }, function(error) {
134
- console.error(error);
135
- });
173
+ #### (Optional) Log the response
174
+
175
+ ```typescript
176
+ emailAPI
177
+ .sendTransacEmail(message)
178
+ .then((res) => {
179
+ console.log(JSON.stringify(res.body));
180
+ })
181
+ .catch((err) => {
182
+ console.error("Error sending email:", err.body);
183
+ });
184
+ ```
185
+
186
+ ### Create Contact
187
+
188
+ #### Installation
136
189
 
190
+ ```bash
191
+ npm i @getbrevo/brevo --save
137
192
  ```
138
- -------------------------------------------------------------------------------------------------------------------------
139
- ## Get Contacts API example:
140
- ```shell
141
- const brevo = require('@getbrevo/brevo');
142
193
 
143
- let apiInstance = new brevo.ContactsApi()
194
+ #### Import packages
144
195
 
145
- let apiKey = apiInstance.authentications['api-key'];
146
- apiKey.apiKey = 'YOUR API KEY';
196
+ ```typescript
197
+ import { CreateContact, ContactsApi } from "@getbrevo/brevo";
198
+ ```
147
199
 
148
- apiInstance.getContacts().then(function(data) {
149
- console.log('API called successfully. Returned data: ' + JSON.stringify(data));
200
+ #### Instantiate API with your credentials
150
201
 
151
- }, function(error) {
152
- console.error(error);
202
+ ```typescript
203
+ let contactAPI = new ContactsApi();
204
+ (contactAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxx"
205
+ ```
206
+
207
+ #### Build your contact
208
+
209
+ ```typescript
210
+ let contact = new CreateContact();
211
+ contact.email = "michael.brown@example.com";
212
+ contact.attributes = {
213
+ FIRSTNAME: { value: "Michael" },
214
+ LASTNAME: { value: "Brown" },
215
+ };
216
+ ```
217
+
218
+ #### Create the contact
219
+
220
+ ```typescript
221
+ contactAPI.createContact(contact).then(res => {
222
+ console.log(JSON.stringify(res.body));
223
+ }).catch(err => {
224
+ console.error("Error creating contact:", err.body);
153
225
  });
154
226
  ```
155
227
 
156
- For more examples, refer the [Endpoints Guide](https://developers.brevo.com/reference)
228
+ ## Support
229
+
230
+ For questions and support, please refer to our [documentation](https://developers.brevo.com) or contact our support team.
231
+
232
+ ## License
233
+
234
+ This SDK is distributed under the MIT License.
package/api/accountApi.ts CHANGED
@@ -11,7 +11,7 @@
11
11
  */
12
12
 
13
13
 
14
- import localVarRequest from 'request';
14
+ import localVarRequest, { RequestOptions } from '../requestCompat';
15
15
  import http from 'http';
16
16
 
17
17
  /* tslint:disable:no-unused-locals */
@@ -114,11 +114,11 @@ export class AccountApi {
114
114
 
115
115
  let localVarUseFormData = false;
116
116
 
117
- let localVarRequestOptions: localVarRequest.Options = {
117
+ let localVarRequestOptions: RequestOptions = {
118
118
  method: 'GET',
119
119
  qs: localVarQueryParameters,
120
120
  headers: localVarHeaderParams,
121
- uri: localVarPath,
121
+ url: localVarPath,
122
122
  useQuerystring: this._useQuerystring,
123
123
  json: true,
124
124
  };
@@ -202,11 +202,11 @@ export class AccountApi {
202
202
 
203
203
  let localVarUseFormData = false;
204
204
 
205
- let localVarRequestOptions: localVarRequest.Options = {
205
+ let localVarRequestOptions: RequestOptions = {
206
206
  method: 'GET',
207
207
  qs: localVarQueryParameters,
208
208
  headers: localVarHeaderParams,
209
- uri: localVarPath,
209
+ url: localVarPath,
210
210
  useQuerystring: this._useQuerystring,
211
211
  json: true,
212
212
  };
package/api/companiesApi.ts CHANGED
@@ -11,7 +11,7 @@
11
11
  */
12
12
 
13
13
 
14
- import localVarRequest from 'request';
14
+ import localVarRequest, { RequestOptions } from '../requestCompat';
15
15
  import http from 'http';
16
16
 
17
17
  /* tslint:disable:no-unused-locals */
@@ -119,11 +119,11 @@ export class CompaniesApi {
119
119
 
120
120
  let localVarUseFormData = false;
121
121
 
122
- let localVarRequestOptions: localVarRequest.Options = {
122
+ let localVarRequestOptions: RequestOptions = {
123
123
  method: 'GET',
124
124
  qs: localVarQueryParameters,
125
125
  headers: localVarHeaderParams,
126
- uri: localVarPath,
126
+ url: localVarPath,
127
127
  useQuerystring: this._useQuerystring,
128
128
  json: true,
129
129
  };
@@ -222,11 +222,11 @@ export class CompaniesApi {
222
222
 
223
223
  let localVarUseFormData = false;
224
224
 
225
- let localVarRequestOptions: localVarRequest.Options = {
225
+ let localVarRequestOptions: RequestOptions = {
226
226
  method: 'GET',
227
227
  qs: localVarQueryParameters,
228
228
  headers: localVarHeaderParams,
229
- uri: localVarPath,
229
+ url: localVarPath,
230
230
  useQuerystring: this._useQuerystring,
231
231
  json: true,
232
232
  };
@@ -297,11 +297,11 @@ export class CompaniesApi {
297
297
 
298
298
  let localVarUseFormData = false;
299
299
 
300
- let localVarRequestOptions: localVarRequest.Options = {
300
+ let localVarRequestOptions: RequestOptions = {
301
301
  method: 'DELETE',
302
302
  qs: localVarQueryParameters,
303
303
  headers: localVarHeaderParams,
304
- uri: localVarPath,
304
+ url: localVarPath,
305
305
  useQuerystring: this._useQuerystring,
306
306
  json: true,
307
307
  };
@@ -371,11 +371,11 @@ export class CompaniesApi {
371
371
 
372
372
  let localVarUseFormData = false;
373
373
 
374
- let localVarRequestOptions: localVarRequest.Options = {
374
+ let localVarRequestOptions: RequestOptions = {
375
375
  method: 'GET',
376
376
  qs: localVarQueryParameters,
377
377
  headers: localVarHeaderParams,
378
- uri: localVarPath,
378
+ url: localVarPath,
379
379
  useQuerystring: this._useQuerystring,
380
380
  json: true,
381
381
  };
@@ -452,11 +452,11 @@ export class CompaniesApi {
452
452
 
453
453
  let localVarUseFormData = false;
454
454
 
455
- let localVarRequestOptions: localVarRequest.Options = {
455
+ let localVarRequestOptions: RequestOptions = {
456
456
  method: 'PATCH',
457
457
  qs: localVarQueryParameters,
458
458
  headers: localVarHeaderParams,
459
- uri: localVarPath,
459
+ url: localVarPath,
460
460
  useQuerystring: this._useQuerystring,
461
461
  json: true,
462
462
  body: ObjectSerializer.serialize(body, "CompaniesIdPatchRequest")
@@ -534,11 +534,11 @@ export class CompaniesApi {
534
534
 
535
535
  let localVarUseFormData = false;
536
536
 
537
- let localVarRequestOptions: localVarRequest.Options = {
537
+ let localVarRequestOptions: RequestOptions = {
538
538
  method: 'PATCH',
539
539
  qs: localVarQueryParameters,
540
540
  headers: localVarHeaderParams,
541
- uri: localVarPath,
541
+ url: localVarPath,
542
542
  useQuerystring: this._useQuerystring,
543
543
  json: true,
544
544
  body: ObjectSerializer.serialize(body, "CompaniesLinkUnlinkIdPatchRequest")
@@ -608,11 +608,11 @@ export class CompaniesApi {
608
608
 
609
609
  let localVarUseFormData = false;
610
610
 
611
- let localVarRequestOptions: localVarRequest.Options = {
611
+ let localVarRequestOptions: RequestOptions = {
612
612
  method: 'POST',
613
613
  qs: localVarQueryParameters,
614
614
  headers: localVarHeaderParams,
615
- uri: localVarPath,
615
+ url: localVarPath,
616
616
  useQuerystring: this._useQuerystring,
617
617
  json: true,
618
618
  body: ObjectSerializer.serialize(body, "CompaniesPostRequest")