@novu/api 0.1.0 → 0.1.2

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 (530) hide show
  1. package/FUNCTIONS.md +16 -10
  2. package/README.md +182 -100
  3. package/docs/sdks/authentication/README.md +10 -10
  4. package/docs/sdks/credentials/README.md +56 -12
  5. package/docs/sdks/integrations/README.md +18 -18
  6. package/docs/sdks/messages/README.md +17 -11
  7. package/docs/sdks/notifications/README.md +8 -38
  8. package/docs/sdks/novu/README.md +138 -66
  9. package/docs/sdks/novumessages/README.md +17 -17
  10. package/docs/sdks/novunotifications/README.md +14 -12
  11. package/docs/sdks/novusubscribers/README.md +9 -9
  12. package/docs/sdks/preferences/README.md +22 -22
  13. package/docs/sdks/properties/README.md +6 -6
  14. package/docs/sdks/stats/README.md +6 -6
  15. package/docs/sdks/subscribers/README.md +349 -37
  16. package/docs/sdks/topics/README.md +15 -15
  17. package/docs/sdks/webhooks/README.md +3 -3
  18. package/funcs/cancel.js +4 -4
  19. package/funcs/cancel.js.map +1 -1
  20. package/funcs/integrationsCreate.js +4 -4
  21. package/funcs/integrationsCreate.js.map +1 -1
  22. package/funcs/integrationsDelete.js +4 -4
  23. package/funcs/integrationsDelete.js.map +1 -1
  24. package/funcs/integrationsList.js +4 -4
  25. package/funcs/integrationsList.js.map +1 -1
  26. package/funcs/integrationsListActive.js +4 -4
  27. package/funcs/integrationsListActive.js.map +1 -1
  28. package/funcs/integrationsSetAsPrimary.js +4 -4
  29. package/funcs/integrationsSetAsPrimary.js.map +1 -1
  30. package/funcs/integrationsUpdate.js +4 -4
  31. package/funcs/integrationsUpdate.js.map +1 -1
  32. package/funcs/integrationsWebhooksRetrieve.js +4 -4
  33. package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
  34. package/funcs/messagesDelete.js +4 -4
  35. package/funcs/messagesDelete.js.map +1 -1
  36. package/funcs/messagesDeleteByTransactionId.js +4 -4
  37. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  38. package/funcs/messagesRetrieve.js +4 -4
  39. package/funcs/messagesRetrieve.js.map +1 -1
  40. package/funcs/notificationsList.js +4 -4
  41. package/funcs/notificationsList.js.map +1 -1
  42. package/funcs/notificationsRetrieve.js +4 -4
  43. package/funcs/notificationsRetrieve.js.map +1 -1
  44. package/funcs/notificationsStatsGraph.js +4 -4
  45. package/funcs/notificationsStatsGraph.js.map +1 -1
  46. package/funcs/notificationsStatsRetrieve.js +4 -4
  47. package/funcs/notificationsStatsRetrieve.js.map +1 -1
  48. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +1 -1
  49. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
  50. package/funcs/subscribersAuthenticationChatAccessOauth.js +7 -7
  51. package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
  52. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +2 -2
  53. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
  54. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +6 -6
  55. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +1 -1
  56. package/funcs/subscribersCreate.d.ts +1 -1
  57. package/funcs/subscribersCreate.d.ts.map +1 -1
  58. package/funcs/subscribersCreate.js +6 -6
  59. package/funcs/subscribersCreate.js.map +1 -1
  60. package/funcs/subscribersCreateBulk.d.ts +1 -1
  61. package/funcs/subscribersCreateBulk.d.ts.map +1 -1
  62. package/funcs/subscribersCreateBulk.js +7 -6
  63. package/funcs/subscribersCreateBulk.js.map +1 -1
  64. package/funcs/subscribersCredentialsAppend.d.ts +1 -1
  65. package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
  66. package/funcs/subscribersCredentialsAppend.js +6 -6
  67. package/funcs/subscribersCredentialsAppend.js.map +1 -1
  68. package/funcs/subscribersCredentialsDelete.d.ts +1 -1
  69. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  70. package/funcs/subscribersCredentialsDelete.js +7 -7
  71. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  72. package/funcs/subscribersCredentialsUpdate.d.ts +1 -1
  73. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  74. package/funcs/subscribersCredentialsUpdate.js +6 -6
  75. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  76. package/funcs/subscribersDelete.js +5 -5
  77. package/funcs/subscribersDelete.js.map +1 -1
  78. package/funcs/subscribersDeleteLegacy.d.ts +18 -0
  79. package/funcs/subscribersDeleteLegacy.d.ts.map +1 -0
  80. package/funcs/subscribersDeleteLegacy.js +141 -0
  81. package/funcs/subscribersDeleteLegacy.js.map +1 -0
  82. package/funcs/subscribersList.d.ts +1 -1
  83. package/funcs/subscribersList.d.ts.map +1 -1
  84. package/funcs/subscribersList.js +6 -6
  85. package/funcs/subscribersList.js.map +1 -1
  86. package/funcs/subscribersMessagesMarkAll.d.ts +1 -1
  87. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  88. package/funcs/subscribersMessagesMarkAll.js +8 -7
  89. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  90. package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -1
  91. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  92. package/funcs/subscribersMessagesMarkAllAs.js +6 -6
  93. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  94. package/funcs/subscribersMessagesUpdateAsSeen.d.ts +1 -1
  95. package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  96. package/funcs/subscribersMessagesUpdateAsSeen.js +6 -6
  97. package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
  98. package/funcs/subscribersNotificationsFeed.d.ts +1 -1
  99. package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
  100. package/funcs/subscribersNotificationsFeed.js +7 -6
  101. package/funcs/subscribersNotificationsFeed.js.map +1 -1
  102. package/funcs/subscribersNotificationsUnseenCount.d.ts +1 -1
  103. package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  104. package/funcs/subscribersNotificationsUnseenCount.js +6 -6
  105. package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
  106. package/funcs/subscribersPatch.d.ts +17 -0
  107. package/funcs/subscribersPatch.d.ts.map +1 -0
  108. package/funcs/subscribersPatch.js +143 -0
  109. package/funcs/subscribersPatch.js.map +1 -0
  110. package/funcs/subscribersPreferencesList.d.ts +1 -1
  111. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  112. package/funcs/subscribersPreferencesList.js +6 -6
  113. package/funcs/subscribersPreferencesList.js.map +1 -1
  114. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +1 -1
  115. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
  116. package/funcs/subscribersPreferencesRetrieveByLevel.js +6 -6
  117. package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
  118. package/funcs/subscribersPreferencesUpdate.d.ts +1 -1
  119. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  120. package/funcs/subscribersPreferencesUpdate.js +6 -6
  121. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  122. package/funcs/subscribersPreferencesUpdateGlobal.d.ts +1 -1
  123. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
  124. package/funcs/subscribersPreferencesUpdateGlobal.js +6 -6
  125. package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
  126. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
  127. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
  128. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +6 -6
  129. package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  130. package/funcs/subscribersRetrieve.d.ts +1 -1
  131. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  132. package/funcs/subscribersRetrieve.js +6 -11
  133. package/funcs/subscribersRetrieve.js.map +1 -1
  134. package/funcs/subscribersRetrieveLegacy.d.ts +16 -0
  135. package/funcs/subscribersRetrieveLegacy.d.ts.map +1 -0
  136. package/funcs/subscribersRetrieveLegacy.js +144 -0
  137. package/funcs/subscribersRetrieveLegacy.js.map +1 -0
  138. package/funcs/subscribersSearch.d.ts +13 -0
  139. package/funcs/subscribersSearch.d.ts.map +1 -0
  140. package/funcs/subscribersSearch.js +138 -0
  141. package/funcs/subscribersSearch.js.map +1 -0
  142. package/funcs/subscribersUpdate.d.ts +1 -1
  143. package/funcs/subscribersUpdate.d.ts.map +1 -1
  144. package/funcs/subscribersUpdate.js +6 -6
  145. package/funcs/subscribersUpdate.js.map +1 -1
  146. package/funcs/topicsCreate.js +4 -4
  147. package/funcs/topicsCreate.js.map +1 -1
  148. package/funcs/topicsDelete.js +4 -4
  149. package/funcs/topicsDelete.js.map +1 -1
  150. package/funcs/topicsList.js +4 -4
  151. package/funcs/topicsList.js.map +1 -1
  152. package/funcs/topicsRename.js +4 -4
  153. package/funcs/topicsRename.js.map +1 -1
  154. package/funcs/topicsRetrieve.js +4 -4
  155. package/funcs/topicsRetrieve.js.map +1 -1
  156. package/funcs/topicsSubscribersAssign.js +4 -4
  157. package/funcs/topicsSubscribersAssign.js.map +1 -1
  158. package/funcs/topicsSubscribersRemove.js +4 -4
  159. package/funcs/topicsSubscribersRemove.js.map +1 -1
  160. package/funcs/topicsSubscribersRetrieve.js +4 -4
  161. package/funcs/topicsSubscribersRetrieve.js.map +1 -1
  162. package/funcs/trigger.js +4 -4
  163. package/funcs/trigger.js.map +1 -1
  164. package/funcs/triggerBroadcast.js +4 -4
  165. package/funcs/triggerBroadcast.js.map +1 -1
  166. package/funcs/triggerBulk.js +4 -4
  167. package/funcs/triggerBulk.js.map +1 -1
  168. package/jsr.json +1 -1
  169. package/lib/config.d.ts +4 -4
  170. package/lib/config.d.ts.map +1 -1
  171. package/lib/config.js +3 -3
  172. package/lib/config.js.map +1 -1
  173. package/lib/retries.js +0 -1
  174. package/lib/retries.js.map +1 -1
  175. package/lib/schemas.d.ts +1 -1
  176. package/lib/schemas.d.ts.map +1 -1
  177. package/lib/schemas.js +4 -1
  178. package/lib/schemas.js.map +1 -1
  179. package/lib/security.js +1 -1
  180. package/lib/security.js.map +1 -1
  181. package/models/components/{channelsettings.d.ts → channelsettingsdto.d.ts} +22 -22
  182. package/models/components/channelsettingsdto.d.ts.map +1 -0
  183. package/models/components/{channelsettings.js → channelsettingsdto.js} +29 -29
  184. package/models/components/channelsettingsdto.js.map +1 -0
  185. package/models/components/index.d.ts +4 -2
  186. package/models/components/index.d.ts.map +1 -1
  187. package/models/components/index.js +4 -2
  188. package/models/components/index.js.map +1 -1
  189. package/models/components/listsubscribersresponsedto.d.ts +43 -0
  190. package/models/components/listsubscribersresponsedto.d.ts.map +1 -0
  191. package/models/components/listsubscribersresponsedto.js +64 -0
  192. package/models/components/listsubscribersresponsedto.js.map +1 -0
  193. package/models/components/patchsubscriberrequestdto.d.ts +96 -0
  194. package/models/components/patchsubscriberrequestdto.d.ts.map +1 -0
  195. package/models/components/patchsubscriberrequestdto.js +100 -0
  196. package/models/components/patchsubscriberrequestdto.js.map +1 -0
  197. package/models/components/removesubscriberresponsedto.d.ts +37 -0
  198. package/models/components/removesubscriberresponsedto.d.ts.map +1 -0
  199. package/models/components/removesubscriberresponsedto.js +61 -0
  200. package/models/components/removesubscriberresponsedto.js.map +1 -0
  201. package/models/components/security.d.ts +2 -2
  202. package/models/components/security.d.ts.map +1 -1
  203. package/models/components/security.js +2 -11
  204. package/models/components/security.js.map +1 -1
  205. package/models/components/subscriberresponsedto.d.ts +14 -3
  206. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  207. package/models/components/subscriberresponsedto.js +5 -3
  208. package/models/components/subscriberresponsedto.js.map +1 -1
  209. package/models/components/triggereventrequestdto.d.ts +1 -12
  210. package/models/components/triggereventrequestdto.d.ts.map +1 -1
  211. package/models/components/triggereventrequestdto.js +10 -6
  212. package/models/components/triggereventrequestdto.js.map +1 -1
  213. package/models/operations/index.d.ts +23 -19
  214. package/models/operations/index.d.ts.map +1 -1
  215. package/models/operations/index.js +23 -19
  216. package/models/operations/index.js.map +1 -1
  217. package/models/operations/subscriberscontrollergetsubscriber.d.ts +0 -5
  218. package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
  219. package/models/operations/subscriberscontrollergetsubscriber.js +0 -2
  220. package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
  221. package/models/operations/subscriberscontrollerpatchsubscriber.d.ts +68 -0
  222. package/models/operations/subscriberscontrollerpatchsubscriber.d.ts.map +1 -0
  223. package/models/operations/subscriberscontrollerpatchsubscriber.js +114 -0
  224. package/models/operations/subscriberscontrollerpatchsubscriber.js.map +1 -0
  225. package/models/operations/subscriberscontrollerremovesubscriber.d.ts +2 -2
  226. package/models/operations/subscriberscontrollerremovesubscriber.js +2 -2
  227. package/models/operations/subscriberscontrollersearchsubscribers.d.ts +126 -0
  228. package/models/operations/subscriberscontrollersearchsubscribers.d.ts.map +1 -0
  229. package/models/operations/subscriberscontrollersearchsubscribers.js +145 -0
  230. package/models/operations/subscriberscontrollersearchsubscribers.js.map +1 -0
  231. package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts +66 -0
  232. package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts.map +1 -0
  233. package/models/operations/subscribersv1controllerbulkcreatesubscribers.js +112 -0
  234. package/models/operations/subscribersv1controllerbulkcreatesubscribers.js.map +1 -0
  235. package/models/operations/subscribersv1controllerchataccessoauth.d.ts +80 -0
  236. package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +1 -0
  237. package/models/operations/subscribersv1controllerchataccessoauth.js +113 -0
  238. package/models/operations/subscribersv1controllerchataccessoauth.js.map +1 -0
  239. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +108 -0
  240. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +1 -0
  241. package/models/operations/subscribersv1controllerchatoauthcallback.js +143 -0
  242. package/models/operations/subscribersv1controllerchatoauthcallback.js.map +1 -0
  243. package/models/operations/subscribersv1controllercreatesubscriber.d.ts +66 -0
  244. package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +1 -0
  245. package/models/operations/subscribersv1controllercreatesubscriber.js +112 -0
  246. package/models/operations/subscribersv1controllercreatesubscriber.js.map +1 -0
  247. package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts +65 -0
  248. package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts.map +1 -0
  249. package/models/operations/subscribersv1controllerdeletesubscribercredentials.js +111 -0
  250. package/models/operations/subscribersv1controllerdeletesubscribercredentials.js.map +1 -0
  251. package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts +79 -0
  252. package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts.map +1 -0
  253. package/models/operations/subscribersv1controllergetnotificationsfeed.js +120 -0
  254. package/models/operations/subscribersv1controllergetnotificationsfeed.js.map +1 -0
  255. package/models/operations/subscribersv1controllergetsubscriber.d.ts +71 -0
  256. package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +1 -0
  257. package/models/operations/subscribersv1controllergetsubscriber.js +112 -0
  258. package/models/operations/subscribersv1controllergetsubscriber.js.map +1 -0
  259. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +108 -0
  260. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +1 -0
  261. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +141 -0
  262. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +1 -0
  263. package/models/operations/subscribersv1controllergetunseencount.d.ts +76 -0
  264. package/models/operations/subscribersv1controllergetunseencount.d.ts.map +1 -0
  265. package/models/operations/subscribersv1controllergetunseencount.js +114 -0
  266. package/models/operations/subscribersv1controllergetunseencount.js.map +1 -0
  267. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +71 -0
  268. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +1 -0
  269. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +116 -0
  270. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +1 -0
  271. package/models/operations/subscribersv1controllerlistsubscribers.d.ts +108 -0
  272. package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +1 -0
  273. package/models/operations/subscribersv1controllerlistsubscribers.js +145 -0
  274. package/models/operations/subscribersv1controllerlistsubscribers.js.map +1 -0
  275. package/models/operations/subscribersv1controllermarkactionasseen.d.ts +72 -0
  276. package/models/operations/subscribersv1controllermarkactionasseen.d.ts.map +1 -0
  277. package/models/operations/subscribersv1controllermarkactionasseen.js +118 -0
  278. package/models/operations/subscribersv1controllermarkactionasseen.js.map +1 -0
  279. package/models/operations/subscribersv1controllermarkallunreadasread.d.ts +68 -0
  280. package/models/operations/subscribersv1controllermarkallunreadasread.d.ts.map +1 -0
  281. package/models/operations/subscribersv1controllermarkallunreadasread.js +114 -0
  282. package/models/operations/subscribersv1controllermarkallunreadasread.js.map +1 -0
  283. package/models/operations/subscribersv1controllermarkmessagesas.d.ts +68 -0
  284. package/models/operations/subscribersv1controllermarkmessagesas.d.ts.map +1 -0
  285. package/models/operations/subscribersv1controllermarkmessagesas.js +114 -0
  286. package/models/operations/subscribersv1controllermarkmessagesas.js.map +1 -0
  287. package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts +68 -0
  288. package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts.map +1 -0
  289. package/models/operations/subscribersv1controllermodifysubscriberchannel.js +115 -0
  290. package/models/operations/subscribersv1controllermodifysubscriberchannel.js.map +1 -0
  291. package/models/operations/subscribersv1controllerremovesubscriber.d.ts +66 -0
  292. package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +1 -0
  293. package/models/operations/subscribersv1controllerremovesubscriber.js +110 -0
  294. package/models/operations/subscribersv1controllerremovesubscriber.js.map +1 -0
  295. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +68 -0
  296. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +1 -0
  297. package/models/operations/subscribersv1controllerupdatesubscriber.js +114 -0
  298. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +1 -0
  299. package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts +68 -0
  300. package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts.map +1 -0
  301. package/models/operations/subscribersv1controllerupdatesubscriberchannel.js +115 -0
  302. package/models/operations/subscribersv1controllerupdatesubscriberchannel.js.map +1 -0
  303. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +68 -0
  304. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +1 -0
  305. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +118 -0
  306. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +1 -0
  307. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts +68 -0
  308. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts.map +1 -0
  309. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js +118 -0
  310. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js.map +1 -0
  311. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +70 -0
  312. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +1 -0
  313. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +120 -0
  314. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +1 -0
  315. package/package.json +10 -7
  316. package/sdk/authentication.d.ts +3 -3
  317. package/sdk/authentication.d.ts.map +1 -1
  318. package/sdk/authentication.js.map +1 -1
  319. package/sdk/credentials.d.ts +3 -3
  320. package/sdk/credentials.d.ts.map +1 -1
  321. package/sdk/credentials.js.map +1 -1
  322. package/sdk/novumessages.d.ts +3 -3
  323. package/sdk/novumessages.d.ts.map +1 -1
  324. package/sdk/novumessages.js.map +1 -1
  325. package/sdk/novunotifications.d.ts +2 -2
  326. package/sdk/novunotifications.d.ts.map +1 -1
  327. package/sdk/novunotifications.js.map +1 -1
  328. package/sdk/preferences.d.ts +4 -4
  329. package/sdk/preferences.d.ts.map +1 -1
  330. package/sdk/preferences.js.map +1 -1
  331. package/sdk/properties.d.ts +1 -1
  332. package/sdk/properties.d.ts.map +1 -1
  333. package/sdk/subscribers.d.ts +33 -6
  334. package/sdk/subscribers.d.ts.map +1 -1
  335. package/sdk/subscribers.js +43 -4
  336. package/sdk/subscribers.js.map +1 -1
  337. package/sources/json-development.json +2327 -228
  338. package/src/funcs/cancel.ts +4 -4
  339. package/src/funcs/integrationsCreate.ts +4 -4
  340. package/src/funcs/integrationsDelete.ts +4 -4
  341. package/src/funcs/integrationsList.ts +4 -4
  342. package/src/funcs/integrationsListActive.ts +4 -4
  343. package/src/funcs/integrationsSetAsPrimary.ts +5 -5
  344. package/src/funcs/integrationsUpdate.ts +5 -5
  345. package/src/funcs/integrationsWebhooksRetrieve.ts +4 -4
  346. package/src/funcs/messagesDelete.ts +4 -4
  347. package/src/funcs/messagesDeleteByTransactionId.ts +4 -4
  348. package/src/funcs/messagesRetrieve.ts +4 -4
  349. package/src/funcs/notificationsList.ts +4 -4
  350. package/src/funcs/notificationsRetrieve.ts +4 -4
  351. package/src/funcs/notificationsStatsGraph.ts +4 -4
  352. package/src/funcs/notificationsStatsRetrieve.ts +4 -4
  353. package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +10 -10
  354. package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +11 -11
  355. package/src/funcs/subscribersCreate.ts +10 -10
  356. package/src/funcs/subscribersCreateBulk.ts +15 -15
  357. package/src/funcs/subscribersCredentialsAppend.ts +11 -11
  358. package/src/funcs/subscribersCredentialsDelete.ts +10 -10
  359. package/src/funcs/subscribersCredentialsUpdate.ts +11 -11
  360. package/src/funcs/subscribersDelete.ts +5 -5
  361. package/src/funcs/subscribersDeleteLegacy.ts +200 -0
  362. package/src/funcs/subscribersList.ts +11 -11
  363. package/src/funcs/subscribersMessagesMarkAll.ts +14 -11
  364. package/src/funcs/subscribersMessagesMarkAllAs.ts +10 -10
  365. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +10 -10
  366. package/src/funcs/subscribersNotificationsFeed.ts +11 -10
  367. package/src/funcs/subscribersNotificationsUnseenCount.ts +10 -10
  368. package/src/funcs/subscribersPatch.ts +204 -0
  369. package/src/funcs/subscribersPreferencesList.ts +10 -10
  370. package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +10 -10
  371. package/src/funcs/subscribersPreferencesUpdate.ts +10 -10
  372. package/src/funcs/subscribersPreferencesUpdateGlobal.ts +16 -15
  373. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +10 -10
  374. package/src/funcs/subscribersRetrieve.ts +6 -13
  375. package/src/funcs/subscribersRetrieveLegacy.ts +205 -0
  376. package/src/funcs/subscribersSearch.ts +195 -0
  377. package/src/funcs/subscribersUpdate.ts +10 -10
  378. package/src/funcs/topicsCreate.ts +4 -4
  379. package/src/funcs/topicsDelete.ts +4 -4
  380. package/src/funcs/topicsList.ts +4 -4
  381. package/src/funcs/topicsRename.ts +4 -4
  382. package/src/funcs/topicsRetrieve.ts +4 -4
  383. package/src/funcs/topicsSubscribersAssign.ts +4 -4
  384. package/src/funcs/topicsSubscribersRemove.ts +4 -4
  385. package/src/funcs/topicsSubscribersRetrieve.ts +4 -4
  386. package/src/funcs/trigger.ts +4 -4
  387. package/src/funcs/triggerBroadcast.ts +4 -4
  388. package/src/funcs/triggerBulk.ts +4 -4
  389. package/src/lib/config.ts +4 -4
  390. package/src/lib/retries.ts +0 -1
  391. package/src/lib/schemas.ts +5 -0
  392. package/src/lib/security.ts +1 -1
  393. package/src/models/components/{channelsettings.ts → channelsettingsdto.ts} +40 -38
  394. package/src/models/components/index.ts +4 -2
  395. package/src/models/components/listsubscribersresponsedto.ts +89 -0
  396. package/src/models/components/patchsubscriberrequestdto.ts +182 -0
  397. package/src/models/components/removesubscriberresponsedto.ts +78 -0
  398. package/src/models/components/security.ts +4 -13
  399. package/src/models/components/subscriberresponsedto.ts +18 -9
  400. package/src/models/components/triggereventrequestdto.ts +11 -22
  401. package/src/models/operations/index.ts +23 -19
  402. package/src/models/operations/subscriberscontrollergetsubscriber.ts +0 -7
  403. package/src/models/operations/subscriberscontrollerpatchsubscriber.ts +189 -0
  404. package/src/models/operations/subscriberscontrollerremovesubscriber.ts +4 -4
  405. package/src/models/operations/subscriberscontrollersearchsubscribers.ts +260 -0
  406. package/src/models/operations/subscribersv1controllerbulkcreatesubscribers.ts +185 -0
  407. package/src/models/operations/{subscriberscontrollerchataccessoauth.ts → subscribersv1controllerchataccessoauth.ts} +47 -46
  408. package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +281 -0
  409. package/src/models/operations/subscribersv1controllercreatesubscriber.ts +187 -0
  410. package/src/models/operations/subscribersv1controllerdeletesubscribercredentials.ts +178 -0
  411. package/src/models/operations/{subscriberscontrollergetnotificationsfeed.ts → subscribersv1controllergetnotificationsfeed.ts} +46 -46
  412. package/src/models/operations/subscribersv1controllergetsubscriber.ts +188 -0
  413. package/src/models/operations/{subscriberscontrollergetsubscriberpreferencebylevel.ts → subscribersv1controllergetsubscriberpreferencebylevel.ts} +46 -46
  414. package/src/models/operations/subscribersv1controllergetunseencount.ts +195 -0
  415. package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +191 -0
  416. package/src/models/operations/subscribersv1controllerlistsubscribers.ts +283 -0
  417. package/src/models/operations/{subscriberscontrollermarkactionasseen.ts → subscribersv1controllermarkactionasseen.ts} +48 -46
  418. package/src/models/operations/subscribersv1controllermarkallunreadasread.ts +191 -0
  419. package/src/models/operations/subscribersv1controllermarkmessagesas.ts +187 -0
  420. package/src/models/operations/subscribersv1controllermodifysubscriberchannel.ts +192 -0
  421. package/src/models/operations/subscribersv1controllerremovesubscriber.ts +183 -0
  422. package/src/models/operations/{subscriberscontrollerupdatesubscriber.ts → subscribersv1controllerupdatesubscriber.ts} +48 -46
  423. package/src/models/operations/subscribersv1controllerupdatesubscriberchannel.ts +192 -0
  424. package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +195 -0
  425. package/src/models/operations/subscribersv1controllerupdatesubscriberonlineflag.ts +193 -0
  426. package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +197 -0
  427. package/src/sdk/authentication.ts +4 -4
  428. package/src/sdk/credentials.ts +7 -3
  429. package/src/sdk/novumessages.ts +4 -4
  430. package/src/sdk/novunotifications.ts +4 -4
  431. package/src/sdk/preferences.ts +7 -6
  432. package/src/sdk/properties.ts +1 -1
  433. package/src/sdk/subscribers.ts +89 -10
  434. package/models/components/channelsettings.d.ts.map +0 -1
  435. package/models/components/channelsettings.js.map +0 -1
  436. package/models/components/workflowtostepcontrolvaluesdto.d.ts +0 -40
  437. package/models/components/workflowtostepcontrolvaluesdto.d.ts.map +0 -1
  438. package/models/components/workflowtostepcontrolvaluesdto.js +0 -59
  439. package/models/components/workflowtostepcontrolvaluesdto.js.map +0 -1
  440. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +0 -66
  441. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +0 -1
  442. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +0 -112
  443. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +0 -1
  444. package/models/operations/subscriberscontrollerchataccessoauth.d.ts +0 -80
  445. package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +0 -1
  446. package/models/operations/subscriberscontrollerchataccessoauth.js +0 -113
  447. package/models/operations/subscriberscontrollerchataccessoauth.js.map +0 -1
  448. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +0 -108
  449. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +0 -1
  450. package/models/operations/subscriberscontrollerchatoauthcallback.js +0 -142
  451. package/models/operations/subscriberscontrollerchatoauthcallback.js.map +0 -1
  452. package/models/operations/subscriberscontrollercreatesubscriber.d.ts +0 -66
  453. package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +0 -1
  454. package/models/operations/subscriberscontrollercreatesubscriber.js +0 -112
  455. package/models/operations/subscriberscontrollercreatesubscriber.js.map +0 -1
  456. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +0 -65
  457. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +0 -1
  458. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +0 -111
  459. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +0 -1
  460. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +0 -79
  461. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +0 -1
  462. package/models/operations/subscriberscontrollergetnotificationsfeed.js +0 -120
  463. package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +0 -1
  464. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +0 -108
  465. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +0 -1
  466. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +0 -141
  467. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +0 -1
  468. package/models/operations/subscriberscontrollergetunseencount.d.ts +0 -76
  469. package/models/operations/subscriberscontrollergetunseencount.d.ts.map +0 -1
  470. package/models/operations/subscriberscontrollergetunseencount.js +0 -114
  471. package/models/operations/subscriberscontrollergetunseencount.js.map +0 -1
  472. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +0 -71
  473. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +0 -1
  474. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +0 -113
  475. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +0 -1
  476. package/models/operations/subscriberscontrollerlistsubscribers.d.ts +0 -108
  477. package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +0 -1
  478. package/models/operations/subscriberscontrollerlistsubscribers.js +0 -145
  479. package/models/operations/subscriberscontrollerlistsubscribers.js.map +0 -1
  480. package/models/operations/subscriberscontrollermarkactionasseen.d.ts +0 -72
  481. package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +0 -1
  482. package/models/operations/subscriberscontrollermarkactionasseen.js +0 -118
  483. package/models/operations/subscriberscontrollermarkactionasseen.js.map +0 -1
  484. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +0 -68
  485. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +0 -1
  486. package/models/operations/subscriberscontrollermarkallunreadasread.js +0 -114
  487. package/models/operations/subscriberscontrollermarkallunreadasread.js.map +0 -1
  488. package/models/operations/subscriberscontrollermarkmessagesas.d.ts +0 -68
  489. package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +0 -1
  490. package/models/operations/subscriberscontrollermarkmessagesas.js +0 -114
  491. package/models/operations/subscriberscontrollermarkmessagesas.js.map +0 -1
  492. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +0 -68
  493. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +0 -1
  494. package/models/operations/subscriberscontrollermodifysubscriberchannel.js +0 -114
  495. package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +0 -1
  496. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +0 -68
  497. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +0 -1
  498. package/models/operations/subscriberscontrollerupdatesubscriber.js +0 -114
  499. package/models/operations/subscriberscontrollerupdatesubscriber.js.map +0 -1
  500. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +0 -68
  501. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +0 -1
  502. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +0 -114
  503. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +0 -1
  504. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +0 -68
  505. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +0 -1
  506. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +0 -118
  507. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +0 -1
  508. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +0 -68
  509. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +0 -1
  510. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +0 -117
  511. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +0 -1
  512. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +0 -70
  513. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +0 -1
  514. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +0 -119
  515. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +0 -1
  516. package/src/models/components/workflowtostepcontrolvaluesdto.ts +0 -71
  517. package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +0 -185
  518. package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +0 -281
  519. package/src/models/operations/subscriberscontrollercreatesubscriber.ts +0 -185
  520. package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +0 -177
  521. package/src/models/operations/subscriberscontrollergetunseencount.ts +0 -192
  522. package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +0 -193
  523. package/src/models/operations/subscriberscontrollerlistsubscribers.ts +0 -282
  524. package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +0 -191
  525. package/src/models/operations/subscriberscontrollermarkmessagesas.ts +0 -184
  526. package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +0 -193
  527. package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +0 -193
  528. package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +0 -195
  529. package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +0 -192
  530. package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +0 -196
