@getbrevo/brevo 1.0.0

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 (1074) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc +22 -0
  3. package/.github/CODEOWNERS +1 -0
  4. package/.github/workflows/release.yml +20 -0
  5. package/.swagger-codegen/VERSION +1 -0
  6. package/.swagger-codegen-ignore +23 -0
  7. package/.travis.yml +5 -0
  8. package/LICENSE.md +15 -0
  9. package/README.md +683 -0
  10. package/docs/AbTestCampaignResult.md +43 -0
  11. package/docs/AbTestCampaignResultClickedLinks.md +9 -0
  12. package/docs/AbTestCampaignResultStatistics.md +13 -0
  13. package/docs/AbTestVersionClicks.md +7 -0
  14. package/docs/AbTestVersionClicksInner.md +10 -0
  15. package/docs/AbTestVersionStats.md +9 -0
  16. package/docs/AccountApi.md +119 -0
  17. package/docs/AddChildDomain.md +8 -0
  18. package/docs/AddContactToList.md +9 -0
  19. package/docs/AddCredits.md +9 -0
  20. package/docs/AuthenticateDomainModel.md +9 -0
  21. package/docs/BlockDomain.md +8 -0
  22. package/docs/Body.md +10 -0
  23. package/docs/Body1.md +10 -0
  24. package/docs/Body10.md +11 -0
  25. package/docs/Body11.md +8 -0
  26. package/docs/Body12.md +11 -0
  27. package/docs/Body2.md +11 -0
  28. package/docs/Body3.md +9 -0
  29. package/docs/Body4.md +9 -0
  30. package/docs/Body5.md +11 -0
  31. package/docs/Body6.md +18 -0
  32. package/docs/Body7.md +17 -0
  33. package/docs/Body8.md +13 -0
  34. package/docs/Body9.md +8 -0
  35. package/docs/BodyVariablesItems.md +7 -0
  36. package/docs/CompaniesApi.md +406 -0
  37. package/docs/CompaniesList.md +8 -0
  38. package/docs/Company.md +11 -0
  39. package/docs/CompanyAttributes.md +7 -0
  40. package/docs/CompanyAttributesInner.md +12 -0
  41. package/docs/ComponentItems.md +9 -0
  42. package/docs/ContactsApi.md +1691 -0
  43. package/docs/ConversationsApi.md +518 -0
  44. package/docs/ConversationsMessage.md +28 -0
  45. package/docs/ConversationsMessageFile.md +12 -0
  46. package/docs/ConversationsMessageFileImageInfo.md +10 -0
  47. package/docs/CouponsApi.md +291 -0
  48. package/docs/CreateApiKeyRequest.md +9 -0
  49. package/docs/CreateApiKeyResponse.md +9 -0
  50. package/docs/CreateAttribute.md +30 -0
  51. package/docs/CreateAttributeEnumeration.md +9 -0
  52. package/docs/CreateCategoryModel.md +8 -0
  53. package/docs/CreateChild.md +32 -0
  54. package/docs/CreateContact.md +15 -0
  55. package/docs/CreateCouponCollection.md +9 -0
  56. package/docs/CreateCoupons.md +9 -0
  57. package/docs/CreateDoiContact.md +13 -0
  58. package/docs/CreateDomain.md +8 -0
  59. package/docs/CreateDomainModel.md +11 -0
  60. package/docs/CreateDomainModelDnsRecords.md +9 -0
  61. package/docs/CreateDomainModelDnsRecordsDkimRecord.md +11 -0
  62. package/docs/CreateEmailCampaign.md +49 -0
  63. package/docs/CreateEmailCampaignRecipients.md +10 -0
  64. package/docs/CreateEmailCampaignSender.md +10 -0
  65. package/docs/CreateExternalFeed.md +29 -0
  66. package/docs/CreateList.md +9 -0
  67. package/docs/CreateModel.md +8 -0
  68. package/docs/CreateProductModel.md +8 -0
  69. package/docs/CreateReseller.md +9 -0
  70. package/docs/CreateSender.md +10 -0
  71. package/docs/CreateSenderIps.md +10 -0
  72. package/docs/CreateSenderModel.md +10 -0
  73. package/docs/CreateSmsCampaign.md +15 -0
  74. package/docs/CreateSmsCampaignRecipients.md +9 -0
  75. package/docs/CreateSmtpEmail.md +9 -0
  76. package/docs/CreateSmtpTemplate.md +17 -0
  77. package/docs/CreateSmtpTemplateSender.md +10 -0
  78. package/docs/CreateSubAccount.md +30 -0
  79. package/docs/CreateSubAccountResponse.md +8 -0
  80. package/docs/CreateUpdateBatchCategory.md +9 -0
  81. package/docs/CreateUpdateBatchCategoryModel.md +9 -0
  82. package/docs/CreateUpdateBatchProducts.md +9 -0
  83. package/docs/CreateUpdateBatchProductsModel.md +9 -0
  84. package/docs/CreateUpdateCategories.md +11 -0
  85. package/docs/CreateUpdateCategory.md +12 -0
  86. package/docs/CreateUpdateContactModel.md +8 -0
  87. package/docs/CreateUpdateFolder.md +8 -0
  88. package/docs/CreateUpdateProduct.md +18 -0
  89. package/docs/CreateUpdateProducts.md +17 -0
  90. package/docs/CreateWebhook.md +66 -0
  91. package/docs/CreateWhatsAppCampaign.md +11 -0
  92. package/docs/CreateWhatsAppCampaignRecipients.md +10 -0
  93. package/docs/CreateWhatsAppTemplate.md +24 -0
  94. package/docs/CreatedBatchId.md +8 -0
  95. package/docs/CreatedProcessId.md +8 -0
  96. package/docs/Deal.md +11 -0
  97. package/docs/DealAttributes.md +7 -0
  98. package/docs/DealAttributesInner.md +12 -0
  99. package/docs/DealsApi.md +512 -0
  100. package/docs/DealsList.md +8 -0
  101. package/docs/DeleteHardbounces.md +10 -0
  102. package/docs/DomainsApi.md +278 -0
  103. package/docs/EcommerceApi.md +645 -0
  104. package/docs/EmailCampaignsApi.md +766 -0
  105. package/docs/EmailExportRecipients.md +32 -0
  106. package/docs/ErrorModel.md +48 -0
  107. package/docs/ExportWebhooksHistory.md +57 -0
  108. package/docs/ExternalFeedsApi.md +309 -0
  109. package/docs/FileData.md +14 -0
  110. package/docs/FileDownloadableLink.md +8 -0
  111. package/docs/FileList.md +7 -0
  112. package/docs/FilesApi.md +304 -0
  113. package/docs/GetAccount.md +10 -0
  114. package/docs/GetAccountActivity.md +8 -0
  115. package/docs/GetAccountActivityLogs.md +12 -0
  116. package/docs/GetAccountMarketingAutomation.md +9 -0
  117. package/docs/GetAccountPlan.md +39 -0
  118. package/docs/GetAccountRelay.md +9 -0
  119. package/docs/GetAccountRelayData.md +10 -0
  120. package/docs/GetAggregatedReport.md +20 -0
  121. package/docs/GetAllExternalFeeds.md +9 -0
  122. package/docs/GetAllExternalFeedsFeeds.md +32 -0
  123. package/docs/GetAttributes.md +8 -0
  124. package/docs/GetAttributesAttributes.md +46 -0
  125. package/docs/GetAttributesEnumeration.md +9 -0
  126. package/docs/GetBlockedDomains.md +8 -0
  127. package/docs/GetCampaignOverview.md +51 -0
  128. package/docs/GetCampaignRecipients.md +9 -0
  129. package/docs/GetCampaignStats.md +23 -0
  130. package/docs/GetCategories.md +9 -0
  131. package/docs/GetCategoryDetails.md +13 -0
  132. package/docs/GetChildAccountCreationStatus.md +8 -0
  133. package/docs/GetChildDomain.md +9 -0
  134. package/docs/GetChildDomains.md +7 -0
  135. package/docs/GetChildInfo.md +12 -0
  136. package/docs/GetChildInfoApiKeys.md +9 -0
  137. package/docs/GetChildInfoApiKeysV2.md +9 -0
  138. package/docs/GetChildInfoApiKeysV3.md +9 -0
  139. package/docs/GetChildInfoCredits.md +9 -0
  140. package/docs/GetChildInfoStatistics.md +10 -0
  141. package/docs/GetChildrenList.md +9 -0
  142. package/docs/GetClient.md +11 -0
  143. package/docs/GetContactCampaignStats.md +16 -0
  144. package/docs/GetContactCampaignStatsClicked.md +9 -0
  145. package/docs/GetContactCampaignStatsOpened.md +11 -0
  146. package/docs/GetContactCampaignStatsTransacAttributes.md +10 -0
  147. package/docs/GetContactCampaignStatsUnsubscriptions.md +9 -0
  148. package/docs/GetContactDetails.md +16 -0
  149. package/docs/GetContacts.md +9 -0
  150. package/docs/GetCouponCollection.md +13 -0
  151. package/docs/GetDeviceBrowserStats.md +11 -0
  152. package/docs/GetDomainConfigurationModel.md +11 -0
  153. package/docs/GetDomainsList.md +8 -0
  154. package/docs/GetDomainsListDomains.md +12 -0
  155. package/docs/GetEmailCampaign.md +9 -0
  156. package/docs/GetEmailCampaigns.md +9 -0
  157. package/docs/GetEmailEventReport.md +8 -0
  158. package/docs/GetEmailEventReportEvents.md +53 -0
  159. package/docs/GetExtendedCampaignOverview.md +23 -0
  160. package/docs/GetExtendedCampaignOverviewSender.md +10 -0
  161. package/docs/GetExtendedCampaignStats.md +15 -0
  162. package/docs/GetExtendedCampaignStatsGlobalStats.md +7 -0
  163. package/docs/GetExtendedClient.md +8 -0
  164. package/docs/GetExtendedClientAddress.md +11 -0
  165. package/docs/GetExtendedContactDetails.md +8 -0
  166. package/docs/GetExtendedContactDetailsStatistics.md +16 -0
  167. package/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
  168. package/docs/GetExtendedContactDetailsStatisticsLinks.md +11 -0
  169. package/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +9 -0
  170. package/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
  171. package/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
  172. package/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +9 -0
  173. package/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +10 -0
  174. package/docs/GetExtendedList.md +11 -0
  175. package/docs/GetExtendedListCampaignStats.md +9 -0
  176. package/docs/GetExternalFeedByUUID.md +32 -0
  177. package/docs/GetExternalFeedByUUIDHeaders.md +9 -0
  178. package/docs/GetFolder.md +12 -0
  179. package/docs/GetFolderLists.md +9 -0
  180. package/docs/GetFolders.md +9 -0
  181. package/docs/GetInboundEmailEvents.md +8 -0
  182. package/docs/GetInboundEmailEventsByUuid.md +15 -0
  183. package/docs/GetInboundEmailEventsByUuidAttachments.md +11 -0
  184. package/docs/GetInboundEmailEventsByUuidLogs.md +24 -0
  185. package/docs/GetInboundEmailEventsEvents.md +11 -0
  186. package/docs/GetInvitedUsersList.md +8 -0
  187. package/docs/GetInvitedUsersListFeatureAccess.md +10 -0
  188. package/docs/GetInvitedUsersListUsers.md +11 -0
  189. package/docs/GetIp.md +11 -0
  190. package/docs/GetIpFromSender.md +11 -0
  191. package/docs/GetIps.md +8 -0
  192. package/docs/GetIpsFromSender.md +8 -0
  193. package/docs/GetList.md +12 -0
  194. package/docs/GetLists.md +9 -0
  195. package/docs/GetProcess.md +24 -0
  196. package/docs/GetProcesses.md +9 -0
  197. package/docs/GetProductDetails.md +22 -0
  198. package/docs/GetProducts.md +9 -0
  199. package/docs/GetReports.md +8 -0
  200. package/docs/GetReportsReports.md +20 -0
  201. package/docs/GetScheduledEmailByBatchId.md +9 -0
  202. package/docs/GetScheduledEmailByBatchIdBatches.md +25 -0
  203. package/docs/GetScheduledEmailByMessageId.md +25 -0
  204. package/docs/GetSegments.md +9 -0
  205. package/docs/GetSegmentsSegments.md +11 -0
  206. package/docs/GetSendersList.md +8 -0
  207. package/docs/GetSendersListIps.md +10 -0
  208. package/docs/GetSendersListSenders.md +12 -0
  209. package/docs/GetSharedTemplateUrl.md +8 -0
  210. package/docs/GetSmsCampaign.md +9 -0
  211. package/docs/GetSmsCampaignOverview.md +34 -0
  212. package/docs/GetSmsCampaignRecipients.md +7 -0
  213. package/docs/GetSmsCampaignStats.md +14 -0
  214. package/docs/GetSmsCampaigns.md +9 -0
  215. package/docs/GetSmsEventReport.md +8 -0
  216. package/docs/GetSmsEventReportEvents.md +41 -0
  217. package/docs/GetSmtpTemplateOverview.md +20 -0
  218. package/docs/GetSmtpTemplateOverviewSender.md +10 -0
  219. package/docs/GetSmtpTemplates.md +9 -0
  220. package/docs/GetSsoToken.md +8 -0
  221. package/docs/GetStatsByBrowser.md +7 -0
  222. package/docs/GetStatsByDevice.md +11 -0
  223. package/docs/GetStatsByDomain.md +7 -0
  224. package/docs/GetTransacAggregatedSmsReport.md +17 -0
  225. package/docs/GetTransacBlockedContacts.md +9 -0
  226. package/docs/GetTransacBlockedContactsContacts.md +11 -0
  227. package/docs/GetTransacBlockedContactsReason.md +28 -0
  228. package/docs/GetTransacEmailContent.md +14 -0
  229. package/docs/GetTransacEmailContentEvents.md +9 -0
  230. package/docs/GetTransacEmailsList.md +9 -0
  231. package/docs/GetTransacEmailsListTransactionalEmails.md +15 -0
  232. package/docs/GetTransacSmsReport.md +8 -0
  233. package/docs/GetTransacSmsReportReports.md +17 -0
  234. package/docs/GetUserPermission.md +10 -0
  235. package/docs/GetUserPermissionPrivileges.md +9 -0
  236. package/docs/GetWATemplates.md +9 -0
  237. package/docs/GetWATemplatesTemplates.md +15 -0
  238. package/docs/GetWebhook.md +25 -0
  239. package/docs/GetWebhooks.md +8 -0
  240. package/docs/GetWhatsAppConfig.md +39 -0
  241. package/docs/GetWhatsappCampaignOverview.md +39 -0
  242. package/docs/GetWhatsappCampaigns.md +9 -0
  243. package/docs/GetWhatsappCampaignsCampaigns.md +41 -0
  244. package/docs/GetWhatsappEventReport.md +8 -0
  245. package/docs/GetWhatsappEventReportEvents.md +36 -0
  246. package/docs/InboundParsingApi.md +190 -0
  247. package/docs/InlineResponse200.md +8 -0
  248. package/docs/InlineResponse2001.md +10 -0
  249. package/docs/InlineResponse201.md +8 -0
  250. package/docs/InlineResponse2011.md +8 -0
  251. package/docs/InlineResponse2012.md +8 -0
  252. package/docs/InlineResponse2013.md +8 -0
  253. package/docs/InlineResponse2014.md +8 -0
  254. package/docs/ManageIp.md +8 -0
  255. package/docs/MasterAccountApi.md +524 -0
  256. package/docs/MasterDetailsResponse.md +14 -0
  257. package/docs/MasterDetailsResponseBillingInfo.md +11 -0
  258. package/docs/MasterDetailsResponseBillingInfoAddress.md +12 -0
  259. package/docs/MasterDetailsResponseBillingInfoName.md +9 -0
  260. package/docs/MasterDetailsResponsePlanInfo.md +24 -0
  261. package/docs/MasterDetailsResponsePlanInfoFeatures.md +12 -0
  262. package/docs/Note.md +14 -0
  263. package/docs/NoteData.md +11 -0
  264. package/docs/NoteId.md +8 -0
  265. package/docs/NoteList.md +7 -0
  266. package/docs/NotesApi.md +299 -0
  267. package/docs/Order.md +16 -0
  268. package/docs/OrderBatch.md +9 -0
  269. package/docs/OrderBilling.md +14 -0
  270. package/docs/OrderProducts.md +11 -0
  271. package/docs/Otp.md +8 -0
  272. package/docs/Pipeline.md +10 -0
  273. package/docs/PipelineStage.md +9 -0
  274. package/docs/Pipelines.md +7 -0
  275. package/docs/PostContactInfo.md +8 -0
  276. package/docs/PostContactInfoContacts.md +11 -0
  277. package/docs/PostSendFailed.md +12 -0
  278. package/docs/PostSendSmsTestFailed.md +11 -0
  279. package/docs/ProcessApi.md +123 -0
  280. package/docs/RemainingCreditModel.md +9 -0
  281. package/docs/RemainingCreditModelChild.md +9 -0
  282. package/docs/RemainingCreditModelReseller.md +9 -0
  283. package/docs/RemoveContactFromList.md +10 -0
  284. package/docs/RemoveCredits.md +9 -0
  285. package/docs/RequestContactExport.md +10 -0
  286. package/docs/RequestContactExportCustomContactFilter.md +62 -0
  287. package/docs/RequestContactImport.md +17 -0
  288. package/docs/RequestContactImportNewList.md +9 -0
  289. package/docs/RequestSmsRecipientExport.md +28 -0
  290. package/docs/ResellerApi.md +924 -0
  291. package/docs/SMSCampaignsApi.md +589 -0
  292. package/docs/ScheduleSmtpEmail.md +10 -0
  293. package/docs/SendReport.md +28 -0
  294. package/docs/SendReportEmail.md +9 -0
  295. package/docs/SendSms.md +12 -0
  296. package/docs/SendSmtpEmail.md +23 -0
  297. package/docs/SendSmtpEmailAttachment.md +10 -0
  298. package/docs/SendSmtpEmailBcc.md +9 -0
  299. package/docs/SendSmtpEmailCc.md +9 -0
  300. package/docs/SendSmtpEmailMessageVersions.md +13 -0
  301. package/docs/SendSmtpEmailReplyTo.md +9 -0
  302. package/docs/SendSmtpEmailReplyTo1.md +9 -0
  303. package/docs/SendSmtpEmailSender.md +10 -0
  304. package/docs/SendSmtpEmailTo.md +9 -0
  305. package/docs/SendSmtpEmailTo1.md +9 -0
  306. package/docs/SendTestEmail.md +8 -0
  307. package/docs/SendTestSms.md +8 -0
  308. package/docs/SendTransacSms.md +26 -0
  309. package/docs/SendWhatsappMessage.md +11 -0
  310. package/docs/SendersApi.md +399 -0
  311. package/docs/SsoTokenRequest.md +33 -0
  312. package/docs/SubAccountDetailsResponse.md +11 -0
  313. package/docs/SubAccountDetailsResponsePlanInfo.md +10 -0
  314. package/docs/SubAccountDetailsResponsePlanInfoCredits.md +9 -0
  315. package/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md +9 -0
  316. package/docs/SubAccountDetailsResponsePlanInfoFeatures.md +10 -0
  317. package/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md +9 -0
  318. package/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md +9 -0
  319. package/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md +9 -0
  320. package/docs/SubAccountUpdatePlanRequest.md +9 -0
  321. package/docs/SubAccountUpdatePlanRequestCredits.md +8 -0
  322. package/docs/SubAccountUpdatePlanRequestFeatures.md +10 -0
  323. package/docs/SubAccountsResponse.md +9 -0
  324. package/docs/SubAccountsResponseSubAccounts.md +11 -0
  325. package/docs/Task.md +13 -0
  326. package/docs/TaskList.md +8 -0
  327. package/docs/TaskReminder.md +25 -0
  328. package/docs/TaskTypes.md +9 -0
  329. package/docs/TasksApi.md +360 -0
  330. package/docs/TransactionalEmailsApi.md +1333 -0
  331. package/docs/TransactionalSMSApi.md +261 -0
  332. package/docs/TransactionalWhatsAppApi.md +137 -0
  333. package/docs/UpdateAttribute.md +9 -0
  334. package/docs/UpdateAttributeEnumeration.md +9 -0
  335. package/docs/UpdateBatchContacts.md +8 -0
  336. package/docs/UpdateBatchContactsContacts.md +17 -0
  337. package/docs/UpdateBatchContactsModel.md +9 -0
  338. package/docs/UpdateCampaignStatus.md +31 -0
  339. package/docs/UpdateChild.md +12 -0
  340. package/docs/UpdateChildAccountStatus.md +11 -0
  341. package/docs/UpdateChildDomain.md +8 -0
  342. package/docs/UpdateContact.md +14 -0
  343. package/docs/UpdateCouponCollection.md +8 -0
  344. package/docs/UpdateEmailCampaign.md +49 -0
  345. package/docs/UpdateEmailCampaignRecipients.md +10 -0
  346. package/docs/UpdateEmailCampaignSender.md +10 -0
  347. package/docs/UpdateExternalFeed.md +29 -0
  348. package/docs/UpdateList.md +9 -0
  349. package/docs/UpdateSender.md +10 -0
  350. package/docs/UpdateSmsCampaign.md +15 -0
  351. package/docs/UpdateSmtpTemplate.md +17 -0
  352. package/docs/UpdateSmtpTemplateSender.md +10 -0
  353. package/docs/UpdateWebhook.md +52 -0
  354. package/docs/UpdateWhatsAppCampaign.md +22 -0
  355. package/docs/UploadImageModel.md +8 -0
  356. package/docs/UploadImageToGallery.md +9 -0
  357. package/docs/UserApi.md +112 -0
  358. package/docs/VariablesItems.md +10 -0
  359. package/docs/WebhooksApi.md +346 -0
  360. package/docs/WhatsAppCampaignsApi.md +519 -0
  361. package/docs/WhatsappCampStats.md +12 -0
  362. package/docs/WhatsappCampTemplate.md +18 -0
  363. package/git_push.sh +52 -0
  364. package/mocha.opts +1 -0
  365. package/package.json +35 -0
  366. package/src/ApiClient.js +601 -0
  367. package/src/api/AccountApi.js +154 -0
  368. package/src/api/CompaniesApi.js +431 -0
  369. package/src/api/ContactsApi.js +1683 -0
  370. package/src/api/ConversationsApi.js +529 -0
  371. package/src/api/CouponsApi.js +317 -0
  372. package/src/api/DealsApi.js +527 -0
  373. package/src/api/DomainsApi.js +297 -0
  374. package/src/api/EcommerceApi.js +656 -0
  375. package/src/api/EmailCampaignsApi.js +781 -0
  376. package/src/api/ExternalFeedsApi.js +340 -0
  377. package/src/api/FilesApi.js +336 -0
  378. package/src/api/InboundParsingApi.js +225 -0
  379. package/src/api/MasterAccountApi.js +537 -0
  380. package/src/api/NotesApi.js +330 -0
  381. package/src/api/ProcessApi.js +159 -0
  382. package/src/api/ResellerApi.js +941 -0
  383. package/src/api/SMSCampaignsApi.js +612 -0
  384. package/src/api/SendersApi.js +410 -0
  385. package/src/api/TasksApi.js +391 -0
  386. package/src/api/TransactionalEmailsApi.js +1318 -0
  387. package/src/api/TransactionalSMSApi.js +295 -0
  388. package/src/api/TransactionalWhatsAppApi.js +177 -0
  389. package/src/api/UserApi.js +147 -0
  390. package/src/api/WebhooksApi.js +367 -0
  391. package/src/api/WhatsAppCampaignsApi.js +527 -0
  392. package/src/index.js +1833 -0
  393. package/src/model/AbTestCampaignResult.js +185 -0
  394. package/src/model/AbTestCampaignResultClickedLinks.js +83 -0
  395. package/src/model/AbTestCampaignResultStatistics.js +119 -0
  396. package/src/model/AbTestVersionClicks.js +69 -0
  397. package/src/model/AbTestVersionClicksInner.js +95 -0
  398. package/src/model/AbTestVersionStats.js +86 -0
  399. package/src/model/AddChildDomain.js +73 -0
  400. package/src/model/AddContactToList.js +81 -0
  401. package/src/model/AddCredits.js +81 -0
  402. package/src/model/AuthenticateDomainModel.js +85 -0
  403. package/src/model/BlockDomain.js +75 -0
  404. package/src/model/Body.js +91 -0
  405. package/src/model/Body1.js +89 -0
  406. package/src/model/Body10.js +101 -0
  407. package/src/model/Body11.js +75 -0
  408. package/src/model/Body12.js +97 -0
  409. package/src/model/Body2.js +97 -0
  410. package/src/model/Body3.js +83 -0
  411. package/src/model/Body4.js +81 -0
  412. package/src/model/Body5.js +97 -0
  413. package/src/model/Body6.js +158 -0
  414. package/src/model/Body7.js +145 -0
  415. package/src/model/Body8.js +117 -0
  416. package/src/model/Body9.js +75 -0
  417. package/src/model/BodyVariablesItems.js +65 -0
  418. package/src/model/CompaniesList.js +74 -0
  419. package/src/model/Company.js +98 -0
  420. package/src/model/CompanyAttributes.js +69 -0
  421. package/src/model/CompanyAttributesInner.js +101 -0
  422. package/src/model/ComponentItems.js +79 -0
  423. package/src/model/ConversationsMessage.js +165 -0
  424. package/src/model/ConversationsMessageFile.js +104 -0
  425. package/src/model/ConversationsMessageFileImageInfo.js +90 -0
  426. package/src/model/CreateApiKeyRequest.js +83 -0
  427. package/src/model/CreateApiKeyResponse.js +81 -0
  428. package/src/model/CreateAttribute.js +141 -0
  429. package/src/model/CreateAttributeEnumeration.js +85 -0
  430. package/src/model/CreateCategoryModel.js +73 -0
  431. package/src/model/CreateChild.js +167 -0
  432. package/src/model/CreateContact.js +130 -0
  433. package/src/model/CreateCouponCollection.js +85 -0
  434. package/src/model/CreateCoupons.js +84 -0
  435. package/src/model/CreateDoiContact.js +121 -0
  436. package/src/model/CreateDomain.js +75 -0
  437. package/src/model/CreateDomainModel.js +98 -0
  438. package/src/model/CreateDomainModelDnsRecords.js +79 -0
  439. package/src/model/CreateDomainModelDnsRecordsDkimRecord.js +93 -0
  440. package/src/model/CreateEmailCampaign.js +339 -0
  441. package/src/model/CreateEmailCampaignRecipients.js +90 -0
  442. package/src/model/CreateEmailCampaignSender.js +92 -0
  443. package/src/model/CreateExternalFeed.js +169 -0
  444. package/src/model/CreateList.js +85 -0
  445. package/src/model/CreateModel.js +75 -0
  446. package/src/model/CreateProductModel.js +73 -0
  447. package/src/model/CreateReseller.js +83 -0
  448. package/src/model/CreateSender.js +93 -0
  449. package/src/model/CreateSenderIps.js +93 -0
  450. package/src/model/CreateSenderModel.js +91 -0
  451. package/src/model/CreateSmsCampaign.js +135 -0
  452. package/src/model/CreateSmsCampaignRecipients.js +83 -0
  453. package/src/model/CreateSmtpEmail.js +80 -0
  454. package/src/model/CreateSmtpTemplate.js +150 -0
  455. package/src/model/CreateSmtpTemplateSender.js +90 -0
  456. package/src/model/CreateSubAccount.js +145 -0
  457. package/src/model/CreateSubAccountResponse.js +75 -0
  458. package/src/model/CreateUpdateBatchCategory.js +83 -0
  459. package/src/model/CreateUpdateBatchCategoryModel.js +81 -0
  460. package/src/model/CreateUpdateBatchProducts.js +83 -0
  461. package/src/model/CreateUpdateBatchProductsModel.js +81 -0
  462. package/src/model/CreateUpdateCategories.js +99 -0
  463. package/src/model/CreateUpdateCategory.js +108 -0
  464. package/src/model/CreateUpdateContactModel.js +73 -0
  465. package/src/model/CreateUpdateFolder.js +73 -0
  466. package/src/model/CreateUpdateProduct.js +158 -0
  467. package/src/model/CreateUpdateProducts.js +149 -0
  468. package/src/model/CreateWebhook.js +246 -0
  469. package/src/model/CreateWhatsAppCampaign.js +104 -0
  470. package/src/model/CreateWhatsAppCampaignRecipients.js +90 -0
  471. package/src/model/CreateWhatsAppTemplate.js +141 -0
  472. package/src/model/CreatedBatchId.js +75 -0
  473. package/src/model/CreatedProcessId.js +75 -0
  474. package/src/model/Deal.js +98 -0
  475. package/src/model/DealAttributes.js +69 -0
  476. package/src/model/DealAttributesInner.js +101 -0
  477. package/src/model/DealsList.js +74 -0
  478. package/src/model/DeleteHardbounces.js +89 -0
  479. package/src/model/EmailExportRecipients.js +139 -0
  480. package/src/model/ErrorModel.js +189 -0
  481. package/src/model/ExportWebhooksHistory.js +251 -0
  482. package/src/model/FileData.js +122 -0
  483. package/src/model/FileDownloadableLink.js +75 -0
  484. package/src/model/FileList.js +69 -0
  485. package/src/model/GetAccount.js +101 -0
  486. package/src/model/GetAccountActivity.js +73 -0
  487. package/src/model/GetAccountActivityLogs.js +115 -0
  488. package/src/model/GetAccountMarketingAutomation.js +83 -0
  489. package/src/model/GetAccountPlan.js +171 -0
  490. package/src/model/GetAccountRelay.js +85 -0
  491. package/src/model/GetAccountRelayData.js +96 -0
  492. package/src/model/GetAggregatedReport.js +169 -0
  493. package/src/model/GetAllExternalFeeds.js +80 -0
  494. package/src/model/GetAllExternalFeedsFeeds.js +205 -0
  495. package/src/model/GetAttributes.js +75 -0
  496. package/src/model/GetAttributesAttributes.js +185 -0
  497. package/src/model/GetAttributesEnumeration.js +85 -0
  498. package/src/model/GetBlockedDomains.js +76 -0
  499. package/src/model/GetCampaignOverview.js +249 -0
  500. package/src/model/GetCampaignRecipients.js +83 -0
  501. package/src/model/GetCampaignStats.js +215 -0
  502. package/src/model/GetCategories.js +84 -0
  503. package/src/model/GetCategoryDetails.js +121 -0
  504. package/src/model/GetChildAccountCreationStatus.js +75 -0
  505. package/src/model/GetChildDomain.js +81 -0
  506. package/src/model/GetChildDomains.js +68 -0
  507. package/src/model/GetChildInfo.js +113 -0
  508. package/src/model/GetChildInfoApiKeys.js +82 -0
  509. package/src/model/GetChildInfoApiKeysV2.js +85 -0
  510. package/src/model/GetChildInfoApiKeysV3.js +85 -0
  511. package/src/model/GetChildInfoCredits.js +82 -0
  512. package/src/model/GetChildInfoStatistics.js +90 -0
  513. package/src/model/GetChildrenList.js +81 -0
  514. package/src/model/GetClient.js +105 -0
  515. package/src/model/GetContactCampaignStats.js +129 -0
  516. package/src/model/GetContactCampaignStatsClicked.js +84 -0
  517. package/src/model/GetContactCampaignStatsOpened.js +105 -0
  518. package/src/model/GetContactCampaignStatsTransacAttributes.js +95 -0
  519. package/src/model/GetContactCampaignStatsUnsubscriptions.js +85 -0
  520. package/src/model/GetContactDetails.js +151 -0
  521. package/src/model/GetContacts.js +84 -0
  522. package/src/model/GetCouponCollection.js +125 -0
  523. package/src/model/GetDeviceBrowserStats.js +105 -0
  524. package/src/model/GetDomainConfigurationModel.js +104 -0
  525. package/src/model/GetDomainsList.js +73 -0
  526. package/src/model/GetDomainsListDomains.js +113 -0
  527. package/src/model/GetEmailCampaign.js +100 -0
  528. package/src/model/GetEmailCampaigns.js +80 -0
  529. package/src/model/GetEmailEventReport.js +72 -0
  530. package/src/model/GetEmailEventReportEvents.js +253 -0
  531. package/src/model/GetExtendedCampaignOverview.js +217 -0
  532. package/src/model/GetExtendedCampaignOverviewSender.js +89 -0
  533. package/src/model/GetExtendedCampaignStats.js +143 -0
  534. package/src/model/GetExtendedCampaignStatsGlobalStats.js +66 -0
  535. package/src/model/GetExtendedClient.js +83 -0
  536. package/src/model/GetExtendedClientAddress.js +106 -0
  537. package/src/model/GetExtendedContactDetails.js +87 -0
  538. package/src/model/GetExtendedContactDetailsStatistics.js +137 -0
  539. package/src/model/GetExtendedContactDetailsStatisticsClicked.js +85 -0
  540. package/src/model/GetExtendedContactDetailsStatisticsLinks.js +105 -0
  541. package/src/model/GetExtendedContactDetailsStatisticsMessagesSent.js +85 -0
  542. package/src/model/GetExtendedContactDetailsStatisticsOpened.js +105 -0
  543. package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptions.js +86 -0
  544. package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.js +83 -0
  545. package/src/model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.js +93 -0
  546. package/src/model/GetExtendedList.js +110 -0
  547. package/src/model/GetExtendedListCampaignStats.js +84 -0
  548. package/src/model/GetExternalFeedByUUID.js +205 -0
  549. package/src/model/GetExternalFeedByUUIDHeaders.js +81 -0
  550. package/src/model/GetFolder.js +115 -0
  551. package/src/model/GetFolderLists.js +80 -0
  552. package/src/model/GetFolders.js +80 -0
  553. package/src/model/GetInboundEmailEvents.js +72 -0
  554. package/src/model/GetInboundEmailEventsByUuid.js +129 -0
  555. package/src/model/GetInboundEmailEventsByUuidAttachments.js +97 -0
  556. package/src/model/GetInboundEmailEventsByUuidLogs.js +113 -0
  557. package/src/model/GetInboundEmailEventsEvents.js +105 -0
  558. package/src/model/GetInvitedUsersList.js +73 -0
  559. package/src/model/GetInvitedUsersListFeatureAccess.js +90 -0
  560. package/src/model/GetInvitedUsersListUsers.js +104 -0
  561. package/src/model/GetIp.js +105 -0
  562. package/src/model/GetIpFromSender.js +105 -0
  563. package/src/model/GetIps.js +75 -0
  564. package/src/model/GetIpsFromSender.js +75 -0
  565. package/src/model/GetList.js +115 -0
  566. package/src/model/GetLists.js +81 -0
  567. package/src/model/GetProcess.js +129 -0
  568. package/src/model/GetProcesses.js +81 -0
  569. package/src/model/GetProductDetails.js +197 -0
  570. package/src/model/GetProducts.js +84 -0
  571. package/src/model/GetReports.js +72 -0
  572. package/src/model/GetReportsReports.js +195 -0
  573. package/src/model/GetScheduledEmailByBatchId.js +80 -0
  574. package/src/model/GetScheduledEmailByBatchIdBatches.js +127 -0
  575. package/src/model/GetScheduledEmailByMessageId.js +127 -0
  576. package/src/model/GetSegments.js +80 -0
  577. package/src/model/GetSegmentsSegments.js +97 -0
  578. package/src/model/GetSendersList.js +73 -0
  579. package/src/model/GetSendersListIps.js +95 -0
  580. package/src/model/GetSendersListSenders.js +113 -0
  581. package/src/model/GetSharedTemplateUrl.js +75 -0
  582. package/src/model/GetSmsCampaign.js +95 -0
  583. package/src/model/GetSmsCampaignOverview.js +187 -0
  584. package/src/model/GetSmsCampaignRecipients.js +65 -0
  585. package/src/model/GetSmsCampaignStats.js +135 -0
  586. package/src/model/GetSmsCampaigns.js +80 -0
  587. package/src/model/GetSmsEventReport.js +72 -0
  588. package/src/model/GetSmsEventReportEvents.js +188 -0
  589. package/src/model/GetSmtpTemplateOverview.js +192 -0
  590. package/src/model/GetSmtpTemplateOverviewSender.js +89 -0
  591. package/src/model/GetSmtpTemplates.js +80 -0
  592. package/src/model/GetSsoToken.js +75 -0
  593. package/src/model/GetStatsByBrowser.js +68 -0
  594. package/src/model/GetStatsByDevice.js +97 -0
  595. package/src/model/GetStatsByDomain.js +68 -0
  596. package/src/model/GetTransacAggregatedSmsReport.js +145 -0
  597. package/src/model/GetTransacBlockedContacts.js +80 -0
  598. package/src/model/GetTransacBlockedContactsContacts.js +104 -0
  599. package/src/model/GetTransacBlockedContactsReason.js +126 -0
  600. package/src/model/GetTransacEmailContent.js +133 -0
  601. package/src/model/GetTransacEmailContentEvents.js +85 -0
  602. package/src/model/GetTransacEmailsList.js +80 -0
  603. package/src/model/GetTransacEmailsListTransactionalEmails.js +139 -0
  604. package/src/model/GetTransacSmsReport.js +72 -0
  605. package/src/model/GetTransacSmsReportReports.js +145 -0
  606. package/src/model/GetUserPermission.js +96 -0
  607. package/src/model/GetUserPermissionPrivileges.js +83 -0
  608. package/src/model/GetWATemplates.js +84 -0
  609. package/src/model/GetWATemplatesTemplates.js +143 -0
  610. package/src/model/GetWebhook.js +154 -0
  611. package/src/model/GetWebhooks.js +74 -0
  612. package/src/model/GetWhatsAppConfig.js +165 -0
  613. package/src/model/GetWhatsappCampaignOverview.js +205 -0
  614. package/src/model/GetWhatsappCampaigns.js +80 -0
  615. package/src/model/GetWhatsappCampaignsCampaigns.js +222 -0
  616. package/src/model/GetWhatsappEventReport.js +72 -0
  617. package/src/model/GetWhatsappEventReportEvents.js +189 -0
  618. package/src/model/InlineResponse200.js +76 -0
  619. package/src/model/InlineResponse2001.js +95 -0
  620. package/src/model/InlineResponse201.js +76 -0
  621. package/src/model/InlineResponse2011.js +76 -0
  622. package/src/model/InlineResponse2012.js +75 -0
  623. package/src/model/InlineResponse2013.js +75 -0
  624. package/src/model/InlineResponse2014.js +75 -0
  625. package/src/model/ManageIp.js +73 -0
  626. package/src/model/MasterDetailsResponse.js +119 -0
  627. package/src/model/MasterDetailsResponseBillingInfo.js +96 -0
  628. package/src/model/MasterDetailsResponseBillingInfoAddress.js +106 -0
  629. package/src/model/MasterDetailsResponseBillingInfoName.js +82 -0
  630. package/src/model/MasterDetailsResponsePlanInfo.js +134 -0
  631. package/src/model/MasterDetailsResponsePlanInfoFeatures.js +105 -0
  632. package/src/model/Note.js +124 -0
  633. package/src/model/NoteData.js +100 -0
  634. package/src/model/NoteId.js +74 -0
  635. package/src/model/NoteList.js +69 -0
  636. package/src/model/Order.js +147 -0
  637. package/src/model/OrderBatch.js +83 -0
  638. package/src/model/OrderBilling.js +122 -0
  639. package/src/model/OrderProducts.js +104 -0
  640. package/src/model/Otp.js +73 -0
  641. package/src/model/Pipeline.js +90 -0
  642. package/src/model/PipelineStage.js +82 -0
  643. package/src/model/Pipelines.js +69 -0
  644. package/src/model/PostContactInfo.js +74 -0
  645. package/src/model/PostContactInfoContacts.js +95 -0
  646. package/src/model/PostSendFailed.js +106 -0
  647. package/src/model/PostSendSmsTestFailed.js +99 -0
  648. package/src/model/RemainingCreditModel.js +83 -0
  649. package/src/model/RemainingCreditModelChild.js +86 -0
  650. package/src/model/RemainingCreditModelReseller.js +85 -0
  651. package/src/model/RemoveContactFromList.js +89 -0
  652. package/src/model/RemoveCredits.js +81 -0
  653. package/src/model/RequestContactExport.js +90 -0
  654. package/src/model/RequestContactExportCustomContactFilter.js +222 -0
  655. package/src/model/RequestContactImport.js +148 -0
  656. package/src/model/RequestContactImportNewList.js +82 -0
  657. package/src/model/RequestSmsRecipientExport.js +127 -0
  658. package/src/model/ScheduleSmtpEmail.js +88 -0
  659. package/src/model/SendReport.js +127 -0
  660. package/src/model/SendReportEmail.js +86 -0
  661. package/src/model/SendSms.js +107 -0
  662. package/src/model/SendSmtpEmail.js +191 -0
  663. package/src/model/SendSmtpEmailAttachment.js +89 -0
  664. package/src/model/SendSmtpEmailBcc.js +83 -0
  665. package/src/model/SendSmtpEmailCc.js +83 -0
  666. package/src/model/SendSmtpEmailMessageVersions.js +114 -0
  667. package/src/model/SendSmtpEmailReplyTo.js +84 -0
  668. package/src/model/SendSmtpEmailReplyTo1.js +84 -0
  669. package/src/model/SendSmtpEmailSender.js +90 -0
  670. package/src/model/SendSmtpEmailTo.js +83 -0
  671. package/src/model/SendSmtpEmailTo1.js +83 -0
  672. package/src/model/SendTestEmail.js +73 -0
  673. package/src/model/SendTestSms.js +73 -0
  674. package/src/model/SendTransacSms.js +157 -0
  675. package/src/model/SendWhatsappMessage.js +101 -0
  676. package/src/model/SsoTokenRequest.js +147 -0
  677. package/src/model/SubAccountDetailsResponse.js +96 -0
  678. package/src/model/SubAccountDetailsResponsePlanInfo.js +88 -0
  679. package/src/model/SubAccountDetailsResponsePlanInfoCredits.js +81 -0
  680. package/src/model/SubAccountDetailsResponsePlanInfoCreditsEmails.js +82 -0
  681. package/src/model/SubAccountDetailsResponsePlanInfoFeatures.js +87 -0
  682. package/src/model/SubAccountDetailsResponsePlanInfoFeaturesInbox.js +82 -0
  683. package/src/model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.js +82 -0
  684. package/src/model/SubAccountDetailsResponsePlanInfoFeaturesUsers.js +82 -0
  685. package/src/model/SubAccountUpdatePlanRequest.js +80 -0
  686. package/src/model/SubAccountUpdatePlanRequestCredits.js +74 -0
  687. package/src/model/SubAccountUpdatePlanRequestFeatures.js +90 -0
  688. package/src/model/SubAccountsResponse.js +80 -0
  689. package/src/model/SubAccountsResponseSubAccounts.js +105 -0
  690. package/src/model/Task.js +118 -0
  691. package/src/model/TaskList.js +74 -0
  692. package/src/model/TaskReminder.js +128 -0
  693. package/src/model/TaskTypes.js +82 -0
  694. package/src/model/UpdateAttribute.js +81 -0
  695. package/src/model/UpdateAttributeEnumeration.js +85 -0
  696. package/src/model/UpdateBatchContacts.js +73 -0
  697. package/src/model/UpdateBatchContactsContacts.js +145 -0
  698. package/src/model/UpdateBatchContactsModel.js +79 -0
  699. package/src/model/UpdateCampaignStatus.js +130 -0
  700. package/src/model/UpdateChild.js +105 -0
  701. package/src/model/UpdateChildAccountStatus.js +97 -0
  702. package/src/model/UpdateChildDomain.js +73 -0
  703. package/src/model/UpdateContact.js +121 -0
  704. package/src/model/UpdateCouponCollection.js +75 -0
  705. package/src/model/UpdateEmailCampaign.js +335 -0
  706. package/src/model/UpdateEmailCampaignRecipients.js +90 -0
  707. package/src/model/UpdateEmailCampaignSender.js +90 -0
  708. package/src/model/UpdateExternalFeed.js +164 -0
  709. package/src/model/UpdateList.js +81 -0
  710. package/src/model/UpdateSender.js +89 -0
  711. package/src/model/UpdateSmsCampaign.js +129 -0
  712. package/src/model/UpdateSmtpTemplate.js +144 -0
  713. package/src/model/UpdateSmtpTemplateSender.js +90 -0
  714. package/src/model/UpdateWebhook.js +207 -0
  715. package/src/model/UpdateWhatsAppCampaign.js +117 -0
  716. package/src/model/UploadImageModel.js +75 -0
  717. package/src/model/UploadImageToGallery.js +83 -0
  718. package/src/model/VariablesItems.js +86 -0
  719. package/src/model/WhatsappCampStats.js +110 -0
  720. package/src/model/WhatsappCampTemplate.js +149 -0
  721. package/test/api/AccountApi.spec.js +157 -0
  722. package/test/api/CompaniesApi.spec.js +273 -0
  723. package/test/api/ContactsApi.spec.js +1278 -0
  724. package/test/api/ConversationsApi.spec.js +430 -0
  725. package/test/api/CouponsApi.spec.js +176 -0
  726. package/test/api/DealsApi.spec.js +300 -0
  727. package/test/api/DomainsApi.spec.js +210 -0
  728. package/test/api/EcommerceApi.spec.js +423 -0
  729. package/test/api/EmailCampaignsApi.spec.js +512 -0
  730. package/test/api/ExternalFeedsApi.spec.js +249 -0
  731. package/test/api/FilesApi.spec.js +176 -0
  732. package/test/api/InboundParsingApi.spec.js +168 -0
  733. package/test/api/MasterAccountApi.spec.js +372 -0
  734. package/test/api/NotesApi.spec.js +181 -0
  735. package/test/api/ProcessApi.spec.js +111 -0
  736. package/test/api/ResellerApi.spec.js +467 -0
  737. package/test/api/SMSCampaignsApi.spec.js +294 -0
  738. package/test/api/SendersApi.spec.js +264 -0
  739. package/test/api/TasksApi.spec.js +277 -0
  740. package/test/api/TransactionalEmailsApi.spec.js +870 -0
  741. package/test/api/TransactionalSMSApi.spec.js +228 -0
  742. package/test/api/TransactionalWhatsAppApi.spec.js +120 -0
  743. package/test/api/UserApi.spec.js +128 -0
  744. package/test/api/WebhooksApi.spec.js +209 -0
  745. package/test/api/WhatsAppCampaignsApi.spec.js +413 -0
  746. package/test/assert-equals.js +81 -0
  747. package/test/model/AbTestCampaignResult.spec.js +95 -0
  748. package/test/model/AbTestCampaignResultClickedLinks.spec.js +59 -0
  749. package/test/model/AbTestCampaignResultStatistics.spec.js +83 -0
  750. package/test/model/AbTestVersionClicks.spec.js +47 -0
  751. package/test/model/AbTestVersionClicksInner.spec.js +65 -0
  752. package/test/model/AbTestVersionStats.spec.js +59 -0
  753. package/test/model/AddChildDomain.spec.js +53 -0
  754. package/test/model/AddContactToList.spec.js +59 -0
  755. package/test/model/AddCredits.spec.js +59 -0
  756. package/test/model/AuthenticateDomainModel.spec.js +59 -0
  757. package/test/model/BlockDomain.spec.js +53 -0
  758. package/test/model/Body.spec.js +65 -0
  759. package/test/model/Body1.spec.js +65 -0
  760. package/test/model/Body10.spec.js +71 -0
  761. package/test/model/Body11.spec.js +53 -0
  762. package/test/model/Body12.spec.js +71 -0
  763. package/test/model/Body2.spec.js +71 -0
  764. package/test/model/Body3.spec.js +59 -0
  765. package/test/model/Body4.spec.js +59 -0
  766. package/test/model/Body5.spec.js +71 -0
  767. package/test/model/Body6.spec.js +113 -0
  768. package/test/model/Body7.spec.js +107 -0
  769. package/test/model/Body8.spec.js +83 -0
  770. package/test/model/Body9.spec.js +53 -0
  771. package/test/model/BodyVariablesItems.spec.js +47 -0
  772. package/test/model/CompaniesList.spec.js +53 -0
  773. package/test/model/Company.spec.js +71 -0
  774. package/test/model/CompanyAttributes.spec.js +47 -0
  775. package/test/model/CompanyAttributesInner.spec.js +77 -0
  776. package/test/model/ComponentItems.spec.js +59 -0
  777. package/test/model/ConversationsMessage.spec.js +107 -0
  778. package/test/model/ConversationsMessageFile.spec.js +77 -0
  779. package/test/model/ConversationsMessageFileImageInfo.spec.js +65 -0
  780. package/test/model/CreateApiKeyRequest.spec.js +59 -0
  781. package/test/model/CreateApiKeyResponse.spec.js +59 -0
  782. package/test/model/CreateAttribute.spec.js +71 -0
  783. package/test/model/CreateAttributeEnumeration.spec.js +59 -0
  784. package/test/model/CreateCategoryModel.spec.js +53 -0
  785. package/test/model/CreateChild.spec.js +83 -0
  786. package/test/model/CreateContact.spec.js +95 -0
  787. package/test/model/CreateCouponCollection.spec.js +59 -0
  788. package/test/model/CreateCoupons.spec.js +59 -0
  789. package/test/model/CreateDoiContact.spec.js +83 -0
  790. package/test/model/CreateDomain.spec.js +53 -0
  791. package/test/model/CreateDomainModel.spec.js +71 -0
  792. package/test/model/CreateDomainModelDnsRecords.spec.js +59 -0
  793. package/test/model/CreateDomainModelDnsRecordsDkimRecord.spec.js +71 -0
  794. package/test/model/CreateEmailCampaign.spec.js +233 -0
  795. package/test/model/CreateEmailCampaignRecipients.spec.js +65 -0
  796. package/test/model/CreateEmailCampaignSender.spec.js +65 -0
  797. package/test/model/CreateExternalFeed.spec.js +101 -0
  798. package/test/model/CreateList.spec.js +59 -0
  799. package/test/model/CreateModel.spec.js +53 -0
  800. package/test/model/CreateProductModel.spec.js +53 -0
  801. package/test/model/CreateReseller.spec.js +59 -0
  802. package/test/model/CreateSender.spec.js +65 -0
  803. package/test/model/CreateSenderIps.spec.js +65 -0
  804. package/test/model/CreateSenderModel.spec.js +65 -0
  805. package/test/model/CreateSmsCampaign.spec.js +95 -0
  806. package/test/model/CreateSmsCampaignRecipients.spec.js +59 -0
  807. package/test/model/CreateSmtpEmail.spec.js +59 -0
  808. package/test/model/CreateSmtpTemplate.spec.js +107 -0
  809. package/test/model/CreateSmtpTemplateSender.spec.js +65 -0
  810. package/test/model/CreateSubAccount.spec.js +71 -0
  811. package/test/model/CreateSubAccountResponse.spec.js +53 -0
  812. package/test/model/CreateUpdateBatchCategory.spec.js +59 -0
  813. package/test/model/CreateUpdateBatchCategoryModel.spec.js +59 -0
  814. package/test/model/CreateUpdateBatchProducts.spec.js +59 -0
  815. package/test/model/CreateUpdateBatchProductsModel.spec.js +59 -0
  816. package/test/model/CreateUpdateCategories.spec.js +71 -0
  817. package/test/model/CreateUpdateCategory.spec.js +77 -0
  818. package/test/model/CreateUpdateContactModel.spec.js +53 -0
  819. package/test/model/CreateUpdateFolder.spec.js +53 -0
  820. package/test/model/CreateUpdateProduct.spec.js +113 -0
  821. package/test/model/CreateUpdateProducts.spec.js +107 -0
  822. package/test/model/CreateWebhook.spec.js +77 -0
  823. package/test/model/CreateWhatsAppCampaign.spec.js +71 -0
  824. package/test/model/CreateWhatsAppCampaignRecipients.spec.js +65 -0
  825. package/test/model/CreateWhatsAppTemplate.spec.js +83 -0
  826. package/test/model/CreatedBatchId.spec.js +53 -0
  827. package/test/model/CreatedProcessId.spec.js +53 -0
  828. package/test/model/Deal.spec.js +71 -0
  829. package/test/model/DealAttributes.spec.js +47 -0
  830. package/test/model/DealAttributesInner.spec.js +77 -0
  831. package/test/model/DealsList.spec.js +53 -0
  832. package/test/model/DeleteHardbounces.spec.js +65 -0
  833. package/test/model/EmailExportRecipients.spec.js +59 -0
  834. package/test/model/ErrorModel.spec.js +59 -0
  835. package/test/model/ExportWebhooksHistory.spec.js +101 -0
  836. package/test/model/FileData.spec.js +89 -0
  837. package/test/model/FileDownloadableLink.spec.js +53 -0
  838. package/test/model/FileList.spec.js +47 -0
  839. package/test/model/GetAccount.spec.js +65 -0
  840. package/test/model/GetAccountActivity.spec.js +53 -0
  841. package/test/model/GetAccountActivityLogs.spec.js +77 -0
  842. package/test/model/GetAccountMarketingAutomation.spec.js +59 -0
  843. package/test/model/GetAccountPlan.spec.js +83 -0
  844. package/test/model/GetAccountRelay.spec.js +59 -0
  845. package/test/model/GetAccountRelayData.spec.js +65 -0
  846. package/test/model/GetAggregatedReport.spec.js +125 -0
  847. package/test/model/GetAllExternalFeeds.spec.js +59 -0
  848. package/test/model/GetAllExternalFeedsFeeds.spec.js +119 -0
  849. package/test/model/GetAttributes.spec.js +53 -0
  850. package/test/model/GetAttributesAttributes.spec.js +77 -0
  851. package/test/model/GetAttributesEnumeration.spec.js +59 -0
  852. package/test/model/GetBlockedDomains.spec.js +53 -0
  853. package/test/model/GetCampaignOverview.spec.js +131 -0
  854. package/test/model/GetCampaignRecipients.spec.js +59 -0
  855. package/test/model/GetCampaignStats.spec.js +143 -0
  856. package/test/model/GetCategories.spec.js +59 -0
  857. package/test/model/GetCategoryDetails.spec.js +83 -0
  858. package/test/model/GetChildAccountCreationStatus.spec.js +53 -0
  859. package/test/model/GetChildDomain.spec.js +59 -0
  860. package/test/model/GetChildDomains.spec.js +47 -0
  861. package/test/model/GetChildInfo.spec.js +77 -0
  862. package/test/model/GetChildInfoApiKeys.spec.js +59 -0
  863. package/test/model/GetChildInfoApiKeysV2.spec.js +59 -0
  864. package/test/model/GetChildInfoApiKeysV3.spec.js +59 -0
  865. package/test/model/GetChildInfoCredits.spec.js +59 -0
  866. package/test/model/GetChildInfoStatistics.spec.js +65 -0
  867. package/test/model/GetChildrenList.spec.js +59 -0
  868. package/test/model/GetClient.spec.js +71 -0
  869. package/test/model/GetContactCampaignStats.spec.js +101 -0
  870. package/test/model/GetContactCampaignStatsClicked.spec.js +59 -0
  871. package/test/model/GetContactCampaignStatsOpened.spec.js +71 -0
  872. package/test/model/GetContactCampaignStatsTransacAttributes.spec.js +65 -0
  873. package/test/model/GetContactCampaignStatsUnsubscriptions.spec.js +59 -0
  874. package/test/model/GetContactDetails.spec.js +101 -0
  875. package/test/model/GetContacts.spec.js +59 -0
  876. package/test/model/GetCouponCollection.spec.js +83 -0
  877. package/test/model/GetDeviceBrowserStats.spec.js +71 -0
  878. package/test/model/GetDomainConfigurationModel.spec.js +71 -0
  879. package/test/model/GetDomainsList.spec.js +53 -0
  880. package/test/model/GetDomainsListDomains.spec.js +77 -0
  881. package/test/model/GetEmailCampaign.spec.js +59 -0
  882. package/test/model/GetEmailCampaigns.spec.js +59 -0
  883. package/test/model/GetEmailEventReport.spec.js +53 -0
  884. package/test/model/GetEmailEventReportEvents.spec.js +113 -0
  885. package/test/model/GetExtendedCampaignOverview.spec.js +143 -0
  886. package/test/model/GetExtendedCampaignOverviewSender.spec.js +65 -0
  887. package/test/model/GetExtendedCampaignStats.spec.js +95 -0
  888. package/test/model/GetExtendedCampaignStatsGlobalStats.spec.js +47 -0
  889. package/test/model/GetExtendedClient.spec.js +53 -0
  890. package/test/model/GetExtendedClientAddress.spec.js +71 -0
  891. package/test/model/GetExtendedContactDetails.spec.js +53 -0
  892. package/test/model/GetExtendedContactDetailsStatistics.spec.js +101 -0
  893. package/test/model/GetExtendedContactDetailsStatisticsClicked.spec.js +59 -0
  894. package/test/model/GetExtendedContactDetailsStatisticsLinks.spec.js +71 -0
  895. package/test/model/GetExtendedContactDetailsStatisticsMessagesSent.spec.js +59 -0
  896. package/test/model/GetExtendedContactDetailsStatisticsOpened.spec.js +71 -0
  897. package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptions.spec.js +59 -0
  898. package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.spec.js +59 -0
  899. package/test/model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.spec.js +65 -0
  900. package/test/model/GetExtendedList.spec.js +71 -0
  901. package/test/model/GetExtendedListCampaignStats.spec.js +59 -0
  902. package/test/model/GetExternalFeedByUUID.spec.js +119 -0
  903. package/test/model/GetExternalFeedByUUIDHeaders.spec.js +59 -0
  904. package/test/model/GetFolder.spec.js +77 -0
  905. package/test/model/GetFolderLists.spec.js +59 -0
  906. package/test/model/GetFolders.spec.js +59 -0
  907. package/test/model/GetInboundEmailEvents.spec.js +53 -0
  908. package/test/model/GetInboundEmailEventsByUuid.spec.js +95 -0
  909. package/test/model/GetInboundEmailEventsByUuidAttachments.spec.js +71 -0
  910. package/test/model/GetInboundEmailEventsByUuidLogs.spec.js +59 -0
  911. package/test/model/GetInboundEmailEventsEvents.spec.js +71 -0
  912. package/test/model/GetInvitedUsersList.spec.js +53 -0
  913. package/test/model/GetInvitedUsersListFeatureAccess.spec.js +65 -0
  914. package/test/model/GetInvitedUsersListUsers.spec.js +71 -0
  915. package/test/model/GetIp.spec.js +71 -0
  916. package/test/model/GetIpFromSender.spec.js +71 -0
  917. package/test/model/GetIps.spec.js +53 -0
  918. package/test/model/GetIpsFromSender.spec.js +53 -0
  919. package/test/model/GetList.spec.js +77 -0
  920. package/test/model/GetLists.spec.js +59 -0
  921. package/test/model/GetProcess.spec.js +71 -0
  922. package/test/model/GetProcesses.spec.js +59 -0
  923. package/test/model/GetProductDetails.spec.js +137 -0
  924. package/test/model/GetProducts.spec.js +59 -0
  925. package/test/model/GetReports.spec.js +53 -0
  926. package/test/model/GetReportsReports.spec.js +125 -0
  927. package/test/model/GetScheduledEmailByBatchId.spec.js +59 -0
  928. package/test/model/GetScheduledEmailByBatchIdBatches.spec.js +65 -0
  929. package/test/model/GetScheduledEmailByMessageId.spec.js +65 -0
  930. package/test/model/GetSegments.spec.js +59 -0
  931. package/test/model/GetSegmentsSegments.spec.js +71 -0
  932. package/test/model/GetSendersList.spec.js +53 -0
  933. package/test/model/GetSendersListIps.spec.js +65 -0
  934. package/test/model/GetSendersListSenders.spec.js +77 -0
  935. package/test/model/GetSharedTemplateUrl.spec.js +53 -0
  936. package/test/model/GetSmsCampaign.spec.js +59 -0
  937. package/test/model/GetSmsCampaignOverview.spec.js +95 -0
  938. package/test/model/GetSmsCampaignRecipients.spec.js +47 -0
  939. package/test/model/GetSmsCampaignStats.spec.js +89 -0
  940. package/test/model/GetSmsCampaigns.spec.js +59 -0
  941. package/test/model/GetSmsEventReport.spec.js +53 -0
  942. package/test/model/GetSmsEventReportEvents.spec.js +89 -0
  943. package/test/model/GetSmtpTemplateOverview.spec.js +125 -0
  944. package/test/model/GetSmtpTemplateOverviewSender.spec.js +65 -0
  945. package/test/model/GetSmtpTemplates.spec.js +59 -0
  946. package/test/model/GetSsoToken.spec.js +53 -0
  947. package/test/model/GetStatsByBrowser.spec.js +47 -0
  948. package/test/model/GetStatsByDevice.spec.js +71 -0
  949. package/test/model/GetStatsByDomain.spec.js +47 -0
  950. package/test/model/GetTransacAggregatedSmsReport.spec.js +107 -0
  951. package/test/model/GetTransacBlockedContacts.spec.js +59 -0
  952. package/test/model/GetTransacBlockedContactsContacts.spec.js +71 -0
  953. package/test/model/GetTransacBlockedContactsReason.spec.js +59 -0
  954. package/test/model/GetTransacEmailContent.spec.js +89 -0
  955. package/test/model/GetTransacEmailContentEvents.spec.js +59 -0
  956. package/test/model/GetTransacEmailsList.spec.js +59 -0
  957. package/test/model/GetTransacEmailsListTransactionalEmails.spec.js +95 -0
  958. package/test/model/GetTransacSmsReport.spec.js +53 -0
  959. package/test/model/GetTransacSmsReportReports.spec.js +107 -0
  960. package/test/model/GetUserPermission.spec.js +65 -0
  961. package/test/model/GetUserPermissionPrivileges.spec.js +59 -0
  962. package/test/model/GetWATemplates.spec.js +59 -0
  963. package/test/model/GetWATemplatesTemplates.spec.js +95 -0
  964. package/test/model/GetWebhook.spec.js +89 -0
  965. package/test/model/GetWebhooks.spec.js +53 -0
  966. package/test/model/GetWhatsAppConfig.spec.js +83 -0
  967. package/test/model/GetWhatsappCampaignOverview.spec.js +101 -0
  968. package/test/model/GetWhatsappCampaigns.spec.js +59 -0
  969. package/test/model/GetWhatsappCampaignsCampaigns.spec.js +113 -0
  970. package/test/model/GetWhatsappEventReport.spec.js +53 -0
  971. package/test/model/GetWhatsappEventReportEvents.spec.js +95 -0
  972. package/test/model/InlineResponse200.spec.js +53 -0
  973. package/test/model/InlineResponse2001.spec.js +65 -0
  974. package/test/model/InlineResponse201.spec.js +53 -0
  975. package/test/model/InlineResponse2011.spec.js +53 -0
  976. package/test/model/InlineResponse2012.spec.js +53 -0
  977. package/test/model/InlineResponse2013.spec.js +53 -0
  978. package/test/model/InlineResponse2014.spec.js +53 -0
  979. package/test/model/ManageIp.spec.js +53 -0
  980. package/test/model/MasterDetailsResponse.spec.js +89 -0
  981. package/test/model/MasterDetailsResponseBillingInfo.spec.js +71 -0
  982. package/test/model/MasterDetailsResponseBillingInfoAddress.spec.js +77 -0
  983. package/test/model/MasterDetailsResponseBillingInfoName.spec.js +59 -0
  984. package/test/model/MasterDetailsResponsePlanInfo.spec.js +83 -0
  985. package/test/model/MasterDetailsResponsePlanInfoFeatures.spec.js +77 -0
  986. package/test/model/Note.spec.js +89 -0
  987. package/test/model/NoteData.spec.js +71 -0
  988. package/test/model/NoteId.spec.js +53 -0
  989. package/test/model/NoteList.spec.js +47 -0
  990. package/test/model/Order.spec.js +101 -0
  991. package/test/model/OrderBatch.spec.js +59 -0
  992. package/test/model/OrderBilling.spec.js +89 -0
  993. package/test/model/OrderProducts.spec.js +71 -0
  994. package/test/model/Otp.spec.js +53 -0
  995. package/test/model/Pipeline.spec.js +65 -0
  996. package/test/model/PipelineStage.spec.js +59 -0
  997. package/test/model/Pipelines.spec.js +47 -0
  998. package/test/model/PostContactInfo.spec.js +53 -0
  999. package/test/model/PostContactInfoContacts.spec.js +71 -0
  1000. package/test/model/PostSendFailed.spec.js +77 -0
  1001. package/test/model/PostSendSmsTestFailed.spec.js +71 -0
  1002. package/test/model/RemainingCreditModel.spec.js +59 -0
  1003. package/test/model/RemainingCreditModelChild.spec.js +59 -0
  1004. package/test/model/RemainingCreditModelReseller.spec.js +59 -0
  1005. package/test/model/RemoveContactFromList.spec.js +65 -0
  1006. package/test/model/RemoveCredits.spec.js +59 -0
  1007. package/test/model/RequestContactExport.spec.js +65 -0
  1008. package/test/model/RequestContactExportCustomContactFilter.spec.js +83 -0
  1009. package/test/model/RequestContactImport.spec.js +107 -0
  1010. package/test/model/RequestContactImportNewList.spec.js +59 -0
  1011. package/test/model/RequestSmsRecipientExport.spec.js +59 -0
  1012. package/test/model/ScheduleSmtpEmail.spec.js +65 -0
  1013. package/test/model/SendReport.spec.js +59 -0
  1014. package/test/model/SendReportEmail.spec.js +59 -0
  1015. package/test/model/SendSms.spec.js +77 -0
  1016. package/test/model/SendSmtpEmail.spec.js +143 -0
  1017. package/test/model/SendSmtpEmailAttachment.spec.js +65 -0
  1018. package/test/model/SendSmtpEmailBcc.spec.js +59 -0
  1019. package/test/model/SendSmtpEmailCc.spec.js +59 -0
  1020. package/test/model/SendSmtpEmailMessageVersions.spec.js +83 -0
  1021. package/test/model/SendSmtpEmailReplyTo.spec.js +59 -0
  1022. package/test/model/SendSmtpEmailReplyTo1.spec.js +59 -0
  1023. package/test/model/SendSmtpEmailSender.spec.js +65 -0
  1024. package/test/model/SendSmtpEmailTo.spec.js +59 -0
  1025. package/test/model/SendSmtpEmailTo1.spec.js +59 -0
  1026. package/test/model/SendTestEmail.spec.js +53 -0
  1027. package/test/model/SendTestSms.spec.js +53 -0
  1028. package/test/model/SendTransacSms.spec.js +95 -0
  1029. package/test/model/SendWhatsappMessage.spec.js +71 -0
  1030. package/test/model/SsoTokenRequest.spec.js +65 -0
  1031. package/test/model/SubAccountDetailsResponse.spec.js +71 -0
  1032. package/test/model/SubAccountDetailsResponsePlanInfo.spec.js +65 -0
  1033. package/test/model/SubAccountDetailsResponsePlanInfoCredits.spec.js +59 -0
  1034. package/test/model/SubAccountDetailsResponsePlanInfoCreditsEmails.spec.js +59 -0
  1035. package/test/model/SubAccountDetailsResponsePlanInfoFeatures.spec.js +65 -0
  1036. package/test/model/SubAccountDetailsResponsePlanInfoFeaturesInbox.spec.js +59 -0
  1037. package/test/model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.spec.js +59 -0
  1038. package/test/model/SubAccountDetailsResponsePlanInfoFeaturesUsers.spec.js +59 -0
  1039. package/test/model/SubAccountUpdatePlanRequest.spec.js +59 -0
  1040. package/test/model/SubAccountUpdatePlanRequestCredits.spec.js +53 -0
  1041. package/test/model/SubAccountUpdatePlanRequestFeatures.spec.js +65 -0
  1042. package/test/model/SubAccountsResponse.spec.js +59 -0
  1043. package/test/model/SubAccountsResponseSubAccounts.spec.js +71 -0
  1044. package/test/model/Task.spec.js +83 -0
  1045. package/test/model/TaskList.spec.js +53 -0
  1046. package/test/model/TaskReminder.spec.js +65 -0
  1047. package/test/model/TaskTypes.spec.js +59 -0
  1048. package/test/model/UpdateAttribute.spec.js +59 -0
  1049. package/test/model/UpdateAttributeEnumeration.spec.js +59 -0
  1050. package/test/model/UpdateBatchContacts.spec.js +53 -0
  1051. package/test/model/UpdateBatchContactsContacts.spec.js +107 -0
  1052. package/test/model/UpdateBatchContactsModel.spec.js +59 -0
  1053. package/test/model/UpdateCampaignStatus.spec.js +53 -0
  1054. package/test/model/UpdateChild.spec.js +77 -0
  1055. package/test/model/UpdateChildAccountStatus.spec.js +71 -0
  1056. package/test/model/UpdateChildDomain.spec.js +53 -0
  1057. package/test/model/UpdateContact.spec.js +89 -0
  1058. package/test/model/UpdateCouponCollection.spec.js +53 -0
  1059. package/test/model/UpdateEmailCampaign.spec.js +233 -0
  1060. package/test/model/UpdateEmailCampaignRecipients.spec.js +65 -0
  1061. package/test/model/UpdateEmailCampaignSender.spec.js +65 -0
  1062. package/test/model/UpdateExternalFeed.spec.js +101 -0
  1063. package/test/model/UpdateList.spec.js +59 -0
  1064. package/test/model/UpdateSender.spec.js +65 -0
  1065. package/test/model/UpdateSmsCampaign.spec.js +95 -0
  1066. package/test/model/UpdateSmtpTemplate.spec.js +107 -0
  1067. package/test/model/UpdateSmtpTemplateSender.spec.js +65 -0
  1068. package/test/model/UpdateWebhook.spec.js +71 -0
  1069. package/test/model/UpdateWhatsAppCampaign.spec.js +71 -0
  1070. package/test/model/UploadImageModel.spec.js +53 -0
  1071. package/test/model/UploadImageToGallery.spec.js +59 -0
  1072. package/test/model/VariablesItems.spec.js +65 -0
  1073. package/test/model/WhatsappCampStats.spec.js +77 -0
  1074. package/test/model/WhatsappCampTemplate.spec.js +113 -0
