@novu/api 1.0.0 → 1.2.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 (568) hide show
  1. package/FUNCTIONS.md +2 -19
  2. package/README.md +82 -327
  3. package/bin/mcp-server.js +1905 -3353
  4. package/bin/mcp-server.js.map +96 -113
  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/components/patchsubscriberrequestdto.d.ts +6 -26
  277. package/models/components/patchsubscriberrequestdto.d.ts.map +1 -1
  278. package/models/components/patchsubscriberrequestdto.js +3 -27
  279. package/models/components/patchsubscriberrequestdto.js.map +1 -1
  280. package/models/components/subscriberpayloaddto.d.ts +13 -13
  281. package/models/components/subscriberpayloaddto.d.ts.map +1 -1
  282. package/models/components/subscriberpayloaddto.js +17 -16
  283. package/models/components/subscriberpayloaddto.js.map +1 -1
  284. package/models/operations/index.d.ts +0 -7
  285. package/models/operations/index.d.ts.map +1 -1
  286. package/models/operations/index.js +0 -7
  287. package/models/operations/index.js.map +1 -1
  288. package/package.json +2 -2
  289. package/sdk/credentials.d.ts +9 -7
  290. package/sdk/credentials.d.ts.map +1 -1
  291. package/sdk/credentials.js +9 -7
  292. package/sdk/credentials.js.map +1 -1
  293. package/sdk/integrations.d.ts +23 -12
  294. package/sdk/integrations.d.ts.map +1 -1
  295. package/sdk/integrations.js +23 -13
  296. package/sdk/integrations.js.map +1 -1
  297. package/sdk/messages.d.ts +9 -5
  298. package/sdk/messages.d.ts.map +1 -1
  299. package/sdk/messages.js +9 -5
  300. package/sdk/messages.js.map +1 -1
  301. package/sdk/notifications.d.ts +13 -5
  302. package/sdk/notifications.d.ts.map +1 -1
  303. package/sdk/notifications.js +13 -6
  304. package/sdk/notifications.js.map +1 -1
  305. package/sdk/novumessages.d.ts +14 -3
  306. package/sdk/novumessages.d.ts.map +1 -1
  307. package/sdk/novumessages.js +14 -3
  308. package/sdk/novumessages.js.map +1 -1
  309. package/sdk/novunotifications.d.ts +8 -2
  310. package/sdk/novunotifications.d.ts.map +1 -1
  311. package/sdk/novunotifications.js +8 -2
  312. package/sdk/novunotifications.js.map +1 -1
  313. package/sdk/novutopics.d.ts +3 -2
  314. package/sdk/novutopics.d.ts.map +1 -1
  315. package/sdk/novutopics.js +3 -2
  316. package/sdk/novutopics.js.map +1 -1
  317. package/sdk/preferences.d.ts +7 -4
  318. package/sdk/preferences.d.ts.map +1 -1
  319. package/sdk/preferences.js +7 -4
  320. package/sdk/preferences.js.map +1 -1
  321. package/sdk/properties.d.ts +1 -1
  322. package/sdk/properties.js +1 -1
  323. package/sdk/subscribers.d.ts +16 -30
  324. package/sdk/subscribers.d.ts.map +1 -1
  325. package/sdk/subscribers.js +16 -35
  326. package/sdk/subscribers.js.map +1 -1
  327. package/sdk/subscriptions.d.ts +12 -1
  328. package/sdk/subscriptions.d.ts.map +1 -1
  329. package/sdk/subscriptions.js +12 -1
  330. package/sdk/subscriptions.js.map +1 -1
  331. package/sdk/topics.d.ts +20 -5
  332. package/sdk/topics.d.ts.map +1 -1
  333. package/sdk/topics.js +20 -5
  334. package/sdk/topics.js.map +1 -1
  335. package/sources/json-development.json +1928 -5272
  336. package/src/funcs/integrationsCreate.ts +3 -2
  337. package/src/funcs/integrationsDelete.ts +5 -1
  338. package/src/funcs/integrationsList.ts +2 -2
  339. package/src/funcs/integrationsListActive.ts +2 -2
  340. package/src/funcs/integrationsSetAsPrimary.ts +6 -1
  341. package/src/funcs/integrationsUpdate.ts +5 -1
  342. package/src/funcs/messagesDelete.ts +3 -2
  343. package/src/funcs/messagesDeleteByTransactionId.ts +2 -1
  344. package/src/funcs/messagesRetrieve.ts +4 -2
  345. package/src/funcs/notificationsList.ts +7 -1
  346. package/src/funcs/notificationsRetrieve.ts +6 -1
  347. package/src/funcs/subscribersCreate.ts +3 -2
  348. package/src/funcs/subscribersCreateBulk.ts +1 -2
  349. package/src/funcs/subscribersCredentialsAppend.ts +3 -3
  350. package/src/funcs/subscribersCredentialsDelete.ts +3 -2
  351. package/src/funcs/subscribersCredentialsUpdate.ts +3 -2
  352. package/src/funcs/subscribersDelete.ts +1 -1
  353. package/src/funcs/subscribersMessagesMarkAll.ts +4 -1
  354. package/src/funcs/subscribersMessagesMarkAllAs.ts +5 -1
  355. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +5 -1
  356. package/src/funcs/subscribersNotificationsFeed.ts +4 -1
  357. package/src/funcs/subscribersNotificationsUnseenCount.ts +4 -1
  358. package/src/funcs/subscribersPatch.ts +3 -2
  359. package/src/funcs/subscribersPreferencesList.ts +3 -2
  360. package/src/funcs/subscribersPreferencesUpdate.ts +4 -2
  361. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
  362. package/src/funcs/subscribersRetrieve.ts +3 -2
  363. package/src/funcs/subscribersSearch.ts +5 -1
  364. package/src/funcs/subscribersTopicsList.ts +3 -2
  365. package/src/funcs/topicsCreate.ts +1 -1
  366. package/src/funcs/topicsDelete.ts +5 -1
  367. package/src/funcs/topicsGet.ts +4 -1
  368. package/src/funcs/topicsList.ts +6 -1
  369. package/src/funcs/topicsSubscriptionsCreate.ts +5 -1
  370. package/src/funcs/topicsSubscriptionsDelete.ts +3 -0
  371. package/src/funcs/topicsSubscriptionsList.ts +4 -0
  372. package/src/funcs/topicsUpdate.ts +4 -1
  373. package/src/lib/config.ts +4 -4
  374. package/src/mcp-server/cli/start/impl.ts +2 -2
  375. package/src/mcp-server/mcp-server.ts +1 -1
  376. package/src/mcp-server/server.ts +1 -15
  377. package/src/mcp-server/tools/integrationsCreate.ts +3 -2
  378. package/src/mcp-server/tools/integrationsDelete.ts +4 -1
  379. package/src/mcp-server/tools/integrationsList.ts +2 -2
  380. package/src/mcp-server/tools/integrationsListActive.ts +2 -2
  381. package/src/mcp-server/tools/integrationsSetAsPrimary.ts +5 -1
  382. package/src/mcp-server/tools/integrationsUpdate.ts +4 -1
  383. package/src/mcp-server/tools/messagesDelete.ts +3 -2
  384. package/src/mcp-server/tools/messagesDeleteByTransactionId.ts +2 -1
  385. package/src/mcp-server/tools/messagesRetrieve.ts +4 -2
  386. package/src/mcp-server/tools/notificationsList.ts +6 -1
  387. package/src/mcp-server/tools/notificationsRetrieve.ts +5 -1
  388. package/src/mcp-server/tools/subscribersCreate.ts +3 -2
  389. package/src/mcp-server/tools/subscribersCreateBulk.ts +1 -2
  390. package/src/mcp-server/tools/subscribersCredentialsAppend.ts +3 -3
  391. package/src/mcp-server/tools/subscribersCredentialsDelete.ts +3 -2
  392. package/src/mcp-server/tools/subscribersCredentialsUpdate.ts +3 -2
  393. package/src/mcp-server/tools/subscribersDelete.ts +1 -1
  394. package/src/mcp-server/tools/subscribersMessagesMarkAll.ts +3 -2
  395. package/src/mcp-server/tools/subscribersMessagesMarkAllAs.ts +4 -1
  396. package/src/mcp-server/tools/subscribersMessagesUpdateAsSeen.ts +4 -1
  397. package/src/mcp-server/tools/subscribersNotificationsFeed.ts +3 -1
  398. package/src/mcp-server/tools/subscribersNotificationsUnseenCount.ts +3 -1
  399. package/src/mcp-server/tools/subscribersPatch.ts +3 -2
  400. package/src/mcp-server/tools/subscribersPreferencesList.ts +3 -2
  401. package/src/mcp-server/tools/subscribersPreferencesUpdate.ts +4 -2
  402. package/src/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
  403. package/src/mcp-server/tools/subscribersRetrieve.ts +3 -2
  404. package/src/mcp-server/tools/subscribersSearch.ts +4 -1
  405. package/src/mcp-server/tools/subscribersTopicsList.ts +3 -2
  406. package/src/mcp-server/tools/topicsCreate.ts +1 -1
  407. package/src/mcp-server/tools/topicsDelete.ts +4 -1
  408. package/src/mcp-server/tools/topicsGet.ts +3 -1
  409. package/src/mcp-server/tools/topicsList.ts +5 -1
  410. package/src/mcp-server/tools/topicsSubscriptionsCreate.ts +4 -2
  411. package/src/mcp-server/tools/topicsSubscriptionsDelete.ts +3 -1
  412. package/src/mcp-server/tools/topicsSubscriptionsList.ts +4 -1
  413. package/src/mcp-server/tools/topicsUpdate.ts +3 -1
  414. package/src/models/components/index.ts +0 -3
  415. package/src/models/components/notificationfeeditemdto.ts +4 -4
  416. package/src/models/components/patchsubscriberrequestdto.ts +4 -47
  417. package/src/models/components/subscriberpayloaddto.ts +19 -37
  418. package/src/models/operations/index.ts +0 -7
  419. package/src/sdk/credentials.ts +9 -7
  420. package/src/sdk/integrations.ts +23 -15
  421. package/src/sdk/messages.ts +9 -5
  422. package/src/sdk/notifications.ts +13 -8
  423. package/src/sdk/novumessages.ts +14 -3
  424. package/src/sdk/novunotifications.ts +8 -2
  425. package/src/sdk/novutopics.ts +3 -2
  426. package/src/sdk/preferences.ts +7 -4
  427. package/src/sdk/properties.ts +1 -1
  428. package/src/sdk/subscribers.ts +16 -66
  429. package/src/sdk/subscriptions.ts +12 -1
  430. package/src/sdk/topics.ts +20 -5
  431. package/docs/sdks/authentication/README.md +0 -183
  432. package/docs/sdks/stats/README.md +0 -162
  433. package/docs/sdks/webhooks/README.md +0 -85
  434. package/funcs/integrationsWebhooksRetrieve.d.ts +0 -17
  435. package/funcs/integrationsWebhooksRetrieve.d.ts.map +0 -1
  436. package/funcs/integrationsWebhooksRetrieve.js +0 -143
  437. package/funcs/integrationsWebhooksRetrieve.js.map +0 -1
  438. package/funcs/notificationsStatsGraph.d.ts +0 -14
  439. package/funcs/notificationsStatsGraph.d.ts.map +0 -1
  440. package/funcs/notificationsStatsGraph.js +0 -141
  441. package/funcs/notificationsStatsGraph.js.map +0 -1
  442. package/funcs/notificationsStatsRetrieve.d.ts +0 -14
  443. package/funcs/notificationsStatsRetrieve.d.ts.map +0 -1
  444. package/funcs/notificationsStatsRetrieve.js +0 -134
  445. package/funcs/notificationsStatsRetrieve.js.map +0 -1
  446. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +0 -14
  447. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +0 -1
  448. package/funcs/subscribersAuthenticationChatAccessOauth.js +0 -148
  449. package/funcs/subscribersAuthenticationChatAccessOauth.js.map +0 -1
  450. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +0 -20
  451. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +0 -1
  452. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +0 -154
  453. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +0 -1
  454. package/funcs/subscribersList.d.ts +0 -20
  455. package/funcs/subscribersList.d.ts.map +0 -1
  456. package/funcs/subscribersList.js +0 -172
  457. package/funcs/subscribersList.js.map +0 -1
  458. package/funcs/subscribersUpsert.d.ts +0 -18
  459. package/funcs/subscribersUpsert.d.ts.map +0 -1
  460. package/funcs/subscribersUpsert.js +0 -148
  461. package/funcs/subscribersUpsert.js.map +0 -1
  462. package/mcp-server/tools/integrationsWebhooksRetrieve.d.ts +0 -9
  463. package/mcp-server/tools/integrationsWebhooksRetrieve.d.ts.map +0 -1
  464. package/mcp-server/tools/integrationsWebhooksRetrieve.js +0 -55
  465. package/mcp-server/tools/integrationsWebhooksRetrieve.js.map +0 -1
  466. package/mcp-server/tools/notificationsStatsGraph.d.ts +0 -9
  467. package/mcp-server/tools/notificationsStatsGraph.d.ts.map +0 -1
  468. package/mcp-server/tools/notificationsStatsGraph.js +0 -53
  469. package/mcp-server/tools/notificationsStatsGraph.js.map +0 -1
  470. package/mcp-server/tools/notificationsStatsRetrieve.d.ts +0 -8
  471. package/mcp-server/tools/notificationsStatsRetrieve.d.ts.map +0 -1
  472. package/mcp-server/tools/notificationsStatsRetrieve.js +0 -52
  473. package/mcp-server/tools/notificationsStatsRetrieve.js.map +0 -1
  474. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.d.ts +0 -8
  475. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.d.ts.map +0 -1
  476. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js +0 -51
  477. package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js.map +0 -1
  478. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.d.ts +0 -8
  479. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +0 -1
  480. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js +0 -52
  481. package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js.map +0 -1
  482. package/mcp-server/tools/subscribersList.d.ts +0 -10
  483. package/mcp-server/tools/subscribersList.d.ts.map +0 -1
  484. package/mcp-server/tools/subscribersList.js +0 -56
  485. package/mcp-server/tools/subscribersList.js.map +0 -1
  486. package/mcp-server/tools/subscribersUpsert.d.ts +0 -11
  487. package/mcp-server/tools/subscribersUpsert.d.ts.map +0 -1
  488. package/mcp-server/tools/subscribersUpsert.js +0 -57
  489. package/mcp-server/tools/subscribersUpsert.js.map +0 -1
  490. package/models/components/activitygraphstatesresponse.d.ts +0 -70
  491. package/models/components/activitygraphstatesresponse.d.ts.map +0 -1
  492. package/models/components/activitygraphstatesresponse.js +0 -97
  493. package/models/components/activitygraphstatesresponse.js.map +0 -1
  494. package/models/components/activitystatsresponsedto.d.ts +0 -31
  495. package/models/components/activitystatsresponsedto.d.ts.map +0 -1
  496. package/models/components/activitystatsresponsedto.js +0 -61
  497. package/models/components/activitystatsresponsedto.js.map +0 -1
  498. package/models/components/updatesubscriberrequestdto.d.ts +0 -72
  499. package/models/components/updatesubscriberrequestdto.d.ts.map +0 -1
  500. package/models/components/updatesubscriberrequestdto.js +0 -74
  501. package/models/components/updatesubscriberrequestdto.js.map +0 -1
  502. package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts +0 -65
  503. package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts.map +0 -1
  504. package/models/operations/integrationscontrollergetwebhooksupportstatus.js +0 -109
  505. package/models/operations/integrationscontrollergetwebhooksupportstatus.js.map +0 -1
  506. package/models/operations/notificationscontrollergetactivitygraphstats.d.ts +0 -66
  507. package/models/operations/notificationscontrollergetactivitygraphstats.d.ts.map +0 -1
  508. package/models/operations/notificationscontrollergetactivitygraphstats.js +0 -110
  509. package/models/operations/notificationscontrollergetactivitygraphstats.js.map +0 -1
  510. package/models/operations/notificationscontrollergetactivitystats.d.ts +0 -64
  511. package/models/operations/notificationscontrollergetactivitystats.d.ts.map +0 -1
  512. package/models/operations/notificationscontrollergetactivitystats.js +0 -108
  513. package/models/operations/notificationscontrollergetactivitystats.js.map +0 -1
  514. package/models/operations/subscribersv1controllerchataccessoauth.d.ts +0 -80
  515. package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +0 -1
  516. package/models/operations/subscribersv1controllerchataccessoauth.js +0 -113
  517. package/models/operations/subscribersv1controllerchataccessoauth.js.map +0 -1
  518. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +0 -108
  519. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +0 -1
  520. package/models/operations/subscribersv1controllerchatoauthcallback.js +0 -143
  521. package/models/operations/subscribersv1controllerchatoauthcallback.js.map +0 -1
  522. package/models/operations/subscribersv1controllerlistsubscribers.d.ts +0 -108
  523. package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +0 -1
  524. package/models/operations/subscribersv1controllerlistsubscribers.js +0 -145
  525. package/models/operations/subscribersv1controllerlistsubscribers.js.map +0 -1
  526. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +0 -68
  527. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +0 -1
  528. package/models/operations/subscribersv1controllerupdatesubscriber.js +0 -114
  529. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +0 -1
  530. package/sdk/authentication.d.ts +0 -17
  531. package/sdk/authentication.d.ts.map +0 -1
  532. package/sdk/authentication.js +0 -28
  533. package/sdk/authentication.js.map +0 -1
  534. package/sdk/stats.d.ts +0 -13
  535. package/sdk/stats.d.ts.map +0 -1
  536. package/sdk/stats.js +0 -26
  537. package/sdk/stats.js.map +0 -1
  538. package/sdk/webhooks.d.ts +0 -12
  539. package/sdk/webhooks.d.ts.map +0 -1
  540. package/sdk/webhooks.js +0 -22
  541. package/sdk/webhooks.js.map +0 -1
  542. package/src/funcs/integrationsWebhooksRetrieve.ts +0 -238
  543. package/src/funcs/notificationsStatsGraph.ts +0 -230
  544. package/src/funcs/notificationsStatsRetrieve.ts +0 -218
  545. package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +0 -234
  546. package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +0 -250
  547. package/src/funcs/subscribersList.ts +0 -305
  548. package/src/funcs/subscribersUpsert.ts +0 -240
  549. package/src/mcp-server/tools/integrationsWebhooksRetrieve.ts +0 -39
  550. package/src/mcp-server/tools/notificationsStatsGraph.ts +0 -37
  551. package/src/mcp-server/tools/notificationsStatsRetrieve.ts +0 -35
  552. package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauth.ts +0 -36
  553. package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.ts +0 -38
  554. package/src/mcp-server/tools/subscribersList.ts +0 -41
  555. package/src/mcp-server/tools/subscribersUpsert.ts +0 -43
  556. package/src/models/components/activitygraphstatesresponse.ts +0 -118
  557. package/src/models/components/activitystatsresponsedto.ts +0 -70
  558. package/src/models/components/updatesubscriberrequestdto.ts +0 -124
  559. package/src/models/operations/integrationscontrollergetwebhooksupportstatus.ts +0 -182
  560. package/src/models/operations/notificationscontrollergetactivitygraphstats.ts +0 -183
  561. package/src/models/operations/notificationscontrollergetactivitystats.ts +0 -179
  562. package/src/models/operations/subscribersv1controllerchataccessoauth.ts +0 -200
  563. package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +0 -281
  564. package/src/models/operations/subscribersv1controllerlistsubscribers.ts +0 -283
  565. package/src/models/operations/subscribersv1controllerupdatesubscriber.ts +0 -191
  566. package/src/sdk/authentication.ts +0 -48
  567. package/src/sdk/stats.ts +0 -41
  568. package/src/sdk/webhooks.ts +0 -29
