@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,1691 @@
1
+ # Brevo.ContactsApi
2
+
3
+ All URIs are relative to *https://api.brevo.com/v3*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**addContactToList**](ContactsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
8
+ [**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
9
+ [**createContact**](ContactsApi.md#createContact) | **POST** /contacts | Create a contact
10
+ [**createDoiContact**](ContactsApi.md#createDoiContact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow
11
+ [**createFolder**](ContactsApi.md#createFolder) | **POST** /contacts/folders | Create a folder
12
+ [**createList**](ContactsApi.md#createList) | **POST** /contacts/lists | Create a list
13
+ [**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
14
+ [**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /contacts/{identifier} | Delete a contact
15
+ [**deleteFolder**](ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
16
+ [**deleteList**](ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
17
+ [**getAttributes**](ContactsApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes
18
+ [**getContactInfo**](ContactsApi.md#getContactInfo) | **GET** /contacts/{identifier} | Get a contact's details
19
+ [**getContactStats**](ContactsApi.md#getContactStats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
20
+ [**getContacts**](ContactsApi.md#getContacts) | **GET** /contacts | Get all the contacts
21
+ [**getContactsFromList**](ContactsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
22
+ [**getFolder**](ContactsApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
23
+ [**getFolderLists**](ContactsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
24
+ [**getFolders**](ContactsApi.md#getFolders) | **GET** /contacts/folders | Get all folders
25
+ [**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details
26
+ [**getLists**](ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists
27
+ [**getSegments**](ContactsApi.md#getSegments) | **GET** /contacts/segments | Get all the Segments
28
+ [**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
29
+ [**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
30
+ [**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
31
+ [**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
32
+ [**updateBatchContacts**](ContactsApi.md#updateBatchContacts) | **POST** /contacts/batch | Update multiple contacts
33
+ [**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{identifier} | Update a contact
34
+ [**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder
35
+ [**updateList**](ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
36
+
37
+
38
+ <a name="addContactToList"></a>
39
+ # **addContactToList**
40
+ > PostContactInfo addContactToList(listId, contactEmails)
41
+
42
+ Add existing contacts to a list
43
+
44
+ ### Example
45
+ ```javascript
46
+ var Brevo = require('@getbrevo/brevo');
47
+ var defaultClient = Brevo.ApiClient.instance;
48
+
49
+ // Configure API key authorization: api-key
50
+ var apiKey = defaultClient.authentications['api-key'];
51
+ apiKey.apiKey = 'YOUR API KEY';
52
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
53
+ //apiKey.apiKeyPrefix = 'Token';
54
+
55
+ // Configure API key authorization: partner-key
56
+ var partnerKey = defaultClient.authentications['partner-key'];
57
+ partnerKey.apiKey = 'YOUR API KEY';
58
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
59
+ //partnerKey.apiKeyPrefix = 'Token';
60
+
61
+ var apiInstance = new Brevo.ContactsApi();
62
+
63
+ var listId = 789; // Number | Id of the list
64
+
65
+ var contactEmails = new Brevo.AddContactToList(); // AddContactToList | Emails addresses OR IDs of the contacts
66
+
67
+ apiInstance.addContactToList(listId, contactEmails).then(function(data) {
68
+ console.log('API called successfully. Returned data: ' + data);
69
+ }, function(error) {
70
+ console.error(error);
71
+ });
72
+
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ Name | Type | Description | Notes
78
+ ------------- | ------------- | ------------- | -------------
79
+ **listId** | **Number**| Id of the list |
80
+ **contactEmails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
81
+
82
+ ### Return type
83
+
84
+ [**PostContactInfo**](PostContactInfo.md)
85
+
86
+ ### Authorization
87
+
88
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: application/json
93
+ - **Accept**: application/json
94
+
95
+ <a name="createAttribute"></a>
96
+ # **createAttribute**
97
+ > createAttribute(attributeCategory, attributeName, createAttribute)
98
+
99
+ Create contact attribute
100
+
101
+ ### Example
102
+ ```javascript
103
+ var Brevo = require('@getbrevo/brevo');
104
+ var defaultClient = Brevo.ApiClient.instance;
105
+
106
+ // Configure API key authorization: api-key
107
+ var apiKey = defaultClient.authentications['api-key'];
108
+ apiKey.apiKey = 'YOUR API KEY';
109
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
110
+ //apiKey.apiKeyPrefix = 'Token';
111
+
112
+ // Configure API key authorization: partner-key
113
+ var partnerKey = defaultClient.authentications['partner-key'];
114
+ partnerKey.apiKey = 'YOUR API KEY';
115
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
116
+ //partnerKey.apiKeyPrefix = 'Token';
117
+
118
+ var apiInstance = new Brevo.ContactsApi();
119
+
120
+ var attributeCategory = "attributeCategory_example"; // String | Category of the attribute
121
+
122
+ var attributeName = "attributeName_example"; // String | Name of the attribute
123
+
124
+ var createAttribute = new Brevo.CreateAttribute(); // CreateAttribute | Values to create an attribute
125
+
126
+ apiInstance.createAttribute(attributeCategory, attributeName, createAttribute).then(function() {
127
+ console.log('API called successfully.');
128
+ }, function(error) {
129
+ console.error(error);
130
+ });
131
+
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ Name | Type | Description | Notes
137
+ ------------- | ------------- | ------------- | -------------
138
+ **attributeCategory** | **String**| Category of the attribute |
139
+ **attributeName** | **String**| Name of the attribute |
140
+ **createAttribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
141
+
142
+ ### Return type
143
+
144
+ null (empty response body)
145
+
146
+ ### Authorization
147
+
148
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+ <a name="createContact"></a>
156
+ # **createContact**
157
+ > CreateUpdateContactModel createContact(createContact)
158
+
159
+ Create a contact
160
+
161
+ ### Example
162
+ ```javascript
163
+ var Brevo = require('@getbrevo/brevo');
164
+ var defaultClient = Brevo.ApiClient.instance;
165
+
166
+ // Configure API key authorization: api-key
167
+ var apiKey = defaultClient.authentications['api-key'];
168
+ apiKey.apiKey = 'YOUR API KEY';
169
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
170
+ //apiKey.apiKeyPrefix = 'Token';
171
+
172
+ // Configure API key authorization: partner-key
173
+ var partnerKey = defaultClient.authentications['partner-key'];
174
+ partnerKey.apiKey = 'YOUR API KEY';
175
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
176
+ //partnerKey.apiKeyPrefix = 'Token';
177
+
178
+ var apiInstance = new Brevo.ContactsApi();
179
+
180
+ var createContact = new Brevo.CreateContact(); // CreateContact | Values to create a contact
181
+
182
+ apiInstance.createContact(createContact).then(function(data) {
183
+ console.log('API called successfully. Returned data: ' + data);
184
+ }, function(error) {
185
+ console.error(error);
186
+ });
187
+
188
+ ```
189
+
190
+ ### Parameters
191
+
192
+ Name | Type | Description | Notes
193
+ ------------- | ------------- | ------------- | -------------
194
+ **createContact** | [**CreateContact**](CreateContact.md)| Values to create a contact |
195
+
196
+ ### Return type
197
+
198
+ [**CreateUpdateContactModel**](CreateUpdateContactModel.md)
199
+
200
+ ### Authorization
201
+
202
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
203
+
204
+ ### HTTP request headers
205
+
206
+ - **Content-Type**: application/json
207
+ - **Accept**: application/json
208
+
209
+ <a name="createDoiContact"></a>
210
+ # **createDoiContact**
211
+ > createDoiContact(createDoiContact)
212
+
213
+ Create Contact via DOI (Double-Opt-In) Flow
214
+
215
+ ### Example
216
+ ```javascript
217
+ var Brevo = require('@getbrevo/brevo');
218
+ var defaultClient = Brevo.ApiClient.instance;
219
+
220
+ // Configure API key authorization: api-key
221
+ var apiKey = defaultClient.authentications['api-key'];
222
+ apiKey.apiKey = 'YOUR API KEY';
223
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
224
+ //apiKey.apiKeyPrefix = 'Token';
225
+
226
+ // Configure API key authorization: partner-key
227
+ var partnerKey = defaultClient.authentications['partner-key'];
228
+ partnerKey.apiKey = 'YOUR API KEY';
229
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
230
+ //partnerKey.apiKeyPrefix = 'Token';
231
+
232
+ var apiInstance = new Brevo.ContactsApi();
233
+
234
+ var createDoiContact = new Brevo.CreateDoiContact(); // CreateDoiContact | Values to create the Double opt-in (DOI) contact
235
+
236
+ apiInstance.createDoiContact(createDoiContact).then(function() {
237
+ console.log('API called successfully.');
238
+ }, function(error) {
239
+ console.error(error);
240
+ });
241
+
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ Name | Type | Description | Notes
247
+ ------------- | ------------- | ------------- | -------------
248
+ **createDoiContact** | [**CreateDoiContact**](CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact |
249
+
250
+ ### Return type
251
+
252
+ null (empty response body)
253
+
254
+ ### Authorization
255
+
256
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
257
+
258
+ ### HTTP request headers
259
+
260
+ - **Content-Type**: application/json
261
+ - **Accept**: application/json
262
+
263
+ <a name="createFolder"></a>
264
+ # **createFolder**
265
+ > CreateModel createFolder(createFolder)
266
+
267
+ Create a folder
268
+
269
+ ### Example
270
+ ```javascript
271
+ var Brevo = require('@getbrevo/brevo');
272
+ var defaultClient = Brevo.ApiClient.instance;
273
+
274
+ // Configure API key authorization: api-key
275
+ var apiKey = defaultClient.authentications['api-key'];
276
+ apiKey.apiKey = 'YOUR API KEY';
277
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
278
+ //apiKey.apiKeyPrefix = 'Token';
279
+
280
+ // Configure API key authorization: partner-key
281
+ var partnerKey = defaultClient.authentications['partner-key'];
282
+ partnerKey.apiKey = 'YOUR API KEY';
283
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
284
+ //partnerKey.apiKeyPrefix = 'Token';
285
+
286
+ var apiInstance = new Brevo.ContactsApi();
287
+
288
+ var createFolder = new Brevo.CreateUpdateFolder(); // CreateUpdateFolder | Name of the folder
289
+
290
+ apiInstance.createFolder(createFolder).then(function(data) {
291
+ console.log('API called successfully. Returned data: ' + data);
292
+ }, function(error) {
293
+ console.error(error);
294
+ });
295
+
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+ Name | Type | Description | Notes
301
+ ------------- | ------------- | ------------- | -------------
302
+ **createFolder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
303
+
304
+ ### Return type
305
+
306
+ [**CreateModel**](CreateModel.md)
307
+
308
+ ### Authorization
309
+
310
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
311
+
312
+ ### HTTP request headers
313
+
314
+ - **Content-Type**: application/json
315
+ - **Accept**: application/json
316
+
317
+ <a name="createList"></a>
318
+ # **createList**
319
+ > CreateModel createList(createList)
320
+
321
+ Create a list
322
+
323
+ ### Example
324
+ ```javascript
325
+ var Brevo = require('@getbrevo/brevo');
326
+ var defaultClient = Brevo.ApiClient.instance;
327
+
328
+ // Configure API key authorization: api-key
329
+ var apiKey = defaultClient.authentications['api-key'];
330
+ apiKey.apiKey = 'YOUR API KEY';
331
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
332
+ //apiKey.apiKeyPrefix = 'Token';
333
+
334
+ // Configure API key authorization: partner-key
335
+ var partnerKey = defaultClient.authentications['partner-key'];
336
+ partnerKey.apiKey = 'YOUR API KEY';
337
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
338
+ //partnerKey.apiKeyPrefix = 'Token';
339
+
340
+ var apiInstance = new Brevo.ContactsApi();
341
+
342
+ var createList = new Brevo.CreateList(); // CreateList | Values to create a list
343
+
344
+ apiInstance.createList(createList).then(function(data) {
345
+ console.log('API called successfully. Returned data: ' + data);
346
+ }, function(error) {
347
+ console.error(error);
348
+ });
349
+
350
+ ```
351
+
352
+ ### Parameters
353
+
354
+ Name | Type | Description | Notes
355
+ ------------- | ------------- | ------------- | -------------
356
+ **createList** | [**CreateList**](CreateList.md)| Values to create a list |
357
+
358
+ ### Return type
359
+
360
+ [**CreateModel**](CreateModel.md)
361
+
362
+ ### Authorization
363
+
364
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
365
+
366
+ ### HTTP request headers
367
+
368
+ - **Content-Type**: application/json
369
+ - **Accept**: application/json
370
+
371
+ <a name="deleteAttribute"></a>
372
+ # **deleteAttribute**
373
+ > deleteAttribute(attributeCategory, attributeName)
374
+
375
+ Delete an attribute
376
+
377
+ ### Example
378
+ ```javascript
379
+ var Brevo = require('@getbrevo/brevo');
380
+ var defaultClient = Brevo.ApiClient.instance;
381
+
382
+ // Configure API key authorization: api-key
383
+ var apiKey = defaultClient.authentications['api-key'];
384
+ apiKey.apiKey = 'YOUR API KEY';
385
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
386
+ //apiKey.apiKeyPrefix = 'Token';
387
+
388
+ // Configure API key authorization: partner-key
389
+ var partnerKey = defaultClient.authentications['partner-key'];
390
+ partnerKey.apiKey = 'YOUR API KEY';
391
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
392
+ //partnerKey.apiKeyPrefix = 'Token';
393
+
394
+ var apiInstance = new Brevo.ContactsApi();
395
+
396
+ var attributeCategory = "attributeCategory_example"; // String | Category of the attribute
397
+
398
+ var attributeName = "attributeName_example"; // String | Name of the existing attribute
399
+
400
+ apiInstance.deleteAttribute(attributeCategory, attributeName).then(function() {
401
+ console.log('API called successfully.');
402
+ }, function(error) {
403
+ console.error(error);
404
+ });
405
+
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+ Name | Type | Description | Notes
411
+ ------------- | ------------- | ------------- | -------------
412
+ **attributeCategory** | **String**| Category of the attribute |
413
+ **attributeName** | **String**| Name of the existing attribute |
414
+
415
+ ### Return type
416
+
417
+ null (empty response body)
418
+
419
+ ### Authorization
420
+
421
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
422
+
423
+ ### HTTP request headers
424
+
425
+ - **Content-Type**: application/json
426
+ - **Accept**: application/json
427
+
428
+ <a name="deleteContact"></a>
429
+ # **deleteContact**
430
+ > deleteContact(identifier)
431
+
432
+ Delete a contact
433
+
434
+ ### Example
435
+ ```javascript
436
+ var Brevo = require('@getbrevo/brevo');
437
+ var defaultClient = Brevo.ApiClient.instance;
438
+
439
+ // Configure API key authorization: api-key
440
+ var apiKey = defaultClient.authentications['api-key'];
441
+ apiKey.apiKey = 'YOUR API KEY';
442
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
443
+ //apiKey.apiKeyPrefix = 'Token';
444
+
445
+ // Configure API key authorization: partner-key
446
+ var partnerKey = defaultClient.authentications['partner-key'];
447
+ partnerKey.apiKey = 'YOUR API KEY';
448
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
449
+ //partnerKey.apiKeyPrefix = 'Token';
450
+
451
+ var apiInstance = new Brevo.ContactsApi();
452
+
453
+ var identifier = "identifier_example"; // String | Email (urlencoded) OR ID of the contact
454
+
455
+ apiInstance.deleteContact(identifier).then(function() {
456
+ console.log('API called successfully.');
457
+ }, function(error) {
458
+ console.error(error);
459
+ });
460
+
461
+ ```
462
+
463
+ ### Parameters
464
+
465
+ Name | Type | Description | Notes
466
+ ------------- | ------------- | ------------- | -------------
467
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
468
+
469
+ ### Return type
470
+
471
+ null (empty response body)
472
+
473
+ ### Authorization
474
+
475
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
476
+
477
+ ### HTTP request headers
478
+
479
+ - **Content-Type**: application/json
480
+ - **Accept**: application/json
481
+
482
+ <a name="deleteFolder"></a>
483
+ # **deleteFolder**
484
+ > deleteFolder(folderId)
485
+
486
+ Delete a folder (and all its lists)
487
+
488
+ ### Example
489
+ ```javascript
490
+ var Brevo = require('@getbrevo/brevo');
491
+ var defaultClient = Brevo.ApiClient.instance;
492
+
493
+ // Configure API key authorization: api-key
494
+ var apiKey = defaultClient.authentications['api-key'];
495
+ apiKey.apiKey = 'YOUR API KEY';
496
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
497
+ //apiKey.apiKeyPrefix = 'Token';
498
+
499
+ // Configure API key authorization: partner-key
500
+ var partnerKey = defaultClient.authentications['partner-key'];
501
+ partnerKey.apiKey = 'YOUR API KEY';
502
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
503
+ //partnerKey.apiKeyPrefix = 'Token';
504
+
505
+ var apiInstance = new Brevo.ContactsApi();
506
+
507
+ var folderId = 789; // Number | Id of the folder
508
+
509
+ apiInstance.deleteFolder(folderId).then(function() {
510
+ console.log('API called successfully.');
511
+ }, function(error) {
512
+ console.error(error);
513
+ });
514
+
515
+ ```
516
+
517
+ ### Parameters
518
+
519
+ Name | Type | Description | Notes
520
+ ------------- | ------------- | ------------- | -------------
521
+ **folderId** | **Number**| Id of the folder |
522
+
523
+ ### Return type
524
+
525
+ null (empty response body)
526
+
527
+ ### Authorization
528
+
529
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: application/json
534
+ - **Accept**: application/json
535
+
536
+ <a name="deleteList"></a>
537
+ # **deleteList**
538
+ > deleteList(listId)
539
+
540
+ Delete a list
541
+
542
+ ### Example
543
+ ```javascript
544
+ var Brevo = require('@getbrevo/brevo');
545
+ var defaultClient = Brevo.ApiClient.instance;
546
+
547
+ // Configure API key authorization: api-key
548
+ var apiKey = defaultClient.authentications['api-key'];
549
+ apiKey.apiKey = 'YOUR API KEY';
550
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
551
+ //apiKey.apiKeyPrefix = 'Token';
552
+
553
+ // Configure API key authorization: partner-key
554
+ var partnerKey = defaultClient.authentications['partner-key'];
555
+ partnerKey.apiKey = 'YOUR API KEY';
556
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
557
+ //partnerKey.apiKeyPrefix = 'Token';
558
+
559
+ var apiInstance = new Brevo.ContactsApi();
560
+
561
+ var listId = 789; // Number | Id of the list
562
+
563
+ apiInstance.deleteList(listId).then(function() {
564
+ console.log('API called successfully.');
565
+ }, function(error) {
566
+ console.error(error);
567
+ });
568
+
569
+ ```
570
+
571
+ ### Parameters
572
+
573
+ Name | Type | Description | Notes
574
+ ------------- | ------------- | ------------- | -------------
575
+ **listId** | **Number**| Id of the list |
576
+
577
+ ### Return type
578
+
579
+ null (empty response body)
580
+
581
+ ### Authorization
582
+
583
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
584
+
585
+ ### HTTP request headers
586
+
587
+ - **Content-Type**: application/json
588
+ - **Accept**: application/json
589
+
590
+ <a name="getAttributes"></a>
591
+ # **getAttributes**
592
+ > GetAttributes getAttributes()
593
+
594
+ List all attributes
595
+
596
+ ### Example
597
+ ```javascript
598
+ var Brevo = require('@getbrevo/brevo');
599
+ var defaultClient = Brevo.ApiClient.instance;
600
+
601
+ // Configure API key authorization: api-key
602
+ var apiKey = defaultClient.authentications['api-key'];
603
+ apiKey.apiKey = 'YOUR API KEY';
604
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
605
+ //apiKey.apiKeyPrefix = 'Token';
606
+
607
+ // Configure API key authorization: partner-key
608
+ var partnerKey = defaultClient.authentications['partner-key'];
609
+ partnerKey.apiKey = 'YOUR API KEY';
610
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
611
+ //partnerKey.apiKeyPrefix = 'Token';
612
+
613
+ var apiInstance = new Brevo.ContactsApi();
614
+ apiInstance.getAttributes().then(function(data) {
615
+ console.log('API called successfully. Returned data: ' + data);
616
+ }, function(error) {
617
+ console.error(error);
618
+ });
619
+
620
+ ```
621
+
622
+ ### Parameters
623
+ This endpoint does not need any parameter.
624
+
625
+ ### Return type
626
+
627
+ [**GetAttributes**](GetAttributes.md)
628
+
629
+ ### Authorization
630
+
631
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
632
+
633
+ ### HTTP request headers
634
+
635
+ - **Content-Type**: application/json
636
+ - **Accept**: application/json
637
+
638
+ <a name="getContactInfo"></a>
639
+ # **getContactInfo**
640
+ > GetExtendedContactDetails getContactInfo(identifier, opts)
641
+
642
+ Get a contact's details
643
+
644
+ Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.brevo.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
645
+
646
+ ### Example
647
+ ```javascript
648
+ var Brevo = require('@getbrevo/brevo');
649
+ var defaultClient = Brevo.ApiClient.instance;
650
+
651
+ // Configure API key authorization: api-key
652
+ var apiKey = defaultClient.authentications['api-key'];
653
+ apiKey.apiKey = 'YOUR API KEY';
654
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
655
+ //apiKey.apiKeyPrefix = 'Token';
656
+
657
+ // Configure API key authorization: partner-key
658
+ var partnerKey = defaultClient.authentications['partner-key'];
659
+ partnerKey.apiKey = 'YOUR API KEY';
660
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
661
+ //partnerKey.apiKeyPrefix = 'Token';
662
+
663
+ var apiInstance = new Brevo.ContactsApi();
664
+
665
+ var identifier = "identifier_example"; // String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
666
+
667
+ var opts = {
668
+ 'startDate': "startDate_example", // String | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
669
+ 'endDate': "endDate_example" // String | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.
670
+ };
671
+ apiInstance.getContactInfo(identifier, opts).then(function(data) {
672
+ console.log('API called successfully. Returned data: ' + data);
673
+ }, function(error) {
674
+ console.error(error);
675
+ });
676
+
677
+ ```
678
+
679
+ ### Parameters
680
+
681
+ Name | Type | Description | Notes
682
+ ------------- | ------------- | ------------- | -------------
683
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
684
+ **startDate** | **String**| **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
685
+ **endDate** | **String**| **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. | [optional]
686
+
687
+ ### Return type
688
+
689
+ [**GetExtendedContactDetails**](GetExtendedContactDetails.md)
690
+
691
+ ### Authorization
692
+
693
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
694
+
695
+ ### HTTP request headers
696
+
697
+ - **Content-Type**: application/json
698
+ - **Accept**: application/json
699
+
700
+ <a name="getContactStats"></a>
701
+ # **getContactStats**
702
+ > GetContactCampaignStats getContactStats(identifier, opts)
703
+
704
+ Get email campaigns' statistics for a contact
705
+
706
+ ### Example
707
+ ```javascript
708
+ var Brevo = require('@getbrevo/brevo');
709
+ var defaultClient = Brevo.ApiClient.instance;
710
+
711
+ // Configure API key authorization: api-key
712
+ var apiKey = defaultClient.authentications['api-key'];
713
+ apiKey.apiKey = 'YOUR API KEY';
714
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
715
+ //apiKey.apiKeyPrefix = 'Token';
716
+
717
+ // Configure API key authorization: partner-key
718
+ var partnerKey = defaultClient.authentications['partner-key'];
719
+ partnerKey.apiKey = 'YOUR API KEY';
720
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
721
+ //partnerKey.apiKeyPrefix = 'Token';
722
+
723
+ var apiInstance = new Brevo.ContactsApi();
724
+
725
+ var identifier = "identifier_example"; // String | Email (urlencoded) OR ID of the contact
726
+
727
+ var opts = {
728
+ 'startDate': "startDate_example", // String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
729
+ 'endDate': "endDate_example" // String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
730
+ };
731
+ apiInstance.getContactStats(identifier, opts).then(function(data) {
732
+ console.log('API called successfully. Returned data: ' + data);
733
+ }, function(error) {
734
+ console.error(error);
735
+ });
736
+
737
+ ```
738
+
739
+ ### Parameters
740
+
741
+ Name | Type | Description | Notes
742
+ ------------- | ------------- | ------------- | -------------
743
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
744
+ **startDate** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
745
+ **endDate** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional]
746
+
747
+ ### Return type
748
+
749
+ [**GetContactCampaignStats**](GetContactCampaignStats.md)
750
+
751
+ ### Authorization
752
+
753
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
754
+
755
+ ### HTTP request headers
756
+
757
+ - **Content-Type**: application/json
758
+ - **Accept**: application/json
759
+
760
+ <a name="getContacts"></a>
761
+ # **getContacts**
762
+ > GetContacts getContacts(opts)
763
+
764
+ Get all the contacts
765
+
766
+ ### Example
767
+ ```javascript
768
+ var Brevo = require('@getbrevo/brevo');
769
+ var defaultClient = Brevo.ApiClient.instance;
770
+
771
+ // Configure API key authorization: api-key
772
+ var apiKey = defaultClient.authentications['api-key'];
773
+ apiKey.apiKey = 'YOUR API KEY';
774
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
775
+ //apiKey.apiKeyPrefix = 'Token';
776
+
777
+ // Configure API key authorization: partner-key
778
+ var partnerKey = defaultClient.authentications['partner-key'];
779
+ partnerKey.apiKey = 'YOUR API KEY';
780
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
781
+ //partnerKey.apiKeyPrefix = 'Token';
782
+
783
+ var apiInstance = new Brevo.ContactsApi();
784
+
785
+ var opts = {
786
+ 'limit': 50, // Number | Number of documents per page
787
+ 'offset': 0, // Number | Index of the first document of the page
788
+ 'modifiedSince': "modifiedSince_example", // String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
789
+ 'createdSince': "createdSince_example", // String | Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
790
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
791
+ };
792
+ apiInstance.getContacts(opts).then(function(data) {
793
+ console.log('API called successfully. Returned data: ' + data);
794
+ }, function(error) {
795
+ console.error(error);
796
+ });
797
+
798
+ ```
799
+
800
+ ### Parameters
801
+
802
+ Name | Type | Description | Notes
803
+ ------------- | ------------- | ------------- | -------------
804
+ **limit** | **Number**| Number of documents per page | [optional] [default to 50]
805
+ **offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
806
+ **modifiedSince** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
807
+ **createdSince** | **String**| Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
808
+ **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]
809
+
810
+ ### Return type
811
+
812
+ [**GetContacts**](GetContacts.md)
813
+
814
+ ### Authorization
815
+
816
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
817
+
818
+ ### HTTP request headers
819
+
820
+ - **Content-Type**: application/json
821
+ - **Accept**: application/json
822
+
823
+ <a name="getContactsFromList"></a>
824
+ # **getContactsFromList**
825
+ > GetContacts getContactsFromList(listId, opts)
826
+
827
+ Get contacts in a list
828
+
829
+ ### Example
830
+ ```javascript
831
+ var Brevo = require('@getbrevo/brevo');
832
+ var defaultClient = Brevo.ApiClient.instance;
833
+
834
+ // Configure API key authorization: api-key
835
+ var apiKey = defaultClient.authentications['api-key'];
836
+ apiKey.apiKey = 'YOUR API KEY';
837
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
838
+ //apiKey.apiKeyPrefix = 'Token';
839
+
840
+ // Configure API key authorization: partner-key
841
+ var partnerKey = defaultClient.authentications['partner-key'];
842
+ partnerKey.apiKey = 'YOUR API KEY';
843
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
844
+ //partnerKey.apiKeyPrefix = 'Token';
845
+
846
+ var apiInstance = new Brevo.ContactsApi();
847
+
848
+ var listId = 789; // Number | Id of the list
849
+
850
+ var opts = {
851
+ 'modifiedSince': "modifiedSince_example", // String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
852
+ 'limit': 50, // Number | Number of documents per page
853
+ 'offset': 0, // Number | Index of the first document of the page
854
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
855
+ };
856
+ apiInstance.getContactsFromList(listId, opts).then(function(data) {
857
+ console.log('API called successfully. Returned data: ' + data);
858
+ }, function(error) {
859
+ console.error(error);
860
+ });
861
+
862
+ ```
863
+
864
+ ### Parameters
865
+
866
+ Name | Type | Description | Notes
867
+ ------------- | ------------- | ------------- | -------------
868
+ **listId** | **Number**| Id of the list |
869
+ **modifiedSince** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
870
+ **limit** | **Number**| Number of documents per page | [optional] [default to 50]
871
+ **offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
872
+ **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]
873
+
874
+ ### Return type
875
+
876
+ [**GetContacts**](GetContacts.md)
877
+
878
+ ### Authorization
879
+
880
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
881
+
882
+ ### HTTP request headers
883
+
884
+ - **Content-Type**: application/json
885
+ - **Accept**: application/json
886
+
887
+ <a name="getFolder"></a>
888
+ # **getFolder**
889
+ > GetFolder getFolder(folderId)
890
+
891
+ Returns a folder's details
892
+
893
+ ### Example
894
+ ```javascript
895
+ var Brevo = require('@getbrevo/brevo');
896
+ var defaultClient = Brevo.ApiClient.instance;
897
+
898
+ // Configure API key authorization: api-key
899
+ var apiKey = defaultClient.authentications['api-key'];
900
+ apiKey.apiKey = 'YOUR API KEY';
901
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
902
+ //apiKey.apiKeyPrefix = 'Token';
903
+
904
+ // Configure API key authorization: partner-key
905
+ var partnerKey = defaultClient.authentications['partner-key'];
906
+ partnerKey.apiKey = 'YOUR API KEY';
907
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
908
+ //partnerKey.apiKeyPrefix = 'Token';
909
+
910
+ var apiInstance = new Brevo.ContactsApi();
911
+
912
+ var folderId = 789; // Number | id of the folder
913
+
914
+ apiInstance.getFolder(folderId).then(function(data) {
915
+ console.log('API called successfully. Returned data: ' + data);
916
+ }, function(error) {
917
+ console.error(error);
918
+ });
919
+
920
+ ```
921
+
922
+ ### Parameters
923
+
924
+ Name | Type | Description | Notes
925
+ ------------- | ------------- | ------------- | -------------
926
+ **folderId** | **Number**| id of the folder |
927
+
928
+ ### Return type
929
+
930
+ [**GetFolder**](GetFolder.md)
931
+
932
+ ### Authorization
933
+
934
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
935
+
936
+ ### HTTP request headers
937
+
938
+ - **Content-Type**: application/json
939
+ - **Accept**: application/json
940
+
941
+ <a name="getFolderLists"></a>
942
+ # **getFolderLists**
943
+ > GetFolderLists getFolderLists(folderId, opts)
944
+
945
+ Get lists in a folder
946
+
947
+ ### Example
948
+ ```javascript
949
+ var Brevo = require('@getbrevo/brevo');
950
+ var defaultClient = Brevo.ApiClient.instance;
951
+
952
+ // Configure API key authorization: api-key
953
+ var apiKey = defaultClient.authentications['api-key'];
954
+ apiKey.apiKey = 'YOUR API KEY';
955
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
956
+ //apiKey.apiKeyPrefix = 'Token';
957
+
958
+ // Configure API key authorization: partner-key
959
+ var partnerKey = defaultClient.authentications['partner-key'];
960
+ partnerKey.apiKey = 'YOUR API KEY';
961
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
962
+ //partnerKey.apiKeyPrefix = 'Token';
963
+
964
+ var apiInstance = new Brevo.ContactsApi();
965
+
966
+ var folderId = 789; // Number | Id of the folder
967
+
968
+ var opts = {
969
+ 'limit': 10, // Number | Number of documents per page
970
+ 'offset': 0, // Number | Index of the first document of the page
971
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
972
+ };
973
+ apiInstance.getFolderLists(folderId, opts).then(function(data) {
974
+ console.log('API called successfully. Returned data: ' + data);
975
+ }, function(error) {
976
+ console.error(error);
977
+ });
978
+
979
+ ```
980
+
981
+ ### Parameters
982
+
983
+ Name | Type | Description | Notes
984
+ ------------- | ------------- | ------------- | -------------
985
+ **folderId** | **Number**| Id of the folder |
986
+ **limit** | **Number**| Number of documents per page | [optional] [default to 10]
987
+ **offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
988
+ **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]
989
+
990
+ ### Return type
991
+
992
+ [**GetFolderLists**](GetFolderLists.md)
993
+
994
+ ### Authorization
995
+
996
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
997
+
998
+ ### HTTP request headers
999
+
1000
+ - **Content-Type**: application/json
1001
+ - **Accept**: application/json
1002
+
1003
+ <a name="getFolders"></a>
1004
+ # **getFolders**
1005
+ > GetFolders getFolders(limit, offset, opts)
1006
+
1007
+ Get all folders
1008
+
1009
+ ### Example
1010
+ ```javascript
1011
+ var Brevo = require('@getbrevo/brevo');
1012
+ var defaultClient = Brevo.ApiClient.instance;
1013
+
1014
+ // Configure API key authorization: api-key
1015
+ var apiKey = defaultClient.authentications['api-key'];
1016
+ apiKey.apiKey = 'YOUR API KEY';
1017
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1018
+ //apiKey.apiKeyPrefix = 'Token';
1019
+
1020
+ // Configure API key authorization: partner-key
1021
+ var partnerKey = defaultClient.authentications['partner-key'];
1022
+ partnerKey.apiKey = 'YOUR API KEY';
1023
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1024
+ //partnerKey.apiKeyPrefix = 'Token';
1025
+
1026
+ var apiInstance = new Brevo.ContactsApi();
1027
+
1028
+ var limit = 10; // Number | Number of documents per page
1029
+
1030
+ var offset = 0; // Number | Index of the first document of the page
1031
+
1032
+ var opts = {
1033
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1034
+ };
1035
+ apiInstance.getFolders(limit, offset, opts).then(function(data) {
1036
+ console.log('API called successfully. Returned data: ' + data);
1037
+ }, function(error) {
1038
+ console.error(error);
1039
+ });
1040
+
1041
+ ```
1042
+
1043
+ ### Parameters
1044
+
1045
+ Name | Type | Description | Notes
1046
+ ------------- | ------------- | ------------- | -------------
1047
+ **limit** | **Number**| Number of documents per page | [default to 10]
1048
+ **offset** | **Number**| Index of the first document of the page | [default to 0]
1049
+ **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]
1050
+
1051
+ ### Return type
1052
+
1053
+ [**GetFolders**](GetFolders.md)
1054
+
1055
+ ### Authorization
1056
+
1057
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1058
+
1059
+ ### HTTP request headers
1060
+
1061
+ - **Content-Type**: application/json
1062
+ - **Accept**: application/json
1063
+
1064
+ <a name="getList"></a>
1065
+ # **getList**
1066
+ > GetExtendedList getList(listId)
1067
+
1068
+ Get a list's details
1069
+
1070
+ ### Example
1071
+ ```javascript
1072
+ var Brevo = require('@getbrevo/brevo');
1073
+ var defaultClient = Brevo.ApiClient.instance;
1074
+
1075
+ // Configure API key authorization: api-key
1076
+ var apiKey = defaultClient.authentications['api-key'];
1077
+ apiKey.apiKey = 'YOUR API KEY';
1078
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1079
+ //apiKey.apiKeyPrefix = 'Token';
1080
+
1081
+ // Configure API key authorization: partner-key
1082
+ var partnerKey = defaultClient.authentications['partner-key'];
1083
+ partnerKey.apiKey = 'YOUR API KEY';
1084
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1085
+ //partnerKey.apiKeyPrefix = 'Token';
1086
+
1087
+ var apiInstance = new Brevo.ContactsApi();
1088
+
1089
+ var listId = 789; // Number | Id of the list
1090
+
1091
+ apiInstance.getList(listId).then(function(data) {
1092
+ console.log('API called successfully. Returned data: ' + data);
1093
+ }, function(error) {
1094
+ console.error(error);
1095
+ });
1096
+
1097
+ ```
1098
+
1099
+ ### Parameters
1100
+
1101
+ Name | Type | Description | Notes
1102
+ ------------- | ------------- | ------------- | -------------
1103
+ **listId** | **Number**| Id of the list |
1104
+
1105
+ ### Return type
1106
+
1107
+ [**GetExtendedList**](GetExtendedList.md)
1108
+
1109
+ ### Authorization
1110
+
1111
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1112
+
1113
+ ### HTTP request headers
1114
+
1115
+ - **Content-Type**: application/json
1116
+ - **Accept**: application/json
1117
+
1118
+ <a name="getLists"></a>
1119
+ # **getLists**
1120
+ > GetLists getLists(opts)
1121
+
1122
+ Get all the lists
1123
+
1124
+ ### Example
1125
+ ```javascript
1126
+ var Brevo = require('@getbrevo/brevo');
1127
+ var defaultClient = Brevo.ApiClient.instance;
1128
+
1129
+ // Configure API key authorization: api-key
1130
+ var apiKey = defaultClient.authentications['api-key'];
1131
+ apiKey.apiKey = 'YOUR API KEY';
1132
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1133
+ //apiKey.apiKeyPrefix = 'Token';
1134
+
1135
+ // Configure API key authorization: partner-key
1136
+ var partnerKey = defaultClient.authentications['partner-key'];
1137
+ partnerKey.apiKey = 'YOUR API KEY';
1138
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1139
+ //partnerKey.apiKeyPrefix = 'Token';
1140
+
1141
+ var apiInstance = new Brevo.ContactsApi();
1142
+
1143
+ var opts = {
1144
+ 'limit': 10, // Number | Number of documents per page
1145
+ 'offset': 0, // Number | Index of the first document of the page
1146
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1147
+ };
1148
+ apiInstance.getLists(opts).then(function(data) {
1149
+ console.log('API called successfully. Returned data: ' + data);
1150
+ }, function(error) {
1151
+ console.error(error);
1152
+ });
1153
+
1154
+ ```
1155
+
1156
+ ### Parameters
1157
+
1158
+ Name | Type | Description | Notes
1159
+ ------------- | ------------- | ------------- | -------------
1160
+ **limit** | **Number**| Number of documents per page | [optional] [default to 10]
1161
+ **offset** | **Number**| Index of the first document of the page | [optional] [default to 0]
1162
+ **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]
1163
+
1164
+ ### Return type
1165
+
1166
+ [**GetLists**](GetLists.md)
1167
+
1168
+ ### Authorization
1169
+
1170
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1171
+
1172
+ ### HTTP request headers
1173
+
1174
+ - **Content-Type**: application/json
1175
+ - **Accept**: application/json
1176
+
1177
+ <a name="getSegments"></a>
1178
+ # **getSegments**
1179
+ > GetSegments getSegments(limit, offset, opts)
1180
+
1181
+ Get all the Segments
1182
+
1183
+ ### Example
1184
+ ```javascript
1185
+ var Brevo = require('@getbrevo/brevo');
1186
+ var defaultClient = Brevo.ApiClient.instance;
1187
+
1188
+ // Configure API key authorization: api-key
1189
+ var apiKey = defaultClient.authentications['api-key'];
1190
+ apiKey.apiKey = 'YOUR API KEY';
1191
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1192
+ //apiKey.apiKeyPrefix = 'Token';
1193
+
1194
+ // Configure API key authorization: partner-key
1195
+ var partnerKey = defaultClient.authentications['partner-key'];
1196
+ partnerKey.apiKey = 'YOUR API KEY';
1197
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1198
+ //partnerKey.apiKeyPrefix = 'Token';
1199
+
1200
+ var apiInstance = new Brevo.ContactsApi();
1201
+
1202
+ var limit = 10; // Number | Number of documents per page
1203
+
1204
+ var offset = 0; // Number | Index of the first document of the page
1205
+
1206
+ var opts = {
1207
+ 'sort': "desc" // String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
1208
+ };
1209
+ apiInstance.getSegments(limit, offset, opts).then(function(data) {
1210
+ console.log('API called successfully. Returned data: ' + data);
1211
+ }, function(error) {
1212
+ console.error(error);
1213
+ });
1214
+
1215
+ ```
1216
+
1217
+ ### Parameters
1218
+
1219
+ Name | Type | Description | Notes
1220
+ ------------- | ------------- | ------------- | -------------
1221
+ **limit** | **Number**| Number of documents per page | [default to 10]
1222
+ **offset** | **Number**| Index of the first document of the page | [default to 0]
1223
+ **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]
1224
+
1225
+ ### Return type
1226
+
1227
+ [**GetSegments**](GetSegments.md)
1228
+
1229
+ ### Authorization
1230
+
1231
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1232
+
1233
+ ### HTTP request headers
1234
+
1235
+ - **Content-Type**: application/json
1236
+ - **Accept**: application/json
1237
+
1238
+ <a name="importContacts"></a>
1239
+ # **importContacts**
1240
+ > CreatedProcessId importContacts(requestContactImport)
1241
+
1242
+ Import contacts
1243
+
1244
+ It returns the background process ID which on completion calls the notify URL that you have set in the input.
1245
+
1246
+ ### Example
1247
+ ```javascript
1248
+ var Brevo = require('@getbrevo/brevo');
1249
+ var defaultClient = Brevo.ApiClient.instance;
1250
+
1251
+ // Configure API key authorization: api-key
1252
+ var apiKey = defaultClient.authentications['api-key'];
1253
+ apiKey.apiKey = 'YOUR API KEY';
1254
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1255
+ //apiKey.apiKeyPrefix = 'Token';
1256
+
1257
+ // Configure API key authorization: partner-key
1258
+ var partnerKey = defaultClient.authentications['partner-key'];
1259
+ partnerKey.apiKey = 'YOUR API KEY';
1260
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1261
+ //partnerKey.apiKeyPrefix = 'Token';
1262
+
1263
+ var apiInstance = new Brevo.ContactsApi();
1264
+
1265
+ var requestContactImport = new Brevo.RequestContactImport(); // RequestContactImport | Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``
1266
+
1267
+ apiInstance.importContacts(requestContactImport).then(function(data) {
1268
+ console.log('API called successfully. Returned data: ' + data);
1269
+ }, function(error) {
1270
+ console.error(error);
1271
+ });
1272
+
1273
+ ```
1274
+
1275
+ ### Parameters
1276
+
1277
+ Name | Type | Description | Notes
1278
+ ------------- | ------------- | ------------- | -------------
1279
+ **requestContactImport** | [**RequestContactImport**](RequestContactImport.md)| Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` |
1280
+
1281
+ ### Return type
1282
+
1283
+ [**CreatedProcessId**](CreatedProcessId.md)
1284
+
1285
+ ### Authorization
1286
+
1287
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1288
+
1289
+ ### HTTP request headers
1290
+
1291
+ - **Content-Type**: application/json
1292
+ - **Accept**: application/json
1293
+
1294
+ <a name="removeContactFromList"></a>
1295
+ # **removeContactFromList**
1296
+ > PostContactInfo removeContactFromList(listId, contactEmails)
1297
+
1298
+ Delete a contact from a list
1299
+
1300
+ ### Example
1301
+ ```javascript
1302
+ var Brevo = require('@getbrevo/brevo');
1303
+ var defaultClient = Brevo.ApiClient.instance;
1304
+
1305
+ // Configure API key authorization: api-key
1306
+ var apiKey = defaultClient.authentications['api-key'];
1307
+ apiKey.apiKey = 'YOUR API KEY';
1308
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1309
+ //apiKey.apiKeyPrefix = 'Token';
1310
+
1311
+ // Configure API key authorization: partner-key
1312
+ var partnerKey = defaultClient.authentications['partner-key'];
1313
+ partnerKey.apiKey = 'YOUR API KEY';
1314
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1315
+ //partnerKey.apiKeyPrefix = 'Token';
1316
+
1317
+ var apiInstance = new Brevo.ContactsApi();
1318
+
1319
+ var listId = 789; // Number | Id of the list
1320
+
1321
+ var contactEmails = new Brevo.RemoveContactFromList(); // RemoveContactFromList | Emails addresses OR IDs of the contacts
1322
+
1323
+ apiInstance.removeContactFromList(listId, contactEmails).then(function(data) {
1324
+ console.log('API called successfully. Returned data: ' + data);
1325
+ }, function(error) {
1326
+ console.error(error);
1327
+ });
1328
+
1329
+ ```
1330
+
1331
+ ### Parameters
1332
+
1333
+ Name | Type | Description | Notes
1334
+ ------------- | ------------- | ------------- | -------------
1335
+ **listId** | **Number**| Id of the list |
1336
+ **contactEmails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
1337
+
1338
+ ### Return type
1339
+
1340
+ [**PostContactInfo**](PostContactInfo.md)
1341
+
1342
+ ### Authorization
1343
+
1344
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1345
+
1346
+ ### HTTP request headers
1347
+
1348
+ - **Content-Type**: application/json
1349
+ - **Accept**: application/json
1350
+
1351
+ <a name="requestContactExport"></a>
1352
+ # **requestContactExport**
1353
+ > CreatedProcessId requestContactExport(requestContactExport)
1354
+
1355
+ Export contacts
1356
+
1357
+ It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
1358
+
1359
+ ### Example
1360
+ ```javascript
1361
+ var Brevo = require('@getbrevo/brevo');
1362
+ var defaultClient = Brevo.ApiClient.instance;
1363
+
1364
+ // Configure API key authorization: api-key
1365
+ var apiKey = defaultClient.authentications['api-key'];
1366
+ apiKey.apiKey = 'YOUR API KEY';
1367
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1368
+ //apiKey.apiKeyPrefix = 'Token';
1369
+
1370
+ // Configure API key authorization: partner-key
1371
+ var partnerKey = defaultClient.authentications['partner-key'];
1372
+ partnerKey.apiKey = 'YOUR API KEY';
1373
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1374
+ //partnerKey.apiKeyPrefix = 'Token';
1375
+
1376
+ var apiInstance = new Brevo.ContactsApi();
1377
+
1378
+ var requestContactExport = new Brevo.RequestContactExport(); // RequestContactExport | Values to request a contact export
1379
+
1380
+ apiInstance.requestContactExport(requestContactExport).then(function(data) {
1381
+ console.log('API called successfully. Returned data: ' + data);
1382
+ }, function(error) {
1383
+ console.error(error);
1384
+ });
1385
+
1386
+ ```
1387
+
1388
+ ### Parameters
1389
+
1390
+ Name | Type | Description | Notes
1391
+ ------------- | ------------- | ------------- | -------------
1392
+ **requestContactExport** | [**RequestContactExport**](RequestContactExport.md)| Values to request a contact export |
1393
+
1394
+ ### Return type
1395
+
1396
+ [**CreatedProcessId**](CreatedProcessId.md)
1397
+
1398
+ ### Authorization
1399
+
1400
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1401
+
1402
+ ### HTTP request headers
1403
+
1404
+ - **Content-Type**: application/json
1405
+ - **Accept**: application/json
1406
+
1407
+ <a name="updateAttribute"></a>
1408
+ # **updateAttribute**
1409
+ > updateAttribute(attributeCategory, attributeName, updateAttribute)
1410
+
1411
+ Update contact attribute
1412
+
1413
+ ### Example
1414
+ ```javascript
1415
+ var Brevo = require('@getbrevo/brevo');
1416
+ var defaultClient = Brevo.ApiClient.instance;
1417
+
1418
+ // Configure API key authorization: api-key
1419
+ var apiKey = defaultClient.authentications['api-key'];
1420
+ apiKey.apiKey = 'YOUR API KEY';
1421
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1422
+ //apiKey.apiKeyPrefix = 'Token';
1423
+
1424
+ // Configure API key authorization: partner-key
1425
+ var partnerKey = defaultClient.authentications['partner-key'];
1426
+ partnerKey.apiKey = 'YOUR API KEY';
1427
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1428
+ //partnerKey.apiKeyPrefix = 'Token';
1429
+
1430
+ var apiInstance = new Brevo.ContactsApi();
1431
+
1432
+ var attributeCategory = "attributeCategory_example"; // String | Category of the attribute
1433
+
1434
+ var attributeName = "attributeName_example"; // String | Name of the existing attribute
1435
+
1436
+ var updateAttribute = new Brevo.UpdateAttribute(); // UpdateAttribute | Values to update an attribute
1437
+
1438
+ apiInstance.updateAttribute(attributeCategory, attributeName, updateAttribute).then(function() {
1439
+ console.log('API called successfully.');
1440
+ }, function(error) {
1441
+ console.error(error);
1442
+ });
1443
+
1444
+ ```
1445
+
1446
+ ### Parameters
1447
+
1448
+ Name | Type | Description | Notes
1449
+ ------------- | ------------- | ------------- | -------------
1450
+ **attributeCategory** | **String**| Category of the attribute |
1451
+ **attributeName** | **String**| Name of the existing attribute |
1452
+ **updateAttribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute |
1453
+
1454
+ ### Return type
1455
+
1456
+ null (empty response body)
1457
+
1458
+ ### Authorization
1459
+
1460
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1461
+
1462
+ ### HTTP request headers
1463
+
1464
+ - **Content-Type**: application/json
1465
+ - **Accept**: application/json
1466
+
1467
+ <a name="updateBatchContacts"></a>
1468
+ # **updateBatchContacts**
1469
+ > updateBatchContacts(updateBatchContacts)
1470
+
1471
+ Update multiple contacts
1472
+
1473
+ ### Example
1474
+ ```javascript
1475
+ var Brevo = require('@getbrevo/brevo');
1476
+ var defaultClient = Brevo.ApiClient.instance;
1477
+
1478
+ // Configure API key authorization: api-key
1479
+ var apiKey = defaultClient.authentications['api-key'];
1480
+ apiKey.apiKey = 'YOUR API KEY';
1481
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1482
+ //apiKey.apiKeyPrefix = 'Token';
1483
+
1484
+ // Configure API key authorization: partner-key
1485
+ var partnerKey = defaultClient.authentications['partner-key'];
1486
+ partnerKey.apiKey = 'YOUR API KEY';
1487
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1488
+ //partnerKey.apiKeyPrefix = 'Token';
1489
+
1490
+ var apiInstance = new Brevo.ContactsApi();
1491
+
1492
+ var updateBatchContacts = new Brevo.UpdateBatchContacts(); // UpdateBatchContacts | Values to update multiple contacts
1493
+
1494
+ apiInstance.updateBatchContacts(updateBatchContacts).then(function() {
1495
+ console.log('API called successfully.');
1496
+ }, function(error) {
1497
+ console.error(error);
1498
+ });
1499
+
1500
+ ```
1501
+
1502
+ ### Parameters
1503
+
1504
+ Name | Type | Description | Notes
1505
+ ------------- | ------------- | ------------- | -------------
1506
+ **updateBatchContacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts |
1507
+
1508
+ ### Return type
1509
+
1510
+ null (empty response body)
1511
+
1512
+ ### Authorization
1513
+
1514
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1515
+
1516
+ ### HTTP request headers
1517
+
1518
+ - **Content-Type**: application/json
1519
+ - **Accept**: application/json
1520
+
1521
+ <a name="updateContact"></a>
1522
+ # **updateContact**
1523
+ > updateContact(identifier, updateContact)
1524
+
1525
+ Update a contact
1526
+
1527
+ ### Example
1528
+ ```javascript
1529
+ var Brevo = require('@getbrevo/brevo');
1530
+ var defaultClient = Brevo.ApiClient.instance;
1531
+
1532
+ // Configure API key authorization: api-key
1533
+ var apiKey = defaultClient.authentications['api-key'];
1534
+ apiKey.apiKey = 'YOUR API KEY';
1535
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1536
+ //apiKey.apiKeyPrefix = 'Token';
1537
+
1538
+ // Configure API key authorization: partner-key
1539
+ var partnerKey = defaultClient.authentications['partner-key'];
1540
+ partnerKey.apiKey = 'YOUR API KEY';
1541
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1542
+ //partnerKey.apiKeyPrefix = 'Token';
1543
+
1544
+ var apiInstance = new Brevo.ContactsApi();
1545
+
1546
+ var identifier = "identifier_example"; // String | Email (urlencoded) OR ID of the contact
1547
+
1548
+ var updateContact = new Brevo.UpdateContact(); // UpdateContact | Values to update a contact
1549
+
1550
+ apiInstance.updateContact(identifier, updateContact).then(function() {
1551
+ console.log('API called successfully.');
1552
+ }, function(error) {
1553
+ console.error(error);
1554
+ });
1555
+
1556
+ ```
1557
+
1558
+ ### Parameters
1559
+
1560
+ Name | Type | Description | Notes
1561
+ ------------- | ------------- | ------------- | -------------
1562
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact |
1563
+ **updateContact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
1564
+
1565
+ ### Return type
1566
+
1567
+ null (empty response body)
1568
+
1569
+ ### Authorization
1570
+
1571
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1572
+
1573
+ ### HTTP request headers
1574
+
1575
+ - **Content-Type**: application/json
1576
+ - **Accept**: application/json
1577
+
1578
+ <a name="updateFolder"></a>
1579
+ # **updateFolder**
1580
+ > updateFolder(folderId, updateFolder)
1581
+
1582
+ Update a folder
1583
+
1584
+ ### Example
1585
+ ```javascript
1586
+ var Brevo = require('@getbrevo/brevo');
1587
+ var defaultClient = Brevo.ApiClient.instance;
1588
+
1589
+ // Configure API key authorization: api-key
1590
+ var apiKey = defaultClient.authentications['api-key'];
1591
+ apiKey.apiKey = 'YOUR API KEY';
1592
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1593
+ //apiKey.apiKeyPrefix = 'Token';
1594
+
1595
+ // Configure API key authorization: partner-key
1596
+ var partnerKey = defaultClient.authentications['partner-key'];
1597
+ partnerKey.apiKey = 'YOUR API KEY';
1598
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1599
+ //partnerKey.apiKeyPrefix = 'Token';
1600
+
1601
+ var apiInstance = new Brevo.ContactsApi();
1602
+
1603
+ var folderId = 789; // Number | Id of the folder
1604
+
1605
+ var updateFolder = new Brevo.CreateUpdateFolder(); // CreateUpdateFolder | Name of the folder
1606
+
1607
+ apiInstance.updateFolder(folderId, updateFolder).then(function() {
1608
+ console.log('API called successfully.');
1609
+ }, function(error) {
1610
+ console.error(error);
1611
+ });
1612
+
1613
+ ```
1614
+
1615
+ ### Parameters
1616
+
1617
+ Name | Type | Description | Notes
1618
+ ------------- | ------------- | ------------- | -------------
1619
+ **folderId** | **Number**| Id of the folder |
1620
+ **updateFolder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
1621
+
1622
+ ### Return type
1623
+
1624
+ null (empty response body)
1625
+
1626
+ ### Authorization
1627
+
1628
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1629
+
1630
+ ### HTTP request headers
1631
+
1632
+ - **Content-Type**: application/json
1633
+ - **Accept**: application/json
1634
+
1635
+ <a name="updateList"></a>
1636
+ # **updateList**
1637
+ > updateList(listId, updateList)
1638
+
1639
+ Update a list
1640
+
1641
+ ### Example
1642
+ ```javascript
1643
+ var Brevo = require('@getbrevo/brevo');
1644
+ var defaultClient = Brevo.ApiClient.instance;
1645
+
1646
+ // Configure API key authorization: api-key
1647
+ var apiKey = defaultClient.authentications['api-key'];
1648
+ apiKey.apiKey = 'YOUR API KEY';
1649
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1650
+ //apiKey.apiKeyPrefix = 'Token';
1651
+
1652
+ // Configure API key authorization: partner-key
1653
+ var partnerKey = defaultClient.authentications['partner-key'];
1654
+ partnerKey.apiKey = 'YOUR API KEY';
1655
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1656
+ //partnerKey.apiKeyPrefix = 'Token';
1657
+
1658
+ var apiInstance = new Brevo.ContactsApi();
1659
+
1660
+ var listId = 789; // Number | Id of the list
1661
+
1662
+ var updateList = new Brevo.UpdateList(); // UpdateList | Values to update a list
1663
+
1664
+ apiInstance.updateList(listId, updateList).then(function() {
1665
+ console.log('API called successfully.');
1666
+ }, function(error) {
1667
+ console.error(error);
1668
+ });
1669
+
1670
+ ```
1671
+
1672
+ ### Parameters
1673
+
1674
+ Name | Type | Description | Notes
1675
+ ------------- | ------------- | ------------- | -------------
1676
+ **listId** | **Number**| Id of the list |
1677
+ **updateList** | [**UpdateList**](UpdateList.md)| Values to update a list |
1678
+
1679
+ ### Return type
1680
+
1681
+ null (empty response body)
1682
+
1683
+ ### Authorization
1684
+
1685
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1686
+
1687
+ ### HTTP request headers
1688
+
1689
+ - **Content-Type**: application/json
1690
+ - **Accept**: application/json
1691
+