@@ -28,22 +28,28 @@ Novu Documentation
28
28
  import { Novu } from "@novu/api";
29
29
 
30
30
  const novu = new Novu({
31
- apiKey: "<YOUR_API_KEY_HERE>",
31
+ secretKey: "<YOUR_API_KEY_HERE>",
32
32
  });
33
33
 
34
34
  async function run() {
35
35
  const result = await novu.trigger({
36
- name: "workflow_identifier",
37
- to: [
38
- {
39
- topicKey: "<value>",
40
- type: "Topic",
36
+ workflowId: "workflow_identifier",
37
+ payload: {
38
+ "comment_id": "string",
39
+ "post": {
40
+ "text": "string",
41
41
  },
42
- {
43
- topicKey: "<value>",
44
- type: "Topic",
42
+ },
43
+ overrides: {
44
+ "fcm": {
45
+ "data": {
46
+ "key": "value",
47
+ },
45
48
  },
46
- ],
49
+ },
50
+ to: {
51
+ subscriberId: "<id>",
52
+ },
47
53
  });
48
54
 
49
55
  // Handle the result
@@ -64,22 +70,28 @@ import { trigger } from "@novu/api/funcs/trigger.js";
64
70
  // Use `NovuCore` for best tree-shaking performance.
65
71
  // You can create one instance of it to use across an application.
66
72
  const novu = new NovuCore({
67
- apiKey: "<YOUR_API_KEY_HERE>",
73
+ secretKey: "<YOUR_API_KEY_HERE>",
68
74
  });
69
75
 
70
76
  async function run() {
71
77
  const res = await trigger(novu, {
72
- name: "workflow_identifier",
73
- to: [
74
- {
75
- topicKey: "<value>",
76
- type: "Topic",
78
+ workflowId: "workflow_identifier",
79
+ payload: {
80
+ "comment_id": "string",
81
+ "post": {
82
+ "text": "string",
77
83
  },
78
- {
79
- topicKey: "<value>",
80
- type: "Topic",
84
+ },
85
+ overrides: {
86
+ "fcm": {
87
+ "data": {
88
+ "key": "value",
89
+ },
81
90
  },
82
- ],
91
+ },
92
+ to: {
93
+ subscriberId: "<id>",
94
+ },
83
95
  });
84
96
 
85
97
  if (!res.ok) {
@@ -113,8 +125,8 @@ run();
113
125
 
114
126
  | Error Type | Status Code | Content Type |
115
127
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
116
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
117
128
  | errors.ErrorDto | 414 | application/json |
129
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
118
130
  | errors.ValidationErrorDto | 422 | application/json |
119
131
  | errors.ErrorDto | 500 | application/json |
120
132
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -132,41 +144,71 @@ run();
132
144
  import { Novu } from "@novu/api";
133
145
 
134
146
  const novu = new Novu({
135
- apiKey: "<YOUR_API_KEY_HERE>",
147
+ secretKey: "<YOUR_API_KEY_HERE>",
136
148
  });
137
149
 
138
150
  async function run() {
139
151
  const result = await novu.triggerBulk({
140
152
  events: [
141
153
  {
142
- name: "workflow_identifier",
143
- to: [
144
- {
145
- topicKey: "<value>",
146
- type: "Topic",
154
+ workflowId: "workflow_identifier",
155
+ payload: {
156
+ "comment_id": "string",
157
+ "post": {
158
+ "text": "string",
147
159
  },
148
- {
149
- subscriberId: "<id>",
160
+ },
161
+ overrides: {
162
+ "fcm": {
163
+ "data": {
164
+ "key": "value",
165
+ },
150
166
  },
151
- ],
167
+ },
168
+ to: {
169
+ subscriberId: "<id>",
170
+ },
152
171
  },
153
172
  {
154
- name: "workflow_identifier",
173
+ workflowId: "workflow_identifier",
174
+ payload: {
175
+ "comment_id": "string",
176
+ "post": {
177
+ "text": "string",
178
+ },
179
+ },
180
+ overrides: {
181
+ "fcm": {
182
+ "data": {
183
+ "key": "value",
184
+ },
185
+ },
186
+ },
155
187
  to: [
156
-
188
+ {
189
+ topicKey: "<value>",
190
+ type: "Subscriber",
191
+ },
157
192
  ],
158
193
  },
159
194
  {
160
- name: "workflow_identifier",
161
- to: [
162
- {
163
- topicKey: "<value>",
164
- type: "Topic",
195
+ workflowId: "workflow_identifier",
196
+ payload: {
197
+ "comment_id": "string",
198
+ "post": {
199
+ "text": "string",
165
200
  },
166
- {
167
- topicKey: "<value>",
168
- type: "Topic",
201
+ },
202
+ overrides: {
203
+ "fcm": {
204
+ "data": {
205
+ "key": "value",
206
+ },
169
207
  },
208
+ },
209
+ to: [
210
+ "SUBSCRIBER_ID",
211
+ "SUBSCRIBER_ID",
170
212
  ],
171
213
  },
172
214
  ],
@@ -190,41 +232,71 @@ import { triggerBulk } from "@novu/api/funcs/triggerBulk.js";
190
232
  // Use `NovuCore` for best tree-shaking performance.
191
233
  // You can create one instance of it to use across an application.
192
234
  const novu = new NovuCore({
193
- apiKey: "<YOUR_API_KEY_HERE>",
235
+ secretKey: "<YOUR_API_KEY_HERE>",
194
236
  });
195
237
 
196
238
  async function run() {
197
239
  const res = await triggerBulk(novu, {
198
240
  events: [
199
241
  {
200
- name: "workflow_identifier",
201
- to: [
202
- {
203
- topicKey: "<value>",
204
- type: "Topic",
242
+ workflowId: "workflow_identifier",
243
+ payload: {
244
+ "comment_id": "string",
245
+ "post": {
246
+ "text": "string",
205
247
  },
206
- {
207
- subscriberId: "<id>",
248
+ },
249
+ overrides: {
250
+ "fcm": {
251
+ "data": {
252
+ "key": "value",
253
+ },
208
254
  },
209
- ],
255
+ },
256
+ to: {
257
+ subscriberId: "<id>",
258
+ },
210
259
  },
211
260
  {
212
- name: "workflow_identifier",
261
+ workflowId: "workflow_identifier",
262
+ payload: {
263
+ "comment_id": "string",
264
+ "post": {
265
+ "text": "string",
266
+ },
267
+ },
268
+ overrides: {
269
+ "fcm": {
270
+ "data": {
271
+ "key": "value",
272
+ },
273
+ },
274
+ },
213
275
  to: [
214
-
276
+ {
277
+ topicKey: "<value>",
278
+ type: "Subscriber",
279
+ },
215
280
  ],
216
281
  },
217
282
  {
218
- name: "workflow_identifier",
219
- to: [
220
- {
221
- topicKey: "<value>",
222
- type: "Topic",
283
+ workflowId: "workflow_identifier",
284
+ payload: {
285
+ "comment_id": "string",
286
+ "post": {
287
+ "text": "string",
223
288
  },
224
- {
225
- topicKey: "<value>",
226
- type: "Topic",
289
+ },
290
+ overrides: {
291
+ "fcm": {
292
+ "data": {
293
+ "key": "value",
294
+ },
227
295
  },
296
+ },
297
+ to: [
298
+ "SUBSCRIBER_ID",
299
+ "SUBSCRIBER_ID",
228
300
  ],
229
301
  },
230
302
  ],
@@ -261,8 +333,8 @@ run();
261
333
 
262
334
  | Error Type | Status Code | Content Type |
263
335
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
264
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
265
336
  | errors.ErrorDto | 414 | application/json |
337
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
266
338
  | errors.ValidationErrorDto | 422 | application/json |
267
339
  | errors.ErrorDto | 500 | application/json |
268
340
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -278,7 +350,7 @@ Trigger a broadcast event to all existing subscribers, could be used to send ann
278
350
  import { Novu } from "@novu/api";
279
351
 
280
352
  const novu = new Novu({
281
- apiKey: "<YOUR_API_KEY_HERE>",
353
+ secretKey: "<YOUR_API_KEY_HERE>",
282
354
  });
283
355
 
284
356
  async function run() {
@@ -310,7 +382,7 @@ import { triggerBroadcast } from "@novu/api/funcs/triggerBroadcast.js";
310
382
  // Use `NovuCore` for best tree-shaking performance.
311
383
  // You can create one instance of it to use across an application.
312
384
  const novu = new NovuCore({
313
- apiKey: "<YOUR_API_KEY_HERE>",
385
+ secretKey: "<YOUR_API_KEY_HERE>",
314
386
  });
315
387
 
316
388
  async function run() {
@@ -355,8 +427,8 @@ run();
355
427
 
356
428
  | Error Type | Status Code | Content Type |
357
429
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
358
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
359
430
  | errors.ErrorDto | 414 | application/json |
431
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
360
432
  | errors.ValidationErrorDto | 422 | application/json |
361
433
  | errors.ErrorDto | 500 | application/json |
362
434
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -374,7 +446,7 @@ run();
374
446
  import { Novu } from "@novu/api";
375
447
 
376
448
  const novu = new Novu({
377
- apiKey: "<YOUR_API_KEY_HERE>",
449
+ secretKey: "<YOUR_API_KEY_HERE>",
378
450
  });
379
451
 
380
452
  async function run() {
@@ -398,7 +470,7 @@ import { cancel } from "@novu/api/funcs/cancel.js";
398
470
  // Use `NovuCore` for best tree-shaking performance.
399
471
  // You can create one instance of it to use across an application.
400
472
  const novu = new NovuCore({
401
- apiKey: "<YOUR_API_KEY_HERE>",
473
+ secretKey: "<YOUR_API_KEY_HERE>",
402
474
  });
403
475
 
404
476
  async function run() {
@@ -435,8 +507,8 @@ run();
435
507
 
436
508
  | Error Type | Status Code | Content Type |
437
509
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
438
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
439
510
  | errors.ErrorDto | 414 | application/json |
511
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
440
512
  | errors.ValidationErrorDto | 422 | application/json |
441
513
  | errors.ErrorDto | 500 | application/json |
442
514
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -19,13 +19,13 @@ Mark a subscriber messages as seen, read, unseen or unread
19
19
  import { Novu } from "@novu/api";
20
20
 
21
21
  const novu = new Novu({
22
- apiKey: "<YOUR_API_KEY_HERE>",
22
+ secretKey: "<YOUR_API_KEY_HERE>",
23
23
  });
24
24
 
25
25
  async function run() {
26
26
  const result = await novu.subscribers.messages.markAllAs({
27
- messageId: "<value>",
28
- markAs: "read",
27
+ messageId: "<id>",
28
+ markAs: "unread",
29
29
  }, "<id>");
30
30
 
31
31
  // Handle the result
@@ -46,13 +46,13 @@ import { subscribersMessagesMarkAllAs } from "@novu/api/funcs/subscribersMessage
46
46
  // Use `NovuCore` for best tree-shaking performance.
47
47
  // You can create one instance of it to use across an application.
48
48
  const novu = new NovuCore({
49
- apiKey: "<YOUR_API_KEY_HERE>",
49
+ secretKey: "<YOUR_API_KEY_HERE>",
50
50
  });
51
51
 
52
52
  async function run() {
53
53
  const res = await subscribersMessagesMarkAllAs(novu, {
54
- messageId: "<value>",
55
- markAs: "read",
54
+ messageId: "<id>",
55
+ markAs: "unread",
56
56
  }, "<id>");
57
57
 
58
58
  if (!res.ok) {
@@ -81,14 +81,14 @@ run();
81
81
 
82
82
  ### Response
83
83
 
84
- **Promise\<[operations.SubscribersControllerMarkMessagesAsResponse](../../models/operations/subscriberscontrollermarkmessagesasresponse.md)\>**
84
+ **Promise\<[operations.SubscribersV1ControllerMarkMessagesAsResponse](../../models/operations/subscribersv1controllermarkmessagesasresponse.md)\>**
85
85
 
86
86
  ### Errors
87
87
 
88
88
  | Error Type | Status Code | Content Type |
89
89
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
90
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
91
90
  | errors.ErrorDto | 414 | application/json |
91
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
92
92
  | errors.ValidationErrorDto | 422 | application/json |
93
93
  | errors.ErrorDto | 500 | application/json |
94
94
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -103,7 +103,7 @@ Marks all the subscriber messages as read, unread, seen or unseen. Optionally yo
103
103
  import { Novu } from "@novu/api";
104
104
 
105
105
  const novu = new Novu({
106
- apiKey: "<YOUR_API_KEY_HERE>",
106
+ secretKey: "<YOUR_API_KEY_HERE>",
107
107
  });
108
108
 
109
109
  async function run() {
@@ -129,7 +129,7 @@ import { subscribersMessagesMarkAll } from "@novu/api/funcs/subscribersMessagesM
129
129
  // Use `NovuCore` for best tree-shaking performance.
130
130
  // You can create one instance of it to use across an application.
131
131
  const novu = new NovuCore({
132
- apiKey: "<YOUR_API_KEY_HERE>",
132
+ secretKey: "<YOUR_API_KEY_HERE>",
133
133
  });
134
134
 
135
135
  async function run() {
@@ -163,14 +163,14 @@ run();
163
163
 
164
164
  ### Response
165
165
 
166
- **Promise\<[operations.SubscribersControllerMarkAllUnreadAsReadResponse](../../models/operations/subscriberscontrollermarkallunreadasreadresponse.md)\>**
166
+ **Promise\<[operations.SubscribersV1ControllerMarkAllUnreadAsReadResponse](../../models/operations/subscribersv1controllermarkallunreadasreadresponse.md)\>**
167
167
 
168
168
  ### Errors
169
169
 
170
170
  | Error Type | Status Code | Content Type |
171
171
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
172
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
173
172
  | errors.ErrorDto | 414 | application/json |
173
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
174
174
  | errors.ValidationErrorDto | 422 | application/json |
175
175
  | errors.ErrorDto | 500 | application/json |
176
176
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -185,7 +185,7 @@ Mark message action as seen
185
185
  import { Novu } from "@novu/api";
186
186
 
187
187
  const novu = new Novu({
188
- apiKey: "<YOUR_API_KEY_HERE>",
188
+ secretKey: "<YOUR_API_KEY_HERE>",
189
189
  });
190
190
 
191
191
  async function run() {
@@ -216,7 +216,7 @@ import { subscribersMessagesUpdateAsSeen } from "@novu/api/funcs/subscribersMess
216
216
  // Use `NovuCore` for best tree-shaking performance.
217
217
  // You can create one instance of it to use across an application.
218
218
  const novu = new NovuCore({
219
- apiKey: "<YOUR_API_KEY_HERE>",
219
+ secretKey: "<YOUR_API_KEY_HERE>",
220
220
  });
221
221
 
222
222
  async function run() {
@@ -246,21 +246,21 @@ run();
246
246
 
247
247
  | Parameter | Type | Required | Description |
248
248
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
249
- | `request` | [operations.SubscribersControllerMarkActionAsSeenRequest](../../models/operations/subscriberscontrollermarkactionasseenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
249
+ | `request` | [operations.SubscribersV1ControllerMarkActionAsSeenRequest](../../models/operations/subscribersv1controllermarkactionasseenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
250
250
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
251
251
  | `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. |
252
252
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
253
253
 
254
254
  ### Response
255
255
 
256
- **Promise\<[operations.SubscribersControllerMarkActionAsSeenResponse](../../models/operations/subscriberscontrollermarkactionasseenresponse.md)\>**
256
+ **Promise\<[operations.SubscribersV1ControllerMarkActionAsSeenResponse](../../models/operations/subscribersv1controllermarkactionasseenresponse.md)\>**
257
257
 
258
258
  ### Errors
259
259
 
260
260
  | Error Type | Status Code | Content Type |
261
261
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
262
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
263
262
  | errors.ErrorDto | 414 | application/json |
263
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
264
264
  | errors.ValidationErrorDto | 422 | application/json |
265
265
  | errors.ErrorDto | 500 | application/json |
266
266
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -18,12 +18,13 @@ Get in-app notification feed for a particular subscriber
18
18
  import { Novu } from "@novu/api";
19
19
 
20
20
  const novu = new Novu({
21
- apiKey: "<YOUR_API_KEY_HERE>",
21
+ secretKey: "<YOUR_API_KEY_HERE>",
22
22
  });
23
23
 
24
24
  async function run() {
25
25
  const result = await novu.subscribers.notifications.feed({
26
26
  subscriberId: "<id>",
27
+ limit: 10,
27
28
  payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
28
29
  });
29
30
 
@@ -45,12 +46,13 @@ import { subscribersNotificationsFeed } from "@novu/api/funcs/subscribersNotific
45
46
  // Use `NovuCore` for best tree-shaking performance.
46
47
  // You can create one instance of it to use across an application.
47
48
  const novu = new NovuCore({
48
- apiKey: "<YOUR_API_KEY_HERE>",
49
+ secretKey: "<YOUR_API_KEY_HERE>",
49
50
  });
50
51
 
51
52
  async function run() {
52
53
  const res = await subscribersNotificationsFeed(novu, {
53
54
  subscriberId: "<id>",
55
+ limit: 10,
54
56
  payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
55
57
  });
56
58
 
@@ -71,21 +73,21 @@ run();
71
73
 
72
74
  | Parameter | Type | Required | Description |
73
75
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
74
- | `request` | [operations.SubscribersControllerGetNotificationsFeedRequest](../../models/operations/subscriberscontrollergetnotificationsfeedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
+ | `request` | [operations.SubscribersV1ControllerGetNotificationsFeedRequest](../../models/operations/subscribersv1controllergetnotificationsfeedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
75
77
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
76
78
  | `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. |
77
79
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
78
80
 
79
81
  ### Response
80
82
 
81
- **Promise\<[operations.SubscribersControllerGetNotificationsFeedResponse](../../models/operations/subscriberscontrollergetnotificationsfeedresponse.md)\>**
83
+ **Promise\<[operations.SubscribersV1ControllerGetNotificationsFeedResponse](../../models/operations/subscribersv1controllergetnotificationsfeedresponse.md)\>**
82
84
 
83
85
  ### Errors
84
86
 
85
87
  | Error Type | Status Code | Content Type |
86
88
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
87
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
88
89
  | errors.ErrorDto | 414 | application/json |
90
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
89
91
  | errors.ValidationErrorDto | 422 | application/json |
90
92
  | errors.ErrorDto | 500 | application/json |
91
93
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -100,14 +102,14 @@ Get the unseen in-app notifications count for subscribers feed
100
102
  import { Novu } from "@novu/api";
101
103
 
102
104
  const novu = new Novu({
103
- apiKey: "<YOUR_API_KEY_HERE>",
105
+ secretKey: "<YOUR_API_KEY_HERE>",
104
106
  });
105
107
 
106
108
  async function run() {
107
109
  const result = await novu.subscribers.notifications.unseenCount({
108
110
  subscriberId: "<id>",
109
111
  seen: false,
110
- limit: 2979.49,
112
+ limit: 100,
111
113
  });
112
114
 
113
115
  // Handle the result
@@ -128,14 +130,14 @@ import { subscribersNotificationsUnseenCount } from "@novu/api/funcs/subscribers
128
130
  // Use `NovuCore` for best tree-shaking performance.
129
131
  // You can create one instance of it to use across an application.
130
132
  const novu = new NovuCore({
131
- apiKey: "<YOUR_API_KEY_HERE>",
133
+ secretKey: "<YOUR_API_KEY_HERE>",
132
134
  });
133
135
 
134
136
  async function run() {
135
137
  const res = await subscribersNotificationsUnseenCount(novu, {
136
138
  subscriberId: "<id>",
137
139
  seen: false,
138
- limit: 2979.49,
140
+ limit: 100,
139
141
  });
140
142
 
141
143
  if (!res.ok) {
@@ -155,21 +157,21 @@ run();
155
157
 
156
158
  | Parameter | Type | Required | Description |
157
159
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
- | `request` | [operations.SubscribersControllerGetUnseenCountRequest](../../models/operations/subscriberscontrollergetunseencountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
160
+ | `request` | [operations.SubscribersV1ControllerGetUnseenCountRequest](../../models/operations/subscribersv1controllergetunseencountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
159
161
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
162
  | `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
163
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
164
 
163
165
  ### Response
164
166
 
165
- **Promise\<[operations.SubscribersControllerGetUnseenCountResponse](../../models/operations/subscriberscontrollergetunseencountresponse.md)\>**
167
+ **Promise\<[operations.SubscribersV1ControllerGetUnseenCountResponse](../../models/operations/subscribersv1controllergetunseencountresponse.md)\>**
166
168
 
167
169
  ### Errors
168
170
 
169
171
  | Error Type | Status Code | Content Type |
170
172
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
171
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
172
173
  | errors.ErrorDto | 414 | application/json |
174
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
173
175
  | errors.ValidationErrorDto | 422 | application/json |
174
176
  | errors.ErrorDto | 500 | application/json |
175
177
  | errors.SDKError | 4XX, 5XX | \*/\* |