@novu/api 0.0.1-alpha.150 → 0.0.1-alpha.160
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 +14 -1
- package/docs/sdks/admin/README.md +161 -0
- 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 +218 -4
- 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/adminTestingControllerIdempotency.d.ts +11 -0
- package/funcs/adminTestingControllerIdempotency.d.ts.map +1 -0
- package/funcs/adminTestingControllerIdempotency.js +112 -0
- package/funcs/adminTestingControllerIdempotency.js.map +1 -0
- package/funcs/adminTestingControllerIdempotencyGet.d.ts +10 -0
- package/funcs/adminTestingControllerIdempotencyGet.d.ts.map +1 -0
- package/funcs/adminTestingControllerIdempotencyGet.js +109 -0
- package/funcs/adminTestingControllerIdempotencyGet.js.map +1 -0
- package/funcs/cancel.d.ts +1 -1
- package/funcs/cancel.d.ts.map +1 -1
- package/funcs/cancel.js +5 -3
- 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 +13 -6
- 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 +5 -3
- 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 +17 -3
- 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 +18 -3
- 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 +5 -3
- 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 +5 -8
- 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 +5 -3
- 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 +5 -3
- 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 +5 -8
- package/funcs/messagesDeleteByTransactionId.js.map +1 -1
- package/funcs/messagesRetrieve.d.ts.map +1 -1
- package/funcs/messagesRetrieve.js +3 -2
- package/funcs/messagesRetrieve.js.map +1 -1
- package/funcs/notificationsList.d.ts.map +1 -1
- package/funcs/notificationsList.js +3 -2
- 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 +5 -3
- 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 +5 -3
- 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 +17 -3
- package/funcs/notificationsStatsRetrieve.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.js +3 -2
- package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +3 -2
- 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 +13 -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 +13 -6
- 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 +5 -8
- 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 +5 -8
- 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 +5 -8
- 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 +5 -3
- 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 +13 -13
- 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 +5 -8
- 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 +5 -8
- package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.js +3 -2
- package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
- package/funcs/subscribersNotificationsFeed.js +3 -2
- package/funcs/subscribersNotificationsFeed.js.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.js +3 -2
- 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 +5 -8
- package/funcs/subscribersPreferencesList.js.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.js +3 -2
- package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +3 -2
- 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 +5 -8
- 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 +5 -8
- 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 +5 -8
- 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 +5 -8
- package/funcs/subscribersUpdate.js.map +1 -1
- package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.d.ts +8 -0
- package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.d.ts.map +1 -0
- package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js +91 -0
- package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js.map +1 -0
- package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.d.ts +8 -0
- package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.d.ts.map +1 -0
- package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js +91 -0
- package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js.map +1 -0
- package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.d.ts +8 -0
- package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.d.ts.map +1 -0
- package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js +91 -0
- package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js.map +1 -0
- package/funcs/topicsCreate.d.ts +1 -1
- package/funcs/topicsCreate.d.ts.map +1 -1
- package/funcs/topicsCreate.js +12 -6
- 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 +5 -3
- package/funcs/topicsDelete.js.map +1 -1
- package/funcs/topicsList.d.ts.map +1 -1
- package/funcs/topicsList.js +3 -2
- 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 +5 -8
- 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 +5 -3
- 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 +5 -8
- 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 +5 -8
- 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 +5 -8
- 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 +12 -6
- 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 +13 -6
- 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 +12 -6
- package/funcs/triggerBulk.js.map +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/idempotencybodydto.d.ts +29 -0
- package/models/components/idempotencybodydto.d.ts.map +1 -0
- package/models/components/idempotencybodydto.js +59 -0
- package/models/components/idempotencybodydto.js.map +1 -0
- package/models/components/index.d.ts +1 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +1 -0
- package/models/components/index.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/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.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/testingcontrolleridempotency.d.ts +64 -0
- package/models/operations/testingcontrolleridempotency.d.ts.map +1 -0
- package/models/operations/testingcontrolleridempotency.js +108 -0
- package/models/operations/testingcontrolleridempotency.js.map +1 -0
- package/models/operations/testingcontrolleridempotencyget.d.ts +61 -0
- package/models/operations/testingcontrolleridempotencyget.d.ts.map +1 -0
- package/models/operations/testingcontrolleridempotencyget.js +103 -0
- package/models/operations/testingcontrolleridempotencyget.js.map +1 -0
- 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/admin.d.ts +8 -0
- package/sdk/admin.d.ts.map +1 -0
- package/sdk/admin.js +20 -0
- package/sdk/admin.js.map +1 -0
- 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 +12 -12
- 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 +2 -2
- 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 +10 -4
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +24 -8
- 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 +12 -12
- 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 +8 -8
- 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/adminTestingControllerIdempotency.ts +160 -0
- package/src/funcs/adminTestingControllerIdempotencyGet.ts +155 -0
- 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/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.ts +114 -0
- package/src/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.ts +114 -0
- package/src/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.ts +114 -0
- 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 +2 -2
- package/src/models/components/idempotencybodydto.ts +66 -0
- package/src/models/components/index.ts +1 -0
- 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/index.ts +2 -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/testingcontrolleridempotency.ts +161 -0
- package/src/models/operations/testingcontrolleridempotencyget.ts +161 -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/admin.ts +36 -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 +54 -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
package/README.md
CHANGED
|
@@ -218,6 +218,11 @@ run();
|
|
|
218
218
|
<details open>
|
|
219
219
|
<summary>Available methods</summary>
|
|
220
220
|
|
|
221
|
+
### [admin](docs/sdks/admin/README.md)
|
|
222
|
+
|
|
223
|
+
* [testingControllerIdempotency](docs/sdks/admin/README.md#testingcontrolleridempotency)
|
|
224
|
+
* [testingControllerIdempotencyGet](docs/sdks/admin/README.md#testingcontrolleridempotencyget)
|
|
225
|
+
|
|
221
226
|
### [integrations](docs/sdks/integrations/README.md)
|
|
222
227
|
|
|
223
228
|
* [list](docs/sdks/integrations/README.md#list) - Get integrations
|
|
@@ -253,6 +258,9 @@ run();
|
|
|
253
258
|
* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
|
|
254
259
|
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
|
|
255
260
|
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
|
|
261
|
+
* [testApiRateLimitBulkControllerNoCategoryNoCostOverride](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorynocostoverride)
|
|
262
|
+
* [testApiRateLimitBulkControllerNoCategorySingleCostOverride](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorysinglecostoverride)
|
|
263
|
+
* [testApiRateLimitBulkControllerGlobalCategoryNoCostOverride](docs/sdks/novu/README.md#testapiratelimitbulkcontrollerglobalcategorynocostoverride)
|
|
256
264
|
|
|
257
265
|
### [subscribers](docs/sdks/subscribers/README.md)
|
|
258
266
|
|
|
@@ -328,6 +336,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
328
336
|
|
|
329
337
|
<summary>Available standalone functions</summary>
|
|
330
338
|
|
|
339
|
+
- [`adminTestingControllerIdempotency`](docs/sdks/admin/README.md#testingcontrolleridempotency)
|
|
340
|
+
- [`adminTestingControllerIdempotencyGet`](docs/sdks/admin/README.md#testingcontrolleridempotencyget)
|
|
331
341
|
- [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
|
|
332
342
|
- [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
|
|
333
343
|
- [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete integration
|
|
@@ -364,6 +374,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
364
374
|
- [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
|
|
365
375
|
- [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
|
|
366
376
|
- [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
|
|
377
|
+
- [`testApiRateLimitBulkControllerGlobalCategoryNoCostOverride`](docs/sdks/novu/README.md#testapiratelimitbulkcontrollerglobalcategorynocostoverride)
|
|
378
|
+
- [`testApiRateLimitBulkControllerNoCategoryNoCostOverride`](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorynocostoverride)
|
|
379
|
+
- [`testApiRateLimitBulkControllerNoCategorySingleCostOverride`](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorysinglecostoverride)
|
|
367
380
|
- [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
|
|
368
381
|
- [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
|
|
369
382
|
- [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered
|
|
@@ -399,7 +412,7 @@ const novu = new Novu({
|
|
|
399
412
|
});
|
|
400
413
|
|
|
401
414
|
async function run() {
|
|
402
|
-
const result = await novu.subscribers.list();
|
|
415
|
+
const result = await novu.subscribers.list({});
|
|
403
416
|
|
|
404
417
|
for await (const page of result) {
|
|
405
418
|
// Handle the page
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# Admin
|
|
2
|
+
(*admin*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
testing
|
|
7
|
+
<https://docs.novu.co/platform/organizations>
|
|
8
|
+
|
|
9
|
+
### Available Operations
|
|
10
|
+
|
|
11
|
+
* [testingControllerIdempotency](#testingcontrolleridempotency)
|
|
12
|
+
* [testingControllerIdempotencyGet](#testingcontrolleridempotencyget)
|
|
13
|
+
|
|
14
|
+
## testingControllerIdempotency
|
|
15
|
+
|
|
16
|
+
### Example Usage
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { Novu } from "@novu/api";
|
|
20
|
+
|
|
21
|
+
const novu = new Novu({
|
|
22
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
async function run() {
|
|
26
|
+
const result = await novu.admin.testingControllerIdempotency({
|
|
27
|
+
data: 6704.42,
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
// Handle the result
|
|
31
|
+
console.log(result);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
run();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Standalone function
|
|
38
|
+
|
|
39
|
+
The standalone function version of this method:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { NovuCore } from "@novu/api/core.js";
|
|
43
|
+
import { adminTestingControllerIdempotency } from "@novu/api/funcs/adminTestingControllerIdempotency.js";
|
|
44
|
+
|
|
45
|
+
// Use `NovuCore` for best tree-shaking performance.
|
|
46
|
+
// You can create one instance of it to use across an application.
|
|
47
|
+
const novu = new NovuCore({
|
|
48
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const res = await adminTestingControllerIdempotency(novu, {
|
|
53
|
+
data: 6704.42,
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
if (!res.ok) {
|
|
57
|
+
throw res.error;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
const { value: result } = res;
|
|
61
|
+
|
|
62
|
+
// Handle the result
|
|
63
|
+
console.log(result);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
run();
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Parameter | Type | Required | Description |
|
|
72
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
+
| `idempotencyBodyDto` | [components.IdempotencyBodyDto](../../models/components/idempotencybodydto.md) | :heavy_check_mark: | N/A |
|
|
74
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
75
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
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. |
|
|
77
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
|
+
|
|
79
|
+
### Response
|
|
80
|
+
|
|
81
|
+
**Promise\<[operations.TestingControllerIdempotencyResponse](../../models/operations/testingcontrolleridempotencyresponse.md)\>**
|
|
82
|
+
|
|
83
|
+
### Errors
|
|
84
|
+
|
|
85
|
+
| Error Type | Status Code | Content Type |
|
|
86
|
+
| ------------------------- | ------------------------- | ------------------------- |
|
|
87
|
+
| errors.ErrorDto | 400, 404, 409 | application/json |
|
|
88
|
+
| errors.ValidationErrorDto | 422 | application/json |
|
|
89
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
90
|
+
|
|
91
|
+
## testingControllerIdempotencyGet
|
|
92
|
+
|
|
93
|
+
### Example Usage
|
|
94
|
+
|
|
95
|
+
```typescript
|
|
96
|
+
import { Novu } from "@novu/api";
|
|
97
|
+
|
|
98
|
+
const novu = new Novu({
|
|
99
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
async function run() {
|
|
103
|
+
const result = await novu.admin.testingControllerIdempotencyGet();
|
|
104
|
+
|
|
105
|
+
// Handle the result
|
|
106
|
+
console.log(result);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
run();
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Standalone function
|
|
113
|
+
|
|
114
|
+
The standalone function version of this method:
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
import { NovuCore } from "@novu/api/core.js";
|
|
118
|
+
import { adminTestingControllerIdempotencyGet } from "@novu/api/funcs/adminTestingControllerIdempotencyGet.js";
|
|
119
|
+
|
|
120
|
+
// Use `NovuCore` for best tree-shaking performance.
|
|
121
|
+
// You can create one instance of it to use across an application.
|
|
122
|
+
const novu = new NovuCore({
|
|
123
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
async function run() {
|
|
127
|
+
const res = await adminTestingControllerIdempotencyGet(novu);
|
|
128
|
+
|
|
129
|
+
if (!res.ok) {
|
|
130
|
+
throw res.error;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
const { value: result } = res;
|
|
134
|
+
|
|
135
|
+
// Handle the result
|
|
136
|
+
console.log(result);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
run();
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
| Parameter | Type | Required | Description |
|
|
145
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
146
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
147
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
148
|
+
| `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
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
150
|
+
|
|
151
|
+
### Response
|
|
152
|
+
|
|
153
|
+
**Promise\<[operations.TestingControllerIdempotencyGetResponse](../../models/operations/testingcontrolleridempotencygetresponse.md)\>**
|
|
154
|
+
|
|
155
|
+
### Errors
|
|
156
|
+
|
|
157
|
+
| Error Type | Status Code | Content Type |
|
|
158
|
+
| ------------------------- | ------------------------- | ------------------------- |
|
|
159
|
+
| errors.ErrorDto | 400, 404, 409 | application/json |
|
|
160
|
+
| errors.ValidationErrorDto | 422 | application/json |
|
|
161
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -24,11 +24,14 @@ const novu = new Novu({
|
|
|
24
24
|
|
|
25
25
|
async function run() {
|
|
26
26
|
const result = await novu.subscribers.credentials.update({
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
27
|
+
subscriberId: "<id>",
|
|
28
|
+
updateSubscriberChannelRequestDto: {
|
|
29
|
+
providerId: "pushpad",
|
|
30
|
+
credentials: {
|
|
31
|
+
webhookUrl: "https://example.com/webhook",
|
|
32
|
+
},
|
|
30
33
|
},
|
|
31
|
-
}
|
|
34
|
+
});
|
|
32
35
|
|
|
33
36
|
// Handle the result
|
|
34
37
|
console.log(result);
|
|
@@ -53,11 +56,14 @@ const novu = new NovuCore({
|
|
|
53
56
|
|
|
54
57
|
async function run() {
|
|
55
58
|
const res = await subscribersCredentialsUpdate(novu, {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
+
subscriberId: "<id>",
|
|
60
|
+
updateSubscriberChannelRequestDto: {
|
|
61
|
+
providerId: "pushpad",
|
|
62
|
+
credentials: {
|
|
63
|
+
webhookUrl: "https://example.com/webhook",
|
|
64
|
+
},
|
|
59
65
|
},
|
|
60
|
-
}
|
|
66
|
+
});
|
|
61
67
|
|
|
62
68
|
if (!res.ok) {
|
|
63
69
|
throw res.error;
|
|
@@ -76,8 +82,7 @@ run();
|
|
|
76
82
|
|
|
77
83
|
| Parameter | Type | Required | Description |
|
|
78
84
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
79
|
-
| `
|
|
80
|
-
| `updateSubscriberChannelRequestDto` | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.md) | :heavy_check_mark: | N/A |
|
|
85
|
+
| `request` | [operations.SubscribersControllerUpdateSubscriberChannelRequest](../../models/operations/subscriberscontrollerupdatesubscriberchannelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
81
86
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
82
87
|
| `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
88
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -111,11 +116,14 @@ const novu = new Novu({
|
|
|
111
116
|
|
|
112
117
|
async function run() {
|
|
113
118
|
const result = await novu.subscribers.credentials.append({
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
119
|
+
subscriberId: "<id>",
|
|
120
|
+
updateSubscriberChannelRequestDto: {
|
|
121
|
+
providerId: "zulip",
|
|
122
|
+
credentials: {
|
|
123
|
+
webhookUrl: "https://example.com/webhook",
|
|
124
|
+
},
|
|
117
125
|
},
|
|
118
|
-
}
|
|
126
|
+
});
|
|
119
127
|
|
|
120
128
|
// Handle the result
|
|
121
129
|
console.log(result);
|
|
@@ -140,11 +148,14 @@ const novu = new NovuCore({
|
|
|
140
148
|
|
|
141
149
|
async function run() {
|
|
142
150
|
const res = await subscribersCredentialsAppend(novu, {
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
151
|
+
subscriberId: "<id>",
|
|
152
|
+
updateSubscriberChannelRequestDto: {
|
|
153
|
+
providerId: "zulip",
|
|
154
|
+
credentials: {
|
|
155
|
+
webhookUrl: "https://example.com/webhook",
|
|
156
|
+
},
|
|
146
157
|
},
|
|
147
|
-
}
|
|
158
|
+
});
|
|
148
159
|
|
|
149
160
|
if (!res.ok) {
|
|
150
161
|
throw res.error;
|
|
@@ -163,8 +174,7 @@ run();
|
|
|
163
174
|
|
|
164
175
|
| Parameter | Type | Required | Description |
|
|
165
176
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
166
|
-
| `
|
|
167
|
-
| `updateSubscriberChannelRequestDto` | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.md) | :heavy_check_mark: | N/A |
|
|
177
|
+
| `request` | [operations.SubscribersControllerModifySubscriberChannelRequest](../../models/operations/subscriberscontrollermodifysubscriberchannelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
168
178
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
169
179
|
| `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. |
|
|
170
180
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -195,7 +205,10 @@ const novu = new Novu({
|
|
|
195
205
|
});
|
|
196
206
|
|
|
197
207
|
async function run() {
|
|
198
|
-
const result = await novu.subscribers.credentials.delete(
|
|
208
|
+
const result = await novu.subscribers.credentials.delete({
|
|
209
|
+
subscriberId: "<id>",
|
|
210
|
+
providerId: "<id>",
|
|
211
|
+
});
|
|
199
212
|
|
|
200
213
|
// Handle the result
|
|
201
214
|
console.log(result);
|
|
@@ -219,7 +232,10 @@ const novu = new NovuCore({
|
|
|
219
232
|
});
|
|
220
233
|
|
|
221
234
|
async function run() {
|
|
222
|
-
const res = await subscribersCredentialsDelete(novu,
|
|
235
|
+
const res = await subscribersCredentialsDelete(novu, {
|
|
236
|
+
subscriberId: "<id>",
|
|
237
|
+
providerId: "<id>",
|
|
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
|
-
| `providerId` | *string* | :heavy_check_mark: | N/A |
|
|
257
|
+
| `request` | [operations.SubscribersControllerDeleteSubscriberCredentialsRequest](../../models/operations/subscriberscontrollerdeletesubscribercredentialsrequest.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. |
|
|
@@ -72,6 +72,7 @@ run();
|
|
|
72
72
|
|
|
73
73
|
| Parameter | Type | Required | Description |
|
|
74
74
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
75
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
75
76
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
77
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
77
78
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -151,7 +152,8 @@ run();
|
|
|
151
152
|
|
|
152
153
|
| Parameter | Type | Required | Description |
|
|
153
154
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
154
|
-
| `
|
|
155
|
+
| `createIntegrationRequestDto` | [components.CreateIntegrationRequestDto](../../models/components/createintegrationrequestdto.md) | :heavy_check_mark: | N/A |
|
|
156
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
155
157
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
156
158
|
| `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. |
|
|
157
159
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -225,6 +227,7 @@ run();
|
|
|
225
227
|
|
|
226
228
|
| Parameter | Type | Required | Description |
|
|
227
229
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
230
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
228
231
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
229
232
|
| `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. |
|
|
230
233
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -255,7 +258,10 @@ const novu = new Novu({
|
|
|
255
258
|
});
|
|
256
259
|
|
|
257
260
|
async function run() {
|
|
258
|
-
const result = await novu.integrations.update({
|
|
261
|
+
const result = await novu.integrations.update({
|
|
262
|
+
integrationId: "<id>",
|
|
263
|
+
updateIntegrationRequestDto: {},
|
|
264
|
+
});
|
|
259
265
|
|
|
260
266
|
// Handle the result
|
|
261
267
|
console.log(result);
|
|
@@ -279,7 +285,10 @@ const novu = new NovuCore({
|
|
|
279
285
|
});
|
|
280
286
|
|
|
281
287
|
async function run() {
|
|
282
|
-
const res = await integrationsUpdate(novu, {
|
|
288
|
+
const res = await integrationsUpdate(novu, {
|
|
289
|
+
integrationId: "<id>",
|
|
290
|
+
updateIntegrationRequestDto: {},
|
|
291
|
+
});
|
|
283
292
|
|
|
284
293
|
if (!res.ok) {
|
|
285
294
|
throw res.error;
|
|
@@ -298,8 +307,7 @@ run();
|
|
|
298
307
|
|
|
299
308
|
| Parameter | Type | Required | Description |
|
|
300
309
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
301
|
-
| `
|
|
302
|
-
| `updateIntegrationRequestDto` | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.md) | :heavy_check_mark: | N/A |
|
|
310
|
+
| `request` | [operations.IntegrationsControllerUpdateIntegrationByIdRequest](../../models/operations/integrationscontrollerupdateintegrationbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
303
311
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
304
312
|
| `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. |
|
|
305
313
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -374,6 +382,7 @@ run();
|
|
|
374
382
|
| Parameter | Type | Required | Description |
|
|
375
383
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
376
384
|
| `integrationId` | *string* | :heavy_check_mark: | N/A |
|
|
385
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
377
386
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
378
387
|
| `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. |
|
|
379
388
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -448,6 +457,7 @@ run();
|
|
|
448
457
|
| Parameter | Type | Required | Description |
|
|
449
458
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
450
459
|
| `integrationId` | *string* | :heavy_check_mark: | N/A |
|
|
460
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
451
461
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
452
462
|
| `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. |
|
|
453
463
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -144,6 +144,7 @@ run();
|
|
|
144
144
|
| Parameter | Type | Required | Description |
|
|
145
145
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
146
146
|
| `messageId` | *string* | :heavy_check_mark: | N/A |
|
|
147
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
147
148
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
148
149
|
| `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
150
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -174,7 +175,9 @@ const novu = new Novu({
|
|
|
174
175
|
});
|
|
175
176
|
|
|
176
177
|
async function run() {
|
|
177
|
-
const result = await novu.messages.deleteByTransactionId(
|
|
178
|
+
const result = await novu.messages.deleteByTransactionId({
|
|
179
|
+
transactionId: "<id>",
|
|
180
|
+
});
|
|
178
181
|
|
|
179
182
|
// Handle the result
|
|
180
183
|
console.log(result);
|
|
@@ -198,7 +201,9 @@ const novu = new NovuCore({
|
|
|
198
201
|
});
|
|
199
202
|
|
|
200
203
|
async function run() {
|
|
201
|
-
const res = await messagesDeleteByTransactionId(novu,
|
|
204
|
+
const res = await messagesDeleteByTransactionId(novu, {
|
|
205
|
+
transactionId: "<id>",
|
|
206
|
+
});
|
|
202
207
|
|
|
203
208
|
if (!res.ok) {
|
|
204
209
|
throw res.error;
|
|
@@ -217,8 +222,7 @@ run();
|
|
|
217
222
|
|
|
218
223
|
| Parameter | Type | Required | Description |
|
|
219
224
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
220
|
-
| `
|
|
221
|
-
| `channel` | [operations.Channel](../../models/operations/channel.md) | :heavy_minus_sign: | The channel of the message to be deleted |
|
|
225
|
+
| `request` | [operations.MessagesControllerDeleteMessagesByTransactionIdRequest](../../models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
222
226
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
223
227
|
| `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. |
|
|
224
228
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -174,6 +174,7 @@ run();
|
|
|
174
174
|
| Parameter | Type | Required | Description |
|
|
175
175
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
176
176
|
| `notificationId` | *string* | :heavy_check_mark: | N/A |
|
|
177
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
|
|
177
178
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
178
179
|
| `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. |
|
|
179
180
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|