@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.
- package/FUNCTIONS.md +2 -19
- package/README.md +82 -327
- package/bin/mcp-server.js +427 -1892
- package/bin/mcp-server.js.map +84 -110
- package/docs/sdks/credentials/README.md +13 -11
- package/docs/sdks/integrations/README.md +19 -14
- package/docs/sdks/messages/README.md +28 -24
- package/docs/sdks/notifications/README.md +9 -4
- package/docs/sdks/novu/README.md +16 -188
- package/docs/sdks/novumessages/README.md +16 -14
- package/docs/sdks/novunotifications/README.md +4 -4
- package/docs/sdks/novutopics/README.md +3 -2
- package/docs/sdks/preferences/README.md +7 -4
- package/docs/sdks/properties/README.md +1 -1
- package/docs/sdks/subscribers/README.md +15 -208
- package/docs/sdks/subscriptions/README.md +6 -4
- package/docs/sdks/topics/README.md +14 -15
- package/funcs/integrationsCreate.d.ts +3 -2
- package/funcs/integrationsCreate.d.ts.map +1 -1
- package/funcs/integrationsCreate.js +3 -2
- package/funcs/integrationsCreate.js.map +1 -1
- package/funcs/integrationsDelete.d.ts +5 -1
- package/funcs/integrationsDelete.d.ts.map +1 -1
- package/funcs/integrationsDelete.js +5 -1
- package/funcs/integrationsDelete.js.map +1 -1
- package/funcs/integrationsList.d.ts +2 -2
- package/funcs/integrationsList.js +2 -2
- package/funcs/integrationsListActive.d.ts +2 -2
- package/funcs/integrationsListActive.js +2 -2
- package/funcs/integrationsSetAsPrimary.d.ts +6 -1
- package/funcs/integrationsSetAsPrimary.d.ts.map +1 -1
- package/funcs/integrationsSetAsPrimary.js +6 -1
- package/funcs/integrationsSetAsPrimary.js.map +1 -1
- package/funcs/integrationsUpdate.d.ts +5 -1
- package/funcs/integrationsUpdate.d.ts.map +1 -1
- package/funcs/integrationsUpdate.js +5 -1
- package/funcs/integrationsUpdate.js.map +1 -1
- package/funcs/messagesDelete.d.ts +3 -2
- package/funcs/messagesDelete.d.ts.map +1 -1
- package/funcs/messagesDelete.js +3 -2
- package/funcs/messagesDelete.js.map +1 -1
- package/funcs/messagesDeleteByTransactionId.d.ts +2 -1
- package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
- package/funcs/messagesDeleteByTransactionId.js +2 -1
- package/funcs/messagesDeleteByTransactionId.js.map +1 -1
- package/funcs/messagesRetrieve.d.ts +4 -2
- package/funcs/messagesRetrieve.d.ts.map +1 -1
- package/funcs/messagesRetrieve.js +4 -2
- package/funcs/messagesRetrieve.js.map +1 -1
- package/funcs/notificationsList.d.ts +7 -1
- package/funcs/notificationsList.d.ts.map +1 -1
- package/funcs/notificationsList.js +7 -1
- package/funcs/notificationsList.js.map +1 -1
- package/funcs/notificationsRetrieve.d.ts +6 -1
- package/funcs/notificationsRetrieve.d.ts.map +1 -1
- package/funcs/notificationsRetrieve.js +6 -1
- package/funcs/notificationsRetrieve.js.map +1 -1
- package/funcs/subscribersCreate.d.ts +3 -2
- package/funcs/subscribersCreate.d.ts.map +1 -1
- package/funcs/subscribersCreate.js +3 -2
- package/funcs/subscribersCreate.js.map +1 -1
- package/funcs/subscribersCreateBulk.d.ts +1 -2
- package/funcs/subscribersCreateBulk.d.ts.map +1 -1
- package/funcs/subscribersCreateBulk.js +1 -2
- package/funcs/subscribersCreateBulk.js.map +1 -1
- package/funcs/subscribersCredentialsAppend.d.ts +3 -3
- package/funcs/subscribersCredentialsAppend.js +3 -3
- package/funcs/subscribersCredentialsDelete.d.ts +3 -2
- package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
- package/funcs/subscribersCredentialsDelete.js +3 -2
- package/funcs/subscribersCredentialsDelete.js.map +1 -1
- package/funcs/subscribersCredentialsUpdate.d.ts +3 -2
- package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
- package/funcs/subscribersCredentialsUpdate.js +3 -2
- package/funcs/subscribersCredentialsUpdate.js.map +1 -1
- package/funcs/subscribersDelete.d.ts +1 -1
- package/funcs/subscribersDelete.js +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts +4 -1
- package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAll.js +4 -1
- package/funcs/subscribersMessagesMarkAll.js.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts +5 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.js +5 -1
- package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts +5 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.js +5 -1
- package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts +4 -1
- package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
- package/funcs/subscribersNotificationsFeed.js +4 -1
- package/funcs/subscribersNotificationsFeed.js.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts +4 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.js +4 -1
- package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
- package/funcs/subscribersPatch.d.ts +3 -2
- package/funcs/subscribersPatch.d.ts.map +1 -1
- package/funcs/subscribersPatch.js +3 -2
- package/funcs/subscribersPatch.js.map +1 -1
- package/funcs/subscribersPreferencesList.d.ts +3 -2
- package/funcs/subscribersPreferencesList.d.ts.map +1 -1
- package/funcs/subscribersPreferencesList.js +3 -2
- package/funcs/subscribersPreferencesList.js.map +1 -1
- package/funcs/subscribersPreferencesUpdate.d.ts +4 -2
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +4 -2
- package/funcs/subscribersPreferencesUpdate.js.map +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.js +1 -1
- package/funcs/subscribersRetrieve.d.ts +3 -2
- package/funcs/subscribersRetrieve.d.ts.map +1 -1
- package/funcs/subscribersRetrieve.js +3 -2
- package/funcs/subscribersRetrieve.js.map +1 -1
- package/funcs/subscribersSearch.d.ts +5 -1
- package/funcs/subscribersSearch.d.ts.map +1 -1
- package/funcs/subscribersSearch.js +5 -1
- package/funcs/subscribersSearch.js.map +1 -1
- package/funcs/subscribersTopicsList.d.ts +3 -2
- package/funcs/subscribersTopicsList.d.ts.map +1 -1
- package/funcs/subscribersTopicsList.js +3 -2
- package/funcs/subscribersTopicsList.js.map +1 -1
- package/funcs/topicsCreate.d.ts +1 -1
- package/funcs/topicsCreate.js +1 -1
- package/funcs/topicsDelete.d.ts +5 -1
- package/funcs/topicsDelete.d.ts.map +1 -1
- package/funcs/topicsDelete.js +5 -1
- package/funcs/topicsDelete.js.map +1 -1
- package/funcs/topicsGet.d.ts +4 -1
- package/funcs/topicsGet.d.ts.map +1 -1
- package/funcs/topicsGet.js +4 -1
- package/funcs/topicsGet.js.map +1 -1
- package/funcs/topicsList.d.ts +6 -1
- package/funcs/topicsList.d.ts.map +1 -1
- package/funcs/topicsList.js +6 -1
- package/funcs/topicsList.js.map +1 -1
- package/funcs/topicsSubscriptionsCreate.d.ts +5 -1
- package/funcs/topicsSubscriptionsCreate.d.ts.map +1 -1
- package/funcs/topicsSubscriptionsCreate.js +5 -1
- package/funcs/topicsSubscriptionsCreate.js.map +1 -1
- package/funcs/topicsSubscriptionsDelete.d.ts +3 -0
- package/funcs/topicsSubscriptionsDelete.d.ts.map +1 -1
- package/funcs/topicsSubscriptionsDelete.js +3 -0
- package/funcs/topicsSubscriptionsDelete.js.map +1 -1
- package/funcs/topicsSubscriptionsList.d.ts +4 -0
- package/funcs/topicsSubscriptionsList.d.ts.map +1 -1
- package/funcs/topicsSubscriptionsList.js +4 -0
- package/funcs/topicsSubscriptionsList.js.map +1 -1
- package/funcs/topicsUpdate.d.ts +4 -1
- package/funcs/topicsUpdate.d.ts.map +1 -1
- package/funcs/topicsUpdate.js +4 -1
- package/funcs/topicsUpdate.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/lib/config.js.map +1 -1
- package/mcp-server/cli/start/impl.js +2 -2
- package/mcp-server/cli/start/impl.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +1 -15
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/integrationsCreate.d.ts.map +1 -1
- package/mcp-server/tools/integrationsCreate.js +3 -2
- package/mcp-server/tools/integrationsCreate.js.map +1 -1
- package/mcp-server/tools/integrationsDelete.d.ts.map +1 -1
- package/mcp-server/tools/integrationsDelete.js +4 -1
- package/mcp-server/tools/integrationsDelete.js.map +1 -1
- package/mcp-server/tools/integrationsList.js +2 -2
- package/mcp-server/tools/integrationsList.js.map +1 -1
- package/mcp-server/tools/integrationsListActive.js +2 -2
- package/mcp-server/tools/integrationsListActive.js.map +1 -1
- package/mcp-server/tools/integrationsSetAsPrimary.d.ts.map +1 -1
- package/mcp-server/tools/integrationsSetAsPrimary.js +5 -1
- package/mcp-server/tools/integrationsSetAsPrimary.js.map +1 -1
- package/mcp-server/tools/integrationsUpdate.d.ts.map +1 -1
- package/mcp-server/tools/integrationsUpdate.js +4 -1
- package/mcp-server/tools/integrationsUpdate.js.map +1 -1
- package/mcp-server/tools/messagesDelete.d.ts.map +1 -1
- package/mcp-server/tools/messagesDelete.js +3 -2
- package/mcp-server/tools/messagesDelete.js.map +1 -1
- package/mcp-server/tools/messagesDeleteByTransactionId.d.ts.map +1 -1
- package/mcp-server/tools/messagesDeleteByTransactionId.js +2 -1
- package/mcp-server/tools/messagesDeleteByTransactionId.js.map +1 -1
- package/mcp-server/tools/messagesRetrieve.d.ts.map +1 -1
- package/mcp-server/tools/messagesRetrieve.js +4 -2
- package/mcp-server/tools/messagesRetrieve.js.map +1 -1
- package/mcp-server/tools/notificationsList.d.ts.map +1 -1
- package/mcp-server/tools/notificationsList.js +6 -1
- package/mcp-server/tools/notificationsList.js.map +1 -1
- package/mcp-server/tools/notificationsRetrieve.d.ts.map +1 -1
- package/mcp-server/tools/notificationsRetrieve.js +5 -1
- package/mcp-server/tools/notificationsRetrieve.js.map +1 -1
- package/mcp-server/tools/subscribersCreate.d.ts.map +1 -1
- package/mcp-server/tools/subscribersCreate.js +3 -2
- package/mcp-server/tools/subscribersCreate.js.map +1 -1
- package/mcp-server/tools/subscribersCreateBulk.d.ts.map +1 -1
- package/mcp-server/tools/subscribersCreateBulk.js +1 -2
- package/mcp-server/tools/subscribersCreateBulk.js.map +1 -1
- package/mcp-server/tools/subscribersCredentialsAppend.js +3 -3
- package/mcp-server/tools/subscribersCredentialsAppend.js.map +1 -1
- package/mcp-server/tools/subscribersCredentialsDelete.d.ts.map +1 -1
- package/mcp-server/tools/subscribersCredentialsDelete.js +3 -2
- package/mcp-server/tools/subscribersCredentialsDelete.js.map +1 -1
- package/mcp-server/tools/subscribersCredentialsUpdate.d.ts.map +1 -1
- package/mcp-server/tools/subscribersCredentialsUpdate.js +3 -2
- package/mcp-server/tools/subscribersCredentialsUpdate.js.map +1 -1
- package/mcp-server/tools/subscribersDelete.js +1 -1
- package/mcp-server/tools/subscribersDelete.js.map +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAll.d.ts.map +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAll.js +3 -1
- package/mcp-server/tools/subscribersMessagesMarkAll.js.map +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAllAs.d.ts.map +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAllAs.js +4 -1
- package/mcp-server/tools/subscribersMessagesMarkAllAs.js.map +1 -1
- package/mcp-server/tools/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
- package/mcp-server/tools/subscribersMessagesUpdateAsSeen.js +4 -1
- package/mcp-server/tools/subscribersMessagesUpdateAsSeen.js.map +1 -1
- package/mcp-server/tools/subscribersNotificationsFeed.d.ts.map +1 -1
- package/mcp-server/tools/subscribersNotificationsFeed.js +3 -1
- package/mcp-server/tools/subscribersNotificationsFeed.js.map +1 -1
- package/mcp-server/tools/subscribersNotificationsUnseenCount.d.ts.map +1 -1
- package/mcp-server/tools/subscribersNotificationsUnseenCount.js +3 -1
- package/mcp-server/tools/subscribersNotificationsUnseenCount.js.map +1 -1
- package/mcp-server/tools/subscribersPatch.d.ts.map +1 -1
- package/mcp-server/tools/subscribersPatch.js +3 -2
- package/mcp-server/tools/subscribersPatch.js.map +1 -1
- package/mcp-server/tools/subscribersPreferencesList.d.ts.map +1 -1
- package/mcp-server/tools/subscribersPreferencesList.js +3 -2
- package/mcp-server/tools/subscribersPreferencesList.js.map +1 -1
- package/mcp-server/tools/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/mcp-server/tools/subscribersPreferencesUpdate.js +4 -2
- package/mcp-server/tools/subscribersPreferencesUpdate.js.map +1 -1
- package/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.js +1 -1
- package/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
- package/mcp-server/tools/subscribersRetrieve.d.ts.map +1 -1
- package/mcp-server/tools/subscribersRetrieve.js +3 -2
- package/mcp-server/tools/subscribersRetrieve.js.map +1 -1
- package/mcp-server/tools/subscribersSearch.d.ts.map +1 -1
- package/mcp-server/tools/subscribersSearch.js +4 -1
- package/mcp-server/tools/subscribersSearch.js.map +1 -1
- package/mcp-server/tools/subscribersTopicsList.d.ts.map +1 -1
- package/mcp-server/tools/subscribersTopicsList.js +3 -2
- package/mcp-server/tools/subscribersTopicsList.js.map +1 -1
- package/mcp-server/tools/topicsCreate.js +1 -1
- package/mcp-server/tools/topicsDelete.d.ts.map +1 -1
- package/mcp-server/tools/topicsDelete.js +4 -1
- package/mcp-server/tools/topicsDelete.js.map +1 -1
- package/mcp-server/tools/topicsGet.d.ts.map +1 -1
- package/mcp-server/tools/topicsGet.js +3 -1
- package/mcp-server/tools/topicsGet.js.map +1 -1
- package/mcp-server/tools/topicsList.d.ts.map +1 -1
- package/mcp-server/tools/topicsList.js +5 -1
- package/mcp-server/tools/topicsList.js.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsCreate.d.ts.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsCreate.js +4 -1
- package/mcp-server/tools/topicsSubscriptionsCreate.js.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsDelete.d.ts.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsDelete.js +3 -1
- package/mcp-server/tools/topicsSubscriptionsDelete.js.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsList.d.ts.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsList.js +4 -1
- package/mcp-server/tools/topicsSubscriptionsList.js.map +1 -1
- package/mcp-server/tools/topicsUpdate.d.ts.map +1 -1
- package/mcp-server/tools/topicsUpdate.js +3 -1
- package/mcp-server/tools/topicsUpdate.js.map +1 -1
- package/models/components/index.d.ts +0 -3
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +0 -3
- package/models/components/index.js.map +1 -1
- package/models/components/notificationfeeditemdto.d.ts +2 -2
- package/models/components/notificationfeeditemdto.d.ts.map +1 -1
- package/models/components/notificationfeeditemdto.js +2 -2
- package/models/components/notificationfeeditemdto.js.map +1 -1
- package/models/operations/index.d.ts +0 -7
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -7
- package/models/operations/index.js.map +1 -1
- package/package.json +2 -2
- package/sdk/credentials.d.ts +9 -7
- package/sdk/credentials.d.ts.map +1 -1
- package/sdk/credentials.js +9 -7
- package/sdk/credentials.js.map +1 -1
- package/sdk/integrations.d.ts +23 -12
- package/sdk/integrations.d.ts.map +1 -1
- package/sdk/integrations.js +23 -13
- package/sdk/integrations.js.map +1 -1
- package/sdk/messages.d.ts +9 -5
- package/sdk/messages.d.ts.map +1 -1
- package/sdk/messages.js +9 -5
- package/sdk/messages.js.map +1 -1
- package/sdk/notifications.d.ts +13 -5
- package/sdk/notifications.d.ts.map +1 -1
- package/sdk/notifications.js +13 -6
- package/sdk/notifications.js.map +1 -1
- package/sdk/novumessages.d.ts +14 -3
- package/sdk/novumessages.d.ts.map +1 -1
- package/sdk/novumessages.js +14 -3
- package/sdk/novumessages.js.map +1 -1
- package/sdk/novunotifications.d.ts +8 -2
- package/sdk/novunotifications.d.ts.map +1 -1
- package/sdk/novunotifications.js +8 -2
- package/sdk/novunotifications.js.map +1 -1
- package/sdk/novutopics.d.ts +3 -2
- package/sdk/novutopics.d.ts.map +1 -1
- package/sdk/novutopics.js +3 -2
- package/sdk/novutopics.js.map +1 -1
- package/sdk/preferences.d.ts +7 -4
- package/sdk/preferences.d.ts.map +1 -1
- package/sdk/preferences.js +7 -4
- package/sdk/preferences.js.map +1 -1
- package/sdk/properties.d.ts +1 -1
- package/sdk/properties.js +1 -1
- package/sdk/subscribers.d.ts +16 -30
- package/sdk/subscribers.d.ts.map +1 -1
- package/sdk/subscribers.js +16 -35
- package/sdk/subscribers.js.map +1 -1
- package/sdk/subscriptions.d.ts +12 -1
- package/sdk/subscriptions.d.ts.map +1 -1
- package/sdk/subscriptions.js +12 -1
- package/sdk/subscriptions.js.map +1 -1
- package/sdk/topics.d.ts +20 -5
- package/sdk/topics.d.ts.map +1 -1
- package/sdk/topics.js +20 -5
- package/sdk/topics.js.map +1 -1
- package/sources/json-development.json +2597 -5944
- package/src/funcs/integrationsCreate.ts +3 -2
- package/src/funcs/integrationsDelete.ts +5 -1
- package/src/funcs/integrationsList.ts +2 -2
- package/src/funcs/integrationsListActive.ts +2 -2
- package/src/funcs/integrationsSetAsPrimary.ts +6 -1
- package/src/funcs/integrationsUpdate.ts +5 -1
- package/src/funcs/messagesDelete.ts +3 -2
- package/src/funcs/messagesDeleteByTransactionId.ts +2 -1
- package/src/funcs/messagesRetrieve.ts +4 -2
- package/src/funcs/notificationsList.ts +7 -1
- package/src/funcs/notificationsRetrieve.ts +6 -1
- package/src/funcs/subscribersCreate.ts +3 -2
- package/src/funcs/subscribersCreateBulk.ts +1 -2
- package/src/funcs/subscribersCredentialsAppend.ts +3 -3
- package/src/funcs/subscribersCredentialsDelete.ts +3 -2
- package/src/funcs/subscribersCredentialsUpdate.ts +3 -2
- package/src/funcs/subscribersDelete.ts +1 -1
- package/src/funcs/subscribersMessagesMarkAll.ts +4 -1
- package/src/funcs/subscribersMessagesMarkAllAs.ts +5 -1
- package/src/funcs/subscribersMessagesUpdateAsSeen.ts +5 -1
- package/src/funcs/subscribersNotificationsFeed.ts +4 -1
- package/src/funcs/subscribersNotificationsUnseenCount.ts +4 -1
- package/src/funcs/subscribersPatch.ts +3 -2
- package/src/funcs/subscribersPreferencesList.ts +3 -2
- package/src/funcs/subscribersPreferencesUpdate.ts +4 -2
- package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
- package/src/funcs/subscribersRetrieve.ts +3 -2
- package/src/funcs/subscribersSearch.ts +5 -1
- package/src/funcs/subscribersTopicsList.ts +3 -2
- package/src/funcs/topicsCreate.ts +1 -1
- package/src/funcs/topicsDelete.ts +5 -1
- package/src/funcs/topicsGet.ts +4 -1
- package/src/funcs/topicsList.ts +6 -1
- package/src/funcs/topicsSubscriptionsCreate.ts +5 -1
- package/src/funcs/topicsSubscriptionsDelete.ts +3 -0
- package/src/funcs/topicsSubscriptionsList.ts +4 -0
- package/src/funcs/topicsUpdate.ts +4 -1
- package/src/lib/config.ts +4 -4
- package/src/mcp-server/cli/start/impl.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -15
- package/src/mcp-server/tools/integrationsCreate.ts +3 -2
- package/src/mcp-server/tools/integrationsDelete.ts +4 -1
- package/src/mcp-server/tools/integrationsList.ts +2 -2
- package/src/mcp-server/tools/integrationsListActive.ts +2 -2
- package/src/mcp-server/tools/integrationsSetAsPrimary.ts +5 -1
- package/src/mcp-server/tools/integrationsUpdate.ts +4 -1
- package/src/mcp-server/tools/messagesDelete.ts +3 -2
- package/src/mcp-server/tools/messagesDeleteByTransactionId.ts +2 -1
- package/src/mcp-server/tools/messagesRetrieve.ts +4 -2
- package/src/mcp-server/tools/notificationsList.ts +6 -1
- package/src/mcp-server/tools/notificationsRetrieve.ts +5 -1
- package/src/mcp-server/tools/subscribersCreate.ts +3 -2
- package/src/mcp-server/tools/subscribersCreateBulk.ts +1 -2
- package/src/mcp-server/tools/subscribersCredentialsAppend.ts +3 -3
- package/src/mcp-server/tools/subscribersCredentialsDelete.ts +3 -2
- package/src/mcp-server/tools/subscribersCredentialsUpdate.ts +3 -2
- package/src/mcp-server/tools/subscribersDelete.ts +1 -1
- package/src/mcp-server/tools/subscribersMessagesMarkAll.ts +3 -2
- package/src/mcp-server/tools/subscribersMessagesMarkAllAs.ts +4 -1
- package/src/mcp-server/tools/subscribersMessagesUpdateAsSeen.ts +4 -1
- package/src/mcp-server/tools/subscribersNotificationsFeed.ts +3 -1
- package/src/mcp-server/tools/subscribersNotificationsUnseenCount.ts +3 -1
- package/src/mcp-server/tools/subscribersPatch.ts +3 -2
- package/src/mcp-server/tools/subscribersPreferencesList.ts +3 -2
- package/src/mcp-server/tools/subscribersPreferencesUpdate.ts +4 -2
- package/src/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
- package/src/mcp-server/tools/subscribersRetrieve.ts +3 -2
- package/src/mcp-server/tools/subscribersSearch.ts +4 -1
- package/src/mcp-server/tools/subscribersTopicsList.ts +3 -2
- package/src/mcp-server/tools/topicsCreate.ts +1 -1
- package/src/mcp-server/tools/topicsDelete.ts +4 -1
- package/src/mcp-server/tools/topicsGet.ts +3 -1
- package/src/mcp-server/tools/topicsList.ts +5 -1
- package/src/mcp-server/tools/topicsSubscriptionsCreate.ts +4 -2
- package/src/mcp-server/tools/topicsSubscriptionsDelete.ts +3 -1
- package/src/mcp-server/tools/topicsSubscriptionsList.ts +4 -1
- package/src/mcp-server/tools/topicsUpdate.ts +3 -1
- package/src/models/components/index.ts +0 -3
- package/src/models/components/notificationfeeditemdto.ts +4 -4
- package/src/models/operations/index.ts +0 -7
- package/src/sdk/credentials.ts +9 -7
- package/src/sdk/integrations.ts +23 -15
- package/src/sdk/messages.ts +9 -5
- package/src/sdk/notifications.ts +13 -8
- package/src/sdk/novumessages.ts +14 -3
- package/src/sdk/novunotifications.ts +8 -2
- package/src/sdk/novutopics.ts +3 -2
- package/src/sdk/preferences.ts +7 -4
- package/src/sdk/properties.ts +1 -1
- package/src/sdk/subscribers.ts +16 -66
- package/src/sdk/subscriptions.ts +12 -1
- package/src/sdk/topics.ts +20 -5
- package/docs/sdks/authentication/README.md +0 -183
- package/docs/sdks/stats/README.md +0 -162
- package/docs/sdks/webhooks/README.md +0 -85
- package/funcs/integrationsWebhooksRetrieve.d.ts +0 -17
- package/funcs/integrationsWebhooksRetrieve.d.ts.map +0 -1
- package/funcs/integrationsWebhooksRetrieve.js +0 -143
- package/funcs/integrationsWebhooksRetrieve.js.map +0 -1
- package/funcs/notificationsStatsGraph.d.ts +0 -14
- package/funcs/notificationsStatsGraph.d.ts.map +0 -1
- package/funcs/notificationsStatsGraph.js +0 -141
- package/funcs/notificationsStatsGraph.js.map +0 -1
- package/funcs/notificationsStatsRetrieve.d.ts +0 -14
- package/funcs/notificationsStatsRetrieve.d.ts.map +0 -1
- package/funcs/notificationsStatsRetrieve.js +0 -134
- package/funcs/notificationsStatsRetrieve.js.map +0 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +0 -14
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +0 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.js +0 -148
- package/funcs/subscribersAuthenticationChatAccessOauth.js.map +0 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +0 -20
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +0 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +0 -154
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +0 -1
- package/funcs/subscribersList.d.ts +0 -20
- package/funcs/subscribersList.d.ts.map +0 -1
- package/funcs/subscribersList.js +0 -172
- package/funcs/subscribersList.js.map +0 -1
- package/funcs/subscribersUpsert.d.ts +0 -18
- package/funcs/subscribersUpsert.d.ts.map +0 -1
- package/funcs/subscribersUpsert.js +0 -148
- package/funcs/subscribersUpsert.js.map +0 -1
- package/mcp-server/tools/integrationsWebhooksRetrieve.d.ts +0 -9
- package/mcp-server/tools/integrationsWebhooksRetrieve.d.ts.map +0 -1
- package/mcp-server/tools/integrationsWebhooksRetrieve.js +0 -55
- package/mcp-server/tools/integrationsWebhooksRetrieve.js.map +0 -1
- package/mcp-server/tools/notificationsStatsGraph.d.ts +0 -9
- package/mcp-server/tools/notificationsStatsGraph.d.ts.map +0 -1
- package/mcp-server/tools/notificationsStatsGraph.js +0 -53
- package/mcp-server/tools/notificationsStatsGraph.js.map +0 -1
- package/mcp-server/tools/notificationsStatsRetrieve.d.ts +0 -8
- package/mcp-server/tools/notificationsStatsRetrieve.d.ts.map +0 -1
- package/mcp-server/tools/notificationsStatsRetrieve.js +0 -52
- package/mcp-server/tools/notificationsStatsRetrieve.js.map +0 -1
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.d.ts +0 -8
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.d.ts.map +0 -1
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js +0 -51
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js.map +0 -1
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.d.ts +0 -8
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +0 -1
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js +0 -52
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js.map +0 -1
- package/mcp-server/tools/subscribersList.d.ts +0 -10
- package/mcp-server/tools/subscribersList.d.ts.map +0 -1
- package/mcp-server/tools/subscribersList.js +0 -56
- package/mcp-server/tools/subscribersList.js.map +0 -1
- package/mcp-server/tools/subscribersUpsert.d.ts +0 -11
- package/mcp-server/tools/subscribersUpsert.d.ts.map +0 -1
- package/mcp-server/tools/subscribersUpsert.js +0 -57
- package/mcp-server/tools/subscribersUpsert.js.map +0 -1
- package/models/components/activitygraphstatesresponse.d.ts +0 -70
- package/models/components/activitygraphstatesresponse.d.ts.map +0 -1
- package/models/components/activitygraphstatesresponse.js +0 -97
- package/models/components/activitygraphstatesresponse.js.map +0 -1
- package/models/components/activitystatsresponsedto.d.ts +0 -31
- package/models/components/activitystatsresponsedto.d.ts.map +0 -1
- package/models/components/activitystatsresponsedto.js +0 -61
- package/models/components/activitystatsresponsedto.js.map +0 -1
- package/models/components/updatesubscriberrequestdto.d.ts +0 -72
- package/models/components/updatesubscriberrequestdto.d.ts.map +0 -1
- package/models/components/updatesubscriberrequestdto.js +0 -74
- package/models/components/updatesubscriberrequestdto.js.map +0 -1
- package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts +0 -65
- package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts.map +0 -1
- package/models/operations/integrationscontrollergetwebhooksupportstatus.js +0 -109
- package/models/operations/integrationscontrollergetwebhooksupportstatus.js.map +0 -1
- package/models/operations/notificationscontrollergetactivitygraphstats.d.ts +0 -66
- package/models/operations/notificationscontrollergetactivitygraphstats.d.ts.map +0 -1
- package/models/operations/notificationscontrollergetactivitygraphstats.js +0 -110
- package/models/operations/notificationscontrollergetactivitygraphstats.js.map +0 -1
- package/models/operations/notificationscontrollergetactivitystats.d.ts +0 -64
- package/models/operations/notificationscontrollergetactivitystats.d.ts.map +0 -1
- package/models/operations/notificationscontrollergetactivitystats.js +0 -108
- package/models/operations/notificationscontrollergetactivitystats.js.map +0 -1
- package/models/operations/subscribersv1controllerchataccessoauth.d.ts +0 -80
- package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +0 -1
- package/models/operations/subscribersv1controllerchataccessoauth.js +0 -113
- package/models/operations/subscribersv1controllerchataccessoauth.js.map +0 -1
- package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +0 -108
- package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +0 -1
- package/models/operations/subscribersv1controllerchatoauthcallback.js +0 -143
- package/models/operations/subscribersv1controllerchatoauthcallback.js.map +0 -1
- package/models/operations/subscribersv1controllerlistsubscribers.d.ts +0 -108
- package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +0 -1
- package/models/operations/subscribersv1controllerlistsubscribers.js +0 -145
- package/models/operations/subscribersv1controllerlistsubscribers.js.map +0 -1
- package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +0 -68
- package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +0 -1
- package/models/operations/subscribersv1controllerupdatesubscriber.js +0 -114
- package/models/operations/subscribersv1controllerupdatesubscriber.js.map +0 -1
- package/sdk/authentication.d.ts +0 -17
- package/sdk/authentication.d.ts.map +0 -1
- package/sdk/authentication.js +0 -28
- package/sdk/authentication.js.map +0 -1
- package/sdk/stats.d.ts +0 -13
- package/sdk/stats.d.ts.map +0 -1
- package/sdk/stats.js +0 -26
- package/sdk/stats.js.map +0 -1
- package/sdk/webhooks.d.ts +0 -12
- package/sdk/webhooks.d.ts.map +0 -1
- package/sdk/webhooks.js +0 -22
- package/sdk/webhooks.js.map +0 -1
- package/src/funcs/integrationsWebhooksRetrieve.ts +0 -238
- package/src/funcs/notificationsStatsGraph.ts +0 -230
- package/src/funcs/notificationsStatsRetrieve.ts +0 -218
- package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +0 -234
- package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +0 -250
- package/src/funcs/subscribersList.ts +0 -305
- package/src/funcs/subscribersUpsert.ts +0 -240
- package/src/mcp-server/tools/integrationsWebhooksRetrieve.ts +0 -39
- package/src/mcp-server/tools/notificationsStatsGraph.ts +0 -37
- package/src/mcp-server/tools/notificationsStatsRetrieve.ts +0 -35
- package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauth.ts +0 -36
- package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.ts +0 -38
- package/src/mcp-server/tools/subscribersList.ts +0 -41
- package/src/mcp-server/tools/subscribersUpsert.ts +0 -43
- package/src/models/components/activitygraphstatesresponse.ts +0 -118
- package/src/models/components/activitystatsresponsedto.ts +0 -70
- package/src/models/components/updatesubscriberrequestdto.ts +0 -124
- package/src/models/operations/integrationscontrollergetwebhooksupportstatus.ts +0 -182
- package/src/models/operations/notificationscontrollergetactivitygraphstats.ts +0 -183
- package/src/models/operations/notificationscontrollergetactivitystats.ts +0 -179
- package/src/models/operations/subscribersv1controllerchataccessoauth.ts +0 -200
- package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +0 -281
- package/src/models/operations/subscribersv1controllerlistsubscribers.ts +0 -283
- package/src/models/operations/subscribersv1controllerupdatesubscriber.ts +0 -191
- package/src/sdk/authentication.ts +0 -48
- package/src/sdk/stats.ts +0 -41
- 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: `
|
|
15
|
+
description: `List all integrations
|
|
16
16
|
|
|
17
|
-
|
|
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: `
|
|
15
|
+
description: `List active integrations
|
|
16
16
|
|
|
17
|
-
|
|
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: `
|
|
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
|
-
|
|
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
|
-
|
|
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: `
|
|
15
|
+
description: `List all messages
|
|
16
16
|
|
|
17
|
-
|
|
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: `
|
|
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: `
|
|
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
|
|
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
|
|
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: `
|
|
19
|
+
description: `Upsert provider credentials
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
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
|
|
17
|
+
description: `Delete provider credentials
|
|
18
18
|
|
|
19
|
-
Delete subscriber credentials such as slack and
|
|
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
|
|
19
|
+
description: `Update provider credentials
|
|
20
20
|
|
|
21
|
-
|
|
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
|
-
|
|
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: `
|
|
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: `
|
|
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: `
|
|
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: `
|
|
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: `
|
|
18
|
+
description: `Update a subscriber
|
|
19
19
|
|
|
20
|
-
|
|
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: `
|
|
16
|
+
description: `Retrieve subscriber preferences
|
|
17
17
|
|
|
18
|
-
|
|
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
|
|
19
|
+
description: `Update subscriber preferences
|
|
20
20
|
|
|
21
|
-
Update subscriber
|
|
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
|
-
|
|
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: `
|
|
16
|
+
description: `Retrieve a subscriber
|
|
17
17
|
|
|
18
|
-
|
|
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
|
|
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: `
|
|
16
|
+
description: `Retrieve subscriber subscriptions
|
|
17
17
|
|
|
18
|
-
|
|
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
|
|
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
|
|
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: `
|
|
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: `
|
|
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
|
-
|
|
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
|
|
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
|
|
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
|
|
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";
|
package/src/sdk/credentials.ts
CHANGED
|
@@ -12,10 +12,11 @@ import { unwrapAsync } from "../types/fp.js";
|
|
|
12
12
|
|
|
13
13
|
export class Credentials extends ClientSDK {
|
|
14
14
|
/**
|
|
15
|
-
* Update
|
|
15
|
+
* Update provider credentials
|
|
16
16
|
*
|
|
17
17
|
* @remarks
|
|
18
|
-
*
|
|
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
|
-
*
|
|
40
|
+
* Upsert provider credentials
|
|
40
41
|
*
|
|
41
42
|
* @remarks
|
|
42
|
-
*
|
|
43
|
-
*
|
|
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
|
|
65
|
+
* Delete provider credentials
|
|
65
66
|
*
|
|
66
67
|
* @remarks
|
|
67
|
-
* Delete subscriber credentials such as slack and
|
|
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,
|