@novu/api 0.1.1 → 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 +2 -3
- package/README.md +36 -42
- 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 +9 -9
- package/docs/sdks/notifications/README.md +6 -6
- package/docs/sdks/novu/README.md +21 -179
- package/docs/sdks/novumessages/README.md +13 -13
- package/docs/sdks/novunotifications/README.md +10 -10
- package/docs/sdks/novusubscribers/README.md +9 -9
- package/docs/sdks/preferences/README.md +18 -18
- package/docs/sdks/properties/README.md +4 -4
- package/docs/sdks/stats/README.md +6 -6
- package/docs/sdks/subscribers/README.md +347 -33
- 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/{create.js → subscribersDeleteLegacy.js} +51 -20
- 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/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/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 -4
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +4 -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/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 -21
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +23 -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/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 +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 +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/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 +2327 -344
- 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/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/{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/index.ts +4 -4
- 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 -21
- 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/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 +0 -59
- 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/FUNCTIONS.md
CHANGED
|
@@ -26,19 +26,18 @@ import { SDKValidationError } from "@novu/api/models/errors/sdkvalidationerror.j
|
|
|
26
26
|
// Use `NovuCore` for best tree-shaking performance.
|
|
27
27
|
// You can create one instance of it to use across an application.
|
|
28
28
|
const novu = new NovuCore({
|
|
29
|
-
|
|
29
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
30
30
|
});
|
|
31
31
|
|
|
32
32
|
async function run() {
|
|
33
33
|
const res = await trigger(novu, {
|
|
34
|
-
|
|
34
|
+
workflowId: "workflow_identifier",
|
|
35
35
|
payload: {
|
|
36
36
|
"comment_id": "string",
|
|
37
37
|
"post": {
|
|
38
38
|
"text": "string",
|
|
39
39
|
},
|
|
40
40
|
},
|
|
41
|
-
bridgeUrl: "https://example.com/bridge",
|
|
42
41
|
overrides: {
|
|
43
42
|
"fcm": {
|
|
44
43
|
"data": {
|
package/README.md
CHANGED
|
@@ -83,19 +83,18 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
|
|
83
83
|
import { Novu } from "@novu/api";
|
|
84
84
|
|
|
85
85
|
const novu = new Novu({
|
|
86
|
-
|
|
86
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
87
87
|
});
|
|
88
88
|
|
|
89
89
|
async function run() {
|
|
90
90
|
const result = await novu.trigger({
|
|
91
|
-
|
|
91
|
+
workflowId: "workflow_identifier",
|
|
92
92
|
payload: {
|
|
93
93
|
"comment_id": "string",
|
|
94
94
|
"post": {
|
|
95
95
|
"text": "string",
|
|
96
96
|
},
|
|
97
97
|
},
|
|
98
|
-
bridgeUrl: "https://example.com/bridge",
|
|
99
98
|
overrides: {
|
|
100
99
|
"fcm": {
|
|
101
100
|
"data": {
|
|
@@ -122,21 +121,20 @@ run();
|
|
|
122
121
|
import { Novu } from "@novu/api";
|
|
123
122
|
|
|
124
123
|
const novu = new Novu({
|
|
125
|
-
|
|
124
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
126
125
|
});
|
|
127
126
|
|
|
128
127
|
async function run() {
|
|
129
128
|
const result = await novu.triggerBulk({
|
|
130
129
|
events: [
|
|
131
130
|
{
|
|
132
|
-
|
|
131
|
+
workflowId: "workflow_identifier",
|
|
133
132
|
payload: {
|
|
134
133
|
"comment_id": "string",
|
|
135
134
|
"post": {
|
|
136
135
|
"text": "string",
|
|
137
136
|
},
|
|
138
137
|
},
|
|
139
|
-
bridgeUrl: "https://example.com/bridge",
|
|
140
138
|
overrides: {
|
|
141
139
|
"fcm": {
|
|
142
140
|
"data": {
|
|
@@ -149,14 +147,13 @@ async function run() {
|
|
|
149
147
|
},
|
|
150
148
|
},
|
|
151
149
|
{
|
|
152
|
-
|
|
150
|
+
workflowId: "workflow_identifier",
|
|
153
151
|
payload: {
|
|
154
152
|
"comment_id": "string",
|
|
155
153
|
"post": {
|
|
156
154
|
"text": "string",
|
|
157
155
|
},
|
|
158
156
|
},
|
|
159
|
-
bridgeUrl: "https://example.com/bridge",
|
|
160
157
|
overrides: {
|
|
161
158
|
"fcm": {
|
|
162
159
|
"data": {
|
|
@@ -172,14 +169,13 @@ async function run() {
|
|
|
172
169
|
],
|
|
173
170
|
},
|
|
174
171
|
{
|
|
175
|
-
|
|
172
|
+
workflowId: "workflow_identifier",
|
|
176
173
|
payload: {
|
|
177
174
|
"comment_id": "string",
|
|
178
175
|
"post": {
|
|
179
176
|
"text": "string",
|
|
180
177
|
},
|
|
181
178
|
},
|
|
182
|
-
bridgeUrl: "https://example.com/bridge",
|
|
183
179
|
overrides: {
|
|
184
180
|
"fcm": {
|
|
185
181
|
"data": {
|
|
@@ -209,7 +205,7 @@ run();
|
|
|
209
205
|
import { Novu } from "@novu/api";
|
|
210
206
|
|
|
211
207
|
const novu = new Novu({
|
|
212
|
-
|
|
208
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
213
209
|
});
|
|
214
210
|
|
|
215
211
|
async function run() {
|
|
@@ -237,7 +233,7 @@ run();
|
|
|
237
233
|
import { Novu } from "@novu/api";
|
|
238
234
|
|
|
239
235
|
const novu = new Novu({
|
|
240
|
-
|
|
236
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
241
237
|
});
|
|
242
238
|
|
|
243
239
|
async function run() {
|
|
@@ -293,17 +289,19 @@ run();
|
|
|
293
289
|
* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
|
|
294
290
|
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
|
|
295
291
|
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
|
|
296
|
-
* [supportControllerFetchUserOrganizations](docs/sdks/novu/README.md#supportcontrollerfetchuserorganizations)
|
|
297
|
-
* [create](docs/sdks/novu/README.md#create)
|
|
298
292
|
|
|
299
293
|
### [subscribers](docs/sdks/subscribers/README.md)
|
|
300
294
|
|
|
301
295
|
* [list](docs/sdks/subscribers/README.md#list) - Get subscribers
|
|
302
296
|
* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
|
|
303
|
-
* [
|
|
297
|
+
* [retrieveLegacy](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
|
|
304
298
|
* [update](docs/sdks/subscribers/README.md#update) - Update subscriber
|
|
305
|
-
* [
|
|
299
|
+
* [~~deleteLegacy~~](docs/sdks/subscribers/README.md#deletelegacy) - Delete subscriber :warning: **Deprecated**
|
|
306
300
|
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
|
|
301
|
+
* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
|
|
302
|
+
* [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
|
|
303
|
+
* [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
|
|
304
|
+
* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
|
|
307
305
|
|
|
308
306
|
#### [subscribers.authentication](docs/sdks/authentication/README.md)
|
|
309
307
|
|
|
@@ -371,7 +369,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
371
369
|
<summary>Available standalone functions</summary>
|
|
372
370
|
|
|
373
371
|
- [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
|
|
374
|
-
- [`create`](docs/sdks/novu/README.md#create)
|
|
375
372
|
- [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
|
|
376
373
|
- [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete integration
|
|
377
374
|
- [`integrationsList`](docs/sdks/integrations/README.md#list) - Get integrations
|
|
@@ -400,14 +397,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
400
397
|
- [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
|
|
401
398
|
- [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
|
|
402
399
|
- [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
|
|
400
|
+
- [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Patch subscriber
|
|
403
401
|
- [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
|
|
404
402
|
- [`subscribersPreferencesRetrieveByLevel`](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level
|
|
405
403
|
- [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber preference
|
|
406
404
|
- [`subscribersPreferencesUpdateGlobal`](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences
|
|
407
405
|
- [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
|
|
408
406
|
- [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
|
|
407
|
+
- [`subscribersRetrieveLegacy`](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
|
|
408
|
+
- [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search for subscribers
|
|
409
409
|
- [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
|
|
410
|
-
- [`supportControllerFetchUserOrganizations`](docs/sdks/novu/README.md#supportcontrollerfetchuserorganizations)
|
|
411
410
|
- [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
|
|
412
411
|
- [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
|
|
413
412
|
- [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered
|
|
@@ -419,6 +418,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
419
418
|
- [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
|
|
420
419
|
- [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
|
|
421
420
|
- [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
|
|
421
|
+
- ~~[`subscribersDeleteLegacy`](docs/sdks/subscribers/README.md#deletelegacy)~~ - Delete subscriber :warning: **Deprecated**
|
|
422
422
|
|
|
423
423
|
</details>
|
|
424
424
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
@@ -439,7 +439,7 @@ Here's an example of one such pagination call:
|
|
|
439
439
|
import { Novu } from "@novu/api";
|
|
440
440
|
|
|
441
441
|
const novu = new Novu({
|
|
442
|
-
|
|
442
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
443
443
|
});
|
|
444
444
|
|
|
445
445
|
async function run() {
|
|
@@ -463,8 +463,8 @@ Some methods specify known errors which can be thrown. All the known errors are
|
|
|
463
463
|
|
|
464
464
|
| Error Type | Status Code | Content Type |
|
|
465
465
|
| ------------------------- | -------------------------------------- | ---------------- |
|
|
466
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
467
466
|
| errors.ErrorDto | 414 | application/json |
|
|
467
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
468
468
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
469
469
|
| errors.ErrorDto | 500 | application/json |
|
|
470
470
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -480,21 +480,20 @@ import {
|
|
|
480
480
|
} from "@novu/api/models/errors";
|
|
481
481
|
|
|
482
482
|
const novu = new Novu({
|
|
483
|
-
|
|
483
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
484
484
|
});
|
|
485
485
|
|
|
486
486
|
async function run() {
|
|
487
487
|
let result;
|
|
488
488
|
try {
|
|
489
489
|
result = await novu.trigger({
|
|
490
|
-
|
|
490
|
+
workflowId: "workflow_identifier",
|
|
491
491
|
payload: {
|
|
492
492
|
"comment_id": "string",
|
|
493
493
|
"post": {
|
|
494
494
|
"text": "string",
|
|
495
495
|
},
|
|
496
496
|
},
|
|
497
|
-
bridgeUrl: "https://example.com/bridge",
|
|
498
497
|
overrides: {
|
|
499
498
|
"fcm": {
|
|
500
499
|
"data": {
|
|
@@ -583,19 +582,18 @@ import { Novu } from "@novu/api";
|
|
|
583
582
|
|
|
584
583
|
const novu = new Novu({
|
|
585
584
|
serverIdx: 1,
|
|
586
|
-
|
|
585
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
587
586
|
});
|
|
588
587
|
|
|
589
588
|
async function run() {
|
|
590
589
|
const result = await novu.trigger({
|
|
591
|
-
|
|
590
|
+
workflowId: "workflow_identifier",
|
|
592
591
|
payload: {
|
|
593
592
|
"comment_id": "string",
|
|
594
593
|
"post": {
|
|
595
594
|
"text": "string",
|
|
596
595
|
},
|
|
597
596
|
},
|
|
598
|
-
bridgeUrl: "https://example.com/bridge",
|
|
599
597
|
overrides: {
|
|
600
598
|
"fcm": {
|
|
601
599
|
"data": {
|
|
@@ -624,19 +622,18 @@ import { Novu } from "@novu/api";
|
|
|
624
622
|
|
|
625
623
|
const novu = new Novu({
|
|
626
624
|
serverURL: "https://api.novu.co",
|
|
627
|
-
|
|
625
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
628
626
|
});
|
|
629
627
|
|
|
630
628
|
async function run() {
|
|
631
629
|
const result = await novu.trigger({
|
|
632
|
-
|
|
630
|
+
workflowId: "workflow_identifier",
|
|
633
631
|
payload: {
|
|
634
632
|
"comment_id": "string",
|
|
635
633
|
"post": {
|
|
636
634
|
"text": "string",
|
|
637
635
|
},
|
|
638
636
|
},
|
|
639
|
-
bridgeUrl: "https://example.com/bridge",
|
|
640
637
|
overrides: {
|
|
641
638
|
"fcm": {
|
|
642
639
|
"data": {
|
|
@@ -714,28 +711,27 @@ const sdk = new Novu({ httpClient });
|
|
|
714
711
|
|
|
715
712
|
This SDK supports the following security scheme globally:
|
|
716
713
|
|
|
717
|
-
| Name
|
|
718
|
-
|
|
|
719
|
-
| `
|
|
714
|
+
| Name | Type | Scheme |
|
|
715
|
+
| ----------- | ------ | ------- |
|
|
716
|
+
| `secretKey` | apiKey | API key |
|
|
720
717
|
|
|
721
|
-
To authenticate with the API the `
|
|
718
|
+
To authenticate with the API the `secretKey` parameter must be set when initializing the SDK client instance. For example:
|
|
722
719
|
```typescript
|
|
723
720
|
import { Novu } from "@novu/api";
|
|
724
721
|
|
|
725
722
|
const novu = new Novu({
|
|
726
|
-
|
|
723
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
727
724
|
});
|
|
728
725
|
|
|
729
726
|
async function run() {
|
|
730
727
|
const result = await novu.trigger({
|
|
731
|
-
|
|
728
|
+
workflowId: "workflow_identifier",
|
|
732
729
|
payload: {
|
|
733
730
|
"comment_id": "string",
|
|
734
731
|
"post": {
|
|
735
732
|
"text": "string",
|
|
736
733
|
},
|
|
737
734
|
},
|
|
738
|
-
bridgeUrl: "https://example.com/bridge",
|
|
739
735
|
overrides: {
|
|
740
736
|
"fcm": {
|
|
741
737
|
"data": {
|
|
@@ -767,19 +763,18 @@ To change the default retry strategy for a single API call, simply provide a ret
|
|
|
767
763
|
import { Novu } from "@novu/api";
|
|
768
764
|
|
|
769
765
|
const novu = new Novu({
|
|
770
|
-
|
|
766
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
771
767
|
});
|
|
772
768
|
|
|
773
769
|
async function run() {
|
|
774
770
|
const result = await novu.trigger({
|
|
775
|
-
|
|
771
|
+
workflowId: "workflow_identifier",
|
|
776
772
|
payload: {
|
|
777
773
|
"comment_id": "string",
|
|
778
774
|
"post": {
|
|
779
775
|
"text": "string",
|
|
780
776
|
},
|
|
781
777
|
},
|
|
782
|
-
bridgeUrl: "https://example.com/bridge",
|
|
783
778
|
overrides: {
|
|
784
779
|
"fcm": {
|
|
785
780
|
"data": {
|
|
@@ -826,19 +821,18 @@ const novu = new Novu({
|
|
|
826
821
|
},
|
|
827
822
|
retryConnectionErrors: false,
|
|
828
823
|
},
|
|
829
|
-
|
|
824
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
830
825
|
});
|
|
831
826
|
|
|
832
827
|
async function run() {
|
|
833
828
|
const result = await novu.trigger({
|
|
834
|
-
|
|
829
|
+
workflowId: "workflow_identifier",
|
|
835
830
|
payload: {
|
|
836
831
|
"comment_id": "string",
|
|
837
832
|
"post": {
|
|
838
833
|
"text": "string",
|
|
839
834
|
},
|
|
840
835
|
},
|
|
841
|
-
bridgeUrl: "https://example.com/bridge",
|
|
842
836
|
overrides: {
|
|
843
837
|
"fcm": {
|
|
844
838
|
"data": {
|
|
@@ -18,7 +18,7 @@ Handle providers oauth redirect
|
|
|
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() {
|
|
@@ -48,7 +48,7 @@ import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/func
|
|
|
48
48
|
// Use `NovuCore` for best tree-shaking performance.
|
|
49
49
|
// You can create one instance of it to use across an application.
|
|
50
50
|
const novu = new NovuCore({
|
|
51
|
-
|
|
51
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
52
52
|
});
|
|
53
53
|
|
|
54
54
|
async function run() {
|
|
@@ -77,21 +77,21 @@ run();
|
|
|
77
77
|
|
|
78
78
|
| Parameter | Type | Required | Description |
|
|
79
79
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
80
|
-
| `request` | [operations.
|
|
80
|
+
| `request` | [operations.SubscribersV1ControllerChatOauthCallbackRequest](../../models/operations/subscribersv1controllerchatoauthcallbackrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
81
81
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
82
82
|
| `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. |
|
|
83
83
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
84
84
|
|
|
85
85
|
### Response
|
|
86
86
|
|
|
87
|
-
**Promise\<[operations.
|
|
87
|
+
**Promise\<[operations.SubscribersV1ControllerChatOauthCallbackResponse](../../models/operations/subscribersv1controllerchatoauthcallbackresponse.md)\>**
|
|
88
88
|
|
|
89
89
|
### Errors
|
|
90
90
|
|
|
91
91
|
| Error Type | Status Code | Content Type |
|
|
92
92
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
93
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
94
93
|
| errors.ErrorDto | 414 | application/json |
|
|
94
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
95
95
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
96
96
|
| errors.ErrorDto | 500 | application/json |
|
|
97
97
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -106,7 +106,7 @@ Handle chat oauth
|
|
|
106
106
|
import { Novu } from "@novu/api";
|
|
107
107
|
|
|
108
108
|
const novu = new Novu({
|
|
109
|
-
|
|
109
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
110
110
|
});
|
|
111
111
|
|
|
112
112
|
async function run() {
|
|
@@ -135,7 +135,7 @@ import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscr
|
|
|
135
135
|
// Use `NovuCore` for best tree-shaking performance.
|
|
136
136
|
// You can create one instance of it to use across an application.
|
|
137
137
|
const novu = new NovuCore({
|
|
138
|
-
|
|
138
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
139
139
|
});
|
|
140
140
|
|
|
141
141
|
async function run() {
|
|
@@ -163,21 +163,21 @@ run();
|
|
|
163
163
|
|
|
164
164
|
| Parameter | Type | Required | Description |
|
|
165
165
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
166
|
-
| `request` | [operations.
|
|
166
|
+
| `request` | [operations.SubscribersV1ControllerChatAccessOauthRequest](../../models/operations/subscribersv1controllerchataccessoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
167
167
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
168
168
|
| `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. |
|
|
169
169
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
170
170
|
|
|
171
171
|
### Response
|
|
172
172
|
|
|
173
|
-
**Promise\<[operations.
|
|
173
|
+
**Promise\<[operations.SubscribersV1ControllerChatAccessOauthResponse](../../models/operations/subscribersv1controllerchataccessoauthresponse.md)\>**
|
|
174
174
|
|
|
175
175
|
### Errors
|
|
176
176
|
|
|
177
177
|
| Error Type | Status Code | Content Type |
|
|
178
178
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
179
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
180
179
|
| errors.ErrorDto | 414 | application/json |
|
|
180
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
181
181
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
182
182
|
| errors.ErrorDto | 500 | application/json |
|
|
183
183
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -19,7 +19,7 @@ Subscriber credentials associated to the delivery methods such as slack and push
|
|
|
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() {
|
|
@@ -59,7 +59,7 @@ import { subscribersCredentialsUpdate } from "@novu/api/funcs/subscribersCredent
|
|
|
59
59
|
// Use `NovuCore` for best tree-shaking performance.
|
|
60
60
|
// You can create one instance of it to use across an application.
|
|
61
61
|
const novu = new NovuCore({
|
|
62
|
-
|
|
62
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
63
63
|
});
|
|
64
64
|
|
|
65
65
|
async function run() {
|
|
@@ -107,14 +107,14 @@ run();
|
|
|
107
107
|
|
|
108
108
|
### Response
|
|
109
109
|
|
|
110
|
-
**Promise\<[operations.
|
|
110
|
+
**Promise\<[operations.SubscribersV1ControllerUpdateSubscriberChannelResponse](../../models/operations/subscribersv1controllerupdatesubscriberchannelresponse.md)\>**
|
|
111
111
|
|
|
112
112
|
### Errors
|
|
113
113
|
|
|
114
114
|
| Error Type | Status Code | Content Type |
|
|
115
115
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
116
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
117
116
|
| errors.ErrorDto | 414 | application/json |
|
|
117
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
118
118
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
119
119
|
| errors.ErrorDto | 500 | application/json |
|
|
120
120
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -130,7 +130,7 @@ Subscriber credentials associated to the delivery methods such as slack and push
|
|
|
130
130
|
import { Novu } from "@novu/api";
|
|
131
131
|
|
|
132
132
|
const novu = new Novu({
|
|
133
|
-
|
|
133
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
134
134
|
});
|
|
135
135
|
|
|
136
136
|
async function run() {
|
|
@@ -170,7 +170,7 @@ import { subscribersCredentialsAppend } from "@novu/api/funcs/subscribersCredent
|
|
|
170
170
|
// Use `NovuCore` for best tree-shaking performance.
|
|
171
171
|
// You can create one instance of it to use across an application.
|
|
172
172
|
const novu = new NovuCore({
|
|
173
|
-
|
|
173
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
174
174
|
});
|
|
175
175
|
|
|
176
176
|
async function run() {
|
|
@@ -218,14 +218,14 @@ run();
|
|
|
218
218
|
|
|
219
219
|
### Response
|
|
220
220
|
|
|
221
|
-
**Promise\<[operations.
|
|
221
|
+
**Promise\<[operations.SubscribersV1ControllerModifySubscriberChannelResponse](../../models/operations/subscribersv1controllermodifysubscriberchannelresponse.md)\>**
|
|
222
222
|
|
|
223
223
|
### Errors
|
|
224
224
|
|
|
225
225
|
| Error Type | Status Code | Content Type |
|
|
226
226
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
227
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
228
227
|
| errors.ErrorDto | 414 | application/json |
|
|
228
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
229
229
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
230
230
|
| errors.ErrorDto | 500 | application/json |
|
|
231
231
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -240,7 +240,7 @@ Delete subscriber credentials such as slack and expo tokens.
|
|
|
240
240
|
import { Novu } from "@novu/api";
|
|
241
241
|
|
|
242
242
|
const novu = new Novu({
|
|
243
|
-
|
|
243
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
244
244
|
});
|
|
245
245
|
|
|
246
246
|
async function run() {
|
|
@@ -264,7 +264,7 @@ import { subscribersCredentialsDelete } from "@novu/api/funcs/subscribersCredent
|
|
|
264
264
|
// Use `NovuCore` for best tree-shaking performance.
|
|
265
265
|
// You can create one instance of it to use across an application.
|
|
266
266
|
const novu = new NovuCore({
|
|
267
|
-
|
|
267
|
+
secretKey: "<YOUR_API_KEY_HERE>",
|
|
268
268
|
});
|
|
269
269
|
|
|
270
270
|
async function run() {
|
|
@@ -296,14 +296,14 @@ run();
|
|
|
296
296
|
|
|
297
297
|
### Response
|
|
298
298
|
|
|
299
|
-
**Promise\<[operations.
|
|
299
|
+
**Promise\<[operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse](../../models/operations/subscribersv1controllerdeletesubscribercredentialsresponse.md)\>**
|
|
300
300
|
|
|
301
301
|
### Errors
|
|
302
302
|
|
|
303
303
|
| Error Type | Status Code | Content Type |
|
|
304
304
|
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
305
|
-
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
306
305
|
| errors.ErrorDto | 414 | application/json |
|
|
306
|
+
| errors.ErrorDto | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
|
|
307
307
|
| errors.ValidationErrorDto | 422 | application/json |
|
|
308
308
|
| errors.ErrorDto | 500 | application/json |
|
|
309
309
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|