@novu/api 1.0.0 → 1.1.0

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 (558) hide show
  1. package/FUNCTIONS.md +2 -19
  2. package/README.md +82 -327
  3. package/bin/mcp-server.js +427 -1892
  4. package/bin/mcp-server.js.map +84 -110
  5. package/docs/sdks/credentials/README.md +13 -11
  6. package/docs/sdks/integrations/README.md +19 -14
  7. package/docs/sdks/messages/README.md +28 -24
  8. package/docs/sdks/notifications/README.md +9 -4
  9. package/docs/sdks/novu/README.md +16 -188
  10. package/docs/sdks/novumessages/README.md +16 -14
  11. package/docs/sdks/novunotifications/README.md +4 -4
  12. package/docs/sdks/novutopics/README.md +3 -2
  13. package/docs/sdks/preferences/README.md +7 -4
  14. package/docs/sdks/properties/README.md +1 -1
  15. package/docs/sdks/subscribers/README.md +15 -208
  16. package/docs/sdks/subscriptions/README.md +6 -4
  17. package/docs/sdks/topics/README.md +14 -15
  18. package/funcs/integrationsCreate.d.ts +3 -2
  19. package/funcs/integrationsCreate.d.ts.map +1 -1
  20. package/funcs/integrationsCreate.js +3 -2
  21. package/funcs/integrationsCreate.js.map +1 -1
  22. package/funcs/integrationsDelete.d.ts +5 -1
  23. package/funcs/integrationsDelete.d.ts.map +1 -1
  24. package/funcs/integrationsDelete.js +5 -1
  25. package/funcs/integrationsDelete.js.map +1 -1
  26. package/funcs/integrationsList.d.ts +2 -2
  27. package/funcs/integrationsList.js +2 -2
  28. package/funcs/integrationsListActive.d.ts +2 -2
  29. package/funcs/integrationsListActive.js +2 -2
  30. package/funcs/integrationsSetAsPrimary.d.ts +6 -1
  31. package/funcs/integrationsSetAsPrimary.d.ts.map +1 -1
  32. package/funcs/integrationsSetAsPrimary.js +6 -1
  33. package/funcs/integrationsSetAsPrimary.js.map +1 -1
  34. package/funcs/integrationsUpdate.d.ts +5 -1
  35. package/funcs/integrationsUpdate.d.ts.map +1 -1
  36. package/funcs/integrationsUpdate.js +5 -1
  37. package/funcs/integrationsUpdate.js.map +1 -1
  38. package/funcs/messagesDelete.d.ts +3 -2
  39. package/funcs/messagesDelete.d.ts.map +1 -1
  40. package/funcs/messagesDelete.js +3 -2
  41. package/funcs/messagesDelete.js.map +1 -1
  42. package/funcs/messagesDeleteByTransactionId.d.ts +2 -1
  43. package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
  44. package/funcs/messagesDeleteByTransactionId.js +2 -1
  45. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  46. package/funcs/messagesRetrieve.d.ts +4 -2
  47. package/funcs/messagesRetrieve.d.ts.map +1 -1
  48. package/funcs/messagesRetrieve.js +4 -2
  49. package/funcs/messagesRetrieve.js.map +1 -1
  50. package/funcs/notificationsList.d.ts +7 -1
  51. package/funcs/notificationsList.d.ts.map +1 -1
  52. package/funcs/notificationsList.js +7 -1
  53. package/funcs/notificationsList.js.map +1 -1
  54. package/funcs/notificationsRetrieve.d.ts +6 -1
  55. package/funcs/notificationsRetrieve.d.ts.map +1 -1
  56. package/funcs/notificationsRetrieve.js +6 -1
  57. package/funcs/notificationsRetrieve.js.map +1 -1
  58. package/funcs/subscribersCreate.d.ts +3 -2
  59. package/funcs/subscribersCreate.d.ts.map +1 -1
  60. package/funcs/subscribersCreate.js +3 -2
  61. package/funcs/subscribersCreate.js.map +1 -1
  62. package/funcs/subscribersCreateBulk.d.ts +1 -2
  63. package/funcs/subscribersCreateBulk.d.ts.map +1 -1
  64. package/funcs/subscribersCreateBulk.js +1 -2
  65. package/funcs/subscribersCreateBulk.js.map +1 -1
  66. package/funcs/subscribersCredentialsAppend.d.ts +3 -3
  67. package/funcs/subscribersCredentialsAppend.js +3 -3
  68. package/funcs/subscribersCredentialsDelete.d.ts +3 -2
  69. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  70. package/funcs/subscribersCredentialsDelete.js +3 -2
  71. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  72. package/funcs/subscribersCredentialsUpdate.d.ts +3 -2
  73. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  74. package/funcs/subscribersCredentialsUpdate.js +3 -2
  75. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  76. package/funcs/subscribersDelete.d.ts +1 -1
  77. package/funcs/subscribersDelete.js +1 -1
  78. package/funcs/subscribersMessagesMarkAll.d.ts +4 -1
  79. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  80. package/funcs/subscribersMessagesMarkAll.js +4 -1
  81. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  82. package/funcs/subscribersMessagesMarkAllAs.d.ts +5 -1
  83. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  84. package/funcs/subscribersMessagesMarkAllAs.js +5 -1
  85. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  86. package/funcs/subscribersMessagesUpdateAsSeen.d.ts +5 -1
  87. package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  88. package/funcs/subscribersMessagesUpdateAsSeen.js +5 -1
  89. package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
  90. package/funcs/subscribersNotificationsFeed.d.ts +4 -1
  91. package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
  92. package/funcs/subscribersNotificationsFeed.js +4 -1
  93. package/funcs/subscribersNotificationsFeed.js.map +1 -1
  94. package/funcs/subscribersNotificationsUnseenCount.d.ts +4 -1
  95. package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  96. package/funcs/subscribersNotificationsUnseenCount.js +4 -1
  97. package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
  98. package/funcs/subscribersPatch.d.ts +3 -2
  99. package/funcs/subscribersPatch.d.ts.map +1 -1
  100. package/funcs/subscribersPatch.js +3 -2
  101. package/funcs/subscribersPatch.js.map +1 -1
  102. package/funcs/subscribersPreferencesList.d.ts +3 -2
  103. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  104. package/funcs/subscribersPreferencesList.js +3 -2
  105. package/funcs/subscribersPreferencesList.js.map +1 -1
  106. package/funcs/subscribersPreferencesUpdate.d.ts +4 -2
  107. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  108. package/funcs/subscribersPreferencesUpdate.js +4 -2
  109. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  110. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
  111. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +1 -1
  112. package/funcs/subscribersRetrieve.d.ts +3 -2
  113. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  114. package/funcs/subscribersRetrieve.js +3 -2
  115. package/funcs/subscribersRetrieve.js.map +1 -1
  116. package/funcs/subscribersSearch.d.ts +5 -1
  117. package/funcs/subscribersSearch.d.ts.map +1 -1
  118. package/funcs/subscribersSearch.js +5 -1
  119. package/funcs/subscribersSearch.js.map +1 -1
  120. package/funcs/subscribersTopicsList.d.ts +3 -2
  121. package/funcs/subscribersTopicsList.d.ts.map +1 -1
  122. package/funcs/subscribersTopicsList.js +3 -2
  123. package/funcs/subscribersTopicsList.js.map +1 -1
  124. package/funcs/topicsCreate.d.ts +1 -1
  125. package/funcs/topicsCreate.js +1 -1
  126. package/funcs/topicsDelete.d.ts +5 -1
  127. package/funcs/topicsDelete.d.ts.map +1 -1
  128. package/funcs/topicsDelete.js +5 -1
  129. package/funcs/topicsDelete.js.map +1 -1
  130. package/funcs/topicsGet.d.ts +4 -1
  131. package/funcs/topicsGet.d.ts.map +1 -1
  132. package/funcs/topicsGet.js +4 -1
  133. package/funcs/topicsGet.js.map +1 -1
  134. package/funcs/topicsList.d.ts +6 -1
  135. package/funcs/topicsList.d.ts.map +1 -1
  136. package/funcs/topicsList.js +6 -1
  137. package/funcs/topicsList.js.map +1 -1
  138. package/funcs/topicsSubscriptionsCreate.d.ts +5 -1
  139. package/funcs/topicsSubscriptionsCreate.d.ts.map +1 -1
  140. package/funcs/topicsSubscriptionsCreate.js +5 -1
  141. package/funcs/topicsSubscriptionsCreate.js.map +1 -1
  142. package/funcs/topicsSubscriptionsDelete.d.ts +3 -0
  143. package/funcs/topicsSubscriptionsDelete.d.ts.map +1 -1
  144. package/funcs/topicsSubscriptionsDelete.js +3 -0
  145. package/funcs/topicsSubscriptionsDelete.js.map +1 -1
  146. package/funcs/topicsSubscriptionsList.d.ts +4 -0
  147. package/funcs/topicsSubscriptionsList.d.ts.map +1 -1
  148. package/funcs/topicsSubscriptionsList.js +4 -0
  149. package/funcs/topicsSubscriptionsList.js.map +1 -1
  150. package/funcs/topicsUpdate.d.ts +4 -1
  151. package/funcs/topicsUpdate.d.ts.map +1 -1
  152. package/funcs/topicsUpdate.js +4 -1
  153. package/funcs/topicsUpdate.js.map +1 -1
  154. package/jsr.json +1 -1
  155. package/lib/config.d.ts +4 -4
  156. package/lib/config.js +4 -4
  157. package/lib/config.js.map +1 -1
  158. package/mcp-server/cli/start/impl.js +2 -2
  159. package/mcp-server/cli/start/impl.js.map +1 -1
  160. package/mcp-server/mcp-server.js +1 -1
  161. package/mcp-server/server.d.ts.map +1 -1
  162. package/mcp-server/server.js +1 -15
  163. package/mcp-server/server.js.map +1 -1
  164. package/mcp-server/tools/integrationsCreate.d.ts.map +1 -1
  165. package/mcp-server/tools/integrationsCreate.js +3 -2
  166. package/mcp-server/tools/integrationsCreate.js.map +1 -1
  167. package/mcp-server/tools/integrationsDelete.d.ts.map +1 -1
  168. package/mcp-server/tools/integrationsDelete.js +4 -1
  169. package/mcp-server/tools/integrationsDelete.js.map +1 -1
  170. package/mcp-server/tools/integrationsList.js +2 -2
  171. package/mcp-server/tools/integrationsList.js.map +1 -1
  172. package/mcp-server/tools/integrationsListActive.js +2 -2
  173. package/mcp-server/tools/integrationsListActive.js.map +1 -1
  174. package/mcp-server/tools/integrationsSetAsPrimary.d.ts.map +1 -1
  175. package/mcp-server/tools/integrationsSetAsPrimary.js +5 -1
  176. package/mcp-server/tools/integrationsSetAsPrimary.js.map +1 -1
  177. package/mcp-server/tools/integrationsUpdate.d.ts.map +1 -1
  178. package/mcp-server/tools/integrationsUpdate.js +4 -1
  179. package/mcp-server/tools/integrationsUpdate.js.map +1 -1
  180. package/mcp-server/tools/messagesDelete.d.ts.map +1 -1
  181. package/mcp-server/tools/messagesDelete.js +3 -2
  182. package/mcp-server/tools/messagesDelete.js.map +1 -1
  183. package/mcp-server/tools/messagesDeleteByTransactionId.d.ts.map +1 -1
  184. package/mcp-server/tools/messagesDeleteByTransactionId.js +2 -1
  185. package/mcp-server/tools/messagesDeleteByTransactionId.js.map +1 -1
  186. package/mcp-server/tools/messagesRetrieve.d.ts.map +1 -1
  187. package/mcp-server/tools/messagesRetrieve.js +4 -2
  188. package/mcp-server/tools/messagesRetrieve.js.map +1 -1
  189. package/mcp-server/tools/notificationsList.d.ts.map +1 -1
  190. package/mcp-server/tools/notificationsList.js +6 -1
  191. package/mcp-server/tools/notificationsList.js.map +1 -1
  192. package/mcp-server/tools/notificationsRetrieve.d.ts.map +1 -1
  193. package/mcp-server/tools/notificationsRetrieve.js +5 -1
  194. package/mcp-server/tools/notificationsRetrieve.js.map +1 -1
  195. package/mcp-server/tools/subscribersCreate.d.ts.map +1 -1
  196. package/mcp-server/tools/subscribersCreate.js +3 -2
  197. package/mcp-server/tools/subscribersCreate.js.map +1 -1
  198. package/mcp-server/tools/subscribersCreateBulk.d.ts.map +1 -1
  199. package/mcp-server/tools/subscribersCreateBulk.js +1 -2
  200. package/mcp-server/tools/subscribersCreateBulk.js.map +1 -1
  201. package/mcp-server/tools/subscribersCredentialsAppend.js +3 -3
  202. package/mcp-server/tools/subscribersCredentialsAppend.js.map +1 -1
  203. package/mcp-server/tools/subscribersCredentialsDelete.d.ts.map +1 -1
  204. package/mcp-server/tools/subscribersCredentialsDelete.js +3 -2
  205. package/mcp-server/tools/subscribersCredentialsDelete.js.map +1 -1
  206. package/mcp-server/tools/subscribersCredentialsUpdate.d.ts.map +1 -1
  207. package/mcp-server/tools/subscribersCredentialsUpdate.js +3 -2
  208. package/mcp-server/tools/subscribersCredentialsUpdate.js.map +1 -1
  209. package/mcp-server/tools/subscribersDelete.js +1 -1
  210. package/mcp-server/tools/subscribersDelete.js.map +1 -1
  211. package/mcp-server/tools/subscribersMessagesMarkAll.d.ts.map +1 -1
  212. package/mcp-server/tools/subscribersMessagesMarkAll.js +3 -1
  213. package/mcp-server/tools/subscribersMessagesMarkAll.js.map +1 -1
  214. package/mcp-server/tools/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  215. package/mcp-server/tools/subscribersMessagesMarkAllAs.js +4 -1
  216. package/mcp-server/tools/subscribersMessagesMarkAllAs.js.map +1 -1
  217. package/mcp-server/tools/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  218. package/mcp-server/tools/subscribersMessagesUpdateAsSeen.js +4 -1
  219. package/mcp-server/tools/subscribersMessagesUpdateAsSeen.js.map +1 -1
  220. package/mcp-server/tools/subscribersNotificationsFeed.d.ts.map +1 -1
  221. package/mcp-server/tools/subscribersNotificationsFeed.js +3 -1
  222. package/mcp-server/tools/subscribersNotificationsFeed.js.map +1 -1
  223. package/mcp-server/tools/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  224. package/mcp-server/tools/subscribersNotificationsUnseenCount.js +3 -1
  225. package/mcp-server/tools/subscribersNotificationsUnseenCount.js.map +1 -1
  226. package/mcp-server/tools/subscribersPatch.d.ts.map +1 -1
  227. package/mcp-server/tools/subscribersPatch.js +3 -2
  228. package/mcp-server/tools/subscribersPatch.js.map +1 -1
  229. package/mcp-server/tools/subscribersPreferencesList.d.ts.map +1 -1
  230. package/mcp-server/tools/subscribersPreferencesList.js +3 -2
  231. package/mcp-server/tools/subscribersPreferencesList.js.map +1 -1
  232. package/mcp-server/tools/subscribersPreferencesUpdate.d.ts.map +1 -1
  233. package/mcp-server/tools/subscribersPreferencesUpdate.js +4 -2
  234. package/mcp-server/tools/subscribersPreferencesUpdate.js.map +1 -1
  235. package/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.js +1 -1
  236. package/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  237. package/mcp-server/tools/subscribersRetrieve.d.ts.map +1 -1
  238. package/mcp-server/tools/subscribersRetrieve.js +3 -2
  239. package/mcp-server/tools/subscribersRetrieve.js.map +1 -1
  240. package/mcp-server/tools/subscribersSearch.d.ts.map +1 -1
  241. package/mcp-server/tools/subscribersSearch.js +4 -1
  242. package/mcp-server/tools/subscribersSearch.js.map +1 -1
  243. package/mcp-server/tools/subscribersTopicsList.d.ts.map +1 -1
  244. package/mcp-server/tools/subscribersTopicsList.js +3 -2
  245. package/mcp-server/tools/subscribersTopicsList.js.map +1 -1
  246. package/mcp-server/tools/topicsCreate.js +1 -1
  247. package/mcp-server/tools/topicsDelete.d.ts.map +1 -1
  248. package/mcp-server/tools/topicsDelete.js +4 -1
  249. package/mcp-server/tools/topicsDelete.js.map +1 -1
  250. package/mcp-server/tools/topicsGet.d.ts.map +1 -1
  251. package/mcp-server/tools/topicsGet.js +3 -1
  252. package/mcp-server/tools/topicsGet.js.map +1 -1
  253. package/mcp-server/tools/topicsList.d.ts.map +1 -1
  254. package/mcp-server/tools/topicsList.js +5 -1
  255. package/mcp-server/tools/topicsList.js.map +1 -1
  256. package/mcp-server/tools/topicsSubscriptionsCreate.d.ts.map +1 -1
  257. package/mcp-server/tools/topicsSubscriptionsCreate.js +4 -1
  258. package/mcp-server/tools/topicsSubscriptionsCreate.js.map +1 -1
  259. package/mcp-server/tools/topicsSubscriptionsDelete.d.ts.map +1 -1
  260. package/mcp-server/tools/topicsSubscriptionsDelete.js +3 -1
  261. package/mcp-server/tools/topicsSubscriptionsDelete.js.map +1 -1
  262. package/mcp-server/tools/topicsSubscriptionsList.d.ts.map +1 -1
  263. package/mcp-server/tools/topicsSubscriptionsList.js +4 -1
  264. package/mcp-server/tools/topicsSubscriptionsList.js.map +1 -1
  265. package/mcp-server/tools/topicsUpdate.d.ts.map +1 -1
  266. package/mcp-server/tools/topicsUpdate.js +3 -1
  267. package/mcp-server/tools/topicsUpdate.js.map +1 -1
  268. package/models/components/index.d.ts +0 -3
  269. package/models/components/index.d.ts.map +1 -1
  270. package/models/components/index.js +0 -3
  271. package/models/components/index.js.map +1 -1
  272. package/models/components/notificationfeeditemdto.d.ts +2 -2
  273. package/models/components/notificationfeeditemdto.d.ts.map +1 -1
  274. package/models/components/notificationfeeditemdto.js +2 -2
  275. package/models/components/notificationfeeditemdto.js.map +1 -1
  276. package/models/operations/index.d.ts +0 -7
  277. package/models/operations/index.d.ts.map +1 -1
  278. package/models/operations/index.js +0 -7
  279. package/models/operations/index.js.map +1 -1
  280. package/package.json +2 -2
  281. package/sdk/credentials.d.ts +9 -7
  282. package/sdk/credentials.d.ts.map +1 -1
  283. package/sdk/credentials.js +9 -7
  284. package/sdk/credentials.js.map +1 -1
  285. package/sdk/integrations.d.ts +23 -12
  286. package/sdk/integrations.d.ts.map +1 -1
  287. package/sdk/integrations.js +23 -13
  288. package/sdk/integrations.js.map +1 -1
  289. package/sdk/messages.d.ts +9 -5
  290. package/sdk/messages.d.ts.map +1 -1
  291. package/sdk/messages.js +9 -5
  292. package/sdk/messages.js.map +1 -1
  293. package/sdk/notifications.d.ts +13 -5
  294. package/sdk/notifications.d.ts.map +1 -1
  295. package/sdk/notifications.js +13 -6
  296. package/sdk/notifications.js.map +1 -1
  297. package/sdk/novumessages.d.ts +14 -3
  298. package/sdk/novumessages.d.ts.map +1 -1
  299. package/sdk/novumessages.js +14 -3
  300. package/sdk/novumessages.js.map +1 -1
  301. package/sdk/novunotifications.d.ts +8 -2
  302. package/sdk/novunotifications.d.ts.map +1 -1
  303. package/sdk/novunotifications.js +8 -2
  304. package/sdk/novunotifications.js.map +1 -1
  305. package/sdk/novutopics.d.ts +3 -2
  306. package/sdk/novutopics.d.ts.map +1 -1
  307. package/sdk/novutopics.js +3 -2
  308. package/sdk/novutopics.js.map +1 -1
  309. package/sdk/preferences.d.ts +7 -4
  310. package/sdk/preferences.d.ts.map +1 -1
  311. package/sdk/preferences.js +7 -4
  312. package/sdk/preferences.js.map +1 -1
  313. package/sdk/properties.d.ts +1 -1
  314. package/sdk/properties.js +1 -1
  315. package/sdk/subscribers.d.ts +16 -30
  316. package/sdk/subscribers.d.ts.map +1 -1
  317. package/sdk/subscribers.js +16 -35
  318. package/sdk/subscribers.js.map +1 -1
  319. package/sdk/subscriptions.d.ts +12 -1
  320. package/sdk/subscriptions.d.ts.map +1 -1
  321. package/sdk/subscriptions.js +12 -1
  322. package/sdk/subscriptions.js.map +1 -1
  323. package/sdk/topics.d.ts +20 -5
  324. package/sdk/topics.d.ts.map +1 -1
  325. package/sdk/topics.js +20 -5
  326. package/sdk/topics.js.map +1 -1
  327. package/sources/json-development.json +2597 -5944
  328. package/src/funcs/integrationsCreate.ts +3 -2
  329. package/src/funcs/integrationsDelete.ts +5 -1
  330. package/src/funcs/integrationsList.ts +2 -2
  331. package/src/funcs/integrationsListActive.ts +2 -2
  332. package/src/funcs/integrationsSetAsPrimary.ts +6 -1
  333. package/src/funcs/integrationsUpdate.ts +5 -1
  334. package/src/funcs/messagesDelete.ts +3 -2
  335. package/src/funcs/messagesDeleteByTransactionId.ts +2 -1
  336. package/src/funcs/messagesRetrieve.ts +4 -2
  337. package/src/funcs/notificationsList.ts +7 -1
  338. package/src/funcs/notificationsRetrieve.ts +6 -1
  339. package/src/funcs/subscribersCreate.ts +3 -2
  340. package/src/funcs/subscribersCreateBulk.ts +1 -2
  341. package/src/funcs/subscribersCredentialsAppend.ts +3 -3
  342. package/src/funcs/subscribersCredentialsDelete.ts +3 -2
  343. package/src/funcs/subscribersCredentialsUpdate.ts +3 -2
  344. package/src/funcs/subscribersDelete.ts +1 -1
  345. package/src/funcs/subscribersMessagesMarkAll.ts +4 -1
  346. package/src/funcs/subscribersMessagesMarkAllAs.ts +5 -1
  347. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +5 -1
  348. package/src/funcs/subscribersNotificationsFeed.ts +4 -1
  349. package/src/funcs/subscribersNotificationsUnseenCount.ts +4 -1
  350. package/src/funcs/subscribersPatch.ts +3 -2
  351. package/src/funcs/subscribersPreferencesList.ts +3 -2
  352. package/src/funcs/subscribersPreferencesUpdate.ts +4 -2
  353. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
  354. package/src/funcs/subscribersRetrieve.ts +3 -2
  355. package/src/funcs/subscribersSearch.ts +5 -1
  356. package/src/funcs/subscribersTopicsList.ts +3 -2
  357. package/src/funcs/topicsCreate.ts +1 -1
  358. package/src/funcs/topicsDelete.ts +5 -1
  359. package/src/funcs/topicsGet.ts +4 -1
  360. package/src/funcs/topicsList.ts +6 -1
  361. package/src/funcs/topicsSubscriptionsCreate.ts +5 -1
  362. package/src/funcs/topicsSubscriptionsDelete.ts +3 -0
  363. package/src/funcs/topicsSubscriptionsList.ts +4 -0
  364. package/src/funcs/topicsUpdate.ts +4 -1
  365. package/src/lib/config.ts +4 -4
  366. package/src/mcp-server/cli/start/impl.ts +2 -2
  367. package/src/mcp-server/mcp-server.ts +1 -1
  368. package/src/mcp-server/server.ts +1 -15
  369. package/src/mcp-server/tools/integrationsCreate.ts +3 -2
  370. package/src/mcp-server/tools/integrationsDelete.ts +4 -1
  371. package/src/mcp-server/tools/integrationsList.ts +2 -2
  372. package/src/mcp-server/tools/integrationsListActive.ts +2 -2
  373. package/src/mcp-server/tools/integrationsSetAsPrimary.ts +5 -1
  374. package/src/mcp-server/tools/integrationsUpdate.ts +4 -1
  375. package/src/mcp-server/tools/messagesDelete.ts +3 -2
  376. package/src/mcp-server/tools/messagesDeleteByTransactionId.ts +2 -1
  377. package/src/mcp-server/tools/messagesRetrieve.ts +4 -2
  378. package/src/mcp-server/tools/notificationsList.ts +6 -1
  379. package/src/mcp-server/tools/notificationsRetrieve.ts +5 -1
  380. package/src/mcp-server/tools/subscribersCreate.ts +3 -2
  381. package/src/mcp-server/tools/subscribersCreateBulk.ts +1 -2
  382. package/src/mcp-server/tools/subscribersCredentialsAppend.ts +3 -3
  383. package/src/mcp-server/tools/subscribersCredentialsDelete.ts +3 -2
  384. package/src/mcp-server/tools/subscribersCredentialsUpdate.ts +3 -2
  385. package/src/mcp-server/tools/subscribersDelete.ts +1 -1
  386. package/src/mcp-server/tools/subscribersMessagesMarkAll.ts +3 -2
  387. package/src/mcp-server/tools/subscribersMessagesMarkAllAs.ts +4 -1
  388. package/src/mcp-server/tools/subscribersMessagesUpdateAsSeen.ts +4 -1
  389. package/src/mcp-server/tools/subscribersNotificationsFeed.ts +3 -1
  390. package/src/mcp-server/tools/subscribersNotificationsUnseenCount.ts +3 -1
  391. package/src/mcp-server/tools/subscribersPatch.ts +3 -2
  392. package/src/mcp-server/tools/subscribersPreferencesList.ts +3 -2
  393. package/src/mcp-server/tools/subscribersPreferencesUpdate.ts +4 -2
  394. package/src/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
  395. package/src/mcp-server/tools/subscribersRetrieve.ts +3 -2
  396. package/src/mcp-server/tools/subscribersSearch.ts +4 -1
  397. package/src/mcp-server/tools/subscribersTopicsList.ts +3 -2
  398. package/src/mcp-server/tools/topicsCreate.ts +1 -1
  399. package/src/mcp-server/tools/topicsDelete.ts +4 -1
  400. package/src/mcp-server/tools/topicsGet.ts +3 -1
  401. package/src/mcp-server/tools/topicsList.ts +5 -1
  402. package/src/mcp-server/tools/topicsSubscriptionsCreate.ts +4 -2
  403. package/src/mcp-server/tools/topicsSubscriptionsDelete.ts +3 -1
  404. package/src/mcp-server/tools/topicsSubscriptionsList.ts +4 -1
  405. package/src/mcp-server/tools/topicsUpdate.ts +3 -1
  406. package/src/models/components/index.ts +0 -3
  407. package/src/models/components/notificationfeeditemdto.ts +4 -4
  408. package/src/models/operations/index.ts +0 -7
  409. package/src/sdk/credentials.ts +9 -7
  410. package/src/sdk/integrations.ts +23 -15
  411. package/src/sdk/messages.ts +9 -5
  412. package/src/sdk/notifications.ts +13 -8
  413. package/src/sdk/novumessages.ts +14 -3
  414. package/src/sdk/novunotifications.ts +8 -2
  415. package/src/sdk/novutopics.ts +3 -2
  416. package/src/sdk/preferences.ts +7 -4
  417. package/src/sdk/properties.ts +1 -1
  418. package/src/sdk/subscribers.ts +16 -66
  419. package/src/sdk/subscriptions.ts +12 -1
  420. package/src/sdk/topics.ts +20 -5
  421. package/docs/sdks/authentication/README.md +0 -183
  422. package/docs/sdks/stats/README.md +0 -162
  423. package/docs/sdks/webhooks/README.md +0 -85
  424. package/funcs/integrationsWebhooksRetrieve.d.ts +0 -17
  425. package/funcs/integrationsWebhooksRetrieve.d.ts.map +0 -1
  426. package/funcs/integrationsWebhooksRetrieve.js +0 -143
  427. package/funcs/integrationsWebhooksRetrieve.js.map +0 -1
  428. package/funcs/notificationsStatsGraph.d.ts +0 -14
  429. package/funcs/notificationsStatsGraph.d.ts.map +0 -1
  430. package/funcs/notificationsStatsGraph.js +0 -141
  431. package/funcs/notificationsStatsGraph.js.map +0 -1
  432. package/funcs/notificationsStatsRetrieve.d.ts +0 -14
  433. package/funcs/notificationsStatsRetrieve.d.ts.map +0 -1
  434. package/funcs/notificationsStatsRetrieve.js +0 -134
  435. package/funcs/notificationsStatsRetrieve.js.map +0 -1
  436. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +0 -14
  437. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +0 -1
  438. package/funcs/subscribersAuthenticationChatAccessOauth.js +0 -148
  439. package/funcs/subscribersAuthenticationChatAccessOauth.js.map +0 -1
  440. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +0 -20
  441. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +0 -1
  442. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +0 -154
  443. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +0 -1
  444. package/funcs/subscribersList.d.ts +0 -20
  445. package/funcs/subscribersList.d.ts.map +0 -1
  446. package/funcs/subscribersList.js +0 -172
  447. package/funcs/subscribersList.js.map +0 -1
  448. package/funcs/subscribersUpsert.d.ts +0 -18
  449. package/funcs/subscribersUpsert.d.ts.map +0 -1
  450. package/funcs/subscribersUpsert.js +0 -148
  451. package/funcs/subscribersUpsert.js.map +0 -1
  452. package/mcp-server/tools/integrationsWebhooksRetrieve.d.ts +0 -9
  453. package/mcp-server/tools/integrationsWebhooksRetrieve.d.ts.map +0 -1
  454. package/mcp-server/tools/integrationsWebhooksRetrieve.js +0 -55
  455. package/mcp-server/tools/integrationsWebhooksRetrieve.js.map +0 -1
  456. package/mcp-server/tools/notificationsStatsGraph.d.ts +0 -9
  457. package/mcp-server/tools/notificationsStatsGraph.d.ts.map +0 -1
  458. package/mcp-server/tools/notificationsStatsGraph.js +0 -53
  459. package/mcp-server/tools/notificationsStatsGraph.js.map +0 -1
  460. package/mcp-server/tools/notificationsStatsRetrieve.d.ts +0 -8
  461. package/mcp-server/tools/notificationsStatsRetrieve.d.ts.map +0 -1
  462. package/mcp-server/tools/notificationsStatsRetrieve.js +0 -52
  463. package/mcp-server/tools/notificationsStatsRetrieve.js.map +0 -1
  464. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.d.ts +0 -8
  465. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.d.ts.map +0 -1
  466. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js +0 -51
  467. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js.map +0 -1
  468. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.d.ts +0 -8
  469. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +0 -1
  470. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js +0 -52
  471. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js.map +0 -1
  472. package/mcp-server/tools/subscribersList.d.ts +0 -10
  473. package/mcp-server/tools/subscribersList.d.ts.map +0 -1
  474. package/mcp-server/tools/subscribersList.js +0 -56
  475. package/mcp-server/tools/subscribersList.js.map +0 -1
  476. package/mcp-server/tools/subscribersUpsert.d.ts +0 -11
  477. package/mcp-server/tools/subscribersUpsert.d.ts.map +0 -1
  478. package/mcp-server/tools/subscribersUpsert.js +0 -57
  479. package/mcp-server/tools/subscribersUpsert.js.map +0 -1
  480. package/models/components/activitygraphstatesresponse.d.ts +0 -70
  481. package/models/components/activitygraphstatesresponse.d.ts.map +0 -1
  482. package/models/components/activitygraphstatesresponse.js +0 -97
  483. package/models/components/activitygraphstatesresponse.js.map +0 -1
  484. package/models/components/activitystatsresponsedto.d.ts +0 -31
  485. package/models/components/activitystatsresponsedto.d.ts.map +0 -1
  486. package/models/components/activitystatsresponsedto.js +0 -61
  487. package/models/components/activitystatsresponsedto.js.map +0 -1
  488. package/models/components/updatesubscriberrequestdto.d.ts +0 -72
  489. package/models/components/updatesubscriberrequestdto.d.ts.map +0 -1
  490. package/models/components/updatesubscriberrequestdto.js +0 -74
  491. package/models/components/updatesubscriberrequestdto.js.map +0 -1
  492. package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts +0 -65
  493. package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts.map +0 -1
  494. package/models/operations/integrationscontrollergetwebhooksupportstatus.js +0 -109
  495. package/models/operations/integrationscontrollergetwebhooksupportstatus.js.map +0 -1
  496. package/models/operations/notificationscontrollergetactivitygraphstats.d.ts +0 -66
  497. package/models/operations/notificationscontrollergetactivitygraphstats.d.ts.map +0 -1
  498. package/models/operations/notificationscontrollergetactivitygraphstats.js +0 -110
  499. package/models/operations/notificationscontrollergetactivitygraphstats.js.map +0 -1
  500. package/models/operations/notificationscontrollergetactivitystats.d.ts +0 -64
  501. package/models/operations/notificationscontrollergetactivitystats.d.ts.map +0 -1
  502. package/models/operations/notificationscontrollergetactivitystats.js +0 -108
  503. package/models/operations/notificationscontrollergetactivitystats.js.map +0 -1
  504. package/models/operations/subscribersv1controllerchataccessoauth.d.ts +0 -80
  505. package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +0 -1
  506. package/models/operations/subscribersv1controllerchataccessoauth.js +0 -113
  507. package/models/operations/subscribersv1controllerchataccessoauth.js.map +0 -1
  508. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +0 -108
  509. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +0 -1
  510. package/models/operations/subscribersv1controllerchatoauthcallback.js +0 -143
  511. package/models/operations/subscribersv1controllerchatoauthcallback.js.map +0 -1
  512. package/models/operations/subscribersv1controllerlistsubscribers.d.ts +0 -108
  513. package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +0 -1
  514. package/models/operations/subscribersv1controllerlistsubscribers.js +0 -145
  515. package/models/operations/subscribersv1controllerlistsubscribers.js.map +0 -1
  516. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +0 -68
  517. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +0 -1
  518. package/models/operations/subscribersv1controllerupdatesubscriber.js +0 -114
  519. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +0 -1
  520. package/sdk/authentication.d.ts +0 -17
  521. package/sdk/authentication.d.ts.map +0 -1
  522. package/sdk/authentication.js +0 -28
  523. package/sdk/authentication.js.map +0 -1
  524. package/sdk/stats.d.ts +0 -13
  525. package/sdk/stats.d.ts.map +0 -1
  526. package/sdk/stats.js +0 -26
  527. package/sdk/stats.js.map +0 -1
  528. package/sdk/webhooks.d.ts +0 -12
  529. package/sdk/webhooks.d.ts.map +0 -1
  530. package/sdk/webhooks.js +0 -22
  531. package/sdk/webhooks.js.map +0 -1
  532. package/src/funcs/integrationsWebhooksRetrieve.ts +0 -238
  533. package/src/funcs/notificationsStatsGraph.ts +0 -230
  534. package/src/funcs/notificationsStatsRetrieve.ts +0 -218
  535. package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +0 -234
  536. package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +0 -250
  537. package/src/funcs/subscribersList.ts +0 -305
  538. package/src/funcs/subscribersUpsert.ts +0 -240
  539. package/src/mcp-server/tools/integrationsWebhooksRetrieve.ts +0 -39
  540. package/src/mcp-server/tools/notificationsStatsGraph.ts +0 -37
  541. package/src/mcp-server/tools/notificationsStatsRetrieve.ts +0 -35
  542. package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauth.ts +0 -36
  543. package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.ts +0 -38
  544. package/src/mcp-server/tools/subscribersList.ts +0 -41
  545. package/src/mcp-server/tools/subscribersUpsert.ts +0 -43
  546. package/src/models/components/activitygraphstatesresponse.ts +0 -118
  547. package/src/models/components/activitystatsresponsedto.ts +0 -70
  548. package/src/models/components/updatesubscriberrequestdto.ts +0 -124
  549. package/src/models/operations/integrationscontrollergetwebhooksupportstatus.ts +0 -182
  550. package/src/models/operations/notificationscontrollergetactivitygraphstats.ts +0 -183
  551. package/src/models/operations/notificationscontrollergetactivitystats.ts +0 -179
  552. package/src/models/operations/subscribersv1controllerchataccessoauth.ts +0 -200
  553. package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +0 -281
  554. package/src/models/operations/subscribersv1controllerlistsubscribers.ts +0 -283
  555. package/src/models/operations/subscribersv1controllerupdatesubscriber.ts +0 -191
  556. package/src/sdk/authentication.ts +0 -48
  557. package/src/sdk/stats.ts +0 -41
  558. package/src/sdk/webhooks.ts +0 -29
