@novu/api 0.1.1 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +2 -3
- package/README.md +43 -45
- package/docs/sdks/authentication/README.md +10 -10
- package/docs/sdks/credentials/README.md +12 -12
- package/docs/sdks/integrations/README.md +18 -18
- package/docs/sdks/messages/README.md +11 -17
- package/docs/sdks/notifications/README.md +8 -12
- package/docs/sdks/novu/README.md +21 -179
- package/docs/sdks/novumessages/README.md +13 -13
- package/docs/sdks/novunotifications/README.md +10 -16
- package/docs/sdks/novusubscribers/README.md +9 -9
- package/docs/sdks/preferences/README.md +183 -22
- package/docs/sdks/properties/README.md +4 -4
- package/docs/sdks/stats/README.md +6 -6
- package/docs/sdks/subscribers/README.md +349 -35
- package/docs/sdks/topics/README.md +15 -19
- 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/{supportControllerFetchUserOrganizations.js → subscribersPatch.js} +48 -16
- 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/subscribersPreferencesRetrieve.d.ts +16 -0
- package/funcs/subscribersPreferencesRetrieve.d.ts.map +1 -0
- package/funcs/{create.js → subscribersPreferencesRetrieve.js} +51 -20
- package/funcs/subscribersPreferencesRetrieve.js.map +1 -0
- 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 +6 -2
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +21 -15
- 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/subscribersPreferencesUpdateLegacy.d.ts +13 -0
- package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +1 -0
- package/funcs/subscribersPreferencesUpdateLegacy.js +139 -0
- package/funcs/subscribersPreferencesUpdateLegacy.js.map +1 -0
- 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/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/getsubscriberpreferencesdto.d.ts +39 -0
- package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -0
- package/models/components/getsubscriberpreferencesdto.js +63 -0
- package/models/components/getsubscriberpreferencesdto.js.map +1 -0
- package/models/components/globalpreferencedto.d.ts +38 -0
- package/models/components/globalpreferencedto.d.ts.map +1 -0
- package/models/components/globalpreferencedto.js +62 -0
- package/models/components/globalpreferencedto.js.map +1 -0
- package/models/components/index.d.ts +11 -4
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +11 -4
- 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/overrides.d.ts +112 -0
- package/models/components/overrides.d.ts.map +1 -0
- package/models/components/overrides.js +110 -0
- package/models/components/overrides.js.map +1 -0
- package/models/components/patchpreferencechannelsdto.d.ts +52 -0
- package/models/components/patchpreferencechannelsdto.d.ts.map +1 -0
- package/models/components/patchpreferencechannelsdto.js +76 -0
- package/models/components/patchpreferencechannelsdto.js.map +1 -0
- package/models/components/patchsubscriberpreferencesdto.d.ts +38 -0
- package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -0
- package/models/components/patchsubscriberpreferencesdto.js +62 -0
- package/models/components/patchsubscriberpreferencesdto.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/components/triggereventtoallrequestdto.d.ts +15 -15
- package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
- package/models/components/triggereventtoallrequestdto.js +20 -18
- package/models/components/triggereventtoallrequestdto.js.map +1 -1
- package/models/components/workflowinfodto.d.ts +42 -0
- package/models/components/workflowinfodto.d.ts.map +1 -0
- package/models/components/{createsupportthreaddto.js → workflowinfodto.js} +23 -19
- package/models/components/workflowinfodto.js.map +1 -0
- package/models/components/workflowpreferencedto.d.ts +50 -0
- package/models/components/workflowpreferencedto.d.ts.map +1 -0
- package/models/components/workflowpreferencedto.js +68 -0
- package/models/components/workflowpreferencedto.js.map +1 -0
- package/models/operations/index.d.ts +25 -21
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +25 -21
- 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/subscriberscontrollergetsubscriberpreferences.d.ts +66 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.js +110 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -0
- 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/subscriberscontrollerupdatesubscriberpreferences.d.ts +68 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js +118 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.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 +6 -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 +18 -4
- package/sdk/preferences.d.ts.map +1 -1
- package/sdk/preferences.js +22 -2
- package/sdk/preferences.js.map +1 -1
- package/sdk/properties.d.ts +1 -1
- package/sdk/properties.d.ts.map +1 -1
- package/sdk/sdk.d.ts +0 -8
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -14
- package/sdk/sdk.js.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 +3504 -356
- 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/{supportControllerFetchUserOrganizations.ts → subscribersPatch.ts} +73 -19
- package/src/funcs/subscribersPreferencesList.ts +10 -10
- package/src/funcs/subscribersPreferencesRetrieve.ts +203 -0
- package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +10 -10
- package/src/funcs/subscribersPreferencesUpdate.ts +31 -24
- package/src/funcs/subscribersPreferencesUpdateGlobal.ts +16 -15
- package/src/funcs/subscribersPreferencesUpdateLegacy.ts +202 -0
- package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +10 -10
- package/src/funcs/subscribersRetrieve.ts +6 -13
- package/src/funcs/subscribersRetrieveLegacy.ts +205 -0
- package/src/funcs/{create.ts → subscribersSearch.ts} +78 -31
- 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/security.ts +1 -1
- package/src/models/components/{channelsettings.ts → channelsettingsdto.ts} +40 -38
- package/src/models/components/getsubscriberpreferencesdto.ts +90 -0
- package/src/models/components/globalpreferencedto.ts +82 -0
- package/src/models/components/index.ts +11 -4
- package/src/models/components/listsubscribersresponsedto.ts +89 -0
- package/src/models/components/overrides.ts +141 -0
- package/src/models/components/patchpreferencechannelsdto.ts +106 -0
- package/src/models/components/patchsubscriberpreferencesdto.ts +84 -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/components/triggereventtoallrequestdto.ts +35 -24
- package/src/models/components/workflowinfodto.ts +81 -0
- package/src/models/components/workflowpreferencedto.ts +108 -0
- package/src/models/operations/index.ts +25 -21
- package/src/models/operations/subscriberscontrollergetsubscriber.ts +0 -7
- package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +183 -0
- 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/subscriberscontrollerupdatesubscriberpreferences.ts +189 -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 +52 -7
- package/src/sdk/properties.ts +1 -1
- package/src/sdk/sdk.ts +0 -34
- package/src/sdk/subscribers.ts +89 -10
- package/funcs/create.d.ts +0 -9
- package/funcs/create.d.ts.map +0 -1
- package/funcs/create.js.map +0 -1
- package/funcs/supportControllerFetchUserOrganizations.d.ts +0 -10
- package/funcs/supportControllerFetchUserOrganizations.d.ts.map +0 -1
- package/funcs/supportControllerFetchUserOrganizations.js.map +0 -1
- package/models/components/channelsettings.d.ts.map +0 -1
- package/models/components/channelsettings.js.map +0 -1
- package/models/components/createsupportthreaddto.d.ts +0 -29
- package/models/components/createsupportthreaddto.d.ts.map +0 -1
- package/models/components/createsupportthreaddto.js.map +0 -1
- package/models/components/plaincardrequestdto.d.ts +0 -100
- package/models/components/plaincardrequestdto.d.ts.map +0 -1
- package/models/components/plaincardrequestdto.js +0 -139
- package/models/components/plaincardrequestdto.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/models/operations/supportcontrollercreatethread.d.ts +0 -35
- package/models/operations/supportcontrollercreatethread.d.ts.map +0 -1
- package/models/operations/supportcontrollercreatethread.js +0 -73
- package/models/operations/supportcontrollercreatethread.js.map +0 -1
- package/models/operations/supportcontrollerfetchuserorganizations.d.ts +0 -56
- package/models/operations/supportcontrollerfetchuserorganizations.d.ts.map +0 -1
- package/models/operations/supportcontrollerfetchuserorganizations.js +0 -96
- package/models/operations/supportcontrollerfetchuserorganizations.js.map +0 -1
- package/src/models/components/createsupportthreaddto.ts +0 -66
- package/src/models/components/plaincardrequestdto.ts +0 -223
- 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/src/models/operations/supportcontrollercreatethread.ts +0 -90
- package/src/models/operations/supportcontrollerfetchuserorganizations.ts +0 -163
package/docs/sdks/novu/README.md
CHANGED
|
@@ -13,8 +13,6 @@ Novu Documentation
|
|
|
13
13
|
* [triggerBulk](#triggerbulk) - Bulk trigger event
|
|
14
14
|
* [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
|
|
15
15
|
* [cancel](#cancel) - Cancel triggered event
|
|
16
|
-
* [supportControllerFetchUserOrganizations](#supportcontrollerfetchuserorganizations)
|
|
17
|
-
* [create](#create)
|
|
18
16
|
|
|
19
17
|
## trigger
|
|
20
18
|
|
|
@@ -30,19 +28,18 @@ Novu Documentation
|
|
|
30
28
|
import { Novu } from "@novu/api";
|
|
31
29
|
|
|
32
30
|
const novu = new Novu({
|
|
33
|
-
|
|
31
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
34
32
|
});
|
|
35
33
|
|
|
36
34
|
async function run() {
|
|
37
35
|
const result = await novu.trigger({
|
|
38
|
-
|
|
36
|
+
workflowId: "workflow_identifier",
|
|
39
37
|
payload: {
|
|
40
38
|
"comment_id": "string",
|
|
41
39
|
"post": {
|
|
42
40
|
"text": "string",
|
|
43
41
|
},
|
|
44
42
|
},
|
|
45
|
-
bridgeUrl: "https://example.com/bridge",
|
|
46
43
|
overrides: {
|
|
47
44
|
"fcm": {
|
|
48
45
|
"data": {
|
|
@@ -73,19 +70,18 @@ import { trigger } from "@novu/api/funcs/trigger.js";
|
|
|
73
70
|
// Use `NovuCore` for best tree-shaking performance.
|
|
74
71
|
// You can create one instance of it to use across an application.
|
|
75
72
|
const novu = new NovuCore({
|
|
76
|
-
|
|
73
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
77
74
|
});
|
|
78
75
|
|
|
79
76
|
async function run() {
|
|
80
77
|
const res = await trigger(novu, {
|
|
81
|
-
|
|
78
|
+
workflowId: "workflow_identifier",
|
|
82
79
|
payload: {
|
|
83
80
|
"comment_id": "string",
|
|
84
81
|
"post": {
|
|
85
82
|
"text": "string",
|
|
86
83
|
},
|
|
87
84
|
},
|
|
88
|
-
bridgeUrl: "https://example.com/bridge",
|
|
89
85
|
overrides: {
|
|
90
86
|
"fcm": {
|
|
91
87
|
"data": {
|
|
@@ -129,8 +125,8 @@ run();
|
|
|
129
125
|
|
|
130
126
|
| Error Type | Status Code | Content Type |
|
|
131
127
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
132
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
133
128
|
| errors.ErrorDto | 414 | application/json |
|
|
129
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
134
130
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
135
131
|
| errors.ErrorDto | 500 | application/json |
|
|
136
132
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -148,21 +144,20 @@ run();
|
|
|
148
144
|
import { Novu } from "@novu/api";
|
|
149
145
|
|
|
150
146
|
const novu = new Novu({
|
|
151
|
-
|
|
147
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
152
148
|
});
|
|
153
149
|
|
|
154
150
|
async function run() {
|
|
155
151
|
const result = await novu.triggerBulk({
|
|
156
152
|
events: [
|
|
157
153
|
{
|
|
158
|
-
|
|
154
|
+
workflowId: "workflow_identifier",
|
|
159
155
|
payload: {
|
|
160
156
|
"comment_id": "string",
|
|
161
157
|
"post": {
|
|
162
158
|
"text": "string",
|
|
163
159
|
},
|
|
164
160
|
},
|
|
165
|
-
bridgeUrl: "https://example.com/bridge",
|
|
166
161
|
overrides: {
|
|
167
162
|
"fcm": {
|
|
168
163
|
"data": {
|
|
@@ -175,14 +170,13 @@ async function run() {
|
|
|
175
170
|
},
|
|
176
171
|
},
|
|
177
172
|
{
|
|
178
|
-
|
|
173
|
+
workflowId: "workflow_identifier",
|
|
179
174
|
payload: {
|
|
180
175
|
"comment_id": "string",
|
|
181
176
|
"post": {
|
|
182
177
|
"text": "string",
|
|
183
178
|
},
|
|
184
179
|
},
|
|
185
|
-
bridgeUrl: "https://example.com/bridge",
|
|
186
180
|
overrides: {
|
|
187
181
|
"fcm": {
|
|
188
182
|
"data": {
|
|
@@ -198,14 +192,13 @@ async function run() {
|
|
|
198
192
|
],
|
|
199
193
|
},
|
|
200
194
|
{
|
|
201
|
-
|
|
195
|
+
workflowId: "workflow_identifier",
|
|
202
196
|
payload: {
|
|
203
197
|
"comment_id": "string",
|
|
204
198
|
"post": {
|
|
205
199
|
"text": "string",
|
|
206
200
|
},
|
|
207
201
|
},
|
|
208
|
-
bridgeUrl: "https://example.com/bridge",
|
|
209
202
|
overrides: {
|
|
210
203
|
"fcm": {
|
|
211
204
|
"data": {
|
|
@@ -239,21 +232,20 @@ import { triggerBulk } from "@novu/api/funcs/triggerBulk.js";
|
|
|
239
232
|
// Use `NovuCore` for best tree-shaking performance.
|
|
240
233
|
// You can create one instance of it to use across an application.
|
|
241
234
|
const novu = new NovuCore({
|
|
242
|
-
|
|
235
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
243
236
|
});
|
|
244
237
|
|
|
245
238
|
async function run() {
|
|
246
239
|
const res = await triggerBulk(novu, {
|
|
247
240
|
events: [
|
|
248
241
|
{
|
|
249
|
-
|
|
242
|
+
workflowId: "workflow_identifier",
|
|
250
243
|
payload: {
|
|
251
244
|
"comment_id": "string",
|
|
252
245
|
"post": {
|
|
253
246
|
"text": "string",
|
|
254
247
|
},
|
|
255
248
|
},
|
|
256
|
-
bridgeUrl: "https://example.com/bridge",
|
|
257
249
|
overrides: {
|
|
258
250
|
"fcm": {
|
|
259
251
|
"data": {
|
|
@@ -266,14 +258,13 @@ async function run() {
|
|
|
266
258
|
},
|
|
267
259
|
},
|
|
268
260
|
{
|
|
269
|
-
|
|
261
|
+
workflowId: "workflow_identifier",
|
|
270
262
|
payload: {
|
|
271
263
|
"comment_id": "string",
|
|
272
264
|
"post": {
|
|
273
265
|
"text": "string",
|
|
274
266
|
},
|
|
275
267
|
},
|
|
276
|
-
bridgeUrl: "https://example.com/bridge",
|
|
277
268
|
overrides: {
|
|
278
269
|
"fcm": {
|
|
279
270
|
"data": {
|
|
@@ -289,14 +280,13 @@ async function run() {
|
|
|
289
280
|
],
|
|
290
281
|
},
|
|
291
282
|
{
|
|
292
|
-
|
|
283
|
+
workflowId: "workflow_identifier",
|
|
293
284
|
payload: {
|
|
294
285
|
"comment_id": "string",
|
|
295
286
|
"post": {
|
|
296
287
|
"text": "string",
|
|
297
288
|
},
|
|
298
289
|
},
|
|
299
|
-
bridgeUrl: "https://example.com/bridge",
|
|
300
290
|
overrides: {
|
|
301
291
|
"fcm": {
|
|
302
292
|
"data": {
|
|
@@ -343,8 +333,8 @@ run();
|
|
|
343
333
|
|
|
344
334
|
| Error Type | Status Code | Content Type |
|
|
345
335
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
346
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
347
336
|
| errors.ErrorDto | 414 | application/json |
|
|
337
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
348
338
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
349
339
|
| errors.ErrorDto | 500 | application/json |
|
|
350
340
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -360,7 +350,7 @@ Trigger a broadcast event to all existing subscribers, could be used to send ann
|
|
|
360
350
|
import { Novu } from "@novu/api";
|
|
361
351
|
|
|
362
352
|
const novu = new Novu({
|
|
363
|
-
|
|
353
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
364
354
|
});
|
|
365
355
|
|
|
366
356
|
async function run() {
|
|
@@ -392,7 +382,7 @@ import { triggerBroadcast } from "@novu/api/funcs/triggerBroadcast.js";
|
|
|
392
382
|
// Use `NovuCore` for best tree-shaking performance.
|
|
393
383
|
// You can create one instance of it to use across an application.
|
|
394
384
|
const novu = new NovuCore({
|
|
395
|
-
|
|
385
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
396
386
|
});
|
|
397
387
|
|
|
398
388
|
async function run() {
|
|
@@ -437,8 +427,8 @@ run();
|
|
|
437
427
|
|
|
438
428
|
| Error Type | Status Code | Content Type |
|
|
439
429
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
440
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
441
430
|
| errors.ErrorDto | 414 | application/json |
|
|
431
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
442
432
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
443
433
|
| errors.ErrorDto | 500 | application/json |
|
|
444
434
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -456,7 +446,7 @@ run();
|
|
|
456
446
|
import { Novu } from "@novu/api";
|
|
457
447
|
|
|
458
448
|
const novu = new Novu({
|
|
459
|
-
|
|
449
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
460
450
|
});
|
|
461
451
|
|
|
462
452
|
async function run() {
|
|
@@ -480,7 +470,7 @@ import { cancel } from "@novu/api/funcs/cancel.js";
|
|
|
480
470
|
// Use `NovuCore` for best tree-shaking performance.
|
|
481
471
|
// You can create one instance of it to use across an application.
|
|
482
472
|
const novu = new NovuCore({
|
|
483
|
-
|
|
473
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
484
474
|
});
|
|
485
475
|
|
|
486
476
|
async function run() {
|
|
@@ -517,156 +507,8 @@ run();
|
|
|
517
507
|
|
|
518
508
|
| Error Type | Status Code | Content Type |
|
|
519
509
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
520
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
521
510
|
| errors.ErrorDto | 414 | application/json |
|
|
511
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
522
512
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
523
513
|
| errors.ErrorDto | 500 | application/json |
|
|
524
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
525
|
-
|
|
526
|
-
## supportControllerFetchUserOrganizations
|
|
527
|
-
|
|
528
|
-
### Example Usage
|
|
529
|
-
|
|
530
|
-
```typescript
|
|
531
|
-
import { Novu } from "@novu/api";
|
|
532
|
-
|
|
533
|
-
const novu = new Novu({
|
|
534
|
-
apiKey: "<YOUR_API_KEY_HERE>",
|
|
535
|
-
});
|
|
536
|
-
|
|
537
|
-
async function run() {
|
|
538
|
-
const result = await novu.supportControllerFetchUserOrganizations({
|
|
539
|
-
timestamp: "<value>",
|
|
540
|
-
});
|
|
541
|
-
|
|
542
|
-
// Handle the result
|
|
543
|
-
console.log(result);
|
|
544
|
-
}
|
|
545
|
-
|
|
546
|
-
run();
|
|
547
|
-
```
|
|
548
|
-
|
|
549
|
-
### Standalone function
|
|
550
|
-
|
|
551
|
-
The standalone function version of this method:
|
|
552
|
-
|
|
553
|
-
```typescript
|
|
554
|
-
import { NovuCore } from "@novu/api/core.js";
|
|
555
|
-
import { supportControllerFetchUserOrganizations } from "@novu/api/funcs/supportControllerFetchUserOrganizations.js";
|
|
556
|
-
|
|
557
|
-
// Use `NovuCore` for best tree-shaking performance.
|
|
558
|
-
// You can create one instance of it to use across an application.
|
|
559
|
-
const novu = new NovuCore({
|
|
560
|
-
apiKey: "<YOUR_API_KEY_HERE>",
|
|
561
|
-
});
|
|
562
|
-
|
|
563
|
-
async function run() {
|
|
564
|
-
const res = await supportControllerFetchUserOrganizations(novu, {
|
|
565
|
-
timestamp: "<value>",
|
|
566
|
-
});
|
|
567
|
-
|
|
568
|
-
if (!res.ok) {
|
|
569
|
-
throw res.error;
|
|
570
|
-
}
|
|
571
|
-
|
|
572
|
-
const { value: result } = res;
|
|
573
|
-
|
|
574
|
-
// Handle the result
|
|
575
|
-
console.log(result);
|
|
576
|
-
}
|
|
577
|
-
|
|
578
|
-
run();
|
|
579
|
-
```
|
|
580
|
-
|
|
581
|
-
### Parameters
|
|
582
|
-
|
|
583
|
-
| Parameter | Type | Required | Description |
|
|
584
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
585
|
-
| `plainCardRequestDto` | [components.PlainCardRequestDto](../../models/components/plaincardrequestdto.md) | :heavy_check_mark: | N/A |
|
|
586
|
-
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
587
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
588
|
-
| `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. |
|
|
589
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
590
|
-
|
|
591
|
-
### Response
|
|
592
|
-
|
|
593
|
-
**Promise\<[operations.SupportControllerFetchUserOrganizationsResponseBody](../../models/operations/supportcontrollerfetchuserorganizationsresponsebody.md)\>**
|
|
594
|
-
|
|
595
|
-
### Errors
|
|
596
|
-
|
|
597
|
-
| Error Type | Status Code | Content Type |
|
|
598
|
-
| --------------- | --------------- | --------------- |
|
|
599
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
600
|
-
|
|
601
|
-
## create
|
|
602
|
-
|
|
603
|
-
### Example Usage
|
|
604
|
-
|
|
605
|
-
```typescript
|
|
606
|
-
import { Novu } from "@novu/api";
|
|
607
|
-
|
|
608
|
-
const novu = new Novu({
|
|
609
|
-
apiKey: "<YOUR_API_KEY_HERE>",
|
|
610
|
-
});
|
|
611
|
-
|
|
612
|
-
async function run() {
|
|
613
|
-
await novu.create({
|
|
614
|
-
text: "<value>",
|
|
615
|
-
});
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
}
|
|
619
|
-
|
|
620
|
-
run();
|
|
621
|
-
```
|
|
622
|
-
|
|
623
|
-
### Standalone function
|
|
624
|
-
|
|
625
|
-
The standalone function version of this method:
|
|
626
|
-
|
|
627
|
-
```typescript
|
|
628
|
-
import { NovuCore } from "@novu/api/core.js";
|
|
629
|
-
import { create } from "@novu/api/funcs/create.js";
|
|
630
|
-
|
|
631
|
-
// Use `NovuCore` for best tree-shaking performance.
|
|
632
|
-
// You can create one instance of it to use across an application.
|
|
633
|
-
const novu = new NovuCore({
|
|
634
|
-
apiKey: "<YOUR_API_KEY_HERE>",
|
|
635
|
-
});
|
|
636
|
-
|
|
637
|
-
async function run() {
|
|
638
|
-
const res = await create(novu, {
|
|
639
|
-
text: "<value>",
|
|
640
|
-
});
|
|
641
|
-
|
|
642
|
-
if (!res.ok) {
|
|
643
|
-
throw res.error;
|
|
644
|
-
}
|
|
645
|
-
|
|
646
|
-
const { value: result } = res;
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
run();
|
|
652
|
-
```
|
|
653
|
-
|
|
654
|
-
### Parameters
|
|
655
|
-
|
|
656
|
-
| Parameter | Type | Required | Description |
|
|
657
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
658
|
-
| `createSupportThreadDto` | [components.CreateSupportThreadDto](../../models/components/createsupportthreaddto.md) | :heavy_check_mark: | N/A |
|
|
659
|
-
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
660
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
661
|
-
| `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. |
|
|
662
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
663
|
-
|
|
664
|
-
### Response
|
|
665
|
-
|
|
666
|
-
**Promise\<void\>**
|
|
667
|
-
|
|
668
|
-
### Errors
|
|
669
|
-
|
|
670
|
-
| Error Type | Status Code | Content Type |
|
|
671
|
-
| --------------- | --------------- | --------------- |
|
|
672
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
514
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -19,7 +19,7 @@ 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() {
|
|
@@ -46,7 +46,7 @@ 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() {
|
|
@@ -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,13 +18,12 @@ 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,
|
|
28
27
|
payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
|
|
29
28
|
});
|
|
30
29
|
|
|
@@ -46,13 +45,12 @@ import { subscribersNotificationsFeed } from "@novu/api/funcs/subscribersNotific
|
|
|
46
45
|
// Use `NovuCore` for best tree-shaking performance.
|
|
47
46
|
// You can create one instance of it to use across an application.
|
|
48
47
|
const novu = new NovuCore({
|
|
49
|
-
|
|
48
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
50
49
|
});
|
|
51
50
|
|
|
52
51
|
async function run() {
|
|
53
52
|
const res = await subscribersNotificationsFeed(novu, {
|
|
54
53
|
subscriberId: "<id>",
|
|
55
|
-
limit: 10,
|
|
56
54
|
payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
|
|
57
55
|
});
|
|
58
56
|
|
|
@@ -73,21 +71,21 @@ run();
|
|
|
73
71
|
|
|
74
72
|
| Parameter | Type | Required | Description |
|
|
75
73
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
76
|
-
| `request` | [operations.
|
|
74
|
+
| `request` | [operations.SubscribersV1ControllerGetNotificationsFeedRequest](../../models/operations/subscribersv1controllergetnotificationsfeedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
77
75
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
78
76
|
| `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. |
|
|
79
77
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
80
78
|
|
|
81
79
|
### Response
|
|
82
80
|
|
|
83
|
-
**Promise\<[operations.
|
|
81
|
+
**Promise\<[operations.SubscribersV1ControllerGetNotificationsFeedResponse](../../models/operations/subscribersv1controllergetnotificationsfeedresponse.md)\>**
|
|
84
82
|
|
|
85
83
|
### Errors
|
|
86
84
|
|
|
87
85
|
| Error Type | Status Code | Content Type |
|
|
88
86
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
89
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
90
87
|
| errors.ErrorDto | 414 | application/json |
|
|
88
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
91
89
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
92
90
|
| errors.ErrorDto | 500 | application/json |
|
|
93
91
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -102,14 +100,12 @@ Get the unseen in-app notifications count for subscribers feed
|
|
|
102
100
|
import { Novu } from "@novu/api";
|
|
103
101
|
|
|
104
102
|
const novu = new Novu({
|
|
105
|
-
|
|
103
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
106
104
|
});
|
|
107
105
|
|
|
108
106
|
async function run() {
|
|
109
107
|
const result = await novu.subscribers.notifications.unseenCount({
|
|
110
108
|
subscriberId: "<id>",
|
|
111
|
-
seen: false,
|
|
112
|
-
limit: 100,
|
|
113
109
|
});
|
|
114
110
|
|
|
115
111
|
// Handle the result
|
|
@@ -130,14 +126,12 @@ import { subscribersNotificationsUnseenCount } from "@novu/api/funcs/subscribers
|
|
|
130
126
|
// Use `NovuCore` for best tree-shaking performance.
|
|
131
127
|
// You can create one instance of it to use across an application.
|
|
132
128
|
const novu = new NovuCore({
|
|
133
|
-
|
|
129
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
134
130
|
});
|
|
135
131
|
|
|
136
132
|
async function run() {
|
|
137
133
|
const res = await subscribersNotificationsUnseenCount(novu, {
|
|
138
134
|
subscriberId: "<id>",
|
|
139
|
-
seen: false,
|
|
140
|
-
limit: 100,
|
|
141
135
|
});
|
|
142
136
|
|
|
143
137
|
if (!res.ok) {
|
|
@@ -157,21 +151,21 @@ run();
|
|
|
157
151
|
|
|
158
152
|
| Parameter | Type | Required | Description |
|
|
159
153
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
160
|
-
| `request` | [operations.
|
|
154
|
+
| `request` | [operations.SubscribersV1ControllerGetUnseenCountRequest](../../models/operations/subscribersv1controllergetunseencountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
161
155
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
162
156
|
| `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. |
|
|
163
157
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
164
158
|
|
|
165
159
|
### Response
|
|
166
160
|
|
|
167
|
-
**Promise\<[operations.
|
|
161
|
+
**Promise\<[operations.SubscribersV1ControllerGetUnseenCountResponse](../../models/operations/subscribersv1controllergetunseencountresponse.md)\>**
|
|
168
162
|
|
|
169
163
|
### Errors
|
|
170
164
|
|
|
171
165
|
| Error Type | Status Code | Content Type |
|
|
172
166
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
173
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
174
167
|
| errors.ErrorDto | 414 | application/json |
|
|
168
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
175
169
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
176
170
|
| errors.ErrorDto | 500 | application/json |
|
|
177
171
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|