@novu/api 0.1.6 → 0.2.1

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 (398) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/README.md +14 -31
  3. package/docs/sdks/authentication/README.md +4 -4
  4. package/docs/sdks/credentials/README.md +6 -6
  5. package/docs/sdks/integrations/README.md +12 -12
  6. package/docs/sdks/messages/README.md +6 -6
  7. package/docs/sdks/notifications/README.md +4 -4
  8. package/docs/sdks/novu/README.md +8 -8
  9. package/docs/sdks/novumessages/README.md +6 -6
  10. package/docs/sdks/novunotifications/README.md +4 -4
  11. package/docs/sdks/novusubscribers/README.md +6 -6
  12. package/docs/sdks/preferences/README.md +9 -260
  13. package/docs/sdks/properties/README.md +2 -2
  14. package/docs/sdks/stats/README.md +4 -4
  15. package/docs/sdks/subscribers/README.md +50 -322
  16. package/docs/sdks/topics/README.md +10 -10
  17. package/docs/sdks/webhooks/README.md +2 -2
  18. package/funcs/cancel.d.ts.map +1 -1
  19. package/funcs/cancel.js +1 -0
  20. package/funcs/cancel.js.map +1 -1
  21. package/funcs/integrationsCreate.d.ts.map +1 -1
  22. package/funcs/integrationsCreate.js +1 -0
  23. package/funcs/integrationsCreate.js.map +1 -1
  24. package/funcs/integrationsDelete.d.ts.map +1 -1
  25. package/funcs/integrationsDelete.js +1 -0
  26. package/funcs/integrationsDelete.js.map +1 -1
  27. package/funcs/integrationsList.d.ts.map +1 -1
  28. package/funcs/integrationsList.js +1 -0
  29. package/funcs/integrationsList.js.map +1 -1
  30. package/funcs/integrationsListActive.d.ts.map +1 -1
  31. package/funcs/integrationsListActive.js +1 -0
  32. package/funcs/integrationsListActive.js.map +1 -1
  33. package/funcs/integrationsSetAsPrimary.d.ts.map +1 -1
  34. package/funcs/integrationsSetAsPrimary.js +1 -0
  35. package/funcs/integrationsSetAsPrimary.js.map +1 -1
  36. package/funcs/integrationsUpdate.d.ts.map +1 -1
  37. package/funcs/integrationsUpdate.js +1 -0
  38. package/funcs/integrationsUpdate.js.map +1 -1
  39. package/funcs/integrationsWebhooksRetrieve.d.ts.map +1 -1
  40. package/funcs/integrationsWebhooksRetrieve.js +1 -0
  41. package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
  42. package/funcs/messagesDelete.d.ts.map +1 -1
  43. package/funcs/messagesDelete.js +1 -0
  44. package/funcs/messagesDelete.js.map +1 -1
  45. package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
  46. package/funcs/messagesDeleteByTransactionId.js +1 -0
  47. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  48. package/funcs/messagesRetrieve.d.ts.map +1 -1
  49. package/funcs/messagesRetrieve.js +1 -0
  50. package/funcs/messagesRetrieve.js.map +1 -1
  51. package/funcs/notificationsList.d.ts.map +1 -1
  52. package/funcs/notificationsList.js +1 -0
  53. package/funcs/notificationsList.js.map +1 -1
  54. package/funcs/notificationsRetrieve.d.ts.map +1 -1
  55. package/funcs/notificationsRetrieve.js +1 -0
  56. package/funcs/notificationsRetrieve.js.map +1 -1
  57. package/funcs/notificationsStatsGraph.d.ts.map +1 -1
  58. package/funcs/notificationsStatsGraph.js +1 -0
  59. package/funcs/notificationsStatsGraph.js.map +1 -1
  60. package/funcs/notificationsStatsRetrieve.d.ts.map +1 -1
  61. package/funcs/notificationsStatsRetrieve.js +1 -0
  62. package/funcs/notificationsStatsRetrieve.js.map +1 -1
  63. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
  64. package/funcs/subscribersAuthenticationChatAccessOauth.js +1 -0
  65. package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
  66. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
  67. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +1 -0
  68. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +1 -1
  69. package/funcs/subscribersCreate.d.ts +2 -2
  70. package/funcs/subscribersCreate.d.ts.map +1 -1
  71. package/funcs/subscribersCreate.js +6 -5
  72. package/funcs/subscribersCreate.js.map +1 -1
  73. package/funcs/subscribersCreateBulk.d.ts.map +1 -1
  74. package/funcs/subscribersCreateBulk.js +1 -0
  75. package/funcs/subscribersCreateBulk.js.map +1 -1
  76. package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
  77. package/funcs/subscribersCredentialsAppend.js +1 -0
  78. package/funcs/subscribersCredentialsAppend.js.map +1 -1
  79. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  80. package/funcs/subscribersCredentialsDelete.js +1 -0
  81. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  82. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  83. package/funcs/subscribersCredentialsUpdate.js +1 -0
  84. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  85. package/funcs/subscribersDelete.d.ts.map +1 -1
  86. package/funcs/subscribersDelete.js +1 -0
  87. package/funcs/subscribersDelete.js.map +1 -1
  88. package/funcs/subscribersList.d.ts.map +1 -1
  89. package/funcs/subscribersList.js +1 -0
  90. package/funcs/subscribersList.js.map +1 -1
  91. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  92. package/funcs/subscribersMessagesMarkAll.js +1 -0
  93. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  94. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  95. package/funcs/subscribersMessagesMarkAllAs.js +1 -0
  96. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  97. package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  98. package/funcs/subscribersMessagesUpdateAsSeen.js +1 -0
  99. package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
  100. package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
  101. package/funcs/subscribersNotificationsFeed.js +1 -0
  102. package/funcs/subscribersNotificationsFeed.js.map +1 -1
  103. package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  104. package/funcs/subscribersNotificationsUnseenCount.js +1 -0
  105. package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
  106. package/funcs/subscribersPatch.d.ts.map +1 -1
  107. package/funcs/subscribersPatch.js +1 -0
  108. package/funcs/subscribersPatch.js.map +1 -1
  109. package/funcs/{subscribersPreferencesRetrieve.d.ts → subscribersPreferencesList.d.ts} +2 -2
  110. package/funcs/subscribersPreferencesList.d.ts.map +1 -0
  111. package/funcs/{subscribersPreferencesRetrieve.js → subscribersPreferencesList.js} +5 -4
  112. package/funcs/subscribersPreferencesList.js.map +1 -0
  113. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  114. package/funcs/subscribersPreferencesUpdate.js +1 -0
  115. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  116. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
  117. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +1 -0
  118. package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  119. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  120. package/funcs/subscribersRetrieve.js +1 -0
  121. package/funcs/subscribersRetrieve.js.map +1 -1
  122. package/funcs/subscribersSearch.d.ts.map +1 -1
  123. package/funcs/subscribersSearch.js +1 -0
  124. package/funcs/subscribersSearch.js.map +1 -1
  125. package/funcs/topicsCreate.d.ts.map +1 -1
  126. package/funcs/topicsCreate.js +1 -0
  127. package/funcs/topicsCreate.js.map +1 -1
  128. package/funcs/topicsDelete.d.ts.map +1 -1
  129. package/funcs/topicsDelete.js +1 -0
  130. package/funcs/topicsDelete.js.map +1 -1
  131. package/funcs/topicsList.d.ts.map +1 -1
  132. package/funcs/topicsList.js +1 -0
  133. package/funcs/topicsList.js.map +1 -1
  134. package/funcs/topicsRename.d.ts.map +1 -1
  135. package/funcs/topicsRename.js +1 -0
  136. package/funcs/topicsRename.js.map +1 -1
  137. package/funcs/topicsRetrieve.d.ts.map +1 -1
  138. package/funcs/topicsRetrieve.js +1 -0
  139. package/funcs/topicsRetrieve.js.map +1 -1
  140. package/funcs/topicsSubscribersAssign.d.ts.map +1 -1
  141. package/funcs/topicsSubscribersAssign.js +1 -0
  142. package/funcs/topicsSubscribersAssign.js.map +1 -1
  143. package/funcs/topicsSubscribersRemove.d.ts.map +1 -1
  144. package/funcs/topicsSubscribersRemove.js +1 -0
  145. package/funcs/topicsSubscribersRemove.js.map +1 -1
  146. package/funcs/topicsSubscribersRetrieve.d.ts.map +1 -1
  147. package/funcs/topicsSubscribersRetrieve.js +1 -0
  148. package/funcs/topicsSubscribersRetrieve.js.map +1 -1
  149. package/funcs/trigger.d.ts.map +1 -1
  150. package/funcs/trigger.js +1 -0
  151. package/funcs/trigger.js.map +1 -1
  152. package/funcs/triggerBroadcast.d.ts.map +1 -1
  153. package/funcs/triggerBroadcast.js +1 -0
  154. package/funcs/triggerBroadcast.js.map +1 -1
  155. package/funcs/triggerBulk.d.ts.map +1 -1
  156. package/funcs/triggerBulk.js +1 -0
  157. package/funcs/triggerBulk.js.map +1 -1
  158. package/hooks/types.d.ts +1 -0
  159. package/hooks/types.d.ts.map +1 -1
  160. package/jsr.json +1 -1
  161. package/lib/config.d.ts +3 -3
  162. package/lib/config.js +3 -3
  163. package/lib/security.d.ts.map +1 -1
  164. package/lib/security.js.map +1 -1
  165. package/models/components/index.d.ts +0 -14
  166. package/models/components/index.d.ts.map +1 -1
  167. package/models/components/index.js +0 -14
  168. package/models/components/index.js.map +1 -1
  169. package/models/components/subscriberresponsedto.d.ts +5 -0
  170. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  171. package/models/components/subscriberresponsedto.js +2 -0
  172. package/models/components/subscriberresponsedto.js.map +1 -1
  173. package/models/operations/index.d.ts +1 -8
  174. package/models/operations/index.d.ts.map +1 -1
  175. package/models/operations/index.js +1 -8
  176. package/models/operations/index.js.map +1 -1
  177. package/models/operations/subscriberscontrollercreatesubscriber.d.ts +66 -0
  178. package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +1 -0
  179. package/models/operations/subscriberscontrollercreatesubscriber.js +112 -0
  180. package/models/operations/subscriberscontrollercreatesubscriber.js.map +1 -0
  181. package/package.json +1 -1
  182. package/sdk/preferences.d.ts +1 -20
  183. package/sdk/preferences.d.ts.map +1 -1
  184. package/sdk/preferences.js +3 -32
  185. package/sdk/preferences.js.map +1 -1
  186. package/sdk/subscribers.d.ts +9 -32
  187. package/sdk/subscribers.d.ts.map +1 -1
  188. package/sdk/subscribers.js +12 -44
  189. package/sdk/subscribers.js.map +1 -1
  190. package/sources/json-development.json +2313 -6112
  191. package/src/funcs/cancel.ts +1 -0
  192. package/src/funcs/integrationsCreate.ts +1 -0
  193. package/src/funcs/integrationsDelete.ts +1 -0
  194. package/src/funcs/integrationsList.ts +1 -0
  195. package/src/funcs/integrationsListActive.ts +1 -0
  196. package/src/funcs/integrationsSetAsPrimary.ts +1 -0
  197. package/src/funcs/integrationsUpdate.ts +1 -0
  198. package/src/funcs/integrationsWebhooksRetrieve.ts +1 -0
  199. package/src/funcs/messagesDelete.ts +1 -0
  200. package/src/funcs/messagesDeleteByTransactionId.ts +1 -0
  201. package/src/funcs/messagesRetrieve.ts +1 -0
  202. package/src/funcs/notificationsList.ts +1 -0
  203. package/src/funcs/notificationsRetrieve.ts +1 -0
  204. package/src/funcs/notificationsStatsGraph.ts +1 -0
  205. package/src/funcs/notificationsStatsRetrieve.ts +1 -0
  206. package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +1 -0
  207. package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +1 -0
  208. package/src/funcs/subscribersCreate.ts +10 -9
  209. package/src/funcs/subscribersCreateBulk.ts +1 -0
  210. package/src/funcs/subscribersCredentialsAppend.ts +1 -0
  211. package/src/funcs/subscribersCredentialsDelete.ts +1 -0
  212. package/src/funcs/subscribersCredentialsUpdate.ts +1 -0
  213. package/src/funcs/subscribersDelete.ts +1 -0
  214. package/src/funcs/subscribersList.ts +1 -0
  215. package/src/funcs/subscribersMessagesMarkAll.ts +1 -0
  216. package/src/funcs/subscribersMessagesMarkAllAs.ts +1 -0
  217. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +1 -0
  218. package/src/funcs/subscribersNotificationsFeed.ts +1 -0
  219. package/src/funcs/subscribersNotificationsUnseenCount.ts +1 -0
  220. package/src/funcs/subscribersPatch.ts +1 -0
  221. package/src/funcs/{subscribersPreferencesRetrieve.ts → subscribersPreferencesList.ts} +2 -1
  222. package/src/funcs/subscribersPreferencesUpdate.ts +1 -0
  223. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +1 -0
  224. package/src/funcs/subscribersRetrieve.ts +1 -0
  225. package/src/funcs/subscribersSearch.ts +1 -0
  226. package/src/funcs/topicsCreate.ts +1 -0
  227. package/src/funcs/topicsDelete.ts +1 -0
  228. package/src/funcs/topicsList.ts +1 -0
  229. package/src/funcs/topicsRename.ts +1 -0
  230. package/src/funcs/topicsRetrieve.ts +1 -0
  231. package/src/funcs/topicsSubscribersAssign.ts +1 -0
  232. package/src/funcs/topicsSubscribersRemove.ts +1 -0
  233. package/src/funcs/topicsSubscribersRetrieve.ts +1 -0
  234. package/src/funcs/trigger.ts +1 -0
  235. package/src/funcs/triggerBroadcast.ts +1 -0
  236. package/src/funcs/triggerBulk.ts +1 -0
  237. package/src/hooks/types.ts +1 -0
  238. package/src/lib/config.ts +3 -3
  239. package/src/lib/security.ts +0 -1
  240. package/src/models/components/index.ts +0 -14
  241. package/src/models/components/subscriberresponsedto.ts +7 -0
  242. package/src/models/operations/index.ts +1 -8
  243. package/src/models/operations/subscriberscontrollercreatesubscriber.ts +185 -0
  244. package/src/sdk/preferences.ts +3 -70
  245. package/src/sdk/subscribers.ts +24 -90
  246. package/docs/sdks/legacy/README.md +0 -86
  247. package/funcs/subscribersDeleteLegacy.d.ts +0 -18
  248. package/funcs/subscribersDeleteLegacy.d.ts.map +0 -1
  249. package/funcs/subscribersDeleteLegacy.js +0 -141
  250. package/funcs/subscribersDeleteLegacy.js.map +0 -1
  251. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts +0 -14
  252. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts.map +0 -1
  253. package/funcs/subscribersPreferencesLegacyUpdateGlobal.js +0 -140
  254. package/funcs/subscribersPreferencesLegacyUpdateGlobal.js.map +0 -1
  255. package/funcs/subscribersPreferencesListLegacy.d.ts +0 -15
  256. package/funcs/subscribersPreferencesListLegacy.d.ts.map +0 -1
  257. package/funcs/subscribersPreferencesListLegacy.js +0 -145
  258. package/funcs/subscribersPreferencesListLegacy.js.map +0 -1
  259. package/funcs/subscribersPreferencesRetrieve.d.ts.map +0 -1
  260. package/funcs/subscribersPreferencesRetrieve.js.map +0 -1
  261. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts +0 -15
  262. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts.map +0 -1
  263. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.js +0 -144
  264. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.js.map +0 -1
  265. package/funcs/subscribersPreferencesUpdateLegacy.d.ts +0 -13
  266. package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +0 -1
  267. package/funcs/subscribersPreferencesUpdateLegacy.js +0 -139
  268. package/funcs/subscribersPreferencesUpdateLegacy.js.map +0 -1
  269. package/funcs/subscribersRetrieveLegacy.d.ts +0 -16
  270. package/funcs/subscribersRetrieveLegacy.d.ts.map +0 -1
  271. package/funcs/subscribersRetrieveLegacy.js +0 -144
  272. package/funcs/subscribersRetrieveLegacy.js.map +0 -1
  273. package/funcs/subscribersUpdateLegacy.d.ts +0 -17
  274. package/funcs/subscribersUpdateLegacy.d.ts.map +0 -1
  275. package/funcs/subscribersUpdateLegacy.js +0 -143
  276. package/funcs/subscribersUpdateLegacy.js.map +0 -1
  277. package/models/components/channelpreference.d.ts +0 -38
  278. package/models/components/channelpreference.d.ts.map +0 -1
  279. package/models/components/channelpreference.js +0 -62
  280. package/models/components/channelpreference.js.map +0 -1
  281. package/models/components/deletesubscriberresponsedto.d.ts +0 -66
  282. package/models/components/deletesubscriberresponsedto.d.ts.map +0 -1
  283. package/models/components/deletesubscriberresponsedto.js +0 -82
  284. package/models/components/deletesubscriberresponsedto.js.map +0 -1
  285. package/models/components/getsubscriberpreferencesresponsedto.d.ts +0 -39
  286. package/models/components/getsubscriberpreferencesresponsedto.d.ts.map +0 -1
  287. package/models/components/getsubscriberpreferencesresponsedto.js +0 -63
  288. package/models/components/getsubscriberpreferencesresponsedto.js.map +0 -1
  289. package/models/components/notificationtriggerresponse.d.ts +0 -55
  290. package/models/components/notificationtriggerresponse.d.ts.map +0 -1
  291. package/models/components/notificationtriggerresponse.js +0 -72
  292. package/models/components/notificationtriggerresponse.js.map +0 -1
  293. package/models/components/notificationtriggervariableresponse.d.ts +0 -101
  294. package/models/components/notificationtriggervariableresponse.d.ts.map +0 -1
  295. package/models/components/notificationtriggervariableresponse.js +0 -112
  296. package/models/components/notificationtriggervariableresponse.js.map +0 -1
  297. package/models/components/preference.d.ts +0 -38
  298. package/models/components/preference.d.ts.map +0 -1
  299. package/models/components/preference.js +0 -62
  300. package/models/components/preference.js.map +0 -1
  301. package/models/components/templateresponse.d.ts +0 -48
  302. package/models/components/templateresponse.d.ts.map +0 -1
  303. package/models/components/templateresponse.js +0 -75
  304. package/models/components/templateresponse.js.map +0 -1
  305. package/models/components/triggerreservedvariableresponse.d.ts +0 -69
  306. package/models/components/triggerreservedvariableresponse.d.ts.map +0 -1
  307. package/models/components/triggerreservedvariableresponse.js +0 -83
  308. package/models/components/triggerreservedvariableresponse.js.map +0 -1
  309. package/models/components/triggertypeenum.d.ts +0 -31
  310. package/models/components/triggertypeenum.d.ts.map +0 -1
  311. package/models/components/triggertypeenum.js +0 -52
  312. package/models/components/triggertypeenum.js.map +0 -1
  313. package/models/components/updatesubscriberglobalpreferencesrequestdto.d.ts +0 -38
  314. package/models/components/updatesubscriberglobalpreferencesrequestdto.d.ts.map +0 -1
  315. package/models/components/updatesubscriberglobalpreferencesrequestdto.js +0 -62
  316. package/models/components/updatesubscriberglobalpreferencesrequestdto.js.map +0 -1
  317. package/models/components/updatesubscriberpreferenceglobalresponsedto.d.ts +0 -33
  318. package/models/components/updatesubscriberpreferenceglobalresponsedto.d.ts.map +0 -1
  319. package/models/components/updatesubscriberpreferenceglobalresponsedto.js +0 -60
  320. package/models/components/updatesubscriberpreferenceglobalresponsedto.js.map +0 -1
  321. package/models/components/updatesubscriberpreferencerequestdto.d.ts +0 -38
  322. package/models/components/updatesubscriberpreferencerequestdto.d.ts.map +0 -1
  323. package/models/components/updatesubscriberpreferencerequestdto.js +0 -62
  324. package/models/components/updatesubscriberpreferencerequestdto.js.map +0 -1
  325. package/models/components/updatesubscriberpreferenceresponsedto.d.ts +0 -39
  326. package/models/components/updatesubscriberpreferenceresponsedto.d.ts.map +0 -1
  327. package/models/components/updatesubscriberpreferenceresponsedto.js +0 -63
  328. package/models/components/updatesubscriberpreferenceresponsedto.js.map +0 -1
  329. package/models/components/updatesubscriberrequestdto.d.ts +0 -72
  330. package/models/components/updatesubscriberrequestdto.d.ts.map +0 -1
  331. package/models/components/updatesubscriberrequestdto.js +0 -74
  332. package/models/components/updatesubscriberrequestdto.js.map +0 -1
  333. package/models/operations/subscribersv1controllercreatesubscriber.d.ts +0 -66
  334. package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +0 -1
  335. package/models/operations/subscribersv1controllercreatesubscriber.js +0 -112
  336. package/models/operations/subscribersv1controllercreatesubscriber.js.map +0 -1
  337. package/models/operations/subscribersv1controllergetsubscriber.d.ts +0 -71
  338. package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +0 -1
  339. package/models/operations/subscribersv1controllergetsubscriber.js +0 -112
  340. package/models/operations/subscribersv1controllergetsubscriber.js.map +0 -1
  341. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +0 -108
  342. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +0 -1
  343. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +0 -141
  344. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +0 -1
  345. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +0 -71
  346. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +0 -1
  347. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +0 -116
  348. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +0 -1
  349. package/models/operations/subscribersv1controllerremovesubscriber.d.ts +0 -66
  350. package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +0 -1
  351. package/models/operations/subscribersv1controllerremovesubscriber.js +0 -110
  352. package/models/operations/subscribersv1controllerremovesubscriber.js.map +0 -1
  353. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +0 -68
  354. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +0 -1
  355. package/models/operations/subscribersv1controllerupdatesubscriber.js +0 -114
  356. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +0 -1
  357. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +0 -68
  358. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +0 -1
  359. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +0 -118
  360. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +0 -1
  361. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +0 -70
  362. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +0 -1
  363. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +0 -120
  364. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +0 -1
  365. package/sdk/legacy.d.ts +0 -10
  366. package/sdk/legacy.d.ts.map +0 -1
  367. package/sdk/legacy.js +0 -19
  368. package/sdk/legacy.js.map +0 -1
  369. package/src/funcs/subscribersDeleteLegacy.ts +0 -200
  370. package/src/funcs/subscribersPreferencesLegacyUpdateGlobal.ts +0 -211
  371. package/src/funcs/subscribersPreferencesListLegacy.ts +0 -209
  372. package/src/funcs/subscribersPreferencesRetrieveByLevelLegacy.ts +0 -205
  373. package/src/funcs/subscribersPreferencesUpdateLegacy.ts +0 -202
  374. package/src/funcs/subscribersRetrieveLegacy.ts +0 -205
  375. package/src/funcs/subscribersUpdateLegacy.ts +0 -204
  376. package/src/models/components/channelpreference.ts +0 -81
  377. package/src/models/components/deletesubscriberresponsedto.ts +0 -114
  378. package/src/models/components/getsubscriberpreferencesresponsedto.ts +0 -93
  379. package/src/models/components/notificationtriggerresponse.ts +0 -126
  380. package/src/models/components/notificationtriggervariableresponse.ts +0 -193
  381. package/src/models/components/preference.ts +0 -78
  382. package/src/models/components/templateresponse.ts +0 -105
  383. package/src/models/components/triggerreservedvariableresponse.ts +0 -116
  384. package/src/models/components/triggertypeenum.ts +0 -38
  385. package/src/models/components/updatesubscriberglobalpreferencesrequestdto.ts +0 -95
  386. package/src/models/components/updatesubscriberpreferenceglobalresponsedto.ts +0 -88
  387. package/src/models/components/updatesubscriberpreferencerequestdto.ts +0 -87
  388. package/src/models/components/updatesubscriberpreferenceresponsedto.ts +0 -93
  389. package/src/models/components/updatesubscriberrequestdto.ts +0 -124
  390. package/src/models/operations/subscribersv1controllercreatesubscriber.ts +0 -187
  391. package/src/models/operations/subscribersv1controllergetsubscriber.ts +0 -188
  392. package/src/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.ts +0 -231
  393. package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +0 -191
  394. package/src/models/operations/subscribersv1controllerremovesubscriber.ts +0 -183
  395. package/src/models/operations/subscribersv1controllerupdatesubscriber.ts +0 -191
  396. package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +0 -195
  397. package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +0 -197
  398. package/src/sdk/legacy.ts +0 -32
@@ -20,6 +20,7 @@ export * from "./notificationscontrollergetactivitygraphstats.js";
20
20
  export * from "./notificationscontrollergetactivitystats.js";
21
21
  export * from "./notificationscontrollergetnotification.js";
22
22
  export * from "./notificationscontrollerlistnotifications.js";
23
+ export * from "./subscriberscontrollercreatesubscriber.js";
23
24
  export * from "./subscriberscontrollergetsubscriber.js";
24
25
  export * from "./subscriberscontrollergetsubscriberpreferences.js";
25
26
  export * from "./subscriberscontrollerpatchsubscriber.js";
@@ -29,24 +30,16 @@ export * from "./subscriberscontrollerupdatesubscriberpreferences.js";
29
30
  export * from "./subscribersv1controllerbulkcreatesubscribers.js";
30
31
  export * from "./subscribersv1controllerchataccessoauth.js";
31
32
  export * from "./subscribersv1controllerchatoauthcallback.js";
32
- export * from "./subscribersv1controllercreatesubscriber.js";
33
33
  export * from "./subscribersv1controllerdeletesubscribercredentials.js";
34
34
  export * from "./subscribersv1controllergetnotificationsfeed.js";
35
- export * from "./subscribersv1controllergetsubscriber.js";
36
- export * from "./subscribersv1controllergetsubscriberpreferencebylevel.js";
37
35
  export * from "./subscribersv1controllergetunseencount.js";
38
- export * from "./subscribersv1controllerlistsubscriberpreferences.js";
39
36
  export * from "./subscribersv1controllerlistsubscribers.js";
40
37
  export * from "./subscribersv1controllermarkactionasseen.js";
41
38
  export * from "./subscribersv1controllermarkallunreadasread.js";
42
39
  export * from "./subscribersv1controllermarkmessagesas.js";
43
40
  export * from "./subscribersv1controllermodifysubscriberchannel.js";
44
- export * from "./subscribersv1controllerremovesubscriber.js";
45
- export * from "./subscribersv1controllerupdatesubscriber.js";
46
41
  export * from "./subscribersv1controllerupdatesubscriberchannel.js";
47
- export * from "./subscribersv1controllerupdatesubscriberglobalpreferences.js";
48
42
  export * from "./subscribersv1controllerupdatesubscriberonlineflag.js";
49
- export * from "./subscribersv1controllerupdatesubscriberpreference.js";
50
43
  export * from "./topicscontrollerassign.js";
51
44
  export * from "./topicscontrollercreatetopic.js";
52
45
  export * from "./topicscontrollerdeletetopic.js";
@@ -0,0 +1,185 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type SubscribersControllerCreateSubscriberRequest = {
13
+ /**
14
+ * A header for idempotency purposes
15
+ */
16
+ idempotencyKey?: string | undefined;
17
+ createSubscriberRequestDto: components.CreateSubscriberRequestDto;
18
+ };
19
+
20
+ export type SubscribersControllerCreateSubscriberResponse = {
21
+ headers: { [k: string]: Array<string> };
22
+ result: components.SubscriberResponseDto;
23
+ };
24
+
25
+ /** @internal */
26
+ export const SubscribersControllerCreateSubscriberRequest$inboundSchema:
27
+ z.ZodType<
28
+ SubscribersControllerCreateSubscriberRequest,
29
+ z.ZodTypeDef,
30
+ unknown
31
+ > = z.object({
32
+ "idempotency-key": z.string().optional(),
33
+ CreateSubscriberRequestDto:
34
+ components.CreateSubscriberRequestDto$inboundSchema,
35
+ }).transform((v) => {
36
+ return remap$(v, {
37
+ "idempotency-key": "idempotencyKey",
38
+ "CreateSubscriberRequestDto": "createSubscriberRequestDto",
39
+ });
40
+ });
41
+
42
+ /** @internal */
43
+ export type SubscribersControllerCreateSubscriberRequest$Outbound = {
44
+ "idempotency-key"?: string | undefined;
45
+ CreateSubscriberRequestDto: components.CreateSubscriberRequestDto$Outbound;
46
+ };
47
+
48
+ /** @internal */
49
+ export const SubscribersControllerCreateSubscriberRequest$outboundSchema:
50
+ z.ZodType<
51
+ SubscribersControllerCreateSubscriberRequest$Outbound,
52
+ z.ZodTypeDef,
53
+ SubscribersControllerCreateSubscriberRequest
54
+ > = z.object({
55
+ idempotencyKey: z.string().optional(),
56
+ createSubscriberRequestDto:
57
+ components.CreateSubscriberRequestDto$outboundSchema,
58
+ }).transform((v) => {
59
+ return remap$(v, {
60
+ idempotencyKey: "idempotency-key",
61
+ createSubscriberRequestDto: "CreateSubscriberRequestDto",
62
+ });
63
+ });
64
+
65
+ /**
66
+ * @internal
67
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
68
+ */
69
+ export namespace SubscribersControllerCreateSubscriberRequest$ {
70
+ /** @deprecated use `SubscribersControllerCreateSubscriberRequest$inboundSchema` instead. */
71
+ export const inboundSchema =
72
+ SubscribersControllerCreateSubscriberRequest$inboundSchema;
73
+ /** @deprecated use `SubscribersControllerCreateSubscriberRequest$outboundSchema` instead. */
74
+ export const outboundSchema =
75
+ SubscribersControllerCreateSubscriberRequest$outboundSchema;
76
+ /** @deprecated use `SubscribersControllerCreateSubscriberRequest$Outbound` instead. */
77
+ export type Outbound = SubscribersControllerCreateSubscriberRequest$Outbound;
78
+ }
79
+
80
+ export function subscribersControllerCreateSubscriberRequestToJSON(
81
+ subscribersControllerCreateSubscriberRequest:
82
+ SubscribersControllerCreateSubscriberRequest,
83
+ ): string {
84
+ return JSON.stringify(
85
+ SubscribersControllerCreateSubscriberRequest$outboundSchema.parse(
86
+ subscribersControllerCreateSubscriberRequest,
87
+ ),
88
+ );
89
+ }
90
+
91
+ export function subscribersControllerCreateSubscriberRequestFromJSON(
92
+ jsonString: string,
93
+ ): SafeParseResult<
94
+ SubscribersControllerCreateSubscriberRequest,
95
+ SDKValidationError
96
+ > {
97
+ return safeParse(
98
+ jsonString,
99
+ (x) =>
100
+ SubscribersControllerCreateSubscriberRequest$inboundSchema.parse(
101
+ JSON.parse(x),
102
+ ),
103
+ `Failed to parse 'SubscribersControllerCreateSubscriberRequest' from JSON`,
104
+ );
105
+ }
106
+
107
+ /** @internal */
108
+ export const SubscribersControllerCreateSubscriberResponse$inboundSchema:
109
+ z.ZodType<
110
+ SubscribersControllerCreateSubscriberResponse,
111
+ z.ZodTypeDef,
112
+ unknown
113
+ > = z.object({
114
+ Headers: z.record(z.array(z.string())),
115
+ Result: components.SubscriberResponseDto$inboundSchema,
116
+ }).transform((v) => {
117
+ return remap$(v, {
118
+ "Headers": "headers",
119
+ "Result": "result",
120
+ });
121
+ });
122
+
123
+ /** @internal */
124
+ export type SubscribersControllerCreateSubscriberResponse$Outbound = {
125
+ Headers: { [k: string]: Array<string> };
126
+ Result: components.SubscriberResponseDto$Outbound;
127
+ };
128
+
129
+ /** @internal */
130
+ export const SubscribersControllerCreateSubscriberResponse$outboundSchema:
131
+ z.ZodType<
132
+ SubscribersControllerCreateSubscriberResponse$Outbound,
133
+ z.ZodTypeDef,
134
+ SubscribersControllerCreateSubscriberResponse
135
+ > = z.object({
136
+ headers: z.record(z.array(z.string())),
137
+ result: components.SubscriberResponseDto$outboundSchema,
138
+ }).transform((v) => {
139
+ return remap$(v, {
140
+ headers: "Headers",
141
+ result: "Result",
142
+ });
143
+ });
144
+
145
+ /**
146
+ * @internal
147
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
148
+ */
149
+ export namespace SubscribersControllerCreateSubscriberResponse$ {
150
+ /** @deprecated use `SubscribersControllerCreateSubscriberResponse$inboundSchema` instead. */
151
+ export const inboundSchema =
152
+ SubscribersControllerCreateSubscriberResponse$inboundSchema;
153
+ /** @deprecated use `SubscribersControllerCreateSubscriberResponse$outboundSchema` instead. */
154
+ export const outboundSchema =
155
+ SubscribersControllerCreateSubscriberResponse$outboundSchema;
156
+ /** @deprecated use `SubscribersControllerCreateSubscriberResponse$Outbound` instead. */
157
+ export type Outbound = SubscribersControllerCreateSubscriberResponse$Outbound;
158
+ }
159
+
160
+ export function subscribersControllerCreateSubscriberResponseToJSON(
161
+ subscribersControllerCreateSubscriberResponse:
162
+ SubscribersControllerCreateSubscriberResponse,
163
+ ): string {
164
+ return JSON.stringify(
165
+ SubscribersControllerCreateSubscriberResponse$outboundSchema.parse(
166
+ subscribersControllerCreateSubscriberResponse,
167
+ ),
168
+ );
169
+ }
170
+
171
+ export function subscribersControllerCreateSubscriberResponseFromJSON(
172
+ jsonString: string,
173
+ ): SafeParseResult<
174
+ SubscribersControllerCreateSubscriberResponse,
175
+ SDKValidationError
176
+ > {
177
+ return safeParse(
178
+ jsonString,
179
+ (x) =>
180
+ SubscribersControllerCreateSubscriberResponse$inboundSchema.parse(
181
+ JSON.parse(x),
182
+ ),
183
+ `Failed to parse 'SubscribersControllerCreateSubscriberResponse' from JSON`,
184
+ );
185
+ }
@@ -2,93 +2,26 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { subscribersPreferencesListLegacy } from "../funcs/subscribersPreferencesListLegacy.js";
6
- import { subscribersPreferencesRetrieve } from "../funcs/subscribersPreferencesRetrieve.js";
7
- import { subscribersPreferencesRetrieveByLevelLegacy } from "../funcs/subscribersPreferencesRetrieveByLevelLegacy.js";
5
+ import { subscribersPreferencesList } from "../funcs/subscribersPreferencesList.js";
8
6
  import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
9
- import { subscribersPreferencesUpdateLegacy } from "../funcs/subscribersPreferencesUpdateLegacy.js";
10
7
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
11
8
  import * as components from "../models/components/index.js";
12
9
  import * as operations from "../models/operations/index.js";
13
10
  import { unwrapAsync } from "../types/fp.js";
14
- import { Legacy } from "./legacy.js";
15
11
 
16
12
  export class Preferences extends ClientSDK {
17
- private _legacy?: Legacy;
18
- get legacy(): Legacy {
19
- return (this._legacy ??= new Legacy(this._options));
20
- }
21
-
22
- /**
23
- * Get subscriber preferences
24
- *
25
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
26
- */
27
- async listLegacy(
28
- subscriberId: string,
29
- includeInactiveChannels?: boolean | undefined,
30
- idempotencyKey?: string | undefined,
31
- options?: RequestOptions,
32
- ): Promise<
33
- operations.SubscribersV1ControllerListSubscriberPreferencesResponse
34
- > {
35
- return unwrapAsync(subscribersPreferencesListLegacy(
36
- this,
37
- subscriberId,
38
- includeInactiveChannels,
39
- idempotencyKey,
40
- options,
41
- ));
42
- }
43
-
44
- /**
45
- * Get subscriber preferences by level
46
- *
47
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
48
- */
49
- async retrieveByLevelLegacy(
50
- request:
51
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
52
- options?: RequestOptions,
53
- ): Promise<
54
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse
55
- > {
56
- return unwrapAsync(subscribersPreferencesRetrieveByLevelLegacy(
57
- this,
58
- request,
59
- options,
60
- ));
61
- }
62
-
63
- /**
64
- * Update subscriber preference
65
- */
66
- async updateLegacy(
67
- request:
68
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
69
- options?: RequestOptions,
70
- ): Promise<
71
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse
72
- > {
73
- return unwrapAsync(subscribersPreferencesUpdateLegacy(
74
- this,
75
- request,
76
- options,
77
- ));
78
- }
79
-
80
13
  /**
81
14
  * Get subscriber preferences
82
15
  *
83
16
  * @remarks
84
17
  * Get subscriber global and workflow specific preferences
85
18
  */
86
- async retrieve(
19
+ async list(
87
20
  subscriberId: string,
88
21
  idempotencyKey?: string | undefined,
89
22
  options?: RequestOptions,
90
23
  ): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse> {
91
- return unwrapAsync(subscribersPreferencesRetrieve(
24
+ return unwrapAsync(subscribersPreferencesList(
92
25
  this,
93
26
  subscriberId,
94
27
  idempotencyKey,
@@ -5,13 +5,10 @@
5
5
  import { subscribersCreate } from "../funcs/subscribersCreate.js";
6
6
  import { subscribersCreateBulk } from "../funcs/subscribersCreateBulk.js";
7
7
  import { subscribersDelete } from "../funcs/subscribersDelete.js";
8
- import { subscribersDeleteLegacy } from "../funcs/subscribersDeleteLegacy.js";
9
8
  import { subscribersList } from "../funcs/subscribersList.js";
10
9
  import { subscribersPatch } from "../funcs/subscribersPatch.js";
11
10
  import { subscribersRetrieve } from "../funcs/subscribersRetrieve.js";
12
- import { subscribersRetrieveLegacy } from "../funcs/subscribersRetrieveLegacy.js";
13
11
  import { subscribersSearch } from "../funcs/subscribersSearch.js";
14
- import { subscribersUpdateLegacy } from "../funcs/subscribersUpdateLegacy.js";
15
12
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
16
13
  import * as components from "../models/components/index.js";
17
14
  import * as operations from "../models/operations/index.js";
@@ -35,11 +32,6 @@ export class Subscribers extends ClientSDK {
35
32
  return (this._properties ??= new Properties(this._options));
36
33
  }
37
34
 
38
- private _preferences?: Preferences;
39
- get preferences(): Preferences {
40
- return (this._preferences ??= new Preferences(this._options));
41
- }
42
-
43
35
  private _notifications?: NovuNotifications;
44
36
  get notifications(): NovuNotifications {
45
37
  return (this._notifications ??= new NovuNotifications(this._options));
@@ -55,6 +47,11 @@ export class Subscribers extends ClientSDK {
55
47
  return (this._authentication ??= new Authentication(this._options));
56
48
  }
57
49
 
50
+ private _preferences?: Preferences;
51
+ get preferences(): Preferences {
52
+ return (this._preferences ??= new Preferences(this._options));
53
+ }
54
+
58
55
  /**
59
56
  * Get subscribers
60
57
  *
@@ -81,88 +78,6 @@ export class Subscribers extends ClientSDK {
81
78
  ));
82
79
  }
83
80
 
84
- /**
85
- * Create subscriber
86
- *
87
- * @remarks
88
- * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
89
- */
90
- async create(
91
- createSubscriberRequestDto: components.CreateSubscriberRequestDto,
92
- idempotencyKey?: string | undefined,
93
- options?: RequestOptions,
94
- ): Promise<operations.SubscribersV1ControllerCreateSubscriberResponse> {
95
- return unwrapAsync(subscribersCreate(
96
- this,
97
- createSubscriberRequestDto,
98
- idempotencyKey,
99
- options,
100
- ));
101
- }
102
-
103
- /**
104
- * Get subscriber
105
- *
106
- * @remarks
107
- * Get subscriber by your internal id used to identify the subscriber
108
- */
109
- async retrieveLegacy(
110
- subscriberId: string,
111
- includeTopics?: boolean | undefined,
112
- idempotencyKey?: string | undefined,
113
- options?: RequestOptions,
114
- ): Promise<operations.SubscribersV1ControllerGetSubscriberResponse> {
115
- return unwrapAsync(subscribersRetrieveLegacy(
116
- this,
117
- subscriberId,
118
- includeTopics,
119
- idempotencyKey,
120
- options,
121
- ));
122
- }
123
-
124
- /**
125
- * Update subscriber
126
- *
127
- * @remarks
128
- * Used to update the subscriber entity with new information
129
- */
130
- async updateLegacy(
131
- updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
132
- subscriberId: string,
133
- idempotencyKey?: string | undefined,
134
- options?: RequestOptions,
135
- ): Promise<operations.SubscribersV1ControllerUpdateSubscriberResponse> {
136
- return unwrapAsync(subscribersUpdateLegacy(
137
- this,
138
- updateSubscriberRequestDto,
139
- subscriberId,
140
- idempotencyKey,
141
- options,
142
- ));
143
- }
144
-
145
- /**
146
- * Delete subscriber
147
- *
148
- * @remarks
149
- * Deletes a subscriber entity from the Novu platform
150
- *
151
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
152
- */
153
- async deleteLegacy(
154
- subscriberId: string,
155
- idempotencyKey?: string | undefined,
156
- options?: RequestOptions,
157
- ): Promise<operations.SubscribersV1ControllerRemoveSubscriberResponse> {
158
- return unwrapAsync(subscribersDeleteLegacy(
159
- this,
160
- subscriberId,
161
- idempotencyKey,
162
- options,
163
- ));
164
- }
165
-
166
81
  /**
167
82
  * Bulk create subscribers
168
83
  *
@@ -198,6 +113,25 @@ export class Subscribers extends ClientSDK {
198
113
  ));
199
114
  }
200
115
 
116
+ /**
117
+ * Create subscriber
118
+ *
119
+ * @remarks
120
+ * Create subscriber with the given data
121
+ */
122
+ async create(
123
+ createSubscriberRequestDto: components.CreateSubscriberRequestDto,
124
+ idempotencyKey?: string | undefined,
125
+ options?: RequestOptions,
126
+ ): Promise<operations.SubscribersControllerCreateSubscriberResponse> {
127
+ return unwrapAsync(subscribersCreate(
128
+ this,
129
+ createSubscriberRequestDto,
130
+ idempotencyKey,
131
+ options,
132
+ ));
133
+ }
134
+
201
135
  /**
202
136
  * Get subscriber
203
137
  *
@@ -1,86 +0,0 @@
1
- # Legacy
2
- (*subscribers.preferences.legacy*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [updateGlobal](#updateglobal) - Update subscriber global preferences
9
-
10
- ## updateGlobal
11
-
12
- Update subscriber global preferences
13
-
14
- ### Example Usage
15
-
16
- ```typescript
17
- import { Novu } from "@novu/api";
18
-
19
- const novu = new Novu({
20
- secretKey: "<YOUR_API_KEY_HERE>",
21
- });
22
-
23
- async function run() {
24
- const result = await novu.subscribers.preferences.legacy.updateGlobal({}, "<id>");
25
-
26
- // Handle the result
27
- console.log(result);
28
- }
29
-
30
- run();
31
- ```
32
-
33
- ### Standalone function
34
-
35
- The standalone function version of this method:
36
-
37
- ```typescript
38
- import { NovuCore } from "@novu/api/core.js";
39
- import { subscribersPreferencesLegacyUpdateGlobal } from "@novu/api/funcs/subscribersPreferencesLegacyUpdateGlobal.js";
40
-
41
- // Use `NovuCore` for best tree-shaking performance.
42
- // You can create one instance of it to use across an application.
43
- const novu = new NovuCore({
44
- secretKey: "<YOUR_API_KEY_HERE>",
45
- });
46
-
47
- async function run() {
48
- const res = await subscribersPreferencesLegacyUpdateGlobal(novu, {}, "<id>");
49
-
50
- if (!res.ok) {
51
- throw res.error;
52
- }
53
-
54
- const { value: result } = res;
55
-
56
- // Handle the result
57
- console.log(result);
58
- }
59
-
60
- run();
61
- ```
62
-
63
- ### Parameters
64
-
65
- | Parameter | Type | Required | Description |
66
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
67
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
68
- | `updateSubscriberGlobalPreferencesRequestDto` | [components.UpdateSubscriberGlobalPreferencesRequestDto](../../models/components/updatesubscriberglobalpreferencesrequestdto.md) | :heavy_check_mark: | N/A |
69
- | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
70
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
71
- | `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. |
72
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
73
-
74
- ### Response
75
-
76
- **Promise\<[operations.SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse](../../models/operations/subscribersv1controllerupdatesubscriberglobalpreferencesresponse.md)\>**
77
-
78
- ### Errors
79
-
80
- | Error Type | Status Code | Content Type |
81
- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
82
- | errors.ErrorDto | 414 | application/json |
83
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
84
- | errors.ValidationErrorDto | 422 | application/json |
85
- | errors.ErrorDto | 500 | application/json |
86
- | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -1,18 +0,0 @@
1
- import { NovuCore } from "../core.js";
2
- import { RequestOptions } from "../lib/sdks.js";
3
- import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
4
- import * as errors from "../models/errors/index.js";
5
- import { SDKError } from "../models/errors/sdkerror.js";
6
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
- import * as operations from "../models/operations/index.js";
8
- import { Result } from "../types/fp.js";
9
- /**
10
- * Delete subscriber
11
- *
12
- * @remarks
13
- * Deletes a subscriber entity from the Novu platform
14
- *
15
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
16
- */
17
- export declare function subscribersDeleteLegacy(client: NovuCore, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<Result<operations.SubscribersV1ControllerRemoveSubscriberResponse, errors.ErrorDto | errors.ErrorDto | errors.ValidationErrorDto | errors.ErrorDto | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
18
- //# sourceMappingURL=subscribersDeleteLegacy.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"subscribersDeleteLegacy.d.ts","sourceRoot":"","sources":["../src/funcs/subscribersDeleteLegacy.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;GAOG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,QAAQ,EAChB,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,+CAA+C,EACxD,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,MAAM,CAAC,QAAQ,GACf,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAkJA"}