@@ -13,7 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$integrationsDelete: ToolDefinition<typeof args> = {
15
15
  name: "integrations-delete",
16
- description: `Delete integration`,
16
+ description: `Delete an integration
17
+
18
+ Delete an integration by its unique key identifier **integrationId**.
19
+ This action is irreversible.`,
17
20
  args,
18
21
  tool: async (client, args, ctx) => {
19
22
  const [result, apiCall] = await integrationsDelete(
@@ -12,9 +12,9 @@ const args = {
12
12
 
13
13
  export const tool$integrationsList: ToolDefinition<typeof args> = {
14
14
  name: "integrations-list",
15
- description: `Get integrations
15
+ description: `List all integrations
16
16
 
17
- Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change`,
17
+ List all the channels integrations created in the organization`,
18
18
  args,
19
19
  tool: async (client, args, ctx) => {
20
20
  const [result, apiCall] = await integrationsList(
@@ -12,9 +12,9 @@ const args = {
12
12
 
13
13
  export const tool$integrationsListActive: ToolDefinition<typeof args> = {
14
14
  name: "integrations-list-active",
15
- description: `Get active integrations
15
+ description: `List active integrations
16
16
 
17
- Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change`,
17
+ List all the active integrations created in the organization`,
18
18
  args,
19
19
  tool: async (client, args, ctx) => {
20
20
  const [result, apiCall] = await integrationsListActive(
@@ -13,7 +13,11 @@ const args = {
13
13
 
14
14
  export const tool$integrationsSetAsPrimary: ToolDefinition<typeof args> = {
15
15
  name: "integrations-set-as-primary",
16
- description: `Set integration as primary`,
16
+ description: `Update integration as primary
17
+
18
+ Update an integration as **primary** by its unique key identifier **integrationId**.
19
+ This API will set the integration as primary for that channel in the current environment.
20
+ Primary integration is used to deliver notification for sms and email channels in the workflow.`,
17
21
  args,
18
22
  tool: async (client, args, ctx) => {
19
23
  const [result, apiCall] = await integrationsSetAsPrimary(
@@ -16,7 +16,10 @@ const args = {
16
16
 
17
17
  export const tool$integrationsUpdate: ToolDefinition<typeof args> = {
18
18
  name: "integrations-update",
19
- description: `Update integration`,
19
+ description: `Update an integration
20
+
21
+ Update an integration by its unique key identifier **integrationId**.
22
+ Each provider supports different credentials, check the provider documentation for more details.`,
20
23
  args,
21
24
  tool: async (client, args, ctx) => {
22
25
  const [result, apiCall] = await integrationsUpdate(
@@ -13,9 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$messagesDelete: ToolDefinition<typeof args> = {
15
15
  name: "messages-delete",
16
- description: `Delete message
16
+ description: `Delete a message
17
17
 
18
- Deletes a message entity from the Novu platform`,
18
+ Delete a message entity from the Novu platform by **messageId**.
19
+ This action is irreversible. **messageId** is required and of mongodbId type.`,
19
20
  args,
20
21
  tool: async (client, args, ctx) => {
21
22
  const [result, apiCall] = await messagesDelete(
@@ -17,7 +17,8 @@ export const tool$messagesDeleteByTransactionId: ToolDefinition<typeof args> = {
17
17
  name: "messages-delete-by-transaction-id",
18
18
  description: `Delete messages by transactionId
19
19
 
20
- Deletes messages entity from the Novu platform using TransactionId of message`,
20
+ Delete multiple messages from the Novu platform using **transactionId** of triggered event.
21
+ This API supports filtering by **channel** and delete all messages associated with the **transactionId**.`,
21
22
  args,
22
23
  tool: async (client, args, ctx) => {
23
24
  const [result, apiCall] = await messagesDeleteByTransactionId(
@@ -12,9 +12,11 @@ const args = {
12
12
 
13
13
  export const tool$messagesRetrieve: ToolDefinition<typeof args> = {
14
14
  name: "messages-retrieve",
15
- description: `Get messages
15
+ description: `List all messages
16
16
 
17
- Returns a list of messages, could paginate using the \`page\` query parameter`,
17
+ List all messages for the current environment.
18
+ This API supports filtering by **channel**, **subscriberId**, and **transactionId**.
19
+ This API returns a paginated list of messages.`,
18
20
  args,
19
21
  tool: async (client, args, ctx) => {
20
22
  const [result, apiCall] = await messagesRetrieve(
@@ -13,7 +13,12 @@ const args = {
13
13
 
14
14
  export const tool$notificationsList: ToolDefinition<typeof args> = {
15
15
  name: "notifications-list",
16
- description: `Get notifications`,
16
+ description: `List all events
17
+
18
+ List all notification events (triggered events) for the current environment.
19
+ This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**.
20
+ Checkout all available filters in the query section.
21
+ This API returns event triggers, to list each channel notifications, check messages APIs.`,
17
22
  args,
18
23
  tool: async (client, args, ctx) => {
19
24
  const [result, apiCall] = await notificationsList(
@@ -13,7 +13,11 @@ const args = {
13
13
 
14
14
  export const tool$notificationsRetrieve: ToolDefinition<typeof args> = {
15
15
  name: "notifications-retrieve",
16
- description: `Get notification`,
16
+ description: `Retrieve an event
17
+
18
+ Retrieve an event by its unique key identifier **notificationId**.
19
+ Here **notificationId** is of mongodbId type.
20
+ This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.`,
17
21
  args,
18
22
  tool: async (client, args, ctx) => {
19
23
  const [result, apiCall] = await notificationsRetrieve(
@@ -15,9 +15,10 @@ const args = {
15
15
 
16
16
  export const tool$subscribersCreate: ToolDefinition<typeof args> = {
17
17
  name: "subscribers-create",
18
- description: `Create subscriber
18
+ description: `Create a subscriber
19
19
 
20
- Create subscriber with the given data, if the subscriber already exists, it will be updated`,
20
+ Create a subscriber with the subscriber attributes.
21
+ **subscriberId** is a required field, rest other fields are optional, if the subscriber already exists, it will be updated`,
21
22
  args,
22
23
  tool: async (client, args, ctx) => {
23
24
  const [result, apiCall] = await subscribersCreate(
@@ -17,8 +17,7 @@ export const tool$subscribersCreateBulk: ToolDefinition<typeof args> = {
17
17
  description: `Bulk create subscribers
18
18
 
19
19
 
20
- Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
21
- The bulk API is limited to 500 subscribers per request.
20
+ Using this endpoint multiple subscribers can be created at once. The bulk API is limited to 500 subscribers per request.
22
21
  `,
23
22
  args,
24
23
  tool: async (client, args, ctx) => {
@@ -16,10 +16,10 @@ const args = {
16
16
 
17
17
  export const tool$subscribersCredentialsAppend: ToolDefinition<typeof args> = {
18
18
  name: "subscribers-credentials-append",
19
- description: `Modify subscriber credentials
19
+ description: `Upsert provider credentials
20
20
 
21
- Subscriber credentials associated to the delivery methods such as slack and push tokens.
22
- This endpoint appends provided credentials and deviceTokens to the existing ones.`,
21
+ Update credentials for a provider such as **slack** and **FCM**.
22
+ **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.`,
23
23
  args,
24
24
  tool: async (client, args, ctx) => {
25
25
  const [result, apiCall] = await subscribersCredentialsAppend(
@@ -14,9 +14,10 @@ const args = {
14
14
 
15
15
  export const tool$subscribersCredentialsDelete: ToolDefinition<typeof args> = {
16
16
  name: "subscribers-credentials-delete",
17
- description: `Delete subscriber credentials by providerId
17
+ description: `Delete provider credentials
18
18
 
19
- Delete subscriber credentials such as slack and expo tokens.`,
19
+ Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**.
20
+ This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.`,
20
21
  args,
21
22
  tool: async (client, args, ctx) => {
22
23
  const [result, apiCall] = await subscribersCredentialsDelete(
@@ -16,9 +16,10 @@ const args = {
16
16
 
17
17
  export const tool$subscribersCredentialsUpdate: ToolDefinition<typeof args> = {
18
18
  name: "subscribers-credentials-update",
19
- description: `Update subscriber credentials
19
+ description: `Update provider credentials
20
20
 
21
- Subscriber credentials associated to the delivery methods such as slack and push tokens.`,
21
+ Update credentials for a provider such as slack and push tokens.
22
+ **providerId** is required field. This API appends the **deviceTokens** to the existing ones.`,
22
23
  args,
23
24
  tool: async (client, args, ctx) => {
24
25
  const [result, apiCall] = await subscribersCredentialsUpdate(
@@ -15,7 +15,7 @@ export const tool$subscribersDelete: ToolDefinition<typeof args> = {
15
15
  name: "subscribers-delete",
16
16
  description: `Delete subscriber
17
17
 
18
- Deletes a subscriber entity from the Novu platform`,
18
+ Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions`,
19
19
  args,
20
20
  tool: async (client, args, ctx) => {
21
21
  const [result, apiCall] = await subscribersDelete(
@@ -16,8 +16,9 @@ const args = {
16
16
 
17
17
  export const tool$subscribersMessagesMarkAll: ToolDefinition<typeof args> = {
18
18
  name: "subscribers-messages-mark-all",
19
- description:
20
- `Marks all the subscriber messages as read, unread, seen or unseen.`,
19
+ description: `Update all notifications state
20
+
21
+ Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by **subscriberId**.`,
21
22
  args,
22
23
  tool: async (client, args, ctx) => {
23
24
  const [result, apiCall] = await subscribersMessagesMarkAll(
@@ -15,7 +15,10 @@ const args = {
15
15
 
16
16
  export const tool$subscribersMessagesMarkAllAs: ToolDefinition<typeof args> = {
17
17
  name: "subscribers-messages-mark-all-as",
18
- description: `Mark a subscriber messages as seen, read, unseen or unread`,
18
+ description: `Update notifications state
19
+
20
+ Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by **subscriberId**.
21
+ **messageId** is of type mongodbId of notifications`,
19
22
  args,
20
23
  tool: async (client, args, ctx) => {
21
24
  const [result, apiCall] = await subscribersMessagesMarkAllAs(
@@ -14,7 +14,10 @@ const args = {
14
14
  export const tool$subscribersMessagesUpdateAsSeen: ToolDefinition<typeof args> =
15
15
  {
16
16
  name: "subscribers-messages-update-as-seen",
17
- description: `Mark message action as seen`,
17
+ description: `Update notification action status
18
+
19
+ Update in-app (inbox) notification's action status by its unique key identifier **messageId** and type field **type**.
20
+ **type** field can be **primary** or **secondary**`,
18
21
  args,
19
22
  tool: async (client, args, ctx) => {
20
23
  const [result, apiCall] = await subscribersMessagesUpdateAsSeen(
@@ -13,7 +13,9 @@ const args = {
13
13
 
14
14
  export const tool$subscribersNotificationsFeed: ToolDefinition<typeof args> = {
15
15
  name: "subscribers-notifications-feed",
16
- description: `Get in-app notification feed for a particular subscriber`,
16
+ description: `Retrieve subscriber notifications
17
+
18
+ Retrieve subscriber in-app (inbox) notifications by its unique key identifier **subscriberId**.`,
17
19
  args,
18
20
  tool: async (client, args, ctx) => {
19
21
  const [result, apiCall] = await subscribersNotificationsFeed(
@@ -15,7 +15,9 @@ export const tool$subscribersNotificationsUnseenCount: ToolDefinition<
15
15
  typeof args
16
16
  > = {
17
17
  name: "subscribers-notifications-unseen-count",
18
- description: `Get the unseen in-app notifications count for subscribers feed`,
18
+ description: `Retrieve unseen notifications count
19
+
20
+ Retrieve unseen in-app (inbox) notifications count for a subscriber by its unique key identifier **subscriberId**.`,
19
21
  args,
20
22
  tool: async (client, args, ctx) => {
21
23
  const [result, apiCall] = await subscribersNotificationsUnseenCount(
@@ -15,9 +15,10 @@ const args = {
15
15
 
16
16
  export const tool$subscribersPatch: ToolDefinition<typeof args> = {
17
17
  name: "subscribers-patch",
18
- description: `Patch subscriber
18
+ description: `Update a subscriber
19
19
 
20
- Patch subscriber by your internal id used to identify the subscriber`,
20
+ Update a subscriber by its unique key identifier **subscriberId**.
21
+ **subscriberId** is a required field, rest other fields are optional`,
21
22
  args,
22
23
  tool: async (client, args, ctx) => {
23
24
  const [result, apiCall] = await subscribersPatch(
@@ -13,9 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$subscribersPreferencesList: ToolDefinition<typeof args> = {
15
15
  name: "subscribers-preferences-list",
16
- description: `Get subscriber preferences
16
+ description: `Retrieve subscriber preferences
17
17
 
18
- Get subscriber global and workflow specific preferences`,
18
+ Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
19
+ This API returns all five channels preferences for all workflows and global preferences.`,
19
20
  args,
20
21
  tool: async (client, args, ctx) => {
21
22
  const [result, apiCall] = await subscribersPreferencesList(
@@ -16,9 +16,11 @@ const args = {
16
16
 
17
17
  export const tool$subscribersPreferencesUpdate: ToolDefinition<typeof args> = {
18
18
  name: "subscribers-preferences-update",
19
- description: `Update subscriber global or workflow specific preferences
19
+ description: `Update subscriber preferences
20
20
 
21
- Update subscriber global or workflow specific preferences`,
21
+ Update subscriber preferences by its unique key identifier **subscriberId**.
22
+ **workflowId** is optional field, if provided, this API will update that workflow preference,
23
+ otherwise it will update global preferences`,
22
24
  args,
23
25
  tool: async (client, args, ctx) => {
24
26
  const [result, apiCall] = await subscribersPreferencesUpdate(
@@ -20,7 +20,7 @@ export const tool$subscribersPropertiesUpdateOnlineFlag: ToolDefinition<
20
20
  name: "subscribers-properties-update-online-flag",
21
21
  description: `Update subscriber online status
22
22
 
23
- Used to update the subscriber isOnline flag.`,
23
+ Update the subscriber online status by its unique key identifier **subscriberId**`,
24
24
  args,
25
25
  tool: async (client, args, ctx) => {
26
26
  const [result, apiCall] = await subscribersPropertiesUpdateOnlineFlag(
@@ -13,9 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$subscribersRetrieve: ToolDefinition<typeof args> = {
15
15
  name: "subscribers-retrieve",
16
- description: `Get subscriber
16
+ description: `Retrieve a subscriber
17
17
 
18
- Get subscriber by your internal id used to identify the subscriber`,
18
+ Retrive a subscriber by its unique key identifier **subscriberId**.
19
+ **subscriberId** field is required.`,
19
20
  args,
20
21
  tool: async (client, args, ctx) => {
21
22
  const [result, apiCall] = await subscribersRetrieve(
@@ -13,7 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$subscribersSearch: ToolDefinition<typeof args> = {
15
15
  name: "subscribers-search",
16
- description: `Search for subscribers`,
16
+ description: `Search subscribers
17
+
18
+ Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
19
+ The search is case sensitive and supports pagination.Checkout all available filters in the query section.`,
17
20
  args,
18
21
  tool: async (client, args, ctx) => {
19
22
  const [result, apiCall] = await subscribersSearch(
@@ -13,9 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$subscribersTopicsList: ToolDefinition<typeof args> = {
15
15
  name: "subscribers-topics-list",
16
- description: `List topics a subscriber is subscribed to
16
+ description: `Retrieve subscriber subscriptions
17
17
 
18
- List topic subscriptions for a subscriber with pagination and filtering`,
18
+ Retrieve subscriber's topic subscriptions by its unique key identifier **subscriberId**.
19
+ Checkout all available filters in the query section.`,
19
20
  args,
20
21
  tool: async (client, args, ctx) => {
21
22
  const [result, apiCall] = await subscribersTopicsList(
@@ -15,7 +15,7 @@ const args = {
15
15
 
16
16
  export const tool$topicsCreate: ToolDefinition<typeof args> = {
17
17
  name: "topics-create",
18
- description: `Create or update a topic
18
+ description: `Create a topic
19
19
 
20
20
  Creates a new topic if it does not exist, or updates an existing topic if it already exists`,
21
21
  args,
@@ -13,7 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$topicsDelete: ToolDefinition<typeof args> = {
15
15
  name: "topics-delete",
16
- description: `Delete topic by key`,
16
+ description: `Delete a topic
17
+
18
+ Delete a topic by its unique key identifier **topicKey**.
19
+ This action is irreversible and will remove all subscriptions to the topic.`,
17
20
  args,
18
21
  tool: async (client, args, ctx) => {
19
22
  const [result, apiCall] = await topicsDelete(
@@ -13,7 +13,9 @@ const args = {
13
13
 
14
14
  export const tool$topicsGet: ToolDefinition<typeof args> = {
15
15
  name: "topics-get",
16
- description: `Get topic by key`,
16
+ description: `Retrieve a topic
17
+
18
+ Retrieve a topic by its unique key identifier **topicKey**`,
17
19
  args,
18
20
  tool: async (client, args, ctx) => {
19
21
  const [result, apiCall] = await topicsGet(
@@ -12,7 +12,11 @@ const args = {
12
12
 
13
13
  export const tool$topicsList: ToolDefinition<typeof args> = {
14
14
  name: "topics-list",
15
- description: `Get topics list`,
15
+ description: `List all topics
16
+
17
+ This api returns a paginated list of topics.
18
+ Topics can be filtered by **key**, **name**, or **includeCursor** to paginate through the list.
19
+ Checkout all available filters in the query section.`,
16
20
  args,
17
21
  tool: async (client, args, ctx) => {
18
22
  const [result, apiCall] = await topicsList(
@@ -16,8 +16,10 @@ const args = {
16
16
 
17
17
  export const tool$topicsSubscriptionsCreate: ToolDefinition<typeof args> = {
18
18
  name: "topics-subscriptions-create",
19
- description:
20
- `Create topic subscriptions, if the topic does not exist, it will be created.`,
19
+ description: `Create topic subscriptions
20
+
21
+ This api will create subscription for subscriberIds for a topic.
22
+ Its like subscribing to a common interest group. if topic does not exist, it will be created.`,
21
23
  args,
22
24
  tool: async (client, args, ctx) => {
23
25
  const [result, apiCall] = await topicsSubscriptionsCreate(
@@ -16,7 +16,9 @@ const args = {
16
16
 
17
17
  export const tool$topicsSubscriptionsDelete: ToolDefinition<typeof args> = {
18
18
  name: "topics-subscriptions-delete",
19
- description: `Delete topic subscriptions`,
19
+ description: `Delete topic subscriptions
20
+
21
+ Delete subscriptions for subscriberIds for a topic.`,
20
22
  args,
21
23
  tool: async (client, args, ctx) => {
22
24
  const [result, apiCall] = await topicsSubscriptionsDelete(
@@ -13,7 +13,10 @@ const args = {
13
13
 
14
14
  export const tool$topicsSubscriptionsList: ToolDefinition<typeof args> = {
15
15
  name: "topics-subscriptions-list",
16
- description: `List topic subscriptions`,
16
+ description: `List topic subscriptions
17
+
18
+ List all topics that a subscriber is subscribed to.
19
+ Checkout all available filters in the query section.`,
17
20
  args,
18
21
  tool: async (client, args, ctx) => {
19
22
  const [result, apiCall] = await topicsSubscriptionsList(
@@ -15,7 +15,9 @@ const args = {
15
15
 
16
16
  export const tool$topicsUpdate: ToolDefinition<typeof args> = {
17
17
  name: "topics-update",
18
- description: `Update topic by key`,
18
+ description: `Update a topic
19
+
20
+ Update a topic name by its unique key identifier **topicKey**`,
19
21
  args,
20
22
  tool: async (client, args, ctx) => {
21
23
  const [result, apiCall] = await topicsUpdate(
@@ -3,14 +3,12 @@
3
3
  */
4
4
 
5
5
  export * from "./activitiesresponsedto.js";
6
- export * from "./activitygraphstatesresponse.js";
7
6
  export * from "./activitynotificationexecutiondetailresponsedto.js";
8
7
  export * from "./activitynotificationjobresponsedto.js";
9
8
  export * from "./activitynotificationresponsedto.js";
10
9
  export * from "./activitynotificationstepresponsedto.js";
11
10
  export * from "./activitynotificationsubscriberresponsedto.js";
12
11
  export * from "./activitynotificationtemplateresponsedto.js";
13
- export * from "./activitystatsresponsedto.js";
14
12
  export * from "./activitytopicdto.js";
15
13
  export * from "./actorfeeditemdto.js";
16
14
  export * from "./actortypeenum.js";
@@ -124,7 +122,6 @@ export * from "./updatedsubscriberdto.js";
124
122
  export * from "./updateintegrationrequestdto.js";
125
123
  export * from "./updatesubscriberchannelrequestdto.js";
126
124
  export * from "./updatesubscriberonlineflagrequestdto.js";
127
- export * from "./updatesubscriberrequestdto.js";
128
125
  export * from "./updatetopicrequestdto.js";
129
126
  export * from "./workfloworiginenum.js";
130
127
  export * from "./workflowresponse.js";
@@ -79,7 +79,7 @@ export type NotificationFeedItemDto = {
79
79
  /**
80
80
  * Identifier for the feed associated with the notification.
81
81
  */
82
- feedId: string;
82
+ feedId?: string | null | undefined;
83
83
  /**
84
84
  * Identifier for the job that triggered the notification.
85
85
  */
@@ -188,7 +188,7 @@ export const NotificationFeedItemDto$inboundSchema: z.ZodType<
188
188
  _organizationId: z.string(),
189
189
  _notificationId: z.string(),
190
190
  _subscriberId: z.string(),
191
- _feedId: z.string(),
191
+ _feedId: z.nullable(z.string()).optional(),
192
192
  _jobId: z.string(),
193
193
  createdAt: z.nullable(
194
194
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -234,7 +234,7 @@ export type NotificationFeedItemDto$Outbound = {
234
234
  _organizationId: string;
235
235
  _notificationId: string;
236
236
  _subscriberId: string;
237
- _feedId: string;
237
+ _feedId?: string | null | undefined;
238
238
  _jobId: string;
239
239
  createdAt?: string | null | undefined;
240
240
  updatedAt?: string | null | undefined;
@@ -268,7 +268,7 @@ export const NotificationFeedItemDto$outboundSchema: z.ZodType<
268
268
  organizationId: z.string(),
269
269
  notificationId: z.string(),
270
270
  subscriberId: z.string(),
271
- feedId: z.string(),
271
+ feedId: z.nullable(z.string()).optional(),
272
272
  jobId: z.string(),
273
273
  createdAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
274
274
  updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
@@ -8,7 +8,6 @@ export * from "./eventscontrollertrigger.js";
8
8
  export * from "./eventscontrollertriggerbulk.js";
9
9
  export * from "./integrationscontrollercreateintegration.js";
10
10
  export * from "./integrationscontrollergetactiveintegrations.js";
11
- export * from "./integrationscontrollergetwebhooksupportstatus.js";
12
11
  export * from "./integrationscontrollerlistintegrations.js";
13
12
  export * from "./integrationscontrollerremoveintegration.js";
14
13
  export * from "./integrationscontrollersetintegrationasprimary.js";
@@ -16,8 +15,6 @@ export * from "./integrationscontrollerupdateintegrationbyid.js";
16
15
  export * from "./messagescontrollerdeletemessage.js";
17
16
  export * from "./messagescontrollerdeletemessagesbytransactionid.js";
18
17
  export * from "./messagescontrollergetmessages.js";
19
- export * from "./notificationscontrollergetactivitygraphstats.js";
20
- export * from "./notificationscontrollergetactivitystats.js";
21
18
  export * from "./notificationscontrollergetnotification.js";
22
19
  export * from "./notificationscontrollerlistnotifications.js";
23
20
  export * from "./subscriberscontrollercreatesubscriber.js";
@@ -29,17 +26,13 @@ export * from "./subscriberscontrollerremovesubscriber.js";
29
26
  export * from "./subscriberscontrollersearchsubscribers.js";
30
27
  export * from "./subscriberscontrollerupdatesubscriberpreferences.js";
31
28
  export * from "./subscribersv1controllerbulkcreatesubscribers.js";
32
- export * from "./subscribersv1controllerchataccessoauth.js";
33
- export * from "./subscribersv1controllerchatoauthcallback.js";
34
29
  export * from "./subscribersv1controllerdeletesubscribercredentials.js";
35
30
  export * from "./subscribersv1controllergetnotificationsfeed.js";
36
31
  export * from "./subscribersv1controllergetunseencount.js";
37
- export * from "./subscribersv1controllerlistsubscribers.js";
38
32
  export * from "./subscribersv1controllermarkactionasseen.js";
39
33
  export * from "./subscribersv1controllermarkallunreadasread.js";
40
34
  export * from "./subscribersv1controllermarkmessagesas.js";
41
35
  export * from "./subscribersv1controllermodifysubscriberchannel.js";
42
- export * from "./subscribersv1controllerupdatesubscriber.js";
43
36
  export * from "./subscribersv1controllerupdatesubscriberchannel.js";
44
37
  export * from "./subscribersv1controllerupdatesubscriberonlineflag.js";
45
38
  export * from "./topicscontrollercreatetopicsubscriptions.js";
@@ -12,10 +12,11 @@ import { unwrapAsync } from "../types/fp.js";
12
12
 
13
13
  export class Credentials extends ClientSDK {
14
14
  /**
15
- * Update subscriber credentials
15
+ * Update provider credentials
16
16
  *
17
17
  * @remarks
18
- * Subscriber credentials associated to the delivery methods such as slack and push tokens.
18
+ * Update credentials for a provider such as slack and push tokens.
19
+ * **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
19
20
  */
20
21
  async update(
21
22
  updateSubscriberChannelRequestDto:
@@ -36,11 +37,11 @@ export class Credentials extends ClientSDK {
36
37
  }
37
38
 
38
39
  /**
39
- * Modify subscriber credentials
40
+ * Upsert provider credentials
40
41
  *
41
42
  * @remarks
42
- * Subscriber credentials associated to the delivery methods such as slack and push tokens.
43
- * This endpoint appends provided credentials and deviceTokens to the existing ones.
43
+ * Update credentials for a provider such as **slack** and **FCM**.
44
+ * **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
44
45
  */
45
46
  async append(
46
47
  updateSubscriberChannelRequestDto:
@@ -61,10 +62,11 @@ export class Credentials extends ClientSDK {
61
62
  }
62
63
 
63
64
  /**
64
- * Delete subscriber credentials by providerId
65
+ * Delete provider credentials
65
66
  *
66
67
  * @remarks
67
- * Delete subscriber credentials such as slack and expo tokens.
68
+ * Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**.
69
+ * This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.
68
70
  */
69
71
  async delete(
70
72
  subscriberId: string,