@bitblit/ratchet-misc 6.0.146-alpha → 6.0.148-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 +5 -4
  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,770 @@
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
+ AddContactToList,
17
+ CreateList,
18
+ CreateModel,
19
+ GetContacts,
20
+ GetExtendedList,
21
+ GetFolderLists,
22
+ GetLists,
23
+ PostContactInfo,
24
+ RemoveContactFromList,
25
+ UpdateList,
26
+ } from '../models/index.js';
27
+ import {
28
+ AddContactToListToJSON,
29
+ CreateListToJSON,
30
+ CreateModelFromJSON,
31
+ GetContactsFromJSON,
32
+ GetExtendedListFromJSON,
33
+ GetFolderListsFromJSON,
34
+ GetListsFromJSON,
35
+ PostContactInfoFromJSON,
36
+ RemoveContactFromListToJSON,
37
+ UpdateListToJSON,
38
+ } from '../models/index.js';
39
+
40
+ export interface AddContactToListRequest {
41
+ listId: number;
42
+ contactEmails: AddContactToList;
43
+ }
44
+
45
+ export interface CreateListRequest {
46
+ createList: CreateList;
47
+ }
48
+
49
+ export interface DeleteListRequest {
50
+ listId: number;
51
+ }
52
+
53
+ export interface GetContactsFromListRequest {
54
+ listId: number;
55
+ modifiedSince?: Date;
56
+ limit?: number;
57
+ offset?: number;
58
+ sort?: GetContactsFromListSortEnum;
59
+ }
60
+
61
+ export interface GetFolderListsRequest {
62
+ folderId: number;
63
+ limit?: number;
64
+ offset?: number;
65
+ sort?: GetFolderListsSortEnum;
66
+ }
67
+
68
+ export interface GetListRequest {
69
+ listId: number;
70
+ }
71
+
72
+ export interface GetListsRequest {
73
+ limit?: number;
74
+ offset?: number;
75
+ sort?: GetListsSortEnum;
76
+ }
77
+
78
+ export interface RemoveContactFromListRequest {
79
+ listId: number;
80
+ contactEmails: RemoveContactFromList;
81
+ }
82
+
83
+ export interface UpdateListRequest {
84
+ listId: number;
85
+ updateList: UpdateList;
86
+ }
87
+
88
+ /**
89
+ * ListsApi - interface
90
+ *
91
+ * @export
92
+ * @interface ListsApiInterface
93
+ */
94
+ export interface ListsApiInterface {
95
+ /**
96
+ *
97
+ * @summary Add existing contacts to a list
98
+ * @param {number} listId Id of the list
99
+ * @param {AddContactToList} contactEmails Emails addresses of the contacts
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ * @memberof ListsApiInterface
103
+ */
104
+ addContactToListRaw(
105
+ requestParameters: AddContactToListRequest,
106
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
107
+ ): Promise<runtime.ApiResponse<PostContactInfo>>;
108
+
109
+ /**
110
+ * Add existing contacts to a list
111
+ */
112
+ addContactToList(
113
+ requestParameters: AddContactToListRequest,
114
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
115
+ ): Promise<PostContactInfo>;
116
+
117
+ /**
118
+ *
119
+ * @summary Create a list
120
+ * @param {CreateList} createList Values to create a list
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ * @memberof ListsApiInterface
124
+ */
125
+ createListRaw(
126
+ requestParameters: CreateListRequest,
127
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
128
+ ): Promise<runtime.ApiResponse<CreateModel>>;
129
+
130
+ /**
131
+ * Create a list
132
+ */
133
+ createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
134
+
135
+ /**
136
+ *
137
+ * @summary Delete a list
138
+ * @param {number} listId Id of the list
139
+ * @param {*} [options] Override http request option.
140
+ * @throws {RequiredError}
141
+ * @memberof ListsApiInterface
142
+ */
143
+ deleteListRaw(
144
+ requestParameters: DeleteListRequest,
145
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
146
+ ): Promise<runtime.ApiResponse<void>>;
147
+
148
+ /**
149
+ * Delete a list
150
+ */
151
+ deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
152
+
153
+ /**
154
+ *
155
+ * @summary Get contacts in a list
156
+ * @param {number} listId Id of the list
157
+ * @param {Date} [modifiedSince] 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.
158
+ * @param {number} [limit] Number of documents per page
159
+ * @param {number} [offset] Index of the first document of the page
160
+ * @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ * @memberof ListsApiInterface
164
+ */
165
+ getContactsFromListRaw(
166
+ requestParameters: GetContactsFromListRequest,
167
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
168
+ ): Promise<runtime.ApiResponse<GetContacts>>;
169
+
170
+ /**
171
+ * Get contacts in a list
172
+ */
173
+ getContactsFromList(
174
+ requestParameters: GetContactsFromListRequest,
175
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
176
+ ): Promise<GetContacts>;
177
+
178
+ /**
179
+ *
180
+ * @summary Get lists in a folder
181
+ * @param {number} folderId Id of the folder
182
+ * @param {number} [limit] Number of documents per page
183
+ * @param {number} [offset] Index of the first document of the page
184
+ * @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ * @memberof ListsApiInterface
188
+ */
189
+ getFolderListsRaw(
190
+ requestParameters: GetFolderListsRequest,
191
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
192
+ ): Promise<runtime.ApiResponse<GetFolderLists>>;
193
+
194
+ /**
195
+ * Get lists in a folder
196
+ */
197
+ getFolderLists(
198
+ requestParameters: GetFolderListsRequest,
199
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
200
+ ): Promise<GetFolderLists>;
201
+
202
+ /**
203
+ *
204
+ * @summary Get a list\'s details
205
+ * @param {number} listId Id of the list
206
+ * @param {*} [options] Override http request option.
207
+ * @throws {RequiredError}
208
+ * @memberof ListsApiInterface
209
+ */
210
+ getListRaw(
211
+ requestParameters: GetListRequest,
212
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
213
+ ): Promise<runtime.ApiResponse<GetExtendedList>>;
214
+
215
+ /**
216
+ * Get a list\'s details
217
+ */
218
+ getList(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedList>;
219
+
220
+ /**
221
+ *
222
+ * @summary Get all the lists
223
+ * @param {number} [limit] Number of documents per page
224
+ * @param {number} [offset] Index of the first document of the page
225
+ * @param {'asc' | 'desc'} [sort] Sort the results in the ascending/descending order of record creation
226
+ * @param {*} [options] Override http request option.
227
+ * @throws {RequiredError}
228
+ * @memberof ListsApiInterface
229
+ */
230
+ getListsRaw(
231
+ requestParameters: GetListsRequest,
232
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
233
+ ): Promise<runtime.ApiResponse<GetLists>>;
234
+
235
+ /**
236
+ * Get all the lists
237
+ */
238
+ getLists(requestParameters: GetListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLists>;
239
+
240
+ /**
241
+ *
242
+ * @summary Delete a contact from a list
243
+ * @param {number} listId Id of the list
244
+ * @param {RemoveContactFromList} contactEmails Emails adresses of the contact
245
+ * @param {*} [options] Override http request option.
246
+ * @throws {RequiredError}
247
+ * @memberof ListsApiInterface
248
+ */
249
+ removeContactFromListRaw(
250
+ requestParameters: RemoveContactFromListRequest,
251
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
252
+ ): Promise<runtime.ApiResponse<PostContactInfo>>;
253
+
254
+ /**
255
+ * Delete a contact from a list
256
+ */
257
+ removeContactFromList(
258
+ requestParameters: RemoveContactFromListRequest,
259
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
260
+ ): Promise<PostContactInfo>;
261
+
262
+ /**
263
+ *
264
+ * @summary Update a list
265
+ * @param {number} listId Id of the list
266
+ * @param {UpdateList} updateList Values to update a list
267
+ * @param {*} [options] Override http request option.
268
+ * @throws {RequiredError}
269
+ * @memberof ListsApiInterface
270
+ */
271
+ updateListRaw(
272
+ requestParameters: UpdateListRequest,
273
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
274
+ ): Promise<runtime.ApiResponse<void>>;
275
+
276
+ /**
277
+ * Update a list
278
+ */
279
+ updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
280
+ }
281
+
282
+ /**
283
+ *
284
+ */
285
+ export class ListsApi extends runtime.BaseAPI implements ListsApiInterface {
286
+ /**
287
+ * Add existing contacts to a list
288
+ */
289
+ async addContactToListRaw(
290
+ requestParameters: AddContactToListRequest,
291
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
292
+ ): Promise<runtime.ApiResponse<PostContactInfo>> {
293
+ if (requestParameters.listId === null || requestParameters.listId === undefined) {
294
+ throw new runtime.RequiredError(
295
+ 'listId',
296
+ 'Required parameter requestParameters.listId was null or undefined when calling addContactToList.',
297
+ );
298
+ }
299
+
300
+ if (requestParameters.contactEmails === null || requestParameters.contactEmails === undefined) {
301
+ throw new runtime.RequiredError(
302
+ 'contactEmails',
303
+ 'Required parameter requestParameters.contactEmails was null or undefined when calling addContactToList.',
304
+ );
305
+ }
306
+
307
+ const queryParameters: any = {};
308
+
309
+ const headerParameters: runtime.HTTPHeaders = {};
310
+
311
+ headerParameters['Content-Type'] = 'application/json';
312
+
313
+ if (this.configuration && this.configuration.apiKey) {
314
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
315
+ }
316
+
317
+ const response = await this.request(
318
+ {
319
+ path: `/contacts/lists/{listId}/contacts/add`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
320
+ method: 'POST',
321
+ headers: headerParameters,
322
+ query: queryParameters,
323
+ body: AddContactToListToJSON(requestParameters.contactEmails),
324
+ },
325
+ initOverrides,
326
+ );
327
+
328
+ return new runtime.JSONApiResponse(response, (jsonValue) => PostContactInfoFromJSON(jsonValue));
329
+ }
330
+
331
+ /**
332
+ * Add existing contacts to a list
333
+ */
334
+ async addContactToList(
335
+ requestParameters: AddContactToListRequest,
336
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
337
+ ): Promise<PostContactInfo> {
338
+ const response = await this.addContactToListRaw(requestParameters, initOverrides);
339
+ return await response.value();
340
+ }
341
+
342
+ /**
343
+ * Create a list
344
+ */
345
+ async createListRaw(
346
+ requestParameters: CreateListRequest,
347
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
348
+ ): Promise<runtime.ApiResponse<CreateModel>> {
349
+ if (requestParameters.createList === null || requestParameters.createList === undefined) {
350
+ throw new runtime.RequiredError(
351
+ 'createList',
352
+ 'Required parameter requestParameters.createList was null or undefined when calling createList.',
353
+ );
354
+ }
355
+
356
+ const queryParameters: any = {};
357
+
358
+ const headerParameters: runtime.HTTPHeaders = {};
359
+
360
+ headerParameters['Content-Type'] = 'application/json';
361
+
362
+ if (this.configuration && this.configuration.apiKey) {
363
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
364
+ }
365
+
366
+ const response = await this.request(
367
+ {
368
+ path: `/contacts/lists`,
369
+ method: 'POST',
370
+ headers: headerParameters,
371
+ query: queryParameters,
372
+ body: CreateListToJSON(requestParameters.createList),
373
+ },
374
+ initOverrides,
375
+ );
376
+
377
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
378
+ }
379
+
380
+ /**
381
+ * Create a list
382
+ */
383
+ async createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel> {
384
+ const response = await this.createListRaw(requestParameters, initOverrides);
385
+ return await response.value();
386
+ }
387
+
388
+ /**
389
+ * Delete a list
390
+ */
391
+ async deleteListRaw(
392
+ requestParameters: DeleteListRequest,
393
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
394
+ ): Promise<runtime.ApiResponse<void>> {
395
+ if (requestParameters.listId === null || requestParameters.listId === undefined) {
396
+ throw new runtime.RequiredError(
397
+ 'listId',
398
+ 'Required parameter requestParameters.listId was null or undefined when calling deleteList.',
399
+ );
400
+ }
401
+
402
+ const queryParameters: any = {};
403
+
404
+ const headerParameters: runtime.HTTPHeaders = {};
405
+
406
+ if (this.configuration && this.configuration.apiKey) {
407
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
408
+ }
409
+
410
+ const response = await this.request(
411
+ {
412
+ path: `/contacts/lists/{listId}`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
413
+ method: 'DELETE',
414
+ headers: headerParameters,
415
+ query: queryParameters,
416
+ },
417
+ initOverrides,
418
+ );
419
+
420
+ return new runtime.VoidApiResponse(response);
421
+ }
422
+
423
+ /**
424
+ * Delete a list
425
+ */
426
+ async deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
427
+ await this.deleteListRaw(requestParameters, initOverrides);
428
+ }
429
+
430
+ /**
431
+ * Get contacts in a list
432
+ */
433
+ async getContactsFromListRaw(
434
+ requestParameters: GetContactsFromListRequest,
435
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
436
+ ): Promise<runtime.ApiResponse<GetContacts>> {
437
+ if (requestParameters.listId === null || requestParameters.listId === undefined) {
438
+ throw new runtime.RequiredError(
439
+ 'listId',
440
+ 'Required parameter requestParameters.listId was null or undefined when calling getContactsFromList.',
441
+ );
442
+ }
443
+
444
+ const queryParameters: any = {};
445
+
446
+ if (requestParameters.modifiedSince !== undefined) {
447
+ queryParameters['modifiedSince'] = (requestParameters.modifiedSince as any).toISOString();
448
+ }
449
+
450
+ if (requestParameters.limit !== undefined) {
451
+ queryParameters['limit'] = requestParameters.limit;
452
+ }
453
+
454
+ if (requestParameters.offset !== undefined) {
455
+ queryParameters['offset'] = requestParameters.offset;
456
+ }
457
+
458
+ if (requestParameters.sort !== undefined) {
459
+ queryParameters['sort'] = requestParameters.sort;
460
+ }
461
+
462
+ const headerParameters: runtime.HTTPHeaders = {};
463
+
464
+ if (this.configuration && this.configuration.apiKey) {
465
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
466
+ }
467
+
468
+ const response = await this.request(
469
+ {
470
+ path: `/contacts/lists/{listId}/contacts`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
471
+ method: 'GET',
472
+ headers: headerParameters,
473
+ query: queryParameters,
474
+ },
475
+ initOverrides,
476
+ );
477
+
478
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetContactsFromJSON(jsonValue));
479
+ }
480
+
481
+ /**
482
+ * Get contacts in a list
483
+ */
484
+ async getContactsFromList(
485
+ requestParameters: GetContactsFromListRequest,
486
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
487
+ ): Promise<GetContacts> {
488
+ const response = await this.getContactsFromListRaw(requestParameters, initOverrides);
489
+ return await response.value();
490
+ }
491
+
492
+ /**
493
+ * Get lists in a folder
494
+ */
495
+ async getFolderListsRaw(
496
+ requestParameters: GetFolderListsRequest,
497
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
498
+ ): Promise<runtime.ApiResponse<GetFolderLists>> {
499
+ if (requestParameters.folderId === null || requestParameters.folderId === undefined) {
500
+ throw new runtime.RequiredError(
501
+ 'folderId',
502
+ 'Required parameter requestParameters.folderId was null or undefined when calling getFolderLists.',
503
+ );
504
+ }
505
+
506
+ const queryParameters: any = {};
507
+
508
+ if (requestParameters.limit !== undefined) {
509
+ queryParameters['limit'] = requestParameters.limit;
510
+ }
511
+
512
+ if (requestParameters.offset !== undefined) {
513
+ queryParameters['offset'] = requestParameters.offset;
514
+ }
515
+
516
+ if (requestParameters.sort !== undefined) {
517
+ queryParameters['sort'] = requestParameters.sort;
518
+ }
519
+
520
+ const headerParameters: runtime.HTTPHeaders = {};
521
+
522
+ if (this.configuration && this.configuration.apiKey) {
523
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
524
+ }
525
+
526
+ const response = await this.request(
527
+ {
528
+ path: `/contacts/folders/{folderId}/lists`.replace(`{${'folderId'}}`, encodeURIComponent(String(requestParameters.folderId))),
529
+ method: 'GET',
530
+ headers: headerParameters,
531
+ query: queryParameters,
532
+ },
533
+ initOverrides,
534
+ );
535
+
536
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetFolderListsFromJSON(jsonValue));
537
+ }
538
+
539
+ /**
540
+ * Get lists in a folder
541
+ */
542
+ async getFolderLists(
543
+ requestParameters: GetFolderListsRequest,
544
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
545
+ ): Promise<GetFolderLists> {
546
+ const response = await this.getFolderListsRaw(requestParameters, initOverrides);
547
+ return await response.value();
548
+ }
549
+
550
+ /**
551
+ * Get a list\'s details
552
+ */
553
+ async getListRaw(
554
+ requestParameters: GetListRequest,
555
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
556
+ ): Promise<runtime.ApiResponse<GetExtendedList>> {
557
+ if (requestParameters.listId === null || requestParameters.listId === undefined) {
558
+ throw new runtime.RequiredError('listId', 'Required parameter requestParameters.listId was null or undefined when calling getList.');
559
+ }
560
+
561
+ const queryParameters: any = {};
562
+
563
+ const headerParameters: runtime.HTTPHeaders = {};
564
+
565
+ if (this.configuration && this.configuration.apiKey) {
566
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
567
+ }
568
+
569
+ const response = await this.request(
570
+ {
571
+ path: `/contacts/lists/{listId}`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
572
+ method: 'GET',
573
+ headers: headerParameters,
574
+ query: queryParameters,
575
+ },
576
+ initOverrides,
577
+ );
578
+
579
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetExtendedListFromJSON(jsonValue));
580
+ }
581
+
582
+ /**
583
+ * Get a list\'s details
584
+ */
585
+ async getList(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedList> {
586
+ const response = await this.getListRaw(requestParameters, initOverrides);
587
+ return await response.value();
588
+ }
589
+
590
+ /**
591
+ * Get all the lists
592
+ */
593
+ async getListsRaw(
594
+ requestParameters: GetListsRequest,
595
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
596
+ ): Promise<runtime.ApiResponse<GetLists>> {
597
+ const queryParameters: any = {};
598
+
599
+ if (requestParameters.limit !== undefined) {
600
+ queryParameters['limit'] = requestParameters.limit;
601
+ }
602
+
603
+ if (requestParameters.offset !== undefined) {
604
+ queryParameters['offset'] = requestParameters.offset;
605
+ }
606
+
607
+ if (requestParameters.sort !== undefined) {
608
+ queryParameters['sort'] = requestParameters.sort;
609
+ }
610
+
611
+ const headerParameters: runtime.HTTPHeaders = {};
612
+
613
+ if (this.configuration && this.configuration.apiKey) {
614
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
615
+ }
616
+
617
+ const response = await this.request(
618
+ {
619
+ path: `/contacts/lists`,
620
+ method: 'GET',
621
+ headers: headerParameters,
622
+ query: queryParameters,
623
+ },
624
+ initOverrides,
625
+ );
626
+
627
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetListsFromJSON(jsonValue));
628
+ }
629
+
630
+ /**
631
+ * Get all the lists
632
+ */
633
+ async getLists(requestParameters: GetListsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLists> {
634
+ const response = await this.getListsRaw(requestParameters, initOverrides);
635
+ return await response.value();
636
+ }
637
+
638
+ /**
639
+ * Delete a contact from a list
640
+ */
641
+ async removeContactFromListRaw(
642
+ requestParameters: RemoveContactFromListRequest,
643
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
644
+ ): Promise<runtime.ApiResponse<PostContactInfo>> {
645
+ if (requestParameters.listId === null || requestParameters.listId === undefined) {
646
+ throw new runtime.RequiredError(
647
+ 'listId',
648
+ 'Required parameter requestParameters.listId was null or undefined when calling removeContactFromList.',
649
+ );
650
+ }
651
+
652
+ if (requestParameters.contactEmails === null || requestParameters.contactEmails === undefined) {
653
+ throw new runtime.RequiredError(
654
+ 'contactEmails',
655
+ 'Required parameter requestParameters.contactEmails was null or undefined when calling removeContactFromList.',
656
+ );
657
+ }
658
+
659
+ const queryParameters: any = {};
660
+
661
+ const headerParameters: runtime.HTTPHeaders = {};
662
+
663
+ headerParameters['Content-Type'] = 'application/json';
664
+
665
+ if (this.configuration && this.configuration.apiKey) {
666
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
667
+ }
668
+
669
+ const response = await this.request(
670
+ {
671
+ path: `/contacts/lists/{listId}/contacts/remove`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
672
+ method: 'POST',
673
+ headers: headerParameters,
674
+ query: queryParameters,
675
+ body: RemoveContactFromListToJSON(requestParameters.contactEmails),
676
+ },
677
+ initOverrides,
678
+ );
679
+
680
+ return new runtime.JSONApiResponse(response, (jsonValue) => PostContactInfoFromJSON(jsonValue));
681
+ }
682
+
683
+ /**
684
+ * Delete a contact from a list
685
+ */
686
+ async removeContactFromList(
687
+ requestParameters: RemoveContactFromListRequest,
688
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
689
+ ): Promise<PostContactInfo> {
690
+ const response = await this.removeContactFromListRaw(requestParameters, initOverrides);
691
+ return await response.value();
692
+ }
693
+
694
+ /**
695
+ * Update a list
696
+ */
697
+ async updateListRaw(
698
+ requestParameters: UpdateListRequest,
699
+ initOverrides?: RequestInit | runtime.InitOverrideFunction,
700
+ ): Promise<runtime.ApiResponse<void>> {
701
+ if (requestParameters.listId === null || requestParameters.listId === undefined) {
702
+ throw new runtime.RequiredError(
703
+ 'listId',
704
+ 'Required parameter requestParameters.listId was null or undefined when calling updateList.',
705
+ );
706
+ }
707
+
708
+ if (requestParameters.updateList === null || requestParameters.updateList === undefined) {
709
+ throw new runtime.RequiredError(
710
+ 'updateList',
711
+ 'Required parameter requestParameters.updateList was null or undefined when calling updateList.',
712
+ );
713
+ }
714
+
715
+ const queryParameters: any = {};
716
+
717
+ const headerParameters: runtime.HTTPHeaders = {};
718
+
719
+ headerParameters['Content-Type'] = 'application/json';
720
+
721
+ if (this.configuration && this.configuration.apiKey) {
722
+ headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
723
+ }
724
+
725
+ const response = await this.request(
726
+ {
727
+ path: `/contacts/lists/{listId}`.replace(`{${'listId'}}`, encodeURIComponent(String(requestParameters.listId))),
728
+ method: 'PUT',
729
+ headers: headerParameters,
730
+ query: queryParameters,
731
+ body: UpdateListToJSON(requestParameters.updateList),
732
+ },
733
+ initOverrides,
734
+ );
735
+
736
+ return new runtime.VoidApiResponse(response);
737
+ }
738
+
739
+ /**
740
+ * Update a list
741
+ */
742
+ async updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
743
+ await this.updateListRaw(requestParameters, initOverrides);
744
+ }
745
+ }
746
+
747
+ /**
748
+ * @export
749
+ * @enum {string}
750
+ */
751
+ export enum GetContactsFromListSortEnum {
752
+ Asc = 'asc',
753
+ Desc = 'desc',
754
+ }
755
+ /**
756
+ * @export
757
+ * @enum {string}
758
+ */
759
+ export enum GetFolderListsSortEnum {
760
+ Asc = 'asc',
761
+ Desc = 'desc',
762
+ }
763
+ /**
764
+ * @export
765
+ * @enum {string}
766
+ */
767
+ export enum GetListsSortEnum {
768
+ Asc = 'asc',
769
+ Desc = 'desc',
770
+ }