@novu/api 0.1.1 → 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 (556) hide show
  1. package/FUNCTIONS.md +2 -3
  2. package/README.md +36 -42
  3. package/docs/sdks/authentication/README.md +10 -10
  4. package/docs/sdks/credentials/README.md +12 -12
  5. package/docs/sdks/integrations/README.md +18 -18
  6. package/docs/sdks/messages/README.md +9 -9
  7. package/docs/sdks/notifications/README.md +6 -6
  8. package/docs/sdks/novu/README.md +21 -179
  9. package/docs/sdks/novumessages/README.md +13 -13
  10. package/docs/sdks/novunotifications/README.md +10 -10
  11. package/docs/sdks/novusubscribers/README.md +9 -9
  12. package/docs/sdks/preferences/README.md +18 -18
  13. package/docs/sdks/properties/README.md +4 -4
  14. package/docs/sdks/stats/README.md +6 -6
  15. package/docs/sdks/subscribers/README.md +347 -33
  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/{create.js → subscribersDeleteLegacy.js} +51 -20
  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/{supportControllerFetchUserOrganizations.js → subscribersPatch.js} +48 -16
  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/security.js +1 -1
  176. package/lib/security.js.map +1 -1
  177. package/models/components/{channelsettings.d.ts → channelsettingsdto.d.ts} +22 -22
  178. package/models/components/channelsettingsdto.d.ts.map +1 -0
  179. package/models/components/{channelsettings.js → channelsettingsdto.js} +29 -29
  180. package/models/components/channelsettingsdto.js.map +1 -0
  181. package/models/components/index.d.ts +4 -4
  182. package/models/components/index.d.ts.map +1 -1
  183. package/models/components/index.js +4 -4
  184. package/models/components/index.js.map +1 -1
  185. package/models/components/listsubscribersresponsedto.d.ts +43 -0
  186. package/models/components/listsubscribersresponsedto.d.ts.map +1 -0
  187. package/models/components/listsubscribersresponsedto.js +64 -0
  188. package/models/components/listsubscribersresponsedto.js.map +1 -0
  189. package/models/components/patchsubscriberrequestdto.d.ts +96 -0
  190. package/models/components/patchsubscriberrequestdto.d.ts.map +1 -0
  191. package/models/components/patchsubscriberrequestdto.js +100 -0
  192. package/models/components/patchsubscriberrequestdto.js.map +1 -0
  193. package/models/components/removesubscriberresponsedto.d.ts +37 -0
  194. package/models/components/removesubscriberresponsedto.d.ts.map +1 -0
  195. package/models/components/removesubscriberresponsedto.js +61 -0
  196. package/models/components/removesubscriberresponsedto.js.map +1 -0
  197. package/models/components/security.d.ts +2 -2
  198. package/models/components/security.d.ts.map +1 -1
  199. package/models/components/security.js +2 -11
  200. package/models/components/security.js.map +1 -1
  201. package/models/components/subscriberresponsedto.d.ts +14 -3
  202. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  203. package/models/components/subscriberresponsedto.js +5 -3
  204. package/models/components/subscriberresponsedto.js.map +1 -1
  205. package/models/components/triggereventrequestdto.d.ts +1 -12
  206. package/models/components/triggereventrequestdto.d.ts.map +1 -1
  207. package/models/components/triggereventrequestdto.js +10 -6
  208. package/models/components/triggereventrequestdto.js.map +1 -1
  209. package/models/operations/index.d.ts +23 -21
  210. package/models/operations/index.d.ts.map +1 -1
  211. package/models/operations/index.js +23 -21
  212. package/models/operations/index.js.map +1 -1
  213. package/models/operations/subscriberscontrollergetsubscriber.d.ts +0 -5
  214. package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
  215. package/models/operations/subscriberscontrollergetsubscriber.js +0 -2
  216. package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
  217. package/models/operations/subscriberscontrollerpatchsubscriber.d.ts +68 -0
  218. package/models/operations/subscriberscontrollerpatchsubscriber.d.ts.map +1 -0
  219. package/models/operations/subscriberscontrollerpatchsubscriber.js +114 -0
  220. package/models/operations/subscriberscontrollerpatchsubscriber.js.map +1 -0
  221. package/models/operations/subscriberscontrollerremovesubscriber.d.ts +2 -2
  222. package/models/operations/subscriberscontrollerremovesubscriber.js +2 -2
  223. package/models/operations/subscriberscontrollersearchsubscribers.d.ts +126 -0
  224. package/models/operations/subscriberscontrollersearchsubscribers.d.ts.map +1 -0
  225. package/models/operations/subscriberscontrollersearchsubscribers.js +145 -0
  226. package/models/operations/subscriberscontrollersearchsubscribers.js.map +1 -0
  227. package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts +66 -0
  228. package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts.map +1 -0
  229. package/models/operations/subscribersv1controllerbulkcreatesubscribers.js +112 -0
  230. package/models/operations/subscribersv1controllerbulkcreatesubscribers.js.map +1 -0
  231. package/models/operations/subscribersv1controllerchataccessoauth.d.ts +80 -0
  232. package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +1 -0
  233. package/models/operations/subscribersv1controllerchataccessoauth.js +113 -0
  234. package/models/operations/subscribersv1controllerchataccessoauth.js.map +1 -0
  235. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +108 -0
  236. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +1 -0
  237. package/models/operations/subscribersv1controllerchatoauthcallback.js +143 -0
  238. package/models/operations/subscribersv1controllerchatoauthcallback.js.map +1 -0
  239. package/models/operations/subscribersv1controllercreatesubscriber.d.ts +66 -0
  240. package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +1 -0
  241. package/models/operations/subscribersv1controllercreatesubscriber.js +112 -0
  242. package/models/operations/subscribersv1controllercreatesubscriber.js.map +1 -0
  243. package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts +65 -0
  244. package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts.map +1 -0
  245. package/models/operations/subscribersv1controllerdeletesubscribercredentials.js +111 -0
  246. package/models/operations/subscribersv1controllerdeletesubscribercredentials.js.map +1 -0
  247. package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts +79 -0
  248. package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts.map +1 -0
  249. package/models/operations/subscribersv1controllergetnotificationsfeed.js +120 -0
  250. package/models/operations/subscribersv1controllergetnotificationsfeed.js.map +1 -0
  251. package/models/operations/subscribersv1controllergetsubscriber.d.ts +71 -0
  252. package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +1 -0
  253. package/models/operations/subscribersv1controllergetsubscriber.js +112 -0
  254. package/models/operations/subscribersv1controllergetsubscriber.js.map +1 -0
  255. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +108 -0
  256. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +1 -0
  257. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +141 -0
  258. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +1 -0
  259. package/models/operations/subscribersv1controllergetunseencount.d.ts +76 -0
  260. package/models/operations/subscribersv1controllergetunseencount.d.ts.map +1 -0
  261. package/models/operations/subscribersv1controllergetunseencount.js +114 -0
  262. package/models/operations/subscribersv1controllergetunseencount.js.map +1 -0
  263. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +71 -0
  264. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +1 -0
  265. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +116 -0
  266. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +1 -0
  267. package/models/operations/subscribersv1controllerlistsubscribers.d.ts +108 -0
  268. package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +1 -0
  269. package/models/operations/subscribersv1controllerlistsubscribers.js +145 -0
  270. package/models/operations/subscribersv1controllerlistsubscribers.js.map +1 -0
  271. package/models/operations/subscribersv1controllermarkactionasseen.d.ts +72 -0
  272. package/models/operations/subscribersv1controllermarkactionasseen.d.ts.map +1 -0
  273. package/models/operations/subscribersv1controllermarkactionasseen.js +118 -0
  274. package/models/operations/subscribersv1controllermarkactionasseen.js.map +1 -0
  275. package/models/operations/subscribersv1controllermarkallunreadasread.d.ts +68 -0
  276. package/models/operations/subscribersv1controllermarkallunreadasread.d.ts.map +1 -0
  277. package/models/operations/subscribersv1controllermarkallunreadasread.js +114 -0
  278. package/models/operations/subscribersv1controllermarkallunreadasread.js.map +1 -0
  279. package/models/operations/subscribersv1controllermarkmessagesas.d.ts +68 -0
  280. package/models/operations/subscribersv1controllermarkmessagesas.d.ts.map +1 -0
  281. package/models/operations/subscribersv1controllermarkmessagesas.js +114 -0
  282. package/models/operations/subscribersv1controllermarkmessagesas.js.map +1 -0
  283. package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts +68 -0
  284. package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts.map +1 -0
  285. package/models/operations/subscribersv1controllermodifysubscriberchannel.js +115 -0
  286. package/models/operations/subscribersv1controllermodifysubscriberchannel.js.map +1 -0
  287. package/models/operations/subscribersv1controllerremovesubscriber.d.ts +66 -0
  288. package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +1 -0
  289. package/models/operations/subscribersv1controllerremovesubscriber.js +110 -0
  290. package/models/operations/subscribersv1controllerremovesubscriber.js.map +1 -0
  291. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +68 -0
  292. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +1 -0
  293. package/models/operations/subscribersv1controllerupdatesubscriber.js +114 -0
  294. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +1 -0
  295. package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts +68 -0
  296. package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts.map +1 -0
  297. package/models/operations/subscribersv1controllerupdatesubscriberchannel.js +115 -0
  298. package/models/operations/subscribersv1controllerupdatesubscriberchannel.js.map +1 -0
  299. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +68 -0
  300. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +1 -0
  301. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +118 -0
  302. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +1 -0
  303. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts +68 -0
  304. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts.map +1 -0
  305. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js +118 -0
  306. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js.map +1 -0
  307. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +70 -0
  308. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +1 -0
  309. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +120 -0
  310. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +1 -0
  311. package/package.json +6 -7
  312. package/sdk/authentication.d.ts +3 -3
  313. package/sdk/authentication.d.ts.map +1 -1
  314. package/sdk/authentication.js.map +1 -1
  315. package/sdk/credentials.d.ts +3 -3
  316. package/sdk/credentials.d.ts.map +1 -1
  317. package/sdk/credentials.js.map +1 -1
  318. package/sdk/novumessages.d.ts +3 -3
  319. package/sdk/novumessages.d.ts.map +1 -1
  320. package/sdk/novumessages.js.map +1 -1
  321. package/sdk/novunotifications.d.ts +2 -2
  322. package/sdk/novunotifications.d.ts.map +1 -1
  323. package/sdk/novunotifications.js.map +1 -1
  324. package/sdk/preferences.d.ts +4 -4
  325. package/sdk/preferences.d.ts.map +1 -1
  326. package/sdk/preferences.js.map +1 -1
  327. package/sdk/properties.d.ts +1 -1
  328. package/sdk/properties.d.ts.map +1 -1
  329. package/sdk/sdk.d.ts +0 -8
  330. package/sdk/sdk.d.ts.map +1 -1
  331. package/sdk/sdk.js +0 -14
  332. package/sdk/sdk.js.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 -344
  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/{supportControllerFetchUserOrganizations.ts → subscribersPatch.ts} +73 -19
  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/{create.ts → subscribersSearch.ts} +78 -31
  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/security.ts +1 -1
  392. package/src/models/components/{channelsettings.ts → channelsettingsdto.ts} +40 -38
  393. package/src/models/components/index.ts +4 -4
  394. package/src/models/components/listsubscribersresponsedto.ts +89 -0
  395. package/src/models/components/patchsubscriberrequestdto.ts +182 -0
  396. package/src/models/components/removesubscriberresponsedto.ts +78 -0
  397. package/src/models/components/security.ts +4 -13
  398. package/src/models/components/subscriberresponsedto.ts +18 -9
  399. package/src/models/components/triggereventrequestdto.ts +11 -22
  400. package/src/models/operations/index.ts +23 -21
  401. package/src/models/operations/subscriberscontrollergetsubscriber.ts +0 -7
  402. package/src/models/operations/subscriberscontrollerpatchsubscriber.ts +189 -0
  403. package/src/models/operations/subscriberscontrollerremovesubscriber.ts +4 -4
  404. package/src/models/operations/subscriberscontrollersearchsubscribers.ts +260 -0
  405. package/src/models/operations/subscribersv1controllerbulkcreatesubscribers.ts +185 -0
  406. package/src/models/operations/{subscriberscontrollerchataccessoauth.ts → subscribersv1controllerchataccessoauth.ts} +47 -46
  407. package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +281 -0
  408. package/src/models/operations/subscribersv1controllercreatesubscriber.ts +187 -0
  409. package/src/models/operations/subscribersv1controllerdeletesubscribercredentials.ts +178 -0
  410. package/src/models/operations/{subscriberscontrollergetnotificationsfeed.ts → subscribersv1controllergetnotificationsfeed.ts} +46 -46
  411. package/src/models/operations/subscribersv1controllergetsubscriber.ts +188 -0
  412. package/src/models/operations/{subscriberscontrollergetsubscriberpreferencebylevel.ts → subscribersv1controllergetsubscriberpreferencebylevel.ts} +46 -46
  413. package/src/models/operations/subscribersv1controllergetunseencount.ts +195 -0
  414. package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +191 -0
  415. package/src/models/operations/subscribersv1controllerlistsubscribers.ts +283 -0
  416. package/src/models/operations/{subscriberscontrollermarkactionasseen.ts → subscribersv1controllermarkactionasseen.ts} +48 -46
  417. package/src/models/operations/subscribersv1controllermarkallunreadasread.ts +191 -0
  418. package/src/models/operations/subscribersv1controllermarkmessagesas.ts +187 -0
  419. package/src/models/operations/subscribersv1controllermodifysubscriberchannel.ts +192 -0
  420. package/src/models/operations/subscribersv1controllerremovesubscriber.ts +183 -0
  421. package/src/models/operations/{subscriberscontrollerupdatesubscriber.ts → subscribersv1controllerupdatesubscriber.ts} +48 -46
  422. package/src/models/operations/subscribersv1controllerupdatesubscriberchannel.ts +192 -0
  423. package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +195 -0
  424. package/src/models/operations/subscribersv1controllerupdatesubscriberonlineflag.ts +193 -0
  425. package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +197 -0
  426. package/src/sdk/authentication.ts +4 -4
  427. package/src/sdk/credentials.ts +7 -3
  428. package/src/sdk/novumessages.ts +4 -4
  429. package/src/sdk/novunotifications.ts +4 -4
  430. package/src/sdk/preferences.ts +7 -6
  431. package/src/sdk/properties.ts +1 -1
  432. package/src/sdk/sdk.ts +0 -34
  433. package/src/sdk/subscribers.ts +89 -10
  434. package/funcs/create.d.ts +0 -9
  435. package/funcs/create.d.ts.map +0 -1
  436. package/funcs/create.js.map +0 -1
  437. package/funcs/supportControllerFetchUserOrganizations.d.ts +0 -10
  438. package/funcs/supportControllerFetchUserOrganizations.d.ts.map +0 -1
  439. package/funcs/supportControllerFetchUserOrganizations.js.map +0 -1
  440. package/models/components/channelsettings.d.ts.map +0 -1
  441. package/models/components/channelsettings.js.map +0 -1
  442. package/models/components/createsupportthreaddto.d.ts +0 -29
  443. package/models/components/createsupportthreaddto.d.ts.map +0 -1
  444. package/models/components/createsupportthreaddto.js +0 -59
  445. package/models/components/createsupportthreaddto.js.map +0 -1
  446. package/models/components/plaincardrequestdto.d.ts +0 -100
  447. package/models/components/plaincardrequestdto.d.ts.map +0 -1
  448. package/models/components/plaincardrequestdto.js +0 -139
  449. package/models/components/plaincardrequestdto.js.map +0 -1
  450. package/models/components/workflowtostepcontrolvaluesdto.d.ts +0 -40
  451. package/models/components/workflowtostepcontrolvaluesdto.d.ts.map +0 -1
  452. package/models/components/workflowtostepcontrolvaluesdto.js +0 -59
  453. package/models/components/workflowtostepcontrolvaluesdto.js.map +0 -1
  454. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +0 -66
  455. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +0 -1
  456. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +0 -112
  457. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +0 -1
  458. package/models/operations/subscriberscontrollerchataccessoauth.d.ts +0 -80
  459. package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +0 -1
  460. package/models/operations/subscriberscontrollerchataccessoauth.js +0 -113
  461. package/models/operations/subscriberscontrollerchataccessoauth.js.map +0 -1
  462. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +0 -108
  463. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +0 -1
  464. package/models/operations/subscriberscontrollerchatoauthcallback.js +0 -142
  465. package/models/operations/subscriberscontrollerchatoauthcallback.js.map +0 -1
  466. package/models/operations/subscriberscontrollercreatesubscriber.d.ts +0 -66
  467. package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +0 -1
  468. package/models/operations/subscriberscontrollercreatesubscriber.js +0 -112
  469. package/models/operations/subscriberscontrollercreatesubscriber.js.map +0 -1
  470. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +0 -65
  471. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +0 -1
  472. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +0 -111
  473. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +0 -1
  474. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +0 -79
  475. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +0 -1
  476. package/models/operations/subscriberscontrollergetnotificationsfeed.js +0 -120
  477. package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +0 -1
  478. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +0 -108
  479. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +0 -1
  480. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +0 -141
  481. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +0 -1
  482. package/models/operations/subscriberscontrollergetunseencount.d.ts +0 -76
  483. package/models/operations/subscriberscontrollergetunseencount.d.ts.map +0 -1
  484. package/models/operations/subscriberscontrollergetunseencount.js +0 -114
  485. package/models/operations/subscriberscontrollergetunseencount.js.map +0 -1
  486. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +0 -71
  487. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +0 -1
  488. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +0 -113
  489. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +0 -1
  490. package/models/operations/subscriberscontrollerlistsubscribers.d.ts +0 -108
  491. package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +0 -1
  492. package/models/operations/subscriberscontrollerlistsubscribers.js +0 -145
  493. package/models/operations/subscriberscontrollerlistsubscribers.js.map +0 -1
  494. package/models/operations/subscriberscontrollermarkactionasseen.d.ts +0 -72
  495. package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +0 -1
  496. package/models/operations/subscriberscontrollermarkactionasseen.js +0 -118
  497. package/models/operations/subscriberscontrollermarkactionasseen.js.map +0 -1
  498. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +0 -68
  499. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +0 -1
  500. package/models/operations/subscriberscontrollermarkallunreadasread.js +0 -114
  501. package/models/operations/subscriberscontrollermarkallunreadasread.js.map +0 -1
  502. package/models/operations/subscriberscontrollermarkmessagesas.d.ts +0 -68
  503. package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +0 -1
  504. package/models/operations/subscriberscontrollermarkmessagesas.js +0 -114
  505. package/models/operations/subscriberscontrollermarkmessagesas.js.map +0 -1
  506. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +0 -68
  507. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +0 -1
  508. package/models/operations/subscriberscontrollermodifysubscriberchannel.js +0 -114
  509. package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +0 -1
  510. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +0 -68
  511. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +0 -1
  512. package/models/operations/subscriberscontrollerupdatesubscriber.js +0 -114
  513. package/models/operations/subscriberscontrollerupdatesubscriber.js.map +0 -1
  514. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +0 -68
  515. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +0 -1
  516. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +0 -114
  517. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +0 -1
  518. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +0 -68
  519. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +0 -1
  520. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +0 -118
  521. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +0 -1
  522. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +0 -68
  523. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +0 -1
  524. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +0 -117
  525. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +0 -1
  526. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +0 -70
  527. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +0 -1
  528. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +0 -119
  529. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +0 -1
  530. package/models/operations/supportcontrollercreatethread.d.ts +0 -35
  531. package/models/operations/supportcontrollercreatethread.d.ts.map +0 -1
  532. package/models/operations/supportcontrollercreatethread.js +0 -73
  533. package/models/operations/supportcontrollercreatethread.js.map +0 -1
  534. package/models/operations/supportcontrollerfetchuserorganizations.d.ts +0 -56
  535. package/models/operations/supportcontrollerfetchuserorganizations.d.ts.map +0 -1
  536. package/models/operations/supportcontrollerfetchuserorganizations.js +0 -96
  537. package/models/operations/supportcontrollerfetchuserorganizations.js.map +0 -1
  538. package/src/models/components/createsupportthreaddto.ts +0 -66
  539. package/src/models/components/plaincardrequestdto.ts +0 -223
  540. package/src/models/components/workflowtostepcontrolvaluesdto.ts +0 -71
  541. package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +0 -185
  542. package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +0 -281
  543. package/src/models/operations/subscriberscontrollercreatesubscriber.ts +0 -185
  544. package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +0 -177
  545. package/src/models/operations/subscriberscontrollergetunseencount.ts +0 -192
  546. package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +0 -193
  547. package/src/models/operations/subscriberscontrollerlistsubscribers.ts +0 -282
  548. package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +0 -191
  549. package/src/models/operations/subscriberscontrollermarkmessagesas.ts +0 -184
  550. package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +0 -193
  551. package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +0 -193
  552. package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +0 -195
  553. package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +0 -192
  554. package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +0 -196
  555. package/src/models/operations/supportcontrollercreatethread.ts +0 -90
  556. package/src/models/operations/supportcontrollerfetchuserorganizations.ts +0 -163