@@ -5,13 +5,14 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
- * [updateAsSeen](#updateasseen) - Mark message action as seen
9
- * [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen.
10
- * [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread
8
+ * [updateAsSeen](#updateasseen) - Update notification action status
9
+ * [markAll](#markall) - Update all notifications state
10
+ * [markAllAs](#markallas) - Update notifications state
11
11
 
12
12
  ## updateAsSeen
13
13
 
14
- Mark message action as seen
14
+ Update in-app (inbox) notification's action status by its unique key identifier **messageId** and type field **type**.
15
+ **type** field can be **primary** or **secondary**
15
16
 
16
17
  ### Example Usage
17
18
 
@@ -28,7 +29,7 @@ async function run() {
28
29
  type: "<value>",
29
30
  subscriberId: "<id>",
30
31
  markMessageActionAsSeenDto: {
31
- status: "done",
32
+ status: "pending",
32
33
  },
33
34
  });
34
35
 
@@ -59,7 +60,7 @@ async function run() {
59
60
  type: "<value>",
60
61
  subscriberId: "<id>",
61
62
  markMessageActionAsSeenDto: {
62
- status: "done",
63
+ status: "pending",
63
64
  },
64
65
  });
65
66
 
@@ -101,7 +102,7 @@ run();
101
102
 
102
103
  ## markAll
103
104
 
104
- Marks all the subscriber messages as read, unread, seen or unseen.
105
+ Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by **subscriberId**.
105
106
 
106
107
  ### Example Usage
107
108
 
@@ -114,7 +115,7 @@ const novu = new Novu({
114
115
 
115
116
  async function run() {
116
117
  const result = await novu.subscribers.messages.markAll({
117
- markAs: "seen",
118
+ markAs: "read",
118
119
  }, "<id>");
119
120
 
120
121
  // Handle the result
@@ -140,7 +141,7 @@ const novu = new NovuCore({
140
141
 
141
142
  async function run() {
142
143
  const res = await subscribersMessagesMarkAll(novu, {
143
- markAs: "seen",
144
+ markAs: "read",
144
145
  }, "<id>");
145
146
 
146
147
  if (!res.ok) {
@@ -183,7 +184,8 @@ run();
183
184
 
184
185
  ## markAllAs
185
186
 
186
- Mark a subscriber messages as seen, read, unseen or unread
187
+ Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by **subscriberId**.
188
+ **messageId** is of type mongodbId of notifications
187
189
 
188
190
  ### Example Usage
189
191
 
@@ -196,8 +198,8 @@ const novu = new Novu({
196
198
 
197
199
  async function run() {
198
200
  const result = await novu.subscribers.messages.markAllAs({
199
- messageId: "<id>",
200
- markAs: "unread",
201
+ messageId: [],
202
+ markAs: "seen",
201
203
  }, "<id>");
202
204
 
203
205
  // Handle the result
@@ -223,8 +225,8 @@ const novu = new NovuCore({
223
225
 
224
226
  async function run() {
225
227
  const res = await subscribersMessagesMarkAllAs(novu, {
226
- messageId: "<id>",
227
- markAs: "unread",
228
+ messageId: [],
229
+ markAs: "seen",
228
230
  }, "<id>");
229
231
 
230
232
  if (!res.ok) {
@@ -5,12 +5,12 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
- * [feed](#feed) - Get in-app notification feed for a particular subscriber
9
- * [unseenCount](#unseencount) - Get the unseen in-app notifications count for subscribers feed
8
+ * [feed](#feed) - Retrieve subscriber notifications
9
+ * [unseenCount](#unseencount) - Retrieve unseen notifications count
10
10
 
11
11
  ## feed
12
12
 
13
- Get in-app notification feed for a particular subscriber
13
+ Retrieve subscriber in-app (inbox) notifications by its unique key identifier **subscriberId**.
14
14
 
15
15
  ### Example Usage
16
16
 
@@ -92,7 +92,7 @@ run();
92
92
 
93
93
  ## unseenCount
94
94
 
95
- Get the unseen in-app notifications count for subscribers feed
95
+ Retrieve unseen in-app (inbox) notifications count for a subscriber by its unique key identifier **subscriberId**.
96
96
 
97
97
  ### Example Usage
98
98
 
@@ -5,11 +5,12 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
- * [list](#list) - List topics a subscriber is subscribed to
8
+ * [list](#list) - Retrieve subscriber subscriptions
9
9
 
10
10
  ## list
11
11
 
12
- List topic subscriptions for a subscriber with pagination and filtering
12
+ Retrieve subscriber's topic subscriptions by its unique key identifier **subscriberId**.
13
+ Checkout all available filters in the query section.
13
14
 
14
15
  ### Example Usage
15
16
 
@@ -5,12 +5,13 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
- * [list](#list) - Get subscriber preferences
9
- * [update](#update) - Update subscriber global or workflow specific preferences
8
+ * [list](#list) - Retrieve subscriber preferences
9
+ * [update](#update) - Update subscriber preferences
10
10
 
11
11
  ## list
12
12
 
13
- Get subscriber global and workflow specific preferences
13
+ Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
14
+ This API returns all five channels preferences for all workflows and global preferences.
14
15
 
15
16
  ### Example Usage
16
17
 
@@ -87,7 +88,9 @@ run();
87
88
 
88
89
  ## update
89
90
 
90
- Update subscriber global or workflow specific preferences
91
+ Update subscriber preferences by its unique key identifier **subscriberId**.
92
+ **workflowId** is optional field, if provided, this API will update that workflow preference,
93
+ otherwise it will update global preferences
91
94
 
92
95
  ### Example Usage
93
96
 
@@ -9,7 +9,7 @@
9
9
 
10
10
  ## updateOnlineFlag
11
11
 
12
- Used to update the subscriber isOnline flag.
12
+ Update the subscriber online status by its unique key identifier **subscriberId**
13
13
 
14
14
  ### Example Usage
15
15
 
@@ -3,23 +3,22 @@
3
3
 
4
4
  ## Overview
5
5
 
6
- A subscriber in Novu represents someone who should receive a message. A subscribers profile information contains important attributes about the subscriber that will be used in messages (name, email). The subscriber object can contain other key-value pairs that can be used to further personalize your messages.
6
+ A subscriber in Novu represents someone who should receive a message. A subscriber's profile information contains important attributes about the subscriber that will be used in messages (name, email). The subscriber object can contain other key-value pairs that can be used to further personalize your messages.
7
7
  <https://docs.novu.co/subscribers/subscribers>
8
8
 
9
9
  ### Available Operations
10
10
 
11
- * [search](#search) - Search for subscribers
12
- * [create](#create) - Create subscriber
13
- * [retrieve](#retrieve) - Get subscriber
14
- * [patch](#patch) - Patch subscriber
11
+ * [search](#search) - Search subscribers
12
+ * [create](#create) - Create a subscriber
13
+ * [retrieve](#retrieve) - Retrieve a subscriber
14
+ * [patch](#patch) - Update a subscriber
15
15
  * [delete](#delete) - Delete subscriber
16
- * [list](#list) - Get subscribers
17
- * [upsert](#upsert) - Upsert subscriber
18
16
  * [createBulk](#createbulk) - Bulk create subscribers
19
17
 
20
18
  ## search
21
19
 
22
- Search for subscribers
20
+ Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
21
+ The search is case sensitive and supports pagination.Checkout all available filters in the query section.
23
22
 
24
23
  ### Example Usage
25
24
 
@@ -95,7 +94,8 @@ run();
95
94
 
96
95
  ## create
97
96
 
98
- Create subscriber with the given data, if the subscriber already exists, it will be updated
97
+ Create a subscriber with the subscriber attributes.
98
+ **subscriberId** is a required field, rest other fields are optional, if the subscriber already exists, it will be updated
99
99
 
100
100
  ### Example Usage
101
101
 
@@ -176,7 +176,8 @@ run();
176
176
 
177
177
  ## retrieve
178
178
 
179
- Get subscriber by your internal id used to identify the subscriber
179
+ Retrive a subscriber by its unique key identifier **subscriberId**.
180
+ **subscriberId** field is required.
180
181
 
181
182
  ### Example Usage
182
183
 
@@ -253,7 +254,8 @@ run();
253
254
 
254
255
  ## patch
255
256
 
256
- Patch subscriber by your internal id used to identify the subscriber
257
+ Update a subscriber by its unique key identifier **subscriberId**.
258
+ **subscriberId** is a required field, rest other fields are optional
257
259
 
258
260
  ### Example Usage
259
261
 
@@ -331,7 +333,7 @@ run();
331
333
 
332
334
  ## delete
333
335
 
334
- Deletes a subscriber entity from the Novu platform
336
+ Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions
335
337
 
336
338
  ### Example Usage
337
339
 
@@ -406,205 +408,10 @@ run();
406
408
  | errors.ErrorDto | 500 | application/json |
407
409
  | errors.SDKError | 4XX, 5XX | \*/\* |
408
410
 
409
- ## list
410
-
411
- Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
412
-
413
- ### Example Usage
414
-
415
- ```typescript
416
- import { Novu } from "@novu/api";
417
-
418
- const novu = new Novu({
419
- secretKey: "YOUR_SECRET_KEY_HERE",
420
- });
421
-
422
- async function run() {
423
- const result = await novu.subscribers.list();
424
-
425
- for await (const page of result) {
426
- // Handle the page
427
- console.log(page);
428
- }
429
- }
430
-
431
- run();
432
- ```
433
-
434
- ### Standalone function
435
-
436
- The standalone function version of this method:
437
-
438
- ```typescript
439
- import { NovuCore } from "@novu/api/core.js";
440
- import { subscribersList } from "@novu/api/funcs/subscribersList.js";
441
-
442
- // Use `NovuCore` for best tree-shaking performance.
443
- // You can create one instance of it to use across an application.
444
- const novu = new NovuCore({
445
- secretKey: "YOUR_SECRET_KEY_HERE",
446
- });
447
-
448
- async function run() {
449
- const res = await subscribersList(novu);
450
-
451
- if (!res.ok) {
452
- throw res.error;
453
- }
454
-
455
- const { value: result } = res;
456
-
457
- for await (const page of result) {
458
- // Handle the page
459
- console.log(page);
460
- }
461
- }
462
-
463
- run();
464
- ```
465
-
466
- ### Parameters
467
-
468
- | Parameter | Type | Required | Description |
469
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
470
- | `page` | *number* | :heavy_minus_sign: | N/A |
471
- | `limit` | *number* | :heavy_minus_sign: | N/A |
472
- | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
473
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
474
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
475
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
476
-
477
- ### Response
478
-
479
- **Promise\<[operations.SubscribersV1ControllerListSubscribersResponse](../../models/operations/subscribersv1controllerlistsubscribersresponse.md)\>**
480
-
481
- ### Errors
482
-
483
- | Error Type | Status Code | Content Type |
484
- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
485
- | errors.ErrorDto | 414 | application/json |
486
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
487
- | errors.ValidationErrorDto | 422 | application/json |
488
- | errors.ErrorDto | 500 | application/json |
489
- | errors.SDKError | 4XX, 5XX | \*/\* |
490
-
491
- ## upsert
492
-
493
- Used to upsert the subscriber entity with new information
494
-
495
- ### Example Usage
496
-
497
- ```typescript
498
- import { Novu } from "@novu/api";
499
-
500
- const novu = new Novu({
501
- secretKey: "YOUR_SECRET_KEY_HERE",
502
- });
503
-
504
- async function run() {
505
- const result = await novu.subscribers.upsert({
506
- email: "john.doe@example.com",
507
- firstName: "John",
508
- lastName: "Doe",
509
- phone: "+1234567890",
510
- avatar: "https://example.com/avatar.jpg",
511
- locale: "en-US",
512
- data: {
513
- "preferences": {
514
- "notifications": true,
515
- "theme": "dark",
516
- },
517
- "tags": [
518
- "premium",
519
- "newsletter",
520
- ],
521
- },
522
- }, "<id>");
523
-
524
- // Handle the result
525
- console.log(result);
526
- }
527
-
528
- run();
529
- ```
530
-
531
- ### Standalone function
532
-
533
- The standalone function version of this method:
534
-
535
- ```typescript
536
- import { NovuCore } from "@novu/api/core.js";
537
- import { subscribersUpsert } from "@novu/api/funcs/subscribersUpsert.js";
538
-
539
- // Use `NovuCore` for best tree-shaking performance.
540
- // You can create one instance of it to use across an application.
541
- const novu = new NovuCore({
542
- secretKey: "YOUR_SECRET_KEY_HERE",
543
- });
544
-
545
- async function run() {
546
- const res = await subscribersUpsert(novu, {
547
- email: "john.doe@example.com",
548
- firstName: "John",
549
- lastName: "Doe",
550
- phone: "+1234567890",
551
- avatar: "https://example.com/avatar.jpg",
552
- locale: "en-US",
553
- data: {
554
- "preferences": {
555
- "notifications": true,
556
- "theme": "dark",
557
- },
558
- "tags": [
559
- "premium",
560
- "newsletter",
561
- ],
562
- },
563
- }, "<id>");
564
-
565
- if (!res.ok) {
566
- throw res.error;
567
- }
568
-
569
- const { value: result } = res;
570
-
571
- // Handle the result
572
- console.log(result);
573
- }
574
-
575
- run();
576
- ```
577
-
578
- ### Parameters
579
-
580
- | Parameter | Type | Required | Description |
581
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
582
- | `subscriberId` | *string* | :heavy_check_mark: | N/A |
583
- | `updateSubscriberRequestDto` | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md) | :heavy_check_mark: | N/A |
584
- | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
585
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
586
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
587
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
588
-
589
- ### Response
590
-
591
- **Promise\<[operations.SubscribersV1ControllerUpdateSubscriberResponse](../../models/operations/subscribersv1controllerupdatesubscriberresponse.md)\>**
592
-
593
- ### Errors
594
-
595
- | Error Type | Status Code | Content Type |
596
- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
597
- | errors.ErrorDto | 414 | application/json |
598
- | errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
599
- | errors.ValidationErrorDto | 422 | application/json |
600
- | errors.ErrorDto | 500 | application/json |
601
- | errors.SDKError | 4XX, 5XX | \*/\* |
602
-
603
411
  ## createBulk
604
412
 
605
413
 
606
- Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
607
- The bulk API is limited to 500 subscribers per request.
414
+ Using this endpoint multiple subscribers can be created at once. The bulk API is limited to 500 subscribers per request.
608
415
 
609
416
 
610
417
  ### Example Usage
@@ -6,12 +6,13 @@
6
6
  ### Available Operations
7
7
 
8
8
  * [list](#list) - List topic subscriptions
9
- * [create](#create) - Create topic subscriptions, if the topic does not exist, it will be created.
9
+ * [create](#create) - Create topic subscriptions
10
10
  * [delete](#delete) - Delete topic subscriptions
11
11
 
12
12
  ## list
13
13
 
14
- List topic subscriptions
14
+ List all topics that a subscriber is subscribed to.
15
+ Checkout all available filters in the query section.
15
16
 
16
17
  ### Example Usage
17
18
 
@@ -91,7 +92,8 @@ run();
91
92
 
92
93
  ## create
93
94
 
94
- Create topic subscriptions, if the topic does not exist, it will be created.
95
+ This api will create subscription for subscriberIds for a topic.
96
+ Its like subscribing to a common interest group. if topic does not exist, it will be created.
95
97
 
96
98
  ### Example Usage
97
99
 
@@ -179,7 +181,7 @@ run();
179
181
 
180
182
  ## delete
181
183
 
182
- Delete topic subscriptions
184
+ Delete subscriptions for subscriberIds for a topic.
183
185
 
184
186
  ### Example Usage
185
187
 
@@ -8,15 +8,17 @@ Topics are a way to group subscribers together so that they can be notified of e
8
8
 
9
9
  ### Available Operations
10
10
 
11
- * [list](#list) - Get topics list
12
- * [create](#create) - Create or update a topic
13
- * [get](#get) - Get topic by key
14
- * [update](#update) - Update topic by key
15
- * [delete](#delete) - Delete topic by key
11
+ * [list](#list) - List all topics
12
+ * [create](#create) - Create a topic
13
+ * [get](#get) - Retrieve a topic
14
+ * [update](#update) - Update a topic
15
+ * [delete](#delete) - Delete a topic
16
16
 
17
17
  ## list
18
18
 
19
- Get topics list
19
+ This api returns a paginated list of topics.
20
+ Topics can be filtered by **key**, **name**, or **includeCursor** to paginate through the list.
21
+ Checkout all available filters in the query section.
20
22
 
21
23
  ### Example Usage
22
24
 
@@ -28,9 +30,7 @@ const novu = new Novu({
28
30
  });
29
31
 
30
32
  async function run() {
31
- const result = await novu.topics.list({
32
- key: "exampleKey",
33
- });
33
+ const result = await novu.topics.list({});
34
34
 
35
35
  // Handle the result
36
36
  console.log(result);
@@ -54,9 +54,7 @@ const novu = new NovuCore({
54
54
  });
55
55
 
56
56
  async function run() {
57
- const res = await topicsList(novu, {
58
- key: "exampleKey",
59
- });
57
+ const res = await topicsList(novu, {});
60
58
 
61
59
  if (!res.ok) {
62
60
  throw res.error;
@@ -179,7 +177,7 @@ run();
179
177
 
180
178
  ## get
181
179
 
182
- Get topic by key
180
+ Retrieve a topic by its unique key identifier **topicKey**
183
181
 
184
182
  ### Example Usage
185
183
 
@@ -256,7 +254,7 @@ run();
256
254
 
257
255
  ## update
258
256
 
259
- Update topic by key
257
+ Update a topic name by its unique key identifier **topicKey**
260
258
 
261
259
  ### Example Usage
262
260
 
@@ -338,7 +336,8 @@ run();
338
336
 
339
337
  ## delete
340
338
 
341
- Delete topic by key
339
+ Delete a topic by its unique key identifier **topicKey**.
340
+ This action is irreversible and will remove all subscriptions to the topic.
342
341
 
343
342
  ### Example Usage
344
343
 
@@ -9,10 +9,11 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Create integration
12
+ * Create an integration
13
13
  *
14
14
  * @remarks
15
- * Create an integration for the current environment the user is based on the API key provided
15
+ * Create an integration for the current environment the user is based on the API key provided.
16
+ * Each provider supports different credentials, check the provider documentation for more details.
16
17
  */
17
18
  export declare function integrationsCreate(client: NovuCore, createIntegrationRequestDto: components.CreateIntegrationRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.IntegrationsControllerCreateIntegrationResponse, errors.ErrorDto | errors.ErrorDto | errors.ValidationErrorDto | errors.ErrorDto | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
18
19
  //# sourceMappingURL=integrationsCreate.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"integrationsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/integrationsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,QAAQ,EAChB,2BAA2B,EAAE,UAAU,CAAC,2BAA2B,EACnE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,+CAA+C,EACxD,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,MAAM,CAAC,QAAQ,GACf,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAOA"}
1
+ {"version":3,"file":"integrationsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/integrationsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,QAAQ,EAChB,2BAA2B,EAAE,UAAU,CAAC,2BAA2B,EACnE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,+CAA+C,EACxD,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,MAAM,CAAC,QAAQ,GACf,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAOA"}
@@ -37,10 +37,11 @@ const errors = __importStar(require("../models/errors/index.js"));
37
37
  const operations = __importStar(require("../models/operations/index.js"));
38
38
  const async_js_1 = require("../types/async.js");
39
39
  /**
40
- * Create integration
40
+ * Create an integration
41
41
  *
42
42
  * @remarks
43
- * Create an integration for the current environment the user is based on the API key provided
43
+ * Create an integration for the current environment the user is based on the API key provided.
44
+ * Each provider supports different credentials, check the provider documentation for more details.
44
45
  */
45
46
  function integrationsCreate(client, createIntegrationRequestDto, idempotencyKey, options) {
46
47
  return new async_js_1.APIPromise($do(client, createIntegrationRequestDto, idempotencyKey, options));
@@ -1 +1 @@
1
- {"version":3,"file":"integrationsCreate.js","sourceRoot":"","sources":["../src/funcs/integrationsCreate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sDAA+D;AAC/D,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,kEAAoD;AAGpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,MAAgB,EAChB,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;IAiBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,2BAA2B,EAC3B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AA3BD,gDA2BC;AAED,KAAK,UAAU,GAAG,CAChB,MAAgB,EAChB,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;IAoBxB,MAAM,KAAK,GAA8D;QACvE,2BAA2B,EAAE,2BAA2B;QACxD,cAAc,EAAE,cAAc;KAC/B,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,6DAA6D;SACrE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,CAAC,2BAA2B,EAAE;QACnE,OAAO,EAAE,IAAI;KACd,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,kBAAkB,CAAC,EAAE,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;QAC1B,iBAAiB,EAAE,IAAA,2BAAY,EAC7B,iBAAiB,EACjB,OAAO,CAAC,iBAAiB,CAAC,EAC1B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;IACxE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,0CAA0C;QACvD,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B;gBACD,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE;oBACP,eAAe,EAAE,IAAI;oBACrB,WAAW,EAAE,KAAK;oBAClB,QAAQ,EAAE,GAAG;oBACb,cAAc,EAAE,OAAO;iBACxB;gBACD,qBAAqB,EAAE,IAAI;aAC5B;eACE,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KAChE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE;YACV,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;QACD,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAc5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,6DAA6D,EACxE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,sBAAsB,CAAC,EAC7C,CAAC,CAAC,OAAO,CACP,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACxC,MAAM,CAAC,sBAAsB,EAC7B,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACvE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EACX,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAC7D,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EACX,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
1
+ {"version":3,"file":"integrationsCreate.js","sourceRoot":"","sources":["../src/funcs/integrationsCreate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sDAA+D;AAC/D,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,kEAAoD;AAGpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,MAAgB,EAChB,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;IAiBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,2BAA2B,EAC3B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AA3BD,gDA2BC;AAED,KAAK,UAAU,GAAG,CAChB,MAAgB,EAChB,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;IAoBxB,MAAM,KAAK,GAA8D;QACvE,2BAA2B,EAAE,2BAA2B;QACxD,cAAc,EAAE,cAAc;KAC/B,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,6DAA6D;SACrE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,CAAC,2BAA2B,EAAE;QACnE,OAAO,EAAE,IAAI;KACd,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,kBAAkB,CAAC,EAAE,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;QAC1B,iBAAiB,EAAE,IAAA,2BAAY,EAC7B,iBAAiB,EACjB,OAAO,CAAC,iBAAiB,CAAC,EAC1B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;IACxE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,0CAA0C;QACvD,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B;gBACD,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE;oBACP,eAAe,EAAE,IAAI;oBACrB,WAAW,EAAE,KAAK;oBAClB,QAAQ,EAAE,GAAG;oBACb,cAAc,EAAE,OAAO;iBACxB;gBACD,qBAAqB,EAAE,IAAI;aAC5B;eACE,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KAChE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE;YACV,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;QACD,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAc5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,6DAA6D,EACxE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,sBAAsB,CAAC,EAC7C,CAAC,CAAC,OAAO,CACP,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACxC,MAAM,CAAC,sBAAsB,EAC7B,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACvE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EACX,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAC7D,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EACX,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
@@ -8,7 +8,11 @@ import * as operations from "../models/operations/index.js";
8
8
  import { APIPromise } from "../types/async.js";
9
9
  import { Result } from "../types/fp.js";
10
10
  /**
11
- * Delete integration
11
+ * Delete an integration
12
+ *
13
+ * @remarks
14
+ * Delete an integration by its unique key identifier **integrationId**.
15
+ * This action is irreversible.
12
16
  */
13
17
  export declare function integrationsDelete(client: NovuCore, integrationId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.IntegrationsControllerRemoveIntegrationResponse, errors.ErrorDto | errors.ErrorDto | errors.ValidationErrorDto | errors.ErrorDto | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
14
18
  //# sourceMappingURL=integrationsDelete.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"integrationsDelete.d.ts","sourceRoot":"","sources":["../src/funcs/integrationsDelete.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,QAAQ,EAChB,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,+CAA+C,EACxD,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,MAAM,CAAC,QAAQ,GACf,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAOA"}
1
+ {"version":3,"file":"integrationsDelete.d.ts","sourceRoot":"","sources":["../src/funcs/integrationsDelete.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,QAAQ,EAChB,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,+CAA+C,EACxD,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,MAAM,CAAC,QAAQ,GACf,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAOA"}