@novu/api 1.2.0 → 1.3.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 (304) hide show
  1. package/FUNCTIONS.md +5 -22
  2. package/README.md +48 -74
  3. package/bin/mcp-server.js +289 -23
  4. package/bin/mcp-server.js.map +59 -57
  5. package/docs/sdks/credentials/README.md +15 -27
  6. package/docs/sdks/integrations/README.md +30 -54
  7. package/docs/sdks/messages/README.md +15 -27
  8. package/docs/sdks/notifications/README.md +10 -18
  9. package/docs/sdks/novu/README.md +44 -57
  10. package/docs/sdks/novumessages/README.md +15 -27
  11. package/docs/sdks/novunotifications/README.md +10 -18
  12. package/docs/sdks/novusubscribers/README.md +5 -9
  13. package/docs/sdks/novutopics/README.md +5 -9
  14. package/docs/sdks/preferences/README.md +10 -18
  15. package/docs/sdks/properties/README.md +5 -9
  16. package/docs/sdks/subscribers/README.md +34 -57
  17. package/docs/sdks/subscriptions/README.md +16 -28
  18. package/docs/sdks/topics/README.md +25 -45
  19. package/funcs/cancel.d.ts +1 -1
  20. package/funcs/cancel.d.ts.map +1 -1
  21. package/funcs/cancel.js +2 -0
  22. package/funcs/cancel.js.map +1 -1
  23. package/funcs/integrationsCreate.d.ts +1 -1
  24. package/funcs/integrationsCreate.d.ts.map +1 -1
  25. package/funcs/integrationsCreate.js +2 -0
  26. package/funcs/integrationsCreate.js.map +1 -1
  27. package/funcs/integrationsDelete.d.ts +1 -1
  28. package/funcs/integrationsDelete.d.ts.map +1 -1
  29. package/funcs/integrationsDelete.js +2 -0
  30. package/funcs/integrationsDelete.js.map +1 -1
  31. package/funcs/integrationsList.d.ts +1 -1
  32. package/funcs/integrationsList.d.ts.map +1 -1
  33. package/funcs/integrationsList.js +2 -0
  34. package/funcs/integrationsList.js.map +1 -1
  35. package/funcs/integrationsListActive.d.ts +1 -1
  36. package/funcs/integrationsListActive.d.ts.map +1 -1
  37. package/funcs/integrationsListActive.js +2 -0
  38. package/funcs/integrationsListActive.js.map +1 -1
  39. package/funcs/integrationsSetAsPrimary.d.ts +1 -1
  40. package/funcs/integrationsSetAsPrimary.d.ts.map +1 -1
  41. package/funcs/integrationsSetAsPrimary.js +2 -0
  42. package/funcs/integrationsSetAsPrimary.js.map +1 -1
  43. package/funcs/integrationsUpdate.d.ts +1 -1
  44. package/funcs/integrationsUpdate.d.ts.map +1 -1
  45. package/funcs/integrationsUpdate.js +2 -0
  46. package/funcs/integrationsUpdate.js.map +1 -1
  47. package/funcs/messagesDelete.d.ts +1 -1
  48. package/funcs/messagesDelete.d.ts.map +1 -1
  49. package/funcs/messagesDelete.js +2 -0
  50. package/funcs/messagesDelete.js.map +1 -1
  51. package/funcs/messagesDeleteByTransactionId.d.ts +1 -1
  52. package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
  53. package/funcs/messagesDeleteByTransactionId.js +2 -0
  54. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  55. package/funcs/messagesRetrieve.d.ts +1 -1
  56. package/funcs/messagesRetrieve.d.ts.map +1 -1
  57. package/funcs/messagesRetrieve.js +2 -0
  58. package/funcs/messagesRetrieve.js.map +1 -1
  59. package/funcs/notificationsList.d.ts +1 -1
  60. package/funcs/notificationsList.d.ts.map +1 -1
  61. package/funcs/notificationsList.js +2 -0
  62. package/funcs/notificationsList.js.map +1 -1
  63. package/funcs/notificationsRetrieve.d.ts +1 -1
  64. package/funcs/notificationsRetrieve.d.ts.map +1 -1
  65. package/funcs/notificationsRetrieve.js +2 -0
  66. package/funcs/notificationsRetrieve.js.map +1 -1
  67. package/funcs/subscribersCreate.d.ts +1 -1
  68. package/funcs/subscribersCreate.d.ts.map +1 -1
  69. package/funcs/subscribersCreate.js +2 -0
  70. package/funcs/subscribersCreate.js.map +1 -1
  71. package/funcs/subscribersCreateBulk.d.ts +1 -1
  72. package/funcs/subscribersCreateBulk.d.ts.map +1 -1
  73. package/funcs/subscribersCreateBulk.js +2 -0
  74. package/funcs/subscribersCreateBulk.js.map +1 -1
  75. package/funcs/subscribersCredentialsAppend.d.ts +1 -1
  76. package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
  77. package/funcs/subscribersCredentialsAppend.js +2 -0
  78. package/funcs/subscribersCredentialsAppend.js.map +1 -1
  79. package/funcs/subscribersCredentialsDelete.d.ts +1 -1
  80. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  81. package/funcs/subscribersCredentialsDelete.js +2 -0
  82. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  83. package/funcs/subscribersCredentialsUpdate.d.ts +1 -1
  84. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  85. package/funcs/subscribersCredentialsUpdate.js +2 -0
  86. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  87. package/funcs/subscribersDelete.d.ts +4 -3
  88. package/funcs/subscribersDelete.d.ts.map +1 -1
  89. package/funcs/subscribersDelete.js +5 -2
  90. package/funcs/subscribersDelete.js.map +1 -1
  91. package/funcs/subscribersMessagesMarkAll.d.ts +1 -1
  92. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  93. package/funcs/subscribersMessagesMarkAll.js +2 -0
  94. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  95. package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -1
  96. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  97. package/funcs/subscribersMessagesMarkAllAs.js +2 -0
  98. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  99. package/funcs/subscribersMessagesUpdateAsSeen.d.ts +1 -1
  100. package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  101. package/funcs/subscribersMessagesUpdateAsSeen.js +2 -0
  102. package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
  103. package/funcs/subscribersNotificationsFeed.d.ts +1 -1
  104. package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
  105. package/funcs/subscribersNotificationsFeed.js +2 -0
  106. package/funcs/subscribersNotificationsFeed.js.map +1 -1
  107. package/funcs/subscribersNotificationsUnseenCount.d.ts +1 -1
  108. package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  109. package/funcs/subscribersNotificationsUnseenCount.js +2 -0
  110. package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
  111. package/funcs/subscribersPatch.d.ts +1 -1
  112. package/funcs/subscribersPatch.d.ts.map +1 -1
  113. package/funcs/subscribersPatch.js +2 -0
  114. package/funcs/subscribersPatch.js.map +1 -1
  115. package/funcs/subscribersPreferencesList.d.ts +1 -1
  116. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  117. package/funcs/subscribersPreferencesList.js +2 -0
  118. package/funcs/subscribersPreferencesList.js.map +1 -1
  119. package/funcs/subscribersPreferencesUpdate.d.ts +1 -1
  120. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  121. package/funcs/subscribersPreferencesUpdate.js +2 -0
  122. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  123. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
  124. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
  125. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +2 -0
  126. package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  127. package/funcs/subscribersRetrieve.d.ts +2 -2
  128. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  129. package/funcs/subscribersRetrieve.js +3 -1
  130. package/funcs/subscribersRetrieve.js.map +1 -1
  131. package/funcs/subscribersSearch.d.ts +1 -1
  132. package/funcs/subscribersSearch.d.ts.map +1 -1
  133. package/funcs/subscribersSearch.js +2 -0
  134. package/funcs/subscribersSearch.js.map +1 -1
  135. package/funcs/subscribersTopicsList.d.ts +1 -1
  136. package/funcs/subscribersTopicsList.d.ts.map +1 -1
  137. package/funcs/subscribersTopicsList.js +2 -0
  138. package/funcs/subscribersTopicsList.js.map +1 -1
  139. package/funcs/topicsCreate.d.ts +1 -1
  140. package/funcs/topicsCreate.d.ts.map +1 -1
  141. package/funcs/topicsCreate.js +2 -0
  142. package/funcs/topicsCreate.js.map +1 -1
  143. package/funcs/topicsDelete.d.ts +1 -1
  144. package/funcs/topicsDelete.d.ts.map +1 -1
  145. package/funcs/topicsDelete.js +2 -0
  146. package/funcs/topicsDelete.js.map +1 -1
  147. package/funcs/topicsGet.d.ts +1 -1
  148. package/funcs/topicsGet.d.ts.map +1 -1
  149. package/funcs/topicsGet.js +2 -0
  150. package/funcs/topicsGet.js.map +1 -1
  151. package/funcs/topicsList.d.ts +1 -1
  152. package/funcs/topicsList.d.ts.map +1 -1
  153. package/funcs/topicsList.js +2 -0
  154. package/funcs/topicsList.js.map +1 -1
  155. package/funcs/topicsSubscribersRetrieve.d.ts +1 -1
  156. package/funcs/topicsSubscribersRetrieve.d.ts.map +1 -1
  157. package/funcs/topicsSubscribersRetrieve.js +2 -0
  158. package/funcs/topicsSubscribersRetrieve.js.map +1 -1
  159. package/funcs/topicsSubscriptionsCreate.d.ts +1 -1
  160. package/funcs/topicsSubscriptionsCreate.d.ts.map +1 -1
  161. package/funcs/topicsSubscriptionsCreate.js +2 -0
  162. package/funcs/topicsSubscriptionsCreate.js.map +1 -1
  163. package/funcs/topicsSubscriptionsDelete.d.ts +1 -1
  164. package/funcs/topicsSubscriptionsDelete.d.ts.map +1 -1
  165. package/funcs/topicsSubscriptionsDelete.js +2 -0
  166. package/funcs/topicsSubscriptionsDelete.js.map +1 -1
  167. package/funcs/topicsSubscriptionsList.d.ts +2 -2
  168. package/funcs/topicsSubscriptionsList.d.ts.map +1 -1
  169. package/funcs/topicsSubscriptionsList.js +3 -1
  170. package/funcs/topicsSubscriptionsList.js.map +1 -1
  171. package/funcs/topicsUpdate.d.ts +1 -1
  172. package/funcs/topicsUpdate.d.ts.map +1 -1
  173. package/funcs/topicsUpdate.js +2 -0
  174. package/funcs/topicsUpdate.js.map +1 -1
  175. package/funcs/trigger.d.ts +1 -1
  176. package/funcs/trigger.d.ts.map +1 -1
  177. package/funcs/trigger.js +5 -1
  178. package/funcs/trigger.js.map +1 -1
  179. package/funcs/triggerBroadcast.d.ts +1 -1
  180. package/funcs/triggerBroadcast.d.ts.map +1 -1
  181. package/funcs/triggerBroadcast.js +5 -1
  182. package/funcs/triggerBroadcast.js.map +1 -1
  183. package/funcs/triggerBulk.d.ts +1 -1
  184. package/funcs/triggerBulk.d.ts.map +1 -1
  185. package/funcs/triggerBulk.js +5 -1
  186. package/funcs/triggerBulk.js.map +1 -1
  187. package/hooks/types.d.ts +2 -0
  188. package/hooks/types.d.ts.map +1 -1
  189. package/index.d.ts +2 -0
  190. package/index.d.ts.map +1 -1
  191. package/index.js +3 -1
  192. package/index.js.map +1 -1
  193. package/jsr.json +1 -1
  194. package/lib/config.d.ts +7 -3
  195. package/lib/config.d.ts.map +1 -1
  196. package/lib/config.js +3 -3
  197. package/lib/config.js.map +1 -1
  198. package/lib/sdks.d.ts +1 -0
  199. package/lib/sdks.d.ts.map +1 -1
  200. package/lib/sdks.js +3 -3
  201. package/lib/sdks.js.map +1 -1
  202. package/mcp-server/mcp-server.js +1 -1
  203. package/mcp-server/server.js +1 -1
  204. package/mcp-server/tools/subscribersDelete.d.ts.map +1 -1
  205. package/mcp-server/tools/subscribersDelete.js +3 -2
  206. package/mcp-server/tools/subscribersDelete.js.map +1 -1
  207. package/mcp-server/tools/subscribersRetrieve.js +1 -1
  208. package/mcp-server/tools/topicsSubscriptionsList.js +1 -1
  209. package/models/components/index.d.ts +1 -0
  210. package/models/components/index.d.ts.map +1 -1
  211. package/models/components/index.js +1 -0
  212. package/models/components/index.js.map +1 -1
  213. package/models/components/notificationfeeditemdto.d.ts +2 -2
  214. package/models/components/notificationfeeditemdto.d.ts.map +1 -1
  215. package/models/components/notificationfeeditemdto.js +2 -2
  216. package/models/components/notificationfeeditemdto.js.map +1 -1
  217. package/models/components/payloadvalidationerrordto.d.ts +125 -0
  218. package/models/components/payloadvalidationerrordto.d.ts.map +1 -0
  219. package/models/components/payloadvalidationerrordto.js +160 -0
  220. package/models/components/payloadvalidationerrordto.js.map +1 -0
  221. package/models/components/updateintegrationrequestdto.d.ts +0 -5
  222. package/models/components/updateintegrationrequestdto.d.ts.map +1 -1
  223. package/models/components/updateintegrationrequestdto.js +0 -2
  224. package/models/components/updateintegrationrequestdto.js.map +1 -1
  225. package/models/errors/index.d.ts +1 -0
  226. package/models/errors/index.d.ts.map +1 -1
  227. package/models/errors/index.js +1 -0
  228. package/models/errors/index.js.map +1 -1
  229. package/models/errors/payloadvalidationexceptiondto.d.ts +222 -0
  230. package/models/errors/payloadvalidationexceptiondto.d.ts.map +1 -0
  231. package/models/errors/payloadvalidationexceptiondto.js +212 -0
  232. package/models/errors/payloadvalidationexceptiondto.js.map +1 -0
  233. package/models/errors/sdkerror.d.ts +14 -2
  234. package/models/errors/sdkerror.d.ts.map +1 -1
  235. package/models/errors/sdkerror.js +1 -1
  236. package/models/errors/sdkerror.js.map +1 -1
  237. package/package.json +1 -1
  238. package/sdk/subscribers.d.ts +4 -3
  239. package/sdk/subscribers.d.ts.map +1 -1
  240. package/sdk/subscribers.js +4 -3
  241. package/sdk/subscribers.js.map +1 -1
  242. package/sdk/subscriptions.d.ts +1 -1
  243. package/sdk/subscriptions.js +1 -1
  244. package/sources/json-development.json +227 -46
  245. package/src/funcs/cancel.ts +2 -6
  246. package/src/funcs/integrationsCreate.ts +2 -6
  247. package/src/funcs/integrationsDelete.ts +2 -6
  248. package/src/funcs/integrationsList.ts +2 -6
  249. package/src/funcs/integrationsListActive.ts +2 -6
  250. package/src/funcs/integrationsSetAsPrimary.ts +2 -6
  251. package/src/funcs/integrationsUpdate.ts +2 -6
  252. package/src/funcs/messagesDelete.ts +2 -6
  253. package/src/funcs/messagesDeleteByTransactionId.ts +2 -6
  254. package/src/funcs/messagesRetrieve.ts +2 -6
  255. package/src/funcs/notificationsList.ts +2 -6
  256. package/src/funcs/notificationsRetrieve.ts +2 -6
  257. package/src/funcs/subscribersCreate.ts +2 -6
  258. package/src/funcs/subscribersCreateBulk.ts +2 -6
  259. package/src/funcs/subscribersCredentialsAppend.ts +2 -6
  260. package/src/funcs/subscribersCredentialsDelete.ts +2 -6
  261. package/src/funcs/subscribersCredentialsUpdate.ts +2 -6
  262. package/src/funcs/subscribersDelete.ts +5 -8
  263. package/src/funcs/subscribersMessagesMarkAll.ts +2 -6
  264. package/src/funcs/subscribersMessagesMarkAllAs.ts +2 -6
  265. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +2 -6
  266. package/src/funcs/subscribersNotificationsFeed.ts +2 -6
  267. package/src/funcs/subscribersNotificationsUnseenCount.ts +2 -6
  268. package/src/funcs/subscribersPatch.ts +2 -6
  269. package/src/funcs/subscribersPreferencesList.ts +2 -6
  270. package/src/funcs/subscribersPreferencesUpdate.ts +2 -6
  271. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +2 -6
  272. package/src/funcs/subscribersRetrieve.ts +3 -7
  273. package/src/funcs/subscribersSearch.ts +2 -6
  274. package/src/funcs/subscribersTopicsList.ts +2 -6
  275. package/src/funcs/topicsCreate.ts +2 -6
  276. package/src/funcs/topicsDelete.ts +2 -6
  277. package/src/funcs/topicsGet.ts +2 -6
  278. package/src/funcs/topicsList.ts +2 -6
  279. package/src/funcs/topicsSubscribersRetrieve.ts +2 -6
  280. package/src/funcs/topicsSubscriptionsCreate.ts +2 -6
  281. package/src/funcs/topicsSubscriptionsDelete.ts +2 -6
  282. package/src/funcs/topicsSubscriptionsList.ts +3 -7
  283. package/src/funcs/topicsUpdate.ts +2 -6
  284. package/src/funcs/trigger.ts +9 -7
  285. package/src/funcs/triggerBroadcast.ts +9 -7
  286. package/src/funcs/triggerBulk.ts +9 -7
  287. package/src/hooks/types.ts +2 -0
  288. package/src/index.ts +2 -0
  289. package/src/lib/config.ts +7 -3
  290. package/src/lib/sdks.ts +10 -4
  291. package/src/mcp-server/mcp-server.ts +1 -1
  292. package/src/mcp-server/server.ts +1 -1
  293. package/src/mcp-server/tools/subscribersDelete.ts +3 -2
  294. package/src/mcp-server/tools/subscribersRetrieve.ts +1 -1
  295. package/src/mcp-server/tools/topicsSubscriptionsList.ts +1 -1
  296. package/src/models/components/index.ts +1 -0
  297. package/src/models/components/notificationfeeditemdto.ts +4 -4
  298. package/src/models/components/payloadvalidationerrordto.ts +299 -0
  299. package/src/models/components/updateintegrationrequestdto.ts +0 -7
  300. package/src/models/errors/index.ts +1 -0
  301. package/src/models/errors/payloadvalidationexceptiondto.ts +466 -0
  302. package/src/models/errors/sdkerror.ts +18 -3
  303. package/src/sdk/subscribers.ts +4 -3
  304. package/src/sdk/subscriptions.ts +1 -1

There are too many changes on this page to be displayed.

The amount of changes on this page would crash your brower.

You can still verify the content by downloading the package file manually.