@novu/api 0.0.1-alpha.149 → 0.0.1-alpha.155

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 (633) hide show
  1. package/README.md +1 -1
  2. package/RUNTIMES.md +27 -1
  3. package/docs/sdks/credentials/README.md +39 -24
  4. package/docs/sdks/integrations/README.md +15 -5
  5. package/docs/sdks/messages/README.md +8 -4
  6. package/docs/sdks/notifications/README.md +1 -0
  7. package/docs/sdks/novu/README.md +7 -3
  8. package/docs/sdks/novumessages/README.md +24 -14
  9. package/docs/sdks/novusubscribers/README.md +45 -30
  10. package/docs/sdks/preferences/README.md +16 -8
  11. package/docs/sdks/properties/README.md +11 -6
  12. package/docs/sdks/stats/README.md +2 -0
  13. package/docs/sdks/subscribers/README.md +52 -42
  14. package/docs/sdks/topics/README.md +15 -7
  15. package/docs/sdks/webhooks/README.md +1 -0
  16. package/funcs/cancel.d.ts +1 -1
  17. package/funcs/cancel.d.ts.map +1 -1
  18. package/funcs/cancel.js +8 -6
  19. package/funcs/cancel.js.map +1 -1
  20. package/funcs/integrationsCreate.d.ts +1 -1
  21. package/funcs/integrationsCreate.d.ts.map +1 -1
  22. package/funcs/integrationsCreate.js +16 -9
  23. package/funcs/integrationsCreate.js.map +1 -1
  24. package/funcs/integrationsDelete.d.ts +1 -1
  25. package/funcs/integrationsDelete.d.ts.map +1 -1
  26. package/funcs/integrationsDelete.js +8 -6
  27. package/funcs/integrationsDelete.js.map +1 -1
  28. package/funcs/integrationsList.d.ts +1 -1
  29. package/funcs/integrationsList.d.ts.map +1 -1
  30. package/funcs/integrationsList.js +20 -6
  31. package/funcs/integrationsList.js.map +1 -1
  32. package/funcs/integrationsListActive.d.ts +1 -1
  33. package/funcs/integrationsListActive.d.ts.map +1 -1
  34. package/funcs/integrationsListActive.js +21 -6
  35. package/funcs/integrationsListActive.js.map +1 -1
  36. package/funcs/integrationsSetAsPrimary.d.ts +1 -1
  37. package/funcs/integrationsSetAsPrimary.d.ts.map +1 -1
  38. package/funcs/integrationsSetAsPrimary.js +8 -6
  39. package/funcs/integrationsSetAsPrimary.js.map +1 -1
  40. package/funcs/integrationsUpdate.d.ts +1 -2
  41. package/funcs/integrationsUpdate.d.ts.map +1 -1
  42. package/funcs/integrationsUpdate.js +8 -11
  43. package/funcs/integrationsUpdate.js.map +1 -1
  44. package/funcs/integrationsWebhooksRetrieve.d.ts +1 -1
  45. package/funcs/integrationsWebhooksRetrieve.d.ts.map +1 -1
  46. package/funcs/integrationsWebhooksRetrieve.js +8 -6
  47. package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
  48. package/funcs/messagesDelete.d.ts +1 -1
  49. package/funcs/messagesDelete.d.ts.map +1 -1
  50. package/funcs/messagesDelete.js +8 -6
  51. package/funcs/messagesDelete.js.map +1 -1
  52. package/funcs/messagesDeleteByTransactionId.d.ts +1 -1
  53. package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
  54. package/funcs/messagesDeleteByTransactionId.js +8 -11
  55. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  56. package/funcs/messagesRetrieve.d.ts.map +1 -1
  57. package/funcs/messagesRetrieve.js +6 -5
  58. package/funcs/messagesRetrieve.js.map +1 -1
  59. package/funcs/notificationsList.d.ts.map +1 -1
  60. package/funcs/notificationsList.js +6 -5
  61. package/funcs/notificationsList.js.map +1 -1
  62. package/funcs/notificationsRetrieve.d.ts +1 -1
  63. package/funcs/notificationsRetrieve.d.ts.map +1 -1
  64. package/funcs/notificationsRetrieve.js +8 -6
  65. package/funcs/notificationsRetrieve.js.map +1 -1
  66. package/funcs/notificationsStatsGraph.d.ts +1 -1
  67. package/funcs/notificationsStatsGraph.d.ts.map +1 -1
  68. package/funcs/notificationsStatsGraph.js +8 -6
  69. package/funcs/notificationsStatsGraph.js.map +1 -1
  70. package/funcs/notificationsStatsRetrieve.d.ts +1 -1
  71. package/funcs/notificationsStatsRetrieve.d.ts.map +1 -1
  72. package/funcs/notificationsStatsRetrieve.js +20 -6
  73. package/funcs/notificationsStatsRetrieve.js.map +1 -1
  74. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
  75. package/funcs/subscribersAuthenticationChatAccessOauth.js +6 -5
  76. package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
  77. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
  78. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +7 -6
  79. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +1 -1
  80. package/funcs/subscribersCreate.d.ts +1 -1
  81. package/funcs/subscribersCreate.d.ts.map +1 -1
  82. package/funcs/subscribersCreate.js +16 -9
  83. package/funcs/subscribersCreate.js.map +1 -1
  84. package/funcs/subscribersCreateBulk.d.ts +1 -1
  85. package/funcs/subscribersCreateBulk.d.ts.map +1 -1
  86. package/funcs/subscribersCreateBulk.js +16 -9
  87. package/funcs/subscribersCreateBulk.js.map +1 -1
  88. package/funcs/subscribersCredentialsAppend.d.ts +1 -2
  89. package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
  90. package/funcs/subscribersCredentialsAppend.js +8 -11
  91. package/funcs/subscribersCredentialsAppend.js.map +1 -1
  92. package/funcs/subscribersCredentialsDelete.d.ts +1 -1
  93. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  94. package/funcs/subscribersCredentialsDelete.js +8 -11
  95. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  96. package/funcs/subscribersCredentialsUpdate.d.ts +1 -2
  97. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  98. package/funcs/subscribersCredentialsUpdate.js +8 -11
  99. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  100. package/funcs/subscribersDelete.d.ts +1 -1
  101. package/funcs/subscribersDelete.d.ts.map +1 -1
  102. package/funcs/subscribersDelete.js +8 -6
  103. package/funcs/subscribersDelete.js.map +1 -1
  104. package/funcs/subscribersList.d.ts +1 -1
  105. package/funcs/subscribersList.d.ts.map +1 -1
  106. package/funcs/subscribersList.js +16 -16
  107. package/funcs/subscribersList.js.map +1 -1
  108. package/funcs/subscribersMessagesMarkAll.d.ts +1 -2
  109. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  110. package/funcs/subscribersMessagesMarkAll.js +8 -11
  111. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  112. package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -2
  113. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  114. package/funcs/subscribersMessagesMarkAllAs.js +8 -11
  115. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  116. package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  117. package/funcs/subscribersMessagesUpdateAsSeen.js +6 -5
  118. package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
  119. package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
  120. package/funcs/subscribersNotificationsFeed.js +6 -5
  121. package/funcs/subscribersNotificationsFeed.js.map +1 -1
  122. package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  123. package/funcs/subscribersNotificationsUnseenCount.js +6 -5
  124. package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
  125. package/funcs/subscribersPreferencesList.d.ts +1 -1
  126. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  127. package/funcs/subscribersPreferencesList.js +8 -11
  128. package/funcs/subscribersPreferencesList.js.map +1 -1
  129. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
  130. package/funcs/subscribersPreferencesRetrieveByLevel.js +6 -5
  131. package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
  132. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  133. package/funcs/subscribersPreferencesUpdate.js +6 -5
  134. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  135. package/funcs/subscribersPreferencesUpdateGlobal.d.ts +1 -2
  136. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
  137. package/funcs/subscribersPreferencesUpdateGlobal.js +8 -11
  138. package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
  139. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -2
  140. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
  141. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +8 -11
  142. package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  143. package/funcs/subscribersRetrieve.d.ts +1 -1
  144. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  145. package/funcs/subscribersRetrieve.js +8 -11
  146. package/funcs/subscribersRetrieve.js.map +1 -1
  147. package/funcs/subscribersUpdate.d.ts +1 -2
  148. package/funcs/subscribersUpdate.d.ts.map +1 -1
  149. package/funcs/subscribersUpdate.js +8 -11
  150. package/funcs/subscribersUpdate.js.map +1 -1
  151. package/funcs/topicsCreate.d.ts +1 -1
  152. package/funcs/topicsCreate.d.ts.map +1 -1
  153. package/funcs/topicsCreate.js +15 -9
  154. package/funcs/topicsCreate.js.map +1 -1
  155. package/funcs/topicsDelete.d.ts +1 -1
  156. package/funcs/topicsDelete.d.ts.map +1 -1
  157. package/funcs/topicsDelete.js +8 -6
  158. package/funcs/topicsDelete.js.map +1 -1
  159. package/funcs/topicsList.d.ts.map +1 -1
  160. package/funcs/topicsList.js +6 -5
  161. package/funcs/topicsList.js.map +1 -1
  162. package/funcs/topicsRename.d.ts +1 -2
  163. package/funcs/topicsRename.d.ts.map +1 -1
  164. package/funcs/topicsRename.js +8 -11
  165. package/funcs/topicsRename.js.map +1 -1
  166. package/funcs/topicsRetrieve.d.ts +1 -1
  167. package/funcs/topicsRetrieve.d.ts.map +1 -1
  168. package/funcs/topicsRetrieve.js +8 -6
  169. package/funcs/topicsRetrieve.js.map +1 -1
  170. package/funcs/topicsSubscribersAssign.d.ts +1 -2
  171. package/funcs/topicsSubscribersAssign.d.ts.map +1 -1
  172. package/funcs/topicsSubscribersAssign.js +8 -11
  173. package/funcs/topicsSubscribersAssign.js.map +1 -1
  174. package/funcs/topicsSubscribersRemove.d.ts +1 -2
  175. package/funcs/topicsSubscribersRemove.d.ts.map +1 -1
  176. package/funcs/topicsSubscribersRemove.js +8 -11
  177. package/funcs/topicsSubscribersRemove.js.map +1 -1
  178. package/funcs/topicsSubscribersRetrieve.d.ts +1 -1
  179. package/funcs/topicsSubscribersRetrieve.d.ts.map +1 -1
  180. package/funcs/topicsSubscribersRetrieve.js +8 -11
  181. package/funcs/topicsSubscribersRetrieve.js.map +1 -1
  182. package/funcs/trigger.d.ts +1 -1
  183. package/funcs/trigger.d.ts.map +1 -1
  184. package/funcs/trigger.js +15 -9
  185. package/funcs/trigger.js.map +1 -1
  186. package/funcs/triggerBroadcast.d.ts +1 -1
  187. package/funcs/triggerBroadcast.d.ts.map +1 -1
  188. package/funcs/triggerBroadcast.js +16 -9
  189. package/funcs/triggerBroadcast.js.map +1 -1
  190. package/funcs/triggerBulk.d.ts +1 -1
  191. package/funcs/triggerBulk.d.ts.map +1 -1
  192. package/funcs/triggerBulk.js +15 -9
  193. package/funcs/triggerBulk.js.map +1 -1
  194. package/lib/config.d.ts +3 -3
  195. package/lib/config.js +4 -5
  196. package/lib/config.js.map +1 -1
  197. package/lib/encodings.js +18 -19
  198. package/lib/encodings.js.map +1 -1
  199. package/lib/http.js +1 -2
  200. package/lib/http.js.map +1 -1
  201. package/lib/matchers.js +5 -6
  202. package/lib/matchers.js.map +1 -1
  203. package/lib/primitives.js +1 -1
  204. package/lib/primitives.js.map +1 -1
  205. package/lib/retries.js +3 -4
  206. package/lib/retries.js.map +1 -1
  207. package/lib/sdks.js +15 -16
  208. package/lib/sdks.js.map +1 -1
  209. package/lib/security.js +1 -1
  210. package/lib/security.js.map +1 -1
  211. package/lib/url.js +1 -1
  212. package/lib/url.js.map +1 -1
  213. package/models/components/activitynotificationexecutiondetailresponsedto.d.ts +0 -5
  214. package/models/components/activitynotificationexecutiondetailresponsedto.d.ts.map +1 -1
  215. package/models/components/activitynotificationexecutiondetailresponsedto.js +0 -4
  216. package/models/components/activitynotificationexecutiondetailresponsedto.js.map +1 -1
  217. package/models/components/activitynotificationjobresponsedto.d.ts +49 -19
  218. package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
  219. package/models/components/activitynotificationjobresponsedto.js +29 -23
  220. package/models/components/activitynotificationjobresponsedto.js.map +1 -1
  221. package/models/components/builderfieldtype.d.ts +46 -0
  222. package/models/components/builderfieldtype.d.ts.map +1 -0
  223. package/models/components/builderfieldtype.js +56 -0
  224. package/models/components/builderfieldtype.js.map +1 -0
  225. package/models/components/createintegrationrequestdto.d.ts +3 -3
  226. package/models/components/createintegrationrequestdto.d.ts.map +1 -1
  227. package/models/components/createintegrationrequestdto.js +3 -3
  228. package/models/components/createintegrationrequestdto.js.map +1 -1
  229. package/models/components/digestregularmetadata.d.ts +8 -8
  230. package/models/components/digestregularmetadata.d.ts.map +1 -1
  231. package/models/components/digestregularmetadata.js +13 -13
  232. package/models/components/digestregularmetadata.js.map +1 -1
  233. package/models/components/digestwitheventsdto.d.ts +95 -0
  234. package/models/components/digestwitheventsdto.d.ts.map +1 -0
  235. package/models/components/digestwitheventsdto.js +91 -0
  236. package/models/components/digestwitheventsdto.js.map +1 -0
  237. package/models/components/fieldfilterpartdto.d.ts +122 -0
  238. package/models/components/fieldfilterpartdto.d.ts.map +1 -0
  239. package/models/components/fieldfilterpartdto.js +116 -0
  240. package/models/components/fieldfilterpartdto.js.map +1 -0
  241. package/models/components/index.d.ts +4 -0
  242. package/models/components/index.d.ts.map +1 -1
  243. package/models/components/index.js +4 -0
  244. package/models/components/index.js.map +1 -1
  245. package/models/components/integrationresponsedto.d.ts +3 -3
  246. package/models/components/integrationresponsedto.d.ts.map +1 -1
  247. package/models/components/integrationresponsedto.js +3 -3
  248. package/models/components/integrationresponsedto.js.map +1 -1
  249. package/models/components/notificationstep.d.ts +3 -3
  250. package/models/components/notificationstep.d.ts.map +1 -1
  251. package/models/components/notificationstep.js +3 -3
  252. package/models/components/notificationstep.js.map +1 -1
  253. package/models/components/notificationstepvariant.d.ts +3 -3
  254. package/models/components/notificationstepvariant.d.ts.map +1 -1
  255. package/models/components/notificationstepvariant.js +3 -3
  256. package/models/components/notificationstepvariant.js.map +1 -1
  257. package/models/components/notificationtriggervariableresponse.d.ts +15 -15
  258. package/models/components/notificationtriggervariableresponse.d.ts.map +1 -1
  259. package/models/components/notificationtriggervariableresponse.js +20 -19
  260. package/models/components/notificationtriggervariableresponse.js.map +1 -1
  261. package/models/components/stepfilterdto.d.ts +63 -0
  262. package/models/components/stepfilterdto.d.ts.map +1 -0
  263. package/models/components/stepfilterdto.js +86 -0
  264. package/models/components/stepfilterdto.js.map +1 -0
  265. package/models/components/updateintegrationrequestdto.d.ts +3 -3
  266. package/models/components/updateintegrationrequestdto.d.ts.map +1 -1
  267. package/models/components/updateintegrationrequestdto.js +3 -3
  268. package/models/components/updateintegrationrequestdto.js.map +1 -1
  269. package/models/errors/httpclienterrors.js +2 -2
  270. package/models/errors/httpclienterrors.js.map +1 -1
  271. package/models/operations/eventscontrollerbroadcasteventtoall.d.ts +30 -0
  272. package/models/operations/eventscontrollerbroadcasteventtoall.d.ts.map +1 -1
  273. package/models/operations/eventscontrollerbroadcasteventtoall.js +40 -1
  274. package/models/operations/eventscontrollerbroadcasteventtoall.js.map +1 -1
  275. package/models/operations/eventscontrollercancel.d.ts +5 -0
  276. package/models/operations/eventscontrollercancel.d.ts.map +1 -1
  277. package/models/operations/eventscontrollercancel.js +10 -0
  278. package/models/operations/eventscontrollercancel.js.map +1 -1
  279. package/models/operations/eventscontrollertrigger.d.ts +30 -0
  280. package/models/operations/eventscontrollertrigger.d.ts.map +1 -1
  281. package/models/operations/eventscontrollertrigger.js +40 -1
  282. package/models/operations/eventscontrollertrigger.js.map +1 -1
  283. package/models/operations/eventscontrollertriggerbulk.d.ts +30 -0
  284. package/models/operations/eventscontrollertriggerbulk.d.ts.map +1 -1
  285. package/models/operations/eventscontrollertriggerbulk.js +40 -1
  286. package/models/operations/eventscontrollertriggerbulk.js.map +1 -1
  287. package/models/operations/integrationscontrollercreateintegration.d.ts +30 -0
  288. package/models/operations/integrationscontrollercreateintegration.d.ts.map +1 -1
  289. package/models/operations/integrationscontrollercreateintegration.js +40 -1
  290. package/models/operations/integrationscontrollercreateintegration.js.map +1 -1
  291. package/models/operations/integrationscontrollergetactiveintegrations.d.ts +28 -0
  292. package/models/operations/integrationscontrollergetactiveintegrations.d.ts.map +1 -1
  293. package/models/operations/integrationscontrollergetactiveintegrations.js +36 -1
  294. package/models/operations/integrationscontrollergetactiveintegrations.js.map +1 -1
  295. package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts +5 -0
  296. package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts.map +1 -1
  297. package/models/operations/integrationscontrollergetwebhooksupportstatus.js +10 -0
  298. package/models/operations/integrationscontrollergetwebhooksupportstatus.js.map +1 -1
  299. package/models/operations/integrationscontrollerlistintegrations.d.ts +28 -0
  300. package/models/operations/integrationscontrollerlistintegrations.d.ts.map +1 -1
  301. package/models/operations/integrationscontrollerlistintegrations.js +36 -1
  302. package/models/operations/integrationscontrollerlistintegrations.js.map +1 -1
  303. package/models/operations/integrationscontrollerremoveintegration.d.ts +5 -0
  304. package/models/operations/integrationscontrollerremoveintegration.d.ts.map +1 -1
  305. package/models/operations/integrationscontrollerremoveintegration.js +10 -0
  306. package/models/operations/integrationscontrollerremoveintegration.js.map +1 -1
  307. package/models/operations/integrationscontrollersetintegrationasprimary.d.ts +5 -0
  308. package/models/operations/integrationscontrollersetintegrationasprimary.d.ts.map +1 -1
  309. package/models/operations/integrationscontrollersetintegrationasprimary.js +10 -0
  310. package/models/operations/integrationscontrollersetintegrationasprimary.js.map +1 -1
  311. package/models/operations/integrationscontrollerupdateintegrationbyid.d.ts +5 -0
  312. package/models/operations/integrationscontrollerupdateintegrationbyid.d.ts.map +1 -1
  313. package/models/operations/integrationscontrollerupdateintegrationbyid.js +4 -0
  314. package/models/operations/integrationscontrollerupdateintegrationbyid.js.map +1 -1
  315. package/models/operations/messagescontrollerdeletemessage.d.ts +5 -0
  316. package/models/operations/messagescontrollerdeletemessage.d.ts.map +1 -1
  317. package/models/operations/messagescontrollerdeletemessage.js +10 -0
  318. package/models/operations/messagescontrollerdeletemessage.js.map +1 -1
  319. package/models/operations/messagescontrollerdeletemessagesbytransactionid.d.ts +5 -0
  320. package/models/operations/messagescontrollerdeletemessagesbytransactionid.d.ts.map +1 -1
  321. package/models/operations/messagescontrollerdeletemessagesbytransactionid.js +10 -0
  322. package/models/operations/messagescontrollerdeletemessagesbytransactionid.js.map +1 -1
  323. package/models/operations/messagescontrollergetmessages.d.ts +5 -0
  324. package/models/operations/messagescontrollergetmessages.d.ts.map +1 -1
  325. package/models/operations/messagescontrollergetmessages.js +10 -0
  326. package/models/operations/messagescontrollergetmessages.js.map +1 -1
  327. package/models/operations/notificationscontrollergetactivitygraphstats.d.ts +5 -0
  328. package/models/operations/notificationscontrollergetactivitygraphstats.d.ts.map +1 -1
  329. package/models/operations/notificationscontrollergetactivitygraphstats.js +10 -0
  330. package/models/operations/notificationscontrollergetactivitygraphstats.js.map +1 -1
  331. package/models/operations/notificationscontrollergetactivitystats.d.ts +28 -0
  332. package/models/operations/notificationscontrollergetactivitystats.d.ts.map +1 -1
  333. package/models/operations/notificationscontrollergetactivitystats.js +36 -1
  334. package/models/operations/notificationscontrollergetactivitystats.js.map +1 -1
  335. package/models/operations/notificationscontrollergetnotification.d.ts +5 -0
  336. package/models/operations/notificationscontrollergetnotification.d.ts.map +1 -1
  337. package/models/operations/notificationscontrollergetnotification.js +10 -0
  338. package/models/operations/notificationscontrollergetnotification.js.map +1 -1
  339. package/models/operations/notificationscontrollerlistnotifications.d.ts +5 -0
  340. package/models/operations/notificationscontrollerlistnotifications.d.ts.map +1 -1
  341. package/models/operations/notificationscontrollerlistnotifications.js +10 -0
  342. package/models/operations/notificationscontrollerlistnotifications.js.map +1 -1
  343. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +30 -0
  344. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +1 -1
  345. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +40 -1
  346. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +1 -1
  347. package/models/operations/subscriberscontrollerchataccessoauth.d.ts +5 -0
  348. package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +1 -1
  349. package/models/operations/subscriberscontrollerchataccessoauth.js +10 -0
  350. package/models/operations/subscriberscontrollerchataccessoauth.js.map +1 -1
  351. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +5 -0
  352. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +1 -1
  353. package/models/operations/subscriberscontrollerchatoauthcallback.js +10 -0
  354. package/models/operations/subscriberscontrollerchatoauthcallback.js.map +1 -1
  355. package/models/operations/subscriberscontrollercreatesubscriber.d.ts +30 -0
  356. package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +1 -1
  357. package/models/operations/subscriberscontrollercreatesubscriber.js +40 -1
  358. package/models/operations/subscriberscontrollercreatesubscriber.js.map +1 -1
  359. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +5 -0
  360. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +1 -1
  361. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +10 -0
  362. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +1 -1
  363. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +5 -0
  364. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +1 -1
  365. package/models/operations/subscriberscontrollergetnotificationsfeed.js +10 -0
  366. package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +1 -1
  367. package/models/operations/subscriberscontrollergetsubscriber.d.ts +5 -0
  368. package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
  369. package/models/operations/subscriberscontrollergetsubscriber.js +10 -0
  370. package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
  371. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +5 -0
  372. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +1 -1
  373. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +10 -0
  374. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +1 -1
  375. package/models/operations/subscriberscontrollergetunseencount.d.ts +5 -0
  376. package/models/operations/subscriberscontrollergetunseencount.d.ts.map +1 -1
  377. package/models/operations/subscriberscontrollergetunseencount.js +10 -0
  378. package/models/operations/subscriberscontrollergetunseencount.js.map +1 -1
  379. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +5 -0
  380. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +1 -1
  381. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +10 -0
  382. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +1 -1
  383. package/models/operations/subscriberscontrollerlistsubscribers.d.ts +5 -0
  384. package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +1 -1
  385. package/models/operations/subscriberscontrollerlistsubscribers.js +10 -0
  386. package/models/operations/subscriberscontrollerlistsubscribers.js.map +1 -1
  387. package/models/operations/subscriberscontrollermarkactionasseen.d.ts +5 -0
  388. package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +1 -1
  389. package/models/operations/subscriberscontrollermarkactionasseen.js +4 -0
  390. package/models/operations/subscriberscontrollermarkactionasseen.js.map +1 -1
  391. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +5 -0
  392. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +1 -1
  393. package/models/operations/subscriberscontrollermarkallunreadasread.js +4 -0
  394. package/models/operations/subscriberscontrollermarkallunreadasread.js.map +1 -1
  395. package/models/operations/subscriberscontrollermarkmessagesas.d.ts +5 -0
  396. package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +1 -1
  397. package/models/operations/subscriberscontrollermarkmessagesas.js +4 -0
  398. package/models/operations/subscriberscontrollermarkmessagesas.js.map +1 -1
  399. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +5 -0
  400. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +1 -1
  401. package/models/operations/subscriberscontrollermodifysubscriberchannel.js +4 -0
  402. package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +1 -1
  403. package/models/operations/subscriberscontrollerremovesubscriber.d.ts +5 -0
  404. package/models/operations/subscriberscontrollerremovesubscriber.d.ts.map +1 -1
  405. package/models/operations/subscriberscontrollerremovesubscriber.js +10 -0
  406. package/models/operations/subscriberscontrollerremovesubscriber.js.map +1 -1
  407. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +5 -0
  408. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +1 -1
  409. package/models/operations/subscriberscontrollerupdatesubscriber.js +4 -0
  410. package/models/operations/subscriberscontrollerupdatesubscriber.js.map +1 -1
  411. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +5 -0
  412. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +1 -1
  413. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +4 -0
  414. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +1 -1
  415. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +5 -0
  416. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +1 -1
  417. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +4 -0
  418. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +1 -1
  419. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +5 -0
  420. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +1 -1
  421. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +4 -0
  422. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +1 -1
  423. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +5 -0
  424. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +1 -1
  425. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +4 -0
  426. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +1 -1
  427. package/models/operations/topicscontrollerassign.d.ts +5 -0
  428. package/models/operations/topicscontrollerassign.d.ts.map +1 -1
  429. package/models/operations/topicscontrollerassign.js +4 -0
  430. package/models/operations/topicscontrollerassign.js.map +1 -1
  431. package/models/operations/topicscontrollercreatetopic.d.ts +30 -0
  432. package/models/operations/topicscontrollercreatetopic.d.ts.map +1 -1
  433. package/models/operations/topicscontrollercreatetopic.js +40 -1
  434. package/models/operations/topicscontrollercreatetopic.js.map +1 -1
  435. package/models/operations/topicscontrollerdeletetopic.d.ts +5 -0
  436. package/models/operations/topicscontrollerdeletetopic.d.ts.map +1 -1
  437. package/models/operations/topicscontrollerdeletetopic.js +10 -0
  438. package/models/operations/topicscontrollerdeletetopic.js.map +1 -1
  439. package/models/operations/topicscontrollergettopic.d.ts +5 -0
  440. package/models/operations/topicscontrollergettopic.d.ts.map +1 -1
  441. package/models/operations/topicscontrollergettopic.js +10 -0
  442. package/models/operations/topicscontrollergettopic.js.map +1 -1
  443. package/models/operations/topicscontrollergettopicsubscriber.d.ts +5 -0
  444. package/models/operations/topicscontrollergettopicsubscriber.d.ts.map +1 -1
  445. package/models/operations/topicscontrollergettopicsubscriber.js +10 -0
  446. package/models/operations/topicscontrollergettopicsubscriber.js.map +1 -1
  447. package/models/operations/topicscontrollerlisttopics.d.ts +5 -0
  448. package/models/operations/topicscontrollerlisttopics.d.ts.map +1 -1
  449. package/models/operations/topicscontrollerlisttopics.js +10 -0
  450. package/models/operations/topicscontrollerlisttopics.js.map +1 -1
  451. package/models/operations/topicscontrollerremovesubscribers.d.ts +5 -0
  452. package/models/operations/topicscontrollerremovesubscribers.d.ts.map +1 -1
  453. package/models/operations/topicscontrollerremovesubscribers.js +4 -0
  454. package/models/operations/topicscontrollerremovesubscribers.js.map +1 -1
  455. package/models/operations/topicscontrollerrenametopic.d.ts +5 -0
  456. package/models/operations/topicscontrollerrenametopic.d.ts.map +1 -1
  457. package/models/operations/topicscontrollerrenametopic.js +4 -0
  458. package/models/operations/topicscontrollerrenametopic.js.map +1 -1
  459. package/package.json +1 -1
  460. package/sdk/credentials.d.ts +3 -4
  461. package/sdk/credentials.d.ts.map +1 -1
  462. package/sdk/credentials.js +6 -6
  463. package/sdk/credentials.js.map +1 -1
  464. package/sdk/integrations.d.ts +6 -6
  465. package/sdk/integrations.d.ts.map +1 -1
  466. package/sdk/integrations.js +13 -14
  467. package/sdk/integrations.js.map +1 -1
  468. package/sdk/messages.d.ts +2 -2
  469. package/sdk/messages.d.ts.map +1 -1
  470. package/sdk/messages.js +4 -4
  471. package/sdk/messages.js.map +1 -1
  472. package/sdk/notifications.d.ts +1 -1
  473. package/sdk/notifications.d.ts.map +1 -1
  474. package/sdk/notifications.js +3 -4
  475. package/sdk/notifications.js.map +1 -1
  476. package/sdk/novumessages.d.ts +2 -3
  477. package/sdk/novumessages.d.ts.map +1 -1
  478. package/sdk/novumessages.js +4 -4
  479. package/sdk/novumessages.js.map +1 -1
  480. package/sdk/novusubscribers.d.ts +3 -4
  481. package/sdk/novusubscribers.d.ts.map +1 -1
  482. package/sdk/novusubscribers.js +6 -6
  483. package/sdk/novusubscribers.js.map +1 -1
  484. package/sdk/preferences.d.ts +2 -3
  485. package/sdk/preferences.d.ts.map +1 -1
  486. package/sdk/preferences.js +4 -4
  487. package/sdk/preferences.js.map +1 -1
  488. package/sdk/properties.d.ts +1 -2
  489. package/sdk/properties.d.ts.map +1 -1
  490. package/sdk/properties.js +2 -2
  491. package/sdk/properties.js.map +1 -1
  492. package/sdk/sdk.d.ts +4 -4
  493. package/sdk/sdk.d.ts.map +1 -1
  494. package/sdk/sdk.js +13 -18
  495. package/sdk/sdk.js.map +1 -1
  496. package/sdk/stats.d.ts +2 -2
  497. package/sdk/stats.d.ts.map +1 -1
  498. package/sdk/stats.js +4 -4
  499. package/sdk/stats.js.map +1 -1
  500. package/sdk/subscribers.d.ts +6 -6
  501. package/sdk/subscribers.d.ts.map +1 -1
  502. package/sdk/subscribers.js +18 -24
  503. package/sdk/subscribers.js.map +1 -1
  504. package/sdk/topics.d.ts +4 -4
  505. package/sdk/topics.d.ts.map +1 -1
  506. package/sdk/topics.js +9 -10
  507. package/sdk/topics.js.map +1 -1
  508. package/sdk/webhooks.d.ts +1 -1
  509. package/sdk/webhooks.d.ts.map +1 -1
  510. package/sdk/webhooks.js +2 -2
  511. package/sdk/webhooks.js.map +1 -1
  512. package/src/funcs/cancel.ts +9 -2
  513. package/src/funcs/integrationsCreate.ts +21 -7
  514. package/src/funcs/integrationsDelete.ts +9 -2
  515. package/src/funcs/integrationsList.ts +28 -2
  516. package/src/funcs/integrationsListActive.ts +29 -2
  517. package/src/funcs/integrationsSetAsPrimary.ts +9 -2
  518. package/src/funcs/integrationsUpdate.ts +9 -11
  519. package/src/funcs/integrationsWebhooksRetrieve.ts +9 -2
  520. package/src/funcs/messagesDelete.ts +9 -2
  521. package/src/funcs/messagesDeleteByTransactionId.ts +9 -11
  522. package/src/funcs/messagesRetrieve.ts +8 -3
  523. package/src/funcs/notificationsList.ts +8 -3
  524. package/src/funcs/notificationsRetrieve.ts +9 -2
  525. package/src/funcs/notificationsStatsGraph.ts +10 -3
  526. package/src/funcs/notificationsStatsRetrieve.ts +28 -2
  527. package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +7 -2
  528. package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +7 -2
  529. package/src/funcs/subscribersCreate.ts +21 -7
  530. package/src/funcs/subscribersCreateBulk.ts +24 -7
  531. package/src/funcs/subscribersCredentialsAppend.ts +9 -13
  532. package/src/funcs/subscribersCredentialsDelete.ts +9 -11
  533. package/src/funcs/subscribersCredentialsUpdate.ts +9 -13
  534. package/src/funcs/subscribersDelete.ts +9 -2
  535. package/src/funcs/subscribersList.ts +18 -17
  536. package/src/funcs/subscribersMessagesMarkAll.ts +9 -11
  537. package/src/funcs/subscribersMessagesMarkAllAs.ts +9 -11
  538. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +7 -2
  539. package/src/funcs/subscribersNotificationsFeed.ts +7 -2
  540. package/src/funcs/subscribersNotificationsUnseenCount.ts +7 -2
  541. package/src/funcs/subscribersPreferencesList.ts +9 -11
  542. package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +7 -2
  543. package/src/funcs/subscribersPreferencesUpdate.ts +7 -2
  544. package/src/funcs/subscribersPreferencesUpdateGlobal.ts +10 -14
  545. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +9 -14
  546. package/src/funcs/subscribersRetrieve.ts +9 -10
  547. package/src/funcs/subscribersUpdate.ts +9 -11
  548. package/src/funcs/topicsCreate.ts +21 -7
  549. package/src/funcs/topicsDelete.ts +9 -2
  550. package/src/funcs/topicsList.ts +8 -3
  551. package/src/funcs/topicsRename.ts +9 -11
  552. package/src/funcs/topicsRetrieve.ts +9 -2
  553. package/src/funcs/topicsSubscribersAssign.ts +9 -11
  554. package/src/funcs/topicsSubscribersRemove.ts +9 -11
  555. package/src/funcs/topicsSubscribersRetrieve.ts +9 -10
  556. package/src/funcs/trigger.ts +21 -7
  557. package/src/funcs/triggerBroadcast.ts +21 -7
  558. package/src/funcs/triggerBulk.ts +21 -7
  559. package/src/lib/config.ts +3 -3
  560. package/src/models/components/activitynotificationexecutiondetailresponsedto.ts +0 -9
  561. package/src/models/components/activitynotificationjobresponsedto.ts +47 -41
  562. package/src/models/components/builderfieldtype.ts +39 -0
  563. package/src/models/components/createintegrationrequestdto.ts +9 -9
  564. package/src/models/components/digestregularmetadata.ts +18 -15
  565. package/src/models/components/digestwitheventsdto.ts +127 -0
  566. package/src/models/components/fieldfilterpartdto.ts +139 -0
  567. package/src/models/components/index.ts +4 -0
  568. package/src/models/components/integrationresponsedto.ts +9 -9
  569. package/src/models/components/notificationstep.ts +9 -9
  570. package/src/models/components/notificationstepvariant.ts +9 -9
  571. package/src/models/components/notificationtriggervariableresponse.ts +44 -24
  572. package/src/models/components/stepfilterdto.ts +112 -0
  573. package/src/models/components/updateintegrationrequestdto.ts +9 -9
  574. package/src/models/operations/eventscontrollerbroadcasteventtoall.ts +87 -0
  575. package/src/models/operations/eventscontrollercancel.ts +15 -0
  576. package/src/models/operations/eventscontrollertrigger.ts +77 -0
  577. package/src/models/operations/eventscontrollertriggerbulk.ts +79 -0
  578. package/src/models/operations/integrationscontrollercreateintegration.ts +91 -0
  579. package/src/models/operations/integrationscontrollergetactiveintegrations.ts +83 -0
  580. package/src/models/operations/integrationscontrollergetwebhooksupportstatus.ts +15 -0
  581. package/src/models/operations/integrationscontrollerlistintegrations.ts +82 -0
  582. package/src/models/operations/integrationscontrollerremoveintegration.ts +15 -0
  583. package/src/models/operations/integrationscontrollersetintegrationasprimary.ts +15 -0
  584. package/src/models/operations/integrationscontrollerupdateintegrationbyid.ts +9 -0
  585. package/src/models/operations/messagescontrollerdeletemessage.ts +15 -0
  586. package/src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts +15 -0
  587. package/src/models/operations/messagescontrollergetmessages.ts +15 -0
  588. package/src/models/operations/notificationscontrollergetactivitygraphstats.ts +15 -0
  589. package/src/models/operations/notificationscontrollergetactivitystats.ts +83 -0
  590. package/src/models/operations/notificationscontrollergetnotification.ts +15 -0
  591. package/src/models/operations/notificationscontrollerlistnotifications.ts +15 -0
  592. package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +89 -0
  593. package/src/models/operations/subscriberscontrollerchataccessoauth.ts +15 -0
  594. package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +15 -0
  595. package/src/models/operations/subscriberscontrollercreatesubscriber.ts +90 -0
  596. package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +15 -0
  597. package/src/models/operations/subscriberscontrollergetnotificationsfeed.ts +15 -0
  598. package/src/models/operations/subscriberscontrollergetsubscriber.ts +15 -0
  599. package/src/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.ts +15 -0
  600. package/src/models/operations/subscriberscontrollergetunseencount.ts +15 -0
  601. package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +15 -0
  602. package/src/models/operations/subscriberscontrollerlistsubscribers.ts +15 -0
  603. package/src/models/operations/subscriberscontrollermarkactionasseen.ts +9 -0
  604. package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +9 -0
  605. package/src/models/operations/subscriberscontrollermarkmessagesas.ts +9 -0
  606. package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +9 -0
  607. package/src/models/operations/subscriberscontrollerremovesubscriber.ts +15 -0
  608. package/src/models/operations/subscriberscontrollerupdatesubscriber.ts +9 -0
  609. package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +9 -0
  610. package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +9 -0
  611. package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +9 -0
  612. package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +9 -0
  613. package/src/models/operations/topicscontrollerassign.ts +9 -0
  614. package/src/models/operations/topicscontrollercreatetopic.ts +79 -0
  615. package/src/models/operations/topicscontrollerdeletetopic.ts +15 -0
  616. package/src/models/operations/topicscontrollergettopic.ts +15 -0
  617. package/src/models/operations/topicscontrollergettopicsubscriber.ts +15 -0
  618. package/src/models/operations/topicscontrollerlisttopics.ts +15 -0
  619. package/src/models/operations/topicscontrollerremovesubscribers.ts +9 -0
  620. package/src/models/operations/topicscontrollerrenametopic.ts +9 -0
  621. package/src/sdk/credentials.ts +6 -15
  622. package/src/sdk/integrations.ts +14 -6
  623. package/src/sdk/messages.ts +4 -4
  624. package/src/sdk/notifications.ts +2 -0
  625. package/src/sdk/novumessages.ts +4 -9
  626. package/src/sdk/novusubscribers.ts +6 -13
  627. package/src/sdk/preferences.ts +5 -10
  628. package/src/sdk/properties.ts +2 -6
  629. package/src/sdk/sdk.ts +14 -6
  630. package/src/sdk/stats.ts +4 -0
  631. package/src/sdk/subscribers.ts +16 -16
  632. package/src/sdk/topics.ts +10 -6
  633. package/src/sdk/webhooks.ts +2 -0
