@bitblit/ratchet-misc 6.0.146-alpha → 6.0.147-alpha

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 (278) hide show
  1. package/package.json +4 -3
  2. package/src/brevo/brevo-keys.ts +7 -0
  3. package/src/brevo/brevo-mail-sending-provider.ts +49 -0
  4. package/src/brevo/brevo-ratchet.spec.ts +35 -0
  5. package/src/brevo/brevo-ratchet.ts +50 -0
  6. package/src/brevo/generated/.openapi-generator/FILES +208 -0
  7. package/src/brevo/generated/.openapi-generator/VERSION +1 -0
  8. package/src/brevo/generated/.openapi-generator-ignore +23 -0
  9. package/src/brevo/generated/apis/AccountApi.ts +76 -0
  10. package/src/brevo/generated/apis/AttributesApi.ts +366 -0
  11. package/src/brevo/generated/apis/ContactsApi.ts +2295 -0
  12. package/src/brevo/generated/apis/EmailCampaignsApi.ts +1130 -0
  13. package/src/brevo/generated/apis/FoldersApi.ts +502 -0
  14. package/src/brevo/generated/apis/ListsApi.ts +770 -0
  15. package/src/brevo/generated/apis/ProcessApi.ts +165 -0
  16. package/src/brevo/generated/apis/ResellerApi.ts +1330 -0
  17. package/src/brevo/generated/apis/SMSCampaignsApi.ts +839 -0
  18. package/src/brevo/generated/apis/SMTPApi.ts +1674 -0
  19. package/src/brevo/generated/apis/SendersApi.ts +425 -0
  20. package/src/brevo/generated/apis/TransactionalSMSApi.ts +433 -0
  21. package/src/brevo/generated/apis/WebhooksApi.ts +393 -0
  22. package/src/brevo/generated/apis/WhatsAppCampaignsApi.ts +371 -0
  23. package/src/brevo/generated/models/AbTestCampaignResult.ts +142 -0
  24. package/src/brevo/generated/models/AbTestCampaignResultClickedLinks.ts +73 -0
  25. package/src/brevo/generated/models/AbTestCampaignResultStatistics.ts +109 -0
  26. package/src/brevo/generated/models/AbTestVersionClicksInner.ts +79 -0
  27. package/src/brevo/generated/models/AbTestVersionStats.ts +70 -0
  28. package/src/brevo/generated/models/AddChildDomain.ts +62 -0
  29. package/src/brevo/generated/models/AddContactToList.ts +62 -0
  30. package/src/brevo/generated/models/AddCredits.ts +70 -0
  31. package/src/brevo/generated/models/BlockDomain.ts +61 -0
  32. package/src/brevo/generated/models/ComponentItems.ts +70 -0
  33. package/src/brevo/generated/models/CreateAttribute.ts +95 -0
  34. package/src/brevo/generated/models/CreateAttributeEnumerationInner.ts +70 -0
  35. package/src/brevo/generated/models/CreateChild.ts +120 -0
  36. package/src/brevo/generated/models/CreateContact.ts +110 -0
  37. package/src/brevo/generated/models/CreateDoiContact.ts +106 -0
  38. package/src/brevo/generated/models/CreateEmailCampaign.ts +293 -0
  39. package/src/brevo/generated/models/CreateEmailCampaignRecipients.ts +70 -0
  40. package/src/brevo/generated/models/CreateEmailCampaignSender.ts +78 -0
  41. package/src/brevo/generated/models/CreateList.ts +70 -0
  42. package/src/brevo/generated/models/CreateModel.ts +61 -0
  43. package/src/brevo/generated/models/CreateReseller.ts +71 -0
  44. package/src/brevo/generated/models/CreateSender.ts +82 -0
  45. package/src/brevo/generated/models/CreateSenderIpsInner.ts +80 -0
  46. package/src/brevo/generated/models/CreateSenderModel.ts +79 -0
  47. package/src/brevo/generated/models/CreateSmsCampaign.ts +99 -0
  48. package/src/brevo/generated/models/CreateSmsCampaignRecipients.ts +71 -0
  49. package/src/brevo/generated/models/CreateSmtpEmail.ts +61 -0
  50. package/src/brevo/generated/models/CreateSmtpTemplate.ts +139 -0
  51. package/src/brevo/generated/models/CreateSmtpTemplateSender.ts +78 -0
  52. package/src/brevo/generated/models/CreateUpdateContactModel.ts +62 -0
  53. package/src/brevo/generated/models/CreateUpdateFolder.ts +62 -0
  54. package/src/brevo/generated/models/CreateWebhook.ts +119 -0
  55. package/src/brevo/generated/models/CreatedProcessId.ts +61 -0
  56. package/src/brevo/generated/models/DeleteHardbounces.ts +78 -0
  57. package/src/brevo/generated/models/EmailExportRecipients.ts +86 -0
  58. package/src/brevo/generated/models/ErrorModel.ts +92 -0
  59. package/src/brevo/generated/models/GetAccount.ts +138 -0
  60. package/src/brevo/generated/models/GetAccountAllOfMarketingAutomation.ts +74 -0
  61. package/src/brevo/generated/models/GetAccountAllOfPlan.ts +124 -0
  62. package/src/brevo/generated/models/GetAccountAllOfRelay.ts +73 -0
  63. package/src/brevo/generated/models/GetAccountAllOfRelayData.ts +79 -0
  64. package/src/brevo/generated/models/GetAggregatedReport.ts +169 -0
  65. package/src/brevo/generated/models/GetAttributes.ts +64 -0
  66. package/src/brevo/generated/models/GetAttributesAttributesInner.ts +129 -0
  67. package/src/brevo/generated/models/GetAttributesAttributesInnerEnumerationInner.ts +73 -0
  68. package/src/brevo/generated/models/GetBlockedDomains.ts +61 -0
  69. package/src/brevo/generated/models/GetCampaignOverview.ts +183 -0
  70. package/src/brevo/generated/models/GetCampaignRecipients.ts +70 -0
  71. package/src/brevo/generated/models/GetCampaignStats.ts +177 -0
  72. package/src/brevo/generated/models/GetChildAccountCreationStatus.ts +61 -0
  73. package/src/brevo/generated/models/GetChildDomain.ts +70 -0
  74. package/src/brevo/generated/models/GetChildInfo.ts +137 -0
  75. package/src/brevo/generated/models/GetChildInfoAllOfApiKeys.ts +75 -0
  76. package/src/brevo/generated/models/GetChildInfoAllOfApiKeysV2.ts +70 -0
  77. package/src/brevo/generated/models/GetChildInfoAllOfApiKeysV3.ts +70 -0
  78. package/src/brevo/generated/models/GetChildInfoAllOfCredits.ts +70 -0
  79. package/src/brevo/generated/models/GetChildInfoAllOfStatistics.ts +78 -0
  80. package/src/brevo/generated/models/GetChildrenList.ts +73 -0
  81. package/src/brevo/generated/models/GetChildrenListChildrenInner.ts +145 -0
  82. package/src/brevo/generated/models/GetClient.ts +88 -0
  83. package/src/brevo/generated/models/GetContactCampaignStats.ts +168 -0
  84. package/src/brevo/generated/models/GetContactCampaignStatsClickedInner.ts +79 -0
  85. package/src/brevo/generated/models/GetContactCampaignStatsOpenedInner.ts +91 -0
  86. package/src/brevo/generated/models/GetContactCampaignStatsTransacAttributesInner.ts +82 -0
  87. package/src/brevo/generated/models/GetContactCampaignStatsUnsubscriptions.ts +92 -0
  88. package/src/brevo/generated/models/GetContactDetails.ts +133 -0
  89. package/src/brevo/generated/models/GetContacts.ts +73 -0
  90. package/src/brevo/generated/models/GetDeviceBrowserStats.ts +88 -0
  91. package/src/brevo/generated/models/GetEmailCampaign.ts +348 -0
  92. package/src/brevo/generated/models/GetEmailCampaigns.ts +73 -0
  93. package/src/brevo/generated/models/GetEmailCampaignsCampaignsInner.ts +348 -0
  94. package/src/brevo/generated/models/GetEmailEventReport.ts +64 -0
  95. package/src/brevo/generated/models/GetEmailEventReportEventsInner.ts +157 -0
  96. package/src/brevo/generated/models/GetExtendedCampaignOverview.ts +326 -0
  97. package/src/brevo/generated/models/GetExtendedCampaignOverviewAllOfSender.ts +81 -0
  98. package/src/brevo/generated/models/GetExtendedCampaignStats.ts +132 -0
  99. package/src/brevo/generated/models/GetExtendedClient.ts +100 -0
  100. package/src/brevo/generated/models/GetExtendedClientAllOfAddress.ts +88 -0
  101. package/src/brevo/generated/models/GetExtendedContactDetails.ts +147 -0
  102. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatistics.ts +168 -0
  103. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsClicked.ts +79 -0
  104. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsLinks.ts +91 -0
  105. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsMessagesSent.ts +77 -0
  106. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsOpened.ts +91 -0
  107. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptions.ts +96 -0
  108. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.ts +78 -0
  109. package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.ts +87 -0
  110. package/src/brevo/generated/models/GetExtendedList.ts +129 -0
  111. package/src/brevo/generated/models/GetExtendedListAllOfCampaignStats.ts +73 -0
  112. package/src/brevo/generated/models/GetFolder.ts +97 -0
  113. package/src/brevo/generated/models/GetFolderLists.ts +73 -0
  114. package/src/brevo/generated/models/GetFolders.ts +72 -0
  115. package/src/brevo/generated/models/GetIp.ts +88 -0
  116. package/src/brevo/generated/models/GetIpFromSender.ts +88 -0
  117. package/src/brevo/generated/models/GetIps.ts +64 -0
  118. package/src/brevo/generated/models/GetIpsFromSender.ts +64 -0
  119. package/src/brevo/generated/models/GetList.ts +88 -0
  120. package/src/brevo/generated/models/GetLists.ts +73 -0
  121. package/src/brevo/generated/models/GetListsListsInner.ts +97 -0
  122. package/src/brevo/generated/models/GetProcess.ts +99 -0
  123. package/src/brevo/generated/models/GetProcesses.ts +73 -0
  124. package/src/brevo/generated/models/GetReports.ts +64 -0
  125. package/src/brevo/generated/models/GetReportsReportsInner.ts +169 -0
  126. package/src/brevo/generated/models/GetSegments.ts +72 -0
  127. package/src/brevo/generated/models/GetSegmentsSegments.ts +86 -0
  128. package/src/brevo/generated/models/GetSendersList.ts +64 -0
  129. package/src/brevo/generated/models/GetSendersListSendersInner.ts +103 -0
  130. package/src/brevo/generated/models/GetSendersListSendersInnerIpsInner.ts +82 -0
  131. package/src/brevo/generated/models/GetSharedTemplateUrl.ts +61 -0
  132. package/src/brevo/generated/models/GetSmsCampaign.ts +160 -0
  133. package/src/brevo/generated/models/GetSmsCampaignOverview.ts +137 -0
  134. package/src/brevo/generated/models/GetSmsCampaignStats.ts +115 -0
  135. package/src/brevo/generated/models/GetSmsCampaigns.ts +73 -0
  136. package/src/brevo/generated/models/GetSmsCampaignsCampaignsInner.ts +160 -0
  137. package/src/brevo/generated/models/GetSmsEventReport.ts +64 -0
  138. package/src/brevo/generated/models/GetSmsEventReportEventsInner.ts +131 -0
  139. package/src/brevo/generated/models/GetSmtpTemplateOverview.ts +172 -0
  140. package/src/brevo/generated/models/GetSmtpTemplateOverviewSender.ts +78 -0
  141. package/src/brevo/generated/models/GetSmtpTemplates.ts +72 -0
  142. package/src/brevo/generated/models/GetSsoToken.ts +61 -0
  143. package/src/brevo/generated/models/GetStatsByDevice.ts +88 -0
  144. package/src/brevo/generated/models/GetTransacAggregatedSmsReport.ts +142 -0
  145. package/src/brevo/generated/models/GetTransacBlockedContacts.ts +75 -0
  146. package/src/brevo/generated/models/GetTransacBlockedContactsContactsInner.ts +97 -0
  147. package/src/brevo/generated/models/GetTransacBlockedContactsContactsInnerReason.ts +86 -0
  148. package/src/brevo/generated/models/GetTransacEmailContent.ts +118 -0
  149. package/src/brevo/generated/models/GetTransacEmailContentEventsInner.ts +70 -0
  150. package/src/brevo/generated/models/GetTransacEmailsList.ts +72 -0
  151. package/src/brevo/generated/models/GetTransacEmailsListTransactionalEmailsInner.ts +126 -0
  152. package/src/brevo/generated/models/GetTransacSmsReport.ts +64 -0
  153. package/src/brevo/generated/models/GetTransacSmsReportReportsInner.ts +142 -0
  154. package/src/brevo/generated/models/GetWATemplates.ts +73 -0
  155. package/src/brevo/generated/models/GetWATemplatesTemplatesInner.ts +125 -0
  156. package/src/brevo/generated/models/GetWebhook.ts +124 -0
  157. package/src/brevo/generated/models/GetWebhooks.ts +64 -0
  158. package/src/brevo/generated/models/GetWhatsappCampaignOverview.ts +152 -0
  159. package/src/brevo/generated/models/GetWhatsappCampaigns.ts +75 -0
  160. package/src/brevo/generated/models/GetWhatsappCampaignsCampaignsInner.ts +169 -0
  161. package/src/brevo/generated/models/ManageIp.ts +62 -0
  162. package/src/brevo/generated/models/PostContactInfo.ts +64 -0
  163. package/src/brevo/generated/models/PostContactInfoContacts.ts +86 -0
  164. package/src/brevo/generated/models/PostSendFailed.ts +96 -0
  165. package/src/brevo/generated/models/PostSendSmsTestFailed.ts +88 -0
  166. package/src/brevo/generated/models/RemainingCreditModel.ts +75 -0
  167. package/src/brevo/generated/models/RemainingCreditModelChild.ts +70 -0
  168. package/src/brevo/generated/models/RemainingCreditModelReseller.ts +70 -0
  169. package/src/brevo/generated/models/RemoveContactFromList.ts +70 -0
  170. package/src/brevo/generated/models/RemoveCredits.ts +70 -0
  171. package/src/brevo/generated/models/RequestContactExport.ts +94 -0
  172. package/src/brevo/generated/models/RequestContactExportCustomContactFilter.ts +141 -0
  173. package/src/brevo/generated/models/RequestContactImport.ts +136 -0
  174. package/src/brevo/generated/models/RequestContactImportNewList.ts +70 -0
  175. package/src/brevo/generated/models/RequestSmsRecipientExport.ts +84 -0
  176. package/src/brevo/generated/models/SendEmail.ts +129 -0
  177. package/src/brevo/generated/models/SendEmailAttachmentInner.ts +70 -0
  178. package/src/brevo/generated/models/SendReport.ts +86 -0
  179. package/src/brevo/generated/models/SendReportEmail.ts +70 -0
  180. package/src/brevo/generated/models/SendSms.ts +96 -0
  181. package/src/brevo/generated/models/SendSmtpEmail.ts +171 -0
  182. package/src/brevo/generated/models/SendSmtpEmailAttachmentInner.ts +78 -0
  183. package/src/brevo/generated/models/SendSmtpEmailBccInner.ts +71 -0
  184. package/src/brevo/generated/models/SendSmtpEmailCcInner.ts +71 -0
  185. package/src/brevo/generated/models/SendSmtpEmailReplyTo.ts +71 -0
  186. package/src/brevo/generated/models/SendSmtpEmailSender.ts +71 -0
  187. package/src/brevo/generated/models/SendSmtpEmailToInner.ts +71 -0
  188. package/src/brevo/generated/models/SendTemplateEmail.ts +61 -0
  189. package/src/brevo/generated/models/SendTestEmail.ts +62 -0
  190. package/src/brevo/generated/models/SendTestSms.ts +62 -0
  191. package/src/brevo/generated/models/SendTransacSms.ts +122 -0
  192. package/src/brevo/generated/models/UpdateAttribute.ts +74 -0
  193. package/src/brevo/generated/models/UpdateAttributeEnumerationInner.ts +70 -0
  194. package/src/brevo/generated/models/UpdateCampaignStatus.ts +77 -0
  195. package/src/brevo/generated/models/UpdateChild.ts +94 -0
  196. package/src/brevo/generated/models/UpdateChildAccountStatus.ts +86 -0
  197. package/src/brevo/generated/models/UpdateChildDomain.ts +62 -0
  198. package/src/brevo/generated/models/UpdateContact.ts +102 -0
  199. package/src/brevo/generated/models/UpdateEmailCampaign.ts +291 -0
  200. package/src/brevo/generated/models/UpdateEmailCampaignRecipients.ts +70 -0
  201. package/src/brevo/generated/models/UpdateEmailCampaignSender.ts +78 -0
  202. package/src/brevo/generated/models/UpdateList.ts +70 -0
  203. package/src/brevo/generated/models/UpdateSender.ts +80 -0
  204. package/src/brevo/generated/models/UpdateSmsCampaign.ts +96 -0
  205. package/src/brevo/generated/models/UpdateSmtpTemplate.ts +136 -0
  206. package/src/brevo/generated/models/UpdateSmtpTemplateSender.ts +78 -0
  207. package/src/brevo/generated/models/UpdateWebhook.ts +100 -0
  208. package/src/brevo/generated/models/UploadImageToGallery.ts +71 -0
  209. package/src/brevo/generated/models/VariablesItems.ts +78 -0
  210. package/src/brevo/generated/models/WhatsappCampStats.ts +97 -0
  211. package/src/brevo/generated/models/WhatsappCampTemplate.ts +146 -0
  212. package/src/brevo/generated/models/index.ts +189 -0
  213. package/src/brevo/generated/runtime.ts +455 -0
  214. package/src/build/ratchet-misc-info.ts +19 -0
  215. package/src/handlebars/handlebars-ratchet.spec.ts +117 -0
  216. package/src/handlebars/handlebars-ratchet.ts +151 -0
  217. package/src/handlebars/remote-handlebars-template-renderer.ts +87 -0
  218. package/src/model-validator/model-validator.spec.ts +43 -0
  219. package/src/model-validator/model-validator.ts +67 -0
  220. package/src/rxjs/observable-ratchet.spec.ts +21 -0
  221. package/src/rxjs/observable-ratchet.ts +27 -0
  222. package/src/rxjs/rxjs-ratchet.spec.ts +22 -0
  223. package/src/rxjs/rxjs-ratchet.ts +44 -0
  224. package/src/sobol/generated/.openapi-generator/FILES +53 -0
  225. package/src/sobol/generated/.openapi-generator/VERSION +1 -0
  226. package/src/sobol/generated/.openapi-generator-ignore +23 -0
  227. package/src/sobol/generated/apis/AgreementsApi.ts +656 -0
  228. package/src/sobol/generated/apis/CustomFieldValuesApi.ts +412 -0
  229. package/src/sobol/generated/apis/CustomFieldsApi.ts +460 -0
  230. package/src/sobol/generated/apis/GoalsApi.ts +565 -0
  231. package/src/sobol/generated/apis/RoleAssignmentsApi.ts +289 -0
  232. package/src/sobol/generated/apis/RolesApi.ts +736 -0
  233. package/src/sobol/generated/apis/TeamsApi.ts +748 -0
  234. package/src/sobol/generated/apis/UsersApi.ts +640 -0
  235. package/src/sobol/generated/apis/index.ts +8 -0
  236. package/src/sobol/generated/index.ts +3 -0
  237. package/src/sobol/generated/models/Address.ts +220 -0
  238. package/src/sobol/generated/models/AddressTypeInternalEnum.ts +35 -0
  239. package/src/sobol/generated/models/Agreement.ts +281 -0
  240. package/src/sobol/generated/models/AgreementOwnersInner.ts +80 -0
  241. package/src/sobol/generated/models/AgreementSignatoriesInner.ts +78 -0
  242. package/src/sobol/generated/models/CustomField.ts +265 -0
  243. package/src/sobol/generated/models/CustomFieldBadgeConfig.ts +67 -0
  244. package/src/sobol/generated/models/CustomFieldBadgeConfigOptionsValue.ts +105 -0
  245. package/src/sobol/generated/models/CustomFieldBadgeContent.ts +67 -0
  246. package/src/sobol/generated/models/CustomFieldBadgeContentBadgesInner.ts +73 -0
  247. package/src/sobol/generated/models/CustomFieldConfig.ts +88 -0
  248. package/src/sobol/generated/models/CustomFieldMultiSelectDropDownConfig.ts +70 -0
  249. package/src/sobol/generated/models/CustomFieldMultiSelectDropDownContent.ts +72 -0
  250. package/src/sobol/generated/models/CustomFieldMultiSelectDropDownContentSelectedOptions.ts +77 -0
  251. package/src/sobol/generated/models/CustomFieldSingleSelectDropDownConfig.ts +70 -0
  252. package/src/sobol/generated/models/CustomFieldSingleSelectDropDownConfigOptionsValue.ts +75 -0
  253. package/src/sobol/generated/models/CustomFieldSingleSelectDropDownContent.ts +72 -0
  254. package/src/sobol/generated/models/CustomFieldSingleSelectDropDownContentSelectedOptions.ts +77 -0
  255. package/src/sobol/generated/models/CustomFieldTextConfig.ts +62 -0
  256. package/src/sobol/generated/models/CustomFieldTextContent.ts +62 -0
  257. package/src/sobol/generated/models/CustomFieldValue.ts +249 -0
  258. package/src/sobol/generated/models/CustomFieldValueContent.ts +88 -0
  259. package/src/sobol/generated/models/FeatureToggle.ts +123 -0
  260. package/src/sobol/generated/models/GlobalIdentity.ts +218 -0
  261. package/src/sobol/generated/models/GlobalUserSettings.ts +187 -0
  262. package/src/sobol/generated/models/Goal.ts +322 -0
  263. package/src/sobol/generated/models/GoalOwnersInner.ts +80 -0
  264. package/src/sobol/generated/models/GoalParentGoal.ts +78 -0
  265. package/src/sobol/generated/models/GoalValue.ts +178 -0
  266. package/src/sobol/generated/models/LocalIdentity.ts +220 -0
  267. package/src/sobol/generated/models/ObjectRef.ts +82 -0
  268. package/src/sobol/generated/models/Role.ts +258 -0
  269. package/src/sobol/generated/models/RoleAccountableTo.ts +78 -0
  270. package/src/sobol/generated/models/RoleAssignment.ts +202 -0
  271. package/src/sobol/generated/models/RoleAssignmentsInner.ts +78 -0
  272. package/src/sobol/generated/models/RoleContributesTo.ts +78 -0
  273. package/src/sobol/generated/models/Team.ts +273 -0
  274. package/src/sobol/generated/models/TeamOwnersInner.ts +79 -0
  275. package/src/sobol/generated/models/User.ts +396 -0
  276. package/src/sobol/generated/models/UserLocalIdentitiesInner.ts +78 -0
  277. package/src/sobol/generated/models/index.ts +40 -0
  278. package/src/sobol/generated/runtime.ts +455 -0