@@ -0,0 +1,1333 @@
1
+ # Brevo.TransactionalEmailsApi
2
+
3
+ All URIs are relative to *https://api.brevo.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**blockNewDomain**](TransactionalEmailsApi.md#blockNewDomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
8
+ [**createSmtpTemplate**](TransactionalEmailsApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an email template
9
+ [**deleteBlockedDomain**](TransactionalEmailsApi.md#deleteBlockedDomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
10
+ [**deleteHardbounces**](TransactionalEmailsApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
11
+ [**deleteScheduledEmailById**](TransactionalEmailsApi.md#deleteScheduledEmailById) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
12
+ [**deleteSmtpTemplate**](TransactionalEmailsApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
13
+ [**getAggregatedSmtpReport**](TransactionalEmailsApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
14
+ [**getBlockedDomains**](TransactionalEmailsApi.md#getBlockedDomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
15
+ [**getEmailEventReport**](TransactionalEmailsApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
16
+ [**getScheduledEmailByBatchId**](TransactionalEmailsApi.md#getScheduledEmailByBatchId) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
17
+ [**getScheduledEmailByMessageId**](TransactionalEmailsApi.md#getScheduledEmailByMessageId) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
18
+ [**getSmtpReport**](TransactionalEmailsApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
19
+ [**getSmtpTemplate**](TransactionalEmailsApi.md#getSmtpTemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
20
+ [**getSmtpTemplates**](TransactionalEmailsApi.md#getSmtpTemplates) | **GET** /smtp/templates | Get the list of email templates
21
+ [**getTransacBlockedContacts**](TransactionalEmailsApi.md#getTransacBlockedContacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
22
+ [**getTransacEmailContent**](TransactionalEmailsApi.md#getTransacEmailContent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
23
+ [**getTransacEmailsList**](TransactionalEmailsApi.md#getTransacEmailsList) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
24
+ [**sendTestTemplate**](TransactionalEmailsApi.md#sendTestTemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
25
+ [**sendTransacEmail**](TransactionalEmailsApi.md#sendTransacEmail) | **POST** /smtp/email | Send a transactional email
26
+ [**smtpBlockedContactsEmailDelete**](TransactionalEmailsApi.md#smtpBlockedContactsEmailDelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
27
+ [**smtpLogMessageIdDelete**](TransactionalEmailsApi.md#smtpLogMessageIdDelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
28
+ [**updateSmtpTemplate**](TransactionalEmailsApi.md#updateSmtpTemplate) | **PUT** /smtp/templates/{templateId} | Update an email template
29
+
30
+
31
+ <a name="blockNewDomain"></a>
32
+ # **blockNewDomain**
33
+ > blockNewDomain(blockDomain)
34
+
35
+ Add a new domain to the list of blocked domains
36
+
37
+ Blocks a new domain in order to avoid messages being sent to the same
38
+
39
+ ### Example
40
+ ```javascript
41
+ var Brevo = require('@getbrevo/brevo');
42
+ var defaultClient = Brevo.ApiClient.instance;
43
+
44
+ // Configure API key authorization: api-key
45
+ var apiKey = defaultClient.authentications['api-key'];
46
+ apiKey.apiKey = 'YOUR API KEY';
47
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
48
+ //apiKey.apiKeyPrefix = 'Token';
49
+
50
+ // Configure API key authorization: partner-key
51
+ var partnerKey = defaultClient.authentications['partner-key'];
52
+ partnerKey.apiKey = 'YOUR API KEY';
53
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
54
+ //partnerKey.apiKeyPrefix = 'Token';
55
+
56
+ var apiInstance = new Brevo.TransactionalEmailsApi();
57
+
58
+ var blockDomain = new Brevo.BlockDomain(); // BlockDomain |
59
+
60
+ apiInstance.blockNewDomain(blockDomain).then(function() {
61
+ console.log('API called successfully.');
62
+ }, function(error) {
63
+ console.error(error);
64
+ });
65
+
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ Name | Type | Description | Notes
71
+ ------------- | ------------- | ------------- | -------------
72
+ **blockDomain** | [**BlockDomain**](BlockDomain.md)| |
73
+
74
+ ### Return type
75
+
76
+ null (empty response body)
77
+
78
+ ### Authorization
79
+
80
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: application/json
85
+ - **Accept**: application/json
86
+
87
+ <a name="createSmtpTemplate"></a>
88
+ # **createSmtpTemplate**
89
+ > CreateModel createSmtpTemplate(smtpTemplate)
90
+
91
+ Create an email template
92
+
93
+ ### Example
94
+ ```javascript
95
+ var Brevo = require('@getbrevo/brevo');
96
+ var defaultClient = Brevo.ApiClient.instance;
97
+
98
+ // Configure API key authorization: api-key
99
+ var apiKey = defaultClient.authentications['api-key'];
100
+ apiKey.apiKey = 'YOUR API KEY';
101
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
102
+ //apiKey.apiKeyPrefix = 'Token';
103
+
104
+ // Configure API key authorization: partner-key
105
+ var partnerKey = defaultClient.authentications['partner-key'];
106
+ partnerKey.apiKey = 'YOUR API KEY';
107
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
108
+ //partnerKey.apiKeyPrefix = 'Token';
109
+
110
+ var apiInstance = new Brevo.TransactionalEmailsApi();
111
+
112
+ var smtpTemplate = new Brevo.CreateSmtpTemplate(); // CreateSmtpTemplate | values to update in transactional email template
113
+
114
+ apiInstance.createSmtpTemplate(smtpTemplate).then(function(data) {
115
+ console.log('API called successfully. Returned data: ' + data);
116
+ }, function(error) {
117
+ console.error(error);
118
+ });
119
+
120
+ ```
121
+
122
+ ### Parameters
123
+
124
+ Name | Type | Description | Notes
125
+ ------------- | ------------- | ------------- | -------------
126
+ **smtpTemplate** | [**CreateSmtpTemplate**](CreateSmtpTemplate.md)| values to update in transactional email template |
127
+
128
+ ### Return type
129
+
130
+ [**CreateModel**](CreateModel.md)
131
+
132
+ ### Authorization
133
+
134
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
135
+
136
+ ### HTTP request headers
137
+
138
+ - **Content-Type**: application/json
139
+ - **Accept**: application/json
140
+
141
+ <a name="deleteBlockedDomain"></a>
142
+ # **deleteBlockedDomain**
143
+ > deleteBlockedDomain(domain)
144
+
145
+ Unblock an existing domain from the list of blocked domains
146
+
147
+ Unblocks an existing domain from the list of blocked domains
148
+
149
+ ### Example
150
+ ```javascript
151
+ var Brevo = require('@getbrevo/brevo');
152
+ var defaultClient = Brevo.ApiClient.instance;
153
+
154
+ // Configure API key authorization: api-key
155
+ var apiKey = defaultClient.authentications['api-key'];
156
+ apiKey.apiKey = 'YOUR API KEY';
157
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
158
+ //apiKey.apiKeyPrefix = 'Token';
159
+
160
+ // Configure API key authorization: partner-key
161
+ var partnerKey = defaultClient.authentications['partner-key'];
162
+ partnerKey.apiKey = 'YOUR API KEY';
163
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
164
+ //partnerKey.apiKeyPrefix = 'Token';
165
+
166
+ var apiInstance = new Brevo.TransactionalEmailsApi();
167
+
168
+ var domain = "domain_example"; // String | The name of the domain to be deleted
169
+
170
+ apiInstance.deleteBlockedDomain(domain).then(function() {
171
+ console.log('API called successfully.');
172
+ }, function(error) {
173
+ console.error(error);
174
+ });
175
+
176
+ ```
177
+
178
+ ### Parameters
179
+
180
+ Name | Type | Description | Notes
181
+ ------------- | ------------- | ------------- | -------------
182
+ **domain** | **String**| The name of the domain to be deleted |
183
+
184
+ ### Return type
185
+
186
+ null (empty response body)
187
+
188
+ ### Authorization
189
+
190
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: application/json
195
+ - **Accept**: application/json
196
+
197
+ <a name="deleteHardbounces"></a>
198
+ # **deleteHardbounces**
199
+ > deleteHardbounces(opts)
200
+
201
+ Delete hardbounces
202
+
203
+ Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
204
+
205
+ ### Example
206
+ ```javascript
207
+ var Brevo = require('@getbrevo/brevo');
208
+ var defaultClient = Brevo.ApiClient.instance;
209
+
210
+ // Configure API key authorization: api-key
211
+ var apiKey = defaultClient.authentications['api-key'];
212
+ apiKey.apiKey = 'YOUR API KEY';
213
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
214
+ //apiKey.apiKeyPrefix = 'Token';
215
+
216
+ // Configure API key authorization: partner-key
217
+ var partnerKey = defaultClient.authentications['partner-key'];
218
+ partnerKey.apiKey = 'YOUR API KEY';
219
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
220
+ //partnerKey.apiKeyPrefix = 'Token';
221
+
222
+ var apiInstance = new Brevo.TransactionalEmailsApi();
223
+
224
+ var opts = {
225
+ 'deleteHardbounces': new Brevo.DeleteHardbounces() // DeleteHardbounces | values to delete hardbounces
226
+ };
227
+ apiInstance.deleteHardbounces(opts).then(function() {
228
+ console.log('API called successfully.');
229
+ }, function(error) {
230
+ console.error(error);
231
+ });
232
+
233
+ ```
234
+
235
+ ### Parameters
236
+
237
+ Name | Type | Description | Notes
238
+ ------------- | ------------- | ------------- | -------------
239
+ **deleteHardbounces** | [**DeleteHardbounces**](DeleteHardbounces.md)| values to delete hardbounces | [optional]
240
+
241
+ ### Return type
242
+
243
+ null (empty response body)
244
+
245
+ ### Authorization
246
+
247
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
248
+
249
+ ### HTTP request headers
250
+
251
+ - **Content-Type**: application/json
252
+ - **Accept**: application/json
253
+
254
+ <a name="deleteScheduledEmailById"></a>
255
+ # **deleteScheduledEmailById**
256
+ > deleteScheduledEmailById(identifier)
257
+
258
+ Delete scheduled emails by batchId or messageId
259
+
260
+ Delete scheduled batch of emails by batchId or single scheduled email by messageId
261
+
262
+ ### Example
263
+ ```javascript
264
+ var Brevo = require('@getbrevo/brevo');
265
+ var defaultClient = Brevo.ApiClient.instance;
266
+
267
+ // Configure API key authorization: api-key
268
+ var apiKey = defaultClient.authentications['api-key'];
269
+ apiKey.apiKey = 'YOUR API KEY';
270
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
271
+ //apiKey.apiKeyPrefix = 'Token';
272
+
273
+ // Configure API key authorization: partner-key
274
+ var partnerKey = defaultClient.authentications['partner-key'];
275
+ partnerKey.apiKey = 'YOUR API KEY';
276
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
277
+ //partnerKey.apiKeyPrefix = 'Token';
278
+
279
+ var apiInstance = new Brevo.TransactionalEmailsApi();
280
+
281
+ var identifier = "identifier_example"; // String | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
282
+
283
+ apiInstance.deleteScheduledEmailById(identifier).then(function() {
284
+ console.log('API called successfully.');
285
+ }, function(error) {
286
+ console.error(error);
287
+ });
288
+
289
+ ```
290
+
291
+ ### Parameters
292
+
293
+ Name | Type | Description | Notes
294
+ ------------- | ------------- | ------------- | -------------
295
+ **identifier** | **String**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. |
296
+
297
+ ### Return type
298
+
299
+ null (empty response body)
300
+
301
+ ### Authorization
302
+
303
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
304
+
305
+ ### HTTP request headers
306
+
307
+ - **Content-Type**: application/json
308
+ - **Accept**: application/json
309
+
310
+ <a name="deleteSmtpTemplate"></a>
311
+ # **deleteSmtpTemplate**
312
+ > deleteSmtpTemplate(templateId)
313
+
314
+ Delete an inactive email template
315
+
316
+ ### Example
317
+ ```javascript
318
+ var Brevo = require('@getbrevo/brevo');
319
+ var defaultClient = Brevo.ApiClient.instance;
320
+
321
+ // Configure API key authorization: api-key
322
+ var apiKey = defaultClient.authentications['api-key'];
323
+ apiKey.apiKey = 'YOUR API KEY';
324
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
325
+ //apiKey.apiKeyPrefix = 'Token';
326
+
327
+ // Configure API key authorization: partner-key
328
+ var partnerKey = defaultClient.authentications['partner-key'];
329
+ partnerKey.apiKey = 'YOUR API KEY';
330
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
331
+ //partnerKey.apiKeyPrefix = 'Token';
332
+
333
+ var apiInstance = new Brevo.TransactionalEmailsApi();
334
+
335
+ var templateId = 789; // Number | id of the template
336
+
337
+ apiInstance.deleteSmtpTemplate(templateId).then(function() {
338
+ console.log('API called successfully.');
339
+ }, function(error) {
340
+ console.error(error);
341
+ });
342
+
343
+ ```
344
+
345
+ ### Parameters
346
+
347
+ Name | Type | Description | Notes
348
+ ------------- | ------------- | ------------- | -------------
349
+ **templateId** | **Number**| id of the template |
350
+
351
+ ### Return type
352
+
353
+ null (empty response body)
354
+
355
+ ### Authorization
356
+
357
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
358
+
359
+ ### HTTP request headers
360
+
361
+ - **Content-Type**: application/json
362
+ - **Accept**: application/json
363
+
364
+ <a name="getAggregatedSmtpReport"></a>
365
+ # **getAggregatedSmtpReport**
366
+ > GetAggregatedReport getAggregatedSmtpReport(opts)
367
+
368
+ Get your transactional email activity aggregated over a period of time
369
+
370
+ This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
371
+
372
+ ### Example
373
+ ```javascript
374
+ var Brevo = require('@getbrevo/brevo');
375
+ var defaultClient = Brevo.ApiClient.instance;
376
+
377
+ // Configure API key authorization: api-key
378
+ var apiKey = defaultClient.authentications['api-key'];
379
+ apiKey.apiKey = 'YOUR API KEY';
380
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
381
+ //apiKey.apiKeyPrefix = 'Token';
382
+
383
+ // Configure API key authorization: partner-key
384
+ var partnerKey = defaultClient.authentications['partner-key'];
385
+ partnerKey.apiKey = 'YOUR API KEY';
386
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
387
+ //partnerKey.apiKeyPrefix = 'Token';
388
+
389
+ var apiInstance = new Brevo.TransactionalEmailsApi();
390
+
391
+ var opts = {
392
+ 'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
393
+ 'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
394
+ 'days': 789, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
395
+ 'tag': "tag_example" // String | Tag of the emails
396
+ };
397
+ apiInstance.getAggregatedSmtpReport(opts).then(function(data) {
398
+ console.log('API called successfully. Returned data: ' + data);
399
+ }, function(error) {
400
+ console.error(error);
401
+ });
402
+
403
+ ```
404
+
405
+ ### Parameters
406
+
407
+ Name | Type | Description | Notes
408
+ ------------- | ------------- | ------------- | -------------
409
+ **startDate** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
410
+ **endDate** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
411
+ **days** | **Number**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
412
+ **tag** | **String**| Tag of the emails | [optional]
413
+
414
+ ### Return type
415
+
416
+ [**GetAggregatedReport**](GetAggregatedReport.md)
417
+
418
+ ### Authorization
419
+
420
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
421
+
422
+ ### HTTP request headers
423
+
424
+ - **Content-Type**: application/json
425
+ - **Accept**: application/json
426
+
427
+ <a name="getBlockedDomains"></a>
428
+ # **getBlockedDomains**
429
+ > GetBlockedDomains getBlockedDomains()
430
+
431
+ Get the list of blocked domains
432
+
433
+ Get the list of blocked domains
434
+
435
+ ### Example
436
+ ```javascript
437
+ var Brevo = require('@getbrevo/brevo');
438
+ var defaultClient = Brevo.ApiClient.instance;
439
+
440
+ // Configure API key authorization: api-key
441
+ var apiKey = defaultClient.authentications['api-key'];
442
+ apiKey.apiKey = 'YOUR API KEY';
443
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
444
+ //apiKey.apiKeyPrefix = 'Token';
445
+
446
+ // Configure API key authorization: partner-key
447
+ var partnerKey = defaultClient.authentications['partner-key'];
448
+ partnerKey.apiKey = 'YOUR API KEY';
449
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
450
+ //partnerKey.apiKeyPrefix = 'Token';
451
+
452
+ var apiInstance = new Brevo.TransactionalEmailsApi();
453
+ apiInstance.getBlockedDomains().then(function(data) {
454
+ console.log('API called successfully. Returned data: ' + data);
455
+ }, function(error) {
456
+ console.error(error);
457
+ });
458
+
459
+ ```
460
+
461
+ ### Parameters
462
+ This endpoint does not need any parameter.
463
+
464
+ ### Return type
465
+
466
+ [**GetBlockedDomains**](GetBlockedDomains.md)
467
+
468
+ ### Authorization
469
+
470
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
471
+
472
+ ### HTTP request headers
473
+
474
+ - **Content-Type**: application/json
475
+ - **Accept**: application/json
476
+
477
+ <a name="getEmailEventReport"></a>
478
+ # **getEmailEventReport**
479
+ > GetEmailEventReport getEmailEventReport(opts)
480
+
481
+ Get all your transactional email activity (unaggregated events)
482
+
483
+ This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
484
+
485
+ ### Example
486
+ ```javascript
487
+ var Brevo = require('@getbrevo/brevo');
488
+ var defaultClient = Brevo.ApiClient.instance;
489
+
490
+ // Configure API key authorization: api-key
491
+ var apiKey = defaultClient.authentications['api-key'];
492
+ apiKey.apiKey = 'YOUR API KEY';
493
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
494
+ //apiKey.apiKeyPrefix = 'Token';
495
+
496
+ // Configure API key authorization: partner-key
497
+ var partnerKey = defaultClient.authentications['partner-key'];
498
+ partnerKey.apiKey = 'YOUR API KEY';
499
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
500
+ //partnerKey.apiKeyPrefix = 'Token';
501
+
502
+ var apiInstance = new Brevo.TransactionalEmailsApi();
503
+
504
+ var opts = {
505
+ 'limit': 2500, // Number | Number limitation for the result returned
506
+ 'offset': 0, // Number | Beginning point in the list to retrieve from.
507
+ 'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
508
+ 'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
509
+ 'days': 789, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
510
+ 'email': "email_example", // String | Filter the report for a specific email addresses
511
+ 'event': "event_example", // String | Filter the report for a specific event type
512
+ 'tags': "tags_example", // String | Filter the report for tags (serialized and urlencoded array)
513
+ 'messageId': "messageId_example", // String | Filter on a specific message id
514
+ 'templateId': 789, // Number | Filter on a specific template id
515
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
516
+ };
517
+ apiInstance.getEmailEventReport(opts).then(function(data) {
518
+ console.log('API called successfully. Returned data: ' + data);
519
+ }, function(error) {
520
+ console.error(error);
521
+ });
522
+
523
+ ```
524
+
525
+ ### Parameters
526
+
527
+ Name | Type | Description | Notes
528
+ ------------- | ------------- | ------------- | -------------
529
+ **limit** | **Number**| Number limitation for the result returned | [optional] [default to 2500]
530
+ **offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]
531
+ **startDate** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
532
+ **endDate** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
533
+ **days** | **Number**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
534
+ **email** | **String**| Filter the report for a specific email addresses | [optional]
535
+ **event** | **String**| Filter the report for a specific event type | [optional]
536
+ **tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional]
537
+ **messageId** | **String**| Filter on a specific message id | [optional]
538
+ **templateId** | **Number**| Filter on a specific template id | [optional]
539
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
540
+
541
+ ### Return type
542
+
543
+ [**GetEmailEventReport**](GetEmailEventReport.md)
544
+
545
+ ### Authorization
546
+
547
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
548
+
549
+ ### HTTP request headers
550
+
551
+ - **Content-Type**: application/json
552
+ - **Accept**: application/json
553
+
554
+ <a name="getScheduledEmailByBatchId"></a>
555
+ # **getScheduledEmailByBatchId**
556
+ > GetScheduledEmailByBatchId getScheduledEmailByBatchId(batchId, opts)
557
+
558
+ Fetch scheduled emails by batchId
559
+
560
+ Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
561
+
562
+ ### Example
563
+ ```javascript
564
+ var Brevo = require('@getbrevo/brevo');
565
+ var defaultClient = Brevo.ApiClient.instance;
566
+
567
+ // Configure API key authorization: api-key
568
+ var apiKey = defaultClient.authentications['api-key'];
569
+ apiKey.apiKey = 'YOUR API KEY';
570
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
571
+ //apiKey.apiKeyPrefix = 'Token';
572
+
573
+ // Configure API key authorization: partner-key
574
+ var partnerKey = defaultClient.authentications['partner-key'];
575
+ partnerKey.apiKey = 'YOUR API KEY';
576
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
577
+ //partnerKey.apiKeyPrefix = 'Token';
578
+
579
+ var apiInstance = new Brevo.TransactionalEmailsApi();
580
+
581
+ var batchId = "batchId_example"; // String | The batchId of scheduled emails batch (Should be a valid UUIDv4)
582
+
583
+ var opts = {
584
+ 'startDate': new Date("2013-10-20"), // Date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
585
+ 'endDate': new Date("2013-10-20"), // Date | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
586
+ 'sort': "desc", // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
587
+ 'status': "status_example", // String | Filter the records by `status` of the scheduled email batch or message.
588
+ 'limit': 100, // Number | Number of documents returned per page
589
+ 'offset': 0 // Number | Index of the first document on the page
590
+ };
591
+ apiInstance.getScheduledEmailByBatchId(batchId, opts).then(function(data) {
592
+ console.log('API called successfully. Returned data: ' + data);
593
+ }, function(error) {
594
+ console.error(error);
595
+ });
596
+
597
+ ```
598
+
599
+ ### Parameters
600
+
601
+ Name | Type | Description | Notes
602
+ ------------- | ------------- | ------------- | -------------
603
+ **batchId** | **String**| The batchId of scheduled emails batch (Should be a valid UUIDv4) |
604
+ **startDate** | **Date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
605
+ **endDate** | **Date**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
606
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
607
+ **status** | **String**| Filter the records by `status` of the scheduled email batch or message. | [optional]
608
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 100]
609
+ **offset** | **Number**| Index of the first document on the page | [optional] [default to 0]
610
+
611
+ ### Return type
612
+
613
+ [**GetScheduledEmailByBatchId**](GetScheduledEmailByBatchId.md)
614
+
615
+ ### Authorization
616
+
617
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
618
+
619
+ ### HTTP request headers
620
+
621
+ - **Content-Type**: application/json
622
+ - **Accept**: application/json
623
+
624
+ <a name="getScheduledEmailByMessageId"></a>
625
+ # **getScheduledEmailByMessageId**
626
+ > GetScheduledEmailByMessageId getScheduledEmailByMessageId(messageId, opts)
627
+
628
+ Fetch scheduled email by messageId
629
+
630
+ Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
631
+
632
+ ### Example
633
+ ```javascript
634
+ var Brevo = require('@getbrevo/brevo');
635
+ var defaultClient = Brevo.ApiClient.instance;
636
+
637
+ // Configure API key authorization: api-key
638
+ var apiKey = defaultClient.authentications['api-key'];
639
+ apiKey.apiKey = 'YOUR API KEY';
640
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
641
+ //apiKey.apiKeyPrefix = 'Token';
642
+
643
+ // Configure API key authorization: partner-key
644
+ var partnerKey = defaultClient.authentications['partner-key'];
645
+ partnerKey.apiKey = 'YOUR API KEY';
646
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
647
+ //partnerKey.apiKeyPrefix = 'Token';
648
+
649
+ var apiInstance = new Brevo.TransactionalEmailsApi();
650
+
651
+ var messageId = "messageId_example"; // String | The messageId of scheduled email
652
+
653
+ var opts = {
654
+ 'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
655
+ 'endDate': new Date("2013-10-20") // Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
656
+ };
657
+ apiInstance.getScheduledEmailByMessageId(messageId, opts).then(function(data) {
658
+ console.log('API called successfully. Returned data: ' + data);
659
+ }, function(error) {
660
+ console.error(error);
661
+ });
662
+
663
+ ```
664
+
665
+ ### Parameters
666
+
667
+ Name | Type | Description | Notes
668
+ ------------- | ------------- | ------------- | -------------
669
+ **messageId** | **String**| The messageId of scheduled email |
670
+ **startDate** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional]
671
+ **endDate** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
672
+
673
+ ### Return type
674
+
675
+ [**GetScheduledEmailByMessageId**](GetScheduledEmailByMessageId.md)
676
+
677
+ ### Authorization
678
+
679
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
680
+
681
+ ### HTTP request headers
682
+
683
+ - **Content-Type**: application/json
684
+ - **Accept**: application/json
685
+
686
+ <a name="getSmtpReport"></a>
687
+ # **getSmtpReport**
688
+ > GetReports getSmtpReport(opts)
689
+
690
+ Get your transactional email activity aggregated per day
691
+
692
+ ### Example
693
+ ```javascript
694
+ var Brevo = require('@getbrevo/brevo');
695
+ var defaultClient = Brevo.ApiClient.instance;
696
+
697
+ // Configure API key authorization: api-key
698
+ var apiKey = defaultClient.authentications['api-key'];
699
+ apiKey.apiKey = 'YOUR API KEY';
700
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
701
+ //apiKey.apiKeyPrefix = 'Token';
702
+
703
+ // Configure API key authorization: partner-key
704
+ var partnerKey = defaultClient.authentications['partner-key'];
705
+ partnerKey.apiKey = 'YOUR API KEY';
706
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
707
+ //partnerKey.apiKeyPrefix = 'Token';
708
+
709
+ var apiInstance = new Brevo.TransactionalEmailsApi();
710
+
711
+ var opts = {
712
+ 'limit': 10, // Number | Number of documents returned per page
713
+ 'offset': 0, // Number | Index of the first document on the page
714
+ 'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
715
+ 'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
716
+ 'days': 789, // Number | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
717
+ 'tag': "tag_example", // String | Tag of the emails
718
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
719
+ };
720
+ apiInstance.getSmtpReport(opts).then(function(data) {
721
+ console.log('API called successfully. Returned data: ' + data);
722
+ }, function(error) {
723
+ console.error(error);
724
+ });
725
+
726
+ ```
727
+
728
+ ### Parameters
729
+
730
+ Name | Type | Description | Notes
731
+ ------------- | ------------- | ------------- | -------------
732
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 10]
733
+ **offset** | **Number**| Index of the first document on the page | [optional] [default to 0]
734
+ **startDate** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
735
+ **endDate** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
736
+ **days** | **Number**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
737
+ **tag** | **String**| Tag of the emails | [optional]
738
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
739
+
740
+ ### Return type
741
+
742
+ [**GetReports**](GetReports.md)
743
+
744
+ ### Authorization
745
+
746
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
747
+
748
+ ### HTTP request headers
749
+
750
+ - **Content-Type**: application/json
751
+ - **Accept**: application/json
752
+
753
+ <a name="getSmtpTemplate"></a>
754
+ # **getSmtpTemplate**
755
+ > GetSmtpTemplateOverview getSmtpTemplate(templateId)
756
+
757
+ Returns the template information
758
+
759
+ ### Example
760
+ ```javascript
761
+ var Brevo = require('@getbrevo/brevo');
762
+ var defaultClient = Brevo.ApiClient.instance;
763
+
764
+ // Configure API key authorization: api-key
765
+ var apiKey = defaultClient.authentications['api-key'];
766
+ apiKey.apiKey = 'YOUR API KEY';
767
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
768
+ //apiKey.apiKeyPrefix = 'Token';
769
+
770
+ // Configure API key authorization: partner-key
771
+ var partnerKey = defaultClient.authentications['partner-key'];
772
+ partnerKey.apiKey = 'YOUR API KEY';
773
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
774
+ //partnerKey.apiKeyPrefix = 'Token';
775
+
776
+ var apiInstance = new Brevo.TransactionalEmailsApi();
777
+
778
+ var templateId = 789; // Number | id of the template
779
+
780
+ apiInstance.getSmtpTemplate(templateId).then(function(data) {
781
+ console.log('API called successfully. Returned data: ' + data);
782
+ }, function(error) {
783
+ console.error(error);
784
+ });
785
+
786
+ ```
787
+
788
+ ### Parameters
789
+
790
+ Name | Type | Description | Notes
791
+ ------------- | ------------- | ------------- | -------------
792
+ **templateId** | **Number**| id of the template |
793
+
794
+ ### Return type
795
+
796
+ [**GetSmtpTemplateOverview**](GetSmtpTemplateOverview.md)
797
+
798
+ ### Authorization
799
+
800
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
801
+
802
+ ### HTTP request headers
803
+
804
+ - **Content-Type**: application/json
805
+ - **Accept**: application/json
806
+
807
+ <a name="getSmtpTemplates"></a>
808
+ # **getSmtpTemplates**
809
+ > GetSmtpTemplates getSmtpTemplates(opts)
810
+
811
+ Get the list of email templates
812
+
813
+ ### Example
814
+ ```javascript
815
+ var Brevo = require('@getbrevo/brevo');
816
+ var defaultClient = Brevo.ApiClient.instance;
817
+
818
+ // Configure API key authorization: api-key
819
+ var apiKey = defaultClient.authentications['api-key'];
820
+ apiKey.apiKey = 'YOUR API KEY';
821
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
822
+ //apiKey.apiKeyPrefix = 'Token';
823
+
824
+ // Configure API key authorization: partner-key
825
+ var partnerKey = defaultClient.authentications['partner-key'];
826
+ partnerKey.apiKey = 'YOUR API KEY';
827
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
828
+ //partnerKey.apiKeyPrefix = 'Token';
829
+
830
+ var apiInstance = new Brevo.TransactionalEmailsApi();
831
+
832
+ var opts = {
833
+ 'templateStatus': true, // Boolean | Filter on the status of the template. Active = true, inactive = false
834
+ 'limit': 50, // Number | Number of documents returned per page
835
+ 'offset': 0, // Number | Index of the first document in the page
836
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
837
+ };
838
+ apiInstance.getSmtpTemplates(opts).then(function(data) {
839
+ console.log('API called successfully. Returned data: ' + data);
840
+ }, function(error) {
841
+ console.error(error);
842
+ });
843
+
844
+ ```
845
+
846
+ ### Parameters
847
+
848
+ Name | Type | Description | Notes
849
+ ------------- | ------------- | ------------- | -------------
850
+ **templateStatus** | **Boolean**| Filter on the status of the template. Active = true, inactive = false | [optional]
851
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 50]
852
+ **offset** | **Number**| Index of the first document in the page | [optional] [default to 0]
853
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
854
+
855
+ ### Return type
856
+
857
+ [**GetSmtpTemplates**](GetSmtpTemplates.md)
858
+
859
+ ### Authorization
860
+
861
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
862
+
863
+ ### HTTP request headers
864
+
865
+ - **Content-Type**: application/json
866
+ - **Accept**: application/json
867
+
868
+ <a name="getTransacBlockedContacts"></a>
869
+ # **getTransacBlockedContacts**
870
+ > GetTransacBlockedContacts getTransacBlockedContacts(opts)
871
+
872
+ Get the list of blocked or unsubscribed transactional contacts
873
+
874
+ ### Example
875
+ ```javascript
876
+ var Brevo = require('@getbrevo/brevo');
877
+ var defaultClient = Brevo.ApiClient.instance;
878
+
879
+ // Configure API key authorization: api-key
880
+ var apiKey = defaultClient.authentications['api-key'];
881
+ apiKey.apiKey = 'YOUR API KEY';
882
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
883
+ //apiKey.apiKeyPrefix = 'Token';
884
+
885
+ // Configure API key authorization: partner-key
886
+ var partnerKey = defaultClient.authentications['partner-key'];
887
+ partnerKey.apiKey = 'YOUR API KEY';
888
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
889
+ //partnerKey.apiKeyPrefix = 'Token';
890
+
891
+ var apiInstance = new Brevo.TransactionalEmailsApi();
892
+
893
+ var opts = {
894
+ 'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
895
+ 'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
896
+ 'limit': 50, // Number | Number of documents returned per page
897
+ 'offset': 0, // Number | Index of the first document on the page
898
+ 'senders': ["senders_example"], // [String] | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
899
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
900
+ };
901
+ apiInstance.getTransacBlockedContacts(opts).then(function(data) {
902
+ console.log('API called successfully. Returned data: ' + data);
903
+ }, function(error) {
904
+ console.error(error);
905
+ });
906
+
907
+ ```
908
+
909
+ ### Parameters
910
+
911
+ Name | Type | Description | Notes
912
+ ------------- | ------------- | ------------- | -------------
913
+ **startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional]
914
+ **endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional]
915
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 50]
916
+ **offset** | **Number**| Index of the first document on the page | [optional] [default to 0]
917
+ **senders** | [**[String]**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
918
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
919
+
920
+ ### Return type
921
+
922
+ [**GetTransacBlockedContacts**](GetTransacBlockedContacts.md)
923
+
924
+ ### Authorization
925
+
926
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
927
+
928
+ ### HTTP request headers
929
+
930
+ - **Content-Type**: application/json
931
+ - **Accept**: application/json
932
+
933
+ <a name="getTransacEmailContent"></a>
934
+ # **getTransacEmailContent**
935
+ > GetTransacEmailContent getTransacEmailContent(uuid)
936
+
937
+ Get the personalized content of a sent transactional email
938
+
939
+ ### Example
940
+ ```javascript
941
+ var Brevo = require('@getbrevo/brevo');
942
+ var defaultClient = Brevo.ApiClient.instance;
943
+
944
+ // Configure API key authorization: api-key
945
+ var apiKey = defaultClient.authentications['api-key'];
946
+ apiKey.apiKey = 'YOUR API KEY';
947
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
948
+ //apiKey.apiKeyPrefix = 'Token';
949
+
950
+ // Configure API key authorization: partner-key
951
+ var partnerKey = defaultClient.authentications['partner-key'];
952
+ partnerKey.apiKey = 'YOUR API KEY';
953
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
954
+ //partnerKey.apiKeyPrefix = 'Token';
955
+
956
+ var apiInstance = new Brevo.TransactionalEmailsApi();
957
+
958
+ var uuid = "uuid_example"; // String | Unique id of the transactional email that has been sent to a particular contact
959
+
960
+ apiInstance.getTransacEmailContent(uuid).then(function(data) {
961
+ console.log('API called successfully. Returned data: ' + data);
962
+ }, function(error) {
963
+ console.error(error);
964
+ });
965
+
966
+ ```
967
+
968
+ ### Parameters
969
+
970
+ Name | Type | Description | Notes
971
+ ------------- | ------------- | ------------- | -------------
972
+ **uuid** | **String**| Unique id of the transactional email that has been sent to a particular contact |
973
+
974
+ ### Return type
975
+
976
+ [**GetTransacEmailContent**](GetTransacEmailContent.md)
977
+
978
+ ### Authorization
979
+
980
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
981
+
982
+ ### HTTP request headers
983
+
984
+ - **Content-Type**: application/json
985
+ - **Accept**: application/json
986
+
987
+ <a name="getTransacEmailsList"></a>
988
+ # **getTransacEmailsList**
989
+ > GetTransacEmailsList getTransacEmailsList(opts)
990
+
991
+ Get the list of transactional emails on the basis of allowed filters
992
+
993
+ This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
994
+
995
+ ### Example
996
+ ```javascript
997
+ var Brevo = require('@getbrevo/brevo');
998
+ var defaultClient = Brevo.ApiClient.instance;
999
+
1000
+ // Configure API key authorization: api-key
1001
+ var apiKey = defaultClient.authentications['api-key'];
1002
+ apiKey.apiKey = 'YOUR API KEY';
1003
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1004
+ //apiKey.apiKeyPrefix = 'Token';
1005
+
1006
+ // Configure API key authorization: partner-key
1007
+ var partnerKey = defaultClient.authentications['partner-key'];
1008
+ partnerKey.apiKey = 'YOUR API KEY';
1009
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1010
+ //partnerKey.apiKeyPrefix = 'Token';
1011
+
1012
+ var apiInstance = new Brevo.TransactionalEmailsApi();
1013
+
1014
+ var opts = {
1015
+ 'email': "email_example", // String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
1016
+ 'templateId': 789, // Number | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
1017
+ 'messageId': "messageId_example", // String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
1018
+ 'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
1019
+ 'endDate': "endDate_example", // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
1020
+ 'sort': "desc", // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1021
+ 'limit': 500, // Number | Number of documents returned per page
1022
+ 'offset': 0 // Number | Index of the first document in the page
1023
+ };
1024
+ apiInstance.getTransacEmailsList(opts).then(function(data) {
1025
+ console.log('API called successfully. Returned data: ' + data);
1026
+ }, function(error) {
1027
+ console.error(error);
1028
+ });
1029
+
1030
+ ```
1031
+
1032
+ ### Parameters
1033
+
1034
+ Name | Type | Description | Notes
1035
+ ------------- | ------------- | ------------- | -------------
1036
+ **email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
1037
+ **templateId** | **Number**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional]
1038
+ **messageId** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
1039
+ **startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
1040
+ **endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional]
1041
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
1042
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 500]
1043
+ **offset** | **Number**| Index of the first document in the page | [optional] [default to 0]
1044
+
1045
+ ### Return type
1046
+
1047
+ [**GetTransacEmailsList**](GetTransacEmailsList.md)
1048
+
1049
+ ### Authorization
1050
+
1051
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1052
+
1053
+ ### HTTP request headers
1054
+
1055
+ - **Content-Type**: application/json
1056
+ - **Accept**: application/json
1057
+
1058
+ <a name="sendTestTemplate"></a>
1059
+ # **sendTestTemplate**
1060
+ > sendTestTemplate(templateId, sendTestEmail)
1061
+
1062
+ Send a template to your test list
1063
+
1064
+ ### Example
1065
+ ```javascript
1066
+ var Brevo = require('@getbrevo/brevo');
1067
+ var defaultClient = Brevo.ApiClient.instance;
1068
+
1069
+ // Configure API key authorization: api-key
1070
+ var apiKey = defaultClient.authentications['api-key'];
1071
+ apiKey.apiKey = 'YOUR API KEY';
1072
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1073
+ //apiKey.apiKeyPrefix = 'Token';
1074
+
1075
+ // Configure API key authorization: partner-key
1076
+ var partnerKey = defaultClient.authentications['partner-key'];
1077
+ partnerKey.apiKey = 'YOUR API KEY';
1078
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1079
+ //partnerKey.apiKeyPrefix = 'Token';
1080
+
1081
+ var apiInstance = new Brevo.TransactionalEmailsApi();
1082
+
1083
+ var templateId = 789; // Number | Id of the template
1084
+
1085
+ var sendTestEmail = new Brevo.SendTestEmail(); // SendTestEmail |
1086
+
1087
+ apiInstance.sendTestTemplate(templateId, sendTestEmail).then(function() {
1088
+ console.log('API called successfully.');
1089
+ }, function(error) {
1090
+ console.error(error);
1091
+ });
1092
+
1093
+ ```
1094
+
1095
+ ### Parameters
1096
+
1097
+ Name | Type | Description | Notes
1098
+ ------------- | ------------- | ------------- | -------------
1099
+ **templateId** | **Number**| Id of the template |
1100
+ **sendTestEmail** | [**SendTestEmail**](SendTestEmail.md)| |
1101
+
1102
+ ### Return type
1103
+
1104
+ null (empty response body)
1105
+
1106
+ ### Authorization
1107
+
1108
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1109
+
1110
+ ### HTTP request headers
1111
+
1112
+ - **Content-Type**: application/json
1113
+ - **Accept**: application/json
1114
+
1115
+ <a name="sendTransacEmail"></a>
1116
+ # **sendTransacEmail**
1117
+ > CreateSmtpEmail sendTransacEmail(sendSmtpEmail)
1118
+
1119
+ Send a transactional email
1120
+
1121
+ ### Example
1122
+ ```javascript
1123
+ var Brevo = require('@getbrevo/brevo');
1124
+ var defaultClient = Brevo.ApiClient.instance;
1125
+
1126
+ // Configure API key authorization: api-key
1127
+ var apiKey = defaultClient.authentications['api-key'];
1128
+ apiKey.apiKey = 'YOUR API KEY';
1129
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1130
+ //apiKey.apiKeyPrefix = 'Token';
1131
+
1132
+ // Configure API key authorization: partner-key
1133
+ var partnerKey = defaultClient.authentications['partner-key'];
1134
+ partnerKey.apiKey = 'YOUR API KEY';
1135
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1136
+ //partnerKey.apiKeyPrefix = 'Token';
1137
+
1138
+ var apiInstance = new Brevo.TransactionalEmailsApi();
1139
+
1140
+ var sendSmtpEmail = new Brevo.SendSmtpEmail(); // SendSmtpEmail | Values to send a transactional email
1141
+
1142
+ apiInstance.sendTransacEmail(sendSmtpEmail).then(function(data) {
1143
+ console.log('API called successfully. Returned data: ' + data);
1144
+ }, function(error) {
1145
+ console.error(error);
1146
+ });
1147
+
1148
+ ```
1149
+
1150
+ ### Parameters
1151
+
1152
+ Name | Type | Description | Notes
1153
+ ------------- | ------------- | ------------- | -------------
1154
+ **sendSmtpEmail** | [**SendSmtpEmail**](SendSmtpEmail.md)| Values to send a transactional email |
1155
+
1156
+ ### Return type
1157
+
1158
+ [**CreateSmtpEmail**](CreateSmtpEmail.md)
1159
+
1160
+ ### Authorization
1161
+
1162
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1163
+
1164
+ ### HTTP request headers
1165
+
1166
+ - **Content-Type**: application/json
1167
+ - **Accept**: application/json
1168
+
1169
+ <a name="smtpBlockedContactsEmailDelete"></a>
1170
+ # **smtpBlockedContactsEmailDelete**
1171
+ > smtpBlockedContactsEmailDelete(email)
1172
+
1173
+ Unblock or resubscribe a transactional contact
1174
+
1175
+ ### Example
1176
+ ```javascript
1177
+ var Brevo = require('@getbrevo/brevo');
1178
+ var defaultClient = Brevo.ApiClient.instance;
1179
+
1180
+ // Configure API key authorization: api-key
1181
+ var apiKey = defaultClient.authentications['api-key'];
1182
+ apiKey.apiKey = 'YOUR API KEY';
1183
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1184
+ //apiKey.apiKeyPrefix = 'Token';
1185
+
1186
+ // Configure API key authorization: partner-key
1187
+ var partnerKey = defaultClient.authentications['partner-key'];
1188
+ partnerKey.apiKey = 'YOUR API KEY';
1189
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1190
+ //partnerKey.apiKeyPrefix = 'Token';
1191
+
1192
+ var apiInstance = new Brevo.TransactionalEmailsApi();
1193
+
1194
+ var email = "email_example"; // String | contact email (urlencoded) to unblock.
1195
+
1196
+ apiInstance.smtpBlockedContactsEmailDelete(email).then(function() {
1197
+ console.log('API called successfully.');
1198
+ }, function(error) {
1199
+ console.error(error);
1200
+ });
1201
+
1202
+ ```
1203
+
1204
+ ### Parameters
1205
+
1206
+ Name | Type | Description | Notes
1207
+ ------------- | ------------- | ------------- | -------------
1208
+ **email** | **String**| contact email (urlencoded) to unblock. |
1209
+
1210
+ ### Return type
1211
+
1212
+ null (empty response body)
1213
+
1214
+ ### Authorization
1215
+
1216
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1217
+
1218
+ ### HTTP request headers
1219
+
1220
+ - **Content-Type**: application/json
1221
+ - **Accept**: application/json
1222
+
1223
+ <a name="smtpLogMessageIdDelete"></a>
1224
+ # **smtpLogMessageIdDelete**
1225
+ > smtpLogMessageIdDelete(messageId)
1226
+
1227
+ Delete an SMTP transactional log
1228
+
1229
+ ### Example
1230
+ ```javascript
1231
+ var Brevo = require('@getbrevo/brevo');
1232
+ var defaultClient = Brevo.ApiClient.instance;
1233
+
1234
+ // Configure API key authorization: api-key
1235
+ var apiKey = defaultClient.authentications['api-key'];
1236
+ apiKey.apiKey = 'YOUR API KEY';
1237
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1238
+ //apiKey.apiKeyPrefix = 'Token';
1239
+
1240
+ // Configure API key authorization: partner-key
1241
+ var partnerKey = defaultClient.authentications['partner-key'];
1242
+ partnerKey.apiKey = 'YOUR API KEY';
1243
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1244
+ //partnerKey.apiKeyPrefix = 'Token';
1245
+
1246
+ var apiInstance = new Brevo.TransactionalEmailsApi();
1247
+
1248
+ var messageId = "messageId_example"; // String | MessageId of the transactional log to delete
1249
+
1250
+ apiInstance.smtpLogMessageIdDelete(messageId).then(function() {
1251
+ console.log('API called successfully.');
1252
+ }, function(error) {
1253
+ console.error(error);
1254
+ });
1255
+
1256
+ ```
1257
+
1258
+ ### Parameters
1259
+
1260
+ Name | Type | Description | Notes
1261
+ ------------- | ------------- | ------------- | -------------
1262
+ **messageId** | **String**| MessageId of the transactional log to delete |
1263
+
1264
+ ### Return type
1265
+
1266
+ null (empty response body)
1267
+
1268
+ ### Authorization
1269
+
1270
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1271
+
1272
+ ### HTTP request headers
1273
+
1274
+ - **Content-Type**: application/json
1275
+ - **Accept**: application/json
1276
+
1277
+ <a name="updateSmtpTemplate"></a>
1278
+ # **updateSmtpTemplate**
1279
+ > updateSmtpTemplate(templateId, smtpTemplate)
1280
+
1281
+ Update an email template
1282
+
1283
+ ### Example
1284
+ ```javascript
1285
+ var Brevo = require('@getbrevo/brevo');
1286
+ var defaultClient = Brevo.ApiClient.instance;
1287
+
1288
+ // Configure API key authorization: api-key
1289
+ var apiKey = defaultClient.authentications['api-key'];
1290
+ apiKey.apiKey = 'YOUR API KEY';
1291
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1292
+ //apiKey.apiKeyPrefix = 'Token';
1293
+
1294
+ // Configure API key authorization: partner-key
1295
+ var partnerKey = defaultClient.authentications['partner-key'];
1296
+ partnerKey.apiKey = 'YOUR API KEY';
1297
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1298
+ //partnerKey.apiKeyPrefix = 'Token';
1299
+
1300
+ var apiInstance = new Brevo.TransactionalEmailsApi();
1301
+
1302
+ var templateId = 789; // Number | id of the template
1303
+
1304
+ var smtpTemplate = new Brevo.UpdateSmtpTemplate(); // UpdateSmtpTemplate | values to update in transactional email template
1305
+
1306
+ apiInstance.updateSmtpTemplate(templateId, smtpTemplate).then(function() {
1307
+ console.log('API called successfully.');
1308
+ }, function(error) {
1309
+ console.error(error);
1310
+ });
1311
+
1312
+ ```
1313
+
1314
+ ### Parameters
1315
+
1316
+ Name | Type | Description | Notes
1317
+ ------------- | ------------- | ------------- | -------------
1318
+ **templateId** | **Number**| id of the template |
1319
+ **smtpTemplate** | [**UpdateSmtpTemplate**](UpdateSmtpTemplate.md)| values to update in transactional email template |
1320
+
1321
+ ### Return type
1322
+
1323
+ null (empty response body)
1324
+
1325
+ ### Authorization
1326
+
1327
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1328
+
1329
+ ### HTTP request headers
1330
+
1331
+ - **Content-Type**: application/json
1332
+ - **Accept**: application/json
1333
+