@novu/api 0.7.0 → 1.0.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/README.md +27 -17
- package/bin/mcp-server.js +1397 -746
- package/bin/mcp-server.js.map +62 -49
- package/docs/sdks/novumessages/README.md +2 -2
- package/docs/sdks/novusubscribers/README.md +1 -181
- package/docs/sdks/novutopics/README.md +88 -0
- package/docs/sdks/subscribers/README.md +1 -1
- package/docs/sdks/subscriptions/README.md +266 -0
- package/docs/sdks/topics/README.md +52 -52
- package/funcs/notificationsList.js +1 -0
- package/funcs/notificationsList.js.map +1 -1
- package/funcs/subscribersCreate.d.ts +1 -1
- package/funcs/subscribersCreate.js +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts +1 -1
- package/funcs/subscribersMessagesMarkAll.js +1 -1
- package/funcs/subscribersTopicsList.d.ts +17 -0
- package/funcs/subscribersTopicsList.d.ts.map +1 -0
- package/funcs/subscribersTopicsList.js +151 -0
- package/funcs/subscribersTopicsList.js.map +1 -0
- package/funcs/topicsCreate.d.ts +3 -3
- package/funcs/topicsCreate.d.ts.map +1 -1
- package/funcs/topicsCreate.js +11 -14
- package/funcs/topicsCreate.js.map +1 -1
- package/funcs/topicsDelete.d.ts +2 -5
- package/funcs/topicsDelete.d.ts.map +1 -1
- package/funcs/topicsDelete.js +6 -6
- package/funcs/topicsDelete.js.map +1 -1
- package/funcs/{topicsRetrieve.d.ts → topicsGet.d.ts} +3 -6
- package/funcs/topicsGet.d.ts.map +1 -0
- package/funcs/{topicsRetrieve.js → topicsGet.js} +6 -9
- package/funcs/topicsGet.js.map +1 -0
- package/funcs/topicsList.d.ts +1 -4
- package/funcs/topicsList.d.ts.map +1 -1
- package/funcs/topicsList.js +9 -7
- package/funcs/topicsList.js.map +1 -1
- package/funcs/topicsSubscribersRetrieve.d.ts +1 -1
- package/funcs/topicsSubscribersRetrieve.d.ts.map +1 -1
- package/funcs/topicsSubscribersRetrieve.js +4 -3
- package/funcs/topicsSubscribersRetrieve.js.map +1 -1
- package/funcs/topicsSubscriptionsCreate.d.ts +15 -0
- package/funcs/topicsSubscriptionsCreate.d.ts.map +1 -0
- package/funcs/{topicsSubscribersRemove.js → topicsSubscriptionsCreate.js} +14 -17
- package/funcs/topicsSubscriptionsCreate.js.map +1 -0
- package/funcs/{topicsSubscribersAssign.d.ts → topicsSubscriptionsDelete.d.ts} +3 -6
- package/funcs/topicsSubscriptionsDelete.d.ts.map +1 -0
- package/funcs/{topicsSubscribersAssign.js → topicsSubscriptionsDelete.js} +15 -20
- package/funcs/topicsSubscriptionsDelete.js.map +1 -0
- package/funcs/{topicsSubscribersRemove.d.ts → topicsSubscriptionsList.d.ts} +3 -7
- package/funcs/topicsSubscriptionsList.d.ts.map +1 -0
- package/funcs/topicsSubscriptionsList.js +147 -0
- package/funcs/topicsSubscriptionsList.js.map +1 -0
- package/funcs/{topicsRename.d.ts → topicsUpdate.d.ts} +3 -6
- package/funcs/topicsUpdate.d.ts.map +1 -0
- package/funcs/{topicsRename.js → topicsUpdate.js} +13 -16
- package/funcs/topicsUpdate.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +17 -13
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/subscribersCreate.js +1 -1
- package/mcp-server/tools/subscribersCreate.js.map +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAll.js +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAll.js.map +1 -1
- package/mcp-server/tools/subscribersTopicsList.d.ts +8 -0
- package/mcp-server/tools/subscribersTopicsList.d.ts.map +1 -0
- package/mcp-server/tools/subscribersTopicsList.js +54 -0
- package/mcp-server/tools/subscribersTopicsList.js.map +1 -0
- package/mcp-server/tools/topicsCreate.d.ts +1 -1
- package/mcp-server/tools/topicsCreate.d.ts.map +1 -1
- package/mcp-server/tools/topicsCreate.js +4 -4
- package/mcp-server/tools/topicsCreate.js.map +1 -1
- package/mcp-server/tools/topicsDelete.js +3 -4
- package/mcp-server/tools/topicsDelete.js.map +1 -1
- package/mcp-server/tools/{topicsRetrieve.d.ts → topicsGet.d.ts} +2 -2
- package/mcp-server/tools/topicsGet.d.ts.map +1 -0
- package/mcp-server/tools/{topicsRetrieve.js → topicsGet.js} +7 -9
- package/mcp-server/tools/topicsGet.js.map +1 -0
- package/mcp-server/tools/topicsList.d.ts.map +1 -1
- package/mcp-server/tools/topicsList.js +1 -3
- package/mcp-server/tools/topicsList.js.map +1 -1
- package/mcp-server/tools/topicsSubscriptionsCreate.d.ts +11 -0
- package/mcp-server/tools/topicsSubscriptionsCreate.d.ts.map +1 -0
- package/mcp-server/tools/{topicsSubscribersRemove.js → topicsSubscriptionsCreate.js} +10 -11
- package/mcp-server/tools/topicsSubscriptionsCreate.js.map +1 -0
- package/mcp-server/tools/topicsSubscriptionsDelete.d.ts +11 -0
- package/mcp-server/tools/topicsSubscriptionsDelete.d.ts.map +1 -0
- package/mcp-server/tools/{topicsSubscribersAssign.js → topicsSubscriptionsDelete.js} +8 -10
- package/mcp-server/tools/topicsSubscriptionsDelete.js.map +1 -0
- package/mcp-server/tools/topicsSubscriptionsList.d.ts +8 -0
- package/mcp-server/tools/topicsSubscriptionsList.d.ts.map +1 -0
- package/mcp-server/tools/topicsSubscriptionsList.js +52 -0
- package/mcp-server/tools/topicsSubscriptionsList.js.map +1 -0
- package/mcp-server/tools/{topicsRename.d.ts → topicsUpdate.d.ts} +3 -3
- package/mcp-server/tools/{topicsRename.d.ts.map → topicsUpdate.d.ts.map} +1 -1
- package/mcp-server/tools/{topicsRename.js → topicsUpdate.js} +8 -10
- package/mcp-server/tools/topicsUpdate.js.map +1 -0
- package/models/components/activitynotificationresponsedto.d.ts +6 -0
- package/models/components/activitynotificationresponsedto.d.ts.map +1 -1
- package/models/components/activitynotificationresponsedto.js +3 -0
- package/models/components/activitynotificationresponsedto.js.map +1 -1
- package/models/components/activitytopicdto.d.ts +37 -0
- package/models/components/activitytopicdto.d.ts.map +1 -0
- package/models/components/activitytopicdto.js +70 -0
- package/models/components/activitytopicdto.js.map +1 -0
- package/models/components/createtopicsubscriptionsrequestdto.d.ts +32 -0
- package/models/components/createtopicsubscriptionsrequestdto.d.ts.map +1 -0
- package/models/components/createtopicsubscriptionsrequestdto.js +59 -0
- package/models/components/createtopicsubscriptionsrequestdto.js.map +1 -0
- package/models/components/createtopicsubscriptionsresponsedto.d.ts +45 -0
- package/models/components/createtopicsubscriptionsresponsedto.d.ts.map +1 -0
- package/models/components/createtopicsubscriptionsresponsedto.js +66 -0
- package/models/components/createtopicsubscriptionsresponsedto.js.map +1 -0
- package/models/components/createupdatetopicrequestdto.d.ts +37 -0
- package/models/components/createupdatetopicrequestdto.d.ts.map +1 -0
- package/models/components/{removesubscribersrequestdto.js → createupdatetopicrequestdto.js} +21 -19
- package/models/components/createupdatetopicrequestdto.js.map +1 -0
- package/models/components/deletetopicresponsedto.d.ts +32 -0
- package/models/components/deletetopicresponsedto.d.ts.map +1 -0
- package/models/components/{createtopicrequestdto.js → deletetopicresponsedto.js} +19 -21
- package/models/components/deletetopicresponsedto.js.map +1 -0
- package/models/components/deletetopicsubscriptionsrequestdto.d.ts +32 -0
- package/models/components/deletetopicsubscriptionsrequestdto.d.ts.map +1 -0
- package/models/components/deletetopicsubscriptionsrequestdto.js +59 -0
- package/models/components/deletetopicsubscriptionsrequestdto.js.map +1 -0
- package/models/components/deletetopicsubscriptionsresponsedto.d.ts +45 -0
- package/models/components/deletetopicsubscriptionsresponsedto.d.ts.map +1 -0
- package/models/components/deletetopicsubscriptionsresponsedto.js +66 -0
- package/models/components/deletetopicsubscriptionsresponsedto.js.map +1 -0
- package/models/components/index.d.ts +17 -10
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +17 -10
- package/models/components/index.js.map +1 -1
- package/models/components/listtopicsresponsedto.d.ts +43 -0
- package/models/components/listtopicsresponsedto.d.ts.map +1 -0
- package/models/components/listtopicsresponsedto.js +64 -0
- package/models/components/listtopicsresponsedto.js.map +1 -0
- package/models/components/listtopicsubscriptionsresponsedto.d.ts +43 -0
- package/models/components/listtopicsubscriptionsresponsedto.d.ts.map +1 -0
- package/models/components/listtopicsubscriptionsresponsedto.js +64 -0
- package/models/components/listtopicsubscriptionsresponsedto.js.map +1 -0
- package/models/components/metadto.d.ts +42 -0
- package/models/components/metadto.d.ts.map +1 -0
- package/models/components/{addsubscribersrequestdto.js → metadto.js} +23 -19
- package/models/components/metadto.js.map +1 -0
- package/models/components/subscriberdto.d.ts +57 -0
- package/models/components/subscriberdto.d.ts.map +1 -0
- package/models/components/subscriberdto.js +78 -0
- package/models/components/subscriberdto.js.map +1 -0
- package/models/components/subscriptiondto.d.ts +109 -0
- package/models/components/subscriptiondto.d.ts.map +1 -0
- package/models/components/subscriptiondto.js +122 -0
- package/models/components/subscriptiondto.js.map +1 -0
- package/models/components/subscriptionerrordto.d.ts +42 -0
- package/models/components/subscriptionerrordto.d.ts.map +1 -0
- package/models/components/{failedassignmentsdto.js → subscriptionerrordto.js} +23 -19
- package/models/components/subscriptionerrordto.js.map +1 -0
- package/models/components/subscriptionsdeleteerrordto.d.ts +42 -0
- package/models/components/subscriptionsdeleteerrordto.d.ts.map +1 -0
- package/models/components/subscriptionsdeleteerrordto.js +63 -0
- package/models/components/subscriptionsdeleteerrordto.js.map +1 -0
- package/models/components/topicdto.d.ts +13 -10
- package/models/components/topicdto.d.ts.map +1 -1
- package/models/components/topicdto.js +4 -14
- package/models/components/topicdto.js.map +1 -1
- package/models/components/topicresponsedto.d.ts +52 -0
- package/models/components/topicresponsedto.d.ts.map +1 -0
- package/models/components/{createtopicresponsedto.js → topicresponsedto.js} +25 -19
- package/models/components/topicresponsedto.js.map +1 -0
- package/models/components/topicsubscriptionresponsedto.d.ts +49 -0
- package/models/components/topicsubscriptionresponsedto.d.ts.map +1 -0
- package/models/components/topicsubscriptionresponsedto.js +76 -0
- package/models/components/topicsubscriptionresponsedto.js.map +1 -0
- package/models/components/updatetopicrequestdto.d.ts +32 -0
- package/models/components/{renametopicrequestdto.d.ts.map → updatetopicrequestdto.d.ts.map} +1 -1
- package/models/components/{renametopicrequestdto.js → updatetopicrequestdto.js} +17 -17
- package/models/components/{renametopicrequestdto.js.map → updatetopicrequestdto.js.map} +1 -1
- package/models/operations/index.d.ts +7 -5
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +7 -5
- package/models/operations/index.js.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.d.ts +5 -0
- package/models/operations/notificationscontrollerlistnotifications.d.ts.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.js +2 -0
- package/models/operations/notificationscontrollerlistnotifications.js.map +1 -1
- package/models/operations/subscriberscontrollerlistsubscribertopics.d.ts +136 -0
- package/models/operations/subscriberscontrollerlistsubscribertopics.d.ts.map +1 -0
- package/models/operations/subscriberscontrollerlistsubscribertopics.js +146 -0
- package/models/operations/subscriberscontrollerlistsubscribertopics.js.map +1 -0
- package/models/operations/topicscontrollercreatetopicsubscriptions.d.ts +71 -0
- package/models/operations/topicscontrollercreatetopicsubscriptions.d.ts.map +1 -0
- package/models/operations/topicscontrollercreatetopicsubscriptions.js +114 -0
- package/models/operations/topicscontrollercreatetopicsubscriptions.js.map +1 -0
- package/models/operations/topicscontrollerdeletetopic.d.ts +4 -1
- package/models/operations/topicscontrollerdeletetopic.d.ts.map +1 -1
- package/models/operations/topicscontrollerdeletetopic.js +5 -0
- package/models/operations/topicscontrollerdeletetopic.js.map +1 -1
- package/models/operations/topicscontrollerdeletetopicsubscriptions.d.ts +71 -0
- package/models/operations/topicscontrollerdeletetopicsubscriptions.d.ts.map +1 -0
- package/models/operations/topicscontrollerdeletetopicsubscriptions.js +114 -0
- package/models/operations/topicscontrollerdeletetopicsubscriptions.js.map +1 -0
- package/models/operations/topicscontrollergettopic.d.ts +3 -3
- package/models/operations/topicscontrollergettopic.d.ts.map +1 -1
- package/models/operations/topicscontrollergettopic.js +2 -2
- package/models/operations/topicscontrollergettopic.js.map +1 -1
- package/models/operations/topicscontrollerlisttopics.d.ts +66 -9
- package/models/operations/topicscontrollerlisttopics.d.ts.map +1 -1
- package/models/operations/topicscontrollerlisttopics.js +41 -7
- package/models/operations/topicscontrollerlisttopics.js.map +1 -1
- package/models/operations/topicscontrollerlisttopicsubscriptions.d.ts +136 -0
- package/models/operations/topicscontrollerlisttopicsubscriptions.d.ts.map +1 -0
- package/models/operations/topicscontrollerlisttopicsubscriptions.js +148 -0
- package/models/operations/topicscontrollerlisttopicsubscriptions.js.map +1 -0
- package/models/operations/topicscontrollerupdatetopic.d.ts +71 -0
- package/models/operations/{topicscontrollerrenametopic.d.ts.map → topicscontrollerupdatetopic.d.ts.map} +1 -1
- package/models/operations/topicscontrollerupdatetopic.js +114 -0
- package/models/operations/{topicscontrollerrenametopic.js.map → topicscontrollerupdatetopic.js.map} +1 -1
- package/models/operations/topicscontrollerupserttopic.d.ts +66 -0
- package/models/operations/{topicscontrollercreatetopic.d.ts.map → topicscontrollerupserttopic.d.ts.map} +1 -1
- package/models/operations/topicscontrollerupserttopic.js +112 -0
- package/models/operations/topicscontrollerupserttopic.js.map +1 -0
- package/models/operations/topicsv1controllergettopicsubscriber.d.ts +74 -0
- package/models/operations/topicsv1controllergettopicsubscriber.d.ts.map +1 -0
- package/models/operations/topicsv1controllergettopicsubscriber.js +112 -0
- package/models/operations/topicsv1controllergettopicsubscriber.js.map +1 -0
- package/package.json +1 -1
- package/sdk/novumessages.d.ts +1 -1
- package/sdk/novumessages.js +1 -1
- package/sdk/novusubscribers.d.ts +1 -16
- package/sdk/novusubscribers.d.ts.map +1 -1
- package/sdk/novusubscribers.js +0 -20
- package/sdk/novusubscribers.js.map +1 -1
- package/sdk/novutopics.d.ts +12 -0
- package/sdk/novutopics.d.ts.map +1 -0
- package/sdk/novutopics.js +22 -0
- package/sdk/novutopics.js.map +1 -0
- package/sdk/sdk.d.ts +2 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -3
- package/sdk/sdk.js.map +1 -1
- package/sdk/subscribers.d.ts +4 -1
- package/sdk/subscribers.d.ts.map +1 -1
- package/sdk/subscribers.js +5 -1
- package/sdk/subscribers.js.map +1 -1
- package/sdk/subscriptions.d.ts +18 -0
- package/sdk/subscriptions.d.ts.map +1 -0
- package/sdk/subscriptions.js +33 -0
- package/sdk/subscriptions.js.map +1 -0
- package/sdk/topics.d.ts +14 -23
- package/sdk/topics.d.ts.map +1 -1
- package/sdk/topics.js +22 -30
- package/sdk/topics.js.map +1 -1
- package/sources/json-development.json +2720 -1282
- package/src/funcs/notificationsList.ts +1 -0
- package/src/funcs/subscribersCreate.ts +1 -1
- package/src/funcs/subscribersMessagesMarkAll.ts +1 -1
- package/src/funcs/subscribersTopicsList.ts +238 -0
- package/src/funcs/topicsCreate.ts +19 -18
- package/src/funcs/topicsDelete.ts +9 -13
- package/src/funcs/{topicsRetrieve.ts → topicsGet.ts} +3 -6
- package/src/funcs/topicsList.ts +9 -7
- package/src/funcs/topicsSubscribersRetrieve.ts +8 -9
- package/src/funcs/{topicsSubscribersAssign.ts → topicsSubscriptionsCreate.ts} +22 -21
- package/src/funcs/{topicsSubscribersRemove.ts → topicsSubscriptionsDelete.ts} +22 -27
- package/src/funcs/topicsSubscriptionsList.ts +232 -0
- package/src/funcs/{topicsRename.ts → topicsUpdate.ts} +15 -18
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +17 -13
- package/src/mcp-server/tools/subscribersCreate.ts +1 -1
- package/src/mcp-server/tools/subscribersMessagesMarkAll.ts +1 -1
- package/src/mcp-server/tools/subscribersTopicsList.ts +38 -0
- package/src/mcp-server/tools/topicsCreate.ts +5 -4
- package/src/mcp-server/tools/topicsDelete.ts +4 -4
- package/src/mcp-server/tools/{topicsRetrieve.ts → topicsGet.ts} +5 -7
- package/src/mcp-server/tools/topicsList.ts +1 -3
- package/src/mcp-server/tools/{topicsSubscribersRemove.ts → topicsSubscriptionsCreate.ts} +12 -11
- package/src/mcp-server/tools/{topicsSubscribersAssign.ts → topicsSubscriptionsDelete.ts} +8 -9
- package/src/mcp-server/tools/topicsSubscriptionsList.ts +36 -0
- package/src/mcp-server/tools/{topicsRename.ts → topicsUpdate.ts} +7 -9
- package/src/models/components/activitynotificationresponsedto.ts +13 -0
- package/src/models/components/activitytopicdto.ts +85 -0
- package/src/models/components/createtopicsubscriptionsrequestdto.ts +73 -0
- package/src/models/components/createtopicsubscriptionsresponsedto.ts +106 -0
- package/src/models/components/createupdatetopicrequestdto.ts +78 -0
- package/src/models/components/deletetopicresponsedto.ts +69 -0
- package/src/models/components/deletetopicsubscriptionsrequestdto.ts +73 -0
- package/src/models/components/deletetopicsubscriptionsresponsedto.ts +106 -0
- package/src/models/components/index.ts +17 -10
- package/src/models/components/listtopicsresponsedto.ts +89 -0
- package/src/models/components/listtopicsubscriptionsresponsedto.ts +92 -0
- package/src/models/components/metadto.ts +76 -0
- package/src/models/components/subscriberdto.ts +109 -0
- package/src/models/components/subscriptiondto.ts +213 -0
- package/src/models/components/subscriptionerrordto.ts +83 -0
- package/src/models/components/subscriptionsdeleteerrordto.ts +85 -0
- package/src/models/components/topicdto.ts +17 -24
- package/src/models/components/topicresponsedto.ts +106 -0
- package/src/models/components/topicsubscriptionresponsedto.ts +113 -0
- package/src/models/components/updatetopicrequestdto.ts +69 -0
- package/src/models/operations/index.ts +7 -5
- package/src/models/operations/notificationscontrollerlistnotifications.ts +7 -0
- package/src/models/operations/subscriberscontrollerlistsubscribertopics.ts +271 -0
- package/src/models/operations/topicscontrollercreatetopicsubscriptions.ts +197 -0
- package/src/models/operations/topicscontrollerdeletetopic.ts +8 -1
- package/src/models/operations/topicscontrollerdeletetopicsubscriptions.ts +197 -0
- package/src/models/operations/topicscontrollergettopic.ts +5 -5
- package/src/models/operations/topicscontrollerlisttopics.ts +93 -15
- package/src/models/operations/topicscontrollerlisttopicsubscriptions.ts +284 -0
- package/src/models/operations/topicscontrollerupdatetopic.ts +173 -0
- package/src/models/operations/topicscontrollerupserttopic.ts +168 -0
- package/src/models/operations/topicsv1controllergettopicsubscriber.ts +191 -0
- package/src/sdk/novumessages.ts +1 -1
- package/src/sdk/novusubscribers.ts +1 -46
- package/src/sdk/novutopics.ts +27 -0
- package/src/sdk/sdk.ts +5 -5
- package/src/sdk/subscribers.ts +7 -1
- package/src/sdk/subscriptions.ts +65 -0
- package/src/sdk/topics.ts +37 -43
- package/funcs/topicsRename.d.ts.map +0 -1
- package/funcs/topicsRename.js.map +0 -1
- package/funcs/topicsRetrieve.d.ts.map +0 -1
- package/funcs/topicsRetrieve.js.map +0 -1
- package/funcs/topicsSubscribersAssign.d.ts.map +0 -1
- package/funcs/topicsSubscribersAssign.js.map +0 -1
- package/funcs/topicsSubscribersRemove.d.ts.map +0 -1
- package/funcs/topicsSubscribersRemove.js.map +0 -1
- package/mcp-server/tools/topicsRename.js.map +0 -1
- package/mcp-server/tools/topicsRetrieve.d.ts.map +0 -1
- package/mcp-server/tools/topicsRetrieve.js.map +0 -1
- package/mcp-server/tools/topicsSubscribersAssign.d.ts +0 -11
- package/mcp-server/tools/topicsSubscribersAssign.d.ts.map +0 -1
- package/mcp-server/tools/topicsSubscribersAssign.js.map +0 -1
- package/mcp-server/tools/topicsSubscribersRemove.d.ts +0 -11
- package/mcp-server/tools/topicsSubscribersRemove.d.ts.map +0 -1
- package/mcp-server/tools/topicsSubscribersRemove.js.map +0 -1
- package/models/components/addsubscribersrequestdto.d.ts +0 -32
- package/models/components/addsubscribersrequestdto.d.ts.map +0 -1
- package/models/components/addsubscribersrequestdto.js.map +0 -1
- package/models/components/assignsubscribertotopicdto.d.ts +0 -38
- package/models/components/assignsubscribertotopicdto.d.ts.map +0 -1
- package/models/components/assignsubscribertotopicdto.js +0 -62
- package/models/components/assignsubscribertotopicdto.js.map +0 -1
- package/models/components/createtopicrequestdto.d.ts +0 -37
- package/models/components/createtopicrequestdto.d.ts.map +0 -1
- package/models/components/createtopicrequestdto.js.map +0 -1
- package/models/components/createtopicresponsedto.d.ts +0 -37
- package/models/components/createtopicresponsedto.d.ts.map +0 -1
- package/models/components/createtopicresponsedto.js.map +0 -1
- package/models/components/failedassignmentsdto.d.ts +0 -32
- package/models/components/failedassignmentsdto.d.ts.map +0 -1
- package/models/components/failedassignmentsdto.js.map +0 -1
- package/models/components/filtertopicsresponsedto.d.ts +0 -48
- package/models/components/filtertopicsresponsedto.d.ts.map +0 -1
- package/models/components/filtertopicsresponsedto.js +0 -66
- package/models/components/filtertopicsresponsedto.js.map +0 -1
- package/models/components/gettopicresponsedto.d.ts +0 -39
- package/models/components/gettopicresponsedto.d.ts.map +0 -1
- package/models/components/gettopicresponsedto.js +0 -82
- package/models/components/gettopicresponsedto.js.map +0 -1
- package/models/components/removesubscribersrequestdto.d.ts +0 -32
- package/models/components/removesubscribersrequestdto.d.ts.map +0 -1
- package/models/components/removesubscribersrequestdto.js.map +0 -1
- package/models/components/renametopicrequestdto.d.ts +0 -32
- package/models/components/renametopicresponsedto.d.ts +0 -39
- package/models/components/renametopicresponsedto.d.ts.map +0 -1
- package/models/components/renametopicresponsedto.js +0 -82
- package/models/components/renametopicresponsedto.js.map +0 -1
- package/models/operations/topicscontrollerassign.d.ts +0 -71
- package/models/operations/topicscontrollerassign.d.ts.map +0 -1
- package/models/operations/topicscontrollerassign.js +0 -114
- package/models/operations/topicscontrollerassign.js.map +0 -1
- package/models/operations/topicscontrollercreatetopic.d.ts +0 -66
- package/models/operations/topicscontrollercreatetopic.js +0 -112
- package/models/operations/topicscontrollercreatetopic.js.map +0 -1
- package/models/operations/topicscontrollergettopicsubscriber.d.ts +0 -74
- package/models/operations/topicscontrollergettopicsubscriber.d.ts.map +0 -1
- package/models/operations/topicscontrollergettopicsubscriber.js +0 -112
- package/models/operations/topicscontrollergettopicsubscriber.js.map +0 -1
- package/models/operations/topicscontrollerremovesubscribers.d.ts +0 -69
- package/models/operations/topicscontrollerremovesubscribers.d.ts.map +0 -1
- package/models/operations/topicscontrollerremovesubscribers.js +0 -110
- package/models/operations/topicscontrollerremovesubscribers.js.map +0 -1
- package/models/operations/topicscontrollerrenametopic.d.ts +0 -71
- package/models/operations/topicscontrollerrenametopic.js +0 -114
- package/src/models/components/addsubscribersrequestdto.ts +0 -69
- package/src/models/components/assignsubscribertotopicdto.ts +0 -82
- package/src/models/components/createtopicrequestdto.ts +0 -76
- package/src/models/components/createtopicresponsedto.ts +0 -85
- package/src/models/components/failedassignmentsdto.ts +0 -69
- package/src/models/components/filtertopicsresponsedto.ts +0 -96
- package/src/models/components/gettopicresponsedto.ts +0 -99
- package/src/models/components/removesubscribersrequestdto.ts +0 -71
- package/src/models/components/renametopicrequestdto.ts +0 -69
- package/src/models/components/renametopicresponsedto.ts +0 -99
- package/src/models/operations/topicscontrollerassign.ts +0 -168
- package/src/models/operations/topicscontrollercreatetopic.ts +0 -166
- package/src/models/operations/topicscontrollergettopicsubscriber.ts +0 -187
- package/src/models/operations/topicscontrollerremovesubscribers.ts +0 -183
- package/src/models/operations/topicscontrollerrenametopic.ts +0 -173
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [updateAsSeen](#updateasseen) - Mark message action as seen
|
|
9
|
-
* [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen.
|
|
9
|
+
* [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen.
|
|
10
10
|
* [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread
|
|
11
11
|
|
|
12
12
|
## updateAsSeen
|
|
@@ -101,7 +101,7 @@ run();
|
|
|
101
101
|
|
|
102
102
|
## markAll
|
|
103
103
|
|
|
104
|
-
Marks all the subscriber messages as read, unread, seen or unseen.
|
|
104
|
+
Marks all the subscriber messages as read, unread, seen or unseen.
|
|
105
105
|
|
|
106
106
|
### Example Usage
|
|
107
107
|
|
|
@@ -5,99 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [assign](#assign) - Subscribers addition
|
|
9
8
|
* [retrieve](#retrieve) - Check topic subscriber
|
|
10
|
-
* [remove](#remove) - Subscribers removal
|
|
11
|
-
|
|
12
|
-
## assign
|
|
13
|
-
|
|
14
|
-
Add subscribers to a topic by key
|
|
15
|
-
|
|
16
|
-
### Example Usage
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import { Novu } from "@novu/api";
|
|
20
|
-
|
|
21
|
-
const novu = new Novu({
|
|
22
|
-
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
23
|
-
});
|
|
24
|
-
|
|
25
|
-
async function run() {
|
|
26
|
-
const result = await novu.topics.subscribers.assign({
|
|
27
|
-
subscribers: [
|
|
28
|
-
"<value>",
|
|
29
|
-
"<value>",
|
|
30
|
-
"<value>",
|
|
31
|
-
],
|
|
32
|
-
}, "<value>");
|
|
33
|
-
|
|
34
|
-
// Handle the result
|
|
35
|
-
console.log(result);
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
run();
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Standalone function
|
|
42
|
-
|
|
43
|
-
The standalone function version of this method:
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
import { NovuCore } from "@novu/api/core.js";
|
|
47
|
-
import { topicsSubscribersAssign } from "@novu/api/funcs/topicsSubscribersAssign.js";
|
|
48
|
-
|
|
49
|
-
// Use `NovuCore` for best tree-shaking performance.
|
|
50
|
-
// You can create one instance of it to use across an application.
|
|
51
|
-
const novu = new NovuCore({
|
|
52
|
-
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
53
|
-
});
|
|
54
|
-
|
|
55
|
-
async function run() {
|
|
56
|
-
const res = await topicsSubscribersAssign(novu, {
|
|
57
|
-
subscribers: [
|
|
58
|
-
"<value>",
|
|
59
|
-
"<value>",
|
|
60
|
-
"<value>",
|
|
61
|
-
],
|
|
62
|
-
}, "<value>");
|
|
63
|
-
|
|
64
|
-
if (!res.ok) {
|
|
65
|
-
throw res.error;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
const { value: result } = res;
|
|
69
|
-
|
|
70
|
-
// Handle the result
|
|
71
|
-
console.log(result);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
run();
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Parameters
|
|
78
|
-
|
|
79
|
-
| Parameter | Type | Required | Description |
|
|
80
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `topicKey` | *string* | :heavy_check_mark: | The topic key |
|
|
82
|
-
| `addSubscribersRequestDto` | [components.AddSubscribersRequestDto](../../models/components/addsubscribersrequestdto.md) | :heavy_check_mark: | N/A |
|
|
83
|
-
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
84
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
85
|
-
| `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. |
|
|
86
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
87
|
-
|
|
88
|
-
### Response
|
|
89
|
-
|
|
90
|
-
**Promise\<[operations.TopicsControllerAssignResponse](../../models/operations/topicscontrollerassignresponse.md)\>**
|
|
91
|
-
|
|
92
|
-
### Errors
|
|
93
|
-
|
|
94
|
-
| Error Type | Status Code | Content Type |
|
|
95
|
-
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
96
|
-
| errors.ErrorDto | 414 | application/json |
|
|
97
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
98
|
-
| errors.ValidationErrorDto | 422 | application/json |
|
|
99
|
-
| errors.ErrorDto | 500 | application/json |
|
|
100
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
101
9
|
|
|
102
10
|
## retrieve
|
|
103
11
|
|
|
@@ -165,95 +73,7 @@ run();
|
|
|
165
73
|
|
|
166
74
|
### Response
|
|
167
75
|
|
|
168
|
-
**Promise\<[operations.
|
|
169
|
-
|
|
170
|
-
### Errors
|
|
171
|
-
|
|
172
|
-
| Error Type | Status Code | Content Type |
|
|
173
|
-
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
174
|
-
| errors.ErrorDto | 414 | application/json |
|
|
175
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
176
|
-
| errors.ValidationErrorDto | 422 | application/json |
|
|
177
|
-
| errors.ErrorDto | 500 | application/json |
|
|
178
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
179
|
-
|
|
180
|
-
## remove
|
|
181
|
-
|
|
182
|
-
Remove subscribers from a topic
|
|
183
|
-
|
|
184
|
-
### Example Usage
|
|
185
|
-
|
|
186
|
-
```typescript
|
|
187
|
-
import { Novu } from "@novu/api";
|
|
188
|
-
|
|
189
|
-
const novu = new Novu({
|
|
190
|
-
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
191
|
-
});
|
|
192
|
-
|
|
193
|
-
async function run() {
|
|
194
|
-
const result = await novu.topics.subscribers.remove({
|
|
195
|
-
subscribers: [
|
|
196
|
-
"<value>",
|
|
197
|
-
"<value>",
|
|
198
|
-
],
|
|
199
|
-
}, "<value>");
|
|
200
|
-
|
|
201
|
-
// Handle the result
|
|
202
|
-
console.log(result);
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
run();
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
### Standalone function
|
|
209
|
-
|
|
210
|
-
The standalone function version of this method:
|
|
211
|
-
|
|
212
|
-
```typescript
|
|
213
|
-
import { NovuCore } from "@novu/api/core.js";
|
|
214
|
-
import { topicsSubscribersRemove } from "@novu/api/funcs/topicsSubscribersRemove.js";
|
|
215
|
-
|
|
216
|
-
// Use `NovuCore` for best tree-shaking performance.
|
|
217
|
-
// You can create one instance of it to use across an application.
|
|
218
|
-
const novu = new NovuCore({
|
|
219
|
-
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
220
|
-
});
|
|
221
|
-
|
|
222
|
-
async function run() {
|
|
223
|
-
const res = await topicsSubscribersRemove(novu, {
|
|
224
|
-
subscribers: [
|
|
225
|
-
"<value>",
|
|
226
|
-
"<value>",
|
|
227
|
-
],
|
|
228
|
-
}, "<value>");
|
|
229
|
-
|
|
230
|
-
if (!res.ok) {
|
|
231
|
-
throw res.error;
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
const { value: result } = res;
|
|
235
|
-
|
|
236
|
-
// Handle the result
|
|
237
|
-
console.log(result);
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
run();
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
### Parameters
|
|
244
|
-
|
|
245
|
-
| Parameter | Type | Required | Description |
|
|
246
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
247
|
-
| `topicKey` | *string* | :heavy_check_mark: | The topic key |
|
|
248
|
-
| `removeSubscribersRequestDto` | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.md) | :heavy_check_mark: | N/A |
|
|
249
|
-
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
250
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
251
|
-
| `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. |
|
|
252
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
253
|
-
|
|
254
|
-
### Response
|
|
255
|
-
|
|
256
|
-
**Promise\<[operations.TopicsControllerRemoveSubscribersResponse](../../models/operations/topicscontrollerremovesubscribersresponse.md)\>**
|
|
76
|
+
**Promise\<[operations.TopicsV1ControllerGetTopicSubscriberResponse](../../models/operations/topicsv1controllergettopicsubscriberresponse.md)\>**
|
|
257
77
|
|
|
258
78
|
### Errors
|
|
259
79
|
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# NovuTopics
|
|
2
|
+
(*subscribers.topics*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [list](#list) - List topics a subscriber is subscribed to
|
|
9
|
+
|
|
10
|
+
## list
|
|
11
|
+
|
|
12
|
+
List topic subscriptions for a subscriber with pagination and filtering
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { Novu } from "@novu/api";
|
|
18
|
+
|
|
19
|
+
const novu = new Novu({
|
|
20
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
async function run() {
|
|
24
|
+
const result = await novu.subscribers.topics.list({
|
|
25
|
+
subscriberId: "<id>",
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
// Handle the result
|
|
29
|
+
console.log(result);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
run();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Standalone function
|
|
36
|
+
|
|
37
|
+
The standalone function version of this method:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { NovuCore } from "@novu/api/core.js";
|
|
41
|
+
import { subscribersTopicsList } from "@novu/api/funcs/subscribersTopicsList.js";
|
|
42
|
+
|
|
43
|
+
// Use `NovuCore` for best tree-shaking performance.
|
|
44
|
+
// You can create one instance of it to use across an application.
|
|
45
|
+
const novu = new NovuCore({
|
|
46
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
async function run() {
|
|
50
|
+
const res = await subscribersTopicsList(novu, {
|
|
51
|
+
subscriberId: "<id>",
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
if (!res.ok) {
|
|
55
|
+
throw res.error;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
const { value: result } = res;
|
|
59
|
+
|
|
60
|
+
// Handle the result
|
|
61
|
+
console.log(result);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
run();
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Parameter | Type | Required | Description |
|
|
70
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
71
|
+
| `request` | [operations.SubscribersControllerListSubscriberTopicsRequest](../../models/operations/subscriberscontrollerlistsubscribertopicsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
72
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
73
|
+
| `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. |
|
|
74
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
75
|
+
|
|
76
|
+
### Response
|
|
77
|
+
|
|
78
|
+
**Promise\<[operations.SubscribersControllerListSubscriberTopicsResponse](../../models/operations/subscriberscontrollerlistsubscribertopicsresponse.md)\>**
|
|
79
|
+
|
|
80
|
+
### Errors
|
|
81
|
+
|
|
82
|
+
| Error Type | Status Code | Content Type |
|
|
83
|
+
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
84
|
+
| errors.ErrorDto | 414 | application/json |
|
|
85
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
86
|
+
| errors.ValidationErrorDto | 422 | application/json |
|
|
87
|
+
| errors.ErrorDto | 500 | application/json |
|
|
88
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
# Subscriptions
|
|
2
|
+
(*topics.subscriptions*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [list](#list) - List topic subscriptions
|
|
9
|
+
* [create](#create) - Create topic subscriptions, if the topic does not exist, it will be created.
|
|
10
|
+
* [delete](#delete) - Delete topic subscriptions
|
|
11
|
+
|
|
12
|
+
## list
|
|
13
|
+
|
|
14
|
+
List topic subscriptions
|
|
15
|
+
|
|
16
|
+
### Example Usage
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Novu } from "@novu/api";
|
|
20
|
+
|
|
21
|
+
const novu = new Novu({
|
|
22
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
async function run() {
|
|
26
|
+
const result = await novu.topics.subscriptions.list({
|
|
27
|
+
topicKey: "<value>",
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
// Handle the result
|
|
31
|
+
console.log(result);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
run();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Standalone function
|
|
38
|
+
|
|
39
|
+
The standalone function version of this method:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { NovuCore } from "@novu/api/core.js";
|
|
43
|
+
import { topicsSubscriptionsList } from "@novu/api/funcs/topicsSubscriptionsList.js";
|
|
44
|
+
|
|
45
|
+
// Use `NovuCore` for best tree-shaking performance.
|
|
46
|
+
// You can create one instance of it to use across an application.
|
|
47
|
+
const novu = new NovuCore({
|
|
48
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const res = await topicsSubscriptionsList(novu, {
|
|
53
|
+
topicKey: "<value>",
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
if (!res.ok) {
|
|
57
|
+
throw res.error;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
const { value: result } = res;
|
|
61
|
+
|
|
62
|
+
// Handle the result
|
|
63
|
+
console.log(result);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
run();
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Parameter | Type | Required | Description |
|
|
72
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
+
| `request` | [operations.TopicsControllerListTopicSubscriptionsRequest](../../models/operations/topicscontrollerlisttopicsubscriptionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
74
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
75
|
+
| `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. |
|
|
76
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
77
|
+
|
|
78
|
+
### Response
|
|
79
|
+
|
|
80
|
+
**Promise\<[operations.TopicsControllerListTopicSubscriptionsResponse](../../models/operations/topicscontrollerlisttopicsubscriptionsresponse.md)\>**
|
|
81
|
+
|
|
82
|
+
### Errors
|
|
83
|
+
|
|
84
|
+
| Error Type | Status Code | Content Type |
|
|
85
|
+
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
86
|
+
| errors.ErrorDto | 414 | application/json |
|
|
87
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
88
|
+
| errors.ValidationErrorDto | 422 | application/json |
|
|
89
|
+
| errors.ErrorDto | 500 | application/json |
|
|
90
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
91
|
+
|
|
92
|
+
## create
|
|
93
|
+
|
|
94
|
+
Create topic subscriptions, if the topic does not exist, it will be created.
|
|
95
|
+
|
|
96
|
+
### Example Usage
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import { Novu } from "@novu/api";
|
|
100
|
+
|
|
101
|
+
const novu = new Novu({
|
|
102
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
async function run() {
|
|
106
|
+
const result = await novu.topics.subscriptions.create({
|
|
107
|
+
subscriberIds: [
|
|
108
|
+
"subscriberId1",
|
|
109
|
+
"subscriberId2",
|
|
110
|
+
],
|
|
111
|
+
}, "<value>");
|
|
112
|
+
|
|
113
|
+
// Handle the result
|
|
114
|
+
console.log(result);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
run();
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Standalone function
|
|
121
|
+
|
|
122
|
+
The standalone function version of this method:
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
import { NovuCore } from "@novu/api/core.js";
|
|
126
|
+
import { topicsSubscriptionsCreate } from "@novu/api/funcs/topicsSubscriptionsCreate.js";
|
|
127
|
+
|
|
128
|
+
// Use `NovuCore` for best tree-shaking performance.
|
|
129
|
+
// You can create one instance of it to use across an application.
|
|
130
|
+
const novu = new NovuCore({
|
|
131
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
async function run() {
|
|
135
|
+
const res = await topicsSubscriptionsCreate(novu, {
|
|
136
|
+
subscriberIds: [
|
|
137
|
+
"subscriberId1",
|
|
138
|
+
"subscriberId2",
|
|
139
|
+
],
|
|
140
|
+
}, "<value>");
|
|
141
|
+
|
|
142
|
+
if (!res.ok) {
|
|
143
|
+
throw res.error;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
const { value: result } = res;
|
|
147
|
+
|
|
148
|
+
// Handle the result
|
|
149
|
+
console.log(result);
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
run();
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
| Parameter | Type | Required | Description |
|
|
158
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
159
|
+
| `topicKey` | *string* | :heavy_check_mark: | The key identifier of the topic |
|
|
160
|
+
| `createTopicSubscriptionsRequestDto` | [components.CreateTopicSubscriptionsRequestDto](../../models/components/createtopicsubscriptionsrequestdto.md) | :heavy_check_mark: | N/A |
|
|
161
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
162
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
163
|
+
| `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. |
|
|
164
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
165
|
+
|
|
166
|
+
### Response
|
|
167
|
+
|
|
168
|
+
**Promise\<[operations.TopicsControllerCreateTopicSubscriptionsResponse](../../models/operations/topicscontrollercreatetopicsubscriptionsresponse.md)\>**
|
|
169
|
+
|
|
170
|
+
### Errors
|
|
171
|
+
|
|
172
|
+
| Error Type | Status Code | Content Type |
|
|
173
|
+
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
174
|
+
| errors.ErrorDto | 414 | application/json |
|
|
175
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
176
|
+
| errors.ValidationErrorDto | 422 | application/json |
|
|
177
|
+
| errors.ErrorDto | 500 | application/json |
|
|
178
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
179
|
+
|
|
180
|
+
## delete
|
|
181
|
+
|
|
182
|
+
Delete topic subscriptions
|
|
183
|
+
|
|
184
|
+
### Example Usage
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
import { Novu } from "@novu/api";
|
|
188
|
+
|
|
189
|
+
const novu = new Novu({
|
|
190
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
async function run() {
|
|
194
|
+
const result = await novu.topics.subscriptions.delete({
|
|
195
|
+
subscriberIds: [
|
|
196
|
+
"subscriberId1",
|
|
197
|
+
"subscriberId2",
|
|
198
|
+
],
|
|
199
|
+
}, "<value>");
|
|
200
|
+
|
|
201
|
+
// Handle the result
|
|
202
|
+
console.log(result);
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
run();
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Standalone function
|
|
209
|
+
|
|
210
|
+
The standalone function version of this method:
|
|
211
|
+
|
|
212
|
+
```typescript
|
|
213
|
+
import { NovuCore } from "@novu/api/core.js";
|
|
214
|
+
import { topicsSubscriptionsDelete } from "@novu/api/funcs/topicsSubscriptionsDelete.js";
|
|
215
|
+
|
|
216
|
+
// Use `NovuCore` for best tree-shaking performance.
|
|
217
|
+
// You can create one instance of it to use across an application.
|
|
218
|
+
const novu = new NovuCore({
|
|
219
|
+
secretKey: "YOUR_SECRET_KEY_HERE",
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
async function run() {
|
|
223
|
+
const res = await topicsSubscriptionsDelete(novu, {
|
|
224
|
+
subscriberIds: [
|
|
225
|
+
"subscriberId1",
|
|
226
|
+
"subscriberId2",
|
|
227
|
+
],
|
|
228
|
+
}, "<value>");
|
|
229
|
+
|
|
230
|
+
if (!res.ok) {
|
|
231
|
+
throw res.error;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
const { value: result } = res;
|
|
235
|
+
|
|
236
|
+
// Handle the result
|
|
237
|
+
console.log(result);
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
run();
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Parameters
|
|
244
|
+
|
|
245
|
+
| Parameter | Type | Required | Description |
|
|
246
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
247
|
+
| `topicKey` | *string* | :heavy_check_mark: | The key identifier of the topic |
|
|
248
|
+
| `deleteTopicSubscriptionsRequestDto` | [components.DeleteTopicSubscriptionsRequestDto](../../models/components/deletetopicsubscriptionsrequestdto.md) | :heavy_check_mark: | N/A |
|
|
249
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
250
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
251
|
+
| `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. |
|
|
252
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
253
|
+
|
|
254
|
+
### Response
|
|
255
|
+
|
|
256
|
+
**Promise\<[operations.TopicsControllerDeleteTopicSubscriptionsResponse](../../models/operations/topicscontrollerdeletetopicsubscriptionsresponse.md)\>**
|
|
257
|
+
|
|
258
|
+
### Errors
|
|
259
|
+
|
|
260
|
+
| Error Type | Status Code | Content Type |
|
|
261
|
+
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
262
|
+
| errors.ErrorDto | 414 | application/json |
|
|
263
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
264
|
+
| errors.ValidationErrorDto | 422 | application/json |
|
|
265
|
+
| errors.ErrorDto | 500 | application/json |
|
|
266
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|