@novu/api 0.1.0 → 0.1.2
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 +16 -10
- package/README.md +182 -100
- package/docs/sdks/authentication/README.md +10 -10
- package/docs/sdks/credentials/README.md +56 -12
- package/docs/sdks/integrations/README.md +18 -18
- package/docs/sdks/messages/README.md +17 -11
- package/docs/sdks/notifications/README.md +8 -38
- package/docs/sdks/novu/README.md +138 -66
- package/docs/sdks/novumessages/README.md +17 -17
- package/docs/sdks/novunotifications/README.md +14 -12
- package/docs/sdks/novusubscribers/README.md +9 -9
- package/docs/sdks/preferences/README.md +22 -22
- package/docs/sdks/properties/README.md +6 -6
- package/docs/sdks/stats/README.md +6 -6
- package/docs/sdks/subscribers/README.md +349 -37
- package/docs/sdks/topics/README.md +15 -15
- package/docs/sdks/webhooks/README.md +3 -3
- package/funcs/cancel.js +4 -4
- package/funcs/cancel.js.map +1 -1
- package/funcs/integrationsCreate.js +4 -4
- package/funcs/integrationsCreate.js.map +1 -1
- package/funcs/integrationsDelete.js +4 -4
- package/funcs/integrationsDelete.js.map +1 -1
- package/funcs/integrationsList.js +4 -4
- package/funcs/integrationsList.js.map +1 -1
- package/funcs/integrationsListActive.js +4 -4
- package/funcs/integrationsListActive.js.map +1 -1
- package/funcs/integrationsSetAsPrimary.js +4 -4
- package/funcs/integrationsSetAsPrimary.js.map +1 -1
- package/funcs/integrationsUpdate.js +4 -4
- package/funcs/integrationsUpdate.js.map +1 -1
- package/funcs/integrationsWebhooksRetrieve.js +4 -4
- package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
- package/funcs/messagesDelete.js +4 -4
- package/funcs/messagesDelete.js.map +1 -1
- package/funcs/messagesDeleteByTransactionId.js +4 -4
- package/funcs/messagesDeleteByTransactionId.js.map +1 -1
- package/funcs/messagesRetrieve.js +4 -4
- package/funcs/messagesRetrieve.js.map +1 -1
- package/funcs/notificationsList.js +4 -4
- package/funcs/notificationsList.js.map +1 -1
- package/funcs/notificationsRetrieve.js +4 -4
- package/funcs/notificationsRetrieve.js.map +1 -1
- package/funcs/notificationsStatsGraph.js +4 -4
- package/funcs/notificationsStatsGraph.js.map +1 -1
- package/funcs/notificationsStatsRetrieve.js +4 -4
- package/funcs/notificationsStatsRetrieve.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.js +7 -7
- package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +2 -2
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +6 -6
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +1 -1
- package/funcs/subscribersCreate.d.ts +1 -1
- package/funcs/subscribersCreate.d.ts.map +1 -1
- package/funcs/subscribersCreate.js +6 -6
- package/funcs/subscribersCreate.js.map +1 -1
- package/funcs/subscribersCreateBulk.d.ts +1 -1
- package/funcs/subscribersCreateBulk.d.ts.map +1 -1
- package/funcs/subscribersCreateBulk.js +7 -6
- package/funcs/subscribersCreateBulk.js.map +1 -1
- package/funcs/subscribersCredentialsAppend.d.ts +1 -1
- package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
- package/funcs/subscribersCredentialsAppend.js +6 -6
- package/funcs/subscribersCredentialsAppend.js.map +1 -1
- package/funcs/subscribersCredentialsDelete.d.ts +1 -1
- package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
- package/funcs/subscribersCredentialsDelete.js +7 -7
- package/funcs/subscribersCredentialsDelete.js.map +1 -1
- package/funcs/subscribersCredentialsUpdate.d.ts +1 -1
- package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
- package/funcs/subscribersCredentialsUpdate.js +6 -6
- package/funcs/subscribersCredentialsUpdate.js.map +1 -1
- package/funcs/subscribersDelete.js +5 -5
- package/funcs/subscribersDelete.js.map +1 -1
- package/funcs/subscribersDeleteLegacy.d.ts +18 -0
- package/funcs/subscribersDeleteLegacy.d.ts.map +1 -0
- package/funcs/subscribersDeleteLegacy.js +141 -0
- package/funcs/subscribersDeleteLegacy.js.map +1 -0
- package/funcs/subscribersList.d.ts +1 -1
- package/funcs/subscribersList.d.ts.map +1 -1
- package/funcs/subscribersList.js +6 -6
- package/funcs/subscribersList.js.map +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAll.js +8 -7
- package/funcs/subscribersMessagesMarkAll.js.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.js +6 -6
- package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.js +6 -6
- package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
- package/funcs/subscribersNotificationsFeed.js +7 -6
- package/funcs/subscribersNotificationsFeed.js.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.js +6 -6
- package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
- package/funcs/subscribersPatch.d.ts +17 -0
- package/funcs/subscribersPatch.d.ts.map +1 -0
- package/funcs/subscribersPatch.js +143 -0
- package/funcs/subscribersPatch.js.map +1 -0
- package/funcs/subscribersPreferencesList.d.ts +1 -1
- package/funcs/subscribersPreferencesList.d.ts.map +1 -1
- package/funcs/subscribersPreferencesList.js +6 -6
- package/funcs/subscribersPreferencesList.js.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.js +6 -6
- package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
- package/funcs/subscribersPreferencesUpdate.d.ts +1 -1
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +6 -6
- package/funcs/subscribersPreferencesUpdate.js.map +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.d.ts +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.js +6 -6
- package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.js +6 -6
- package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
- package/funcs/subscribersRetrieve.d.ts +1 -1
- package/funcs/subscribersRetrieve.d.ts.map +1 -1
- package/funcs/subscribersRetrieve.js +6 -11
- package/funcs/subscribersRetrieve.js.map +1 -1
- package/funcs/subscribersRetrieveLegacy.d.ts +16 -0
- package/funcs/subscribersRetrieveLegacy.d.ts.map +1 -0
- package/funcs/subscribersRetrieveLegacy.js +144 -0
- package/funcs/subscribersRetrieveLegacy.js.map +1 -0
- package/funcs/subscribersSearch.d.ts +13 -0
- package/funcs/subscribersSearch.d.ts.map +1 -0
- package/funcs/subscribersSearch.js +138 -0
- package/funcs/subscribersSearch.js.map +1 -0
- package/funcs/subscribersUpdate.d.ts +1 -1
- package/funcs/subscribersUpdate.d.ts.map +1 -1
- package/funcs/subscribersUpdate.js +6 -6
- package/funcs/subscribersUpdate.js.map +1 -1
- package/funcs/topicsCreate.js +4 -4
- package/funcs/topicsCreate.js.map +1 -1
- package/funcs/topicsDelete.js +4 -4
- package/funcs/topicsDelete.js.map +1 -1
- package/funcs/topicsList.js +4 -4
- package/funcs/topicsList.js.map +1 -1
- package/funcs/topicsRename.js +4 -4
- package/funcs/topicsRename.js.map +1 -1
- package/funcs/topicsRetrieve.js +4 -4
- package/funcs/topicsRetrieve.js.map +1 -1
- package/funcs/topicsSubscribersAssign.js +4 -4
- package/funcs/topicsSubscribersAssign.js.map +1 -1
- package/funcs/topicsSubscribersRemove.js +4 -4
- package/funcs/topicsSubscribersRemove.js.map +1 -1
- package/funcs/topicsSubscribersRetrieve.js +4 -4
- package/funcs/topicsSubscribersRetrieve.js.map +1 -1
- package/funcs/trigger.js +4 -4
- package/funcs/trigger.js.map +1 -1
- package/funcs/triggerBroadcast.js +4 -4
- package/funcs/triggerBroadcast.js.map +1 -1
- package/funcs/triggerBulk.js +4 -4
- package/funcs/triggerBulk.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/retries.js +0 -1
- package/lib/retries.js.map +1 -1
- package/lib/schemas.d.ts +1 -1
- package/lib/schemas.d.ts.map +1 -1
- package/lib/schemas.js +4 -1
- package/lib/schemas.js.map +1 -1
- package/lib/security.js +1 -1
- package/lib/security.js.map +1 -1
- package/models/components/{channelsettings.d.ts → channelsettingsdto.d.ts} +22 -22
- package/models/components/channelsettingsdto.d.ts.map +1 -0
- package/models/components/{channelsettings.js → channelsettingsdto.js} +29 -29
- package/models/components/channelsettingsdto.js.map +1 -0
- package/models/components/index.d.ts +4 -2
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +4 -2
- package/models/components/index.js.map +1 -1
- package/models/components/listsubscribersresponsedto.d.ts +43 -0
- package/models/components/listsubscribersresponsedto.d.ts.map +1 -0
- package/models/components/listsubscribersresponsedto.js +64 -0
- package/models/components/listsubscribersresponsedto.js.map +1 -0
- package/models/components/patchsubscriberrequestdto.d.ts +96 -0
- package/models/components/patchsubscriberrequestdto.d.ts.map +1 -0
- package/models/components/patchsubscriberrequestdto.js +100 -0
- package/models/components/patchsubscriberrequestdto.js.map +1 -0
- package/models/components/removesubscriberresponsedto.d.ts +37 -0
- package/models/components/removesubscriberresponsedto.d.ts.map +1 -0
- package/models/components/removesubscriberresponsedto.js +61 -0
- package/models/components/removesubscriberresponsedto.js.map +1 -0
- package/models/components/security.d.ts +2 -2
- package/models/components/security.d.ts.map +1 -1
- package/models/components/security.js +2 -11
- package/models/components/security.js.map +1 -1
- package/models/components/subscriberresponsedto.d.ts +14 -3
- package/models/components/subscriberresponsedto.d.ts.map +1 -1
- package/models/components/subscriberresponsedto.js +5 -3
- package/models/components/subscriberresponsedto.js.map +1 -1
- package/models/components/triggereventrequestdto.d.ts +1 -12
- package/models/components/triggereventrequestdto.d.ts.map +1 -1
- package/models/components/triggereventrequestdto.js +10 -6
- package/models/components/triggereventrequestdto.js.map +1 -1
- package/models/operations/index.d.ts +23 -19
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +23 -19
- package/models/operations/index.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriber.d.ts +0 -5
- package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriber.js +0 -2
- package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
- package/models/operations/subscriberscontrollerpatchsubscriber.d.ts +68 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.d.ts.map +1 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.js +114 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.js.map +1 -0
- package/models/operations/subscriberscontrollerremovesubscriber.d.ts +2 -2
- package/models/operations/subscriberscontrollerremovesubscriber.js +2 -2
- package/models/operations/subscriberscontrollersearchsubscribers.d.ts +126 -0
- package/models/operations/subscriberscontrollersearchsubscribers.d.ts.map +1 -0
- package/models/operations/subscriberscontrollersearchsubscribers.js +145 -0
- package/models/operations/subscriberscontrollersearchsubscribers.js.map +1 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts +66 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.js +112 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.js.map +1 -0
- package/models/operations/subscribersv1controllerchataccessoauth.d.ts +80 -0
- package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerchataccessoauth.js +113 -0
- package/models/operations/subscribersv1controllerchataccessoauth.js.map +1 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +108 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.js +143 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.js.map +1 -0
- package/models/operations/subscribersv1controllercreatesubscriber.d.ts +66 -0
- package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllercreatesubscriber.js +112 -0
- package/models/operations/subscribersv1controllercreatesubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts +65 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.js +111 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.js.map +1 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts +79 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.js +120 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.js.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriber.d.ts +71 -0
- package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriber.js +112 -0
- package/models/operations/subscribersv1controllergetsubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +108 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +141 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +1 -0
- package/models/operations/subscribersv1controllergetunseencount.d.ts +76 -0
- package/models/operations/subscribersv1controllergetunseencount.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetunseencount.js +114 -0
- package/models/operations/subscribersv1controllergetunseencount.js.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +71 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +116 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscribers.d.ts +108 -0
- package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscribers.js +145 -0
- package/models/operations/subscribersv1controllerlistsubscribers.js.map +1 -0
- package/models/operations/subscribersv1controllermarkactionasseen.d.ts +72 -0
- package/models/operations/subscribersv1controllermarkactionasseen.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermarkactionasseen.js +118 -0
- package/models/operations/subscribersv1controllermarkactionasseen.js.map +1 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.d.ts +68 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.js +114 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.js.map +1 -0
- package/models/operations/subscribersv1controllermarkmessagesas.d.ts +68 -0
- package/models/operations/subscribersv1controllermarkmessagesas.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermarkmessagesas.js +114 -0
- package/models/operations/subscribersv1controllermarkmessagesas.js.map +1 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts +68 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.js +115 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.js.map +1 -0
- package/models/operations/subscribersv1controllerremovesubscriber.d.ts +66 -0
- package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerremovesubscriber.js +110 -0
- package/models/operations/subscribersv1controllerremovesubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.js +114 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.js +115 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +118 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js +118 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +70 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +120 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +1 -0
- package/package.json +10 -7
- package/sdk/authentication.d.ts +3 -3
- package/sdk/authentication.d.ts.map +1 -1
- package/sdk/authentication.js.map +1 -1
- package/sdk/credentials.d.ts +3 -3
- package/sdk/credentials.d.ts.map +1 -1
- package/sdk/credentials.js.map +1 -1
- package/sdk/novumessages.d.ts +3 -3
- package/sdk/novumessages.d.ts.map +1 -1
- package/sdk/novumessages.js.map +1 -1
- package/sdk/novunotifications.d.ts +2 -2
- package/sdk/novunotifications.d.ts.map +1 -1
- package/sdk/novunotifications.js.map +1 -1
- package/sdk/preferences.d.ts +4 -4
- package/sdk/preferences.d.ts.map +1 -1
- package/sdk/preferences.js.map +1 -1
- package/sdk/properties.d.ts +1 -1
- package/sdk/properties.d.ts.map +1 -1
- package/sdk/subscribers.d.ts +33 -6
- package/sdk/subscribers.d.ts.map +1 -1
- package/sdk/subscribers.js +43 -4
- package/sdk/subscribers.js.map +1 -1
- package/sources/json-development.json +2327 -228
- package/src/funcs/cancel.ts +4 -4
- package/src/funcs/integrationsCreate.ts +4 -4
- package/src/funcs/integrationsDelete.ts +4 -4
- package/src/funcs/integrationsList.ts +4 -4
- package/src/funcs/integrationsListActive.ts +4 -4
- package/src/funcs/integrationsSetAsPrimary.ts +5 -5
- package/src/funcs/integrationsUpdate.ts +5 -5
- package/src/funcs/integrationsWebhooksRetrieve.ts +4 -4
- package/src/funcs/messagesDelete.ts +4 -4
- package/src/funcs/messagesDeleteByTransactionId.ts +4 -4
- package/src/funcs/messagesRetrieve.ts +4 -4
- package/src/funcs/notificationsList.ts +4 -4
- package/src/funcs/notificationsRetrieve.ts +4 -4
- package/src/funcs/notificationsStatsGraph.ts +4 -4
- package/src/funcs/notificationsStatsRetrieve.ts +4 -4
- package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +10 -10
- package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +11 -11
- package/src/funcs/subscribersCreate.ts +10 -10
- package/src/funcs/subscribersCreateBulk.ts +15 -15
- package/src/funcs/subscribersCredentialsAppend.ts +11 -11
- package/src/funcs/subscribersCredentialsDelete.ts +10 -10
- package/src/funcs/subscribersCredentialsUpdate.ts +11 -11
- package/src/funcs/subscribersDelete.ts +5 -5
- package/src/funcs/subscribersDeleteLegacy.ts +200 -0
- package/src/funcs/subscribersList.ts +11 -11
- package/src/funcs/subscribersMessagesMarkAll.ts +14 -11
- package/src/funcs/subscribersMessagesMarkAllAs.ts +10 -10
- package/src/funcs/subscribersMessagesUpdateAsSeen.ts +10 -10
- package/src/funcs/subscribersNotificationsFeed.ts +11 -10
- package/src/funcs/subscribersNotificationsUnseenCount.ts +10 -10
- package/src/funcs/subscribersPatch.ts +204 -0
- package/src/funcs/subscribersPreferencesList.ts +10 -10
- package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +10 -10
- package/src/funcs/subscribersPreferencesUpdate.ts +10 -10
- package/src/funcs/subscribersPreferencesUpdateGlobal.ts +16 -15
- package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +10 -10
- package/src/funcs/subscribersRetrieve.ts +6 -13
- package/src/funcs/subscribersRetrieveLegacy.ts +205 -0
- package/src/funcs/subscribersSearch.ts +195 -0
- package/src/funcs/subscribersUpdate.ts +10 -10
- package/src/funcs/topicsCreate.ts +4 -4
- package/src/funcs/topicsDelete.ts +4 -4
- package/src/funcs/topicsList.ts +4 -4
- package/src/funcs/topicsRename.ts +4 -4
- package/src/funcs/topicsRetrieve.ts +4 -4
- package/src/funcs/topicsSubscribersAssign.ts +4 -4
- package/src/funcs/topicsSubscribersRemove.ts +4 -4
- package/src/funcs/topicsSubscribersRetrieve.ts +4 -4
- package/src/funcs/trigger.ts +4 -4
- package/src/funcs/triggerBroadcast.ts +4 -4
- package/src/funcs/triggerBulk.ts +4 -4
- package/src/lib/config.ts +4 -4
- package/src/lib/retries.ts +0 -1
- package/src/lib/schemas.ts +5 -0
- package/src/lib/security.ts +1 -1
- package/src/models/components/{channelsettings.ts → channelsettingsdto.ts} +40 -38
- package/src/models/components/index.ts +4 -2
- package/src/models/components/listsubscribersresponsedto.ts +89 -0
- package/src/models/components/patchsubscriberrequestdto.ts +182 -0
- package/src/models/components/removesubscriberresponsedto.ts +78 -0
- package/src/models/components/security.ts +4 -13
- package/src/models/components/subscriberresponsedto.ts +18 -9
- package/src/models/components/triggereventrequestdto.ts +11 -22
- package/src/models/operations/index.ts +23 -19
- package/src/models/operations/subscriberscontrollergetsubscriber.ts +0 -7
- package/src/models/operations/subscriberscontrollerpatchsubscriber.ts +189 -0
- package/src/models/operations/subscriberscontrollerremovesubscriber.ts +4 -4
- package/src/models/operations/subscriberscontrollersearchsubscribers.ts +260 -0
- package/src/models/operations/subscribersv1controllerbulkcreatesubscribers.ts +185 -0
- package/src/models/operations/{subscriberscontrollerchataccessoauth.ts → subscribersv1controllerchataccessoauth.ts} +47 -46
- package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +281 -0
- package/src/models/operations/subscribersv1controllercreatesubscriber.ts +187 -0
- package/src/models/operations/subscribersv1controllerdeletesubscribercredentials.ts +178 -0
- package/src/models/operations/{subscriberscontrollergetnotificationsfeed.ts → subscribersv1controllergetnotificationsfeed.ts} +46 -46
- package/src/models/operations/subscribersv1controllergetsubscriber.ts +188 -0
- package/src/models/operations/{subscriberscontrollergetsubscriberpreferencebylevel.ts → subscribersv1controllergetsubscriberpreferencebylevel.ts} +46 -46
- package/src/models/operations/subscribersv1controllergetunseencount.ts +195 -0
- package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +191 -0
- package/src/models/operations/subscribersv1controllerlistsubscribers.ts +283 -0
- package/src/models/operations/{subscriberscontrollermarkactionasseen.ts → subscribersv1controllermarkactionasseen.ts} +48 -46
- package/src/models/operations/subscribersv1controllermarkallunreadasread.ts +191 -0
- package/src/models/operations/subscribersv1controllermarkmessagesas.ts +187 -0
- package/src/models/operations/subscribersv1controllermodifysubscriberchannel.ts +192 -0
- package/src/models/operations/subscribersv1controllerremovesubscriber.ts +183 -0
- package/src/models/operations/{subscriberscontrollerupdatesubscriber.ts → subscribersv1controllerupdatesubscriber.ts} +48 -46
- package/src/models/operations/subscribersv1controllerupdatesubscriberchannel.ts +192 -0
- package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +195 -0
- package/src/models/operations/subscribersv1controllerupdatesubscriberonlineflag.ts +193 -0
- package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +197 -0
- package/src/sdk/authentication.ts +4 -4
- package/src/sdk/credentials.ts +7 -3
- package/src/sdk/novumessages.ts +4 -4
- package/src/sdk/novunotifications.ts +4 -4
- package/src/sdk/preferences.ts +7 -6
- package/src/sdk/properties.ts +1 -1
- package/src/sdk/subscribers.ts +89 -10
- package/models/components/channelsettings.d.ts.map +0 -1
- package/models/components/channelsettings.js.map +0 -1
- package/models/components/workflowtostepcontrolvaluesdto.d.ts +0 -40
- package/models/components/workflowtostepcontrolvaluesdto.d.ts.map +0 -1
- package/models/components/workflowtostepcontrolvaluesdto.js +0 -59
- package/models/components/workflowtostepcontrolvaluesdto.js.map +0 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +0 -66
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +0 -112
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +0 -1
- package/models/operations/subscriberscontrollerchataccessoauth.d.ts +0 -80
- package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerchataccessoauth.js +0 -113
- package/models/operations/subscriberscontrollerchataccessoauth.js.map +0 -1
- package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +0 -108
- package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerchatoauthcallback.js +0 -142
- package/models/operations/subscriberscontrollerchatoauthcallback.js.map +0 -1
- package/models/operations/subscriberscontrollercreatesubscriber.d.ts +0 -66
- package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +0 -1
- package/models/operations/subscriberscontrollercreatesubscriber.js +0 -112
- package/models/operations/subscriberscontrollercreatesubscriber.js.map +0 -1
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +0 -65
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +0 -111
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +0 -1
- package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +0 -79
- package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +0 -1
- package/models/operations/subscriberscontrollergetnotificationsfeed.js +0 -120
- package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +0 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +0 -108
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +0 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +0 -141
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +0 -1
- package/models/operations/subscriberscontrollergetunseencount.d.ts +0 -76
- package/models/operations/subscriberscontrollergetunseencount.d.ts.map +0 -1
- package/models/operations/subscriberscontrollergetunseencount.js +0 -114
- package/models/operations/subscriberscontrollergetunseencount.js.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +0 -71
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +0 -113
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscribers.d.ts +0 -108
- package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscribers.js +0 -145
- package/models/operations/subscriberscontrollerlistsubscribers.js.map +0 -1
- package/models/operations/subscriberscontrollermarkactionasseen.d.ts +0 -72
- package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermarkactionasseen.js +0 -118
- package/models/operations/subscriberscontrollermarkactionasseen.js.map +0 -1
- package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +0 -68
- package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermarkallunreadasread.js +0 -114
- package/models/operations/subscriberscontrollermarkallunreadasread.js.map +0 -1
- package/models/operations/subscriberscontrollermarkmessagesas.d.ts +0 -68
- package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermarkmessagesas.js +0 -114
- package/models/operations/subscriberscontrollermarkmessagesas.js.map +0 -1
- package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +0 -68
- package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermodifysubscriberchannel.js +0 -114
- package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriber.js +0 -114
- package/models/operations/subscriberscontrollerupdatesubscriber.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +0 -114
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +0 -118
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +0 -117
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +0 -70
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +0 -119
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +0 -1
- package/src/models/components/workflowtostepcontrolvaluesdto.ts +0 -71
- package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +0 -185
- package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +0 -281
- package/src/models/operations/subscriberscontrollercreatesubscriber.ts +0 -185
- package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +0 -177
- package/src/models/operations/subscriberscontrollergetunseencount.ts +0 -192
- package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +0 -193
- package/src/models/operations/subscriberscontrollerlistsubscribers.ts +0 -282
- package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +0 -191
- package/src/models/operations/subscriberscontrollermarkmessagesas.ts +0 -184
- package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +0 -193
- package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +0 -193
- package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +0 -195
- package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +0 -192
- package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +0 -196
package/docs/sdks/novu/README.md
CHANGED
|
@@ -28,22 +28,28 @@ Novu Documentation
|
|
|
28
28
|
import { Novu } from "@novu/api";
|
|
29
29
|
|
|
30
30
|
const novu = new Novu({
|
|
31
|
-
|
|
31
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
32
32
|
});
|
|
33
33
|
|
|
34
34
|
async function run() {
|
|
35
35
|
const result = await novu.trigger({
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
36
|
+
workflowId: "workflow_identifier",
|
|
37
|
+
payload: {
|
|
38
|
+
"comment_id": "string",
|
|
39
|
+
"post": {
|
|
40
|
+
"text": "string",
|
|
41
41
|
},
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
42
|
+
},
|
|
43
|
+
overrides: {
|
|
44
|
+
"fcm": {
|
|
45
|
+
"data": {
|
|
46
|
+
"key": "value",
|
|
47
|
+
},
|
|
45
48
|
},
|
|
46
|
-
|
|
49
|
+
},
|
|
50
|
+
to: {
|
|
51
|
+
subscriberId: "<id>",
|
|
52
|
+
},
|
|
47
53
|
});
|
|
48
54
|
|
|
49
55
|
// Handle the result
|
|
@@ -64,22 +70,28 @@ import { trigger } from "@novu/api/funcs/trigger.js";
|
|
|
64
70
|
// Use `NovuCore` for best tree-shaking performance.
|
|
65
71
|
// You can create one instance of it to use across an application.
|
|
66
72
|
const novu = new NovuCore({
|
|
67
|
-
|
|
73
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
68
74
|
});
|
|
69
75
|
|
|
70
76
|
async function run() {
|
|
71
77
|
const res = await trigger(novu, {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
78
|
+
workflowId: "workflow_identifier",
|
|
79
|
+
payload: {
|
|
80
|
+
"comment_id": "string",
|
|
81
|
+
"post": {
|
|
82
|
+
"text": "string",
|
|
77
83
|
},
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
84
|
+
},
|
|
85
|
+
overrides: {
|
|
86
|
+
"fcm": {
|
|
87
|
+
"data": {
|
|
88
|
+
"key": "value",
|
|
89
|
+
},
|
|
81
90
|
},
|
|
82
|
-
|
|
91
|
+
},
|
|
92
|
+
to: {
|
|
93
|
+
subscriberId: "<id>",
|
|
94
|
+
},
|
|
83
95
|
});
|
|
84
96
|
|
|
85
97
|
if (!res.ok) {
|
|
@@ -113,8 +125,8 @@ run();
|
|
|
113
125
|
|
|
114
126
|
| Error Type | Status Code | Content Type |
|
|
115
127
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
116
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
117
128
|
| errors.ErrorDto | 414 | application/json |
|
|
129
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
118
130
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
119
131
|
| errors.ErrorDto | 500 | application/json |
|
|
120
132
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -132,41 +144,71 @@ run();
|
|
|
132
144
|
import { Novu } from "@novu/api";
|
|
133
145
|
|
|
134
146
|
const novu = new Novu({
|
|
135
|
-
|
|
147
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
136
148
|
});
|
|
137
149
|
|
|
138
150
|
async function run() {
|
|
139
151
|
const result = await novu.triggerBulk({
|
|
140
152
|
events: [
|
|
141
153
|
{
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
154
|
+
workflowId: "workflow_identifier",
|
|
155
|
+
payload: {
|
|
156
|
+
"comment_id": "string",
|
|
157
|
+
"post": {
|
|
158
|
+
"text": "string",
|
|
147
159
|
},
|
|
148
|
-
|
|
149
|
-
|
|
160
|
+
},
|
|
161
|
+
overrides: {
|
|
162
|
+
"fcm": {
|
|
163
|
+
"data": {
|
|
164
|
+
"key": "value",
|
|
165
|
+
},
|
|
150
166
|
},
|
|
151
|
-
|
|
167
|
+
},
|
|
168
|
+
to: {
|
|
169
|
+
subscriberId: "<id>",
|
|
170
|
+
},
|
|
152
171
|
},
|
|
153
172
|
{
|
|
154
|
-
|
|
173
|
+
workflowId: "workflow_identifier",
|
|
174
|
+
payload: {
|
|
175
|
+
"comment_id": "string",
|
|
176
|
+
"post": {
|
|
177
|
+
"text": "string",
|
|
178
|
+
},
|
|
179
|
+
},
|
|
180
|
+
overrides: {
|
|
181
|
+
"fcm": {
|
|
182
|
+
"data": {
|
|
183
|
+
"key": "value",
|
|
184
|
+
},
|
|
185
|
+
},
|
|
186
|
+
},
|
|
155
187
|
to: [
|
|
156
|
-
|
|
188
|
+
{
|
|
189
|
+
topicKey: "<value>",
|
|
190
|
+
type: "Subscriber",
|
|
191
|
+
},
|
|
157
192
|
],
|
|
158
193
|
},
|
|
159
194
|
{
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
195
|
+
workflowId: "workflow_identifier",
|
|
196
|
+
payload: {
|
|
197
|
+
"comment_id": "string",
|
|
198
|
+
"post": {
|
|
199
|
+
"text": "string",
|
|
165
200
|
},
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
201
|
+
},
|
|
202
|
+
overrides: {
|
|
203
|
+
"fcm": {
|
|
204
|
+
"data": {
|
|
205
|
+
"key": "value",
|
|
206
|
+
},
|
|
169
207
|
},
|
|
208
|
+
},
|
|
209
|
+
to: [
|
|
210
|
+
"SUBSCRIBER_ID",
|
|
211
|
+
"SUBSCRIBER_ID",
|
|
170
212
|
],
|
|
171
213
|
},
|
|
172
214
|
],
|
|
@@ -190,41 +232,71 @@ import { triggerBulk } from "@novu/api/funcs/triggerBulk.js";
|
|
|
190
232
|
// Use `NovuCore` for best tree-shaking performance.
|
|
191
233
|
// You can create one instance of it to use across an application.
|
|
192
234
|
const novu = new NovuCore({
|
|
193
|
-
|
|
235
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
194
236
|
});
|
|
195
237
|
|
|
196
238
|
async function run() {
|
|
197
239
|
const res = await triggerBulk(novu, {
|
|
198
240
|
events: [
|
|
199
241
|
{
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
242
|
+
workflowId: "workflow_identifier",
|
|
243
|
+
payload: {
|
|
244
|
+
"comment_id": "string",
|
|
245
|
+
"post": {
|
|
246
|
+
"text": "string",
|
|
205
247
|
},
|
|
206
|
-
|
|
207
|
-
|
|
248
|
+
},
|
|
249
|
+
overrides: {
|
|
250
|
+
"fcm": {
|
|
251
|
+
"data": {
|
|
252
|
+
"key": "value",
|
|
253
|
+
},
|
|
208
254
|
},
|
|
209
|
-
|
|
255
|
+
},
|
|
256
|
+
to: {
|
|
257
|
+
subscriberId: "<id>",
|
|
258
|
+
},
|
|
210
259
|
},
|
|
211
260
|
{
|
|
212
|
-
|
|
261
|
+
workflowId: "workflow_identifier",
|
|
262
|
+
payload: {
|
|
263
|
+
"comment_id": "string",
|
|
264
|
+
"post": {
|
|
265
|
+
"text": "string",
|
|
266
|
+
},
|
|
267
|
+
},
|
|
268
|
+
overrides: {
|
|
269
|
+
"fcm": {
|
|
270
|
+
"data": {
|
|
271
|
+
"key": "value",
|
|
272
|
+
},
|
|
273
|
+
},
|
|
274
|
+
},
|
|
213
275
|
to: [
|
|
214
|
-
|
|
276
|
+
{
|
|
277
|
+
topicKey: "<value>",
|
|
278
|
+
type: "Subscriber",
|
|
279
|
+
},
|
|
215
280
|
],
|
|
216
281
|
},
|
|
217
282
|
{
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
283
|
+
workflowId: "workflow_identifier",
|
|
284
|
+
payload: {
|
|
285
|
+
"comment_id": "string",
|
|
286
|
+
"post": {
|
|
287
|
+
"text": "string",
|
|
223
288
|
},
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
289
|
+
},
|
|
290
|
+
overrides: {
|
|
291
|
+
"fcm": {
|
|
292
|
+
"data": {
|
|
293
|
+
"key": "value",
|
|
294
|
+
},
|
|
227
295
|
},
|
|
296
|
+
},
|
|
297
|
+
to: [
|
|
298
|
+
"SUBSCRIBER_ID",
|
|
299
|
+
"SUBSCRIBER_ID",
|
|
228
300
|
],
|
|
229
301
|
},
|
|
230
302
|
],
|
|
@@ -261,8 +333,8 @@ run();
|
|
|
261
333
|
|
|
262
334
|
| Error Type | Status Code | Content Type |
|
|
263
335
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
264
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
265
336
|
| errors.ErrorDto | 414 | application/json |
|
|
337
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
266
338
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
267
339
|
| errors.ErrorDto | 500 | application/json |
|
|
268
340
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -278,7 +350,7 @@ Trigger a broadcast event to all existing subscribers, could be used to send ann
|
|
|
278
350
|
import { Novu } from "@novu/api";
|
|
279
351
|
|
|
280
352
|
const novu = new Novu({
|
|
281
|
-
|
|
353
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
282
354
|
});
|
|
283
355
|
|
|
284
356
|
async function run() {
|
|
@@ -310,7 +382,7 @@ import { triggerBroadcast } from "@novu/api/funcs/triggerBroadcast.js";
|
|
|
310
382
|
// Use `NovuCore` for best tree-shaking performance.
|
|
311
383
|
// You can create one instance of it to use across an application.
|
|
312
384
|
const novu = new NovuCore({
|
|
313
|
-
|
|
385
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
314
386
|
});
|
|
315
387
|
|
|
316
388
|
async function run() {
|
|
@@ -355,8 +427,8 @@ run();
|
|
|
355
427
|
|
|
356
428
|
| Error Type | Status Code | Content Type |
|
|
357
429
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
358
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
359
430
|
| errors.ErrorDto | 414 | application/json |
|
|
431
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
360
432
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
361
433
|
| errors.ErrorDto | 500 | application/json |
|
|
362
434
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -374,7 +446,7 @@ run();
|
|
|
374
446
|
import { Novu } from "@novu/api";
|
|
375
447
|
|
|
376
448
|
const novu = new Novu({
|
|
377
|
-
|
|
449
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
378
450
|
});
|
|
379
451
|
|
|
380
452
|
async function run() {
|
|
@@ -398,7 +470,7 @@ import { cancel } from "@novu/api/funcs/cancel.js";
|
|
|
398
470
|
// Use `NovuCore` for best tree-shaking performance.
|
|
399
471
|
// You can create one instance of it to use across an application.
|
|
400
472
|
const novu = new NovuCore({
|
|
401
|
-
|
|
473
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
402
474
|
});
|
|
403
475
|
|
|
404
476
|
async function run() {
|
|
@@ -435,8 +507,8 @@ run();
|
|
|
435
507
|
|
|
436
508
|
| Error Type | Status Code | Content Type |
|
|
437
509
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
438
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
439
510
|
| errors.ErrorDto | 414 | application/json |
|
|
511
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
440
512
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
441
513
|
| errors.ErrorDto | 500 | application/json |
|
|
442
514
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -19,13 +19,13 @@ Mark a subscriber messages as seen, read, unseen or unread
|
|
|
19
19
|
import { Novu } from "@novu/api";
|
|
20
20
|
|
|
21
21
|
const novu = new Novu({
|
|
22
|
-
|
|
22
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
23
23
|
});
|
|
24
24
|
|
|
25
25
|
async function run() {
|
|
26
26
|
const result = await novu.subscribers.messages.markAllAs({
|
|
27
|
-
messageId: "<
|
|
28
|
-
markAs: "
|
|
27
|
+
messageId: "<id>",
|
|
28
|
+
markAs: "unread",
|
|
29
29
|
}, "<id>");
|
|
30
30
|
|
|
31
31
|
// Handle the result
|
|
@@ -46,13 +46,13 @@ import { subscribersMessagesMarkAllAs } from "@novu/api/funcs/subscribersMessage
|
|
|
46
46
|
// Use `NovuCore` for best tree-shaking performance.
|
|
47
47
|
// You can create one instance of it to use across an application.
|
|
48
48
|
const novu = new NovuCore({
|
|
49
|
-
|
|
49
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
50
50
|
});
|
|
51
51
|
|
|
52
52
|
async function run() {
|
|
53
53
|
const res = await subscribersMessagesMarkAllAs(novu, {
|
|
54
|
-
messageId: "<
|
|
55
|
-
markAs: "
|
|
54
|
+
messageId: "<id>",
|
|
55
|
+
markAs: "unread",
|
|
56
56
|
}, "<id>");
|
|
57
57
|
|
|
58
58
|
if (!res.ok) {
|
|
@@ -81,14 +81,14 @@ run();
|
|
|
81
81
|
|
|
82
82
|
### Response
|
|
83
83
|
|
|
84
|
-
**Promise\<[operations.
|
|
84
|
+
**Promise\<[operations.SubscribersV1ControllerMarkMessagesAsResponse](../../models/operations/subscribersv1controllermarkmessagesasresponse.md)\>**
|
|
85
85
|
|
|
86
86
|
### Errors
|
|
87
87
|
|
|
88
88
|
| Error Type | Status Code | Content Type |
|
|
89
89
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
90
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
91
90
|
| errors.ErrorDto | 414 | application/json |
|
|
91
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
92
92
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
93
93
|
| errors.ErrorDto | 500 | application/json |
|
|
94
94
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -103,7 +103,7 @@ Marks all the subscriber messages as read, unread, seen or unseen. Optionally yo
|
|
|
103
103
|
import { Novu } from "@novu/api";
|
|
104
104
|
|
|
105
105
|
const novu = new Novu({
|
|
106
|
-
|
|
106
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
107
107
|
});
|
|
108
108
|
|
|
109
109
|
async function run() {
|
|
@@ -129,7 +129,7 @@ import { subscribersMessagesMarkAll } from "@novu/api/funcs/subscribersMessagesM
|
|
|
129
129
|
// Use `NovuCore` for best tree-shaking performance.
|
|
130
130
|
// You can create one instance of it to use across an application.
|
|
131
131
|
const novu = new NovuCore({
|
|
132
|
-
|
|
132
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
133
133
|
});
|
|
134
134
|
|
|
135
135
|
async function run() {
|
|
@@ -163,14 +163,14 @@ run();
|
|
|
163
163
|
|
|
164
164
|
### Response
|
|
165
165
|
|
|
166
|
-
**Promise\<[operations.
|
|
166
|
+
**Promise\<[operations.SubscribersV1ControllerMarkAllUnreadAsReadResponse](../../models/operations/subscribersv1controllermarkallunreadasreadresponse.md)\>**
|
|
167
167
|
|
|
168
168
|
### Errors
|
|
169
169
|
|
|
170
170
|
| Error Type | Status Code | Content Type |
|
|
171
171
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
172
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
173
172
|
| errors.ErrorDto | 414 | application/json |
|
|
173
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
174
174
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
175
175
|
| errors.ErrorDto | 500 | application/json |
|
|
176
176
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -185,7 +185,7 @@ Mark message action as seen
|
|
|
185
185
|
import { Novu } from "@novu/api";
|
|
186
186
|
|
|
187
187
|
const novu = new Novu({
|
|
188
|
-
|
|
188
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
189
189
|
});
|
|
190
190
|
|
|
191
191
|
async function run() {
|
|
@@ -216,7 +216,7 @@ import { subscribersMessagesUpdateAsSeen } from "@novu/api/funcs/subscribersMess
|
|
|
216
216
|
// Use `NovuCore` for best tree-shaking performance.
|
|
217
217
|
// You can create one instance of it to use across an application.
|
|
218
218
|
const novu = new NovuCore({
|
|
219
|
-
|
|
219
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
220
220
|
});
|
|
221
221
|
|
|
222
222
|
async function run() {
|
|
@@ -246,21 +246,21 @@ run();
|
|
|
246
246
|
|
|
247
247
|
| Parameter | Type | Required | Description |
|
|
248
248
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
249
|
-
| `request` | [operations.
|
|
249
|
+
| `request` | [operations.SubscribersV1ControllerMarkActionAsSeenRequest](../../models/operations/subscribersv1controllermarkactionasseenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
250
250
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
251
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
252
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
253
253
|
|
|
254
254
|
### Response
|
|
255
255
|
|
|
256
|
-
**Promise\<[operations.
|
|
256
|
+
**Promise\<[operations.SubscribersV1ControllerMarkActionAsSeenResponse](../../models/operations/subscribersv1controllermarkactionasseenresponse.md)\>**
|
|
257
257
|
|
|
258
258
|
### Errors
|
|
259
259
|
|
|
260
260
|
| Error Type | Status Code | Content Type |
|
|
261
261
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
262
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
263
262
|
| errors.ErrorDto | 414 | application/json |
|
|
263
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
264
264
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
265
265
|
| errors.ErrorDto | 500 | application/json |
|
|
266
266
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -18,12 +18,13 @@ Get in-app notification feed for a particular subscriber
|
|
|
18
18
|
import { Novu } from "@novu/api";
|
|
19
19
|
|
|
20
20
|
const novu = new Novu({
|
|
21
|
-
|
|
21
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
22
22
|
});
|
|
23
23
|
|
|
24
24
|
async function run() {
|
|
25
25
|
const result = await novu.subscribers.notifications.feed({
|
|
26
26
|
subscriberId: "<id>",
|
|
27
|
+
limit: 10,
|
|
27
28
|
payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
|
|
28
29
|
});
|
|
29
30
|
|
|
@@ -45,12 +46,13 @@ import { subscribersNotificationsFeed } from "@novu/api/funcs/subscribersNotific
|
|
|
45
46
|
// Use `NovuCore` for best tree-shaking performance.
|
|
46
47
|
// You can create one instance of it to use across an application.
|
|
47
48
|
const novu = new NovuCore({
|
|
48
|
-
|
|
49
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
49
50
|
});
|
|
50
51
|
|
|
51
52
|
async function run() {
|
|
52
53
|
const res = await subscribersNotificationsFeed(novu, {
|
|
53
54
|
subscriberId: "<id>",
|
|
55
|
+
limit: 10,
|
|
54
56
|
payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
|
|
55
57
|
});
|
|
56
58
|
|
|
@@ -71,21 +73,21 @@ run();
|
|
|
71
73
|
|
|
72
74
|
| Parameter | Type | Required | Description |
|
|
73
75
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
-
| `request` | [operations.
|
|
76
|
+
| `request` | [operations.SubscribersV1ControllerGetNotificationsFeedRequest](../../models/operations/subscribersv1controllergetnotificationsfeedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
75
77
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
78
|
| `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. |
|
|
77
79
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
80
|
|
|
79
81
|
### Response
|
|
80
82
|
|
|
81
|
-
**Promise\<[operations.
|
|
83
|
+
**Promise\<[operations.SubscribersV1ControllerGetNotificationsFeedResponse](../../models/operations/subscribersv1controllergetnotificationsfeedresponse.md)\>**
|
|
82
84
|
|
|
83
85
|
### Errors
|
|
84
86
|
|
|
85
87
|
| Error Type | Status Code | Content Type |
|
|
86
88
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
87
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
88
89
|
| errors.ErrorDto | 414 | application/json |
|
|
90
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
89
91
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
90
92
|
| errors.ErrorDto | 500 | application/json |
|
|
91
93
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -100,14 +102,14 @@ Get the unseen in-app notifications count for subscribers feed
|
|
|
100
102
|
import { Novu } from "@novu/api";
|
|
101
103
|
|
|
102
104
|
const novu = new Novu({
|
|
103
|
-
|
|
105
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
104
106
|
});
|
|
105
107
|
|
|
106
108
|
async function run() {
|
|
107
109
|
const result = await novu.subscribers.notifications.unseenCount({
|
|
108
110
|
subscriberId: "<id>",
|
|
109
111
|
seen: false,
|
|
110
|
-
limit:
|
|
112
|
+
limit: 100,
|
|
111
113
|
});
|
|
112
114
|
|
|
113
115
|
// Handle the result
|
|
@@ -128,14 +130,14 @@ import { subscribersNotificationsUnseenCount } from "@novu/api/funcs/subscribers
|
|
|
128
130
|
// Use `NovuCore` for best tree-shaking performance.
|
|
129
131
|
// You can create one instance of it to use across an application.
|
|
130
132
|
const novu = new NovuCore({
|
|
131
|
-
|
|
133
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
132
134
|
});
|
|
133
135
|
|
|
134
136
|
async function run() {
|
|
135
137
|
const res = await subscribersNotificationsUnseenCount(novu, {
|
|
136
138
|
subscriberId: "<id>",
|
|
137
139
|
seen: false,
|
|
138
|
-
limit:
|
|
140
|
+
limit: 100,
|
|
139
141
|
});
|
|
140
142
|
|
|
141
143
|
if (!res.ok) {
|
|
@@ -155,21 +157,21 @@ run();
|
|
|
155
157
|
|
|
156
158
|
| Parameter | Type | Required | Description |
|
|
157
159
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
158
|
-
| `request` | [operations.
|
|
160
|
+
| `request` | [operations.SubscribersV1ControllerGetUnseenCountRequest](../../models/operations/subscribersv1controllergetunseencountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
159
161
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
160
162
|
| `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. |
|
|
161
163
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
162
164
|
|
|
163
165
|
### Response
|
|
164
166
|
|
|
165
|
-
**Promise\<[operations.
|
|
167
|
+
**Promise\<[operations.SubscribersV1ControllerGetUnseenCountResponse](../../models/operations/subscribersv1controllergetunseencountresponse.md)\>**
|
|
166
168
|
|
|
167
169
|
### Errors
|
|
168
170
|
|
|
169
171
|
| Error Type | Status Code | Content Type |
|
|
170
172
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
171
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
172
173
|
| errors.ErrorDto | 414 | application/json |
|
|
174
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
173
175
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
174
176
|
| errors.ErrorDto | 500 | application/json |
|
|
175
177
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|