@novu/api 0.0.1-alpha.149 → 0.0.1-alpha.155
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/RUNTIMES.md +27 -1
- package/docs/sdks/credentials/README.md +39 -24
- package/docs/sdks/integrations/README.md +15 -5
- package/docs/sdks/messages/README.md +8 -4
- package/docs/sdks/notifications/README.md +1 -0
- package/docs/sdks/novu/README.md +7 -3
- package/docs/sdks/novumessages/README.md +24 -14
- package/docs/sdks/novusubscribers/README.md +45 -30
- package/docs/sdks/preferences/README.md +16 -8
- package/docs/sdks/properties/README.md +11 -6
- package/docs/sdks/stats/README.md +2 -0
- package/docs/sdks/subscribers/README.md +52 -42
- package/docs/sdks/topics/README.md +15 -7
- package/docs/sdks/webhooks/README.md +1 -0
- package/funcs/cancel.d.ts +1 -1
- package/funcs/cancel.d.ts.map +1 -1
- package/funcs/cancel.js +8 -6
- package/funcs/cancel.js.map +1 -1
- package/funcs/integrationsCreate.d.ts +1 -1
- package/funcs/integrationsCreate.d.ts.map +1 -1
- package/funcs/integrationsCreate.js +16 -9
- package/funcs/integrationsCreate.js.map +1 -1
- package/funcs/integrationsDelete.d.ts +1 -1
- package/funcs/integrationsDelete.d.ts.map +1 -1
- package/funcs/integrationsDelete.js +8 -6
- package/funcs/integrationsDelete.js.map +1 -1
- package/funcs/integrationsList.d.ts +1 -1
- package/funcs/integrationsList.d.ts.map +1 -1
- package/funcs/integrationsList.js +20 -6
- package/funcs/integrationsList.js.map +1 -1
- package/funcs/integrationsListActive.d.ts +1 -1
- package/funcs/integrationsListActive.d.ts.map +1 -1
- package/funcs/integrationsListActive.js +21 -6
- package/funcs/integrationsListActive.js.map +1 -1
- package/funcs/integrationsSetAsPrimary.d.ts +1 -1
- package/funcs/integrationsSetAsPrimary.d.ts.map +1 -1
- package/funcs/integrationsSetAsPrimary.js +8 -6
- package/funcs/integrationsSetAsPrimary.js.map +1 -1
- package/funcs/integrationsUpdate.d.ts +1 -2
- package/funcs/integrationsUpdate.d.ts.map +1 -1
- package/funcs/integrationsUpdate.js +8 -11
- package/funcs/integrationsUpdate.js.map +1 -1
- package/funcs/integrationsWebhooksRetrieve.d.ts +1 -1
- package/funcs/integrationsWebhooksRetrieve.d.ts.map +1 -1
- package/funcs/integrationsWebhooksRetrieve.js +8 -6
- package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
- package/funcs/messagesDelete.d.ts +1 -1
- package/funcs/messagesDelete.d.ts.map +1 -1
- package/funcs/messagesDelete.js +8 -6
- package/funcs/messagesDelete.js.map +1 -1
- package/funcs/messagesDeleteByTransactionId.d.ts +1 -1
- package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
- package/funcs/messagesDeleteByTransactionId.js +8 -11
- package/funcs/messagesDeleteByTransactionId.js.map +1 -1
- package/funcs/messagesRetrieve.d.ts.map +1 -1
- package/funcs/messagesRetrieve.js +6 -5
- package/funcs/messagesRetrieve.js.map +1 -1
- package/funcs/notificationsList.d.ts.map +1 -1
- package/funcs/notificationsList.js +6 -5
- package/funcs/notificationsList.js.map +1 -1
- package/funcs/notificationsRetrieve.d.ts +1 -1
- package/funcs/notificationsRetrieve.d.ts.map +1 -1
- package/funcs/notificationsRetrieve.js +8 -6
- package/funcs/notificationsRetrieve.js.map +1 -1
- package/funcs/notificationsStatsGraph.d.ts +1 -1
- package/funcs/notificationsStatsGraph.d.ts.map +1 -1
- package/funcs/notificationsStatsGraph.js +8 -6
- package/funcs/notificationsStatsGraph.js.map +1 -1
- package/funcs/notificationsStatsRetrieve.d.ts +1 -1
- package/funcs/notificationsStatsRetrieve.d.ts.map +1 -1
- package/funcs/notificationsStatsRetrieve.js +20 -6
- package/funcs/notificationsStatsRetrieve.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.js +6 -5
- package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +7 -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 +16 -9
- 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 +16 -9
- package/funcs/subscribersCreateBulk.js.map +1 -1
- package/funcs/subscribersCredentialsAppend.d.ts +1 -2
- package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
- package/funcs/subscribersCredentialsAppend.js +8 -11
- 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 +8 -11
- package/funcs/subscribersCredentialsDelete.js.map +1 -1
- package/funcs/subscribersCredentialsUpdate.d.ts +1 -2
- package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
- package/funcs/subscribersCredentialsUpdate.js +8 -11
- package/funcs/subscribersCredentialsUpdate.js.map +1 -1
- package/funcs/subscribersDelete.d.ts +1 -1
- package/funcs/subscribersDelete.d.ts.map +1 -1
- package/funcs/subscribersDelete.js +8 -6
- package/funcs/subscribersDelete.js.map +1 -1
- package/funcs/subscribersList.d.ts +1 -1
- package/funcs/subscribersList.d.ts.map +1 -1
- package/funcs/subscribersList.js +16 -16
- package/funcs/subscribersList.js.map +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts +1 -2
- package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAll.js +8 -11
- package/funcs/subscribersMessagesMarkAll.js.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -2
- package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.js +8 -11
- package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.js +6 -5
- package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
- package/funcs/subscribersNotificationsFeed.js +6 -5
- package/funcs/subscribersNotificationsFeed.js.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.js +6 -5
- package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
- package/funcs/subscribersPreferencesList.d.ts +1 -1
- package/funcs/subscribersPreferencesList.d.ts.map +1 -1
- package/funcs/subscribersPreferencesList.js +8 -11
- package/funcs/subscribersPreferencesList.js.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.js +6 -5
- package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +6 -5
- package/funcs/subscribersPreferencesUpdate.js.map +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.d.ts +1 -2
- package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.js +8 -11
- package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -2
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.js +8 -11
- 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 +8 -11
- package/funcs/subscribersRetrieve.js.map +1 -1
- package/funcs/subscribersUpdate.d.ts +1 -2
- package/funcs/subscribersUpdate.d.ts.map +1 -1
- package/funcs/subscribersUpdate.js +8 -11
- package/funcs/subscribersUpdate.js.map +1 -1
- package/funcs/topicsCreate.d.ts +1 -1
- package/funcs/topicsCreate.d.ts.map +1 -1
- package/funcs/topicsCreate.js +15 -9
- package/funcs/topicsCreate.js.map +1 -1
- package/funcs/topicsDelete.d.ts +1 -1
- package/funcs/topicsDelete.d.ts.map +1 -1
- package/funcs/topicsDelete.js +8 -6
- package/funcs/topicsDelete.js.map +1 -1
- package/funcs/topicsList.d.ts.map +1 -1
- package/funcs/topicsList.js +6 -5
- package/funcs/topicsList.js.map +1 -1
- package/funcs/topicsRename.d.ts +1 -2
- package/funcs/topicsRename.d.ts.map +1 -1
- package/funcs/topicsRename.js +8 -11
- package/funcs/topicsRename.js.map +1 -1
- package/funcs/topicsRetrieve.d.ts +1 -1
- package/funcs/topicsRetrieve.d.ts.map +1 -1
- package/funcs/topicsRetrieve.js +8 -6
- package/funcs/topicsRetrieve.js.map +1 -1
- package/funcs/topicsSubscribersAssign.d.ts +1 -2
- package/funcs/topicsSubscribersAssign.d.ts.map +1 -1
- package/funcs/topicsSubscribersAssign.js +8 -11
- package/funcs/topicsSubscribersAssign.js.map +1 -1
- package/funcs/topicsSubscribersRemove.d.ts +1 -2
- package/funcs/topicsSubscribersRemove.d.ts.map +1 -1
- package/funcs/topicsSubscribersRemove.js +8 -11
- package/funcs/topicsSubscribersRemove.js.map +1 -1
- package/funcs/topicsSubscribersRetrieve.d.ts +1 -1
- package/funcs/topicsSubscribersRetrieve.d.ts.map +1 -1
- package/funcs/topicsSubscribersRetrieve.js +8 -11
- package/funcs/topicsSubscribersRetrieve.js.map +1 -1
- package/funcs/trigger.d.ts +1 -1
- package/funcs/trigger.d.ts.map +1 -1
- package/funcs/trigger.js +15 -9
- package/funcs/trigger.js.map +1 -1
- package/funcs/triggerBroadcast.d.ts +1 -1
- package/funcs/triggerBroadcast.d.ts.map +1 -1
- package/funcs/triggerBroadcast.js +16 -9
- package/funcs/triggerBroadcast.js.map +1 -1
- package/funcs/triggerBulk.d.ts +1 -1
- package/funcs/triggerBulk.d.ts.map +1 -1
- package/funcs/triggerBulk.js +15 -9
- package/funcs/triggerBulk.js.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +4 -5
- package/lib/config.js.map +1 -1
- package/lib/encodings.js +18 -19
- package/lib/encodings.js.map +1 -1
- package/lib/http.js +1 -2
- package/lib/http.js.map +1 -1
- package/lib/matchers.js +5 -6
- package/lib/matchers.js.map +1 -1
- package/lib/primitives.js +1 -1
- package/lib/primitives.js.map +1 -1
- package/lib/retries.js +3 -4
- package/lib/retries.js.map +1 -1
- package/lib/sdks.js +15 -16
- package/lib/sdks.js.map +1 -1
- package/lib/security.js +1 -1
- package/lib/security.js.map +1 -1
- package/lib/url.js +1 -1
- package/lib/url.js.map +1 -1
- package/models/components/activitynotificationexecutiondetailresponsedto.d.ts +0 -5
- package/models/components/activitynotificationexecutiondetailresponsedto.d.ts.map +1 -1
- package/models/components/activitynotificationexecutiondetailresponsedto.js +0 -4
- package/models/components/activitynotificationexecutiondetailresponsedto.js.map +1 -1
- package/models/components/activitynotificationjobresponsedto.d.ts +49 -19
- package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
- package/models/components/activitynotificationjobresponsedto.js +29 -23
- package/models/components/activitynotificationjobresponsedto.js.map +1 -1
- package/models/components/builderfieldtype.d.ts +46 -0
- package/models/components/builderfieldtype.d.ts.map +1 -0
- package/models/components/builderfieldtype.js +56 -0
- package/models/components/builderfieldtype.js.map +1 -0
- package/models/components/createintegrationrequestdto.d.ts +3 -3
- package/models/components/createintegrationrequestdto.d.ts.map +1 -1
- package/models/components/createintegrationrequestdto.js +3 -3
- package/models/components/createintegrationrequestdto.js.map +1 -1
- package/models/components/digestregularmetadata.d.ts +8 -8
- package/models/components/digestregularmetadata.d.ts.map +1 -1
- package/models/components/digestregularmetadata.js +13 -13
- package/models/components/digestregularmetadata.js.map +1 -1
- package/models/components/digestwitheventsdto.d.ts +95 -0
- package/models/components/digestwitheventsdto.d.ts.map +1 -0
- package/models/components/digestwitheventsdto.js +91 -0
- package/models/components/digestwitheventsdto.js.map +1 -0
- package/models/components/fieldfilterpartdto.d.ts +122 -0
- package/models/components/fieldfilterpartdto.d.ts.map +1 -0
- package/models/components/fieldfilterpartdto.js +116 -0
- package/models/components/fieldfilterpartdto.js.map +1 -0
- package/models/components/index.d.ts +4 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +4 -0
- package/models/components/index.js.map +1 -1
- package/models/components/integrationresponsedto.d.ts +3 -3
- package/models/components/integrationresponsedto.d.ts.map +1 -1
- package/models/components/integrationresponsedto.js +3 -3
- package/models/components/integrationresponsedto.js.map +1 -1
- package/models/components/notificationstep.d.ts +3 -3
- package/models/components/notificationstep.d.ts.map +1 -1
- package/models/components/notificationstep.js +3 -3
- package/models/components/notificationstep.js.map +1 -1
- package/models/components/notificationstepvariant.d.ts +3 -3
- package/models/components/notificationstepvariant.d.ts.map +1 -1
- package/models/components/notificationstepvariant.js +3 -3
- package/models/components/notificationstepvariant.js.map +1 -1
- package/models/components/notificationtriggervariableresponse.d.ts +15 -15
- package/models/components/notificationtriggervariableresponse.d.ts.map +1 -1
- package/models/components/notificationtriggervariableresponse.js +20 -19
- package/models/components/notificationtriggervariableresponse.js.map +1 -1
- package/models/components/stepfilterdto.d.ts +63 -0
- package/models/components/stepfilterdto.d.ts.map +1 -0
- package/models/components/stepfilterdto.js +86 -0
- package/models/components/stepfilterdto.js.map +1 -0
- package/models/components/updateintegrationrequestdto.d.ts +3 -3
- package/models/components/updateintegrationrequestdto.d.ts.map +1 -1
- package/models/components/updateintegrationrequestdto.js +3 -3
- package/models/components/updateintegrationrequestdto.js.map +1 -1
- package/models/errors/httpclienterrors.js +2 -2
- package/models/errors/httpclienterrors.js.map +1 -1
- package/models/operations/eventscontrollerbroadcasteventtoall.d.ts +30 -0
- package/models/operations/eventscontrollerbroadcasteventtoall.d.ts.map +1 -1
- package/models/operations/eventscontrollerbroadcasteventtoall.js +40 -1
- package/models/operations/eventscontrollerbroadcasteventtoall.js.map +1 -1
- package/models/operations/eventscontrollercancel.d.ts +5 -0
- package/models/operations/eventscontrollercancel.d.ts.map +1 -1
- package/models/operations/eventscontrollercancel.js +10 -0
- package/models/operations/eventscontrollercancel.js.map +1 -1
- package/models/operations/eventscontrollertrigger.d.ts +30 -0
- package/models/operations/eventscontrollertrigger.d.ts.map +1 -1
- package/models/operations/eventscontrollertrigger.js +40 -1
- package/models/operations/eventscontrollertrigger.js.map +1 -1
- package/models/operations/eventscontrollertriggerbulk.d.ts +30 -0
- package/models/operations/eventscontrollertriggerbulk.d.ts.map +1 -1
- package/models/operations/eventscontrollertriggerbulk.js +40 -1
- package/models/operations/eventscontrollertriggerbulk.js.map +1 -1
- package/models/operations/integrationscontrollercreateintegration.d.ts +30 -0
- package/models/operations/integrationscontrollercreateintegration.d.ts.map +1 -1
- package/models/operations/integrationscontrollercreateintegration.js +40 -1
- package/models/operations/integrationscontrollercreateintegration.js.map +1 -1
- package/models/operations/integrationscontrollergetactiveintegrations.d.ts +28 -0
- package/models/operations/integrationscontrollergetactiveintegrations.d.ts.map +1 -1
- package/models/operations/integrationscontrollergetactiveintegrations.js +36 -1
- package/models/operations/integrationscontrollergetactiveintegrations.js.map +1 -1
- package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts +5 -0
- package/models/operations/integrationscontrollergetwebhooksupportstatus.d.ts.map +1 -1
- package/models/operations/integrationscontrollergetwebhooksupportstatus.js +10 -0
- package/models/operations/integrationscontrollergetwebhooksupportstatus.js.map +1 -1
- package/models/operations/integrationscontrollerlistintegrations.d.ts +28 -0
- package/models/operations/integrationscontrollerlistintegrations.d.ts.map +1 -1
- package/models/operations/integrationscontrollerlistintegrations.js +36 -1
- package/models/operations/integrationscontrollerlistintegrations.js.map +1 -1
- package/models/operations/integrationscontrollerremoveintegration.d.ts +5 -0
- package/models/operations/integrationscontrollerremoveintegration.d.ts.map +1 -1
- package/models/operations/integrationscontrollerremoveintegration.js +10 -0
- package/models/operations/integrationscontrollerremoveintegration.js.map +1 -1
- package/models/operations/integrationscontrollersetintegrationasprimary.d.ts +5 -0
- package/models/operations/integrationscontrollersetintegrationasprimary.d.ts.map +1 -1
- package/models/operations/integrationscontrollersetintegrationasprimary.js +10 -0
- package/models/operations/integrationscontrollersetintegrationasprimary.js.map +1 -1
- package/models/operations/integrationscontrollerupdateintegrationbyid.d.ts +5 -0
- package/models/operations/integrationscontrollerupdateintegrationbyid.d.ts.map +1 -1
- package/models/operations/integrationscontrollerupdateintegrationbyid.js +4 -0
- package/models/operations/integrationscontrollerupdateintegrationbyid.js.map +1 -1
- package/models/operations/messagescontrollerdeletemessage.d.ts +5 -0
- package/models/operations/messagescontrollerdeletemessage.d.ts.map +1 -1
- package/models/operations/messagescontrollerdeletemessage.js +10 -0
- package/models/operations/messagescontrollerdeletemessage.js.map +1 -1
- package/models/operations/messagescontrollerdeletemessagesbytransactionid.d.ts +5 -0
- package/models/operations/messagescontrollerdeletemessagesbytransactionid.d.ts.map +1 -1
- package/models/operations/messagescontrollerdeletemessagesbytransactionid.js +10 -0
- package/models/operations/messagescontrollerdeletemessagesbytransactionid.js.map +1 -1
- package/models/operations/messagescontrollergetmessages.d.ts +5 -0
- package/models/operations/messagescontrollergetmessages.d.ts.map +1 -1
- package/models/operations/messagescontrollergetmessages.js +10 -0
- package/models/operations/messagescontrollergetmessages.js.map +1 -1
- package/models/operations/notificationscontrollergetactivitygraphstats.d.ts +5 -0
- package/models/operations/notificationscontrollergetactivitygraphstats.d.ts.map +1 -1
- package/models/operations/notificationscontrollergetactivitygraphstats.js +10 -0
- package/models/operations/notificationscontrollergetactivitygraphstats.js.map +1 -1
- package/models/operations/notificationscontrollergetactivitystats.d.ts +28 -0
- package/models/operations/notificationscontrollergetactivitystats.d.ts.map +1 -1
- package/models/operations/notificationscontrollergetactivitystats.js +36 -1
- package/models/operations/notificationscontrollergetactivitystats.js.map +1 -1
- package/models/operations/notificationscontrollergetnotification.d.ts +5 -0
- package/models/operations/notificationscontrollergetnotification.d.ts.map +1 -1
- package/models/operations/notificationscontrollergetnotification.js +10 -0
- package/models/operations/notificationscontrollergetnotification.js.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.d.ts +5 -0
- package/models/operations/notificationscontrollerlistnotifications.d.ts.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.js +10 -0
- package/models/operations/notificationscontrollerlistnotifications.js.map +1 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +30 -0
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +40 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +1 -1
- package/models/operations/subscriberscontrollerchataccessoauth.d.ts +5 -0
- package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerchataccessoauth.js +10 -0
- package/models/operations/subscriberscontrollerchataccessoauth.js.map +1 -1
- package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +5 -0
- package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerchatoauthcallback.js +10 -0
- package/models/operations/subscriberscontrollerchatoauthcallback.js.map +1 -1
- package/models/operations/subscriberscontrollercreatesubscriber.d.ts +30 -0
- package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +1 -1
- package/models/operations/subscriberscontrollercreatesubscriber.js +40 -1
- package/models/operations/subscriberscontrollercreatesubscriber.js.map +1 -1
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +5 -0
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +10 -0
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +1 -1
- package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +5 -0
- package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetnotificationsfeed.js +10 -0
- package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriber.d.ts +5 -0
- package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriber.js +10 -0
- package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +5 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +10 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +1 -1
- package/models/operations/subscriberscontrollergetunseencount.d.ts +5 -0
- package/models/operations/subscriberscontrollergetunseencount.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetunseencount.js +10 -0
- package/models/operations/subscriberscontrollergetunseencount.js.map +1 -1
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +5 -0
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +10 -0
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +1 -1
- package/models/operations/subscriberscontrollerlistsubscribers.d.ts +5 -0
- package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerlistsubscribers.js +10 -0
- package/models/operations/subscriberscontrollerlistsubscribers.js.map +1 -1
- package/models/operations/subscriberscontrollermarkactionasseen.d.ts +5 -0
- package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +1 -1
- package/models/operations/subscriberscontrollermarkactionasseen.js +4 -0
- package/models/operations/subscriberscontrollermarkactionasseen.js.map +1 -1
- package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +5 -0
- package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +1 -1
- package/models/operations/subscriberscontrollermarkallunreadasread.js +4 -0
- package/models/operations/subscriberscontrollermarkallunreadasread.js.map +1 -1
- package/models/operations/subscriberscontrollermarkmessagesas.d.ts +5 -0
- package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +1 -1
- package/models/operations/subscriberscontrollermarkmessagesas.js +4 -0
- package/models/operations/subscriberscontrollermarkmessagesas.js.map +1 -1
- package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +5 -0
- package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +1 -1
- package/models/operations/subscriberscontrollermodifysubscriberchannel.js +4 -0
- package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +1 -1
- package/models/operations/subscriberscontrollerremovesubscriber.d.ts +5 -0
- package/models/operations/subscriberscontrollerremovesubscriber.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerremovesubscriber.js +10 -0
- package/models/operations/subscriberscontrollerremovesubscriber.js.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +5 -0
- package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriber.js +4 -0
- package/models/operations/subscriberscontrollerupdatesubscriber.js.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +5 -0
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +4 -0
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +5 -0
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +4 -0
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +5 -0
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +4 -0
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +5 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +1 -1
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +4 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +1 -1
- package/models/operations/topicscontrollerassign.d.ts +5 -0
- package/models/operations/topicscontrollerassign.d.ts.map +1 -1
- package/models/operations/topicscontrollerassign.js +4 -0
- package/models/operations/topicscontrollerassign.js.map +1 -1
- package/models/operations/topicscontrollercreatetopic.d.ts +30 -0
- package/models/operations/topicscontrollercreatetopic.d.ts.map +1 -1
- package/models/operations/topicscontrollercreatetopic.js +40 -1
- package/models/operations/topicscontrollercreatetopic.js.map +1 -1
- package/models/operations/topicscontrollerdeletetopic.d.ts +5 -0
- package/models/operations/topicscontrollerdeletetopic.d.ts.map +1 -1
- package/models/operations/topicscontrollerdeletetopic.js +10 -0
- package/models/operations/topicscontrollerdeletetopic.js.map +1 -1
- package/models/operations/topicscontrollergettopic.d.ts +5 -0
- package/models/operations/topicscontrollergettopic.d.ts.map +1 -1
- package/models/operations/topicscontrollergettopic.js +10 -0
- package/models/operations/topicscontrollergettopic.js.map +1 -1
- package/models/operations/topicscontrollergettopicsubscriber.d.ts +5 -0
- package/models/operations/topicscontrollergettopicsubscriber.d.ts.map +1 -1
- package/models/operations/topicscontrollergettopicsubscriber.js +10 -0
- package/models/operations/topicscontrollergettopicsubscriber.js.map +1 -1
- package/models/operations/topicscontrollerlisttopics.d.ts +5 -0
- package/models/operations/topicscontrollerlisttopics.d.ts.map +1 -1
- package/models/operations/topicscontrollerlisttopics.js +10 -0
- package/models/operations/topicscontrollerlisttopics.js.map +1 -1
- package/models/operations/topicscontrollerremovesubscribers.d.ts +5 -0
- package/models/operations/topicscontrollerremovesubscribers.d.ts.map +1 -1
- package/models/operations/topicscontrollerremovesubscribers.js +4 -0
- package/models/operations/topicscontrollerremovesubscribers.js.map +1 -1
- package/models/operations/topicscontrollerrenametopic.d.ts +5 -0
- package/models/operations/topicscontrollerrenametopic.d.ts.map +1 -1
- package/models/operations/topicscontrollerrenametopic.js +4 -0
- package/models/operations/topicscontrollerrenametopic.js.map +1 -1
- package/package.json +1 -1
- package/sdk/credentials.d.ts +3 -4
- package/sdk/credentials.d.ts.map +1 -1
- package/sdk/credentials.js +6 -6
- package/sdk/credentials.js.map +1 -1
- package/sdk/integrations.d.ts +6 -6
- package/sdk/integrations.d.ts.map +1 -1
- package/sdk/integrations.js +13 -14
- package/sdk/integrations.js.map +1 -1
- package/sdk/messages.d.ts +2 -2
- package/sdk/messages.d.ts.map +1 -1
- package/sdk/messages.js +4 -4
- package/sdk/messages.js.map +1 -1
- package/sdk/notifications.d.ts +1 -1
- package/sdk/notifications.d.ts.map +1 -1
- package/sdk/notifications.js +3 -4
- package/sdk/notifications.js.map +1 -1
- package/sdk/novumessages.d.ts +2 -3
- package/sdk/novumessages.d.ts.map +1 -1
- package/sdk/novumessages.js +4 -4
- package/sdk/novumessages.js.map +1 -1
- package/sdk/novusubscribers.d.ts +3 -4
- package/sdk/novusubscribers.d.ts.map +1 -1
- package/sdk/novusubscribers.js +6 -6
- package/sdk/novusubscribers.js.map +1 -1
- package/sdk/preferences.d.ts +2 -3
- package/sdk/preferences.d.ts.map +1 -1
- package/sdk/preferences.js +4 -4
- package/sdk/preferences.js.map +1 -1
- package/sdk/properties.d.ts +1 -2
- package/sdk/properties.d.ts.map +1 -1
- package/sdk/properties.js +2 -2
- package/sdk/properties.js.map +1 -1
- package/sdk/sdk.d.ts +4 -4
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +13 -18
- package/sdk/sdk.js.map +1 -1
- package/sdk/stats.d.ts +2 -2
- package/sdk/stats.d.ts.map +1 -1
- package/sdk/stats.js +4 -4
- package/sdk/stats.js.map +1 -1
- package/sdk/subscribers.d.ts +6 -6
- package/sdk/subscribers.d.ts.map +1 -1
- package/sdk/subscribers.js +18 -24
- package/sdk/subscribers.js.map +1 -1
- package/sdk/topics.d.ts +4 -4
- package/sdk/topics.d.ts.map +1 -1
- package/sdk/topics.js +9 -10
- package/sdk/topics.js.map +1 -1
- package/sdk/webhooks.d.ts +1 -1
- package/sdk/webhooks.d.ts.map +1 -1
- package/sdk/webhooks.js +2 -2
- package/sdk/webhooks.js.map +1 -1
- package/src/funcs/cancel.ts +9 -2
- package/src/funcs/integrationsCreate.ts +21 -7
- package/src/funcs/integrationsDelete.ts +9 -2
- package/src/funcs/integrationsList.ts +28 -2
- package/src/funcs/integrationsListActive.ts +29 -2
- package/src/funcs/integrationsSetAsPrimary.ts +9 -2
- package/src/funcs/integrationsUpdate.ts +9 -11
- package/src/funcs/integrationsWebhooksRetrieve.ts +9 -2
- package/src/funcs/messagesDelete.ts +9 -2
- package/src/funcs/messagesDeleteByTransactionId.ts +9 -11
- package/src/funcs/messagesRetrieve.ts +8 -3
- package/src/funcs/notificationsList.ts +8 -3
- package/src/funcs/notificationsRetrieve.ts +9 -2
- package/src/funcs/notificationsStatsGraph.ts +10 -3
- package/src/funcs/notificationsStatsRetrieve.ts +28 -2
- package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +7 -2
- package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +7 -2
- package/src/funcs/subscribersCreate.ts +21 -7
- package/src/funcs/subscribersCreateBulk.ts +24 -7
- package/src/funcs/subscribersCredentialsAppend.ts +9 -13
- package/src/funcs/subscribersCredentialsDelete.ts +9 -11
- package/src/funcs/subscribersCredentialsUpdate.ts +9 -13
- package/src/funcs/subscribersDelete.ts +9 -2
- package/src/funcs/subscribersList.ts +18 -17
- package/src/funcs/subscribersMessagesMarkAll.ts +9 -11
- package/src/funcs/subscribersMessagesMarkAllAs.ts +9 -11
- package/src/funcs/subscribersMessagesUpdateAsSeen.ts +7 -2
- package/src/funcs/subscribersNotificationsFeed.ts +7 -2
- package/src/funcs/subscribersNotificationsUnseenCount.ts +7 -2
- package/src/funcs/subscribersPreferencesList.ts +9 -11
- package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +7 -2
- package/src/funcs/subscribersPreferencesUpdate.ts +7 -2
- package/src/funcs/subscribersPreferencesUpdateGlobal.ts +10 -14
- package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +9 -14
- package/src/funcs/subscribersRetrieve.ts +9 -10
- package/src/funcs/subscribersUpdate.ts +9 -11
- package/src/funcs/topicsCreate.ts +21 -7
- package/src/funcs/topicsDelete.ts +9 -2
- package/src/funcs/topicsList.ts +8 -3
- package/src/funcs/topicsRename.ts +9 -11
- package/src/funcs/topicsRetrieve.ts +9 -2
- package/src/funcs/topicsSubscribersAssign.ts +9 -11
- package/src/funcs/topicsSubscribersRemove.ts +9 -11
- package/src/funcs/topicsSubscribersRetrieve.ts +9 -10
- package/src/funcs/trigger.ts +21 -7
- package/src/funcs/triggerBroadcast.ts +21 -7
- package/src/funcs/triggerBulk.ts +21 -7
- package/src/lib/config.ts +3 -3
- package/src/models/components/activitynotificationexecutiondetailresponsedto.ts +0 -9
- package/src/models/components/activitynotificationjobresponsedto.ts +47 -41
- package/src/models/components/builderfieldtype.ts +39 -0
- package/src/models/components/createintegrationrequestdto.ts +9 -9
- package/src/models/components/digestregularmetadata.ts +18 -15
- package/src/models/components/digestwitheventsdto.ts +127 -0
- package/src/models/components/fieldfilterpartdto.ts +139 -0
- package/src/models/components/index.ts +4 -0
- package/src/models/components/integrationresponsedto.ts +9 -9
- package/src/models/components/notificationstep.ts +9 -9
- package/src/models/components/notificationstepvariant.ts +9 -9
- package/src/models/components/notificationtriggervariableresponse.ts +44 -24
- package/src/models/components/stepfilterdto.ts +112 -0
- package/src/models/components/updateintegrationrequestdto.ts +9 -9
- package/src/models/operations/eventscontrollerbroadcasteventtoall.ts +87 -0
- package/src/models/operations/eventscontrollercancel.ts +15 -0
- package/src/models/operations/eventscontrollertrigger.ts +77 -0
- package/src/models/operations/eventscontrollertriggerbulk.ts +79 -0
- package/src/models/operations/integrationscontrollercreateintegration.ts +91 -0
- package/src/models/operations/integrationscontrollergetactiveintegrations.ts +83 -0
- package/src/models/operations/integrationscontrollergetwebhooksupportstatus.ts +15 -0
- package/src/models/operations/integrationscontrollerlistintegrations.ts +82 -0
- package/src/models/operations/integrationscontrollerremoveintegration.ts +15 -0
- package/src/models/operations/integrationscontrollersetintegrationasprimary.ts +15 -0
- package/src/models/operations/integrationscontrollerupdateintegrationbyid.ts +9 -0
- package/src/models/operations/messagescontrollerdeletemessage.ts +15 -0
- package/src/models/operations/messagescontrollerdeletemessagesbytransactionid.ts +15 -0
- package/src/models/operations/messagescontrollergetmessages.ts +15 -0
- package/src/models/operations/notificationscontrollergetactivitygraphstats.ts +15 -0
- package/src/models/operations/notificationscontrollergetactivitystats.ts +83 -0
- package/src/models/operations/notificationscontrollergetnotification.ts +15 -0
- package/src/models/operations/notificationscontrollerlistnotifications.ts +15 -0
- package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +89 -0
- package/src/models/operations/subscriberscontrollerchataccessoauth.ts +15 -0
- package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +15 -0
- package/src/models/operations/subscriberscontrollercreatesubscriber.ts +90 -0
- package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +15 -0
- package/src/models/operations/subscriberscontrollergetnotificationsfeed.ts +15 -0
- package/src/models/operations/subscriberscontrollergetsubscriber.ts +15 -0
- package/src/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.ts +15 -0
- package/src/models/operations/subscriberscontrollergetunseencount.ts +15 -0
- package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +15 -0
- package/src/models/operations/subscriberscontrollerlistsubscribers.ts +15 -0
- package/src/models/operations/subscriberscontrollermarkactionasseen.ts +9 -0
- package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +9 -0
- package/src/models/operations/subscriberscontrollermarkmessagesas.ts +9 -0
- package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +9 -0
- package/src/models/operations/subscriberscontrollerremovesubscriber.ts +15 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriber.ts +9 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +9 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +9 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +9 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +9 -0
- package/src/models/operations/topicscontrollerassign.ts +9 -0
- package/src/models/operations/topicscontrollercreatetopic.ts +79 -0
- package/src/models/operations/topicscontrollerdeletetopic.ts +15 -0
- package/src/models/operations/topicscontrollergettopic.ts +15 -0
- package/src/models/operations/topicscontrollergettopicsubscriber.ts +15 -0
- package/src/models/operations/topicscontrollerlisttopics.ts +15 -0
- package/src/models/operations/topicscontrollerremovesubscribers.ts +9 -0
- package/src/models/operations/topicscontrollerrenametopic.ts +9 -0
- package/src/sdk/credentials.ts +6 -15
- package/src/sdk/integrations.ts +14 -6
- package/src/sdk/messages.ts +4 -4
- package/src/sdk/notifications.ts +2 -0
- package/src/sdk/novumessages.ts +4 -9
- package/src/sdk/novusubscribers.ts +6 -13
- package/src/sdk/preferences.ts +5 -10
- package/src/sdk/properties.ts +2 -6
- package/src/sdk/sdk.ts +14 -6
- package/src/sdk/stats.ts +4 -0
- package/src/sdk/subscribers.ts +16 -16
- package/src/sdk/topics.ts +10 -6
- package/src/sdk/webhooks.ts +2 -0
|
@@ -24,12 +24,15 @@ const novu = new Novu({
|
|
|
24
24
|
|
|
25
25
|
async function run() {
|
|
26
26
|
const result = await novu.topics.subscribers.assign({
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
27
|
+
topicKey: "<value>",
|
|
28
|
+
addSubscribersRequestDto: {
|
|
29
|
+
subscribers: [
|
|
30
|
+
"<value>",
|
|
31
|
+
"<value>",
|
|
32
|
+
"<value>",
|
|
33
|
+
],
|
|
34
|
+
},
|
|
35
|
+
});
|
|
33
36
|
|
|
34
37
|
// Handle the result
|
|
35
38
|
console.log(result);
|
|
@@ -54,12 +57,15 @@ const novu = new NovuCore({
|
|
|
54
57
|
|
|
55
58
|
async function run() {
|
|
56
59
|
const res = await topicsSubscribersAssign(novu, {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
60
|
+
topicKey: "<value>",
|
|
61
|
+
addSubscribersRequestDto: {
|
|
62
|
+
subscribers: [
|
|
63
|
+
"<value>",
|
|
64
|
+
"<value>",
|
|
65
|
+
"<value>",
|
|
66
|
+
],
|
|
67
|
+
},
|
|
68
|
+
});
|
|
63
69
|
|
|
64
70
|
if (!res.ok) {
|
|
65
71
|
throw res.error;
|
|
@@ -78,8 +84,7 @@ run();
|
|
|
78
84
|
|
|
79
85
|
| Parameter | Type | Required | Description |
|
|
80
86
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `
|
|
82
|
-
| `addSubscribersRequestDto` | [components.AddSubscribersRequestDto](../../models/components/addsubscribersrequestdto.md) | :heavy_check_mark: | N/A |
|
|
87
|
+
| `request` | [operations.TopicsControllerAssignRequest](../../models/operations/topicscontrollerassignrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
88
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
84
89
|
| `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. |
|
|
85
90
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -110,7 +115,10 @@ const novu = new Novu({
|
|
|
110
115
|
});
|
|
111
116
|
|
|
112
117
|
async function run() {
|
|
113
|
-
const result = await novu.topics.subscribers.retrieve(
|
|
118
|
+
const result = await novu.topics.subscribers.retrieve({
|
|
119
|
+
externalSubscriberId: "<id>",
|
|
120
|
+
topicKey: "<value>",
|
|
121
|
+
});
|
|
114
122
|
|
|
115
123
|
// Handle the result
|
|
116
124
|
console.log(result);
|
|
@@ -134,7 +142,10 @@ const novu = new NovuCore({
|
|
|
134
142
|
});
|
|
135
143
|
|
|
136
144
|
async function run() {
|
|
137
|
-
const res = await topicsSubscribersRetrieve(novu,
|
|
145
|
+
const res = await topicsSubscribersRetrieve(novu, {
|
|
146
|
+
externalSubscriberId: "<id>",
|
|
147
|
+
topicKey: "<value>",
|
|
148
|
+
});
|
|
138
149
|
|
|
139
150
|
if (!res.ok) {
|
|
140
151
|
throw res.error;
|
|
@@ -153,8 +164,7 @@ run();
|
|
|
153
164
|
|
|
154
165
|
| Parameter | Type | Required | Description |
|
|
155
166
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
156
|
-
| `
|
|
157
|
-
| `topicKey` | *string* | :heavy_check_mark: | The topic key |
|
|
167
|
+
| `request` | [operations.TopicsControllerGetTopicSubscriberRequest](../../models/operations/topicscontrollergettopicsubscriberrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
158
168
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
159
169
|
| `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. |
|
|
160
170
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -186,11 +196,14 @@ const novu = new Novu({
|
|
|
186
196
|
|
|
187
197
|
async function run() {
|
|
188
198
|
const result = await novu.topics.subscribers.remove({
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
199
|
+
topicKey: "<value>",
|
|
200
|
+
removeSubscribersRequestDto: {
|
|
201
|
+
subscribers: [
|
|
202
|
+
"<value>",
|
|
203
|
+
"<value>",
|
|
204
|
+
],
|
|
205
|
+
},
|
|
206
|
+
});
|
|
194
207
|
|
|
195
208
|
// Handle the result
|
|
196
209
|
console.log(result);
|
|
@@ -215,11 +228,14 @@ const novu = new NovuCore({
|
|
|
215
228
|
|
|
216
229
|
async function run() {
|
|
217
230
|
const res = await topicsSubscribersRemove(novu, {
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
231
|
+
topicKey: "<value>",
|
|
232
|
+
removeSubscribersRequestDto: {
|
|
233
|
+
subscribers: [
|
|
234
|
+
"<value>",
|
|
235
|
+
"<value>",
|
|
236
|
+
],
|
|
237
|
+
},
|
|
238
|
+
});
|
|
223
239
|
|
|
224
240
|
if (!res.ok) {
|
|
225
241
|
throw res.error;
|
|
@@ -238,8 +254,7 @@ run();
|
|
|
238
254
|
|
|
239
255
|
| Parameter | Type | Required | Description |
|
|
240
256
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
241
|
-
| `
|
|
242
|
-
| `removeSubscribersRequestDto` | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.md) | :heavy_check_mark: | N/A |
|
|
257
|
+
| `request` | [operations.TopicsControllerRemoveSubscribersRequest](../../models/operations/topicscontrollerremovesubscribersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
243
258
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
244
259
|
| `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. |
|
|
245
260
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -24,7 +24,9 @@ const novu = new Novu({
|
|
|
24
24
|
});
|
|
25
25
|
|
|
26
26
|
async function run() {
|
|
27
|
-
const result = await novu.subscribers.preferences.list(
|
|
27
|
+
const result = await novu.subscribers.preferences.list({
|
|
28
|
+
subscriberId: "<id>",
|
|
29
|
+
});
|
|
28
30
|
|
|
29
31
|
// Handle the result
|
|
30
32
|
console.log(result);
|
|
@@ -48,7 +50,9 @@ const novu = new NovuCore({
|
|
|
48
50
|
});
|
|
49
51
|
|
|
50
52
|
async function run() {
|
|
51
|
-
const res = await subscribersPreferencesList(novu,
|
|
53
|
+
const res = await subscribersPreferencesList(novu, {
|
|
54
|
+
subscriberId: "<id>",
|
|
55
|
+
});
|
|
52
56
|
|
|
53
57
|
if (!res.ok) {
|
|
54
58
|
throw res.error;
|
|
@@ -67,8 +71,7 @@ run();
|
|
|
67
71
|
|
|
68
72
|
| Parameter | Type | Required | Description |
|
|
69
73
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
70
|
-
| `
|
|
71
|
-
| `includeInactiveChannels` | *boolean* | :heavy_minus_sign: | A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true |
|
|
74
|
+
| `request` | [operations.SubscribersControllerListSubscriberPreferencesRequest](../../models/operations/subscriberscontrollerlistsubscriberpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
72
75
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
73
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. |
|
|
74
77
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -99,7 +102,10 @@ const novu = new Novu({
|
|
|
99
102
|
});
|
|
100
103
|
|
|
101
104
|
async function run() {
|
|
102
|
-
const result = await novu.subscribers.preferences.updateGlobal({
|
|
105
|
+
const result = await novu.subscribers.preferences.updateGlobal({
|
|
106
|
+
subscriberId: "<id>",
|
|
107
|
+
updateSubscriberGlobalPreferencesRequestDto: {},
|
|
108
|
+
});
|
|
103
109
|
|
|
104
110
|
// Handle the result
|
|
105
111
|
console.log(result);
|
|
@@ -123,7 +129,10 @@ const novu = new NovuCore({
|
|
|
123
129
|
});
|
|
124
130
|
|
|
125
131
|
async function run() {
|
|
126
|
-
const res = await subscribersPreferencesUpdateGlobal(novu, {
|
|
132
|
+
const res = await subscribersPreferencesUpdateGlobal(novu, {
|
|
133
|
+
subscriberId: "<id>",
|
|
134
|
+
updateSubscriberGlobalPreferencesRequestDto: {},
|
|
135
|
+
});
|
|
127
136
|
|
|
128
137
|
if (!res.ok) {
|
|
129
138
|
throw res.error;
|
|
@@ -142,8 +151,7 @@ run();
|
|
|
142
151
|
|
|
143
152
|
| Parameter | Type | Required | Description |
|
|
144
153
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
145
|
-
| `
|
|
146
|
-
| `updateSubscriberGlobalPreferencesRequestDto` | [components.UpdateSubscriberGlobalPreferencesRequestDto](../../models/components/updatesubscriberglobalpreferencesrequestdto.md) | :heavy_check_mark: | N/A |
|
|
154
|
+
| `request` | [operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest](../../models/operations/subscriberscontrollerupdatesubscriberglobalpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
147
155
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
148
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. |
|
|
149
157
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -22,8 +22,11 @@ const novu = new Novu({
|
|
|
22
22
|
|
|
23
23
|
async function run() {
|
|
24
24
|
const result = await novu.subscribers.properties.updateOnlineFlag({
|
|
25
|
-
|
|
26
|
-
|
|
25
|
+
subscriberId: "<id>",
|
|
26
|
+
updateSubscriberOnlineFlagRequestDto: {
|
|
27
|
+
isOnline: true,
|
|
28
|
+
},
|
|
29
|
+
});
|
|
27
30
|
|
|
28
31
|
// Handle the result
|
|
29
32
|
console.log(result);
|
|
@@ -48,8 +51,11 @@ const novu = new NovuCore({
|
|
|
48
51
|
|
|
49
52
|
async function run() {
|
|
50
53
|
const res = await subscribersPropertiesUpdateOnlineFlag(novu, {
|
|
51
|
-
|
|
52
|
-
|
|
54
|
+
subscriberId: "<id>",
|
|
55
|
+
updateSubscriberOnlineFlagRequestDto: {
|
|
56
|
+
isOnline: true,
|
|
57
|
+
},
|
|
58
|
+
});
|
|
53
59
|
|
|
54
60
|
if (!res.ok) {
|
|
55
61
|
throw res.error;
|
|
@@ -68,8 +74,7 @@ run();
|
|
|
68
74
|
|
|
69
75
|
| Parameter | Type | Required | Description |
|
|
70
76
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
71
|
-
| `
|
|
72
|
-
| `updateSubscriberOnlineFlagRequestDto` | [components.UpdateSubscriberOnlineFlagRequestDto](../../models/components/updatesubscriberonlineflagrequestdto.md) | :heavy_check_mark: | N/A |
|
|
77
|
+
| `request` | [operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest](../../models/operations/subscriberscontrollerupdatesubscriberonlineflagrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
73
78
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
74
79
|
| `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. |
|
|
75
80
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -65,6 +65,7 @@ run();
|
|
|
65
65
|
|
|
66
66
|
| Parameter | Type | Required | Description |
|
|
67
67
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
68
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
68
69
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
69
70
|
| `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. |
|
|
70
71
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -138,6 +139,7 @@ run();
|
|
|
138
139
|
|
|
139
140
|
| Parameter | Type | Required | Description |
|
|
140
141
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
142
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
141
143
|
| `days` | *number* | :heavy_minus_sign: | N/A |
|
|
142
144
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
143
145
|
| `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. |
|
|
@@ -29,7 +29,7 @@ const novu = new Novu({
|
|
|
29
29
|
});
|
|
30
30
|
|
|
31
31
|
async function run() {
|
|
32
|
-
const result = await novu.subscribers.list();
|
|
32
|
+
const result = await novu.subscribers.list({});
|
|
33
33
|
|
|
34
34
|
for await (const page of result) {
|
|
35
35
|
// Handle the page
|
|
@@ -55,7 +55,7 @@ const novu = new NovuCore({
|
|
|
55
55
|
});
|
|
56
56
|
|
|
57
57
|
async function run() {
|
|
58
|
-
const res = await subscribersList(novu);
|
|
58
|
+
const res = await subscribersList(novu, {});
|
|
59
59
|
|
|
60
60
|
if (!res.ok) {
|
|
61
61
|
throw res.error;
|
|
@@ -76,8 +76,7 @@ run();
|
|
|
76
76
|
|
|
77
77
|
| Parameter | Type | Required | Description |
|
|
78
78
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
79
|
-
| `
|
|
80
|
-
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
79
|
+
| `request` | [operations.SubscribersControllerListSubscribersRequest](../../models/operations/subscriberscontrollerlistsubscribersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
81
80
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
82
81
|
| `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
82
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -155,7 +154,8 @@ run();
|
|
|
155
154
|
|
|
156
155
|
| Parameter | Type | Required | Description |
|
|
157
156
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
158
|
-
| `
|
|
157
|
+
| `createSubscriberRequestDto` | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md) | :heavy_check_mark: | N/A |
|
|
158
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
159
159
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
160
160
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
161
161
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -186,7 +186,9 @@ const novu = new Novu({
|
|
|
186
186
|
});
|
|
187
187
|
|
|
188
188
|
async function run() {
|
|
189
|
-
const result = await novu.subscribers.retrieve(
|
|
189
|
+
const result = await novu.subscribers.retrieve({
|
|
190
|
+
subscriberId: "<id>",
|
|
191
|
+
});
|
|
190
192
|
|
|
191
193
|
// Handle the result
|
|
192
194
|
console.log(result);
|
|
@@ -210,7 +212,9 @@ const novu = new NovuCore({
|
|
|
210
212
|
});
|
|
211
213
|
|
|
212
214
|
async function run() {
|
|
213
|
-
const res = await subscribersRetrieve(novu,
|
|
215
|
+
const res = await subscribersRetrieve(novu, {
|
|
216
|
+
subscriberId: "<id>",
|
|
217
|
+
});
|
|
214
218
|
|
|
215
219
|
if (!res.ok) {
|
|
216
220
|
throw res.error;
|
|
@@ -229,8 +233,7 @@ run();
|
|
|
229
233
|
|
|
230
234
|
| Parameter | Type | Required | Description |
|
|
231
235
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
232
|
-
| `
|
|
233
|
-
| `includeTopics` | *boolean* | :heavy_minus_sign: | Includes the topics associated with the subscriber |
|
|
236
|
+
| `request` | [operations.SubscribersControllerGetSubscriberRequest](../../models/operations/subscriberscontrollergetsubscriberrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
234
237
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
235
238
|
| `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. |
|
|
236
239
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -262,23 +265,26 @@ const novu = new Novu({
|
|
|
262
265
|
|
|
263
266
|
async function run() {
|
|
264
267
|
const result = await novu.subscribers.update({
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
"
|
|
273
|
-
|
|
274
|
-
"
|
|
268
|
+
subscriberId: "<id>",
|
|
269
|
+
updateSubscriberRequestDto: {
|
|
270
|
+
email: "john.doe@example.com",
|
|
271
|
+
firstName: "John",
|
|
272
|
+
lastName: "Doe",
|
|
273
|
+
phone: "+1234567890",
|
|
274
|
+
avatar: "https://example.com/avatar.jpg",
|
|
275
|
+
locale: "en-US",
|
|
276
|
+
data: {
|
|
277
|
+
"preferences": {
|
|
278
|
+
"notifications": true,
|
|
279
|
+
"theme": "dark",
|
|
280
|
+
},
|
|
281
|
+
"tags": [
|
|
282
|
+
"premium",
|
|
283
|
+
"newsletter",
|
|
284
|
+
],
|
|
275
285
|
},
|
|
276
|
-
"tags": [
|
|
277
|
-
"premium",
|
|
278
|
-
"newsletter",
|
|
279
|
-
],
|
|
280
286
|
},
|
|
281
|
-
}
|
|
287
|
+
});
|
|
282
288
|
|
|
283
289
|
// Handle the result
|
|
284
290
|
console.log(result);
|
|
@@ -303,23 +309,26 @@ const novu = new NovuCore({
|
|
|
303
309
|
|
|
304
310
|
async function run() {
|
|
305
311
|
const res = await subscribersUpdate(novu, {
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
"
|
|
314
|
-
|
|
315
|
-
"
|
|
312
|
+
subscriberId: "<id>",
|
|
313
|
+
updateSubscriberRequestDto: {
|
|
314
|
+
email: "john.doe@example.com",
|
|
315
|
+
firstName: "John",
|
|
316
|
+
lastName: "Doe",
|
|
317
|
+
phone: "+1234567890",
|
|
318
|
+
avatar: "https://example.com/avatar.jpg",
|
|
319
|
+
locale: "en-US",
|
|
320
|
+
data: {
|
|
321
|
+
"preferences": {
|
|
322
|
+
"notifications": true,
|
|
323
|
+
"theme": "dark",
|
|
324
|
+
},
|
|
325
|
+
"tags": [
|
|
326
|
+
"premium",
|
|
327
|
+
"newsletter",
|
|
328
|
+
],
|
|
316
329
|
},
|
|
317
|
-
"tags": [
|
|
318
|
-
"premium",
|
|
319
|
-
"newsletter",
|
|
320
|
-
],
|
|
321
330
|
},
|
|
322
|
-
}
|
|
331
|
+
});
|
|
323
332
|
|
|
324
333
|
if (!res.ok) {
|
|
325
334
|
throw res.error;
|
|
@@ -338,8 +347,7 @@ run();
|
|
|
338
347
|
|
|
339
348
|
| Parameter | Type | Required | Description |
|
|
340
349
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
341
|
-
| `
|
|
342
|
-
| `updateSubscriberRequestDto` | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md) | :heavy_check_mark: | N/A |
|
|
350
|
+
| `request` | [operations.SubscribersControllerUpdateSubscriberRequest](../../models/operations/subscriberscontrollerupdatesubscriberrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
343
351
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
344
352
|
| `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. |
|
|
345
353
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -414,6 +422,7 @@ run();
|
|
|
414
422
|
| Parameter | Type | Required | Description |
|
|
415
423
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
416
424
|
| `subscriberId` | *string* | :heavy_check_mark: | N/A |
|
|
425
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
417
426
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
418
427
|
| `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. |
|
|
419
428
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -504,7 +513,8 @@ run();
|
|
|
504
513
|
|
|
505
514
|
| Parameter | Type | Required | Description |
|
|
506
515
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
507
|
-
| `
|
|
516
|
+
| `bulkSubscriberCreateDto` | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md) | :heavy_check_mark: | N/A |
|
|
517
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
508
518
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
509
519
|
| `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. |
|
|
510
520
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|