@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.
- package/FUNCTIONS.md +2 -19
- package/README.md +82 -327
- package/bin/mcp-server.js +1905 -3353
- package/bin/mcp-server.js.map +96 -113
- 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/components/patchsubscriberrequestdto.d.ts +6 -26
- package/models/components/patchsubscriberrequestdto.d.ts.map +1 -1
- package/models/components/patchsubscriberrequestdto.js +3 -27
- package/models/components/patchsubscriberrequestdto.js.map +1 -1
- package/models/components/subscriberpayloaddto.d.ts +13 -13
- package/models/components/subscriberpayloaddto.d.ts.map +1 -1
- package/models/components/subscriberpayloaddto.js +17 -16
- package/models/components/subscriberpayloaddto.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 +1928 -5272
- 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/components/patchsubscriberrequestdto.ts +4 -47
- package/src/models/components/subscriberpayloaddto.ts +19 -37
- 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
|
@@ -5,13 +5,14 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [updateAsSeen](#updateasseen) -
|
|
9
|
-
* [markAll](#markall) -
|
|
10
|
-
* [markAllAs](#markallas) -
|
|
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
|
-
|
|
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: "
|
|
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: "
|
|
63
|
+
status: "pending",
|
|
63
64
|
},
|
|
64
65
|
});
|
|
65
66
|
|
|
@@ -101,7 +102,7 @@ run();
|
|
|
101
102
|
|
|
102
103
|
## markAll
|
|
103
104
|
|
|
104
|
-
|
|
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: "
|
|
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: "
|
|
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
|
-
|
|
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:
|
|
200
|
-
markAs: "
|
|
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:
|
|
227
|
-
markAs: "
|
|
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) -
|
|
9
|
-
* [unseenCount](#unseencount) -
|
|
8
|
+
* [feed](#feed) - Retrieve subscriber notifications
|
|
9
|
+
* [unseenCount](#unseencount) - Retrieve unseen notifications count
|
|
10
10
|
|
|
11
11
|
## feed
|
|
12
12
|
|
|
13
|
-
|
|
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
|
-
|
|
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) -
|
|
8
|
+
* [list](#list) - Retrieve subscriber subscriptions
|
|
9
9
|
|
|
10
10
|
## list
|
|
11
11
|
|
|
12
|
-
|
|
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) -
|
|
9
|
-
* [update](#update) - Update subscriber
|
|
8
|
+
* [list](#list) - Retrieve subscriber preferences
|
|
9
|
+
* [update](#update) - Update subscriber preferences
|
|
10
10
|
|
|
11
11
|
## list
|
|
12
12
|
|
|
13
|
-
|
|
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
|
|
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
|
|
|
@@ -3,23 +3,22 @@
|
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
|
-
A subscriber in Novu represents someone who should receive a message. A subscriber
|
|
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
|
|
12
|
-
* [create](#create) - Create subscriber
|
|
13
|
-
* [retrieve](#retrieve) -
|
|
14
|
-
* [patch](#patch) -
|
|
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
|
|
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
|
|
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
|
-
|
|
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
|
-
|
|
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
|
|
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
|
|
9
|
+
* [create](#create) - Create topic subscriptions
|
|
10
10
|
* [delete](#delete) - Delete topic subscriptions
|
|
11
11
|
|
|
12
12
|
## list
|
|
13
13
|
|
|
14
|
-
List
|
|
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
|
-
|
|
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
|
|
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) -
|
|
12
|
-
* [create](#create) - Create
|
|
13
|
-
* [get](#get) -
|
|
14
|
-
* [update](#update) - Update topic
|
|
15
|
-
* [delete](#delete) - Delete topic
|
|
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
|
-
|
|
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
|
-
|
|
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
|
|
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
|
|
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
|
|
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"}
|