package/FUNCTIONS.md CHANGED
@@ -26,19 +26,18 @@ import { SDKValidationError } from "@novu/api/models/errors/sdkvalidationerror.j
26
26
  // Use `NovuCore` for best tree-shaking performance.
27
27
  // You can create one instance of it to use across an application.
28
28
  const novu = new NovuCore({
29
- apiKey: "<YOUR_API_KEY_HERE>",
29
+ secretKey: "<YOUR_API_KEY_HERE>",
30
30
  });
31
31
 
32
32
  async function run() {
33
33
  const res = await trigger(novu, {
34
- name: "workflow_identifier",
34
+ workflowId: "workflow_identifier",
35
35
  payload: {
36
36
  "comment_id": "string",
37
37
  "post": {
38
38
  "text": "string",
39
39
  },
40
40
  },
41
- bridgeUrl: "https://example.com/bridge",
42
41
  overrides: {
43
42
  "fcm": {
44
43
  "data": {
package/README.md CHANGED
@@ -83,19 +83,18 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
83
83
  import { Novu } from "@novu/api";
84
84
 
85
85
  const novu = new Novu({
86
- apiKey: "<YOUR_API_KEY_HERE>",
86
+ secretKey: "<YOUR_API_KEY_HERE>",
87
87
  });
88
88
 
89
89
  async function run() {
90
90
  const result = await novu.trigger({
91
- name: "workflow_identifier",
91
+ workflowId: "workflow_identifier",
92
92
  payload: {
93
93
  "comment_id": "string",
94
94
  "post": {
95
95
  "text": "string",
96
96
  },
97
97
  },
98
- bridgeUrl: "https://example.com/bridge",
99
98
  overrides: {
100
99
  "fcm": {
101
100
  "data": {
@@ -122,21 +121,20 @@ run();
122
121
  import { Novu } from "@novu/api";
123
122
 
124
123
  const novu = new Novu({
125
- apiKey: "<YOUR_API_KEY_HERE>",
124
+ secretKey: "<YOUR_API_KEY_HERE>",
126
125
  });
127
126
 
128
127
  async function run() {
129
128
  const result = await novu.triggerBulk({
130
129
  events: [
131
130
  {
132
- name: "workflow_identifier",
131
+ workflowId: "workflow_identifier",
133
132
  payload: {
134
133
  "comment_id": "string",
135
134
  "post": {
136
135
  "text": "string",
137
136
  },
138
137
  },
139
- bridgeUrl: "https://example.com/bridge",
140
138
  overrides: {
141
139
  "fcm": {
142
140
  "data": {
@@ -149,14 +147,13 @@ async function run() {
149
147
  },
150
148
  },
151
149
  {
152
- name: "workflow_identifier",
150
+ workflowId: "workflow_identifier",
153
151
  payload: {
154
152
  "comment_id": "string",
155
153
  "post": {
156
154
  "text": "string",
157
155
  },
158
156
  },
159
- bridgeUrl: "https://example.com/bridge",
160
157
  overrides: {
161
158
  "fcm": {
162
159
  "data": {
@@ -172,14 +169,13 @@ async function run() {
172
169
  ],
173
170
  },
174
171
  {
175
- name: "workflow_identifier",
172
+ workflowId: "workflow_identifier",
176
173
  payload: {
177
174
  "comment_id": "string",
178
175
  "post": {
179
176
  "text": "string",
180
177
  },
181
178
  },
182
- bridgeUrl: "https://example.com/bridge",
183
179
  overrides: {
184
180
  "fcm": {
185
181
  "data": {
@@ -209,7 +205,7 @@ run();
209
205
  import { Novu } from "@novu/api";
210
206
 
211
207
  const novu = new Novu({
212
- apiKey: "<YOUR_API_KEY_HERE>",
208
+ secretKey: "<YOUR_API_KEY_HERE>",
213
209
  });
214
210
 
215
211
  async function run() {
@@ -237,7 +233,7 @@ run();
237
233
  import { Novu } from "@novu/api";
238
234
 
239
235
  const novu = new Novu({
240
- apiKey: "<YOUR_API_KEY_HERE>",
236
+ secretKey: "<YOUR_API_KEY_HERE>",
241
237
  });
242
238
 
243
239
  async function run() {
@@ -293,17 +289,19 @@ run();
293
289
  * [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
294
290
  * [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
295
291
  * [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
296
- * [supportControllerFetchUserOrganizations](docs/sdks/novu/README.md#supportcontrollerfetchuserorganizations)
297
- * [create](docs/sdks/novu/README.md#create)
298
292
 
299
293
  ### [subscribers](docs/sdks/subscribers/README.md)
300
294
 
301
295
  * [list](docs/sdks/subscribers/README.md#list) - Get subscribers
302
296
  * [create](docs/sdks/subscribers/README.md#create) - Create subscriber
303
- * [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
297
+ * [retrieveLegacy](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
304
298
  * [update](docs/sdks/subscribers/README.md#update) - Update subscriber
305
- * [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
299
+ * [~~deleteLegacy~~](docs/sdks/subscribers/README.md#deletelegacy) - Delete subscriber :warning: **Deprecated**
306
300
  * [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
301
+ * [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
302
+ * [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
303
+ * [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
304
+ * [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
307
305
 
308
306
  #### [subscribers.authentication](docs/sdks/authentication/README.md)
309
307
 
@@ -371,7 +369,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
371
369
  <summary>Available standalone functions</summary>
372
370
 
373
371
  - [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
374
- - [`create`](docs/sdks/novu/README.md#create)
375
372
  - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
376
373
  - [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete integration
377
374
  - [`integrationsList`](docs/sdks/integrations/README.md#list) - Get integrations
@@ -400,14 +397,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
400
397
  - [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
401
398
  - [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
402
399
  - [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
400
+ - [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Patch subscriber
403
401
  - [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
404
402
  - [`subscribersPreferencesRetrieveByLevel`](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level
405
403
  - [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber preference
406
404
  - [`subscribersPreferencesUpdateGlobal`](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences
407
405
  - [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
408
406
  - [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
407
+ - [`subscribersRetrieveLegacy`](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
408
+ - [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search for subscribers
409
409
  - [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
410
- - [`supportControllerFetchUserOrganizations`](docs/sdks/novu/README.md#supportcontrollerfetchuserorganizations)
411
410
  - [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
412
411
  - [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
413
412
  - [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered
@@ -419,6 +418,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
419
418
  - [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
420
419
  - [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
421
420
  - [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
421
+ - ~~[`subscribersDeleteLegacy`](docs/sdks/subscribers/README.md#deletelegacy)~~ - Delete subscriber :warning: **Deprecated**
422
422
 
423
423
  </details>
424
424
  <!-- End Standalone functions [standalone-funcs] -->
@@ -439,7 +439,7 @@ Here's an example of one such pagination call:
439
439
  import { Novu } from "@novu/api";
440
440
 
441
441
  const novu = new Novu({
442
- apiKey: "<YOUR_API_KEY_HERE>",
442
+ secretKey: "<YOUR_API_KEY_HERE>",
443
443
  });
444
444
 
445
445
  async function run() {
@@ -463,8 +463,8 @@ Some methods specify known errors which can be thrown. All the known errors are
463
463
 
464
464
  | Error Type | Status Code | Content Type |
465
465
  | ------------------------- | -------------------------------------- | ---------------- |
466
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
467
466
  | errors.ErrorDto | 414 | application/json |
467
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
468
468
  | errors.ValidationErrorDto | 422 | application/json |
469
469
  | errors.ErrorDto | 500 | application/json |
470
470
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -480,21 +480,20 @@ import {
480
480
  } from "@novu/api/models/errors";
481
481
 
482
482
  const novu = new Novu({
483
- apiKey: "<YOUR_API_KEY_HERE>",
483
+ secretKey: "<YOUR_API_KEY_HERE>",
484
484
  });
485
485
 
486
486
  async function run() {
487
487
  let result;
488
488
  try {
489
489
  result = await novu.trigger({
490
- name: "workflow_identifier",
490
+ workflowId: "workflow_identifier",
491
491
  payload: {
492
492
  "comment_id": "string",
493
493
  "post": {
494
494
  "text": "string",
495
495
  },
496
496
  },
497
- bridgeUrl: "https://example.com/bridge",
498
497
  overrides: {
499
498
  "fcm": {
500
499
  "data": {
@@ -583,19 +582,18 @@ import { Novu } from "@novu/api";
583
582
 
584
583
  const novu = new Novu({
585
584
  serverIdx: 1,
586
- apiKey: "<YOUR_API_KEY_HERE>",
585
+ secretKey: "<YOUR_API_KEY_HERE>",
587
586
  });
588
587
 
589
588
  async function run() {
590
589
  const result = await novu.trigger({
591
- name: "workflow_identifier",
590
+ workflowId: "workflow_identifier",
592
591
  payload: {
593
592
  "comment_id": "string",
594
593
  "post": {
595
594
  "text": "string",
596
595
  },
597
596
  },
598
- bridgeUrl: "https://example.com/bridge",
599
597
  overrides: {
600
598
  "fcm": {
601
599
  "data": {
@@ -624,19 +622,18 @@ import { Novu } from "@novu/api";
624
622
 
625
623
  const novu = new Novu({
626
624
  serverURL: "https://api.novu.co",
627
- apiKey: "<YOUR_API_KEY_HERE>",
625
+ secretKey: "<YOUR_API_KEY_HERE>",
628
626
  });
629
627
 
630
628
  async function run() {
631
629
  const result = await novu.trigger({
632
- name: "workflow_identifier",
630
+ workflowId: "workflow_identifier",
633
631
  payload: {
634
632
  "comment_id": "string",
635
633
  "post": {
636
634
  "text": "string",
637
635
  },
638
636
  },
639
- bridgeUrl: "https://example.com/bridge",
640
637
  overrides: {
641
638
  "fcm": {
642
639
  "data": {
@@ -714,28 +711,27 @@ const sdk = new Novu({ httpClient });
714
711
 
715
712
  This SDK supports the following security scheme globally:
716
713
 
717
- | Name | Type | Scheme |
718
- | -------- | ------ | ------- |
719
- | `apiKey` | apiKey | API key |
714
+ | Name | Type | Scheme |
715
+ | ----------- | ------ | ------- |
716
+ | `secretKey` | apiKey | API key |
720
717
 
721
- To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
718
+ To authenticate with the API the `secretKey` parameter must be set when initializing the SDK client instance. For example:
722
719
  ```typescript
723
720
  import { Novu } from "@novu/api";
724
721
 
725
722
  const novu = new Novu({
726
- apiKey: "<YOUR_API_KEY_HERE>",
723
+ secretKey: "<YOUR_API_KEY_HERE>",
727
724
  });
728
725
 
729
726
  async function run() {
730
727
  const result = await novu.trigger({
731
- name: "workflow_identifier",
728
+ workflowId: "workflow_identifier",
732
729
  payload: {
733
730
  "comment_id": "string",
734
731
  "post": {
735
732
  "text": "string",
736
733
  },
737
734
  },
738
- bridgeUrl: "https://example.com/bridge",
739
735
  overrides: {
740
736
  "fcm": {
741
737
  "data": {
@@ -767,19 +763,18 @@ To change the default retry strategy for a single API call, simply provide a ret
767
763
  import { Novu } from "@novu/api";
768
764
 
769
765
  const novu = new Novu({
770
- apiKey: "<YOUR_API_KEY_HERE>",
766
+ secretKey: "<YOUR_API_KEY_HERE>",
771
767
  });
772
768
 
773
769
  async function run() {
774
770
  const result = await novu.trigger({
775
- name: "workflow_identifier",
771
+ workflowId: "workflow_identifier",
776
772
  payload: {
777
773
  "comment_id": "string",
778
774
  "post": {
779
775
  "text": "string",
780
776
  },
781
777
  },
782
- bridgeUrl: "https://example.com/bridge",
783
778
  overrides: {
784
779
  "fcm": {
785
780
  "data": {
@@ -826,19 +821,18 @@ const novu = new Novu({
826
821
  },
827
822
  retryConnectionErrors: false,
828
823
  },
829
- apiKey: "<YOUR_API_KEY_HERE>",
824
+ secretKey: "<YOUR_API_KEY_HERE>",
830
825
  });
831
826
 
832
827
  async function run() {
833
828
  const result = await novu.trigger({
834
- name: "workflow_identifier",
829
+ workflowId: "workflow_identifier",
835
830
  payload: {
836
831
  "comment_id": "string",
837
832
  "post": {
838
833
  "text": "string",
839
834
  },
840
835
  },
841
- bridgeUrl: "https://example.com/bridge",
842
836
  overrides: {
843
837
  "fcm": {
844
838
  "data": {
@@ -18,7 +18,7 @@ Handle providers oauth redirect
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() {
@@ -48,7 +48,7 @@ import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/func
48
48
  // Use `NovuCore` for best tree-shaking performance.
49
49
  // You can create one instance of it to use across an application.
50
50
  const novu = new NovuCore({
51
- apiKey: "<YOUR_API_KEY_HERE>",
51
+ secretKey: "<YOUR_API_KEY_HERE>",
52
52
  });
53
53
 
54
54
  async function run() {
@@ -77,21 +77,21 @@ run();
77
77
 
78
78
  | Parameter | Type | Required | Description |
79
79
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
80
- | `request` | [operations.SubscribersControllerChatOauthCallbackRequest](../../models/operations/subscriberscontrollerchatoauthcallbackrequest.md) | :heavy_check_mark: | The request object to use for the request. |
80
+ | `request` | [operations.SubscribersV1ControllerChatOauthCallbackRequest](../../models/operations/subscribersv1controllerchatoauthcallbackrequest.md) | :heavy_check_mark: | The request object to use for the request. |
81
81
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
82
82
  | `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
83
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
84
84
 
85
85
  ### Response
86
86
 
87
- **Promise\<[operations.SubscribersControllerChatOauthCallbackResponse](../../models/operations/subscriberscontrollerchatoauthcallbackresponse.md)\>**
87
+ **Promise\<[operations.SubscribersV1ControllerChatOauthCallbackResponse](../../models/operations/subscribersv1controllerchatoauthcallbackresponse.md)\>**
88
88
 
89
89
  ### Errors
90
90
 
91
91
  | Error Type | Status Code | Content Type |
92
92
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
93
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
94
93
  | errors.ErrorDto | 414 | application/json |
94
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
95
95
  | errors.ValidationErrorDto | 422 | application/json |
96
96
  | errors.ErrorDto | 500 | application/json |
97
97
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -106,7 +106,7 @@ Handle chat oauth
106
106
  import { Novu } from "@novu/api";
107
107
 
108
108
  const novu = new Novu({
109
- apiKey: "<YOUR_API_KEY_HERE>",
109
+ secretKey: "<YOUR_API_KEY_HERE>",
110
110
  });
111
111
 
112
112
  async function run() {
@@ -135,7 +135,7 @@ import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscr
135
135
  // Use `NovuCore` for best tree-shaking performance.
136
136
  // You can create one instance of it to use across an application.
137
137
  const novu = new NovuCore({
138
- apiKey: "<YOUR_API_KEY_HERE>",
138
+ secretKey: "<YOUR_API_KEY_HERE>",
139
139
  });
140
140
 
141
141
  async function run() {
@@ -163,21 +163,21 @@ run();
163
163
 
164
164
  | Parameter | Type | Required | Description |
165
165
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
- | `request` | [operations.SubscribersControllerChatAccessOauthRequest](../../models/operations/subscriberscontrollerchataccessoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. |
166
+ | `request` | [operations.SubscribersV1ControllerChatAccessOauthRequest](../../models/operations/subscribersv1controllerchataccessoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. |
167
167
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
168
  | `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. |
169
169
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
170
 
171
171
  ### Response
172
172
 
173
- **Promise\<[operations.SubscribersControllerChatAccessOauthResponse](../../models/operations/subscriberscontrollerchataccessoauthresponse.md)\>**
173
+ **Promise\<[operations.SubscribersV1ControllerChatAccessOauthResponse](../../models/operations/subscribersv1controllerchataccessoauthresponse.md)\>**
174
174
 
175
175
  ### Errors
176
176
 
177
177
  | Error Type | Status Code | Content Type |
178
178
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
179
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
180
179
  | errors.ErrorDto | 414 | application/json |
180
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
181
181
  | errors.ValidationErrorDto | 422 | application/json |
182
182
  | errors.ErrorDto | 500 | application/json |
183
183
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -19,7 +19,7 @@ Subscriber credentials associated to the delivery methods such as slack and push
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() {
@@ -59,7 +59,7 @@ import { subscribersCredentialsUpdate } from "@novu/api/funcs/subscribersCredent
59
59
  // Use `NovuCore` for best tree-shaking performance.
60
60
  // You can create one instance of it to use across an application.
61
61
  const novu = new NovuCore({
62
- apiKey: "<YOUR_API_KEY_HERE>",
62
+ secretKey: "<YOUR_API_KEY_HERE>",
63
63
  });
64
64
 
65
65
  async function run() {
@@ -107,14 +107,14 @@ run();
107
107
 
108
108
  ### Response
109
109
 
110
- **Promise\<[operations.SubscribersControllerUpdateSubscriberChannelResponse](../../models/operations/subscriberscontrollerupdatesubscriberchannelresponse.md)\>**
110
+ **Promise\<[operations.SubscribersV1ControllerUpdateSubscriberChannelResponse](../../models/operations/subscribersv1controllerupdatesubscriberchannelresponse.md)\>**
111
111
 
112
112
  ### Errors
113
113
 
114
114
  | Error Type | Status Code | Content Type |
115
115
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
116
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
117
116
  | errors.ErrorDto | 414 | application/json |
117
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
118
118
  | errors.ValidationErrorDto | 422 | application/json |
119
119
  | errors.ErrorDto | 500 | application/json |
120
120
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -130,7 +130,7 @@ Subscriber credentials associated to the delivery methods such as slack and push
130
130
  import { Novu } from "@novu/api";
131
131
 
132
132
  const novu = new Novu({
133
- apiKey: "<YOUR_API_KEY_HERE>",
133
+ secretKey: "<YOUR_API_KEY_HERE>",
134
134
  });
135
135
 
136
136
  async function run() {
@@ -170,7 +170,7 @@ import { subscribersCredentialsAppend } from "@novu/api/funcs/subscribersCredent
170
170
  // Use `NovuCore` for best tree-shaking performance.
171
171
  // You can create one instance of it to use across an application.
172
172
  const novu = new NovuCore({
173
- apiKey: "<YOUR_API_KEY_HERE>",
173
+ secretKey: "<YOUR_API_KEY_HERE>",
174
174
  });
175
175
 
176
176
  async function run() {
@@ -218,14 +218,14 @@ run();
218
218
 
219
219
  ### Response
220
220
 
221
- **Promise\<[operations.SubscribersControllerModifySubscriberChannelResponse](../../models/operations/subscriberscontrollermodifysubscriberchannelresponse.md)\>**
221
+ **Promise\<[operations.SubscribersV1ControllerModifySubscriberChannelResponse](../../models/operations/subscribersv1controllermodifysubscriberchannelresponse.md)\>**
222
222
 
223
223
  ### Errors
224
224
 
225
225
  | Error Type | Status Code | Content Type |
226
226
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
227
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
228
227
  | errors.ErrorDto | 414 | application/json |
228
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
229
229
  | errors.ValidationErrorDto | 422 | application/json |
230
230
  | errors.ErrorDto | 500 | application/json |
231
231
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -240,7 +240,7 @@ Delete subscriber credentials such as slack and expo tokens.
240
240
  import { Novu } from "@novu/api";
241
241
 
242
242
  const novu = new Novu({
243
- apiKey: "<YOUR_API_KEY_HERE>",
243
+ secretKey: "<YOUR_API_KEY_HERE>",
244
244
  });
245
245
 
246
246
  async function run() {
@@ -264,7 +264,7 @@ import { subscribersCredentialsDelete } from "@novu/api/funcs/subscribersCredent
264
264
  // Use `NovuCore` for best tree-shaking performance.
265
265
  // You can create one instance of it to use across an application.
266
266
  const novu = new NovuCore({
267
- apiKey: "<YOUR_API_KEY_HERE>",
267
+ secretKey: "<YOUR_API_KEY_HERE>",
268
268
  });
269
269
 
270
270
  async function run() {
@@ -296,14 +296,14 @@ run();
296
296
 
297
297
  ### Response
298
298
 
299
- **Promise\<[operations.SubscribersControllerDeleteSubscriberCredentialsResponse](../../models/operations/subscriberscontrollerdeletesubscribercredentialsresponse.md)\>**
299
+ **Promise\<[operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse](../../models/operations/subscribersv1controllerdeletesubscribercredentialsresponse.md)\>**
300
300
 
301
301
  ### Errors
302
302
 
303
303
  | Error Type | Status Code | Content Type |
304
304
  | -------------------------------------- | -------------------------------------- | -------------------------------------- |
305
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
306
305
  | errors.ErrorDto | 414 | application/json |
306
+ | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
307
307
  | errors.ValidationErrorDto | 422 | application/json |
308
308
  | errors.ErrorDto | 500 | application/json |
309
309
  | errors.SDKError | 4XX, 5XX | \*/\* |