@@ -24,12 +24,15 @@ const novu = new Novu({
24
24
 
25
25
  async function run() {
26
26
  const result = await novu.topics.subscribers.assign({
27
- subscribers: [
28
- "<value>",
29
- "<value>",
30
- "<value>",
31
- ],
32
- }, "<value>");
27
+ topicKey: "<value>",
28
+ addSubscribersRequestDto: {
29
+ subscribers: [
30
+ "<value>",
31
+ "<value>",
32
+ "<value>",
33
+ ],
34
+ },
35
+ });
33
36
 
34
37
  // Handle the result
35
38
  console.log(result);
@@ -54,12 +57,15 @@ const novu = new NovuCore({
54
57
 
55
58
  async function run() {
56
59
  const res = await topicsSubscribersAssign(novu, {
57
- subscribers: [
58
- "<value>",
59
- "<value>",
60
- "<value>",
61
- ],
62
- }, "<value>");
60
+ topicKey: "<value>",
61
+ addSubscribersRequestDto: {
62
+ subscribers: [
63
+ "<value>",
64
+ "<value>",
65
+ "<value>",
66
+ ],
67
+ },
68
+ });
63
69
 
64
70
  if (!res.ok) {
65
71
  throw res.error;
@@ -78,8 +84,7 @@ run();
78
84
 
79
85
  | Parameter | Type | Required | Description |
80
86
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
- | `topicKey` | *string* | :heavy_check_mark: | The topic key |
82
- | `addSubscribersRequestDto` | [components.AddSubscribersRequestDto](../../models/components/addsubscribersrequestdto.md) | :heavy_check_mark: | N/A |
87
+ | `request` | [operations.TopicsControllerAssignRequest](../../models/operations/topicscontrollerassignrequest.md) | :heavy_check_mark: | The request object to use for the request. |
83
88
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
84
89
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
85
90
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -110,7 +115,10 @@ const novu = new Novu({
110
115
  });
111
116
 
112
117
  async function run() {
113
- const result = await novu.topics.subscribers.retrieve("<id>", "<value>");
118
+ const result = await novu.topics.subscribers.retrieve({
119
+ externalSubscriberId: "<id>",
120
+ topicKey: "<value>",
121
+ });
114
122
 
115
123
  // Handle the result
116
124
  console.log(result);
@@ -134,7 +142,10 @@ const novu = new NovuCore({
134
142
  });
135
143
 
136
144
  async function run() {
137
- const res = await topicsSubscribersRetrieve(novu, "<id>", "<value>");
145
+ const res = await topicsSubscribersRetrieve(novu, {
146
+ externalSubscriberId: "<id>",
147
+ topicKey: "<value>",
148
+ });
138
149
 
139
150
  if (!res.ok) {
140
151
  throw res.error;
@@ -153,8 +164,7 @@ run();
153
164
 
154
165
  | Parameter | Type | Required | Description |
155
166
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
156
- | `externalSubscriberId` | *string* | :heavy_check_mark: | The external subscriber id |
157
- | `topicKey` | *string* | :heavy_check_mark: | The topic key |
167
+ | `request` | [operations.TopicsControllerGetTopicSubscriberRequest](../../models/operations/topicscontrollergettopicsubscriberrequest.md) | :heavy_check_mark: | The request object to use for the request. |
158
168
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
159
169
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
160
170
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -186,11 +196,14 @@ const novu = new Novu({
186
196
 
187
197
  async function run() {
188
198
  const result = await novu.topics.subscribers.remove({
189
- subscribers: [
190
- "<value>",
191
- "<value>",
192
- ],
193
- }, "<value>");
199
+ topicKey: "<value>",
200
+ removeSubscribersRequestDto: {
201
+ subscribers: [
202
+ "<value>",
203
+ "<value>",
204
+ ],
205
+ },
206
+ });
194
207
 
195
208
  // Handle the result
196
209
  console.log(result);
@@ -215,11 +228,14 @@ const novu = new NovuCore({
215
228
 
216
229
  async function run() {
217
230
  const res = await topicsSubscribersRemove(novu, {
218
- subscribers: [
219
- "<value>",
220
- "<value>",
221
- ],
222
- }, "<value>");
231
+ topicKey: "<value>",
232
+ removeSubscribersRequestDto: {
233
+ subscribers: [
234
+ "<value>",
235
+ "<value>",
236
+ ],
237
+ },
238
+ });
223
239
 
224
240
  if (!res.ok) {
225
241
  throw res.error;
@@ -238,8 +254,7 @@ run();
238
254
 
239
255
  | Parameter | Type | Required | Description |
240
256
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
241
- | `topicKey` | *string* | :heavy_check_mark: | The topic key |
242
- | `removeSubscribersRequestDto` | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.md) | :heavy_check_mark: | N/A |
257
+ | `request` | [operations.TopicsControllerRemoveSubscribersRequest](../../models/operations/topicscontrollerremovesubscribersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
243
258
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
244
259
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
245
260
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -24,7 +24,9 @@ const novu = new Novu({
24
24
  });
25
25
 
26
26
  async function run() {
27
- const result = await novu.subscribers.preferences.list("<id>");
27
+ const result = await novu.subscribers.preferences.list({
28
+ subscriberId: "<id>",
29
+ });
28
30
 
29
31
  // Handle the result
30
32
  console.log(result);
@@ -48,7 +50,9 @@ const novu = new NovuCore({
48
50
  });
49
51
 
50
52
  async function run() {
51
- const res = await subscribersPreferencesList(novu, "<id>");
53
+ const res = await subscribersPreferencesList(novu, {
54
+ subscriberId: "<id>",
55
+ });
52
56
 
53
57
  if (!res.ok) {
54
58
  throw res.error;
@@ -67,8 +71,7 @@ run();
67
71
 
68
72
  | Parameter | Type | Required | Description |
69
73
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
70
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
71
- | `includeInactiveChannels` | *boolean* | :heavy_minus_sign: | A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true |
74
+ | `request` | [operations.SubscribersControllerListSubscriberPreferencesRequest](../../models/operations/subscriberscontrollerlistsubscriberpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
72
75
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
73
76
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
74
77
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -99,7 +102,10 @@ const novu = new Novu({
99
102
  });
100
103
 
101
104
  async function run() {
102
- const result = await novu.subscribers.preferences.updateGlobal({}, "<id>");
105
+ const result = await novu.subscribers.preferences.updateGlobal({
106
+ subscriberId: "<id>",
107
+ updateSubscriberGlobalPreferencesRequestDto: {},
108
+ });
103
109
 
104
110
  // Handle the result
105
111
  console.log(result);
@@ -123,7 +129,10 @@ const novu = new NovuCore({
123
129
  });
124
130
 
125
131
  async function run() {
126
- const res = await subscribersPreferencesUpdateGlobal(novu, {}, "<id>");
132
+ const res = await subscribersPreferencesUpdateGlobal(novu, {
133
+ subscriberId: "<id>",
134
+ updateSubscriberGlobalPreferencesRequestDto: {},
135
+ });
127
136
 
128
137
  if (!res.ok) {
129
138
  throw res.error;
@@ -142,8 +151,7 @@ run();
142
151
 
143
152
  | Parameter | Type | Required | Description |
144
153
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
145
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
146
- | `updateSubscriberGlobalPreferencesRequestDto` | [components.UpdateSubscriberGlobalPreferencesRequestDto](../../models/components/updatesubscriberglobalpreferencesrequestdto.md) | :heavy_check_mark: | N/A |
154
+ | `request` | [operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest](../../models/operations/subscriberscontrollerupdatesubscriberglobalpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
147
155
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
148
156
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
149
157
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -22,8 +22,11 @@ const novu = new Novu({
22
22
 
23
23
  async function run() {
24
24
  const result = await novu.subscribers.properties.updateOnlineFlag({
25
- isOnline: true,
26
- }, "<id>");
25
+ subscriberId: "<id>",
26
+ updateSubscriberOnlineFlagRequestDto: {
27
+ isOnline: true,
28
+ },
29
+ });
27
30
 
28
31
  // Handle the result
29
32
  console.log(result);
@@ -48,8 +51,11 @@ const novu = new NovuCore({
48
51
 
49
52
  async function run() {
50
53
  const res = await subscribersPropertiesUpdateOnlineFlag(novu, {
51
- isOnline: true,
52
- }, "<id>");
54
+ subscriberId: "<id>",
55
+ updateSubscriberOnlineFlagRequestDto: {
56
+ isOnline: true,
57
+ },
58
+ });
53
59
 
54
60
  if (!res.ok) {
55
61
  throw res.error;
@@ -68,8 +74,7 @@ run();
68
74
 
69
75
  | Parameter | Type | Required | Description |
70
76
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
71
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
72
- | `updateSubscriberOnlineFlagRequestDto` | [components.UpdateSubscriberOnlineFlagRequestDto](../../models/components/updatesubscriberonlineflagrequestdto.md) | :heavy_check_mark: | N/A |
77
+ | `request` | [operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest](../../models/operations/subscriberscontrollerupdatesubscriberonlineflagrequest.md) | :heavy_check_mark: | The request object to use for the request. |
73
78
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
74
79
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
75
80
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -65,6 +65,7 @@ run();
65
65
 
66
66
  | Parameter | Type | Required | Description |
67
67
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
68
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
68
69
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
69
70
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
70
71
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -138,6 +139,7 @@ run();
138
139
 
139
140
  | Parameter | Type | Required | Description |
140
141
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
142
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
141
143
  | `days` | *number* | :heavy_minus_sign: | N/A |
142
144
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
143
145
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
@@ -29,7 +29,7 @@ const novu = new Novu({
29
29
  });
30
30
 
31
31
  async function run() {
32
- const result = await novu.subscribers.list();
32
+ const result = await novu.subscribers.list({});
33
33
 
34
34
  for await (const page of result) {
35
35
  // Handle the page
@@ -55,7 +55,7 @@ const novu = new NovuCore({
55
55
  });
56
56
 
57
57
  async function run() {
58
- const res = await subscribersList(novu);
58
+ const res = await subscribersList(novu, {});
59
59
 
60
60
  if (!res.ok) {
61
61
  throw res.error;
@@ -76,8 +76,7 @@ run();
76
76
 
77
77
  | Parameter | Type | Required | Description |
78
78
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
79
- | `page` | *number* | :heavy_minus_sign: | N/A |
80
- | `limit` | *number* | :heavy_minus_sign: | N/A |
79
+ | `request` | [operations.SubscribersControllerListSubscribersRequest](../../models/operations/subscriberscontrollerlistsubscribersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
81
80
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
82
81
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
83
82
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -155,7 +154,8 @@ run();
155
154
 
156
155
  | Parameter | Type | Required | Description |
157
156
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
- | `request` | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md) | :heavy_check_mark: | The request object to use for the request. |
157
+ | `createSubscriberRequestDto` | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md) | :heavy_check_mark: | N/A |
158
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
159
159
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
160
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
161
161
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -186,7 +186,9 @@ const novu = new Novu({
186
186
  });
187
187
 
188
188
  async function run() {
189
- const result = await novu.subscribers.retrieve("<id>");
189
+ const result = await novu.subscribers.retrieve({
190
+ subscriberId: "<id>",
191
+ });
190
192
 
191
193
  // Handle the result
192
194
  console.log(result);
@@ -210,7 +212,9 @@ const novu = new NovuCore({
210
212
  });
211
213
 
212
214
  async function run() {
213
- const res = await subscribersRetrieve(novu, "<id>");
215
+ const res = await subscribersRetrieve(novu, {
216
+ subscriberId: "<id>",
217
+ });
214
218
 
215
219
  if (!res.ok) {
216
220
  throw res.error;
@@ -229,8 +233,7 @@ run();
229
233
 
230
234
  | Parameter | Type | Required | Description |
231
235
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
232
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
233
- | `includeTopics` | *boolean* | :heavy_minus_sign: | Includes the topics associated with the subscriber |
236
+ | `request` | [operations.SubscribersControllerGetSubscriberRequest](../../models/operations/subscriberscontrollergetsubscriberrequest.md) | :heavy_check_mark: | The request object to use for the request. |
234
237
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
235
238
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
236
239
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -262,23 +265,26 @@ const novu = new Novu({
262
265
 
263
266
  async function run() {
264
267
  const result = await novu.subscribers.update({
265
- email: "john.doe@example.com",
266
- firstName: "John",
267
- lastName: "Doe",
268
- phone: "+1234567890",
269
- avatar: "https://example.com/avatar.jpg",
270
- locale: "en-US",
271
- data: {
272
- "preferences": {
273
- "notifications": true,
274
- "theme": "dark",
268
+ subscriberId: "<id>",
269
+ updateSubscriberRequestDto: {
270
+ email: "john.doe@example.com",
271
+ firstName: "John",
272
+ lastName: "Doe",
273
+ phone: "+1234567890",
274
+ avatar: "https://example.com/avatar.jpg",
275
+ locale: "en-US",
276
+ data: {
277
+ "preferences": {
278
+ "notifications": true,
279
+ "theme": "dark",
280
+ },
281
+ "tags": [
282
+ "premium",
283
+ "newsletter",
284
+ ],
275
285
  },
276
- "tags": [
277
- "premium",
278
- "newsletter",
279
- ],
280
286
  },
281
- }, "<id>");
287
+ });
282
288
 
283
289
  // Handle the result
284
290
  console.log(result);
@@ -303,23 +309,26 @@ const novu = new NovuCore({
303
309
 
304
310
  async function run() {
305
311
  const res = await subscribersUpdate(novu, {
306
- email: "john.doe@example.com",
307
- firstName: "John",
308
- lastName: "Doe",
309
- phone: "+1234567890",
310
- avatar: "https://example.com/avatar.jpg",
311
- locale: "en-US",
312
- data: {
313
- "preferences": {
314
- "notifications": true,
315
- "theme": "dark",
312
+ subscriberId: "<id>",
313
+ updateSubscriberRequestDto: {
314
+ email: "john.doe@example.com",
315
+ firstName: "John",
316
+ lastName: "Doe",
317
+ phone: "+1234567890",
318
+ avatar: "https://example.com/avatar.jpg",
319
+ locale: "en-US",
320
+ data: {
321
+ "preferences": {
322
+ "notifications": true,
323
+ "theme": "dark",
324
+ },
325
+ "tags": [
326
+ "premium",
327
+ "newsletter",
328
+ ],
316
329
  },
317
- "tags": [
318
- "premium",
319
- "newsletter",
320
- ],
321
330
  },
322
- }, "<id>");
331
+ });
323
332
 
324
333
  if (!res.ok) {
325
334
  throw res.error;
@@ -338,8 +347,7 @@ run();
338
347
 
339
348
  | Parameter | Type | Required | Description |
340
349
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
341
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
342
- | `updateSubscriberRequestDto` | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md) | :heavy_check_mark: | N/A |
350
+ | `request` | [operations.SubscribersControllerUpdateSubscriberRequest](../../models/operations/subscriberscontrollerupdatesubscriberrequest.md) | :heavy_check_mark: | The request object to use for the request. |
343
351
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
344
352
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
345
353
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -414,6 +422,7 @@ run();
414
422
  | Parameter | Type | Required | Description |
415
423
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
416
424
  | `subscriberId` | *string* | :heavy_check_mark: | N/A |
425
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
417
426
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
418
427
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
419
428
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -504,7 +513,8 @@ run();
504
513
 
505
514
  | Parameter | Type | Required | Description |
506
515
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
507
- | `request` | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md) | :heavy_check_mark: | The request object to use for the request. |
516
+ | `bulkSubscriberCreateDto` | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md) | :heavy_check_mark: | N/A |
517
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
508
518
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
509
519
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
510
520
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |