@novu/api 3.14.0 → 3.14.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 (324) hide show
  1. package/README.md +7 -3
  2. package/funcs/environmentsDiff.d.ts +19 -0
  3. package/funcs/environmentsDiff.d.ts.map +1 -0
  4. package/funcs/environmentsDiff.js +156 -0
  5. package/funcs/environmentsDiff.js.map +1 -0
  6. package/funcs/environmentsPublish.d.ts +19 -0
  7. package/funcs/environmentsPublish.d.ts.map +1 -0
  8. package/funcs/environmentsPublish.js +156 -0
  9. package/funcs/environmentsPublish.js.map +1 -0
  10. package/funcs/translationsMasterUpload.js +7 -0
  11. package/funcs/translationsMasterUpload.js.map +1 -1
  12. package/funcs/translationsUpload.js +8 -1
  13. package/funcs/translationsUpload.js.map +1 -1
  14. package/jsr.json +1 -1
  15. package/lib/config.d.ts +4 -4
  16. package/lib/config.js +4 -4
  17. package/lib/matchers.d.ts.map +1 -1
  18. package/lib/matchers.js +0 -1
  19. package/lib/matchers.js.map +1 -1
  20. package/lib/security.d.ts.map +1 -1
  21. package/lib/security.js +1 -2
  22. package/lib/security.js.map +1 -1
  23. package/models/components/activitynotificationjobresponsedto.d.ts +1 -0
  24. package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
  25. package/models/components/activitynotificationjobresponsedto.js +1 -0
  26. package/models/components/activitynotificationjobresponsedto.js.map +1 -1
  27. package/models/components/channelsettingsdto.d.ts +2 -2
  28. package/models/components/channelsettingsdto.d.ts.map +1 -1
  29. package/models/components/channelsettingsdto.js +2 -2
  30. package/models/components/channelsettingsdto.js.map +1 -1
  31. package/models/components/chatstepresponsedto.d.ts +4 -0
  32. package/models/components/chatstepresponsedto.d.ts.map +1 -1
  33. package/models/components/chatstepresponsedto.js +1 -0
  34. package/models/components/chatstepresponsedto.js.map +1 -1
  35. package/models/components/createworkflowdto.d.ts +5 -4
  36. package/models/components/createworkflowdto.d.ts.map +1 -1
  37. package/models/components/createworkflowdto.js +3 -0
  38. package/models/components/createworkflowdto.js.map +1 -1
  39. package/models/components/customstepresponsedto.d.ts +4 -0
  40. package/models/components/customstepresponsedto.d.ts.map +1 -1
  41. package/models/components/customstepresponsedto.js +1 -0
  42. package/models/components/customstepresponsedto.js.map +1 -1
  43. package/models/components/delaystepresponsedto.d.ts +4 -0
  44. package/models/components/delaystepresponsedto.d.ts.map +1 -1
  45. package/models/components/delaystepresponsedto.js +1 -0
  46. package/models/components/delaystepresponsedto.js.map +1 -1
  47. package/models/components/dependencyreasonenum.d.ts +16 -0
  48. package/models/components/dependencyreasonenum.d.ts.map +1 -0
  49. package/models/components/dependencyreasonenum.js +50 -0
  50. package/models/components/dependencyreasonenum.js.map +1 -0
  51. package/models/components/diffactionenum.d.ts +19 -0
  52. package/models/components/diffactionenum.d.ts.map +1 -0
  53. package/models/components/diffactionenum.js +53 -0
  54. package/models/components/diffactionenum.js.map +1 -0
  55. package/models/components/diffenvironmentrequestdto.d.ts +15 -0
  56. package/models/components/diffenvironmentrequestdto.d.ts.map +1 -0
  57. package/models/components/diffenvironmentrequestdto.js +49 -0
  58. package/models/components/diffenvironmentrequestdto.js.map +1 -0
  59. package/models/components/diffenvironmentresponsedto.d.ts +27 -0
  60. package/models/components/diffenvironmentresponsedto.d.ts.map +1 -0
  61. package/models/components/diffenvironmentresponsedto.js +55 -0
  62. package/models/components/diffenvironmentresponsedto.js.map +1 -0
  63. package/models/components/diffsummarydto.d.ts +25 -0
  64. package/models/components/diffsummarydto.d.ts.map +1 -0
  65. package/models/components/diffsummarydto.js +53 -0
  66. package/models/components/diffsummarydto.js.map +1 -0
  67. package/models/components/digeststepresponsedto.d.ts +4 -0
  68. package/models/components/digeststepresponsedto.d.ts.map +1 -1
  69. package/models/components/digeststepresponsedto.js +1 -0
  70. package/models/components/digeststepresponsedto.js.map +1 -1
  71. package/models/components/emailstepresponsedto.d.ts +4 -0
  72. package/models/components/emailstepresponsedto.d.ts.map +1 -1
  73. package/models/components/emailstepresponsedto.js +1 -0
  74. package/models/components/emailstepresponsedto.js.map +1 -1
  75. package/models/components/environmentdiffsummarydto.d.ts +21 -0
  76. package/models/components/environmentdiffsummarydto.d.ts.map +1 -0
  77. package/models/components/environmentdiffsummarydto.js +52 -0
  78. package/models/components/environmentdiffsummarydto.js.map +1 -0
  79. package/models/components/failedworkflowdto.d.ts +30 -0
  80. package/models/components/failedworkflowdto.d.ts.map +1 -0
  81. package/models/components/failedworkflowdto.js +55 -0
  82. package/models/components/failedworkflowdto.js.map +1 -0
  83. package/models/components/httpmethodenum.d.ts +21 -0
  84. package/models/components/httpmethodenum.d.ts.map +1 -0
  85. package/models/components/httpmethodenum.js +55 -0
  86. package/models/components/httpmethodenum.js.map +1 -0
  87. package/models/components/httprequestcontroldto.d.ts +56 -0
  88. package/models/components/httprequestcontroldto.d.ts.map +1 -0
  89. package/models/components/httprequestcontroldto.js +72 -0
  90. package/models/components/httprequestcontroldto.js.map +1 -0
  91. package/models/components/httprequestcontrolsmetadataresponsedto.d.ts +25 -0
  92. package/models/components/httprequestcontrolsmetadataresponsedto.d.ts.map +1 -0
  93. package/models/components/httprequestcontrolsmetadataresponsedto.js +54 -0
  94. package/models/components/httprequestcontrolsmetadataresponsedto.js.map +1 -0
  95. package/models/components/httprequestkeyvaluepairdto.d.ts +25 -0
  96. package/models/components/httprequestkeyvaluepairdto.d.ts.map +1 -0
  97. package/models/components/httprequestkeyvaluepairdto.js +60 -0
  98. package/models/components/httprequestkeyvaluepairdto.js.map +1 -0
  99. package/models/components/httprequeststepresponsedto.d.ts +109 -0
  100. package/models/components/httprequeststepresponsedto.d.ts.map +1 -0
  101. package/models/components/httprequeststepresponsedto.js +86 -0
  102. package/models/components/httprequeststepresponsedto.js.map +1 -0
  103. package/models/components/httprequeststepupsertdto.d.ts +53 -0
  104. package/models/components/httprequeststepupsertdto.d.ts.map +1 -0
  105. package/models/components/httprequeststepupsertdto.js +68 -0
  106. package/models/components/httprequeststepupsertdto.js.map +1 -0
  107. package/models/components/inappstepresponsedto.d.ts +4 -0
  108. package/models/components/inappstepresponsedto.d.ts.map +1 -1
  109. package/models/components/inappstepresponsedto.js +1 -0
  110. package/models/components/inappstepresponsedto.js.map +1 -1
  111. package/models/components/inappstepupsertdto.d.ts +4 -4
  112. package/models/components/inappstepupsertdto.d.ts.map +1 -1
  113. package/models/components/inappstepupsertdto.js +5 -5
  114. package/models/components/inappstepupsertdto.js.map +1 -1
  115. package/models/components/index.d.ts +24 -0
  116. package/models/components/index.d.ts.map +1 -1
  117. package/models/components/index.js +24 -0
  118. package/models/components/index.js.map +1 -1
  119. package/models/components/integrationresponsedto.d.ts +4 -4
  120. package/models/components/integrationresponsedto.d.ts.map +1 -1
  121. package/models/components/integrationresponsedto.js +2 -2
  122. package/models/components/integrationresponsedto.js.map +1 -1
  123. package/models/components/layoutcontrolvaluesdto.d.ts +9 -2
  124. package/models/components/layoutcontrolvaluesdto.d.ts.map +1 -1
  125. package/models/components/layoutcontrolvaluesdto.js +10 -2
  126. package/models/components/layoutcontrolvaluesdto.js.map +1 -1
  127. package/models/components/publishenvironmentrequestdto.d.ts +26 -0
  128. package/models/components/publishenvironmentrequestdto.d.ts.map +1 -0
  129. package/models/components/publishenvironmentrequestdto.js +52 -0
  130. package/models/components/publishenvironmentrequestdto.js.map +1 -0
  131. package/models/components/publishenvironmentresponsedto.d.ts +19 -0
  132. package/models/components/publishenvironmentresponsedto.d.ts.map +1 -0
  133. package/models/components/publishenvironmentresponsedto.js +53 -0
  134. package/models/components/publishenvironmentresponsedto.js.map +1 -0
  135. package/models/components/publishsummarydto.d.ts +25 -0
  136. package/models/components/publishsummarydto.d.ts.map +1 -0
  137. package/models/components/publishsummarydto.js +53 -0
  138. package/models/components/publishsummarydto.js.map +1 -0
  139. package/models/components/pushstepresponsedto.d.ts +4 -0
  140. package/models/components/pushstepresponsedto.d.ts.map +1 -1
  141. package/models/components/pushstepresponsedto.js +1 -0
  142. package/models/components/pushstepresponsedto.js.map +1 -1
  143. package/models/components/resourcedependencydto.d.ts +31 -0
  144. package/models/components/resourcedependencydto.d.ts.map +1 -0
  145. package/models/components/resourcedependencydto.js +56 -0
  146. package/models/components/resourcedependencydto.js.map +1 -0
  147. package/models/components/resourcediffdto.d.ts +159 -0
  148. package/models/components/resourcediffdto.d.ts.map +1 -0
  149. package/models/components/resourcediffdto.js +123 -0
  150. package/models/components/resourcediffdto.js.map +1 -0
  151. package/models/components/resourcediffresultdto.d.ts +133 -0
  152. package/models/components/resourcediffresultdto.d.ts.map +1 -0
  153. package/models/components/resourcediffresultdto.js +114 -0
  154. package/models/components/resourcediffresultdto.js.map +1 -0
  155. package/models/components/resourcetopublishdto.d.ts +21 -0
  156. package/models/components/resourcetopublishdto.d.ts.map +1 -0
  157. package/models/components/resourcetopublishdto.js +51 -0
  158. package/models/components/resourcetopublishdto.js.map +1 -0
  159. package/models/components/resourcetypeenum.d.ts +2 -0
  160. package/models/components/resourcetypeenum.d.ts.map +1 -1
  161. package/models/components/resourcetypeenum.js +3 -1
  162. package/models/components/resourcetypeenum.js.map +1 -1
  163. package/models/components/runtimeissuedto.d.ts +1 -16
  164. package/models/components/runtimeissuedto.d.ts.map +1 -1
  165. package/models/components/runtimeissuedto.js +2 -16
  166. package/models/components/runtimeissuedto.js.map +1 -1
  167. package/models/components/skippedworkflowdto.d.ts +26 -0
  168. package/models/components/skippedworkflowdto.d.ts.map +1 -0
  169. package/models/components/skippedworkflowdto.js +54 -0
  170. package/models/components/skippedworkflowdto.js.map +1 -0
  171. package/models/components/smsstepresponsedto.d.ts +4 -0
  172. package/models/components/smsstepresponsedto.d.ts.map +1 -1
  173. package/models/components/smsstepresponsedto.js +1 -0
  174. package/models/components/smsstepresponsedto.js.map +1 -1
  175. package/models/components/stepresponsedto.d.ts +4 -0
  176. package/models/components/stepresponsedto.d.ts.map +1 -1
  177. package/models/components/stepresponsedto.js +1 -0
  178. package/models/components/stepresponsedto.js.map +1 -1
  179. package/models/components/subscriberresponsedto.d.ts +4 -4
  180. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  181. package/models/components/subscriberresponsedto.js +4 -4
  182. package/models/components/subscriberresponsedto.js.map +1 -1
  183. package/models/components/subscriberresponsedtooptional.d.ts +8 -8
  184. package/models/components/subscriberresponsedtooptional.d.ts.map +1 -1
  185. package/models/components/subscriberresponsedtooptional.js +8 -8
  186. package/models/components/subscriberresponsedtooptional.js.map +1 -1
  187. package/models/components/syncactionenum.d.ts +18 -0
  188. package/models/components/syncactionenum.d.ts.map +1 -0
  189. package/models/components/syncactionenum.js +52 -0
  190. package/models/components/syncactionenum.js.map +1 -0
  191. package/models/components/syncedworkflowdto.d.ts +27 -0
  192. package/models/components/syncedworkflowdto.d.ts.map +1 -0
  193. package/models/components/syncedworkflowdto.js +55 -0
  194. package/models/components/syncedworkflowdto.js.map +1 -0
  195. package/models/components/syncresultdto.d.ts +33 -0
  196. package/models/components/syncresultdto.d.ts.map +1 -0
  197. package/models/components/syncresultdto.js +58 -0
  198. package/models/components/syncresultdto.js.map +1 -0
  199. package/models/components/throttlestepresponsedto.d.ts +4 -0
  200. package/models/components/throttlestepresponsedto.d.ts.map +1 -1
  201. package/models/components/throttlestepresponsedto.js +1 -0
  202. package/models/components/throttlestepresponsedto.js.map +1 -1
  203. package/models/components/uicomponentenum.d.ts +11 -3
  204. package/models/components/uicomponentenum.d.ts.map +1 -1
  205. package/models/components/uicomponentenum.js +10 -2
  206. package/models/components/uicomponentenum.js.map +1 -1
  207. package/models/components/uischemagroupenum.d.ts +1 -0
  208. package/models/components/uischemagroupenum.d.ts.map +1 -1
  209. package/models/components/uischemagroupenum.js +1 -0
  210. package/models/components/uischemagroupenum.js.map +1 -1
  211. package/models/components/updatelayoutdto.d.ts +3 -19
  212. package/models/components/updatelayoutdto.d.ts.map +1 -1
  213. package/models/components/updatelayoutdto.js +3 -12
  214. package/models/components/updatelayoutdto.js.map +1 -1
  215. package/models/components/updatesubscriberchannelrequestdto.d.ts +2 -2
  216. package/models/components/updatesubscriberchannelrequestdto.d.ts.map +1 -1
  217. package/models/components/updatesubscriberchannelrequestdto.js +1 -1
  218. package/models/components/updatesubscriberchannelrequestdto.js.map +1 -1
  219. package/models/components/updateworkflowdto.d.ts +5 -4
  220. package/models/components/updateworkflowdto.d.ts.map +1 -1
  221. package/models/components/updateworkflowdto.js +3 -0
  222. package/models/components/updateworkflowdto.js.map +1 -1
  223. package/models/components/workflowcreationsourceenum.d.ts +1 -0
  224. package/models/components/workflowcreationsourceenum.d.ts.map +1 -1
  225. package/models/components/workflowcreationsourceenum.js +1 -0
  226. package/models/components/workflowcreationsourceenum.js.map +1 -1
  227. package/models/components/workflowresponsedto.d.ts +3 -2
  228. package/models/components/workflowresponsedto.d.ts.map +1 -1
  229. package/models/components/workflowresponsedto.js +3 -0
  230. package/models/components/workflowresponsedto.js.map +1 -1
  231. package/models/errors/subscriberresponsedto.d.ts +8 -8
  232. package/models/errors/subscriberresponsedto.d.ts.map +1 -1
  233. package/models/errors/subscriberresponsedto.js +8 -12
  234. package/models/errors/subscriberresponsedto.js.map +1 -1
  235. package/models/operations/environmentscontrollerdiffenvironment.d.ts +37 -0
  236. package/models/operations/environmentscontrollerdiffenvironment.d.ts.map +1 -0
  237. package/models/operations/environmentscontrollerdiffenvironment.js +73 -0
  238. package/models/operations/environmentscontrollerdiffenvironment.js.map +1 -0
  239. package/models/operations/environmentscontrollerpublishenvironment.d.ts +37 -0
  240. package/models/operations/environmentscontrollerpublishenvironment.d.ts.map +1 -0
  241. package/models/operations/environmentscontrollerpublishenvironment.js +73 -0
  242. package/models/operations/environmentscontrollerpublishenvironment.js.map +1 -0
  243. package/models/operations/index.d.ts +2 -0
  244. package/models/operations/index.d.ts.map +1 -1
  245. package/models/operations/index.js +2 -0
  246. package/models/operations/index.js.map +1 -1
  247. package/package.json +1 -1
  248. package/sdk/environments.d.ts +14 -0
  249. package/sdk/environments.d.ts.map +1 -1
  250. package/sdk/environments.js +20 -0
  251. package/sdk/environments.js.map +1 -1
  252. package/src/funcs/environmentsDiff.ts +243 -0
  253. package/src/funcs/environmentsPublish.ts +243 -0
  254. package/src/funcs/translationsMasterUpload.ts +12 -0
  255. package/src/funcs/translationsUpload.ts +12 -1
  256. package/src/lib/config.ts +4 -4
  257. package/src/lib/matchers.ts +3 -2
  258. package/src/lib/security.ts +1 -2
  259. package/src/models/components/activitynotificationjobresponsedto.ts +1 -0
  260. package/src/models/components/channelsettingsdto.ts +4 -4
  261. package/src/models/components/chatstepresponsedto.ts +5 -0
  262. package/src/models/components/createworkflowdto.ts +13 -2
  263. package/src/models/components/customstepresponsedto.ts +5 -0
  264. package/src/models/components/delaystepresponsedto.ts +5 -0
  265. package/src/models/components/dependencyreasonenum.ts +23 -0
  266. package/src/models/components/diffactionenum.ts +26 -0
  267. package/src/models/components/diffenvironmentrequestdto.ts +34 -0
  268. package/src/models/components/diffenvironmentresponsedto.ts +57 -0
  269. package/src/models/components/diffsummarydto.ts +49 -0
  270. package/src/models/components/digeststepresponsedto.ts +5 -0
  271. package/src/models/components/emailstepresponsedto.ts +5 -0
  272. package/src/models/components/environmentdiffsummarydto.ts +44 -0
  273. package/src/models/components/failedworkflowdto.ts +58 -0
  274. package/src/models/components/httpmethodenum.ts +30 -0
  275. package/src/models/components/httprequestcontroldto.ts +107 -0
  276. package/src/models/components/httprequestcontrolsmetadataresponsedto.ts +50 -0
  277. package/src/models/components/httprequestkeyvaluepairdto.ts +61 -0
  278. package/src/models/components/httprequeststepresponsedto.ts +191 -0
  279. package/src/models/components/httprequeststepupsertdto.ts +103 -0
  280. package/src/models/components/inappstepresponsedto.ts +5 -0
  281. package/src/models/components/inappstepupsertdto.ts +9 -17
  282. package/src/models/components/index.ts +24 -0
  283. package/src/models/components/integrationresponsedto.ts +5 -5
  284. package/src/models/components/layoutcontrolvaluesdto.ts +24 -2
  285. package/src/models/components/publishenvironmentrequestdto.ts +53 -0
  286. package/src/models/components/publishenvironmentresponsedto.ts +44 -0
  287. package/src/models/components/publishsummarydto.ts +49 -0
  288. package/src/models/components/pushstepresponsedto.ts +5 -0
  289. package/src/models/components/resourcedependencydto.ts +62 -0
  290. package/src/models/components/resourcediffdto.ts +305 -0
  291. package/src/models/components/resourcediffresultdto.ts +277 -0
  292. package/src/models/components/resourcetopublishdto.ts +44 -0
  293. package/src/models/components/resourcetypeenum.ts +4 -0
  294. package/src/models/components/runtimeissuedto.ts +2 -24
  295. package/src/models/components/skippedworkflowdto.ts +53 -0
  296. package/src/models/components/smsstepresponsedto.ts +5 -0
  297. package/src/models/components/stepresponsedto.ts +5 -0
  298. package/src/models/components/subscriberresponsedto.ts +8 -8
  299. package/src/models/components/subscriberresponsedtooptional.ts +16 -16
  300. package/src/models/components/syncactionenum.ts +25 -0
  301. package/src/models/components/syncedworkflowdto.ts +57 -0
  302. package/src/models/components/syncresultdto.ts +70 -0
  303. package/src/models/components/throttlestepresponsedto.ts +5 -0
  304. package/src/models/components/uicomponentenum.ts +16 -5
  305. package/src/models/components/uischemagroupenum.ts +1 -0
  306. package/src/models/components/updatelayoutdto.ts +7 -36
  307. package/src/models/components/updatesubscriberchannelrequestdto.ts +3 -3
  308. package/src/models/components/updateworkflowdto.ts +13 -2
  309. package/src/models/components/workflowcreationsourceenum.ts +1 -0
  310. package/src/models/components/workflowresponsedto.ts +9 -1
  311. package/src/models/errors/subscriberresponsedto.ts +16 -16
  312. package/src/models/operations/environmentscontrollerdiffenvironment.ts +98 -0
  313. package/src/models/operations/environmentscontrollerpublishenvironment.ts +99 -0
  314. package/src/models/operations/index.ts +2 -0
  315. package/src/sdk/environments.ts +44 -0
  316. package/_speakeasy/.github/action-inputs-config.json +0 -53
  317. package/_speakeasy/.github/action-security-config.json +0 -88
  318. package/codeSamples.json +0 -1772
  319. package/examples/package-lock.json +0 -610
  320. package/examples/package.json +0 -18
  321. package/sources/code-samples.json +0 -2105
  322. package/sources/json-development.json +0 -55438
  323. package/sources/openapi.sdk.json +0 -13193
  324. package/tsconfig.json +0 -40
@@ -1,2105 +0,0 @@
1
- overlay: 1.0.0
2
- info:
3
- title: CodeSamples overlay for typescript target
4
- version: 0.0.0
5
- actions:
6
- <<<<<<< Updated upstream
7
- - target: $["paths"]["/v1/organizations"]["post"]
8
- update:
9
- "x-codeSamples":
10
- - "lang": "typescript"
11
- "label": "OrganizationController_createOrganization"
12
- "source": |-
13
- import { Novu } from "@novu/api";
14
-
15
- const novu = new Novu({
16
- apiKey: "<YOUR_API_KEY_HERE>",
17
- });
18
-
19
- async function run() {
20
- const result = await novu.organizations.create({
21
- name: "<value>",
22
- });
23
-
24
- // Handle the result
25
- console.log(result)
26
- }
27
-
28
- run();
29
- - target: $["paths"]["/v1/workflows/{workflowId}/status"]["put"]
30
- update:
31
- "x-codeSamples":
32
- - "lang": "typescript"
33
- "label": "WorkflowController_updateActiveStatus"
34
- "source": |-
35
- import { Novu } from "@novu/api";
36
-
37
- const novu = new Novu({
38
- apiKey: "<YOUR_API_KEY_HERE>",
39
- });
40
-
41
- async function run() {
42
- const result = await novu.workflows.status.update("<value>", {
43
- active: false,
44
- });
45
-
46
- // Handle the result
47
- console.log(result)
48
- }
49
-
50
- run();
51
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials"]["put"]
52
- update:
53
- "x-codeSamples":
54
- - "lang": "typescript"
55
- "label": "SubscribersController_updateSubscriberChannel"
56
- "source": |-
57
- import { Novu } from "@novu/api";
58
- import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";
59
-
60
- const novu = new Novu({
61
- apiKey: "<YOUR_API_KEY_HERE>",
62
- });
63
-
64
- async function run() {
65
- const result = await novu.subscribers.credentials.update("<value>", {
66
- providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad,
67
- credentials: {
68
- webhookUrl: "<value>",
69
- },
70
- });
71
-
72
- // Handle the result
73
- console.log(result)
74
- }
75
-
76
- run();
77
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences"]["patch"]
78
- update:
79
- "x-codeSamples":
80
- - "lang": "typescript"
81
- "label": "SubscribersController_updateSubscriberGlobalPreferences"
82
- "source": |-
83
- import { Novu } from "@novu/api";
84
-
85
- const novu = new Novu({
86
- apiKey: "<YOUR_API_KEY_HERE>",
87
- });
88
-
89
- async function run() {
90
- const result = await novu.subscribers.preferences.updateGlobal("<value>", {});
91
-
92
- // Handle the result
93
- console.log(result)
94
- }
95
-
96
- run();
97
- - target: $["paths"]["/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}"]["post"]
98
- update:
99
- "x-codeSamples":
100
- - "lang": "typescript"
101
- "label": "SubscribersController_markActionAsSeen"
102
- "source": |-
103
- import { Novu } from "@novu/api";
104
- import { MarkMessageActionAsSeenDtoStatus } from "@novu/api/models/components";
105
-
106
- const novu = new Novu({
107
- apiKey: "<YOUR_API_KEY_HERE>",
108
- });
109
-
110
- async function run() {
111
- const result = await novu.subscribers.messages.updateAsSeen({
112
- messageId: "<value>",
113
- type: "<value>",
114
- subscriberId: "<value>",
115
- markMessageActionAsSeenDto: {
116
- status: MarkMessageActionAsSeenDtoStatus.Done,
117
- },
118
- });
119
-
120
- // Handle the result
121
- console.log(result)
122
- }
123
-
124
- run();
125
- - target: $["paths"]["/v1/layouts/{layoutId}"]["patch"]
126
- update:
127
- "x-codeSamples":
128
- - "lang": "typescript"
129
- "label": "LayoutsController_updateLayout"
130
- "source": |-
131
- import { Novu } from "@novu/api";
132
-
133
- const novu = new Novu({
134
- apiKey: "<YOUR_API_KEY_HERE>",
135
- });
136
-
137
- async function run() {
138
- const result = await novu.layouts.update("<value>", {
139
- identifier: "<value>",
140
- });
141
-
142
- // Handle the result
143
- console.log(result)
144
- }
145
-
146
- run();
147
- - target: $["paths"]["/v1/topics/{topicKey}"]["get"]
148
- update:
149
- "x-codeSamples":
150
- - "lang": "typescript"
151
- "label": "TopicsController_getTopic"
152
- "source": |-
153
- import { Novu } from "@novu/api";
154
-
155
- const novu = new Novu({
156
- apiKey: "<YOUR_API_KEY_HERE>",
157
- });
158
-
159
- async function run() {
160
- const result = await novu.topics.retrieve("<value>");
161
-
162
- // Handle the result
163
- console.log(result)
164
- }
165
-
166
- run();
167
- - target: $["paths"]["/v1/environments"]["get"]
168
- update:
169
- "x-codeSamples":
170
- - "lang": "typescript"
171
- "label": "EnvironmentsController_listMyEnvironments"
172
- "source": |-
173
- import { Novu } from "@novu/api";
174
-
175
- const novu = new Novu({
176
- apiKey: "<YOUR_API_KEY_HERE>",
177
- });
178
-
179
- async function run() {
180
- const result = await novu.environments.list();
181
-
182
- // Handle the result
183
- console.log(result)
184
- }
185
-
186
- run();
187
- - target: $["paths"]["/v1/environments/api-keys"]["get"]
188
- update:
189
- "x-codeSamples":
190
- - "lang": "typescript"
191
- "label": "EnvironmentsController_listOrganizationApiKeys"
192
- "source": |-
193
- import { Novu } from "@novu/api";
194
-
195
- const novu = new Novu({
196
- apiKey: "<YOUR_API_KEY_HERE>",
197
- });
198
-
199
- async function run() {
200
- const result = await novu.environments.apiKeys.list();
201
-
202
- // Handle the result
203
- console.log(result)
204
- }
205
-
206
- run();
207
- - target: $["paths"]["/v1/workflows/variables"]["get"]
208
- update:
209
- "x-codeSamples":
210
- - "lang": "typescript"
211
- "label": "WorkflowController_getWorkflowVariables"
212
- "source": |-
213
- import { Novu } from "@novu/api";
214
-
215
- const novu = new Novu({
216
- apiKey: "<YOUR_API_KEY_HERE>",
217
- });
218
-
219
- async function run() {
220
- const result = await novu.workflows.variables.retrieve();
221
-
222
- // Handle the result
223
- console.log(result)
224
- }
225
-
226
- run();
227
- - target: $["paths"]["/v1/notifications/graph/stats"]["get"]
228
- update:
229
- "x-codeSamples":
230
- - "lang": "typescript"
231
- "label": "NotificationsController_getActivityGraphStats"
232
- "source": |-
233
- import { Novu } from "@novu/api";
234
-
235
- const novu = new Novu({
236
- apiKey: "<YOUR_API_KEY_HERE>",
237
- });
238
-
239
- async function run() {
240
- const result = await novu.notifications.stats.graph(4018.61);
241
-
242
- // Handle the result
243
- console.log(result)
244
- }
245
-
246
- run();
247
- - target: $["paths"]["/v1/notification-groups"]["post"]
248
- update:
249
- "x-codeSamples":
250
- - "lang": "typescript"
251
- "label": "NotificationGroupsController_createNotificationGroup"
252
- "source": |-
253
- import { Novu } from "@novu/api";
254
-
255
- const novu = new Novu({
256
- apiKey: "<YOUR_API_KEY_HERE>",
257
- });
258
-
259
- async function run() {
260
- const result = await novu.workflowGroups.create({
261
- name: "<value>",
262
- });
263
-
264
- // Handle the result
265
- console.log(result)
266
- }
267
-
268
- run();
269
- - target: $["paths"]["/v1/feeds"]["post"]
270
- update:
271
- "x-codeSamples":
272
- - "lang": "typescript"
273
- "label": "FeedsController_createFeed"
274
- "source": |-
275
- import { Novu } from "@novu/api";
276
-
277
- const novu = new Novu({
278
- apiKey: "<YOUR_API_KEY_HERE>",
279
- });
280
-
281
- async function run() {
282
- const result = await novu.feeds.create({
283
- name: "<value>",
284
- });
285
-
286
- // Handle the result
287
- console.log(result)
288
- }
289
-
290
- run();
291
- - target: $["paths"]["/v1/layouts"]["get"]
292
- update:
293
- "x-codeSamples":
294
- - "lang": "typescript"
295
- "label": "LayoutsController_listLayouts"
296
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.layouts.list({});\n\n \n}\n\nrun();"
297
- =======
298
- - target: $["paths"]["/v1/environments"]["get"]
299
- update:
300
- "x-codeSamples":
301
- - "lang": "typescript"
302
- "label": "EnvironmentsControllerV1_listMyEnvironments"
303
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.environments.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
304
- - target: $["paths"]["/v1/environments/api-keys"]["get"]
305
- update:
306
- "x-codeSamples":
307
- - "lang": "typescript"
308
- "label": "EnvironmentsControllerV1_listOrganizationApiKeys"
309
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.environments.apiKeys.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
310
- - target: $["paths"]["/v1/environments/me"]["get"]
311
- update:
312
- "x-codeSamples":
313
- - "lang": "typescript"
314
- "label": "EnvironmentsControllerV1_getCurrentEnvironment"
315
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.environments.retrieve();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
316
- >>>>>>> Stashed changes
317
- - target: $["paths"]["/v1/events/trigger"]["post"]
318
- update:
319
- "x-codeSamples":
320
- - "lang": "typescript"
321
- "label": "EventsController_trigger"
322
- <<<<<<< Updated upstream
323
- "source": |-
324
- import { Novu } from "@novu/api";
325
- import { TopicPayloadDtoType } from "@novu/api/models/components";
326
-
327
- const novu = new Novu({
328
- apiKey: "<YOUR_API_KEY_HERE>",
329
- });
330
-
331
- async function run() {
332
- const result = await novu.trigger({
333
- name: "workflow_identifier",
334
- payload: {},
335
- overrides: {},
336
- to: [
337
- {
338
- topicKey: "topic_key",
339
- type: TopicPayloadDtoType.Topic,
340
- },
341
- ],
342
- });
343
-
344
- // Handle the result
345
- console.log(result)
346
- }
347
-
348
- run();
349
- - target: $["paths"]["/v1/events/trigger/{transactionId}"]["delete"]
350
- update:
351
- "x-codeSamples":
352
- - "lang": "typescript"
353
- "label": "EventsController_cancel"
354
- "source": |-
355
- import { Novu } from "@novu/api";
356
-
357
- const novu = new Novu({
358
- apiKey: "<YOUR_API_KEY_HERE>",
359
- });
360
-
361
- async function run() {
362
- const result = await novu.events.cancel("<value>");
363
-
364
- // Handle the result
365
- console.log(result)
366
- }
367
-
368
- run();
369
- - target: $["paths"]["/v1/notification-groups/{id}"]["patch"]
370
- update:
371
- "x-codeSamples":
372
- - "lang": "typescript"
373
- "label": "NotificationGroupsController_updateNotificationGroup"
374
- "source": |-
375
- import { Novu } from "@novu/api";
376
-
377
- const novu = new Novu({
378
- apiKey: "<YOUR_API_KEY_HERE>",
379
- });
380
-
381
- async function run() {
382
- const result = await novu.workflowGroups.update("<value>", {
383
- name: "<value>",
384
- });
385
-
386
- // Handle the result
387
- console.log(result)
388
- }
389
-
390
- run();
391
- - target: $["paths"]["/v1/messages/transaction/{transactionId}"]["delete"]
392
- update:
393
- "x-codeSamples":
394
- - "lang": "typescript"
395
- "label": "MessagesController_deleteMessagesByTransactionId"
396
- "source": "import { Novu } from \"@novu/api\";\nimport { QueryParamChannel } from \"@novu/api/models/operations\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.messages.deleteByTransactionId(\"<value>\", QueryParamChannel.Push);\n\n \n}\n\nrun();"
397
- - target: $["paths"]["/v1/topics/{topicKey}"]["patch"]
398
- update:
399
- "x-codeSamples":
400
- - "lang": "typescript"
401
- "label": "TopicsController_renameTopic"
402
- "source": |-
403
- import { Novu } from "@novu/api";
404
-
405
- const novu = new Novu({
406
- apiKey: "<YOUR_API_KEY_HERE>",
407
- });
408
-
409
- async function run() {
410
- const result = await novu.topics.rename("<value>", {
411
- name: "<value>",
412
- });
413
-
414
- // Handle the result
415
- console.log(result)
416
- }
417
-
418
- run();
419
- - target: $["paths"]["/v1/tenants"]["post"]
420
- update:
421
- "x-codeSamples":
422
- - "lang": "typescript"
423
- "label": "TenantController_createTenant"
424
- "source": |-
425
- import { Novu } from "@novu/api";
426
-
427
- const novu = new Novu({
428
- apiKey: "<YOUR_API_KEY_HERE>",
429
- });
430
-
431
- async function run() {
432
- const result = await novu.tenants.create({
433
- identifier: "<value>",
434
- name: "<value>",
435
- });
436
-
437
- // Handle the result
438
- console.log(result)
439
- }
440
-
441
- run();
442
- - target: $["paths"]["/v1/organizations"]["patch"]
443
- update:
444
- "x-codeSamples":
445
- - "lang": "typescript"
446
- "label": "OrganizationController_rename"
447
- "source": |-
448
- import { Novu } from "@novu/api";
449
-
450
- const novu = new Novu({
451
- apiKey: "<YOUR_API_KEY_HERE>",
452
- });
453
-
454
- async function run() {
455
- const result = await novu.organizations.rename({
456
- name: "<value>",
457
- });
458
-
459
- // Handle the result
460
- console.log(result)
461
- }
462
-
463
- run();
464
- - target: $["paths"]["/v1/organizations/me"]["get"]
465
- update:
466
- "x-codeSamples":
467
- - "lang": "typescript"
468
- "label": "OrganizationController_getSelfOrganizationData"
469
- "source": |-
470
- import { Novu } from "@novu/api";
471
-
472
- const novu = new Novu({
473
- apiKey: "<YOUR_API_KEY_HERE>",
474
- });
475
-
476
- async function run() {
477
- const result = await novu.organizations.retrieve();
478
-
479
- // Handle the result
480
- console.log(result)
481
- }
482
-
483
- run();
484
- - target: $["paths"]["/v1/workflows/{workflowId}"]["get"]
485
- update:
486
- "x-codeSamples":
487
- - "lang": "typescript"
488
- "label": "WorkflowController_getWorkflowById"
489
- "source": |-
490
- import { Novu } from "@novu/api";
491
-
492
- const novu = new Novu({
493
- apiKey: "<YOUR_API_KEY_HERE>",
494
- });
495
-
496
- async function run() {
497
- const result = await novu.workflows.retrieve("<value>");
498
-
499
- // Handle the result
500
- console.log(result)
501
- }
502
-
503
- run();
504
- - target: $["paths"]["/v1/notifications/{notificationId}"]["get"]
505
- update:
506
- "x-codeSamples":
507
- - "lang": "typescript"
508
- "label": "NotificationsController_getNotification"
509
- "source": |-
510
- import { Novu } from "@novu/api";
511
-
512
- const novu = new Novu({
513
- apiKey: "<YOUR_API_KEY_HERE>",
514
- });
515
-
516
- async function run() {
517
- const result = await novu.notifications.retrieve("<value>");
518
-
519
- // Handle the result
520
- console.log(result)
521
- }
522
-
523
- run();
524
- - target: $["paths"]["/v1/integrations"]["post"]
525
- update:
526
- "x-codeSamples":
527
- - "lang": "typescript"
528
- "label": "IntegrationsController_createIntegration"
529
- "source": |-
530
- import { Novu } from "@novu/api";
531
- import { CreateIntegrationRequestDtoChannel } from "@novu/api/models/components";
532
-
533
- const novu = new Novu({
534
- apiKey: "<YOUR_API_KEY_HERE>",
535
- });
536
-
537
- async function run() {
538
- const result = await novu.integrations.create({
539
- providerId: "<value>",
540
- channel: CreateIntegrationRequestDtoChannel.Sms,
541
- });
542
-
543
- // Handle the result
544
- console.log(result)
545
- }
546
-
547
- run();
548
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences/{parameter}"]["get"]
549
- update:
550
- "x-codeSamples":
551
- - "lang": "typescript"
552
- "label": "SubscribersController_getSubscriberPreferenceByLevel"
553
- "source": |-
554
- import { Novu } from "@novu/api";
555
-
556
- const novu = new Novu({
557
- apiKey: "<YOUR_API_KEY_HERE>",
558
- });
559
-
560
- async function run() {
561
- const result = await novu.subscribers.preferences.retrieveByLevel("<value>", "<value>");
562
-
563
- // Handle the result
564
- console.log(result)
565
- }
566
-
567
- run();
568
- - target: $["paths"]["/v1/messages"]["get"]
569
- update:
570
- "x-codeSamples":
571
- - "lang": "typescript"
572
- "label": "MessagesController_getMessages"
573
- "source": |-
574
- import { Novu } from "@novu/api";
575
-
576
- const novu = new Novu({
577
- apiKey: "<YOUR_API_KEY_HERE>",
578
- });
579
-
580
- async function run() {
581
- const result = await novu.messages.retrieve({});
582
-
583
- // Handle the result
584
- console.log(result)
585
- }
586
-
587
- run();
588
- - target: $["paths"]["/v1/organizations"]["get"]
589
- update:
590
- "x-codeSamples":
591
- - "lang": "typescript"
592
- "label": "OrganizationController_listOrganizations"
593
- "source": |-
594
- import { Novu } from "@novu/api";
595
-
596
- const novu = new Novu({
597
- apiKey: "<YOUR_API_KEY_HERE>",
598
- });
599
-
600
- async function run() {
601
- const result = await novu.organizations.list();
602
-
603
- // Handle the result
604
- console.log(result)
605
- }
606
-
607
- run();
608
- - target: $["paths"]["/v1/notification-groups/{id}"]["delete"]
609
- update:
610
- "x-codeSamples":
611
- - "lang": "typescript"
612
- "label": "NotificationGroupsController_deleteNotificationGroup"
613
- "source": |-
614
- import { Novu } from "@novu/api";
615
-
616
- const novu = new Novu({
617
- apiKey: "<YOUR_API_KEY_HERE>",
618
- });
619
-
620
- async function run() {
621
- const result = await novu.workflowGroups.delete("<value>");
622
-
623
- // Handle the result
624
- console.log(result)
625
- }
626
-
627
- run();
628
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials/{providerId}"]["delete"]
629
- update:
630
- "x-codeSamples":
631
- - "lang": "typescript"
632
- "label": "SubscribersController_deleteSubscriberCredentials"
633
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.subscribers.credentials.delete(\"<value>\", \"<value>\");\n\n \n}\n\nrun();"
634
- - target: $["paths"]["/v1/topics/{topicKey}/subscribers"]["post"]
635
- update:
636
- "x-codeSamples":
637
- - "lang": "typescript"
638
- "label": "TopicsController_addSubscribers"
639
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.topics.subscribers.assign(\"<value>\", {\n subscribers: [\n \"<value>\",\n ],\n });\n\n \n}\n\nrun();"
640
- - target: $["paths"]["/v1/execution-details"]["get"]
641
- update:
642
- "x-codeSamples":
643
- - "lang": "typescript"
644
- "label": "ExecutionDetailsController_getExecutionDetailsForNotification"
645
- "source": |-
646
- import { Novu } from "@novu/api";
647
-
648
- const novu = new Novu({
649
- apiKey: "<YOUR_API_KEY_HERE>",
650
- });
651
-
652
- async function run() {
653
- const result = await novu.executionDetails.retrieve("<value>", "<value>");
654
-
655
- // Handle the result
656
- console.log(result)
657
- }
658
-
659
- run();
660
- - target: $["paths"]["/v1/integrations/active"]["get"]
661
- update:
662
- "x-codeSamples":
663
- - "lang": "typescript"
664
- "label": "IntegrationsController_getActiveIntegrations"
665
- "source": |-
666
- import { Novu } from "@novu/api";
667
-
668
- const novu = new Novu({
669
- apiKey: "<YOUR_API_KEY_HERE>",
670
- });
671
-
672
- async function run() {
673
- const result = await novu.integrations.listActive();
674
-
675
- // Handle the result
676
- console.log(result)
677
- }
678
-
679
- run();
680
- - target: $["paths"]["/v1/subscribers"]["get"]
681
- update:
682
- "x-codeSamples":
683
- - "lang": "typescript"
684
- "label": "SubscribersController_listSubscribers"
685
- "source": |-
686
- import { Novu } from "@novu/api";
687
-
688
- const novu = new Novu({
689
- apiKey: "<YOUR_API_KEY_HERE>",
690
- });
691
-
692
- async function run() {
693
- const result = await novu.subscribers.list(7685.78, 10);
694
-
695
- for await (const page of result) {
696
- // handle page
697
- }
698
- }
699
-
700
- run();
701
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials"]["patch"]
702
- update:
703
- "x-codeSamples":
704
- - "lang": "typescript"
705
- "label": "SubscribersController_modifySubscriberChannel"
706
- "source": |-
707
- import { Novu } from "@novu/api";
708
- import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";
709
-
710
- const novu = new Novu({
711
- apiKey: "<YOUR_API_KEY_HERE>",
712
- });
713
-
714
- async function run() {
715
- const result = await novu.subscribers.credentials.append("<value>", {
716
- providerId: UpdateSubscriberChannelRequestDtoProviderId.Zulip,
717
- credentials: {
718
- webhookUrl: "<value>",
719
- },
720
- });
721
-
722
- // Handle the result
723
- console.log(result)
724
- }
725
-
726
- run();
727
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth"]["get"]
728
- update:
729
- "x-codeSamples":
730
- - "lang": "typescript"
731
- "label": "SubscribersController_chatAccessOauth"
732
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.subscribers.authentication.chatAccessOauth({\n subscriberId: \"<value>\",\n providerId: \"<value>\",\n hmacHash: \"<value>\",\n environmentId: \"<value>\",\n });\n\n \n}\n\nrun();"
733
- - target: $["paths"]["/v1/environments/api-keys/regenerate"]["post"]
734
- update:
735
- "x-codeSamples":
736
- - "lang": "typescript"
737
- "label": "EnvironmentsController_regenerateOrganizationApiKeys"
738
- "source": |-
739
- import { Novu } from "@novu/api";
740
-
741
- const novu = new Novu({
742
- apiKey: "<YOUR_API_KEY_HERE>",
743
- });
744
-
745
- async function run() {
746
- const result = await novu.environments.apiKeys.regenerate();
747
-
748
- // Handle the result
749
- console.log(result)
750
- }
751
-
752
- run();
753
- - target: $["paths"]["/v1/subscribers/{subscriberId}"]["delete"]
754
- update:
755
- "x-codeSamples":
756
- - "lang": "typescript"
757
- "label": "SubscribersController_removeSubscriber"
758
- "source": |-
759
- import { Novu } from "@novu/api";
760
-
761
- const novu = new Novu({
762
- apiKey: "<YOUR_API_KEY_HERE>",
763
- });
764
-
765
- async function run() {
766
- const result = await novu.subscribers.delete("<value>");
767
-
768
- // Handle the result
769
- console.log(result)
770
- }
771
-
772
- run();
773
- - target: $["paths"]["/v1/subscribers/{subscriberId}/notifications/feed"]["get"]
774
- update:
775
- "x-codeSamples":
776
- - "lang": "typescript"
777
- "label": "SubscribersController_getNotificationsFeed"
778
- "source": |-
779
- import { Novu } from "@novu/api";
780
-
781
- const novu = new Novu({
782
- apiKey: "<YOUR_API_KEY_HERE>",
783
- });
784
-
785
- async function run() {
786
- const result = await novu.subscribers.notifications.retrieve({
787
- subscriberId: "<value>",
788
- payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
789
- });
790
-
791
- // Handle the result
792
- console.log(result)
793
- }
794
-
795
- run();
796
- - target: $["paths"]["/v1/topics/{topicKey}/subscribers/removal"]["post"]
797
- update:
798
- "x-codeSamples":
799
- - "lang": "typescript"
800
- "label": "TopicsController_removeSubscribers"
801
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.topics.subscribers.delete(\"<value>\", {\n subscribers: [\n \"<value>\",\n ],\n });\n\n \n}\n\nrun();"
802
- - target: $["paths"]["/v1/tenants"]["get"]
803
- update:
804
- "x-codeSamples":
805
- - "lang": "typescript"
806
- "label": "TenantController_listTenants"
807
- "source": |-
808
- import { Novu } from "@novu/api";
809
-
810
- const novu = new Novu({
811
- apiKey: "<YOUR_API_KEY_HERE>",
812
- });
813
-
814
- async function run() {
815
- const result = await novu.tenants.list(7685.78, 10);
816
-
817
- for await (const page of result) {
818
- // handle page
819
- }
820
- }
821
-
822
- run();
823
- - target: $["paths"]["/v1/changes/count"]["get"]
824
- update:
825
- "x-codeSamples":
826
- - "lang": "typescript"
827
- "label": "ChangesController_getChangesCount"
828
- "source": |-
829
- import { Novu } from "@novu/api";
830
-
831
- const novu = new Novu({
832
- apiKey: "<YOUR_API_KEY_HERE>",
833
- });
834
-
835
- async function run() {
836
- const result = await novu.changes.count();
837
-
838
- // Handle the result
839
- console.log(result)
840
- }
841
-
842
- run();
843
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences"]["get"]
844
- update:
845
- "x-codeSamples":
846
- - "lang": "typescript"
847
- "label": "SubscribersController_listSubscriberPreferences"
848
- "source": |-
849
- import { Novu } from "@novu/api";
850
-
851
- const novu = new Novu({
852
- apiKey: "<YOUR_API_KEY_HERE>",
853
- });
854
-
855
- async function run() {
856
- const result = await novu.subscribers.preferences.list("<value>");
857
-
858
- // Handle the result
859
- console.log(result)
860
- }
861
-
862
- run();
863
- - target: $["paths"]["/v1/topics/{topicKey}/subscribers/{externalSubscriberId}"]["get"]
864
- update:
865
- "x-codeSamples":
866
- - "lang": "typescript"
867
- "label": "TopicsController_getTopicSubscriber"
868
- "source": |-
869
- import { Novu } from "@novu/api";
870
-
871
- const novu = new Novu({
872
- apiKey: "<YOUR_API_KEY_HERE>",
873
- });
874
-
875
- async function run() {
876
- const result = await novu.topics.subscribers.retrieve("<value>", "<value>");
877
-
878
- // Handle the result
879
- console.log(result)
880
- }
881
-
882
- run();
883
- - target: $["paths"]["/v1/tenants/{identifier}"]["delete"]
884
- update:
885
- "x-codeSamples":
886
- - "lang": "typescript"
887
- "label": "TenantController_removeTenant"
888
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.tenants.delete(\"<value>\");\n\n \n}\n\nrun();"
889
- - target: $["paths"]["/v1/notification-groups"]["get"]
890
- update:
891
- "x-codeSamples":
892
- - "lang": "typescript"
893
- "label": "NotificationGroupsController_listNotificationGroups"
894
- "source": |-
895
- import { Novu } from "@novu/api";
896
-
897
- const novu = new Novu({
898
- apiKey: "<YOUR_API_KEY_HERE>",
899
- });
900
-
901
- async function run() {
902
- const result = await novu.workflowGroups.list();
903
-
904
- // Handle the result
905
- console.log(result)
906
- }
907
-
908
- run();
909
- - target: $["paths"]["/v1/integrations/{integrationId}/set-primary"]["post"]
910
- update:
911
- "x-codeSamples":
912
- - "lang": "typescript"
913
- "label": "IntegrationsController_setIntegrationAsPrimary"
914
- "source": |-
915
- import { Novu } from "@novu/api";
916
-
917
- const novu = new Novu({
918
- apiKey: "<YOUR_API_KEY_HERE>",
919
- });
920
-
921
- async function run() {
922
- const result = await novu.integrations.setAsPrimary("<value>");
923
-
924
- // Handle the result
925
- console.log(result)
926
- }
927
-
928
- run();
929
- - target: $["paths"]["/v1/feeds/{feedId}"]["delete"]
930
- update:
931
- "x-codeSamples":
932
- - "lang": "typescript"
933
- "label": "FeedsController_deleteFeedById"
934
- "source": |-
935
- import { Novu } from "@novu/api";
936
-
937
- const novu = new Novu({
938
- apiKey: "<YOUR_API_KEY_HERE>",
939
- });
940
-
941
- async function run() {
942
- const result = await novu.feeds.delete("<value>");
943
-
944
- // Handle the result
945
- console.log(result)
946
- }
947
-
948
- run();
949
- - target: $["paths"]["/v1/layouts/{layoutId}"]["delete"]
950
- update:
951
- "x-codeSamples":
952
- - "lang": "typescript"
953
- "label": "LayoutsController_deleteLayout"
954
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.layouts.delete(\"<value>\");\n\n \n}\n\nrun();"
955
- - target: $["paths"]["/v1/organizations/members/{memberId}"]["delete"]
956
- update:
957
- "x-codeSamples":
958
- - "lang": "typescript"
959
- "label": "OrganizationController_remove"
960
- "source": |-
961
- import { Novu } from "@novu/api";
962
-
963
- const novu = new Novu({
964
- apiKey: "<YOUR_API_KEY_HERE>",
965
- });
966
-
967
- async function run() {
968
- const result = await novu.organizations.members.delete("<value>");
969
-
970
- // Handle the result
971
- console.log(result)
972
- }
973
-
974
- run();
975
- - target: $["paths"]["/v1/workflows"]["get"]
976
- update:
977
- "x-codeSamples":
978
- - "lang": "typescript"
979
- "label": "WorkflowController_listWorkflows"
980
- "source": |-
981
- import { Novu } from "@novu/api";
982
-
983
- const novu = new Novu({
984
- apiKey: "<YOUR_API_KEY_HERE>",
985
- });
986
-
987
- async function run() {
988
- const result = await novu.workflows.list({});
989
-
990
- // Handle the result
991
- console.log(result)
992
- }
993
-
994
- run();
995
- - target: $["paths"]["/v1/notification-groups/{id}"]["get"]
996
- update:
997
- "x-codeSamples":
998
- - "lang": "typescript"
999
- "label": "NotificationGroupsController_getNotificationGroup"
1000
- "source": |-
1001
- import { Novu } from "@novu/api";
1002
-
1003
- const novu = new Novu({
1004
- apiKey: "<YOUR_API_KEY_HERE>",
1005
- });
1006
-
1007
- async function run() {
1008
- const result = await novu.workflowGroups.retrieve("<value>");
1009
-
1010
- // Handle the result
1011
- console.log(result)
1012
- }
1013
-
1014
- run();
1015
- - target: $["paths"]["/v1/changes"]["get"]
1016
- update:
1017
- "x-codeSamples":
1018
- - "lang": "typescript"
1019
- "label": "ChangesController_getChanges"
1020
- "source": |-
1021
- import { Novu } from "@novu/api";
1022
-
1023
- const novu = new Novu({
1024
- apiKey: "<YOUR_API_KEY_HERE>",
1025
- });
1026
-
1027
- async function run() {
1028
- const result = await novu.changes.retrieve({
1029
- promoted: "false",
1030
- });
1031
-
1032
- // Handle the result
1033
- console.log(result)
1034
- }
1035
-
1036
- run();
1037
- - target: $["paths"]["/v1/layouts"]["post"]
1038
- update:
1039
- "x-codeSamples":
1040
- - "lang": "typescript"
1041
- "label": "LayoutsController_PropertyDescriptor"
1042
- "source": |-
1043
- import { Novu } from "@novu/api";
1044
-
1045
- const novu = new Novu({
1046
- apiKey: "<YOUR_API_KEY_HERE>",
1047
- });
1048
-
1049
- async function run() {
1050
- const result = await novu.layouts.create();
1051
-
1052
- // Handle the result
1053
- console.log(result)
1054
- }
1055
-
1056
- run();
1057
- - target: $["paths"]["/v1/topics"]["post"]
1058
- update:
1059
- "x-codeSamples":
1060
- - "lang": "typescript"
1061
- "label": "TopicsController_createTopic"
1062
- "source": |-
1063
- import { Novu } from "@novu/api";
1064
-
1065
- const novu = new Novu({
1066
- apiKey: "<YOUR_API_KEY_HERE>",
1067
- });
1068
-
1069
- async function run() {
1070
- const result = await novu.topics.create({
1071
- key: "<key>",
1072
- name: "<value>",
1073
- });
1074
-
1075
- // Handle the result
1076
- console.log(result)
1077
- }
1078
-
1079
- run();
1080
- - target: $["paths"]["/v1/environments/me"]["get"]
1081
- update:
1082
- "x-codeSamples":
1083
- - "lang": "typescript"
1084
- "label": "EnvironmentsController_getCurrentEnvironment"
1085
- "source": |-
1086
- import { Novu } from "@novu/api";
1087
-
1088
- const novu = new Novu({
1089
- apiKey: "<YOUR_API_KEY_HERE>",
1090
- });
1091
-
1092
- async function run() {
1093
- const result = await novu.environments.retrieve();
1094
-
1095
- // Handle the result
1096
- console.log(result)
1097
- }
1098
-
1099
- run();
1100
- - target: $["paths"]["/v1/subscribers"]["post"]
1101
- update:
1102
- "x-codeSamples":
1103
- - "lang": "typescript"
1104
- "label": "SubscribersController_createSubscriber"
1105
- "source": |-
1106
- import { Novu } from "@novu/api";
1107
-
1108
- const novu = new Novu({
1109
- apiKey: "<YOUR_API_KEY_HERE>",
1110
- });
1111
-
1112
- async function run() {
1113
- const result = await novu.subscribers.create({
1114
- subscriberId: "<value>",
1115
- });
1116
-
1117
- // Handle the result
1118
- console.log(result)
1119
- }
1120
-
1121
- run();
1122
- - target: $["paths"]["/v1/organizations/members"]["get"]
1123
- update:
1124
- "x-codeSamples":
1125
- - "lang": "typescript"
1126
- "label": "OrganizationController_listOrganizationMembers"
1127
- "source": |-
1128
- import { Novu } from "@novu/api";
1129
-
1130
- const novu = new Novu({
1131
- apiKey: "<YOUR_API_KEY_HERE>",
1132
- });
1133
-
1134
- async function run() {
1135
- const result = await novu.organizations.members.list();
1136
-
1137
- // Handle the result
1138
- console.log(result)
1139
- }
1140
-
1141
- run();
1142
- - target: $["paths"]["/v1/changes/bulk/apply"]["post"]
1143
- update:
1144
- "x-codeSamples":
1145
- - "lang": "typescript"
1146
- "label": "ChangesController_bulkApplyDiff"
1147
- "source": |-
1148
- import { Novu } from "@novu/api";
1149
-
1150
- const novu = new Novu({
1151
- apiKey: "<YOUR_API_KEY_HERE>",
1152
- });
1153
-
1154
- async function run() {
1155
- const result = await novu.changes.applyBulk({
1156
- changeIds: [
1157
- "<value>",
1158
- ],
1159
- });
1160
-
1161
- // Handle the result
1162
- console.log(result)
1163
- }
1164
-
1165
- run();
1166
- - target: $["paths"]["/v1/subscribers/{subscriberId}"]["put"]
1167
- update:
1168
- "x-codeSamples":
1169
- - "lang": "typescript"
1170
- "label": "SubscribersController_updateSubscriber"
1171
- "source": |-
1172
- import { Novu } from "@novu/api";
1173
-
1174
- const novu = new Novu({
1175
- apiKey: "<YOUR_API_KEY_HERE>",
1176
- });
1177
-
1178
- async function run() {
1179
- const result = await novu.subscribers.update("<value>", {});
1180
-
1181
- // Handle the result
1182
- console.log(result)
1183
- }
1184
-
1185
- run();
1186
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences/{parameter}"]["patch"]
1187
- update:
1188
- "x-codeSamples":
1189
- - "lang": "typescript"
1190
- "label": "SubscribersController_updateSubscriberPreference"
1191
- "source": |-
1192
- import { Novu } from "@novu/api";
1193
-
1194
- const novu = new Novu({
1195
- apiKey: "<YOUR_API_KEY_HERE>",
1196
- });
1197
-
1198
- async function run() {
1199
- const result = await novu.subscribers.preferences.update({
1200
- subscriberId: "<value>",
1201
- parameter: "<value>",
1202
- updateSubscriberPreferenceRequestDto: {},
1203
- });
1204
-
1205
- // Handle the result
1206
- console.log(result)
1207
- }
1208
-
1209
- run();
1210
- - target: $["paths"]["/v1/subscribers/{subscriberId}/messages/mark-as"]["post"]
1211
- update:
1212
- "x-codeSamples":
1213
- - "lang": "typescript"
1214
- "label": "SubscribersController_markMessagesAs"
1215
- "source": |-
1216
- import { Novu } from "@novu/api";
1217
- import { MarkAs } from "@novu/api/models/components";
1218
-
1219
- const novu = new Novu({
1220
- apiKey: "<YOUR_API_KEY_HERE>",
1221
- });
1222
-
1223
- async function run() {
1224
- const result = await novu.subscribers.messages.markAllAs("<value>", {
1225
- messageId: "<value>",
1226
- markAs: MarkAs.Seen,
1227
- });
1228
-
1229
- // Handle the result
1230
- console.log(result)
1231
- }
1232
-
1233
- run();
1234
- - target: $["paths"]["/v1/layouts/{layoutId}/default"]["post"]
1235
- update:
1236
- "x-codeSamples":
1237
- - "lang": "typescript"
1238
- "label": "LayoutsController_setDefaultLayout"
1239
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.layouts.setAsDefault(\"<value>\");\n\n \n}\n\nrun();"
1240
- - target: $["paths"]["/v1/messages/{messageId}"]["delete"]
1241
- update:
1242
- "x-codeSamples":
1243
- - "lang": "typescript"
1244
- "label": "MessagesController_deleteMessage"
1245
- "source": |-
1246
- import { Novu } from "@novu/api";
1247
-
1248
- const novu = new Novu({
1249
- apiKey: "<YOUR_API_KEY_HERE>",
1250
- });
1251
-
1252
- async function run() {
1253
- const result = await novu.messages.delete("<value>");
1254
-
1255
- // Handle the result
1256
- console.log(result)
1257
- }
1258
-
1259
- run();
1260
- - target: $["paths"]["/v1/organizations/branding"]["put"]
1261
- update:
1262
- "x-codeSamples":
1263
- - "lang": "typescript"
1264
- "label": "OrganizationController_updateBrandingDetails"
1265
- "source": |-
1266
- import { Novu } from "@novu/api";
1267
-
1268
- const novu = new Novu({
1269
- apiKey: "<YOUR_API_KEY_HERE>",
1270
- });
1271
-
1272
- async function run() {
1273
- const result = await novu.organizations.branding.update({
1274
- logo: "<value>",
1275
- color: "fuchsia",
1276
- fontColor: "<value>",
1277
- contentBackground: "<value>",
1278
- });
1279
-
1280
- // Handle the result
1281
- console.log(result)
1282
- }
1283
-
1284
- run();
1285
- - target: $["paths"]["/v1/workflows"]["post"]
1286
- update:
1287
- "x-codeSamples":
1288
- - "lang": "typescript"
1289
- "label": "WorkflowController_create"
1290
- "source": |-
1291
- import { Novu } from "@novu/api";
1292
-
1293
- const novu = new Novu({
1294
- apiKey: "<YOUR_API_KEY_HERE>",
1295
- });
1296
-
1297
- async function run() {
1298
- const result = await novu.workflows.create({
1299
- name: "<value>",
1300
- notificationGroupId: "<value>",
1301
- steps: [
1302
- {},
1303
- ],
1304
- });
1305
-
1306
- // Handle the result
1307
- console.log(result)
1308
- }
1309
-
1310
- run();
1311
- - target: $["paths"]["/v1/events/trigger/bulk"]["post"]
1312
- update:
1313
- "x-codeSamples":
1314
- - "lang": "typescript"
1315
- "label": "EventsController_triggerBulk"
1316
- "source": |-
1317
- import { Novu } from "@novu/api";
1318
- import { TopicPayloadDtoType } from "@novu/api/models/components";
1319
-
1320
- const novu = new Novu({
1321
- apiKey: "<YOUR_API_KEY_HERE>",
1322
- });
1323
-
1324
- async function run() {
1325
- const result = await novu.events.triggerBulk({
1326
- events: [
1327
- {
1328
- name: "workflow_identifier",
1329
- payload: {},
1330
- overrides: {},
1331
- to: [
1332
- {
1333
- topicKey: "topic_key",
1334
- type: TopicPayloadDtoType.Topic,
1335
- },
1336
- ],
1337
- },
1338
- ],
1339
- });
1340
-
1341
- // Handle the result
1342
- console.log(result)
1343
- }
1344
-
1345
- run();
1346
- - target: $["paths"]["/v1/integrations/{integrationId}"]["delete"]
1347
- update:
1348
- "x-codeSamples":
1349
- - "lang": "typescript"
1350
- "label": "IntegrationsController_removeIntegration"
1351
- "source": |-
1352
- import { Novu } from "@novu/api";
1353
-
1354
- const novu = new Novu({
1355
- apiKey: "<YOUR_API_KEY_HERE>",
1356
- });
1357
-
1358
- async function run() {
1359
- const result = await novu.integrations.delete("<value>");
1360
-
1361
- // Handle the result
1362
- console.log(result)
1363
- }
1364
-
1365
- run();
1366
- - target: $["paths"]["/v1/changes/{changeId}/apply"]["post"]
1367
- update:
1368
- "x-codeSamples":
1369
- - "lang": "typescript"
1370
- "label": "ChangesController_applyDiff"
1371
- "source": |-
1372
- import { Novu } from "@novu/api";
1373
-
1374
- const novu = new Novu({
1375
- apiKey: "<YOUR_API_KEY_HERE>",
1376
- });
1377
-
1378
- async function run() {
1379
- const result = await novu.changes.apply("<value>");
1380
-
1381
- // Handle the result
1382
- console.log(result)
1383
- }
1384
-
1385
- run();
1386
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback"]["get"]
1387
- update:
1388
- "x-codeSamples":
1389
- - "lang": "typescript"
1390
- "label": "SubscribersController_chatOauthCallback"
1391
- "source": |-
1392
- import { Novu } from "@novu/api";
1393
-
1394
- const novu = new Novu({
1395
- apiKey: "<YOUR_API_KEY_HERE>",
1396
- });
1397
-
1398
- async function run() {
1399
- const result = await novu.subscribers.authentication.chatAccessOauthCallBack({
1400
- subscriberId: "<value>",
1401
- providerId: "<value>",
1402
- code: "<value>",
1403
- hmacHash: "<value>",
1404
- environmentId: "<value>",
1405
- });
1406
-
1407
- // Handle the result
1408
- console.log(result)
1409
- }
1410
-
1411
- run();
1412
- - target: $["paths"]["/v1/notifications/stats"]["get"]
1413
- update:
1414
- "x-codeSamples":
1415
- - "lang": "typescript"
1416
- "label": "NotificationsController_getActivityStats"
1417
- "source": |-
1418
- import { Novu } from "@novu/api";
1419
-
1420
- const novu = new Novu({
1421
- apiKey: "<YOUR_API_KEY_HERE>",
1422
- });
1423
-
1424
- async function run() {
1425
- const result = await novu.notifications.stats.retrieve();
1426
-
1427
- // Handle the result
1428
- console.log(result)
1429
- }
1430
-
1431
- run();
1432
- - target: $["paths"]["/v1/subscribers/{subscriberId}/online-status"]["patch"]
1433
- update:
1434
- "x-codeSamples":
1435
- - "lang": "typescript"
1436
- "label": "SubscribersController_updateSubscriberOnlineFlag"
1437
- "source": |-
1438
- import { Novu } from "@novu/api";
1439
-
1440
- const novu = new Novu({
1441
- apiKey: "<YOUR_API_KEY_HERE>",
1442
- });
1443
-
1444
- async function run() {
1445
- const result = await novu.subscribers.properties.updateOnlineFlag("<value>", {
1446
- isOnline: false,
1447
- });
1448
-
1449
- // Handle the result
1450
- console.log(result)
1451
- }
1452
-
1453
- run();
1454
- - target: $["paths"]["/v1/layouts/{layoutId}"]["get"]
1455
- update:
1456
- "x-codeSamples":
1457
- - "lang": "typescript"
1458
- "label": "LayoutsController_getLayout"
1459
- "source": |-
1460
- import { Novu } from "@novu/api";
1461
-
1462
- const novu = new Novu({
1463
- apiKey: "<YOUR_API_KEY_HERE>",
1464
- });
1465
-
1466
- async function run() {
1467
- const result = await novu.layouts.retrieve("<value>");
1468
-
1469
- // Handle the result
1470
- console.log(result)
1471
- }
1472
-
1473
- run();
1474
- - target: $["paths"]["/v1/topics"]["get"]
1475
- update:
1476
- "x-codeSamples":
1477
- - "lang": "typescript"
1478
- "label": "TopicsController_listTopics"
1479
- "source": |-
1480
- import { Novu } from "@novu/api";
1481
-
1482
- const novu = new Novu({
1483
- apiKey: "<YOUR_API_KEY_HERE>",
1484
- });
1485
-
1486
- async function run() {
1487
- const result = await novu.topics.list({});
1488
-
1489
- // Handle the result
1490
- console.log(result)
1491
- }
1492
-
1493
- run();
1494
- - target: $["paths"]["/v1/tenants/{identifier}"]["get"]
1495
- update:
1496
- "x-codeSamples":
1497
- - "lang": "typescript"
1498
- "label": "TenantController_getTenantById"
1499
- "source": |-
1500
- import { Novu } from "@novu/api";
1501
-
1502
- const novu = new Novu({
1503
- apiKey: "<YOUR_API_KEY_HERE>",
1504
- });
1505
-
1506
- async function run() {
1507
- const result = await novu.tenants.retrieve("<value>");
1508
-
1509
- // Handle the result
1510
- console.log(result)
1511
- }
1512
-
1513
- run();
1514
- - target: $["paths"]["/v1/workflows/{workflowId}"]["put"]
1515
- update:
1516
- "x-codeSamples":
1517
- - "lang": "typescript"
1518
- "label": "WorkflowController_updateWorkflowById"
1519
- "source": |-
1520
- import { Novu } from "@novu/api";
1521
-
1522
- const novu = new Novu({
1523
- apiKey: "<YOUR_API_KEY_HERE>",
1524
- });
1525
-
1526
- async function run() {
1527
- const result = await novu.workflows.update("<value>", {
1528
- name: "<value>",
1529
- notificationGroupId: "<value>",
1530
- });
1531
-
1532
- // Handle the result
1533
- console.log(result)
1534
- }
1535
-
1536
- run();
1537
- - target: $["paths"]["/v1/workflows/{workflowId}"]["delete"]
1538
- update:
1539
- "x-codeSamples":
1540
- - "lang": "typescript"
1541
- "label": "WorkflowController_deleteWorkflowById"
1542
- "source": |-
1543
- import { Novu } from "@novu/api";
1544
-
1545
- const novu = new Novu({
1546
- apiKey: "<YOUR_API_KEY_HERE>",
1547
- });
1548
-
1549
- async function run() {
1550
- const result = await novu.workflows.delete("<value>");
1551
-
1552
- // Handle the result
1553
- console.log(result)
1554
- }
1555
-
1556
- run();
1557
- - target: $["paths"]["/v1/integrations"]["get"]
1558
- update:
1559
- "x-codeSamples":
1560
- - "lang": "typescript"
1561
- "label": "IntegrationsController_listIntegrations"
1562
- "source": |-
1563
- import { Novu } from "@novu/api";
1564
-
1565
- const novu = new Novu({
1566
- apiKey: "<YOUR_API_KEY_HERE>",
1567
- });
1568
-
1569
- async function run() {
1570
- const result = await novu.integrations.list();
1571
-
1572
- // Handle the result
1573
- console.log(result)
1574
- }
1575
-
1576
- run();
1577
- - target: $["paths"]["/v1/integrations/{integrationId}"]["put"]
1578
- update:
1579
- "x-codeSamples":
1580
- - "lang": "typescript"
1581
- "label": "IntegrationsController_updateIntegrationById"
1582
- "source": |-
1583
- import { Novu } from "@novu/api";
1584
-
1585
- const novu = new Novu({
1586
- apiKey: "<YOUR_API_KEY_HERE>",
1587
- });
1588
-
1589
- async function run() {
1590
- const result = await novu.integrations.update("<value>", {});
1591
-
1592
- // Handle the result
1593
- console.log(result)
1594
- }
1595
-
1596
- run();
1597
- - target: $["paths"]["/v1/subscribers/{subscriberId}"]["get"]
1598
- update:
1599
- "x-codeSamples":
1600
- - "lang": "typescript"
1601
- "label": "SubscribersController_getSubscriber"
1602
- "source": |-
1603
- import { Novu } from "@novu/api";
1604
-
1605
- const novu = new Novu({
1606
- apiKey: "<YOUR_API_KEY_HERE>",
1607
- });
1608
-
1609
- async function run() {
1610
- const result = await novu.subscribers.retrieve("<value>");
1611
-
1612
- // Handle the result
1613
- console.log(result)
1614
- }
1615
-
1616
- run();
1617
- - target: $["paths"]["/v1/subscribers/bulk"]["post"]
1618
- update:
1619
- "x-codeSamples":
1620
- - "lang": "typescript"
1621
- "label": "SubscribersController_bulkCreateSubscribers"
1622
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.subscribers.createBulk({\n subscribers: [\n {\n subscriberId: \"<value>\",\n },\n ],\n });\n\n \n}\n\nrun();"
1623
- - target: $["paths"]["/v1/feeds"]["get"]
1624
- update:
1625
- "x-codeSamples":
1626
- - "lang": "typescript"
1627
- "label": "FeedsController_getFeeds"
1628
- "source": |-
1629
- import { Novu } from "@novu/api";
1630
-
1631
- const novu = new Novu({
1632
- apiKey: "<YOUR_API_KEY_HERE>",
1633
- });
1634
-
1635
- async function run() {
1636
- const result = await novu.feeds.retrieve();
1637
-
1638
- // Handle the result
1639
- console.log(result)
1640
- }
1641
-
1642
- run();
1643
- =======
1644
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.trigger({\n name: \"workflow_identifier\",\n payload: {},\n overrides: {},\n to: [\n {\n topicKey: \"<value>\",\n type: \"Topic\",\n },\n {\n topicKey: \"<value>\",\n type: \"Topic\",\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1645
- >>>>>>> Stashed changes
1646
- - target: $["paths"]["/v1/events/trigger/broadcast"]["post"]
1647
- update:
1648
- "x-codeSamples":
1649
- - "lang": "typescript"
1650
- "label": "EventsController_broadcastEventToAll"
1651
- <<<<<<< Updated upstream
1652
- "source": |-
1653
- import { Novu } from "@novu/api";
1654
-
1655
- const novu = new Novu({
1656
- apiKey: "<YOUR_API_KEY_HERE>",
1657
- });
1658
-
1659
- async function run() {
1660
- const result = await novu.events.triggerBroadcast({
1661
- name: "<value>",
1662
- payload: {},
1663
- overrides: {},
1664
- });
1665
-
1666
- // Handle the result
1667
- console.log(result)
1668
- }
1669
-
1670
- run();
1671
- - target: $["paths"]["/v1/notifications"]["get"]
1672
- update:
1673
- "x-codeSamples":
1674
- - "lang": "typescript"
1675
- "label": "NotificationsController_listNotifications"
1676
- "source": |-
1677
- import { Novu } from "@novu/api";
1678
- import { Channels } from "@novu/api/models/operations";
1679
-
1680
- const novu = new Novu({
1681
- apiKey: "<YOUR_API_KEY_HERE>",
1682
- });
1683
-
1684
- async function run() {
1685
- const result = await novu.notifications.list({
1686
- channels: [
1687
- Channels.Chat,
1688
- ],
1689
- templates: [
1690
- "<value>",
1691
- ],
1692
- emails: [
1693
- "<value>",
1694
- ],
1695
- search: "<value>",
1696
- subscriberIds: [
1697
- "<value>",
1698
- ],
1699
- });
1700
-
1701
- // Handle the result
1702
- console.log(result)
1703
- }
1704
-
1705
- run();
1706
- - target: $["paths"]["/v1/integrations/webhook/provider/{providerOrIntegrationId}/status"]["get"]
1707
- update:
1708
- "x-codeSamples":
1709
- - "lang": "typescript"
1710
- "label": "IntegrationsController_getWebhookSupportStatus"
1711
- "source": |-
1712
- import { Novu } from "@novu/api";
1713
-
1714
- const novu = new Novu({
1715
- apiKey: "<YOUR_API_KEY_HERE>",
1716
- });
1717
-
1718
- async function run() {
1719
- const result = await novu.integrations.webhooks.retrieve("<value>");
1720
-
1721
- // Handle the result
1722
- console.log(result)
1723
- }
1724
-
1725
- run();
1726
- - target: $["paths"]["/v1/subscribers/{subscriberId}/notifications/unseen"]["get"]
1727
- update:
1728
- "x-codeSamples":
1729
- - "lang": "typescript"
1730
- "label": "SubscribersController_getUnseenCount"
1731
- "source": |-
1732
- import { Novu } from "@novu/api";
1733
-
1734
- const novu = new Novu({
1735
- apiKey: "<YOUR_API_KEY_HERE>",
1736
- });
1737
-
1738
- async function run() {
1739
- const result = await novu.subscribers.notifications.unseenCount({
1740
- seen: false,
1741
- subscriberId: "<value>",
1742
- limit: 2166.35,
1743
- });
1744
-
1745
- // Handle the result
1746
- console.log(result)
1747
- }
1748
-
1749
- run();
1750
- - target: $["paths"]["/v1/subscribers/{subscriberId}/messages/mark-all"]["post"]
1751
- update:
1752
- "x-codeSamples":
1753
- - "lang": "typescript"
1754
- "label": "SubscribersController_markAllUnreadAsRead"
1755
- "source": |-
1756
- import { Novu } from "@novu/api";
1757
- import { MarkAllMessageAsRequestDtoMarkAs } from "@novu/api/models/components";
1758
-
1759
- const novu = new Novu({
1760
- apiKey: "<YOUR_API_KEY_HERE>",
1761
- });
1762
-
1763
- async function run() {
1764
- const result = await novu.subscribers.messages.markAll("<value>", {
1765
- markAs: MarkAllMessageAsRequestDtoMarkAs.Seen,
1766
- });
1767
-
1768
- // Handle the result
1769
- console.log(result)
1770
- }
1771
-
1772
- run();
1773
- =======
1774
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.triggerBroadcast({\n name: \"<value>\",\n payload: {},\n overrides: {},\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1775
- - target: $["paths"]["/v1/events/trigger/bulk"]["post"]
1776
- update:
1777
- "x-codeSamples":
1778
- - "lang": "typescript"
1779
- "label": "EventsController_triggerBulk"
1780
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.triggerBulk({\n events: [\n {\n name: \"workflow_identifier\",\n payload: {},\n overrides: {},\n to: [\n {\n topicKey: \"<value>\",\n type: \"Topic\",\n },\n {\n subscriberId: \"<id>\",\n },\n ],\n },\n {\n name: \"workflow_identifier\",\n payload: {},\n overrides: {},\n to: [\n {\n topicKey: \"<value>\",\n type: \"Topic\",\n },\n ],\n },\n {\n name: \"workflow_identifier\",\n payload: {},\n overrides: {},\n to: [\n {\n topicKey: \"<value>\",\n type: \"Topic\",\n },\n {\n topicKey: \"<value>\",\n type: \"Topic\",\n },\n ],\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1781
- - target: $["paths"]["/v1/events/trigger/{transactionId}"]["delete"]
1782
- update:
1783
- "x-codeSamples":
1784
- - "lang": "typescript"
1785
- "label": "EventsController_cancel"
1786
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.cancel(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1787
- - target: $["paths"]["/v1/execution-details"]["get"]
1788
- update:
1789
- "x-codeSamples":
1790
- - "lang": "typescript"
1791
- "label": "ExecutionDetailsController_getExecutionDetailsForNotification"
1792
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.executionDetails.retrieve(\"<id>\", \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1793
- - target: $["paths"]["/v1/integrations"]["get"]
1794
- update:
1795
- "x-codeSamples":
1796
- - "lang": "typescript"
1797
- "label": "IntegrationsController_listIntegrations"
1798
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1799
- - target: $["paths"]["/v1/integrations"]["post"]
1800
- update:
1801
- "x-codeSamples":
1802
- - "lang": "typescript"
1803
- "label": "IntegrationsController_createIntegration"
1804
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.create({\n providerId: \"<id>\",\n channel: \"sms\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1805
- - target: $["paths"]["/v1/integrations/active"]["get"]
1806
- update:
1807
- "x-codeSamples":
1808
- - "lang": "typescript"
1809
- "label": "IntegrationsController_getActiveIntegrations"
1810
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.listActive();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1811
- - target: $["paths"]["/v1/integrations/webhook/provider/{providerOrIntegrationId}/status"]["get"]
1812
- update:
1813
- "x-codeSamples":
1814
- - "lang": "typescript"
1815
- "label": "IntegrationsController_getWebhookSupportStatus"
1816
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.webhooks.retrieve(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1817
- - target: $["paths"]["/v1/integrations/{integrationId}"]["delete"]
1818
- update:
1819
- "x-codeSamples":
1820
- - "lang": "typescript"
1821
- "label": "IntegrationsController_removeIntegration"
1822
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.delete(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1823
- - target: $["paths"]["/v1/integrations/{integrationId}"]["put"]
1824
- update:
1825
- "x-codeSamples":
1826
- - "lang": "typescript"
1827
- "label": "IntegrationsController_updateIntegrationById"
1828
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.update({}, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1829
- - target: $["paths"]["/v1/integrations/{integrationId}/set-primary"]["post"]
1830
- update:
1831
- "x-codeSamples":
1832
- - "lang": "typescript"
1833
- "label": "IntegrationsController_setIntegrationAsPrimary"
1834
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.integrations.setAsPrimary(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1835
- - target: $["paths"]["/v1/messages"]["get"]
1836
- update:
1837
- "x-codeSamples":
1838
- - "lang": "typescript"
1839
- "label": "MessagesController_getMessages"
1840
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.messages.retrieve({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1841
- - target: $["paths"]["/v1/messages/transaction/{transactionId}"]["delete"]
1842
- update:
1843
- "x-codeSamples":
1844
- - "lang": "typescript"
1845
- "label": "MessagesController_deleteMessagesByTransactionId"
1846
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.messages.deleteByTransactionId(\"<id>\");\n\n\n}\n\nrun();"
1847
- - target: $["paths"]["/v1/messages/{messageId}"]["delete"]
1848
- update:
1849
- "x-codeSamples":
1850
- - "lang": "typescript"
1851
- "label": "MessagesController_deleteMessage"
1852
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.messages.delete(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1853
- - target: $["paths"]["/v1/notification-groups"]["get"]
1854
- update:
1855
- "x-codeSamples":
1856
- - "lang": "typescript"
1857
- "label": "NotificationGroupsController_listNotificationGroups"
1858
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.workflowGroups.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1859
- - target: $["paths"]["/v1/notification-groups"]["post"]
1860
- update:
1861
- "x-codeSamples":
1862
- - "lang": "typescript"
1863
- "label": "NotificationGroupsController_createNotificationGroup"
1864
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.workflowGroups.create({\n name: \"<value>\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1865
- - target: $["paths"]["/v1/notification-groups/{id}"]["delete"]
1866
- update:
1867
- "x-codeSamples":
1868
- - "lang": "typescript"
1869
- "label": "NotificationGroupsController_deleteNotificationGroup"
1870
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.workflowGroups.delete(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1871
- - target: $["paths"]["/v1/notification-groups/{id}"]["get"]
1872
- update:
1873
- "x-codeSamples":
1874
- - "lang": "typescript"
1875
- "label": "NotificationGroupsController_getNotificationGroup"
1876
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.workflowGroups.retrieve(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1877
- - target: $["paths"]["/v1/notification-groups/{id}"]["patch"]
1878
- update:
1879
- "x-codeSamples":
1880
- - "lang": "typescript"
1881
- "label": "NotificationGroupsController_updateNotificationGroup"
1882
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.workflowGroups.update({\n name: \"<value>\",\n }, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1883
- - target: $["paths"]["/v1/notifications"]["get"]
1884
- update:
1885
- "x-codeSamples":
1886
- - "lang": "typescript"
1887
- "label": "NotificationsController_listNotifications"
1888
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.notifications.list({\n channels: [\n \"sms\",\n \"chat\",\n \"in_app\",\n ],\n templates: [\n \"<value>\",\n ],\n emails: [\n \"<value>\",\n ],\n search: \"<value>\",\n subscriberIds: [\n \"<value>\",\n \"<value>\",\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1889
- - target: $["paths"]["/v1/notifications/graph/stats"]["get"]
1890
- update:
1891
- "x-codeSamples":
1892
- - "lang": "typescript"
1893
- "label": "NotificationsController_getActivityGraphStats"
1894
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.notifications.stats.graph();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1895
- - target: $["paths"]["/v1/notifications/stats"]["get"]
1896
- update:
1897
- "x-codeSamples":
1898
- - "lang": "typescript"
1899
- "label": "NotificationsController_getActivityStats"
1900
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.notifications.stats.retrieve();\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1901
- - target: $["paths"]["/v1/notifications/{notificationId}"]["get"]
1902
- update:
1903
- "x-codeSamples":
1904
- - "lang": "typescript"
1905
- "label": "NotificationsController_getNotification"
1906
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.notifications.retrieve(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1907
- - target: $["paths"]["/v1/subscribers"]["get"]
1908
- update:
1909
- "x-codeSamples":
1910
- - "lang": "typescript"
1911
- "label": "SubscribersController_listSubscribers"
1912
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.list();\n\n for await (const page of result) {\n // Handle the page\n console.log(page);\n }\n}\n\nrun();"
1913
- - target: $["paths"]["/v1/subscribers"]["post"]
1914
- update:
1915
- "x-codeSamples":
1916
- - "lang": "typescript"
1917
- "label": "SubscribersController_createSubscriber"
1918
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.create({\n subscriberId: \"<id>\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1919
- - target: $["paths"]["/v1/subscribers/bulk"]["post"]
1920
- update:
1921
- "x-codeSamples":
1922
- - "lang": "typescript"
1923
- "label": "SubscribersController_bulkCreateSubscribers"
1924
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.subscribers.createBulk({\n subscribers: [\n \"<value>\",\n ],\n });\n\n\n}\n\nrun();"
1925
- - target: $["paths"]["/v1/subscribers/{subscriberId}"]["delete"]
1926
- update:
1927
- "x-codeSamples":
1928
- - "lang": "typescript"
1929
- "label": "SubscribersController_removeSubscriber"
1930
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.delete(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1931
- - target: $["paths"]["/v1/subscribers/{subscriberId}"]["get"]
1932
- update:
1933
- "x-codeSamples":
1934
- - "lang": "typescript"
1935
- "label": "SubscribersController_getSubscriber"
1936
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.retrieve(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1937
- - target: $["paths"]["/v1/subscribers/{subscriberId}"]["put"]
1938
- update:
1939
- "x-codeSamples":
1940
- - "lang": "typescript"
1941
- "label": "SubscribersController_updateSubscriber"
1942
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.update({}, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1943
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials"]["patch"]
1944
- update:
1945
- "x-codeSamples":
1946
- - "lang": "typescript"
1947
- "label": "SubscribersController_modifySubscriberChannel"
1948
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.credentials.append({\n providerId: 3462.44,\n credentials: {\n webhookUrl: \"https://talkative-pop.org\",\n },\n }, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1949
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials"]["put"]
1950
- update:
1951
- "x-codeSamples":
1952
- - "lang": "typescript"
1953
- "label": "SubscribersController_updateSubscriberChannel"
1954
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.credentials.update({\n providerId: 8574.77,\n credentials: {\n webhookUrl: \"https://grown-worth.name\",\n },\n }, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1955
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials/{providerId}"]["delete"]
1956
- update:
1957
- "x-codeSamples":
1958
- - "lang": "typescript"
1959
- "label": "SubscribersController_deleteSubscriberCredentials"
1960
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.subscribers.credentials.delete(\"<id>\", \"<id>\");\n\n\n}\n\nrun();"
1961
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth"]["get"]
1962
- update:
1963
- "x-codeSamples":
1964
- - "lang": "typescript"
1965
- "label": "SubscribersController_chatAccessOauth"
1966
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.subscribers.authentication.chatAccessOauth({\n subscriberId: \"<id>\",\n providerId: \"<id>\",\n hmacHash: \"<value>\",\n environmentId: \"<id>\",\n });\n\n\n}\n\nrun();"
1967
- - target: $["paths"]["/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback"]["get"]
1968
- update:
1969
- "x-codeSamples":
1970
- - "lang": "typescript"
1971
- "label": "SubscribersController_chatOauthCallback"
1972
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.authentication.chatAccessOauthCallBack({\n subscriberId: \"<id>\",\n providerId: \"<id>\",\n code: \"<value>\",\n hmacHash: \"<value>\",\n environmentId: \"<id>\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1973
- - target: $["paths"]["/v1/subscribers/{subscriberId}/messages/mark-all"]["post"]
1974
- update:
1975
- "x-codeSamples":
1976
- - "lang": "typescript"
1977
- "label": "SubscribersController_markAllUnreadAsRead"
1978
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.messages.markAll({\n markAs: \"seen\",\n }, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1979
- - target: $["paths"]["/v1/subscribers/{subscriberId}/messages/mark-as"]["post"]
1980
- update:
1981
- "x-codeSamples":
1982
- - "lang": "typescript"
1983
- "label": "SubscribersController_markMessagesAs"
1984
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.messages.markAllAs({\n messageId: \"<value>\",\n markAs: \"unread\",\n }, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1985
- - target: $["paths"]["/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}"]["post"]
1986
- update:
1987
- "x-codeSamples":
1988
- - "lang": "typescript"
1989
- "label": "SubscribersController_markActionAsSeen"
1990
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.messages.updateAsSeen({\n messageId: \"<id>\",\n type: \"<value>\",\n subscriberId: \"<id>\",\n markMessageActionAsSeenDto: {\n status: \"done\",\n },\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1991
- - target: $["paths"]["/v1/subscribers/{subscriberId}/notifications/feed"]["get"]
1992
- update:
1993
- "x-codeSamples":
1994
- - "lang": "typescript"
1995
- "label": "SubscribersController_getNotificationsFeed"
1996
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.notifications.retrieve({\n subscriberId: \"<id>\",\n payload: \"btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
1997
- - target: $["paths"]["/v1/subscribers/{subscriberId}/notifications/unseen"]["get"]
1998
- update:
1999
- "x-codeSamples":
2000
- - "lang": "typescript"
2001
- "label": "SubscribersController_getUnseenCount"
2002
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.notifications.unseenCount({\n seen: true,\n subscriberId: \"<id>\",\n limit: 4327.98,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2003
- - target: $["paths"]["/v1/subscribers/{subscriberId}/online-status"]["patch"]
2004
- update:
2005
- "x-codeSamples":
2006
- - "lang": "typescript"
2007
- "label": "SubscribersController_updateSubscriberOnlineFlag"
2008
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.properties.updateOnlineFlag({\n isOnline: false,\n }, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2009
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences"]["get"]
2010
- update:
2011
- "x-codeSamples":
2012
- - "lang": "typescript"
2013
- "label": "SubscribersController_listSubscriberPreferences"
2014
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.preferences.list(\"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2015
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences"]["patch"]
2016
- update:
2017
- "x-codeSamples":
2018
- - "lang": "typescript"
2019
- "label": "SubscribersController_updateSubscriberGlobalPreferences"
2020
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.preferences.updateGlobal({}, \"<id>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2021
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences/{parameter}"]["get"]
2022
- update:
2023
- "x-codeSamples":
2024
- - "lang": "typescript"
2025
- "label": "SubscribersController_getSubscriberPreferenceByLevel"
2026
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.preferences.retrieveByLevel({\n parameter: \"template\",\n subscriberId: \"<id>\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2027
- - target: $["paths"]["/v1/subscribers/{subscriberId}/preferences/{parameter}"]["patch"]
2028
- update:
2029
- "x-codeSamples":
2030
- - "lang": "typescript"
2031
- "label": "SubscribersController_updateSubscriberPreference"
2032
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.subscribers.preferences.update({\n subscriberId: \"<id>\",\n parameter: \"<value>\",\n updateSubscriberPreferenceRequestDto: {},\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2033
- - target: $["paths"]["/v1/topics"]["get"]
2034
- update:
2035
- "x-codeSamples":
2036
- - "lang": "typescript"
2037
- "label": "TopicsController_listTopics"
2038
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.topics.list({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2039
- - target: $["paths"]["/v1/topics"]["post"]
2040
- update:
2041
- "x-codeSamples":
2042
- - "lang": "typescript"
2043
- "label": "TopicsController_createTopic"
2044
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.topics.create({\n key: \"<key>\",\n name: \"<value>\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2045
- >>>>>>> Stashed changes
2046
- - target: $["paths"]["/v1/topics/{topicKey}"]["delete"]
2047
- update:
2048
- "x-codeSamples":
2049
- - "lang": "typescript"
2050
- "label": "TopicsController_deleteTopic"
2051
- <<<<<<< Updated upstream
2052
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.topics.delete(\"<value>\");\n\n \n}\n\nrun();"
2053
- - target: $["paths"]["/v1/tenants/{identifier}"]["patch"]
2054
- update:
2055
- "x-codeSamples":
2056
- - "lang": "typescript"
2057
- "label": "TenantController_updateTenant"
2058
- "source": |-
2059
- import { Novu } from "@novu/api";
2060
-
2061
- const novu = new Novu({
2062
- apiKey: "<YOUR_API_KEY_HERE>",
2063
- });
2064
-
2065
- async function run() {
2066
- const result = await novu.tenants.update("<value>", {});
2067
-
2068
- // Handle the result
2069
- console.log(result)
2070
- }
2071
-
2072
- run();
2073
- =======
2074
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.topics.delete(\"<value>\");\n\n\n}\n\nrun();"
2075
- - target: $["paths"]["/v1/topics/{topicKey}"]["get"]
2076
- update:
2077
- "x-codeSamples":
2078
- - "lang": "typescript"
2079
- "label": "TopicsController_getTopic"
2080
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.topics.retrieve(\"<value>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2081
- - target: $["paths"]["/v1/topics/{topicKey}"]["patch"]
2082
- update:
2083
- "x-codeSamples":
2084
- - "lang": "typescript"
2085
- "label": "TopicsController_renameTopic"
2086
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.topics.rename({\n name: \"<value>\",\n }, \"<value>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2087
- - target: $["paths"]["/v1/topics/{topicKey}/subscribers"]["post"]
2088
- update:
2089
- "x-codeSamples":
2090
- - "lang": "typescript"
2091
- "label": "TopicsController_addSubscribers"
2092
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.topics.subscribers.assign({\n subscribers: [\n \"<value>\",\n \"<value>\",\n \"<value>\",\n ],\n }, \"<value>\");\n\n\n}\n\nrun();"
2093
- - target: $["paths"]["/v1/topics/{topicKey}/subscribers/removal"]["post"]
2094
- update:
2095
- "x-codeSamples":
2096
- - "lang": "typescript"
2097
- "label": "TopicsController_removeSubscribers"
2098
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n await novu.topics.subscribers.delete({\n subscribers: [\n \"<value>\",\n \"<value>\",\n ],\n }, \"<value>\");\n\n\n}\n\nrun();"
2099
- - target: $["paths"]["/v1/topics/{topicKey}/subscribers/{externalSubscriberId}"]["get"]
2100
- update:
2101
- "x-codeSamples":
2102
- - "lang": "typescript"
2103
- "label": "TopicsController_getTopicSubscriber"
2104
- "source": "import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await novu.topics.subscribers.retrieve(\"<id>\", \"<value>\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();"
2105
- >>>>>>> Stashed changes