@@ -0,0 +1,1130 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * SendinBlue API
4
+ * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
5
+ *
6
+ * The version of the OpenAPI document: 3.0.0
7
+ * Contact: contact@sendinblue.com
8
+ *
9
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10
+ * https://openapi-generator.tech
11
+ * Do not edit the class manually.
12
+ */
13
+
14
+ import * as runtime from '../runtime.js';
15
+ import type {
16
+ AbTestCampaignResult,
17
+ CreatedProcessId,
18
+ CreateEmailCampaign,
19
+ CreateModel,
20
+ EmailExportRecipients,
21
+ GetEmailCampaign,
22
+ GetEmailCampaigns,
23
+ GetSharedTemplateUrl,
24
+ SendReport,
25
+ SendTestEmail,
26
+ UpdateCampaignStatus,
27
+ UpdateEmailCampaign,
28
+ UploadImageToGallery,
29
+ } from '../models/index.js';
30
+ import {
31
+ AbTestCampaignResultFromJSON,
32
+ CreatedProcessIdFromJSON,
33
+ CreateEmailCampaignToJSON,
34
+ CreateModelFromJSON,
35
+ EmailExportRecipientsToJSON,
36
+ GetEmailCampaignFromJSON,
37
+ GetEmailCampaignsFromJSON,
38
+ GetSharedTemplateUrlFromJSON,
39
+ SendReportToJSON,
40
+ SendTestEmailToJSON,
41
+ UpdateCampaignStatusToJSON,
42
+ UpdateEmailCampaignToJSON,
43
+ UploadImageToGalleryToJSON,
44
+ } from '../models/index.js';
45
+
46
+ export interface CreateEmailCampaignRequest {
47
+ emailCampaigns: CreateEmailCampaign;
48
+ }
49
+
50
+ export interface DeleteEmailCampaignRequest {
51
+ campaignId: number;
52
+ }
53
+
54
+ export interface EmailExportRecipientsRequest {
55
+ campaignId: number;
56
+ recipientExport?: EmailExportRecipients;
57
+ }
58
+
59
+ export interface GetAbTestCampaignResultRequest {
60
+ campaignId: number;
61
+ }
62
+
63
+ export interface GetEmailCampaignRequest {
64
+ campaignId: number;
65
+ statistics?: GetEmailCampaignStatisticsEnum;
66
+ }
67
+
68
+ export interface GetEmailCampaignsRequest {
69
+ type?: GetEmailCampaignsTypeEnum;
70
+ status?: GetEmailCampaignsStatusEnum;
71
+ statistics?: GetEmailCampaignsStatisticsEnum;
72
+ startDate?: Date;
73
+ endDate?: Date;
74
+ limit?: number;
75
+ offset?: number;
76
+ excludeHtmlContent?: boolean;
77
+ }
78
+
79
+ export interface GetSharedTemplateUrlRequest {
80
+ campaignId: number;
81
+ }
82
+
83
+ export interface SendEmailCampaignNowRequest {
84
+ campaignId: number;
85
+ }
86
+
87
+ export interface SendReportRequest {
88
+ campaignId: number;
89
+ sendReport: SendReport;
90
+ }
91
+
92
+ export interface SendTestEmailRequest {
93
+ campaignId: number;
94
+ emailTo: SendTestEmail;
95
+ }
96
+
97
+ export interface UpdateCampaignStatusRequest {
98
+ campaignId: number;
99
+ status: UpdateCampaignStatus;
100
+ }
101
+
102
+ export interface UpdateEmailCampaignRequest {
103
+ campaignId: number;
104
+ emailCampaign: UpdateEmailCampaign;
105
+ }
106
+
107
+ export interface UploadImageToGalleryRequest {
108
+ uploadImage: UploadImageToGallery;
109
+ }
110
+
111
+ /**
112
+ * EmailCampaignsApi - interface
113
+ *
114
+ * @export
115
+ * @interface EmailCampaignsApiInterface
116
+ */
117
+ export interface EmailCampaignsApiInterface {
118
+ /**
119
+ *
120
+ * @summary Create an email campaign
121
+ * @param {CreateEmailCampaign} emailCampaigns Values to create a campaign
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ * @memberof EmailCampaignsApiInterface
125
+ */
126
+ createEmailCampaignRaw(
127
+ requestParameters: CreateEmailCampaignRequest,
128
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
129
+ ): Promise<runtime.ApiResponse<CreateModel>>;
130
+
131
+ /**
132
+ * Create an email campaign
133
+ */
134
+ createEmailCampaign(
135
+ requestParameters: CreateEmailCampaignRequest,
136
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
137
+ ): Promise<CreateModel>;
138
+
139
+ /**
140
+ *
141
+ * @summary Delete an email campaign
142
+ * @param {number} campaignId id of the campaign
143
+ * @param {*} [options] Override http request option.
144
+ * @throws {RequiredError}
145
+ * @memberof EmailCampaignsApiInterface
146
+ */
147
+ deleteEmailCampaignRaw(
148
+ requestParameters: DeleteEmailCampaignRequest,
149
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
150
+ ): Promise<runtime.ApiResponse<void>>;
151
+
152
+ /**
153
+ * Delete an email campaign
154
+ */
155
+ deleteEmailCampaign(
156
+ requestParameters: DeleteEmailCampaignRequest,
157
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
158
+ ): Promise<void>;
159
+
160
+ /**
161
+ *
162
+ * @summary Export the recipients of an email campaign
163
+ * @param {number} campaignId Id of the campaign
164
+ * @param {EmailExportRecipients} [recipientExport] Values to send for a recipient export request
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ * @memberof EmailCampaignsApiInterface
168
+ */
169
+ emailExportRecipientsRaw(
170
+ requestParameters: EmailExportRecipientsRequest,
171
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
172
+ ): Promise<runtime.ApiResponse<CreatedProcessId>>;
173
+
174
+ /**
175
+ * Export the recipients of an email campaign
176
+ */
177
+ emailExportRecipients(
178
+ requestParameters: EmailExportRecipientsRequest,
179
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
180
+ ): Promise<CreatedProcessId>;
181
+
182
+ /**
183
+ * Obtain winning version of an A/B test email campaign
184
+ * @summary Get an A/B test email campaign results
185
+ * @param {number} campaignId Id of the A/B test campaign
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ * @memberof EmailCampaignsApiInterface
189
+ */
190
+ getAbTestCampaignResultRaw(
191
+ requestParameters: GetAbTestCampaignResultRequest,
192
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
193
+ ): Promise<runtime.ApiResponse<AbTestCampaignResult>>;
194
+
195
+ /**
196
+ * Obtain winning version of an A/B test email campaign
197
+ * Get an A/B test email campaign results
198
+ */
199
+ getAbTestCampaignResult(
200
+ requestParameters: GetAbTestCampaignResultRequest,
201
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
202
+ ): Promise<AbTestCampaignResult>;
203
+
204
+ /**
205
+ *
206
+ * @summary Get an email campaign report
207
+ * @param {number} campaignId Id of the campaign
208
+ * @param {'globalStats' | 'linksStats' | 'statsByDomain' | 'statsByDevice' | 'statsByBrowser'} [statistics] Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ * @memberof EmailCampaignsApiInterface
212
+ */
213
+ getEmailCampaignRaw(
214
+ requestParameters: GetEmailCampaignRequest,
215
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
216
+ ): Promise<runtime.ApiResponse<GetEmailCampaign>>;
217
+
218
+ /**
219
+ * Get an email campaign report
220
+ */
221
+ getEmailCampaign(
222
+ requestParameters: GetEmailCampaignRequest,
223
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
224
+ ): Promise<GetEmailCampaign>;
225
+
226
+ /**
227
+ *
228
+ * @summary Return all your created email campaigns
229
+ * @param {'classic' | 'trigger'} [type] Filter on the type of the campaigns
230
+ * @param {'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess'} [status] Filter on the status of the campaign
231
+ * @param {'globalStats' | 'linksStats' | 'statsByDomain'} [statistics] Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
232
+ * @param {Date} [startDate] Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either \&#39;status\&#39; not passed and if passed is set to \&#39;sent\&#39; )
233
+ * @param {Date} [endDate] Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either \&#39;status\&#39; not passed and if passed is set to \&#39;sent\&#39; )
234
+ * @param {number} [limit] Number of documents per page
235
+ * @param {number} [offset] Index of the first document in the page
236
+ * @param {boolean} [excludeHtmlContent] Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
237
+ * @param {*} [options] Override http request option.
238
+ * @throws {RequiredError}
239
+ * @memberof EmailCampaignsApiInterface
240
+ */
241
+ getEmailCampaignsRaw(
242
+ requestParameters: GetEmailCampaignsRequest,
243
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
244
+ ): Promise<runtime.ApiResponse<GetEmailCampaigns>>;
245
+
246
+ /**
247
+ * Return all your created email campaigns
248
+ */
249
+ getEmailCampaigns(
250
+ requestParameters: GetEmailCampaignsRequest,
251
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
252
+ ): Promise<GetEmailCampaigns>;
253
+
254
+ /**
255
+ * Get a unique URL to share & import an email template from one Sendinblue account to another.
256
+ * @summary Get a shared template url
257
+ * @param {number} campaignId Id of the campaign or template
258
+ * @param {*} [options] Override http request option.
259
+ * @throws {RequiredError}
260
+ * @memberof EmailCampaignsApiInterface
261
+ */
262
+ getSharedTemplateUrlRaw(
263
+ requestParameters: GetSharedTemplateUrlRequest,
264
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
265
+ ): Promise<runtime.ApiResponse<GetSharedTemplateUrl>>;
266
+
267
+ /**
268
+ * Get a unique URL to share & import an email template from one Sendinblue account to another.
269
+ * Get a shared template url
270
+ */
271
+ getSharedTemplateUrl(
272
+ requestParameters: GetSharedTemplateUrlRequest,
273
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
274
+ ): Promise<GetSharedTemplateUrl>;
275
+
276
+ /**
277
+ *
278
+ * @summary Send an email campaign immediately, based on campaignId
279
+ * @param {number} campaignId Id of the campaign
280
+ * @param {*} [options] Override http request option.
281
+ * @throws {RequiredError}
282
+ * @memberof EmailCampaignsApiInterface
283
+ */
284
+ sendEmailCampaignNowRaw(
285
+ requestParameters: SendEmailCampaignNowRequest,
286
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
287
+ ): Promise<runtime.ApiResponse<void>>;
288
+
289
+ /**
290
+ * Send an email campaign immediately, based on campaignId
291
+ */
292
+ sendEmailCampaignNow(
293
+ requestParameters: SendEmailCampaignNowRequest,
294
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
295
+ ): Promise<void>;
296
+
297
+ /**
298
+ * A PDF will be sent to the specified email addresses
299
+ * @summary Send the report of a campaign
300
+ * @param {number} campaignId Id of the campaign
301
+ * @param {SendReport} sendReport Values for send a report
302
+ * @param {*} [options] Override http request option.
303
+ * @throws {RequiredError}
304
+ * @memberof EmailCampaignsApiInterface
305
+ */
306
+ sendReportRaw(
307
+ requestParameters: SendReportRequest,
308
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
309
+ ): Promise<runtime.ApiResponse<void>>;
310
+
311
+ /**
312
+ * A PDF will be sent to the specified email addresses
313
+ * Send the report of a campaign
314
+ */
315
+ sendReport(requestParameters: SendReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
316
+
317
+ /**
318
+ *
319
+ * @summary Send an email campaign to your test list
320
+ * @param {number} campaignId Id of the campaign
321
+ * @param {SendTestEmail} emailTo
322
+ * @param {*} [options] Override http request option.
323
+ * @throws {RequiredError}
324
+ * @memberof EmailCampaignsApiInterface
325
+ */
326
+ sendTestEmailRaw(
327
+ requestParameters: SendTestEmailRequest,
328
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
329
+ ): Promise<runtime.ApiResponse<void>>;
330
+
331
+ /**
332
+ * Send an email campaign to your test list
333
+ */
334
+ sendTestEmail(requestParameters: SendTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
335
+
336
+ /**
337
+ *
338
+ * @summary Update an email campaign status
339
+ * @param {number} campaignId Id of the campaign
340
+ * @param {UpdateCampaignStatus} status Status of the campaign
341
+ * @param {*} [options] Override http request option.
342
+ * @throws {RequiredError}
343
+ * @memberof EmailCampaignsApiInterface
344
+ */
345
+ updateCampaignStatusRaw(
346
+ requestParameters: UpdateCampaignStatusRequest,
347
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
348
+ ): Promise<runtime.ApiResponse<void>>;
349
+
350
+ /**
351
+ * Update an email campaign status
352
+ */
353
+ updateCampaignStatus(
354
+ requestParameters: UpdateCampaignStatusRequest,
355
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
356
+ ): Promise<void>;
357
+
358
+ /**
359
+ *
360
+ * @summary Update an email campaign
361
+ * @param {number} campaignId Id of the campaign
362
+ * @param {UpdateEmailCampaign} emailCampaign Values to update a campaign
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ * @memberof EmailCampaignsApiInterface
366
+ */
367
+ updateEmailCampaignRaw(
368
+ requestParameters: UpdateEmailCampaignRequest,
369
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
370
+ ): Promise<runtime.ApiResponse<void>>;
371
+
372
+ /**
373
+ * Update an email campaign
374
+ */
375
+ updateEmailCampaign(
376
+ requestParameters: UpdateEmailCampaignRequest,
377
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
378
+ ): Promise<void>;
379
+
380
+ /**
381
+ *
382
+ * @summary Upload an image to your account\'s image gallery
383
+ * @param {UploadImageToGallery} uploadImage Parameters to upload an image
384
+ * @param {*} [options] Override http request option.
385
+ * @throws {RequiredError}
386
+ * @memberof EmailCampaignsApiInterface
387
+ */
388
+ uploadImageToGalleryRaw(
389
+ requestParameters: UploadImageToGalleryRequest,
390
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
391
+ ): Promise<runtime.ApiResponse<void>>;
392
+
393
+ /**
394
+ * Upload an image to your account\'s image gallery
395
+ */
396
+ uploadImageToGallery(
397
+ requestParameters: UploadImageToGalleryRequest,
398
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
399
+ ): Promise<void>;
400
+ }
401
+
402
+ /**
403
+ *
404
+ */
405
+ export class EmailCampaignsApi extends runtime.BaseAPI implements EmailCampaignsApiInterface {
406
+ /**
407
+ * Create an email campaign
408
+ */
409
+ async createEmailCampaignRaw(
410
+ requestParameters: CreateEmailCampaignRequest,
411
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
412
+ ): Promise<runtime.ApiResponse<CreateModel>> {
413
+ if (requestParameters.emailCampaigns === null || requestParameters.emailCampaigns === undefined) {
414
+ throw new runtime.RequiredError(
415
+ 'emailCampaigns',
416
+ 'Required parameter requestParameters.emailCampaigns was null or undefined when calling createEmailCampaign.',
417
+ );
418
+ }
419
+
420
+ const queryParameters: any = {};
421
+
422
+ const headerParameters: runtime.HTTPHeaders = {};
423
+
424
+ headerParameters['Content-Type'] = 'application/json';
425
+
426
+ if (this.configuration && this.configuration.apiKey) {
427
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
428
+ }
429
+
430
+ const response = await this.request(
431
+ {
432
+ path: `/emailCampaigns`,
433
+ method: 'POST',
434
+ headers: headerParameters,
435
+ query: queryParameters,
436
+ body: CreateEmailCampaignToJSON(requestParameters.emailCampaigns),
437
+ },
438
+ initOverrides,
439
+ );
440
+
441
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
442
+ }
443
+
444
+ /**
445
+ * Create an email campaign
446
+ */
447
+ async createEmailCampaign(
448
+ requestParameters: CreateEmailCampaignRequest,
449
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
450
+ ): Promise<CreateModel> {
451
+ const response = await this.createEmailCampaignRaw(requestParameters, initOverrides);
452
+ return await response.value();
453
+ }
454
+
455
+ /**
456
+ * Delete an email campaign
457
+ */
458
+ async deleteEmailCampaignRaw(
459
+ requestParameters: DeleteEmailCampaignRequest,
460
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
461
+ ): Promise<runtime.ApiResponse<void>> {
462
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
463
+ throw new runtime.RequiredError(
464
+ 'campaignId',
465
+ 'Required parameter requestParameters.campaignId was null or undefined when calling deleteEmailCampaign.',
466
+ );
467
+ }
468
+
469
+ const queryParameters: any = {};
470
+
471
+ const headerParameters: runtime.HTTPHeaders = {};
472
+
473
+ if (this.configuration && this.configuration.apiKey) {
474
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
475
+ }
476
+
477
+ const response = await this.request(
478
+ {
479
+ path: `/emailCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
480
+ method: 'DELETE',
481
+ headers: headerParameters,
482
+ query: queryParameters,
483
+ },
484
+ initOverrides,
485
+ );
486
+
487
+ return new runtime.VoidApiResponse(response);
488
+ }
489
+
490
+ /**
491
+ * Delete an email campaign
492
+ */
493
+ async deleteEmailCampaign(
494
+ requestParameters: DeleteEmailCampaignRequest,
495
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
496
+ ): Promise<void> {
497
+ await this.deleteEmailCampaignRaw(requestParameters, initOverrides);
498
+ }
499
+
500
+ /**
501
+ * Export the recipients of an email campaign
502
+ */
503
+ async emailExportRecipientsRaw(
504
+ requestParameters: EmailExportRecipientsRequest,
505
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
506
+ ): Promise<runtime.ApiResponse<CreatedProcessId>> {
507
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
508
+ throw new runtime.RequiredError(
509
+ 'campaignId',
510
+ 'Required parameter requestParameters.campaignId was null or undefined when calling emailExportRecipients.',
511
+ );
512
+ }
513
+
514
+ const queryParameters: any = {};
515
+
516
+ const headerParameters: runtime.HTTPHeaders = {};
517
+
518
+ headerParameters['Content-Type'] = 'application/json';
519
+
520
+ if (this.configuration && this.configuration.apiKey) {
521
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
522
+ }
523
+
524
+ const response = await this.request(
525
+ {
526
+ path: `/emailCampaigns/{campaignId}/exportRecipients`.replace(
527
+ `{${'campaignId'}}`,
528
+ encodeURIComponent(String(requestParameters.campaignId)),
529
+ ),
530
+ method: 'POST',
531
+ headers: headerParameters,
532
+ query: queryParameters,
533
+ body: EmailExportRecipientsToJSON(requestParameters.recipientExport),
534
+ },
535
+ initOverrides,
536
+ );
537
+
538
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreatedProcessIdFromJSON(jsonValue));
539
+ }
540
+
541
+ /**
542
+ * Export the recipients of an email campaign
543
+ */
544
+ async emailExportRecipients(
545
+ requestParameters: EmailExportRecipientsRequest,
546
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
547
+ ): Promise<CreatedProcessId> {
548
+ const response = await this.emailExportRecipientsRaw(requestParameters, initOverrides);
549
+ return await response.value();
550
+ }
551
+
552
+ /**
553
+ * Obtain winning version of an A/B test email campaign
554
+ * Get an A/B test email campaign results
555
+ */
556
+ async getAbTestCampaignResultRaw(
557
+ requestParameters: GetAbTestCampaignResultRequest,
558
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
559
+ ): Promise<runtime.ApiResponse<AbTestCampaignResult>> {
560
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
561
+ throw new runtime.RequiredError(
562
+ 'campaignId',
563
+ 'Required parameter requestParameters.campaignId was null or undefined when calling getAbTestCampaignResult.',
564
+ );
565
+ }
566
+
567
+ const queryParameters: any = {};
568
+
569
+ const headerParameters: runtime.HTTPHeaders = {};
570
+
571
+ if (this.configuration && this.configuration.apiKey) {
572
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
573
+ }
574
+
575
+ const response = await this.request(
576
+ {
577
+ path: `/emailCampaigns/{campaignId}/abTestCampaignResult`.replace(
578
+ `{${'campaignId'}}`,
579
+ encodeURIComponent(String(requestParameters.campaignId)),
580
+ ),
581
+ method: 'GET',
582
+ headers: headerParameters,
583
+ query: queryParameters,
584
+ },
585
+ initOverrides,
586
+ );
587
+
588
+ return new runtime.JSONApiResponse(response, (jsonValue) => AbTestCampaignResultFromJSON(jsonValue));
589
+ }
590
+
591
+ /**
592
+ * Obtain winning version of an A/B test email campaign
593
+ * Get an A/B test email campaign results
594
+ */
595
+ async getAbTestCampaignResult(
596
+ requestParameters: GetAbTestCampaignResultRequest,
597
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
598
+ ): Promise<AbTestCampaignResult> {
599
+ const response = await this.getAbTestCampaignResultRaw(requestParameters, initOverrides);
600
+ return await response.value();
601
+ }
602
+
603
+ /**
604
+ * Get an email campaign report
605
+ */
606
+ async getEmailCampaignRaw(
607
+ requestParameters: GetEmailCampaignRequest,
608
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
609
+ ): Promise<runtime.ApiResponse<GetEmailCampaign>> {
610
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
611
+ throw new runtime.RequiredError(
612
+ 'campaignId',
613
+ 'Required parameter requestParameters.campaignId was null or undefined when calling getEmailCampaign.',
614
+ );
615
+ }
616
+
617
+ const queryParameters: any = {};
618
+
619
+ if (requestParameters.statistics !== undefined) {
620
+ queryParameters['statistics'] = requestParameters.statistics;
621
+ }
622
+
623
+ const headerParameters: runtime.HTTPHeaders = {};
624
+
625
+ if (this.configuration && this.configuration.apiKey) {
626
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
627
+ }
628
+
629
+ const response = await this.request(
630
+ {
631
+ path: `/emailCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
632
+ method: 'GET',
633
+ headers: headerParameters,
634
+ query: queryParameters,
635
+ },
636
+ initOverrides,
637
+ );
638
+
639
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailCampaignFromJSON(jsonValue));
640
+ }
641
+
642
+ /**
643
+ * Get an email campaign report
644
+ */
645
+ async getEmailCampaign(
646
+ requestParameters: GetEmailCampaignRequest,
647
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
648
+ ): Promise<GetEmailCampaign> {
649
+ const response = await this.getEmailCampaignRaw(requestParameters, initOverrides);
650
+ return await response.value();
651
+ }
652
+
653
+ /**
654
+ * Return all your created email campaigns
655
+ */
656
+ async getEmailCampaignsRaw(
657
+ requestParameters: GetEmailCampaignsRequest,
658
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
659
+ ): Promise<runtime.ApiResponse<GetEmailCampaigns>> {
660
+ const queryParameters: any = {};
661
+
662
+ if (requestParameters.type !== undefined) {
663
+ queryParameters['type'] = requestParameters.type;
664
+ }
665
+
666
+ if (requestParameters.status !== undefined) {
667
+ queryParameters['status'] = requestParameters.status;
668
+ }
669
+
670
+ if (requestParameters.statistics !== undefined) {
671
+ queryParameters['statistics'] = requestParameters.statistics;
672
+ }
673
+
674
+ if (requestParameters.startDate !== undefined) {
675
+ queryParameters['startDate'] = (requestParameters.startDate as any).toISOString();
676
+ }
677
+
678
+ if (requestParameters.endDate !== undefined) {
679
+ queryParameters['endDate'] = (requestParameters.endDate as any).toISOString();
680
+ }
681
+
682
+ if (requestParameters.limit !== undefined) {
683
+ queryParameters['limit'] = requestParameters.limit;
684
+ }
685
+
686
+ if (requestParameters.offset !== undefined) {
687
+ queryParameters['offset'] = requestParameters.offset;
688
+ }
689
+
690
+ if (requestParameters.excludeHtmlContent !== undefined) {
691
+ queryParameters['excludeHtmlContent'] = requestParameters.excludeHtmlContent;
692
+ }
693
+
694
+ const headerParameters: runtime.HTTPHeaders = {};
695
+
696
+ if (this.configuration && this.configuration.apiKey) {
697
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
698
+ }
699
+
700
+ const response = await this.request(
701
+ {
702
+ path: `/emailCampaigns`,
703
+ method: 'GET',
704
+ headers: headerParameters,
705
+ query: queryParameters,
706
+ },
707
+ initOverrides,
708
+ );
709
+
710
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailCampaignsFromJSON(jsonValue));
711
+ }
712
+
713
+ /**
714
+ * Return all your created email campaigns
715
+ */
716
+ async getEmailCampaigns(
717
+ requestParameters: GetEmailCampaignsRequest = {},
718
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
719
+ ): Promise<GetEmailCampaigns> {
720
+ const response = await this.getEmailCampaignsRaw(requestParameters, initOverrides);
721
+ return await response.value();
722
+ }
723
+
724
+ /**
725
+ * Get a unique URL to share & import an email template from one Sendinblue account to another.
726
+ * Get a shared template url
727
+ */
728
+ async getSharedTemplateUrlRaw(
729
+ requestParameters: GetSharedTemplateUrlRequest,
730
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
731
+ ): Promise<runtime.ApiResponse<GetSharedTemplateUrl>> {
732
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
733
+ throw new runtime.RequiredError(
734
+ 'campaignId',
735
+ 'Required parameter requestParameters.campaignId was null or undefined when calling getSharedTemplateUrl.',
736
+ );
737
+ }
738
+
739
+ const queryParameters: any = {};
740
+
741
+ const headerParameters: runtime.HTTPHeaders = {};
742
+
743
+ if (this.configuration && this.configuration.apiKey) {
744
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
745
+ }
746
+
747
+ const response = await this.request(
748
+ {
749
+ path: `/emailCampaigns/{campaignId}/sharedUrl`.replace(
750
+ `{${'campaignId'}}`,
751
+ encodeURIComponent(String(requestParameters.campaignId)),
752
+ ),
753
+ method: 'GET',
754
+ headers: headerParameters,
755
+ query: queryParameters,
756
+ },
757
+ initOverrides,
758
+ );
759
+
760
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetSharedTemplateUrlFromJSON(jsonValue));
761
+ }
762
+
763
+ /**
764
+ * Get a unique URL to share & import an email template from one Sendinblue account to another.
765
+ * Get a shared template url
766
+ */
767
+ async getSharedTemplateUrl(
768
+ requestParameters: GetSharedTemplateUrlRequest,
769
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
770
+ ): Promise<GetSharedTemplateUrl> {
771
+ const response = await this.getSharedTemplateUrlRaw(requestParameters, initOverrides);
772
+ return await response.value();
773
+ }
774
+
775
+ /**
776
+ * Send an email campaign immediately, based on campaignId
777
+ */
778
+ async sendEmailCampaignNowRaw(
779
+ requestParameters: SendEmailCampaignNowRequest,
780
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
781
+ ): Promise<runtime.ApiResponse<void>> {
782
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
783
+ throw new runtime.RequiredError(
784
+ 'campaignId',
785
+ 'Required parameter requestParameters.campaignId was null or undefined when calling sendEmailCampaignNow.',
786
+ );
787
+ }
788
+
789
+ const queryParameters: any = {};
790
+
791
+ const headerParameters: runtime.HTTPHeaders = {};
792
+
793
+ if (this.configuration && this.configuration.apiKey) {
794
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
795
+ }
796
+
797
+ const response = await this.request(
798
+ {
799
+ path: `/emailCampaigns/{campaignId}/sendNow`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
800
+ method: 'POST',
801
+ headers: headerParameters,
802
+ query: queryParameters,
803
+ },
804
+ initOverrides,
805
+ );
806
+
807
+ return new runtime.VoidApiResponse(response);
808
+ }
809
+
810
+ /**
811
+ * Send an email campaign immediately, based on campaignId
812
+ */
813
+ async sendEmailCampaignNow(
814
+ requestParameters: SendEmailCampaignNowRequest,
815
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
816
+ ): Promise<void> {
817
+ await this.sendEmailCampaignNowRaw(requestParameters, initOverrides);
818
+ }
819
+
820
+ /**
821
+ * A PDF will be sent to the specified email addresses
822
+ * Send the report of a campaign
823
+ */
824
+ async sendReportRaw(
825
+ requestParameters: SendReportRequest,
826
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
827
+ ): Promise<runtime.ApiResponse<void>> {
828
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
829
+ throw new runtime.RequiredError(
830
+ 'campaignId',
831
+ 'Required parameter requestParameters.campaignId was null or undefined when calling sendReport.',
832
+ );
833
+ }
834
+
835
+ if (requestParameters.sendReport === null || requestParameters.sendReport === undefined) {
836
+ throw new runtime.RequiredError(
837
+ 'sendReport',
838
+ 'Required parameter requestParameters.sendReport was null or undefined when calling sendReport.',
839
+ );
840
+ }
841
+
842
+ const queryParameters: any = {};
843
+
844
+ const headerParameters: runtime.HTTPHeaders = {};
845
+
846
+ headerParameters['Content-Type'] = 'application/json';
847
+
848
+ if (this.configuration && this.configuration.apiKey) {
849
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
850
+ }
851
+
852
+ const response = await this.request(
853
+ {
854
+ path: `/emailCampaigns/{campaignId}/sendReport`.replace(
855
+ `{${'campaignId'}}`,
856
+ encodeURIComponent(String(requestParameters.campaignId)),
857
+ ),
858
+ method: 'POST',
859
+ headers: headerParameters,
860
+ query: queryParameters,
861
+ body: SendReportToJSON(requestParameters.sendReport),
862
+ },
863
+ initOverrides,
864
+ );
865
+
866
+ return new runtime.VoidApiResponse(response);
867
+ }
868
+
869
+ /**
870
+ * A PDF will be sent to the specified email addresses
871
+ * Send the report of a campaign
872
+ */
873
+ async sendReport(requestParameters: SendReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
874
+ await this.sendReportRaw(requestParameters, initOverrides);
875
+ }
876
+
877
+ /**
878
+ * Send an email campaign to your test list
879
+ */
880
+ async sendTestEmailRaw(
881
+ requestParameters: SendTestEmailRequest,
882
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
883
+ ): Promise<runtime.ApiResponse<void>> {
884
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
885
+ throw new runtime.RequiredError(
886
+ 'campaignId',
887
+ 'Required parameter requestParameters.campaignId was null or undefined when calling sendTestEmail.',
888
+ );
889
+ }
890
+
891
+ if (requestParameters.emailTo === null || requestParameters.emailTo === undefined) {
892
+ throw new runtime.RequiredError(
893
+ 'emailTo',
894
+ 'Required parameter requestParameters.emailTo was null or undefined when calling sendTestEmail.',
895
+ );
896
+ }
897
+
898
+ const queryParameters: any = {};
899
+
900
+ const headerParameters: runtime.HTTPHeaders = {};
901
+
902
+ headerParameters['Content-Type'] = 'application/json';
903
+
904
+ if (this.configuration && this.configuration.apiKey) {
905
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
906
+ }
907
+
908
+ const response = await this.request(
909
+ {
910
+ path: `/emailCampaigns/{campaignId}/sendTest`.replace(
911
+ `{${'campaignId'}}`,
912
+ encodeURIComponent(String(requestParameters.campaignId)),
913
+ ),
914
+ method: 'POST',
915
+ headers: headerParameters,
916
+ query: queryParameters,
917
+ body: SendTestEmailToJSON(requestParameters.emailTo),
918
+ },
919
+ initOverrides,
920
+ );
921
+
922
+ return new runtime.VoidApiResponse(response);
923
+ }
924
+
925
+ /**
926
+ * Send an email campaign to your test list
927
+ */
928
+ async sendTestEmail(requestParameters: SendTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
929
+ await this.sendTestEmailRaw(requestParameters, initOverrides);
930
+ }
931
+
932
+ /**
933
+ * Update an email campaign status
934
+ */
935
+ async updateCampaignStatusRaw(
936
+ requestParameters: UpdateCampaignStatusRequest,
937
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
938
+ ): Promise<runtime.ApiResponse<void>> {
939
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
940
+ throw new runtime.RequiredError(
941
+ 'campaignId',
942
+ 'Required parameter requestParameters.campaignId was null or undefined when calling updateCampaignStatus.',
943
+ );
944
+ }
945
+
946
+ if (requestParameters.status === null || requestParameters.status === undefined) {
947
+ throw new runtime.RequiredError(
948
+ 'status',
949
+ 'Required parameter requestParameters.status was null or undefined when calling updateCampaignStatus.',
950
+ );
951
+ }
952
+
953
+ const queryParameters: any = {};
954
+
955
+ const headerParameters: runtime.HTTPHeaders = {};
956
+
957
+ headerParameters['Content-Type'] = 'application/json';
958
+
959
+ if (this.configuration && this.configuration.apiKey) {
960
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
961
+ }
962
+
963
+ const response = await this.request(
964
+ {
965
+ path: `/emailCampaigns/{campaignId}/status`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
966
+ method: 'PUT',
967
+ headers: headerParameters,
968
+ query: queryParameters,
969
+ body: UpdateCampaignStatusToJSON(requestParameters.status),
970
+ },
971
+ initOverrides,
972
+ );
973
+
974
+ return new runtime.VoidApiResponse(response);
975
+ }
976
+
977
+ /**
978
+ * Update an email campaign status
979
+ */
980
+ async updateCampaignStatus(
981
+ requestParameters: UpdateCampaignStatusRequest,
982
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
983
+ ): Promise<void> {
984
+ await this.updateCampaignStatusRaw(requestParameters, initOverrides);
985
+ }
986
+
987
+ /**
988
+ * Update an email campaign
989
+ */
990
+ async updateEmailCampaignRaw(
991
+ requestParameters: UpdateEmailCampaignRequest,
992
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
993
+ ): Promise<runtime.ApiResponse<void>> {
994
+ if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
995
+ throw new runtime.RequiredError(
996
+ 'campaignId',
997
+ 'Required parameter requestParameters.campaignId was null or undefined when calling updateEmailCampaign.',
998
+ );
999
+ }
1000
+
1001
+ if (requestParameters.emailCampaign === null || requestParameters.emailCampaign === undefined) {
1002
+ throw new runtime.RequiredError(
1003
+ 'emailCampaign',
1004
+ 'Required parameter requestParameters.emailCampaign was null or undefined when calling updateEmailCampaign.',
1005
+ );
1006
+ }
1007
+
1008
+ const queryParameters: any = {};
1009
+
1010
+ const headerParameters: runtime.HTTPHeaders = {};
1011
+
1012
+ headerParameters['Content-Type'] = 'application/json';
1013
+
1014
+ if (this.configuration && this.configuration.apiKey) {
1015
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
1016
+ }
1017
+
1018
+ const response = await this.request(
1019
+ {
1020
+ path: `/emailCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
1021
+ method: 'PUT',
1022
+ headers: headerParameters,
1023
+ query: queryParameters,
1024
+ body: UpdateEmailCampaignToJSON(requestParameters.emailCampaign),
1025
+ },
1026
+ initOverrides,
1027
+ );
1028
+
1029
+ return new runtime.VoidApiResponse(response);
1030
+ }
1031
+
1032
+ /**
1033
+ * Update an email campaign
1034
+ */
1035
+ async updateEmailCampaign(
1036
+ requestParameters: UpdateEmailCampaignRequest,
1037
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
1038
+ ): Promise<void> {
1039
+ await this.updateEmailCampaignRaw(requestParameters, initOverrides);
1040
+ }
1041
+
1042
+ /**
1043
+ * Upload an image to your account\'s image gallery
1044
+ */
1045
+ async uploadImageToGalleryRaw(
1046
+ requestParameters: UploadImageToGalleryRequest,
1047
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
1048
+ ): Promise<runtime.ApiResponse<void>> {
1049
+ if (requestParameters.uploadImage === null || requestParameters.uploadImage === undefined) {
1050
+ throw new runtime.RequiredError(
1051
+ 'uploadImage',
1052
+ 'Required parameter requestParameters.uploadImage was null or undefined when calling uploadImageToGallery.',
1053
+ );
1054
+ }
1055
+
1056
+ const queryParameters: any = {};
1057
+
1058
+ const headerParameters: runtime.HTTPHeaders = {};
1059
+
1060
+ headerParameters['Content-Type'] = 'application/json';
1061
+
1062
+ if (this.configuration && this.configuration.apiKey) {
1063
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
1064
+ }
1065
+
1066
+ const response = await this.request(
1067
+ {
1068
+ path: `/emailCampaigns/images`,
1069
+ method: 'POST',
1070
+ headers: headerParameters,
1071
+ query: queryParameters,
1072
+ body: UploadImageToGalleryToJSON(requestParameters.uploadImage),
1073
+ },
1074
+ initOverrides,
1075
+ );
1076
+
1077
+ return new runtime.VoidApiResponse(response);
1078
+ }
1079
+
1080
+ /**
1081
+ * Upload an image to your account\'s image gallery
1082
+ */
1083
+ async uploadImageToGallery(
1084
+ requestParameters: UploadImageToGalleryRequest,
1085
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
1086
+ ): Promise<void> {
1087
+ await this.uploadImageToGalleryRaw(requestParameters, initOverrides);
1088
+ }
1089
+ }
1090
+
1091
+ /**
1092
+ * @export
1093
+ * @enum {string}
1094
+ */
1095
+ export enum GetEmailCampaignStatisticsEnum {
1096
+ GlobalStats = 'globalStats',
1097
+ LinksStats = 'linksStats',
1098
+ StatsByDomain = 'statsByDomain',
1099
+ StatsByDevice = 'statsByDevice',
1100
+ StatsByBrowser = 'statsByBrowser',
1101
+ }
1102
+ /**
1103
+ * @export
1104
+ * @enum {string}
1105
+ */
1106
+ export enum GetEmailCampaignsTypeEnum {
1107
+ Classic = 'classic',
1108
+ Trigger = 'trigger',
1109
+ }
1110
+ /**
1111
+ * @export
1112
+ * @enum {string}
1113
+ */
1114
+ export enum GetEmailCampaignsStatusEnum {
1115
+ Suspended = 'suspended',
1116
+ Archive = 'archive',
1117
+ Sent = 'sent',
1118
+ Queued = 'queued',
1119
+ Draft = 'draft',
1120
+ InProcess = 'inProcess',
1121
+ }
1122
+ /**
1123
+ * @export
1124
+ * @enum {string}
1125
+ */
1126
+ export enum GetEmailCampaignsStatisticsEnum {
1127
+ GlobalStats = 'globalStats',
1128
+ LinksStats = 'linksStats',
1129
+ StatsByDomain = 'statsByDomain',
1130
+ }