@novu/api 0.1.1 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +2 -3
- package/README.md +43 -45
- package/docs/sdks/authentication/README.md +10 -10
- package/docs/sdks/credentials/README.md +12 -12
- package/docs/sdks/integrations/README.md +18 -18
- package/docs/sdks/messages/README.md +11 -17
- package/docs/sdks/notifications/README.md +8 -12
- package/docs/sdks/novu/README.md +21 -179
- package/docs/sdks/novumessages/README.md +13 -13
- package/docs/sdks/novunotifications/README.md +10 -16
- package/docs/sdks/novusubscribers/README.md +9 -9
- package/docs/sdks/preferences/README.md +183 -22
- package/docs/sdks/properties/README.md +4 -4
- package/docs/sdks/stats/README.md +6 -6
- package/docs/sdks/subscribers/README.md +349 -35
- package/docs/sdks/topics/README.md +15 -19
- package/docs/sdks/webhooks/README.md +3 -3
- package/funcs/cancel.js +4 -4
- package/funcs/cancel.js.map +1 -1
- package/funcs/integrationsCreate.js +4 -4
- package/funcs/integrationsCreate.js.map +1 -1
- package/funcs/integrationsDelete.js +4 -4
- package/funcs/integrationsDelete.js.map +1 -1
- package/funcs/integrationsList.js +4 -4
- package/funcs/integrationsList.js.map +1 -1
- package/funcs/integrationsListActive.js +4 -4
- package/funcs/integrationsListActive.js.map +1 -1
- package/funcs/integrationsSetAsPrimary.js +4 -4
- package/funcs/integrationsSetAsPrimary.js.map +1 -1
- package/funcs/integrationsUpdate.js +4 -4
- package/funcs/integrationsUpdate.js.map +1 -1
- package/funcs/integrationsWebhooksRetrieve.js +4 -4
- package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
- package/funcs/messagesDelete.js +4 -4
- package/funcs/messagesDelete.js.map +1 -1
- package/funcs/messagesDeleteByTransactionId.js +4 -4
- package/funcs/messagesDeleteByTransactionId.js.map +1 -1
- package/funcs/messagesRetrieve.js +4 -4
- package/funcs/messagesRetrieve.js.map +1 -1
- package/funcs/notificationsList.js +4 -4
- package/funcs/notificationsList.js.map +1 -1
- package/funcs/notificationsRetrieve.js +4 -4
- package/funcs/notificationsRetrieve.js.map +1 -1
- package/funcs/notificationsStatsGraph.js +4 -4
- package/funcs/notificationsStatsGraph.js.map +1 -1
- package/funcs/notificationsStatsRetrieve.js +4 -4
- package/funcs/notificationsStatsRetrieve.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauth.js +7 -7
- package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +2 -2
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +6 -6
- package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +1 -1
- package/funcs/subscribersCreate.d.ts +1 -1
- package/funcs/subscribersCreate.d.ts.map +1 -1
- package/funcs/subscribersCreate.js +6 -6
- package/funcs/subscribersCreate.js.map +1 -1
- package/funcs/subscribersCreateBulk.d.ts +1 -1
- package/funcs/subscribersCreateBulk.d.ts.map +1 -1
- package/funcs/subscribersCreateBulk.js +7 -6
- package/funcs/subscribersCreateBulk.js.map +1 -1
- package/funcs/subscribersCredentialsAppend.d.ts +1 -1
- package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
- package/funcs/subscribersCredentialsAppend.js +6 -6
- package/funcs/subscribersCredentialsAppend.js.map +1 -1
- package/funcs/subscribersCredentialsDelete.d.ts +1 -1
- package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
- package/funcs/subscribersCredentialsDelete.js +7 -7
- package/funcs/subscribersCredentialsDelete.js.map +1 -1
- package/funcs/subscribersCredentialsUpdate.d.ts +1 -1
- package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
- package/funcs/subscribersCredentialsUpdate.js +6 -6
- package/funcs/subscribersCredentialsUpdate.js.map +1 -1
- package/funcs/subscribersDelete.js +5 -5
- package/funcs/subscribersDelete.js.map +1 -1
- package/funcs/subscribersDeleteLegacy.d.ts +18 -0
- package/funcs/subscribersDeleteLegacy.d.ts.map +1 -0
- package/funcs/subscribersDeleteLegacy.js +141 -0
- package/funcs/subscribersDeleteLegacy.js.map +1 -0
- package/funcs/subscribersList.d.ts +1 -1
- package/funcs/subscribersList.d.ts.map +1 -1
- package/funcs/subscribersList.js +6 -6
- package/funcs/subscribersList.js.map +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts +1 -1
- package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAll.js +8 -7
- package/funcs/subscribersMessagesMarkAll.js.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -1
- package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
- package/funcs/subscribersMessagesMarkAllAs.js +6 -6
- package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
- package/funcs/subscribersMessagesUpdateAsSeen.js +6 -6
- package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts +1 -1
- package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
- package/funcs/subscribersNotificationsFeed.js +7 -6
- package/funcs/subscribersNotificationsFeed.js.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts +1 -1
- package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
- package/funcs/subscribersNotificationsUnseenCount.js +6 -6
- package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
- package/funcs/subscribersPatch.d.ts +17 -0
- package/funcs/subscribersPatch.d.ts.map +1 -0
- package/funcs/{supportControllerFetchUserOrganizations.js → subscribersPatch.js} +48 -16
- package/funcs/subscribersPatch.js.map +1 -0
- package/funcs/subscribersPreferencesList.d.ts +1 -1
- package/funcs/subscribersPreferencesList.d.ts.map +1 -1
- package/funcs/subscribersPreferencesList.js +6 -6
- package/funcs/subscribersPreferencesList.js.map +1 -1
- package/funcs/subscribersPreferencesRetrieve.d.ts +16 -0
- package/funcs/subscribersPreferencesRetrieve.d.ts.map +1 -0
- package/funcs/{create.js → subscribersPreferencesRetrieve.js} +51 -20
- package/funcs/subscribersPreferencesRetrieve.js.map +1 -0
- package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
- package/funcs/subscribersPreferencesRetrieveByLevel.js +6 -6
- package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
- package/funcs/subscribersPreferencesUpdate.d.ts +6 -2
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +21 -15
- package/funcs/subscribersPreferencesUpdate.js.map +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.d.ts +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdateGlobal.js +6 -6
- package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
- package/funcs/subscribersPreferencesUpdateLegacy.d.ts +13 -0
- package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +1 -0
- package/funcs/subscribersPreferencesUpdateLegacy.js +139 -0
- package/funcs/subscribersPreferencesUpdateLegacy.js.map +1 -0
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
- package/funcs/subscribersPropertiesUpdateOnlineFlag.js +6 -6
- package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
- package/funcs/subscribersRetrieve.d.ts +1 -1
- package/funcs/subscribersRetrieve.d.ts.map +1 -1
- package/funcs/subscribersRetrieve.js +6 -11
- package/funcs/subscribersRetrieve.js.map +1 -1
- package/funcs/subscribersRetrieveLegacy.d.ts +16 -0
- package/funcs/subscribersRetrieveLegacy.d.ts.map +1 -0
- package/funcs/subscribersRetrieveLegacy.js +144 -0
- package/funcs/subscribersRetrieveLegacy.js.map +1 -0
- package/funcs/subscribersSearch.d.ts +13 -0
- package/funcs/subscribersSearch.d.ts.map +1 -0
- package/funcs/subscribersSearch.js +138 -0
- package/funcs/subscribersSearch.js.map +1 -0
- package/funcs/subscribersUpdate.d.ts +1 -1
- package/funcs/subscribersUpdate.d.ts.map +1 -1
- package/funcs/subscribersUpdate.js +6 -6
- package/funcs/subscribersUpdate.js.map +1 -1
- package/funcs/topicsCreate.js +4 -4
- package/funcs/topicsCreate.js.map +1 -1
- package/funcs/topicsDelete.js +4 -4
- package/funcs/topicsDelete.js.map +1 -1
- package/funcs/topicsList.js +4 -4
- package/funcs/topicsList.js.map +1 -1
- package/funcs/topicsRename.js +4 -4
- package/funcs/topicsRename.js.map +1 -1
- package/funcs/topicsRetrieve.js +4 -4
- package/funcs/topicsRetrieve.js.map +1 -1
- package/funcs/topicsSubscribersAssign.js +4 -4
- package/funcs/topicsSubscribersAssign.js.map +1 -1
- package/funcs/topicsSubscribersRemove.js +4 -4
- package/funcs/topicsSubscribersRemove.js.map +1 -1
- package/funcs/topicsSubscribersRetrieve.js +4 -4
- package/funcs/topicsSubscribersRetrieve.js.map +1 -1
- package/funcs/trigger.js +4 -4
- package/funcs/trigger.js.map +1 -1
- package/funcs/triggerBroadcast.js +4 -4
- package/funcs/triggerBroadcast.js.map +1 -1
- package/funcs/triggerBulk.js +4 -4
- package/funcs/triggerBulk.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/retries.js +0 -1
- package/lib/retries.js.map +1 -1
- package/lib/security.js +1 -1
- package/lib/security.js.map +1 -1
- package/models/components/{channelsettings.d.ts → channelsettingsdto.d.ts} +22 -22
- package/models/components/channelsettingsdto.d.ts.map +1 -0
- package/models/components/{channelsettings.js → channelsettingsdto.js} +29 -29
- package/models/components/channelsettingsdto.js.map +1 -0
- package/models/components/getsubscriberpreferencesdto.d.ts +39 -0
- package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -0
- package/models/components/getsubscriberpreferencesdto.js +63 -0
- package/models/components/getsubscriberpreferencesdto.js.map +1 -0
- package/models/components/globalpreferencedto.d.ts +38 -0
- package/models/components/globalpreferencedto.d.ts.map +1 -0
- package/models/components/globalpreferencedto.js +62 -0
- package/models/components/globalpreferencedto.js.map +1 -0
- package/models/components/index.d.ts +11 -4
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +11 -4
- package/models/components/index.js.map +1 -1
- package/models/components/listsubscribersresponsedto.d.ts +43 -0
- package/models/components/listsubscribersresponsedto.d.ts.map +1 -0
- package/models/components/listsubscribersresponsedto.js +64 -0
- package/models/components/listsubscribersresponsedto.js.map +1 -0
- package/models/components/overrides.d.ts +112 -0
- package/models/components/overrides.d.ts.map +1 -0
- package/models/components/overrides.js +110 -0
- package/models/components/overrides.js.map +1 -0
- package/models/components/patchpreferencechannelsdto.d.ts +52 -0
- package/models/components/patchpreferencechannelsdto.d.ts.map +1 -0
- package/models/components/patchpreferencechannelsdto.js +76 -0
- package/models/components/patchpreferencechannelsdto.js.map +1 -0
- package/models/components/patchsubscriberpreferencesdto.d.ts +38 -0
- package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -0
- package/models/components/patchsubscriberpreferencesdto.js +62 -0
- package/models/components/patchsubscriberpreferencesdto.js.map +1 -0
- package/models/components/patchsubscriberrequestdto.d.ts +96 -0
- package/models/components/patchsubscriberrequestdto.d.ts.map +1 -0
- package/models/components/patchsubscriberrequestdto.js +100 -0
- package/models/components/patchsubscriberrequestdto.js.map +1 -0
- package/models/components/removesubscriberresponsedto.d.ts +37 -0
- package/models/components/removesubscriberresponsedto.d.ts.map +1 -0
- package/models/components/removesubscriberresponsedto.js +61 -0
- package/models/components/removesubscriberresponsedto.js.map +1 -0
- package/models/components/security.d.ts +2 -2
- package/models/components/security.d.ts.map +1 -1
- package/models/components/security.js +2 -11
- package/models/components/security.js.map +1 -1
- package/models/components/subscriberresponsedto.d.ts +14 -3
- package/models/components/subscriberresponsedto.d.ts.map +1 -1
- package/models/components/subscriberresponsedto.js +5 -3
- package/models/components/subscriberresponsedto.js.map +1 -1
- package/models/components/triggereventrequestdto.d.ts +1 -12
- package/models/components/triggereventrequestdto.d.ts.map +1 -1
- package/models/components/triggereventrequestdto.js +10 -6
- package/models/components/triggereventrequestdto.js.map +1 -1
- package/models/components/triggereventtoallrequestdto.d.ts +15 -15
- package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
- package/models/components/triggereventtoallrequestdto.js +20 -18
- package/models/components/triggereventtoallrequestdto.js.map +1 -1
- package/models/components/workflowinfodto.d.ts +42 -0
- package/models/components/workflowinfodto.d.ts.map +1 -0
- package/models/components/{createsupportthreaddto.js → workflowinfodto.js} +23 -19
- package/models/components/workflowinfodto.js.map +1 -0
- package/models/components/workflowpreferencedto.d.ts +50 -0
- package/models/components/workflowpreferencedto.d.ts.map +1 -0
- package/models/components/workflowpreferencedto.js +68 -0
- package/models/components/workflowpreferencedto.js.map +1 -0
- package/models/operations/index.d.ts +25 -21
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +25 -21
- package/models/operations/index.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriber.d.ts +0 -5
- package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriber.js +0 -2
- package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts +66 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.js +110 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.d.ts +68 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.d.ts.map +1 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.js +114 -0
- package/models/operations/subscriberscontrollerpatchsubscriber.js.map +1 -0
- package/models/operations/subscriberscontrollerremovesubscriber.d.ts +2 -2
- package/models/operations/subscriberscontrollerremovesubscriber.js +2 -2
- package/models/operations/subscriberscontrollersearchsubscribers.d.ts +126 -0
- package/models/operations/subscriberscontrollersearchsubscribers.d.ts.map +1 -0
- package/models/operations/subscriberscontrollersearchsubscribers.js +145 -0
- package/models/operations/subscriberscontrollersearchsubscribers.js.map +1 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts +68 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js +118 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js.map +1 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts +66 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.js +112 -0
- package/models/operations/subscribersv1controllerbulkcreatesubscribers.js.map +1 -0
- package/models/operations/subscribersv1controllerchataccessoauth.d.ts +80 -0
- package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerchataccessoauth.js +113 -0
- package/models/operations/subscribersv1controllerchataccessoauth.js.map +1 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +108 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.js +143 -0
- package/models/operations/subscribersv1controllerchatoauthcallback.js.map +1 -0
- package/models/operations/subscribersv1controllercreatesubscriber.d.ts +66 -0
- package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllercreatesubscriber.js +112 -0
- package/models/operations/subscribersv1controllercreatesubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts +65 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.js +111 -0
- package/models/operations/subscribersv1controllerdeletesubscribercredentials.js.map +1 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts +79 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.js +120 -0
- package/models/operations/subscribersv1controllergetnotificationsfeed.js.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriber.d.ts +71 -0
- package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriber.js +112 -0
- package/models/operations/subscribersv1controllergetsubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +108 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +141 -0
- package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +1 -0
- package/models/operations/subscribersv1controllergetunseencount.d.ts +76 -0
- package/models/operations/subscribersv1controllergetunseencount.d.ts.map +1 -0
- package/models/operations/subscribersv1controllergetunseencount.js +114 -0
- package/models/operations/subscribersv1controllergetunseencount.js.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +71 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +116 -0
- package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscribers.d.ts +108 -0
- package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerlistsubscribers.js +145 -0
- package/models/operations/subscribersv1controllerlistsubscribers.js.map +1 -0
- package/models/operations/subscribersv1controllermarkactionasseen.d.ts +72 -0
- package/models/operations/subscribersv1controllermarkactionasseen.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermarkactionasseen.js +118 -0
- package/models/operations/subscribersv1controllermarkactionasseen.js.map +1 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.d.ts +68 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.js +114 -0
- package/models/operations/subscribersv1controllermarkallunreadasread.js.map +1 -0
- package/models/operations/subscribersv1controllermarkmessagesas.d.ts +68 -0
- package/models/operations/subscribersv1controllermarkmessagesas.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermarkmessagesas.js +114 -0
- package/models/operations/subscribersv1controllermarkmessagesas.js.map +1 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts +68 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts.map +1 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.js +115 -0
- package/models/operations/subscribersv1controllermodifysubscriberchannel.js.map +1 -0
- package/models/operations/subscribersv1controllerremovesubscriber.d.ts +66 -0
- package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerremovesubscriber.js +110 -0
- package/models/operations/subscribersv1controllerremovesubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.js +114 -0
- package/models/operations/subscribersv1controllerupdatesubscriber.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.js +115 -0
- package/models/operations/subscribersv1controllerupdatesubscriberchannel.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +118 -0
- package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts +68 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js +118 -0
- package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +70 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +1 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +120 -0
- package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +1 -0
- package/package.json +6 -7
- package/sdk/authentication.d.ts +3 -3
- package/sdk/authentication.d.ts.map +1 -1
- package/sdk/authentication.js.map +1 -1
- package/sdk/credentials.d.ts +3 -3
- package/sdk/credentials.d.ts.map +1 -1
- package/sdk/credentials.js.map +1 -1
- package/sdk/novumessages.d.ts +3 -3
- package/sdk/novumessages.d.ts.map +1 -1
- package/sdk/novumessages.js.map +1 -1
- package/sdk/novunotifications.d.ts +2 -2
- package/sdk/novunotifications.d.ts.map +1 -1
- package/sdk/novunotifications.js.map +1 -1
- package/sdk/preferences.d.ts +18 -4
- package/sdk/preferences.d.ts.map +1 -1
- package/sdk/preferences.js +22 -2
- package/sdk/preferences.js.map +1 -1
- package/sdk/properties.d.ts +1 -1
- package/sdk/properties.d.ts.map +1 -1
- package/sdk/sdk.d.ts +0 -8
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -14
- package/sdk/sdk.js.map +1 -1
- package/sdk/subscribers.d.ts +33 -6
- package/sdk/subscribers.d.ts.map +1 -1
- package/sdk/subscribers.js +43 -4
- package/sdk/subscribers.js.map +1 -1
- package/sources/json-development.json +3504 -356
- package/src/funcs/cancel.ts +4 -4
- package/src/funcs/integrationsCreate.ts +4 -4
- package/src/funcs/integrationsDelete.ts +4 -4
- package/src/funcs/integrationsList.ts +4 -4
- package/src/funcs/integrationsListActive.ts +4 -4
- package/src/funcs/integrationsSetAsPrimary.ts +5 -5
- package/src/funcs/integrationsUpdate.ts +5 -5
- package/src/funcs/integrationsWebhooksRetrieve.ts +4 -4
- package/src/funcs/messagesDelete.ts +4 -4
- package/src/funcs/messagesDeleteByTransactionId.ts +4 -4
- package/src/funcs/messagesRetrieve.ts +4 -4
- package/src/funcs/notificationsList.ts +4 -4
- package/src/funcs/notificationsRetrieve.ts +4 -4
- package/src/funcs/notificationsStatsGraph.ts +4 -4
- package/src/funcs/notificationsStatsRetrieve.ts +4 -4
- package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +10 -10
- package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +11 -11
- package/src/funcs/subscribersCreate.ts +10 -10
- package/src/funcs/subscribersCreateBulk.ts +15 -15
- package/src/funcs/subscribersCredentialsAppend.ts +11 -11
- package/src/funcs/subscribersCredentialsDelete.ts +10 -10
- package/src/funcs/subscribersCredentialsUpdate.ts +11 -11
- package/src/funcs/subscribersDelete.ts +5 -5
- package/src/funcs/subscribersDeleteLegacy.ts +200 -0
- package/src/funcs/subscribersList.ts +11 -11
- package/src/funcs/subscribersMessagesMarkAll.ts +14 -11
- package/src/funcs/subscribersMessagesMarkAllAs.ts +10 -10
- package/src/funcs/subscribersMessagesUpdateAsSeen.ts +10 -10
- package/src/funcs/subscribersNotificationsFeed.ts +11 -10
- package/src/funcs/subscribersNotificationsUnseenCount.ts +10 -10
- package/src/funcs/{supportControllerFetchUserOrganizations.ts → subscribersPatch.ts} +73 -19
- package/src/funcs/subscribersPreferencesList.ts +10 -10
- package/src/funcs/subscribersPreferencesRetrieve.ts +203 -0
- package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +10 -10
- package/src/funcs/subscribersPreferencesUpdate.ts +31 -24
- package/src/funcs/subscribersPreferencesUpdateGlobal.ts +16 -15
- package/src/funcs/subscribersPreferencesUpdateLegacy.ts +202 -0
- package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +10 -10
- package/src/funcs/subscribersRetrieve.ts +6 -13
- package/src/funcs/subscribersRetrieveLegacy.ts +205 -0
- package/src/funcs/{create.ts → subscribersSearch.ts} +78 -31
- package/src/funcs/subscribersUpdate.ts +10 -10
- package/src/funcs/topicsCreate.ts +4 -4
- package/src/funcs/topicsDelete.ts +4 -4
- package/src/funcs/topicsList.ts +4 -4
- package/src/funcs/topicsRename.ts +4 -4
- package/src/funcs/topicsRetrieve.ts +4 -4
- package/src/funcs/topicsSubscribersAssign.ts +4 -4
- package/src/funcs/topicsSubscribersRemove.ts +4 -4
- package/src/funcs/topicsSubscribersRetrieve.ts +4 -4
- package/src/funcs/trigger.ts +4 -4
- package/src/funcs/triggerBroadcast.ts +4 -4
- package/src/funcs/triggerBulk.ts +4 -4
- package/src/lib/config.ts +4 -4
- package/src/lib/retries.ts +0 -1
- package/src/lib/security.ts +1 -1
- package/src/models/components/{channelsettings.ts → channelsettingsdto.ts} +40 -38
- package/src/models/components/getsubscriberpreferencesdto.ts +90 -0
- package/src/models/components/globalpreferencedto.ts +82 -0
- package/src/models/components/index.ts +11 -4
- package/src/models/components/listsubscribersresponsedto.ts +89 -0
- package/src/models/components/overrides.ts +141 -0
- package/src/models/components/patchpreferencechannelsdto.ts +106 -0
- package/src/models/components/patchsubscriberpreferencesdto.ts +84 -0
- package/src/models/components/patchsubscriberrequestdto.ts +182 -0
- package/src/models/components/removesubscriberresponsedto.ts +78 -0
- package/src/models/components/security.ts +4 -13
- package/src/models/components/subscriberresponsedto.ts +18 -9
- package/src/models/components/triggereventrequestdto.ts +11 -22
- package/src/models/components/triggereventtoallrequestdto.ts +35 -24
- package/src/models/components/workflowinfodto.ts +81 -0
- package/src/models/components/workflowpreferencedto.ts +108 -0
- package/src/models/operations/index.ts +25 -21
- package/src/models/operations/subscriberscontrollergetsubscriber.ts +0 -7
- package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +183 -0
- package/src/models/operations/subscriberscontrollerpatchsubscriber.ts +189 -0
- package/src/models/operations/subscriberscontrollerremovesubscriber.ts +4 -4
- package/src/models/operations/subscriberscontrollersearchsubscribers.ts +260 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts +189 -0
- package/src/models/operations/subscribersv1controllerbulkcreatesubscribers.ts +185 -0
- package/src/models/operations/{subscriberscontrollerchataccessoauth.ts → subscribersv1controllerchataccessoauth.ts} +47 -46
- package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +281 -0
- package/src/models/operations/subscribersv1controllercreatesubscriber.ts +187 -0
- package/src/models/operations/subscribersv1controllerdeletesubscribercredentials.ts +178 -0
- package/src/models/operations/{subscriberscontrollergetnotificationsfeed.ts → subscribersv1controllergetnotificationsfeed.ts} +46 -46
- package/src/models/operations/subscribersv1controllergetsubscriber.ts +188 -0
- package/src/models/operations/{subscriberscontrollergetsubscriberpreferencebylevel.ts → subscribersv1controllergetsubscriberpreferencebylevel.ts} +46 -46
- package/src/models/operations/subscribersv1controllergetunseencount.ts +195 -0
- package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +191 -0
- package/src/models/operations/subscribersv1controllerlistsubscribers.ts +283 -0
- package/src/models/operations/{subscriberscontrollermarkactionasseen.ts → subscribersv1controllermarkactionasseen.ts} +48 -46
- package/src/models/operations/subscribersv1controllermarkallunreadasread.ts +191 -0
- package/src/models/operations/subscribersv1controllermarkmessagesas.ts +187 -0
- package/src/models/operations/subscribersv1controllermodifysubscriberchannel.ts +192 -0
- package/src/models/operations/subscribersv1controllerremovesubscriber.ts +183 -0
- package/src/models/operations/{subscriberscontrollerupdatesubscriber.ts → subscribersv1controllerupdatesubscriber.ts} +48 -46
- package/src/models/operations/subscribersv1controllerupdatesubscriberchannel.ts +192 -0
- package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +195 -0
- package/src/models/operations/subscribersv1controllerupdatesubscriberonlineflag.ts +193 -0
- package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +197 -0
- package/src/sdk/authentication.ts +4 -4
- package/src/sdk/credentials.ts +7 -3
- package/src/sdk/novumessages.ts +4 -4
- package/src/sdk/novunotifications.ts +4 -4
- package/src/sdk/preferences.ts +52 -7
- package/src/sdk/properties.ts +1 -1
- package/src/sdk/sdk.ts +0 -34
- package/src/sdk/subscribers.ts +89 -10
- package/funcs/create.d.ts +0 -9
- package/funcs/create.d.ts.map +0 -1
- package/funcs/create.js.map +0 -1
- package/funcs/supportControllerFetchUserOrganizations.d.ts +0 -10
- package/funcs/supportControllerFetchUserOrganizations.d.ts.map +0 -1
- package/funcs/supportControllerFetchUserOrganizations.js.map +0 -1
- package/models/components/channelsettings.d.ts.map +0 -1
- package/models/components/channelsettings.js.map +0 -1
- package/models/components/createsupportthreaddto.d.ts +0 -29
- package/models/components/createsupportthreaddto.d.ts.map +0 -1
- package/models/components/createsupportthreaddto.js.map +0 -1
- package/models/components/plaincardrequestdto.d.ts +0 -100
- package/models/components/plaincardrequestdto.d.ts.map +0 -1
- package/models/components/plaincardrequestdto.js +0 -139
- package/models/components/plaincardrequestdto.js.map +0 -1
- package/models/components/workflowtostepcontrolvaluesdto.d.ts +0 -40
- package/models/components/workflowtostepcontrolvaluesdto.d.ts.map +0 -1
- package/models/components/workflowtostepcontrolvaluesdto.js +0 -59
- package/models/components/workflowtostepcontrolvaluesdto.js.map +0 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +0 -66
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +0 -112
- package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +0 -1
- package/models/operations/subscriberscontrollerchataccessoauth.d.ts +0 -80
- package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerchataccessoauth.js +0 -113
- package/models/operations/subscriberscontrollerchataccessoauth.js.map +0 -1
- package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +0 -108
- package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerchatoauthcallback.js +0 -142
- package/models/operations/subscriberscontrollerchatoauthcallback.js.map +0 -1
- package/models/operations/subscriberscontrollercreatesubscriber.d.ts +0 -66
- package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +0 -1
- package/models/operations/subscriberscontrollercreatesubscriber.js +0 -112
- package/models/operations/subscriberscontrollercreatesubscriber.js.map +0 -1
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +0 -65
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +0 -111
- package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +0 -1
- package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +0 -79
- package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +0 -1
- package/models/operations/subscriberscontrollergetnotificationsfeed.js +0 -120
- package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +0 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +0 -108
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +0 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +0 -141
- package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +0 -1
- package/models/operations/subscriberscontrollergetunseencount.d.ts +0 -76
- package/models/operations/subscriberscontrollergetunseencount.d.ts.map +0 -1
- package/models/operations/subscriberscontrollergetunseencount.js +0 -114
- package/models/operations/subscriberscontrollergetunseencount.js.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +0 -71
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +0 -113
- package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscribers.d.ts +0 -108
- package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerlistsubscribers.js +0 -145
- package/models/operations/subscriberscontrollerlistsubscribers.js.map +0 -1
- package/models/operations/subscriberscontrollermarkactionasseen.d.ts +0 -72
- package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermarkactionasseen.js +0 -118
- package/models/operations/subscriberscontrollermarkactionasseen.js.map +0 -1
- package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +0 -68
- package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermarkallunreadasread.js +0 -114
- package/models/operations/subscriberscontrollermarkallunreadasread.js.map +0 -1
- package/models/operations/subscriberscontrollermarkmessagesas.d.ts +0 -68
- package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermarkmessagesas.js +0 -114
- package/models/operations/subscriberscontrollermarkmessagesas.js.map +0 -1
- package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +0 -68
- package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +0 -1
- package/models/operations/subscriberscontrollermodifysubscriberchannel.js +0 -114
- package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriber.js +0 -114
- package/models/operations/subscriberscontrollerupdatesubscriber.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +0 -114
- package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +0 -118
- package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +0 -68
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +0 -117
- package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +0 -70
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +0 -1
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +0 -119
- package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +0 -1
- package/models/operations/supportcontrollercreatethread.d.ts +0 -35
- package/models/operations/supportcontrollercreatethread.d.ts.map +0 -1
- package/models/operations/supportcontrollercreatethread.js +0 -73
- package/models/operations/supportcontrollercreatethread.js.map +0 -1
- package/models/operations/supportcontrollerfetchuserorganizations.d.ts +0 -56
- package/models/operations/supportcontrollerfetchuserorganizations.d.ts.map +0 -1
- package/models/operations/supportcontrollerfetchuserorganizations.js +0 -96
- package/models/operations/supportcontrollerfetchuserorganizations.js.map +0 -1
- package/src/models/components/createsupportthreaddto.ts +0 -66
- package/src/models/components/plaincardrequestdto.ts +0 -223
- package/src/models/components/workflowtostepcontrolvaluesdto.ts +0 -71
- package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +0 -185
- package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +0 -281
- package/src/models/operations/subscriberscontrollercreatesubscriber.ts +0 -185
- package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +0 -177
- package/src/models/operations/subscriberscontrollergetunseencount.ts +0 -192
- package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +0 -193
- package/src/models/operations/subscriberscontrollerlistsubscribers.ts +0 -282
- package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +0 -191
- package/src/models/operations/subscriberscontrollermarkmessagesas.ts +0 -184
- package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +0 -193
- package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +0 -193
- package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +0 -195
- package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +0 -192
- package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +0 -196
- package/src/models/operations/supportcontrollercreatethread.ts +0 -90
- package/src/models/operations/supportcontrollerfetchuserorganizations.ts +0 -163
|
@@ -486,7 +486,7 @@
|
|
|
486
486
|
],
|
|
487
487
|
"security": [
|
|
488
488
|
{
|
|
489
|
-
"
|
|
489
|
+
"secretKey": []
|
|
490
490
|
}
|
|
491
491
|
]
|
|
492
492
|
}
|
|
@@ -979,7 +979,7 @@
|
|
|
979
979
|
],
|
|
980
980
|
"security": [
|
|
981
981
|
{
|
|
982
|
-
"
|
|
982
|
+
"secretKey": []
|
|
983
983
|
}
|
|
984
984
|
]
|
|
985
985
|
}
|
|
@@ -1502,7 +1502,7 @@
|
|
|
1502
1502
|
],
|
|
1503
1503
|
"security": [
|
|
1504
1504
|
{
|
|
1505
|
-
"
|
|
1505
|
+
"secretKey": []
|
|
1506
1506
|
}
|
|
1507
1507
|
]
|
|
1508
1508
|
}
|
|
@@ -1990,7 +1990,7 @@
|
|
|
1990
1990
|
],
|
|
1991
1991
|
"security": [
|
|
1992
1992
|
{
|
|
1993
|
-
"
|
|
1993
|
+
"secretKey": []
|
|
1994
1994
|
}
|
|
1995
1995
|
]
|
|
1996
1996
|
}
|
|
@@ -2559,7 +2559,7 @@
|
|
|
2559
2559
|
],
|
|
2560
2560
|
"security": [
|
|
2561
2561
|
{
|
|
2562
|
-
"
|
|
2562
|
+
"secretKey": []
|
|
2563
2563
|
}
|
|
2564
2564
|
]
|
|
2565
2565
|
}
|
|
@@ -3034,7 +3034,7 @@
|
|
|
3034
3034
|
],
|
|
3035
3035
|
"security": [
|
|
3036
3036
|
{
|
|
3037
|
-
"
|
|
3037
|
+
"secretKey": []
|
|
3038
3038
|
}
|
|
3039
3039
|
]
|
|
3040
3040
|
}
|
|
@@ -3521,7 +3521,7 @@
|
|
|
3521
3521
|
],
|
|
3522
3522
|
"security": [
|
|
3523
3523
|
{
|
|
3524
|
-
"
|
|
3524
|
+
"secretKey": []
|
|
3525
3525
|
}
|
|
3526
3526
|
]
|
|
3527
3527
|
}
|
|
@@ -4003,7 +4003,7 @@
|
|
|
4003
4003
|
],
|
|
4004
4004
|
"security": [
|
|
4005
4005
|
{
|
|
4006
|
-
"
|
|
4006
|
+
"secretKey": []
|
|
4007
4007
|
}
|
|
4008
4008
|
]
|
|
4009
4009
|
}
|
|
@@ -4481,7 +4481,7 @@
|
|
|
4481
4481
|
],
|
|
4482
4482
|
"security": [
|
|
4483
4483
|
{
|
|
4484
|
-
"
|
|
4484
|
+
"secretKey": []
|
|
4485
4485
|
}
|
|
4486
4486
|
]
|
|
4487
4487
|
},
|
|
@@ -4964,7 +4964,7 @@
|
|
|
4964
4964
|
],
|
|
4965
4965
|
"security": [
|
|
4966
4966
|
{
|
|
4967
|
-
"
|
|
4967
|
+
"secretKey": []
|
|
4968
4968
|
}
|
|
4969
4969
|
]
|
|
4970
4970
|
}
|
|
@@ -5443,7 +5443,7 @@
|
|
|
5443
5443
|
],
|
|
5444
5444
|
"security": [
|
|
5445
5445
|
{
|
|
5446
|
-
"
|
|
5446
|
+
"secretKey": []
|
|
5447
5447
|
}
|
|
5448
5448
|
]
|
|
5449
5449
|
}
|
|
@@ -5927,7 +5927,7 @@
|
|
|
5927
5927
|
],
|
|
5928
5928
|
"security": [
|
|
5929
5929
|
{
|
|
5930
|
-
"
|
|
5930
|
+
"secretKey": []
|
|
5931
5931
|
}
|
|
5932
5932
|
]
|
|
5933
5933
|
}
|
|
@@ -6412,7 +6412,7 @@
|
|
|
6412
6412
|
],
|
|
6413
6413
|
"security": [
|
|
6414
6414
|
{
|
|
6415
|
-
"
|
|
6415
|
+
"secretKey": []
|
|
6416
6416
|
}
|
|
6417
6417
|
]
|
|
6418
6418
|
},
|
|
@@ -6895,7 +6895,7 @@
|
|
|
6895
6895
|
],
|
|
6896
6896
|
"security": [
|
|
6897
6897
|
{
|
|
6898
|
-
"
|
|
6898
|
+
"secretKey": []
|
|
6899
6899
|
}
|
|
6900
6900
|
]
|
|
6901
6901
|
}
|
|
@@ -7371,14 +7371,14 @@
|
|
|
7371
7371
|
],
|
|
7372
7372
|
"security": [
|
|
7373
7373
|
{
|
|
7374
|
-
"
|
|
7374
|
+
"secretKey": []
|
|
7375
7375
|
}
|
|
7376
7376
|
]
|
|
7377
7377
|
}
|
|
7378
7378
|
},
|
|
7379
7379
|
"/v1/subscribers": {
|
|
7380
7380
|
"get": {
|
|
7381
|
-
"operationId": "
|
|
7381
|
+
"operationId": "SubscribersV1Controller_listSubscribers",
|
|
7382
7382
|
"x-speakeasy-pagination": {
|
|
7383
7383
|
"type": "offsetLimit",
|
|
7384
7384
|
"inputs": [
|
|
@@ -7896,12 +7896,12 @@
|
|
|
7896
7896
|
],
|
|
7897
7897
|
"security": [
|
|
7898
7898
|
{
|
|
7899
|
-
"
|
|
7899
|
+
"secretKey": []
|
|
7900
7900
|
}
|
|
7901
7901
|
]
|
|
7902
7902
|
},
|
|
7903
7903
|
"post": {
|
|
7904
|
-
"operationId": "
|
|
7904
|
+
"operationId": "SubscribersV1Controller_createSubscriber",
|
|
7905
7905
|
"summary": "Create subscriber",
|
|
7906
7906
|
"description": "Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.",
|
|
7907
7907
|
"parameters": [
|
|
@@ -8379,14 +8379,15 @@
|
|
|
8379
8379
|
],
|
|
8380
8380
|
"security": [
|
|
8381
8381
|
{
|
|
8382
|
-
"
|
|
8382
|
+
"secretKey": []
|
|
8383
8383
|
}
|
|
8384
8384
|
]
|
|
8385
8385
|
}
|
|
8386
8386
|
},
|
|
8387
8387
|
"/v1/subscribers/{subscriberId}": {
|
|
8388
8388
|
"get": {
|
|
8389
|
-
"operationId": "
|
|
8389
|
+
"operationId": "SubscribersV1Controller_getSubscriber",
|
|
8390
|
+
"x-speakeasy-name-override": "retrieveLegacy",
|
|
8390
8391
|
"summary": "Get subscriber",
|
|
8391
8392
|
"description": "Get subscriber by your internal id used to identify the subscriber",
|
|
8392
8393
|
"parameters": [
|
|
@@ -8871,12 +8872,12 @@
|
|
|
8871
8872
|
],
|
|
8872
8873
|
"security": [
|
|
8873
8874
|
{
|
|
8874
|
-
"
|
|
8875
|
+
"secretKey": []
|
|
8875
8876
|
}
|
|
8876
8877
|
]
|
|
8877
8878
|
},
|
|
8878
8879
|
"put": {
|
|
8879
|
-
"operationId": "
|
|
8880
|
+
"operationId": "SubscribersV1Controller_updateSubscriber",
|
|
8880
8881
|
"summary": "Update subscriber",
|
|
8881
8882
|
"description": "Used to update the subscriber entity with new information",
|
|
8882
8883
|
"parameters": [
|
|
@@ -9362,14 +9363,16 @@
|
|
|
9362
9363
|
],
|
|
9363
9364
|
"security": [
|
|
9364
9365
|
{
|
|
9365
|
-
"
|
|
9366
|
+
"secretKey": []
|
|
9366
9367
|
}
|
|
9367
9368
|
]
|
|
9368
9369
|
},
|
|
9369
9370
|
"delete": {
|
|
9370
|
-
"operationId": "
|
|
9371
|
+
"operationId": "SubscribersV1Controller_removeSubscriber",
|
|
9372
|
+
"x-speakeasy-name-override": "deleteLegacy",
|
|
9371
9373
|
"summary": "Delete subscriber",
|
|
9372
9374
|
"description": "Deletes a subscriber entity from the Novu platform",
|
|
9375
|
+
"deprecated": true,
|
|
9373
9376
|
"parameters": [
|
|
9374
9377
|
{
|
|
9375
9378
|
"name": "subscriberId",
|
|
@@ -9843,14 +9846,14 @@
|
|
|
9843
9846
|
],
|
|
9844
9847
|
"security": [
|
|
9845
9848
|
{
|
|
9846
|
-
"
|
|
9849
|
+
"secretKey": []
|
|
9847
9850
|
}
|
|
9848
9851
|
]
|
|
9849
9852
|
}
|
|
9850
9853
|
},
|
|
9851
9854
|
"/v1/subscribers/bulk": {
|
|
9852
9855
|
"post": {
|
|
9853
|
-
"operationId": "
|
|
9856
|
+
"operationId": "SubscribersV1Controller_bulkCreateSubscribers",
|
|
9854
9857
|
"x-speakeasy-name-override": "createBulk",
|
|
9855
9858
|
"summary": "Bulk create subscribers",
|
|
9856
9859
|
"description": "\n Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.\n The bulk API is limited to 500 subscribers per request.\n ",
|
|
@@ -10329,14 +10332,14 @@
|
|
|
10329
10332
|
],
|
|
10330
10333
|
"security": [
|
|
10331
10334
|
{
|
|
10332
|
-
"
|
|
10335
|
+
"secretKey": []
|
|
10333
10336
|
}
|
|
10334
10337
|
]
|
|
10335
10338
|
}
|
|
10336
10339
|
},
|
|
10337
10340
|
"/v1/subscribers/{subscriberId}/credentials": {
|
|
10338
10341
|
"put": {
|
|
10339
|
-
"operationId": "
|
|
10342
|
+
"operationId": "SubscribersV1Controller_updateSubscriberChannel",
|
|
10340
10343
|
"x-speakeasy-group": "Subscribers.Credentials",
|
|
10341
10344
|
"summary": "Update subscriber credentials",
|
|
10342
10345
|
"description": "Subscriber credentials associated to the delivery methods such as slack and push tokens.",
|
|
@@ -10823,12 +10826,12 @@
|
|
|
10823
10826
|
],
|
|
10824
10827
|
"security": [
|
|
10825
10828
|
{
|
|
10826
|
-
"
|
|
10829
|
+
"secretKey": []
|
|
10827
10830
|
}
|
|
10828
10831
|
]
|
|
10829
10832
|
},
|
|
10830
10833
|
"patch": {
|
|
10831
|
-
"operationId": "
|
|
10834
|
+
"operationId": "SubscribersV1Controller_modifySubscriberChannel",
|
|
10832
10835
|
"x-speakeasy-name-override": "append",
|
|
10833
10836
|
"x-speakeasy-group": "Subscribers.Credentials",
|
|
10834
10837
|
"summary": "Modify subscriber credentials",
|
|
@@ -11316,14 +11319,14 @@
|
|
|
11316
11319
|
],
|
|
11317
11320
|
"security": [
|
|
11318
11321
|
{
|
|
11319
|
-
"
|
|
11322
|
+
"secretKey": []
|
|
11320
11323
|
}
|
|
11321
11324
|
]
|
|
11322
11325
|
}
|
|
11323
11326
|
},
|
|
11324
11327
|
"/v1/subscribers/{subscriberId}/credentials/{providerId}": {
|
|
11325
11328
|
"delete": {
|
|
11326
|
-
"operationId": "
|
|
11329
|
+
"operationId": "SubscribersV1Controller_deleteSubscriberCredentials",
|
|
11327
11330
|
"x-speakeasy-group": "Subscribers.Credentials",
|
|
11328
11331
|
"summary": "Delete subscriber credentials by providerId",
|
|
11329
11332
|
"description": "Delete subscriber credentials such as slack and expo tokens.",
|
|
@@ -11801,14 +11804,14 @@
|
|
|
11801
11804
|
],
|
|
11802
11805
|
"security": [
|
|
11803
11806
|
{
|
|
11804
|
-
"
|
|
11807
|
+
"secretKey": []
|
|
11805
11808
|
}
|
|
11806
11809
|
]
|
|
11807
11810
|
}
|
|
11808
11811
|
},
|
|
11809
11812
|
"/v1/subscribers/{subscriberId}/online-status": {
|
|
11810
11813
|
"patch": {
|
|
11811
|
-
"operationId": "
|
|
11814
|
+
"operationId": "SubscribersV1Controller_updateSubscriberOnlineFlag",
|
|
11812
11815
|
"x-speakeasy-name-override": "updateOnlineFlag",
|
|
11813
11816
|
"x-speakeasy-group": "Subscribers.properties",
|
|
11814
11817
|
"summary": "Update subscriber online status",
|
|
@@ -12296,14 +12299,14 @@
|
|
|
12296
12299
|
],
|
|
12297
12300
|
"security": [
|
|
12298
12301
|
{
|
|
12299
|
-
"
|
|
12302
|
+
"secretKey": []
|
|
12300
12303
|
}
|
|
12301
12304
|
]
|
|
12302
12305
|
}
|
|
12303
12306
|
},
|
|
12304
12307
|
"/v1/subscribers/{subscriberId}/preferences": {
|
|
12305
12308
|
"get": {
|
|
12306
|
-
"operationId": "
|
|
12309
|
+
"operationId": "SubscribersV1Controller_listSubscriberPreferences",
|
|
12307
12310
|
"x-speakeasy-name-override": "list",
|
|
12308
12311
|
"x-speakeasy-group": "Subscribers.Preferences",
|
|
12309
12312
|
"summary": "Get subscriber preferences",
|
|
@@ -12792,12 +12795,12 @@
|
|
|
12792
12795
|
],
|
|
12793
12796
|
"security": [
|
|
12794
12797
|
{
|
|
12795
|
-
"
|
|
12798
|
+
"secretKey": []
|
|
12796
12799
|
}
|
|
12797
12800
|
]
|
|
12798
12801
|
},
|
|
12799
12802
|
"patch": {
|
|
12800
|
-
"operationId": "
|
|
12803
|
+
"operationId": "SubscribersV1Controller_updateSubscriberGlobalPreferences",
|
|
12801
12804
|
"x-speakeasy-name-override": "updateGlobal",
|
|
12802
12805
|
"x-speakeasy-group": "Subscribers.Preferences",
|
|
12803
12806
|
"summary": "Update subscriber global preferences",
|
|
@@ -13284,14 +13287,14 @@
|
|
|
13284
13287
|
],
|
|
13285
13288
|
"security": [
|
|
13286
13289
|
{
|
|
13287
|
-
"
|
|
13290
|
+
"secretKey": []
|
|
13288
13291
|
}
|
|
13289
13292
|
]
|
|
13290
13293
|
}
|
|
13291
13294
|
},
|
|
13292
13295
|
"/v1/subscribers/{subscriberId}/preferences/{parameter}": {
|
|
13293
13296
|
"get": {
|
|
13294
|
-
"operationId": "
|
|
13297
|
+
"operationId": "SubscribersV1Controller_getSubscriberPreferenceByLevel",
|
|
13295
13298
|
"x-speakeasy-name-override": "retrieveByLevel",
|
|
13296
13299
|
"x-speakeasy-group": "Subscribers.Preferences",
|
|
13297
13300
|
"summary": "Get subscriber preferences by level",
|
|
@@ -13794,12 +13797,13 @@
|
|
|
13794
13797
|
],
|
|
13795
13798
|
"security": [
|
|
13796
13799
|
{
|
|
13797
|
-
"
|
|
13800
|
+
"secretKey": []
|
|
13798
13801
|
}
|
|
13799
13802
|
]
|
|
13800
13803
|
},
|
|
13801
13804
|
"patch": {
|
|
13802
|
-
"operationId": "
|
|
13805
|
+
"operationId": "SubscribersV1Controller_updateSubscriberPreference",
|
|
13806
|
+
"x-speakeasy-name-override": "updateLegacy",
|
|
13803
13807
|
"x-speakeasy-group": "Subscribers.Preferences",
|
|
13804
13808
|
"summary": "Update subscriber preference",
|
|
13805
13809
|
"parameters": [
|
|
@@ -14294,14 +14298,14 @@
|
|
|
14294
14298
|
],
|
|
14295
14299
|
"security": [
|
|
14296
14300
|
{
|
|
14297
|
-
"
|
|
14301
|
+
"secretKey": []
|
|
14298
14302
|
}
|
|
14299
14303
|
]
|
|
14300
14304
|
}
|
|
14301
14305
|
},
|
|
14302
14306
|
"/v1/subscribers/{subscriberId}/notifications/feed": {
|
|
14303
14307
|
"get": {
|
|
14304
|
-
"operationId": "
|
|
14308
|
+
"operationId": "SubscribersV1Controller_getNotificationsFeed",
|
|
14305
14309
|
"x-speakeasy-name-override": "feed",
|
|
14306
14310
|
"x-speakeasy-group": "Subscribers.Notifications",
|
|
14307
14311
|
"summary": "Get in-app notification feed for a particular subscriber",
|
|
@@ -14822,14 +14826,14 @@
|
|
|
14822
14826
|
],
|
|
14823
14827
|
"security": [
|
|
14824
14828
|
{
|
|
14825
|
-
"
|
|
14829
|
+
"secretKey": []
|
|
14826
14830
|
}
|
|
14827
14831
|
]
|
|
14828
14832
|
}
|
|
14829
14833
|
},
|
|
14830
14834
|
"/v1/subscribers/{subscriberId}/notifications/unseen": {
|
|
14831
14835
|
"get": {
|
|
14832
|
-
"operationId": "
|
|
14836
|
+
"operationId": "SubscribersV1Controller_getUnseenCount",
|
|
14833
14837
|
"x-speakeasy-name-override": "unseenCount",
|
|
14834
14838
|
"x-speakeasy-group": "Subscribers.Notifications",
|
|
14835
14839
|
"summary": "Get the unseen in-app notifications count for subscribers feed",
|
|
@@ -15326,14 +15330,14 @@
|
|
|
15326
15330
|
],
|
|
15327
15331
|
"security": [
|
|
15328
15332
|
{
|
|
15329
|
-
"
|
|
15333
|
+
"secretKey": []
|
|
15330
15334
|
}
|
|
15331
15335
|
]
|
|
15332
15336
|
}
|
|
15333
15337
|
},
|
|
15334
15338
|
"/v1/subscribers/{subscriberId}/messages/mark-as": {
|
|
15335
15339
|
"post": {
|
|
15336
|
-
"operationId": "
|
|
15340
|
+
"operationId": "SubscribersV1Controller_markMessagesAs",
|
|
15337
15341
|
"x-speakeasy-name-override": "markAllAs",
|
|
15338
15342
|
"x-speakeasy-group": "Subscribers.Messages",
|
|
15339
15343
|
"summary": "Mark a subscriber messages as seen, read, unseen or unread",
|
|
@@ -15823,14 +15827,14 @@
|
|
|
15823
15827
|
],
|
|
15824
15828
|
"security": [
|
|
15825
15829
|
{
|
|
15826
|
-
"
|
|
15830
|
+
"secretKey": []
|
|
15827
15831
|
}
|
|
15828
15832
|
]
|
|
15829
15833
|
}
|
|
15830
15834
|
},
|
|
15831
15835
|
"/v1/subscribers/{subscriberId}/messages/mark-all": {
|
|
15832
15836
|
"post": {
|
|
15833
|
-
"operationId": "
|
|
15837
|
+
"operationId": "SubscribersV1Controller_markAllUnreadAsRead",
|
|
15834
15838
|
"x-speakeasy-name-override": "markAll",
|
|
15835
15839
|
"x-speakeasy-group": "Subscribers.Messages",
|
|
15836
15840
|
"summary": "Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.",
|
|
@@ -16317,14 +16321,14 @@
|
|
|
16317
16321
|
],
|
|
16318
16322
|
"security": [
|
|
16319
16323
|
{
|
|
16320
|
-
"
|
|
16324
|
+
"secretKey": []
|
|
16321
16325
|
}
|
|
16322
16326
|
]
|
|
16323
16327
|
}
|
|
16324
16328
|
},
|
|
16325
16329
|
"/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}": {
|
|
16326
16330
|
"post": {
|
|
16327
|
-
"operationId": "
|
|
16331
|
+
"operationId": "SubscribersV1Controller_markActionAsSeen",
|
|
16328
16332
|
"x-speakeasy-name-override": "updateAsSeen",
|
|
16329
16333
|
"x-speakeasy-group": "Subscribers.Messages",
|
|
16330
16334
|
"summary": "Mark message action as seen",
|
|
@@ -16825,14 +16829,14 @@
|
|
|
16825
16829
|
],
|
|
16826
16830
|
"security": [
|
|
16827
16831
|
{
|
|
16828
|
-
"
|
|
16832
|
+
"secretKey": []
|
|
16829
16833
|
}
|
|
16830
16834
|
]
|
|
16831
16835
|
}
|
|
16832
16836
|
},
|
|
16833
16837
|
"/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback": {
|
|
16834
16838
|
"get": {
|
|
16835
|
-
"operationId": "
|
|
16839
|
+
"operationId": "SubscribersV1Controller_chatOauthCallback",
|
|
16836
16840
|
"x-speakeasy-name-override": "chatAccessOauthCallBack",
|
|
16837
16841
|
"x-speakeasy-group": "Subscribers.Authentication",
|
|
16838
16842
|
"summary": "Handle providers oauth redirect",
|
|
@@ -17391,14 +17395,14 @@
|
|
|
17391
17395
|
],
|
|
17392
17396
|
"security": [
|
|
17393
17397
|
{
|
|
17394
|
-
"
|
|
17398
|
+
"secretKey": []
|
|
17395
17399
|
}
|
|
17396
17400
|
]
|
|
17397
17401
|
}
|
|
17398
17402
|
},
|
|
17399
17403
|
"/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth": {
|
|
17400
17404
|
"get": {
|
|
17401
|
-
"operationId": "
|
|
17405
|
+
"operationId": "SubscribersV1Controller_chatAccessOauth",
|
|
17402
17406
|
"x-speakeasy-name-override": "chatAccessOauth",
|
|
17403
17407
|
"x-speakeasy-group": "Subscribers.Authentication",
|
|
17404
17408
|
"summary": "Handle chat oauth",
|
|
@@ -17878,51 +17882,69 @@
|
|
|
17878
17882
|
],
|
|
17879
17883
|
"security": [
|
|
17880
17884
|
{
|
|
17881
|
-
"
|
|
17885
|
+
"secretKey": []
|
|
17882
17886
|
}
|
|
17883
17887
|
]
|
|
17884
17888
|
}
|
|
17885
17889
|
},
|
|
17886
|
-
"/
|
|
17890
|
+
"/v2/subscribers": {
|
|
17887
17891
|
"get": {
|
|
17888
|
-
"operationId": "
|
|
17889
|
-
"
|
|
17890
|
-
"
|
|
17892
|
+
"operationId": "SubscribersController_searchSubscribers",
|
|
17893
|
+
"x-speakeasy-name-override": "search",
|
|
17894
|
+
"summary": "Search for subscribers",
|
|
17891
17895
|
"parameters": [
|
|
17892
17896
|
{
|
|
17893
|
-
"name": "
|
|
17897
|
+
"name": "after",
|
|
17894
17898
|
"required": false,
|
|
17895
17899
|
"in": "query",
|
|
17900
|
+
"description": "Cursor for pagination indicating the starting point after which to fetch results.",
|
|
17896
17901
|
"schema": {
|
|
17897
|
-
"
|
|
17902
|
+
"type": "string"
|
|
17898
17903
|
}
|
|
17899
17904
|
},
|
|
17900
17905
|
{
|
|
17901
|
-
"name": "
|
|
17906
|
+
"name": "before",
|
|
17902
17907
|
"required": false,
|
|
17903
17908
|
"in": "query",
|
|
17909
|
+
"description": "Cursor for pagination indicating the ending point before which to fetch results.",
|
|
17904
17910
|
"schema": {
|
|
17905
17911
|
"type": "string"
|
|
17906
17912
|
}
|
|
17907
17913
|
},
|
|
17908
17914
|
{
|
|
17909
|
-
"name": "
|
|
17915
|
+
"name": "email",
|
|
17910
17916
|
"required": false,
|
|
17911
17917
|
"in": "query",
|
|
17918
|
+
"description": "Email address of the subscriber to filter results.",
|
|
17912
17919
|
"schema": {
|
|
17913
|
-
"type": "
|
|
17914
|
-
"items": {
|
|
17915
|
-
"type": "string"
|
|
17916
|
-
}
|
|
17920
|
+
"type": "string"
|
|
17917
17921
|
}
|
|
17918
17922
|
},
|
|
17919
17923
|
{
|
|
17920
|
-
"name": "
|
|
17924
|
+
"name": "name",
|
|
17921
17925
|
"required": false,
|
|
17922
17926
|
"in": "query",
|
|
17927
|
+
"description": "Name of the subscriber to filter results.",
|
|
17923
17928
|
"schema": {
|
|
17924
|
-
"
|
|
17925
|
-
|
|
17929
|
+
"type": "string"
|
|
17930
|
+
}
|
|
17931
|
+
},
|
|
17932
|
+
{
|
|
17933
|
+
"name": "phone",
|
|
17934
|
+
"required": false,
|
|
17935
|
+
"in": "query",
|
|
17936
|
+
"description": "Phone number of the subscriber to filter results.",
|
|
17937
|
+
"schema": {
|
|
17938
|
+
"type": "string"
|
|
17939
|
+
}
|
|
17940
|
+
},
|
|
17941
|
+
{
|
|
17942
|
+
"name": "subscriberId",
|
|
17943
|
+
"required": false,
|
|
17944
|
+
"in": "query",
|
|
17945
|
+
"description": "Unique identifier of the subscriber to filter results.",
|
|
17946
|
+
"schema": {
|
|
17947
|
+
"type": "string"
|
|
17926
17948
|
}
|
|
17927
17949
|
},
|
|
17928
17950
|
{
|
|
@@ -17930,10 +17952,27 @@
|
|
|
17930
17952
|
"required": false,
|
|
17931
17953
|
"in": "query",
|
|
17932
17954
|
"schema": {
|
|
17933
|
-
"default": 10,
|
|
17934
17955
|
"type": "number"
|
|
17935
17956
|
}
|
|
17936
17957
|
},
|
|
17958
|
+
{
|
|
17959
|
+
"name": "orderDirection",
|
|
17960
|
+
"required": false,
|
|
17961
|
+
"in": "query",
|
|
17962
|
+
"schema": {
|
|
17963
|
+
"enum": [
|
|
17964
|
+
"ASC",
|
|
17965
|
+
"DESC"
|
|
17966
|
+
],
|
|
17967
|
+
"type": "string"
|
|
17968
|
+
}
|
|
17969
|
+
},
|
|
17970
|
+
{
|
|
17971
|
+
"name": "orderBy",
|
|
17972
|
+
"required": false,
|
|
17973
|
+
"in": "query",
|
|
17974
|
+
"schema": {}
|
|
17975
|
+
},
|
|
17937
17976
|
{
|
|
17938
17977
|
"name": "idempotency-key",
|
|
17939
17978
|
"in": "header",
|
|
@@ -17946,6 +17985,7 @@
|
|
|
17946
17985
|
],
|
|
17947
17986
|
"responses": {
|
|
17948
17987
|
"200": {
|
|
17988
|
+
"description": "OK",
|
|
17949
17989
|
"headers": {
|
|
17950
17990
|
"Content-Type": {
|
|
17951
17991
|
"$ref": "#/components/headers/Content-Type"
|
|
@@ -17969,11 +18009,10 @@
|
|
|
17969
18009
|
"$ref": "#/components/headers/Idempotency-Replay"
|
|
17970
18010
|
}
|
|
17971
18011
|
},
|
|
17972
|
-
"description": "",
|
|
17973
18012
|
"content": {
|
|
17974
18013
|
"application/json": {
|
|
17975
18014
|
"schema": {
|
|
17976
|
-
"$ref": "#/components/schemas/
|
|
18015
|
+
"$ref": "#/components/schemas/ListSubscribersResponseDto"
|
|
17977
18016
|
}
|
|
17978
18017
|
}
|
|
17979
18018
|
}
|
|
@@ -18394,23 +18433,24 @@
|
|
|
18394
18433
|
}
|
|
18395
18434
|
},
|
|
18396
18435
|
"tags": [
|
|
18397
|
-
"
|
|
18436
|
+
"Subscribers"
|
|
18398
18437
|
],
|
|
18399
18438
|
"security": [
|
|
18400
18439
|
{
|
|
18401
|
-
"
|
|
18440
|
+
"secretKey": []
|
|
18402
18441
|
}
|
|
18403
18442
|
]
|
|
18404
18443
|
}
|
|
18405
18444
|
},
|
|
18406
|
-
"/
|
|
18407
|
-
"
|
|
18408
|
-
"operationId": "
|
|
18409
|
-
"
|
|
18410
|
-
"
|
|
18445
|
+
"/v2/subscribers/{subscriberId}": {
|
|
18446
|
+
"get": {
|
|
18447
|
+
"operationId": "SubscribersController_getSubscriber",
|
|
18448
|
+
"x-speakeasy-name-override": "retrieve",
|
|
18449
|
+
"summary": "Get subscriber",
|
|
18450
|
+
"description": "Get subscriber by your internal id used to identify the subscriber",
|
|
18411
18451
|
"parameters": [
|
|
18412
18452
|
{
|
|
18413
|
-
"name": "
|
|
18453
|
+
"name": "subscriberId",
|
|
18414
18454
|
"required": true,
|
|
18415
18455
|
"in": "path",
|
|
18416
18456
|
"schema": {
|
|
@@ -18456,7 +18496,7 @@
|
|
|
18456
18496
|
"content": {
|
|
18457
18497
|
"application/json": {
|
|
18458
18498
|
"schema": {
|
|
18459
|
-
"$ref": "#/components/schemas/
|
|
18499
|
+
"$ref": "#/components/schemas/SubscriberResponseDto"
|
|
18460
18500
|
}
|
|
18461
18501
|
}
|
|
18462
18502
|
}
|
|
@@ -18877,40 +18917,22 @@
|
|
|
18877
18917
|
}
|
|
18878
18918
|
},
|
|
18879
18919
|
"tags": [
|
|
18880
|
-
"
|
|
18920
|
+
"Subscribers"
|
|
18881
18921
|
],
|
|
18882
18922
|
"security": [
|
|
18883
18923
|
{
|
|
18884
|
-
"
|
|
18924
|
+
"secretKey": []
|
|
18885
18925
|
}
|
|
18886
18926
|
]
|
|
18887
|
-
}
|
|
18888
|
-
|
|
18889
|
-
|
|
18890
|
-
|
|
18891
|
-
"
|
|
18892
|
-
"
|
|
18893
|
-
"summary": "Delete messages by transactionId",
|
|
18894
|
-
"description": "Deletes messages entity from the Novu platform using TransactionId of message",
|
|
18927
|
+
},
|
|
18928
|
+
"patch": {
|
|
18929
|
+
"operationId": "SubscribersController_patchSubscriber",
|
|
18930
|
+
"x-speakeasy-name-override": "patch",
|
|
18931
|
+
"summary": "Patch subscriber",
|
|
18932
|
+
"description": "Patch subscriber by your internal id used to identify the subscriber",
|
|
18895
18933
|
"parameters": [
|
|
18896
18934
|
{
|
|
18897
|
-
"name": "
|
|
18898
|
-
"required": false,
|
|
18899
|
-
"in": "query",
|
|
18900
|
-
"description": "The channel of the message to be deleted",
|
|
18901
|
-
"schema": {
|
|
18902
|
-
"enum": [
|
|
18903
|
-
"in_app",
|
|
18904
|
-
"email",
|
|
18905
|
-
"sms",
|
|
18906
|
-
"chat",
|
|
18907
|
-
"push"
|
|
18908
|
-
],
|
|
18909
|
-
"type": "string"
|
|
18910
|
-
}
|
|
18911
|
-
},
|
|
18912
|
-
{
|
|
18913
|
-
"name": "transactionId",
|
|
18935
|
+
"name": "subscriberId",
|
|
18914
18936
|
"required": true,
|
|
18915
18937
|
"in": "path",
|
|
18916
18938
|
"schema": {
|
|
@@ -18927,8 +18949,19 @@
|
|
|
18927
18949
|
}
|
|
18928
18950
|
}
|
|
18929
18951
|
],
|
|
18952
|
+
"requestBody": {
|
|
18953
|
+
"required": true,
|
|
18954
|
+
"content": {
|
|
18955
|
+
"application/json": {
|
|
18956
|
+
"schema": {
|
|
18957
|
+
"$ref": "#/components/schemas/PatchSubscriberRequestDto"
|
|
18958
|
+
}
|
|
18959
|
+
}
|
|
18960
|
+
}
|
|
18961
|
+
},
|
|
18930
18962
|
"responses": {
|
|
18931
|
-
"
|
|
18963
|
+
"200": {
|
|
18964
|
+
"description": "OK",
|
|
18932
18965
|
"headers": {
|
|
18933
18966
|
"Content-Type": {
|
|
18934
18967
|
"$ref": "#/components/headers/Content-Type"
|
|
@@ -18952,7 +18985,13 @@
|
|
|
18952
18985
|
"$ref": "#/components/headers/Idempotency-Replay"
|
|
18953
18986
|
}
|
|
18954
18987
|
},
|
|
18955
|
-
"
|
|
18988
|
+
"content": {
|
|
18989
|
+
"application/json": {
|
|
18990
|
+
"schema": {
|
|
18991
|
+
"$ref": "#/components/schemas/SubscriberResponseDto"
|
|
18992
|
+
}
|
|
18993
|
+
}
|
|
18994
|
+
}
|
|
18956
18995
|
},
|
|
18957
18996
|
"400": {
|
|
18958
18997
|
"description": "Bad Request",
|
|
@@ -19370,21 +19409,28 @@
|
|
|
19370
19409
|
}
|
|
19371
19410
|
},
|
|
19372
19411
|
"tags": [
|
|
19373
|
-
"
|
|
19412
|
+
"Subscribers"
|
|
19374
19413
|
],
|
|
19375
19414
|
"security": [
|
|
19376
19415
|
{
|
|
19377
|
-
"
|
|
19416
|
+
"secretKey": []
|
|
19378
19417
|
}
|
|
19379
19418
|
]
|
|
19380
|
-
}
|
|
19381
|
-
|
|
19382
|
-
|
|
19383
|
-
|
|
19384
|
-
"
|
|
19385
|
-
"
|
|
19386
|
-
"description": "Create a topic",
|
|
19419
|
+
},
|
|
19420
|
+
"delete": {
|
|
19421
|
+
"operationId": "SubscribersController_removeSubscriber",
|
|
19422
|
+
"x-speakeasy-name-override": "delete",
|
|
19423
|
+
"summary": "Delete subscriber",
|
|
19424
|
+
"description": "Deletes a subscriber entity from the Novu platform",
|
|
19387
19425
|
"parameters": [
|
|
19426
|
+
{
|
|
19427
|
+
"name": "subscriberId",
|
|
19428
|
+
"required": true,
|
|
19429
|
+
"in": "path",
|
|
19430
|
+
"schema": {
|
|
19431
|
+
"type": "string"
|
|
19432
|
+
}
|
|
19433
|
+
},
|
|
19388
19434
|
{
|
|
19389
19435
|
"name": "idempotency-key",
|
|
19390
19436
|
"in": "header",
|
|
@@ -19395,19 +19441,9 @@
|
|
|
19395
19441
|
}
|
|
19396
19442
|
}
|
|
19397
19443
|
],
|
|
19398
|
-
"requestBody": {
|
|
19399
|
-
"required": true,
|
|
19400
|
-
"content": {
|
|
19401
|
-
"application/json": {
|
|
19402
|
-
"schema": {
|
|
19403
|
-
"$ref": "#/components/schemas/CreateTopicRequestDto"
|
|
19404
|
-
}
|
|
19405
|
-
}
|
|
19406
|
-
}
|
|
19407
|
-
},
|
|
19408
19444
|
"responses": {
|
|
19409
|
-
"
|
|
19410
|
-
"description": "
|
|
19445
|
+
"200": {
|
|
19446
|
+
"description": "OK",
|
|
19411
19447
|
"headers": {
|
|
19412
19448
|
"Content-Type": {
|
|
19413
19449
|
"$ref": "#/components/headers/Content-Type"
|
|
@@ -19434,7 +19470,7 @@
|
|
|
19434
19470
|
"content": {
|
|
19435
19471
|
"application/json": {
|
|
19436
19472
|
"schema": {
|
|
19437
|
-
"$ref": "#/components/schemas/
|
|
19473
|
+
"$ref": "#/components/schemas/RemoveSubscriberResponseDto"
|
|
19438
19474
|
}
|
|
19439
19475
|
}
|
|
19440
19476
|
}
|
|
@@ -19855,49 +19891,27 @@
|
|
|
19855
19891
|
}
|
|
19856
19892
|
},
|
|
19857
19893
|
"tags": [
|
|
19858
|
-
"
|
|
19894
|
+
"Subscribers"
|
|
19859
19895
|
],
|
|
19860
19896
|
"security": [
|
|
19861
19897
|
{
|
|
19862
|
-
"
|
|
19898
|
+
"secretKey": []
|
|
19863
19899
|
}
|
|
19864
19900
|
]
|
|
19865
|
-
}
|
|
19901
|
+
}
|
|
19902
|
+
},
|
|
19903
|
+
"/v2/subscribers/{subscriberId}/preferences": {
|
|
19866
19904
|
"get": {
|
|
19867
|
-
"operationId": "
|
|
19868
|
-
"
|
|
19869
|
-
"
|
|
19905
|
+
"operationId": "SubscribersController_getSubscriberPreferences",
|
|
19906
|
+
"x-speakeasy-name-override": "retrieve",
|
|
19907
|
+
"x-speakeasy-group": "Subscribers.Preferences",
|
|
19908
|
+
"summary": "Get subscriber preferences",
|
|
19909
|
+
"description": "Get subscriber global and workflow specific preferences",
|
|
19870
19910
|
"parameters": [
|
|
19871
19911
|
{
|
|
19872
|
-
"name": "
|
|
19873
|
-
"required":
|
|
19874
|
-
"in": "
|
|
19875
|
-
"example": 0,
|
|
19876
|
-
"description": "The page number to retrieve (starts from 0)",
|
|
19877
|
-
"schema": {
|
|
19878
|
-
"format": "int64",
|
|
19879
|
-
"default": 0,
|
|
19880
|
-
"type": "integer"
|
|
19881
|
-
}
|
|
19882
|
-
},
|
|
19883
|
-
{
|
|
19884
|
-
"name": "pageSize",
|
|
19885
|
-
"required": false,
|
|
19886
|
-
"in": "query",
|
|
19887
|
-
"example": 10,
|
|
19888
|
-
"description": "The number of items to return per page (default: 10)",
|
|
19889
|
-
"schema": {
|
|
19890
|
-
"format": "int64",
|
|
19891
|
-
"default": 10,
|
|
19892
|
-
"type": "integer"
|
|
19893
|
-
}
|
|
19894
|
-
},
|
|
19895
|
-
{
|
|
19896
|
-
"name": "key",
|
|
19897
|
-
"required": false,
|
|
19898
|
-
"in": "query",
|
|
19899
|
-
"example": "exampleKey",
|
|
19900
|
-
"description": "A filter key to apply to the results",
|
|
19912
|
+
"name": "subscriberId",
|
|
19913
|
+
"required": true,
|
|
19914
|
+
"in": "path",
|
|
19901
19915
|
"schema": {
|
|
19902
19916
|
"type": "string"
|
|
19903
19917
|
}
|
|
@@ -19914,6 +19928,7 @@
|
|
|
19914
19928
|
],
|
|
19915
19929
|
"responses": {
|
|
19916
19930
|
"200": {
|
|
19931
|
+
"description": "OK",
|
|
19917
19932
|
"headers": {
|
|
19918
19933
|
"Content-Type": {
|
|
19919
19934
|
"$ref": "#/components/headers/Content-Type"
|
|
@@ -19937,11 +19952,10 @@
|
|
|
19937
19952
|
"$ref": "#/components/headers/Idempotency-Replay"
|
|
19938
19953
|
}
|
|
19939
19954
|
},
|
|
19940
|
-
"description": "",
|
|
19941
19955
|
"content": {
|
|
19942
19956
|
"application/json": {
|
|
19943
19957
|
"schema": {
|
|
19944
|
-
"$ref": "#/components/schemas/
|
|
19958
|
+
"$ref": "#/components/schemas/GetSubscriberPreferencesDto"
|
|
19945
19959
|
}
|
|
19946
19960
|
}
|
|
19947
19961
|
}
|
|
@@ -20362,28 +20376,25 @@
|
|
|
20362
20376
|
}
|
|
20363
20377
|
},
|
|
20364
20378
|
"tags": [
|
|
20365
|
-
"
|
|
20379
|
+
"Subscribers"
|
|
20366
20380
|
],
|
|
20367
20381
|
"security": [
|
|
20368
20382
|
{
|
|
20369
|
-
"
|
|
20383
|
+
"secretKey": []
|
|
20370
20384
|
}
|
|
20371
20385
|
]
|
|
20372
|
-
}
|
|
20373
|
-
|
|
20374
|
-
|
|
20375
|
-
|
|
20376
|
-
"
|
|
20377
|
-
"
|
|
20378
|
-
"
|
|
20379
|
-
"summary": "Subscribers addition",
|
|
20380
|
-
"description": "Add subscribers to a topic by key",
|
|
20386
|
+
},
|
|
20387
|
+
"patch": {
|
|
20388
|
+
"operationId": "SubscribersController_updateSubscriberPreferences",
|
|
20389
|
+
"x-speakeasy-name-override": "update",
|
|
20390
|
+
"x-speakeasy-group": "Subscribers.Preferences",
|
|
20391
|
+
"summary": "Update subscriber global or workflow specific preferences",
|
|
20392
|
+
"description": "Update subscriber global or workflow specific preferences",
|
|
20381
20393
|
"parameters": [
|
|
20382
20394
|
{
|
|
20383
|
-
"name": "
|
|
20395
|
+
"name": "subscriberId",
|
|
20384
20396
|
"required": true,
|
|
20385
20397
|
"in": "path",
|
|
20386
|
-
"description": "The topic key",
|
|
20387
20398
|
"schema": {
|
|
20388
20399
|
"type": "string"
|
|
20389
20400
|
}
|
|
@@ -20403,13 +20414,14 @@
|
|
|
20403
20414
|
"content": {
|
|
20404
20415
|
"application/json": {
|
|
20405
20416
|
"schema": {
|
|
20406
|
-
"$ref": "#/components/schemas/
|
|
20417
|
+
"$ref": "#/components/schemas/PatchSubscriberPreferencesDto"
|
|
20407
20418
|
}
|
|
20408
20419
|
}
|
|
20409
20420
|
}
|
|
20410
20421
|
},
|
|
20411
20422
|
"responses": {
|
|
20412
20423
|
"200": {
|
|
20424
|
+
"description": "OK",
|
|
20413
20425
|
"headers": {
|
|
20414
20426
|
"Content-Type": {
|
|
20415
20427
|
"$ref": "#/components/headers/Content-Type"
|
|
@@ -20433,11 +20445,10 @@
|
|
|
20433
20445
|
"$ref": "#/components/headers/Idempotency-Replay"
|
|
20434
20446
|
}
|
|
20435
20447
|
},
|
|
20436
|
-
"description": "",
|
|
20437
20448
|
"content": {
|
|
20438
20449
|
"application/json": {
|
|
20439
20450
|
"schema": {
|
|
20440
|
-
"$ref": "#/components/schemas/
|
|
20451
|
+
"$ref": "#/components/schemas/GetSubscriberPreferencesDto"
|
|
20441
20452
|
}
|
|
20442
20453
|
}
|
|
20443
20454
|
}
|
|
@@ -20858,47 +20869,3031 @@
|
|
|
20858
20869
|
}
|
|
20859
20870
|
},
|
|
20860
20871
|
"tags": [
|
|
20861
|
-
"
|
|
20872
|
+
"Subscribers"
|
|
20862
20873
|
],
|
|
20863
20874
|
"security": [
|
|
20864
20875
|
{
|
|
20865
|
-
"
|
|
20876
|
+
"secretKey": []
|
|
20866
20877
|
}
|
|
20867
20878
|
]
|
|
20868
20879
|
}
|
|
20869
20880
|
},
|
|
20870
|
-
"/v1/
|
|
20881
|
+
"/v1/messages": {
|
|
20871
20882
|
"get": {
|
|
20872
|
-
"operationId": "
|
|
20873
|
-
"
|
|
20874
|
-
"
|
|
20875
|
-
"description": "Check if a subscriber belongs to a certain topic",
|
|
20883
|
+
"operationId": "MessagesController_getMessages",
|
|
20884
|
+
"summary": "Get messages",
|
|
20885
|
+
"description": "Returns a list of messages, could paginate using the `page` query parameter",
|
|
20876
20886
|
"parameters": [
|
|
20877
20887
|
{
|
|
20878
|
-
"name": "
|
|
20879
|
-
"required":
|
|
20880
|
-
"in": "
|
|
20881
|
-
"description": "The external subscriber id",
|
|
20888
|
+
"name": "channel",
|
|
20889
|
+
"required": false,
|
|
20890
|
+
"in": "query",
|
|
20882
20891
|
"schema": {
|
|
20883
|
-
"
|
|
20892
|
+
"$ref": "#/components/schemas/ChannelTypeEnum"
|
|
20884
20893
|
}
|
|
20885
20894
|
},
|
|
20886
20895
|
{
|
|
20887
|
-
"name": "
|
|
20888
|
-
"required":
|
|
20889
|
-
"in": "
|
|
20890
|
-
"description": "The topic key",
|
|
20896
|
+
"name": "subscriberId",
|
|
20897
|
+
"required": false,
|
|
20898
|
+
"in": "query",
|
|
20891
20899
|
"schema": {
|
|
20892
20900
|
"type": "string"
|
|
20893
20901
|
}
|
|
20894
20902
|
},
|
|
20895
20903
|
{
|
|
20896
|
-
"name": "
|
|
20897
|
-
"in": "header",
|
|
20898
|
-
"description": "A header for idempotency purposes",
|
|
20904
|
+
"name": "transactionId",
|
|
20899
20905
|
"required": false,
|
|
20906
|
+
"in": "query",
|
|
20900
20907
|
"schema": {
|
|
20901
|
-
"type": "
|
|
20908
|
+
"type": "array",
|
|
20909
|
+
"items": {
|
|
20910
|
+
"type": "string"
|
|
20911
|
+
}
|
|
20912
|
+
}
|
|
20913
|
+
},
|
|
20914
|
+
{
|
|
20915
|
+
"name": "page",
|
|
20916
|
+
"required": false,
|
|
20917
|
+
"in": "query",
|
|
20918
|
+
"schema": {
|
|
20919
|
+
"default": 0,
|
|
20920
|
+
"type": "number"
|
|
20921
|
+
}
|
|
20922
|
+
},
|
|
20923
|
+
{
|
|
20924
|
+
"name": "limit",
|
|
20925
|
+
"required": false,
|
|
20926
|
+
"in": "query",
|
|
20927
|
+
"schema": {
|
|
20928
|
+
"default": 10,
|
|
20929
|
+
"type": "number"
|
|
20930
|
+
}
|
|
20931
|
+
},
|
|
20932
|
+
{
|
|
20933
|
+
"name": "idempotency-key",
|
|
20934
|
+
"in": "header",
|
|
20935
|
+
"description": "A header for idempotency purposes",
|
|
20936
|
+
"required": false,
|
|
20937
|
+
"schema": {
|
|
20938
|
+
"type": "string"
|
|
20939
|
+
}
|
|
20940
|
+
}
|
|
20941
|
+
],
|
|
20942
|
+
"responses": {
|
|
20943
|
+
"200": {
|
|
20944
|
+
"headers": {
|
|
20945
|
+
"Content-Type": {
|
|
20946
|
+
"$ref": "#/components/headers/Content-Type"
|
|
20947
|
+
},
|
|
20948
|
+
"RateLimit-Limit": {
|
|
20949
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
20950
|
+
},
|
|
20951
|
+
"RateLimit-Remaining": {
|
|
20952
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
20953
|
+
},
|
|
20954
|
+
"RateLimit-Reset": {
|
|
20955
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
20956
|
+
},
|
|
20957
|
+
"RateLimit-Policy": {
|
|
20958
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
20959
|
+
},
|
|
20960
|
+
"Idempotency-Key": {
|
|
20961
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
20962
|
+
},
|
|
20963
|
+
"Idempotency-Replay": {
|
|
20964
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
20965
|
+
}
|
|
20966
|
+
},
|
|
20967
|
+
"description": "",
|
|
20968
|
+
"content": {
|
|
20969
|
+
"application/json": {
|
|
20970
|
+
"schema": {
|
|
20971
|
+
"$ref": "#/components/schemas/ActivitiesResponseDto"
|
|
20972
|
+
}
|
|
20973
|
+
}
|
|
20974
|
+
}
|
|
20975
|
+
},
|
|
20976
|
+
"400": {
|
|
20977
|
+
"description": "Bad Request",
|
|
20978
|
+
"headers": {
|
|
20979
|
+
"Content-Type": {
|
|
20980
|
+
"$ref": "#/components/headers/Content-Type"
|
|
20981
|
+
},
|
|
20982
|
+
"RateLimit-Limit": {
|
|
20983
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
20984
|
+
},
|
|
20985
|
+
"RateLimit-Remaining": {
|
|
20986
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
20987
|
+
},
|
|
20988
|
+
"RateLimit-Reset": {
|
|
20989
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
20990
|
+
},
|
|
20991
|
+
"RateLimit-Policy": {
|
|
20992
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
20993
|
+
},
|
|
20994
|
+
"Idempotency-Key": {
|
|
20995
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
20996
|
+
},
|
|
20997
|
+
"Idempotency-Replay": {
|
|
20998
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
20999
|
+
}
|
|
21000
|
+
},
|
|
21001
|
+
"content": {
|
|
21002
|
+
"application/json": {
|
|
21003
|
+
"schema": {
|
|
21004
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21005
|
+
}
|
|
21006
|
+
}
|
|
21007
|
+
}
|
|
21008
|
+
},
|
|
21009
|
+
"401": {
|
|
21010
|
+
"description": "Unauthorized",
|
|
21011
|
+
"headers": {
|
|
21012
|
+
"Content-Type": {
|
|
21013
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21014
|
+
},
|
|
21015
|
+
"RateLimit-Limit": {
|
|
21016
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21017
|
+
},
|
|
21018
|
+
"RateLimit-Remaining": {
|
|
21019
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21020
|
+
},
|
|
21021
|
+
"RateLimit-Reset": {
|
|
21022
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21023
|
+
},
|
|
21024
|
+
"RateLimit-Policy": {
|
|
21025
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21026
|
+
},
|
|
21027
|
+
"Idempotency-Key": {
|
|
21028
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21029
|
+
},
|
|
21030
|
+
"Idempotency-Replay": {
|
|
21031
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21032
|
+
}
|
|
21033
|
+
},
|
|
21034
|
+
"content": {
|
|
21035
|
+
"application/json": {
|
|
21036
|
+
"schema": {
|
|
21037
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21038
|
+
}
|
|
21039
|
+
}
|
|
21040
|
+
}
|
|
21041
|
+
},
|
|
21042
|
+
"403": {
|
|
21043
|
+
"description": "Forbidden",
|
|
21044
|
+
"headers": {
|
|
21045
|
+
"Content-Type": {
|
|
21046
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21047
|
+
},
|
|
21048
|
+
"RateLimit-Limit": {
|
|
21049
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21050
|
+
},
|
|
21051
|
+
"RateLimit-Remaining": {
|
|
21052
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21053
|
+
},
|
|
21054
|
+
"RateLimit-Reset": {
|
|
21055
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21056
|
+
},
|
|
21057
|
+
"RateLimit-Policy": {
|
|
21058
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21059
|
+
},
|
|
21060
|
+
"Idempotency-Key": {
|
|
21061
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21062
|
+
},
|
|
21063
|
+
"Idempotency-Replay": {
|
|
21064
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21065
|
+
}
|
|
21066
|
+
},
|
|
21067
|
+
"content": {
|
|
21068
|
+
"application/json": {
|
|
21069
|
+
"schema": {
|
|
21070
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21071
|
+
}
|
|
21072
|
+
}
|
|
21073
|
+
}
|
|
21074
|
+
},
|
|
21075
|
+
"404": {
|
|
21076
|
+
"description": "Not Found",
|
|
21077
|
+
"headers": {
|
|
21078
|
+
"Content-Type": {
|
|
21079
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21080
|
+
},
|
|
21081
|
+
"RateLimit-Limit": {
|
|
21082
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21083
|
+
},
|
|
21084
|
+
"RateLimit-Remaining": {
|
|
21085
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21086
|
+
},
|
|
21087
|
+
"RateLimit-Reset": {
|
|
21088
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21089
|
+
},
|
|
21090
|
+
"RateLimit-Policy": {
|
|
21091
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21092
|
+
},
|
|
21093
|
+
"Idempotency-Key": {
|
|
21094
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21095
|
+
},
|
|
21096
|
+
"Idempotency-Replay": {
|
|
21097
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21098
|
+
}
|
|
21099
|
+
},
|
|
21100
|
+
"content": {
|
|
21101
|
+
"application/json": {
|
|
21102
|
+
"schema": {
|
|
21103
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21104
|
+
}
|
|
21105
|
+
}
|
|
21106
|
+
}
|
|
21107
|
+
},
|
|
21108
|
+
"405": {
|
|
21109
|
+
"description": "Method Not Allowed",
|
|
21110
|
+
"headers": {
|
|
21111
|
+
"Content-Type": {
|
|
21112
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21113
|
+
},
|
|
21114
|
+
"RateLimit-Limit": {
|
|
21115
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21116
|
+
},
|
|
21117
|
+
"RateLimit-Remaining": {
|
|
21118
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21119
|
+
},
|
|
21120
|
+
"RateLimit-Reset": {
|
|
21121
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21122
|
+
},
|
|
21123
|
+
"RateLimit-Policy": {
|
|
21124
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21125
|
+
},
|
|
21126
|
+
"Idempotency-Key": {
|
|
21127
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21128
|
+
},
|
|
21129
|
+
"Idempotency-Replay": {
|
|
21130
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21131
|
+
}
|
|
21132
|
+
},
|
|
21133
|
+
"content": {
|
|
21134
|
+
"application/json": {
|
|
21135
|
+
"schema": {
|
|
21136
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21137
|
+
}
|
|
21138
|
+
}
|
|
21139
|
+
}
|
|
21140
|
+
},
|
|
21141
|
+
"409": {
|
|
21142
|
+
"description": "Conflict",
|
|
21143
|
+
"headers": {
|
|
21144
|
+
"Content-Type": {
|
|
21145
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21146
|
+
},
|
|
21147
|
+
"RateLimit-Limit": {
|
|
21148
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21149
|
+
},
|
|
21150
|
+
"RateLimit-Remaining": {
|
|
21151
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21152
|
+
},
|
|
21153
|
+
"RateLimit-Reset": {
|
|
21154
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21155
|
+
},
|
|
21156
|
+
"RateLimit-Policy": {
|
|
21157
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21158
|
+
},
|
|
21159
|
+
"Idempotency-Key": {
|
|
21160
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21161
|
+
},
|
|
21162
|
+
"Idempotency-Replay": {
|
|
21163
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21164
|
+
}
|
|
21165
|
+
},
|
|
21166
|
+
"content": {
|
|
21167
|
+
"application/json": {
|
|
21168
|
+
"schema": {
|
|
21169
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21170
|
+
}
|
|
21171
|
+
}
|
|
21172
|
+
}
|
|
21173
|
+
},
|
|
21174
|
+
"413": {
|
|
21175
|
+
"description": "Payload Too Large",
|
|
21176
|
+
"headers": {
|
|
21177
|
+
"Content-Type": {
|
|
21178
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21179
|
+
},
|
|
21180
|
+
"RateLimit-Limit": {
|
|
21181
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21182
|
+
},
|
|
21183
|
+
"RateLimit-Remaining": {
|
|
21184
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21185
|
+
},
|
|
21186
|
+
"RateLimit-Reset": {
|
|
21187
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21188
|
+
},
|
|
21189
|
+
"RateLimit-Policy": {
|
|
21190
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21191
|
+
},
|
|
21192
|
+
"Idempotency-Key": {
|
|
21193
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21194
|
+
},
|
|
21195
|
+
"Idempotency-Replay": {
|
|
21196
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21197
|
+
}
|
|
21198
|
+
},
|
|
21199
|
+
"content": {
|
|
21200
|
+
"application/json": {
|
|
21201
|
+
"schema": {
|
|
21202
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21203
|
+
}
|
|
21204
|
+
}
|
|
21205
|
+
}
|
|
21206
|
+
},
|
|
21207
|
+
"414": {
|
|
21208
|
+
"description": "URI Too Long",
|
|
21209
|
+
"content": {
|
|
21210
|
+
"application/json": {
|
|
21211
|
+
"schema": {
|
|
21212
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21213
|
+
}
|
|
21214
|
+
}
|
|
21215
|
+
}
|
|
21216
|
+
},
|
|
21217
|
+
"415": {
|
|
21218
|
+
"description": "Unsupported Media Type",
|
|
21219
|
+
"headers": {
|
|
21220
|
+
"Content-Type": {
|
|
21221
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21222
|
+
},
|
|
21223
|
+
"RateLimit-Limit": {
|
|
21224
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21225
|
+
},
|
|
21226
|
+
"RateLimit-Remaining": {
|
|
21227
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21228
|
+
},
|
|
21229
|
+
"RateLimit-Reset": {
|
|
21230
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21231
|
+
},
|
|
21232
|
+
"RateLimit-Policy": {
|
|
21233
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21234
|
+
},
|
|
21235
|
+
"Idempotency-Key": {
|
|
21236
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21237
|
+
},
|
|
21238
|
+
"Idempotency-Replay": {
|
|
21239
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21240
|
+
}
|
|
21241
|
+
},
|
|
21242
|
+
"content": {
|
|
21243
|
+
"application/json": {
|
|
21244
|
+
"schema": {
|
|
21245
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21246
|
+
}
|
|
21247
|
+
}
|
|
21248
|
+
}
|
|
21249
|
+
},
|
|
21250
|
+
"422": {
|
|
21251
|
+
"description": "Unprocessable Entity",
|
|
21252
|
+
"headers": {
|
|
21253
|
+
"Content-Type": {
|
|
21254
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21255
|
+
},
|
|
21256
|
+
"RateLimit-Limit": {
|
|
21257
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21258
|
+
},
|
|
21259
|
+
"RateLimit-Remaining": {
|
|
21260
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21261
|
+
},
|
|
21262
|
+
"RateLimit-Reset": {
|
|
21263
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21264
|
+
},
|
|
21265
|
+
"RateLimit-Policy": {
|
|
21266
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21267
|
+
},
|
|
21268
|
+
"Idempotency-Key": {
|
|
21269
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21270
|
+
},
|
|
21271
|
+
"Idempotency-Replay": {
|
|
21272
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21273
|
+
}
|
|
21274
|
+
},
|
|
21275
|
+
"content": {
|
|
21276
|
+
"application/json": {
|
|
21277
|
+
"schema": {
|
|
21278
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
21279
|
+
}
|
|
21280
|
+
}
|
|
21281
|
+
}
|
|
21282
|
+
},
|
|
21283
|
+
"429": {
|
|
21284
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
21285
|
+
"headers": {
|
|
21286
|
+
"Content-Type": {
|
|
21287
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21288
|
+
},
|
|
21289
|
+
"RateLimit-Limit": {
|
|
21290
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21291
|
+
},
|
|
21292
|
+
"RateLimit-Remaining": {
|
|
21293
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21294
|
+
},
|
|
21295
|
+
"RateLimit-Reset": {
|
|
21296
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21297
|
+
},
|
|
21298
|
+
"RateLimit-Policy": {
|
|
21299
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21300
|
+
},
|
|
21301
|
+
"Idempotency-Key": {
|
|
21302
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21303
|
+
},
|
|
21304
|
+
"Idempotency-Replay": {
|
|
21305
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21306
|
+
},
|
|
21307
|
+
"Retry-After": {
|
|
21308
|
+
"$ref": "#/components/headers/Retry-After"
|
|
21309
|
+
}
|
|
21310
|
+
},
|
|
21311
|
+
"content": {
|
|
21312
|
+
"application/json": {
|
|
21313
|
+
"schema": {
|
|
21314
|
+
"type": "string",
|
|
21315
|
+
"example": "API rate limit exceeded"
|
|
21316
|
+
}
|
|
21317
|
+
}
|
|
21318
|
+
}
|
|
21319
|
+
},
|
|
21320
|
+
"500": {
|
|
21321
|
+
"description": "Internal Server Error",
|
|
21322
|
+
"headers": {
|
|
21323
|
+
"Content-Type": {
|
|
21324
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21325
|
+
},
|
|
21326
|
+
"RateLimit-Limit": {
|
|
21327
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21328
|
+
},
|
|
21329
|
+
"RateLimit-Remaining": {
|
|
21330
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21331
|
+
},
|
|
21332
|
+
"RateLimit-Reset": {
|
|
21333
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21334
|
+
},
|
|
21335
|
+
"RateLimit-Policy": {
|
|
21336
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21337
|
+
},
|
|
21338
|
+
"Idempotency-Key": {
|
|
21339
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21340
|
+
},
|
|
21341
|
+
"Idempotency-Replay": {
|
|
21342
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21343
|
+
}
|
|
21344
|
+
},
|
|
21345
|
+
"content": {
|
|
21346
|
+
"application/json": {
|
|
21347
|
+
"schema": {
|
|
21348
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21349
|
+
}
|
|
21350
|
+
}
|
|
21351
|
+
}
|
|
21352
|
+
},
|
|
21353
|
+
"503": {
|
|
21354
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
21355
|
+
"headers": {
|
|
21356
|
+
"Content-Type": {
|
|
21357
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21358
|
+
},
|
|
21359
|
+
"RateLimit-Limit": {
|
|
21360
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21361
|
+
},
|
|
21362
|
+
"RateLimit-Remaining": {
|
|
21363
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21364
|
+
},
|
|
21365
|
+
"RateLimit-Reset": {
|
|
21366
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21367
|
+
},
|
|
21368
|
+
"RateLimit-Policy": {
|
|
21369
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21370
|
+
},
|
|
21371
|
+
"Idempotency-Key": {
|
|
21372
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21373
|
+
},
|
|
21374
|
+
"Idempotency-Replay": {
|
|
21375
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21376
|
+
},
|
|
21377
|
+
"Retry-After": {
|
|
21378
|
+
"$ref": "#/components/headers/Retry-After"
|
|
21379
|
+
}
|
|
21380
|
+
},
|
|
21381
|
+
"content": {
|
|
21382
|
+
"application/json": {
|
|
21383
|
+
"schema": {
|
|
21384
|
+
"type": "string",
|
|
21385
|
+
"example": "Please wait some time, then try again."
|
|
21386
|
+
}
|
|
21387
|
+
}
|
|
21388
|
+
}
|
|
21389
|
+
}
|
|
21390
|
+
},
|
|
21391
|
+
"tags": [
|
|
21392
|
+
"Messages"
|
|
21393
|
+
],
|
|
21394
|
+
"security": [
|
|
21395
|
+
{
|
|
21396
|
+
"secretKey": []
|
|
21397
|
+
}
|
|
21398
|
+
]
|
|
21399
|
+
}
|
|
21400
|
+
},
|
|
21401
|
+
"/v1/messages/{messageId}": {
|
|
21402
|
+
"delete": {
|
|
21403
|
+
"operationId": "MessagesController_deleteMessage",
|
|
21404
|
+
"summary": "Delete message",
|
|
21405
|
+
"description": "Deletes a message entity from the Novu platform",
|
|
21406
|
+
"parameters": [
|
|
21407
|
+
{
|
|
21408
|
+
"name": "messageId",
|
|
21409
|
+
"required": true,
|
|
21410
|
+
"in": "path",
|
|
21411
|
+
"schema": {
|
|
21412
|
+
"type": "string"
|
|
21413
|
+
}
|
|
21414
|
+
},
|
|
21415
|
+
{
|
|
21416
|
+
"name": "idempotency-key",
|
|
21417
|
+
"in": "header",
|
|
21418
|
+
"description": "A header for idempotency purposes",
|
|
21419
|
+
"required": false,
|
|
21420
|
+
"schema": {
|
|
21421
|
+
"type": "string"
|
|
21422
|
+
}
|
|
21423
|
+
}
|
|
21424
|
+
],
|
|
21425
|
+
"responses": {
|
|
21426
|
+
"200": {
|
|
21427
|
+
"description": "OK",
|
|
21428
|
+
"headers": {
|
|
21429
|
+
"Content-Type": {
|
|
21430
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21431
|
+
},
|
|
21432
|
+
"RateLimit-Limit": {
|
|
21433
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21434
|
+
},
|
|
21435
|
+
"RateLimit-Remaining": {
|
|
21436
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21437
|
+
},
|
|
21438
|
+
"RateLimit-Reset": {
|
|
21439
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21440
|
+
},
|
|
21441
|
+
"RateLimit-Policy": {
|
|
21442
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21443
|
+
},
|
|
21444
|
+
"Idempotency-Key": {
|
|
21445
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21446
|
+
},
|
|
21447
|
+
"Idempotency-Replay": {
|
|
21448
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21449
|
+
}
|
|
21450
|
+
},
|
|
21451
|
+
"content": {
|
|
21452
|
+
"application/json": {
|
|
21453
|
+
"schema": {
|
|
21454
|
+
"$ref": "#/components/schemas/DeleteMessageResponseDto"
|
|
21455
|
+
}
|
|
21456
|
+
}
|
|
21457
|
+
}
|
|
21458
|
+
},
|
|
21459
|
+
"400": {
|
|
21460
|
+
"description": "Bad Request",
|
|
21461
|
+
"headers": {
|
|
21462
|
+
"Content-Type": {
|
|
21463
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21464
|
+
},
|
|
21465
|
+
"RateLimit-Limit": {
|
|
21466
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21467
|
+
},
|
|
21468
|
+
"RateLimit-Remaining": {
|
|
21469
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21470
|
+
},
|
|
21471
|
+
"RateLimit-Reset": {
|
|
21472
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21473
|
+
},
|
|
21474
|
+
"RateLimit-Policy": {
|
|
21475
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21476
|
+
},
|
|
21477
|
+
"Idempotency-Key": {
|
|
21478
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21479
|
+
},
|
|
21480
|
+
"Idempotency-Replay": {
|
|
21481
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21482
|
+
}
|
|
21483
|
+
},
|
|
21484
|
+
"content": {
|
|
21485
|
+
"application/json": {
|
|
21486
|
+
"schema": {
|
|
21487
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21488
|
+
}
|
|
21489
|
+
}
|
|
21490
|
+
}
|
|
21491
|
+
},
|
|
21492
|
+
"401": {
|
|
21493
|
+
"description": "Unauthorized",
|
|
21494
|
+
"headers": {
|
|
21495
|
+
"Content-Type": {
|
|
21496
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21497
|
+
},
|
|
21498
|
+
"RateLimit-Limit": {
|
|
21499
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21500
|
+
},
|
|
21501
|
+
"RateLimit-Remaining": {
|
|
21502
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21503
|
+
},
|
|
21504
|
+
"RateLimit-Reset": {
|
|
21505
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21506
|
+
},
|
|
21507
|
+
"RateLimit-Policy": {
|
|
21508
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21509
|
+
},
|
|
21510
|
+
"Idempotency-Key": {
|
|
21511
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21512
|
+
},
|
|
21513
|
+
"Idempotency-Replay": {
|
|
21514
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21515
|
+
}
|
|
21516
|
+
},
|
|
21517
|
+
"content": {
|
|
21518
|
+
"application/json": {
|
|
21519
|
+
"schema": {
|
|
21520
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21521
|
+
}
|
|
21522
|
+
}
|
|
21523
|
+
}
|
|
21524
|
+
},
|
|
21525
|
+
"403": {
|
|
21526
|
+
"description": "Forbidden",
|
|
21527
|
+
"headers": {
|
|
21528
|
+
"Content-Type": {
|
|
21529
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21530
|
+
},
|
|
21531
|
+
"RateLimit-Limit": {
|
|
21532
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21533
|
+
},
|
|
21534
|
+
"RateLimit-Remaining": {
|
|
21535
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21536
|
+
},
|
|
21537
|
+
"RateLimit-Reset": {
|
|
21538
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21539
|
+
},
|
|
21540
|
+
"RateLimit-Policy": {
|
|
21541
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21542
|
+
},
|
|
21543
|
+
"Idempotency-Key": {
|
|
21544
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21545
|
+
},
|
|
21546
|
+
"Idempotency-Replay": {
|
|
21547
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21548
|
+
}
|
|
21549
|
+
},
|
|
21550
|
+
"content": {
|
|
21551
|
+
"application/json": {
|
|
21552
|
+
"schema": {
|
|
21553
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21554
|
+
}
|
|
21555
|
+
}
|
|
21556
|
+
}
|
|
21557
|
+
},
|
|
21558
|
+
"404": {
|
|
21559
|
+
"description": "Not Found",
|
|
21560
|
+
"headers": {
|
|
21561
|
+
"Content-Type": {
|
|
21562
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21563
|
+
},
|
|
21564
|
+
"RateLimit-Limit": {
|
|
21565
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21566
|
+
},
|
|
21567
|
+
"RateLimit-Remaining": {
|
|
21568
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21569
|
+
},
|
|
21570
|
+
"RateLimit-Reset": {
|
|
21571
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21572
|
+
},
|
|
21573
|
+
"RateLimit-Policy": {
|
|
21574
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21575
|
+
},
|
|
21576
|
+
"Idempotency-Key": {
|
|
21577
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21578
|
+
},
|
|
21579
|
+
"Idempotency-Replay": {
|
|
21580
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21581
|
+
}
|
|
21582
|
+
},
|
|
21583
|
+
"content": {
|
|
21584
|
+
"application/json": {
|
|
21585
|
+
"schema": {
|
|
21586
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21587
|
+
}
|
|
21588
|
+
}
|
|
21589
|
+
}
|
|
21590
|
+
},
|
|
21591
|
+
"405": {
|
|
21592
|
+
"description": "Method Not Allowed",
|
|
21593
|
+
"headers": {
|
|
21594
|
+
"Content-Type": {
|
|
21595
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21596
|
+
},
|
|
21597
|
+
"RateLimit-Limit": {
|
|
21598
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21599
|
+
},
|
|
21600
|
+
"RateLimit-Remaining": {
|
|
21601
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21602
|
+
},
|
|
21603
|
+
"RateLimit-Reset": {
|
|
21604
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21605
|
+
},
|
|
21606
|
+
"RateLimit-Policy": {
|
|
21607
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21608
|
+
},
|
|
21609
|
+
"Idempotency-Key": {
|
|
21610
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21611
|
+
},
|
|
21612
|
+
"Idempotency-Replay": {
|
|
21613
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21614
|
+
}
|
|
21615
|
+
},
|
|
21616
|
+
"content": {
|
|
21617
|
+
"application/json": {
|
|
21618
|
+
"schema": {
|
|
21619
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21620
|
+
}
|
|
21621
|
+
}
|
|
21622
|
+
}
|
|
21623
|
+
},
|
|
21624
|
+
"409": {
|
|
21625
|
+
"description": "Conflict",
|
|
21626
|
+
"headers": {
|
|
21627
|
+
"Content-Type": {
|
|
21628
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21629
|
+
},
|
|
21630
|
+
"RateLimit-Limit": {
|
|
21631
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21632
|
+
},
|
|
21633
|
+
"RateLimit-Remaining": {
|
|
21634
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21635
|
+
},
|
|
21636
|
+
"RateLimit-Reset": {
|
|
21637
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21638
|
+
},
|
|
21639
|
+
"RateLimit-Policy": {
|
|
21640
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21641
|
+
},
|
|
21642
|
+
"Idempotency-Key": {
|
|
21643
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21644
|
+
},
|
|
21645
|
+
"Idempotency-Replay": {
|
|
21646
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21647
|
+
}
|
|
21648
|
+
},
|
|
21649
|
+
"content": {
|
|
21650
|
+
"application/json": {
|
|
21651
|
+
"schema": {
|
|
21652
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21653
|
+
}
|
|
21654
|
+
}
|
|
21655
|
+
}
|
|
21656
|
+
},
|
|
21657
|
+
"413": {
|
|
21658
|
+
"description": "Payload Too Large",
|
|
21659
|
+
"headers": {
|
|
21660
|
+
"Content-Type": {
|
|
21661
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21662
|
+
},
|
|
21663
|
+
"RateLimit-Limit": {
|
|
21664
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21665
|
+
},
|
|
21666
|
+
"RateLimit-Remaining": {
|
|
21667
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21668
|
+
},
|
|
21669
|
+
"RateLimit-Reset": {
|
|
21670
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21671
|
+
},
|
|
21672
|
+
"RateLimit-Policy": {
|
|
21673
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21674
|
+
},
|
|
21675
|
+
"Idempotency-Key": {
|
|
21676
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21677
|
+
},
|
|
21678
|
+
"Idempotency-Replay": {
|
|
21679
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21680
|
+
}
|
|
21681
|
+
},
|
|
21682
|
+
"content": {
|
|
21683
|
+
"application/json": {
|
|
21684
|
+
"schema": {
|
|
21685
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21686
|
+
}
|
|
21687
|
+
}
|
|
21688
|
+
}
|
|
21689
|
+
},
|
|
21690
|
+
"414": {
|
|
21691
|
+
"description": "URI Too Long",
|
|
21692
|
+
"content": {
|
|
21693
|
+
"application/json": {
|
|
21694
|
+
"schema": {
|
|
21695
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21696
|
+
}
|
|
21697
|
+
}
|
|
21698
|
+
}
|
|
21699
|
+
},
|
|
21700
|
+
"415": {
|
|
21701
|
+
"description": "Unsupported Media Type",
|
|
21702
|
+
"headers": {
|
|
21703
|
+
"Content-Type": {
|
|
21704
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21705
|
+
},
|
|
21706
|
+
"RateLimit-Limit": {
|
|
21707
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21708
|
+
},
|
|
21709
|
+
"RateLimit-Remaining": {
|
|
21710
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21711
|
+
},
|
|
21712
|
+
"RateLimit-Reset": {
|
|
21713
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21714
|
+
},
|
|
21715
|
+
"RateLimit-Policy": {
|
|
21716
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21717
|
+
},
|
|
21718
|
+
"Idempotency-Key": {
|
|
21719
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21720
|
+
},
|
|
21721
|
+
"Idempotency-Replay": {
|
|
21722
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21723
|
+
}
|
|
21724
|
+
},
|
|
21725
|
+
"content": {
|
|
21726
|
+
"application/json": {
|
|
21727
|
+
"schema": {
|
|
21728
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21729
|
+
}
|
|
21730
|
+
}
|
|
21731
|
+
}
|
|
21732
|
+
},
|
|
21733
|
+
"422": {
|
|
21734
|
+
"description": "Unprocessable Entity",
|
|
21735
|
+
"headers": {
|
|
21736
|
+
"Content-Type": {
|
|
21737
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21738
|
+
},
|
|
21739
|
+
"RateLimit-Limit": {
|
|
21740
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21741
|
+
},
|
|
21742
|
+
"RateLimit-Remaining": {
|
|
21743
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21744
|
+
},
|
|
21745
|
+
"RateLimit-Reset": {
|
|
21746
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21747
|
+
},
|
|
21748
|
+
"RateLimit-Policy": {
|
|
21749
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21750
|
+
},
|
|
21751
|
+
"Idempotency-Key": {
|
|
21752
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21753
|
+
},
|
|
21754
|
+
"Idempotency-Replay": {
|
|
21755
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21756
|
+
}
|
|
21757
|
+
},
|
|
21758
|
+
"content": {
|
|
21759
|
+
"application/json": {
|
|
21760
|
+
"schema": {
|
|
21761
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
21762
|
+
}
|
|
21763
|
+
}
|
|
21764
|
+
}
|
|
21765
|
+
},
|
|
21766
|
+
"429": {
|
|
21767
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
21768
|
+
"headers": {
|
|
21769
|
+
"Content-Type": {
|
|
21770
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21771
|
+
},
|
|
21772
|
+
"RateLimit-Limit": {
|
|
21773
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21774
|
+
},
|
|
21775
|
+
"RateLimit-Remaining": {
|
|
21776
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21777
|
+
},
|
|
21778
|
+
"RateLimit-Reset": {
|
|
21779
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21780
|
+
},
|
|
21781
|
+
"RateLimit-Policy": {
|
|
21782
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21783
|
+
},
|
|
21784
|
+
"Idempotency-Key": {
|
|
21785
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21786
|
+
},
|
|
21787
|
+
"Idempotency-Replay": {
|
|
21788
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21789
|
+
},
|
|
21790
|
+
"Retry-After": {
|
|
21791
|
+
"$ref": "#/components/headers/Retry-After"
|
|
21792
|
+
}
|
|
21793
|
+
},
|
|
21794
|
+
"content": {
|
|
21795
|
+
"application/json": {
|
|
21796
|
+
"schema": {
|
|
21797
|
+
"type": "string",
|
|
21798
|
+
"example": "API rate limit exceeded"
|
|
21799
|
+
}
|
|
21800
|
+
}
|
|
21801
|
+
}
|
|
21802
|
+
},
|
|
21803
|
+
"500": {
|
|
21804
|
+
"description": "Internal Server Error",
|
|
21805
|
+
"headers": {
|
|
21806
|
+
"Content-Type": {
|
|
21807
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21808
|
+
},
|
|
21809
|
+
"RateLimit-Limit": {
|
|
21810
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21811
|
+
},
|
|
21812
|
+
"RateLimit-Remaining": {
|
|
21813
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21814
|
+
},
|
|
21815
|
+
"RateLimit-Reset": {
|
|
21816
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21817
|
+
},
|
|
21818
|
+
"RateLimit-Policy": {
|
|
21819
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21820
|
+
},
|
|
21821
|
+
"Idempotency-Key": {
|
|
21822
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21823
|
+
},
|
|
21824
|
+
"Idempotency-Replay": {
|
|
21825
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21826
|
+
}
|
|
21827
|
+
},
|
|
21828
|
+
"content": {
|
|
21829
|
+
"application/json": {
|
|
21830
|
+
"schema": {
|
|
21831
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21832
|
+
}
|
|
21833
|
+
}
|
|
21834
|
+
}
|
|
21835
|
+
},
|
|
21836
|
+
"503": {
|
|
21837
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
21838
|
+
"headers": {
|
|
21839
|
+
"Content-Type": {
|
|
21840
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21841
|
+
},
|
|
21842
|
+
"RateLimit-Limit": {
|
|
21843
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21844
|
+
},
|
|
21845
|
+
"RateLimit-Remaining": {
|
|
21846
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21847
|
+
},
|
|
21848
|
+
"RateLimit-Reset": {
|
|
21849
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21850
|
+
},
|
|
21851
|
+
"RateLimit-Policy": {
|
|
21852
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21853
|
+
},
|
|
21854
|
+
"Idempotency-Key": {
|
|
21855
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21856
|
+
},
|
|
21857
|
+
"Idempotency-Replay": {
|
|
21858
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21859
|
+
},
|
|
21860
|
+
"Retry-After": {
|
|
21861
|
+
"$ref": "#/components/headers/Retry-After"
|
|
21862
|
+
}
|
|
21863
|
+
},
|
|
21864
|
+
"content": {
|
|
21865
|
+
"application/json": {
|
|
21866
|
+
"schema": {
|
|
21867
|
+
"type": "string",
|
|
21868
|
+
"example": "Please wait some time, then try again."
|
|
21869
|
+
}
|
|
21870
|
+
}
|
|
21871
|
+
}
|
|
21872
|
+
}
|
|
21873
|
+
},
|
|
21874
|
+
"tags": [
|
|
21875
|
+
"Messages"
|
|
21876
|
+
],
|
|
21877
|
+
"security": [
|
|
21878
|
+
{
|
|
21879
|
+
"secretKey": []
|
|
21880
|
+
}
|
|
21881
|
+
]
|
|
21882
|
+
}
|
|
21883
|
+
},
|
|
21884
|
+
"/v1/messages/transaction/{transactionId}": {
|
|
21885
|
+
"delete": {
|
|
21886
|
+
"operationId": "MessagesController_deleteMessagesByTransactionId",
|
|
21887
|
+
"x-speakeasy-name-override": "deleteByTransactionId",
|
|
21888
|
+
"summary": "Delete messages by transactionId",
|
|
21889
|
+
"description": "Deletes messages entity from the Novu platform using TransactionId of message",
|
|
21890
|
+
"parameters": [
|
|
21891
|
+
{
|
|
21892
|
+
"name": "channel",
|
|
21893
|
+
"required": false,
|
|
21894
|
+
"in": "query",
|
|
21895
|
+
"description": "The channel of the message to be deleted",
|
|
21896
|
+
"schema": {
|
|
21897
|
+
"enum": [
|
|
21898
|
+
"in_app",
|
|
21899
|
+
"email",
|
|
21900
|
+
"sms",
|
|
21901
|
+
"chat",
|
|
21902
|
+
"push"
|
|
21903
|
+
],
|
|
21904
|
+
"type": "string"
|
|
21905
|
+
}
|
|
21906
|
+
},
|
|
21907
|
+
{
|
|
21908
|
+
"name": "transactionId",
|
|
21909
|
+
"required": true,
|
|
21910
|
+
"in": "path",
|
|
21911
|
+
"schema": {
|
|
21912
|
+
"type": "string"
|
|
21913
|
+
}
|
|
21914
|
+
},
|
|
21915
|
+
{
|
|
21916
|
+
"name": "idempotency-key",
|
|
21917
|
+
"in": "header",
|
|
21918
|
+
"description": "A header for idempotency purposes",
|
|
21919
|
+
"required": false,
|
|
21920
|
+
"schema": {
|
|
21921
|
+
"type": "string"
|
|
21922
|
+
}
|
|
21923
|
+
}
|
|
21924
|
+
],
|
|
21925
|
+
"responses": {
|
|
21926
|
+
"204": {
|
|
21927
|
+
"headers": {
|
|
21928
|
+
"Content-Type": {
|
|
21929
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21930
|
+
},
|
|
21931
|
+
"RateLimit-Limit": {
|
|
21932
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21933
|
+
},
|
|
21934
|
+
"RateLimit-Remaining": {
|
|
21935
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21936
|
+
},
|
|
21937
|
+
"RateLimit-Reset": {
|
|
21938
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21939
|
+
},
|
|
21940
|
+
"RateLimit-Policy": {
|
|
21941
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21942
|
+
},
|
|
21943
|
+
"Idempotency-Key": {
|
|
21944
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21945
|
+
},
|
|
21946
|
+
"Idempotency-Replay": {
|
|
21947
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21948
|
+
}
|
|
21949
|
+
},
|
|
21950
|
+
"description": ""
|
|
21951
|
+
},
|
|
21952
|
+
"400": {
|
|
21953
|
+
"description": "Bad Request",
|
|
21954
|
+
"headers": {
|
|
21955
|
+
"Content-Type": {
|
|
21956
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21957
|
+
},
|
|
21958
|
+
"RateLimit-Limit": {
|
|
21959
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21960
|
+
},
|
|
21961
|
+
"RateLimit-Remaining": {
|
|
21962
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21963
|
+
},
|
|
21964
|
+
"RateLimit-Reset": {
|
|
21965
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21966
|
+
},
|
|
21967
|
+
"RateLimit-Policy": {
|
|
21968
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
21969
|
+
},
|
|
21970
|
+
"Idempotency-Key": {
|
|
21971
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
21972
|
+
},
|
|
21973
|
+
"Idempotency-Replay": {
|
|
21974
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
21975
|
+
}
|
|
21976
|
+
},
|
|
21977
|
+
"content": {
|
|
21978
|
+
"application/json": {
|
|
21979
|
+
"schema": {
|
|
21980
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
21981
|
+
}
|
|
21982
|
+
}
|
|
21983
|
+
}
|
|
21984
|
+
},
|
|
21985
|
+
"401": {
|
|
21986
|
+
"description": "Unauthorized",
|
|
21987
|
+
"headers": {
|
|
21988
|
+
"Content-Type": {
|
|
21989
|
+
"$ref": "#/components/headers/Content-Type"
|
|
21990
|
+
},
|
|
21991
|
+
"RateLimit-Limit": {
|
|
21992
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
21993
|
+
},
|
|
21994
|
+
"RateLimit-Remaining": {
|
|
21995
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
21996
|
+
},
|
|
21997
|
+
"RateLimit-Reset": {
|
|
21998
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
21999
|
+
},
|
|
22000
|
+
"RateLimit-Policy": {
|
|
22001
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22002
|
+
},
|
|
22003
|
+
"Idempotency-Key": {
|
|
22004
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22005
|
+
},
|
|
22006
|
+
"Idempotency-Replay": {
|
|
22007
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22008
|
+
}
|
|
22009
|
+
},
|
|
22010
|
+
"content": {
|
|
22011
|
+
"application/json": {
|
|
22012
|
+
"schema": {
|
|
22013
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22014
|
+
}
|
|
22015
|
+
}
|
|
22016
|
+
}
|
|
22017
|
+
},
|
|
22018
|
+
"403": {
|
|
22019
|
+
"description": "Forbidden",
|
|
22020
|
+
"headers": {
|
|
22021
|
+
"Content-Type": {
|
|
22022
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22023
|
+
},
|
|
22024
|
+
"RateLimit-Limit": {
|
|
22025
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22026
|
+
},
|
|
22027
|
+
"RateLimit-Remaining": {
|
|
22028
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22029
|
+
},
|
|
22030
|
+
"RateLimit-Reset": {
|
|
22031
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22032
|
+
},
|
|
22033
|
+
"RateLimit-Policy": {
|
|
22034
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22035
|
+
},
|
|
22036
|
+
"Idempotency-Key": {
|
|
22037
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22038
|
+
},
|
|
22039
|
+
"Idempotency-Replay": {
|
|
22040
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22041
|
+
}
|
|
22042
|
+
},
|
|
22043
|
+
"content": {
|
|
22044
|
+
"application/json": {
|
|
22045
|
+
"schema": {
|
|
22046
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22047
|
+
}
|
|
22048
|
+
}
|
|
22049
|
+
}
|
|
22050
|
+
},
|
|
22051
|
+
"404": {
|
|
22052
|
+
"description": "Not Found",
|
|
22053
|
+
"headers": {
|
|
22054
|
+
"Content-Type": {
|
|
22055
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22056
|
+
},
|
|
22057
|
+
"RateLimit-Limit": {
|
|
22058
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22059
|
+
},
|
|
22060
|
+
"RateLimit-Remaining": {
|
|
22061
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22062
|
+
},
|
|
22063
|
+
"RateLimit-Reset": {
|
|
22064
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22065
|
+
},
|
|
22066
|
+
"RateLimit-Policy": {
|
|
22067
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22068
|
+
},
|
|
22069
|
+
"Idempotency-Key": {
|
|
22070
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22071
|
+
},
|
|
22072
|
+
"Idempotency-Replay": {
|
|
22073
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22074
|
+
}
|
|
22075
|
+
},
|
|
22076
|
+
"content": {
|
|
22077
|
+
"application/json": {
|
|
22078
|
+
"schema": {
|
|
22079
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22080
|
+
}
|
|
22081
|
+
}
|
|
22082
|
+
}
|
|
22083
|
+
},
|
|
22084
|
+
"405": {
|
|
22085
|
+
"description": "Method Not Allowed",
|
|
22086
|
+
"headers": {
|
|
22087
|
+
"Content-Type": {
|
|
22088
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22089
|
+
},
|
|
22090
|
+
"RateLimit-Limit": {
|
|
22091
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22092
|
+
},
|
|
22093
|
+
"RateLimit-Remaining": {
|
|
22094
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22095
|
+
},
|
|
22096
|
+
"RateLimit-Reset": {
|
|
22097
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22098
|
+
},
|
|
22099
|
+
"RateLimit-Policy": {
|
|
22100
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22101
|
+
},
|
|
22102
|
+
"Idempotency-Key": {
|
|
22103
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22104
|
+
},
|
|
22105
|
+
"Idempotency-Replay": {
|
|
22106
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22107
|
+
}
|
|
22108
|
+
},
|
|
22109
|
+
"content": {
|
|
22110
|
+
"application/json": {
|
|
22111
|
+
"schema": {
|
|
22112
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22113
|
+
}
|
|
22114
|
+
}
|
|
22115
|
+
}
|
|
22116
|
+
},
|
|
22117
|
+
"409": {
|
|
22118
|
+
"description": "Conflict",
|
|
22119
|
+
"headers": {
|
|
22120
|
+
"Content-Type": {
|
|
22121
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22122
|
+
},
|
|
22123
|
+
"RateLimit-Limit": {
|
|
22124
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22125
|
+
},
|
|
22126
|
+
"RateLimit-Remaining": {
|
|
22127
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22128
|
+
},
|
|
22129
|
+
"RateLimit-Reset": {
|
|
22130
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22131
|
+
},
|
|
22132
|
+
"RateLimit-Policy": {
|
|
22133
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22134
|
+
},
|
|
22135
|
+
"Idempotency-Key": {
|
|
22136
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22137
|
+
},
|
|
22138
|
+
"Idempotency-Replay": {
|
|
22139
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22140
|
+
}
|
|
22141
|
+
},
|
|
22142
|
+
"content": {
|
|
22143
|
+
"application/json": {
|
|
22144
|
+
"schema": {
|
|
22145
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22146
|
+
}
|
|
22147
|
+
}
|
|
22148
|
+
}
|
|
22149
|
+
},
|
|
22150
|
+
"413": {
|
|
22151
|
+
"description": "Payload Too Large",
|
|
22152
|
+
"headers": {
|
|
22153
|
+
"Content-Type": {
|
|
22154
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22155
|
+
},
|
|
22156
|
+
"RateLimit-Limit": {
|
|
22157
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22158
|
+
},
|
|
22159
|
+
"RateLimit-Remaining": {
|
|
22160
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22161
|
+
},
|
|
22162
|
+
"RateLimit-Reset": {
|
|
22163
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22164
|
+
},
|
|
22165
|
+
"RateLimit-Policy": {
|
|
22166
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22167
|
+
},
|
|
22168
|
+
"Idempotency-Key": {
|
|
22169
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22170
|
+
},
|
|
22171
|
+
"Idempotency-Replay": {
|
|
22172
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22173
|
+
}
|
|
22174
|
+
},
|
|
22175
|
+
"content": {
|
|
22176
|
+
"application/json": {
|
|
22177
|
+
"schema": {
|
|
22178
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22179
|
+
}
|
|
22180
|
+
}
|
|
22181
|
+
}
|
|
22182
|
+
},
|
|
22183
|
+
"414": {
|
|
22184
|
+
"description": "URI Too Long",
|
|
22185
|
+
"content": {
|
|
22186
|
+
"application/json": {
|
|
22187
|
+
"schema": {
|
|
22188
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22189
|
+
}
|
|
22190
|
+
}
|
|
22191
|
+
}
|
|
22192
|
+
},
|
|
22193
|
+
"415": {
|
|
22194
|
+
"description": "Unsupported Media Type",
|
|
22195
|
+
"headers": {
|
|
22196
|
+
"Content-Type": {
|
|
22197
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22198
|
+
},
|
|
22199
|
+
"RateLimit-Limit": {
|
|
22200
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22201
|
+
},
|
|
22202
|
+
"RateLimit-Remaining": {
|
|
22203
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22204
|
+
},
|
|
22205
|
+
"RateLimit-Reset": {
|
|
22206
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22207
|
+
},
|
|
22208
|
+
"RateLimit-Policy": {
|
|
22209
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22210
|
+
},
|
|
22211
|
+
"Idempotency-Key": {
|
|
22212
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22213
|
+
},
|
|
22214
|
+
"Idempotency-Replay": {
|
|
22215
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22216
|
+
}
|
|
22217
|
+
},
|
|
22218
|
+
"content": {
|
|
22219
|
+
"application/json": {
|
|
22220
|
+
"schema": {
|
|
22221
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22222
|
+
}
|
|
22223
|
+
}
|
|
22224
|
+
}
|
|
22225
|
+
},
|
|
22226
|
+
"422": {
|
|
22227
|
+
"description": "Unprocessable Entity",
|
|
22228
|
+
"headers": {
|
|
22229
|
+
"Content-Type": {
|
|
22230
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22231
|
+
},
|
|
22232
|
+
"RateLimit-Limit": {
|
|
22233
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22234
|
+
},
|
|
22235
|
+
"RateLimit-Remaining": {
|
|
22236
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22237
|
+
},
|
|
22238
|
+
"RateLimit-Reset": {
|
|
22239
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22240
|
+
},
|
|
22241
|
+
"RateLimit-Policy": {
|
|
22242
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22243
|
+
},
|
|
22244
|
+
"Idempotency-Key": {
|
|
22245
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22246
|
+
},
|
|
22247
|
+
"Idempotency-Replay": {
|
|
22248
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22249
|
+
}
|
|
22250
|
+
},
|
|
22251
|
+
"content": {
|
|
22252
|
+
"application/json": {
|
|
22253
|
+
"schema": {
|
|
22254
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
22255
|
+
}
|
|
22256
|
+
}
|
|
22257
|
+
}
|
|
22258
|
+
},
|
|
22259
|
+
"429": {
|
|
22260
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
22261
|
+
"headers": {
|
|
22262
|
+
"Content-Type": {
|
|
22263
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22264
|
+
},
|
|
22265
|
+
"RateLimit-Limit": {
|
|
22266
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22267
|
+
},
|
|
22268
|
+
"RateLimit-Remaining": {
|
|
22269
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22270
|
+
},
|
|
22271
|
+
"RateLimit-Reset": {
|
|
22272
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22273
|
+
},
|
|
22274
|
+
"RateLimit-Policy": {
|
|
22275
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22276
|
+
},
|
|
22277
|
+
"Idempotency-Key": {
|
|
22278
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22279
|
+
},
|
|
22280
|
+
"Idempotency-Replay": {
|
|
22281
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22282
|
+
},
|
|
22283
|
+
"Retry-After": {
|
|
22284
|
+
"$ref": "#/components/headers/Retry-After"
|
|
22285
|
+
}
|
|
22286
|
+
},
|
|
22287
|
+
"content": {
|
|
22288
|
+
"application/json": {
|
|
22289
|
+
"schema": {
|
|
22290
|
+
"type": "string",
|
|
22291
|
+
"example": "API rate limit exceeded"
|
|
22292
|
+
}
|
|
22293
|
+
}
|
|
22294
|
+
}
|
|
22295
|
+
},
|
|
22296
|
+
"500": {
|
|
22297
|
+
"description": "Internal Server Error",
|
|
22298
|
+
"headers": {
|
|
22299
|
+
"Content-Type": {
|
|
22300
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22301
|
+
},
|
|
22302
|
+
"RateLimit-Limit": {
|
|
22303
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22304
|
+
},
|
|
22305
|
+
"RateLimit-Remaining": {
|
|
22306
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22307
|
+
},
|
|
22308
|
+
"RateLimit-Reset": {
|
|
22309
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22310
|
+
},
|
|
22311
|
+
"RateLimit-Policy": {
|
|
22312
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22313
|
+
},
|
|
22314
|
+
"Idempotency-Key": {
|
|
22315
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22316
|
+
},
|
|
22317
|
+
"Idempotency-Replay": {
|
|
22318
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22319
|
+
}
|
|
22320
|
+
},
|
|
22321
|
+
"content": {
|
|
22322
|
+
"application/json": {
|
|
22323
|
+
"schema": {
|
|
22324
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22325
|
+
}
|
|
22326
|
+
}
|
|
22327
|
+
}
|
|
22328
|
+
},
|
|
22329
|
+
"503": {
|
|
22330
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
22331
|
+
"headers": {
|
|
22332
|
+
"Content-Type": {
|
|
22333
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22334
|
+
},
|
|
22335
|
+
"RateLimit-Limit": {
|
|
22336
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22337
|
+
},
|
|
22338
|
+
"RateLimit-Remaining": {
|
|
22339
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22340
|
+
},
|
|
22341
|
+
"RateLimit-Reset": {
|
|
22342
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22343
|
+
},
|
|
22344
|
+
"RateLimit-Policy": {
|
|
22345
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22346
|
+
},
|
|
22347
|
+
"Idempotency-Key": {
|
|
22348
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22349
|
+
},
|
|
22350
|
+
"Idempotency-Replay": {
|
|
22351
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22352
|
+
},
|
|
22353
|
+
"Retry-After": {
|
|
22354
|
+
"$ref": "#/components/headers/Retry-After"
|
|
22355
|
+
}
|
|
22356
|
+
},
|
|
22357
|
+
"content": {
|
|
22358
|
+
"application/json": {
|
|
22359
|
+
"schema": {
|
|
22360
|
+
"type": "string",
|
|
22361
|
+
"example": "Please wait some time, then try again."
|
|
22362
|
+
}
|
|
22363
|
+
}
|
|
22364
|
+
}
|
|
22365
|
+
}
|
|
22366
|
+
},
|
|
22367
|
+
"tags": [
|
|
22368
|
+
"Messages"
|
|
22369
|
+
],
|
|
22370
|
+
"security": [
|
|
22371
|
+
{
|
|
22372
|
+
"secretKey": []
|
|
22373
|
+
}
|
|
22374
|
+
]
|
|
22375
|
+
}
|
|
22376
|
+
},
|
|
22377
|
+
"/v1/topics": {
|
|
22378
|
+
"post": {
|
|
22379
|
+
"operationId": "TopicsController_createTopic",
|
|
22380
|
+
"summary": "Topic creation",
|
|
22381
|
+
"description": "Create a topic",
|
|
22382
|
+
"parameters": [
|
|
22383
|
+
{
|
|
22384
|
+
"name": "idempotency-key",
|
|
22385
|
+
"in": "header",
|
|
22386
|
+
"description": "A header for idempotency purposes",
|
|
22387
|
+
"required": false,
|
|
22388
|
+
"schema": {
|
|
22389
|
+
"type": "string"
|
|
22390
|
+
}
|
|
22391
|
+
}
|
|
22392
|
+
],
|
|
22393
|
+
"requestBody": {
|
|
22394
|
+
"required": true,
|
|
22395
|
+
"content": {
|
|
22396
|
+
"application/json": {
|
|
22397
|
+
"schema": {
|
|
22398
|
+
"$ref": "#/components/schemas/CreateTopicRequestDto"
|
|
22399
|
+
}
|
|
22400
|
+
}
|
|
22401
|
+
}
|
|
22402
|
+
},
|
|
22403
|
+
"responses": {
|
|
22404
|
+
"201": {
|
|
22405
|
+
"description": "Created",
|
|
22406
|
+
"headers": {
|
|
22407
|
+
"Content-Type": {
|
|
22408
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22409
|
+
},
|
|
22410
|
+
"RateLimit-Limit": {
|
|
22411
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22412
|
+
},
|
|
22413
|
+
"RateLimit-Remaining": {
|
|
22414
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22415
|
+
},
|
|
22416
|
+
"RateLimit-Reset": {
|
|
22417
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22418
|
+
},
|
|
22419
|
+
"RateLimit-Policy": {
|
|
22420
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22421
|
+
},
|
|
22422
|
+
"Idempotency-Key": {
|
|
22423
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22424
|
+
},
|
|
22425
|
+
"Idempotency-Replay": {
|
|
22426
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22427
|
+
}
|
|
22428
|
+
},
|
|
22429
|
+
"content": {
|
|
22430
|
+
"application/json": {
|
|
22431
|
+
"schema": {
|
|
22432
|
+
"$ref": "#/components/schemas/CreateTopicResponseDto"
|
|
22433
|
+
}
|
|
22434
|
+
}
|
|
22435
|
+
}
|
|
22436
|
+
},
|
|
22437
|
+
"400": {
|
|
22438
|
+
"description": "Bad Request",
|
|
22439
|
+
"headers": {
|
|
22440
|
+
"Content-Type": {
|
|
22441
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22442
|
+
},
|
|
22443
|
+
"RateLimit-Limit": {
|
|
22444
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22445
|
+
},
|
|
22446
|
+
"RateLimit-Remaining": {
|
|
22447
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22448
|
+
},
|
|
22449
|
+
"RateLimit-Reset": {
|
|
22450
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22451
|
+
},
|
|
22452
|
+
"RateLimit-Policy": {
|
|
22453
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22454
|
+
},
|
|
22455
|
+
"Idempotency-Key": {
|
|
22456
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22457
|
+
},
|
|
22458
|
+
"Idempotency-Replay": {
|
|
22459
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22460
|
+
}
|
|
22461
|
+
},
|
|
22462
|
+
"content": {
|
|
22463
|
+
"application/json": {
|
|
22464
|
+
"schema": {
|
|
22465
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22466
|
+
}
|
|
22467
|
+
}
|
|
22468
|
+
}
|
|
22469
|
+
},
|
|
22470
|
+
"401": {
|
|
22471
|
+
"description": "Unauthorized",
|
|
22472
|
+
"headers": {
|
|
22473
|
+
"Content-Type": {
|
|
22474
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22475
|
+
},
|
|
22476
|
+
"RateLimit-Limit": {
|
|
22477
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22478
|
+
},
|
|
22479
|
+
"RateLimit-Remaining": {
|
|
22480
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22481
|
+
},
|
|
22482
|
+
"RateLimit-Reset": {
|
|
22483
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22484
|
+
},
|
|
22485
|
+
"RateLimit-Policy": {
|
|
22486
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22487
|
+
},
|
|
22488
|
+
"Idempotency-Key": {
|
|
22489
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22490
|
+
},
|
|
22491
|
+
"Idempotency-Replay": {
|
|
22492
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22493
|
+
}
|
|
22494
|
+
},
|
|
22495
|
+
"content": {
|
|
22496
|
+
"application/json": {
|
|
22497
|
+
"schema": {
|
|
22498
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22499
|
+
}
|
|
22500
|
+
}
|
|
22501
|
+
}
|
|
22502
|
+
},
|
|
22503
|
+
"403": {
|
|
22504
|
+
"description": "Forbidden",
|
|
22505
|
+
"headers": {
|
|
22506
|
+
"Content-Type": {
|
|
22507
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22508
|
+
},
|
|
22509
|
+
"RateLimit-Limit": {
|
|
22510
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22511
|
+
},
|
|
22512
|
+
"RateLimit-Remaining": {
|
|
22513
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22514
|
+
},
|
|
22515
|
+
"RateLimit-Reset": {
|
|
22516
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22517
|
+
},
|
|
22518
|
+
"RateLimit-Policy": {
|
|
22519
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22520
|
+
},
|
|
22521
|
+
"Idempotency-Key": {
|
|
22522
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22523
|
+
},
|
|
22524
|
+
"Idempotency-Replay": {
|
|
22525
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22526
|
+
}
|
|
22527
|
+
},
|
|
22528
|
+
"content": {
|
|
22529
|
+
"application/json": {
|
|
22530
|
+
"schema": {
|
|
22531
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22532
|
+
}
|
|
22533
|
+
}
|
|
22534
|
+
}
|
|
22535
|
+
},
|
|
22536
|
+
"404": {
|
|
22537
|
+
"description": "Not Found",
|
|
22538
|
+
"headers": {
|
|
22539
|
+
"Content-Type": {
|
|
22540
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22541
|
+
},
|
|
22542
|
+
"RateLimit-Limit": {
|
|
22543
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22544
|
+
},
|
|
22545
|
+
"RateLimit-Remaining": {
|
|
22546
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22547
|
+
},
|
|
22548
|
+
"RateLimit-Reset": {
|
|
22549
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22550
|
+
},
|
|
22551
|
+
"RateLimit-Policy": {
|
|
22552
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22553
|
+
},
|
|
22554
|
+
"Idempotency-Key": {
|
|
22555
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22556
|
+
},
|
|
22557
|
+
"Idempotency-Replay": {
|
|
22558
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22559
|
+
}
|
|
22560
|
+
},
|
|
22561
|
+
"content": {
|
|
22562
|
+
"application/json": {
|
|
22563
|
+
"schema": {
|
|
22564
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22565
|
+
}
|
|
22566
|
+
}
|
|
22567
|
+
}
|
|
22568
|
+
},
|
|
22569
|
+
"405": {
|
|
22570
|
+
"description": "Method Not Allowed",
|
|
22571
|
+
"headers": {
|
|
22572
|
+
"Content-Type": {
|
|
22573
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22574
|
+
},
|
|
22575
|
+
"RateLimit-Limit": {
|
|
22576
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22577
|
+
},
|
|
22578
|
+
"RateLimit-Remaining": {
|
|
22579
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22580
|
+
},
|
|
22581
|
+
"RateLimit-Reset": {
|
|
22582
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22583
|
+
},
|
|
22584
|
+
"RateLimit-Policy": {
|
|
22585
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22586
|
+
},
|
|
22587
|
+
"Idempotency-Key": {
|
|
22588
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22589
|
+
},
|
|
22590
|
+
"Idempotency-Replay": {
|
|
22591
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22592
|
+
}
|
|
22593
|
+
},
|
|
22594
|
+
"content": {
|
|
22595
|
+
"application/json": {
|
|
22596
|
+
"schema": {
|
|
22597
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22598
|
+
}
|
|
22599
|
+
}
|
|
22600
|
+
}
|
|
22601
|
+
},
|
|
22602
|
+
"409": {
|
|
22603
|
+
"description": "Conflict",
|
|
22604
|
+
"headers": {
|
|
22605
|
+
"Content-Type": {
|
|
22606
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22607
|
+
},
|
|
22608
|
+
"RateLimit-Limit": {
|
|
22609
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22610
|
+
},
|
|
22611
|
+
"RateLimit-Remaining": {
|
|
22612
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22613
|
+
},
|
|
22614
|
+
"RateLimit-Reset": {
|
|
22615
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22616
|
+
},
|
|
22617
|
+
"RateLimit-Policy": {
|
|
22618
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22619
|
+
},
|
|
22620
|
+
"Idempotency-Key": {
|
|
22621
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22622
|
+
},
|
|
22623
|
+
"Idempotency-Replay": {
|
|
22624
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22625
|
+
}
|
|
22626
|
+
},
|
|
22627
|
+
"content": {
|
|
22628
|
+
"application/json": {
|
|
22629
|
+
"schema": {
|
|
22630
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22631
|
+
}
|
|
22632
|
+
}
|
|
22633
|
+
}
|
|
22634
|
+
},
|
|
22635
|
+
"413": {
|
|
22636
|
+
"description": "Payload Too Large",
|
|
22637
|
+
"headers": {
|
|
22638
|
+
"Content-Type": {
|
|
22639
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22640
|
+
},
|
|
22641
|
+
"RateLimit-Limit": {
|
|
22642
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22643
|
+
},
|
|
22644
|
+
"RateLimit-Remaining": {
|
|
22645
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22646
|
+
},
|
|
22647
|
+
"RateLimit-Reset": {
|
|
22648
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22649
|
+
},
|
|
22650
|
+
"RateLimit-Policy": {
|
|
22651
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22652
|
+
},
|
|
22653
|
+
"Idempotency-Key": {
|
|
22654
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22655
|
+
},
|
|
22656
|
+
"Idempotency-Replay": {
|
|
22657
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22658
|
+
}
|
|
22659
|
+
},
|
|
22660
|
+
"content": {
|
|
22661
|
+
"application/json": {
|
|
22662
|
+
"schema": {
|
|
22663
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22664
|
+
}
|
|
22665
|
+
}
|
|
22666
|
+
}
|
|
22667
|
+
},
|
|
22668
|
+
"414": {
|
|
22669
|
+
"description": "URI Too Long",
|
|
22670
|
+
"content": {
|
|
22671
|
+
"application/json": {
|
|
22672
|
+
"schema": {
|
|
22673
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22674
|
+
}
|
|
22675
|
+
}
|
|
22676
|
+
}
|
|
22677
|
+
},
|
|
22678
|
+
"415": {
|
|
22679
|
+
"description": "Unsupported Media Type",
|
|
22680
|
+
"headers": {
|
|
22681
|
+
"Content-Type": {
|
|
22682
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22683
|
+
},
|
|
22684
|
+
"RateLimit-Limit": {
|
|
22685
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22686
|
+
},
|
|
22687
|
+
"RateLimit-Remaining": {
|
|
22688
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22689
|
+
},
|
|
22690
|
+
"RateLimit-Reset": {
|
|
22691
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22692
|
+
},
|
|
22693
|
+
"RateLimit-Policy": {
|
|
22694
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22695
|
+
},
|
|
22696
|
+
"Idempotency-Key": {
|
|
22697
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22698
|
+
},
|
|
22699
|
+
"Idempotency-Replay": {
|
|
22700
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22701
|
+
}
|
|
22702
|
+
},
|
|
22703
|
+
"content": {
|
|
22704
|
+
"application/json": {
|
|
22705
|
+
"schema": {
|
|
22706
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22707
|
+
}
|
|
22708
|
+
}
|
|
22709
|
+
}
|
|
22710
|
+
},
|
|
22711
|
+
"422": {
|
|
22712
|
+
"description": "Unprocessable Entity",
|
|
22713
|
+
"headers": {
|
|
22714
|
+
"Content-Type": {
|
|
22715
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22716
|
+
},
|
|
22717
|
+
"RateLimit-Limit": {
|
|
22718
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22719
|
+
},
|
|
22720
|
+
"RateLimit-Remaining": {
|
|
22721
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22722
|
+
},
|
|
22723
|
+
"RateLimit-Reset": {
|
|
22724
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22725
|
+
},
|
|
22726
|
+
"RateLimit-Policy": {
|
|
22727
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22728
|
+
},
|
|
22729
|
+
"Idempotency-Key": {
|
|
22730
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22731
|
+
},
|
|
22732
|
+
"Idempotency-Replay": {
|
|
22733
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22734
|
+
}
|
|
22735
|
+
},
|
|
22736
|
+
"content": {
|
|
22737
|
+
"application/json": {
|
|
22738
|
+
"schema": {
|
|
22739
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
22740
|
+
}
|
|
22741
|
+
}
|
|
22742
|
+
}
|
|
22743
|
+
},
|
|
22744
|
+
"429": {
|
|
22745
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
22746
|
+
"headers": {
|
|
22747
|
+
"Content-Type": {
|
|
22748
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22749
|
+
},
|
|
22750
|
+
"RateLimit-Limit": {
|
|
22751
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22752
|
+
},
|
|
22753
|
+
"RateLimit-Remaining": {
|
|
22754
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22755
|
+
},
|
|
22756
|
+
"RateLimit-Reset": {
|
|
22757
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22758
|
+
},
|
|
22759
|
+
"RateLimit-Policy": {
|
|
22760
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22761
|
+
},
|
|
22762
|
+
"Idempotency-Key": {
|
|
22763
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22764
|
+
},
|
|
22765
|
+
"Idempotency-Replay": {
|
|
22766
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22767
|
+
},
|
|
22768
|
+
"Retry-After": {
|
|
22769
|
+
"$ref": "#/components/headers/Retry-After"
|
|
22770
|
+
}
|
|
22771
|
+
},
|
|
22772
|
+
"content": {
|
|
22773
|
+
"application/json": {
|
|
22774
|
+
"schema": {
|
|
22775
|
+
"type": "string",
|
|
22776
|
+
"example": "API rate limit exceeded"
|
|
22777
|
+
}
|
|
22778
|
+
}
|
|
22779
|
+
}
|
|
22780
|
+
},
|
|
22781
|
+
"500": {
|
|
22782
|
+
"description": "Internal Server Error",
|
|
22783
|
+
"headers": {
|
|
22784
|
+
"Content-Type": {
|
|
22785
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22786
|
+
},
|
|
22787
|
+
"RateLimit-Limit": {
|
|
22788
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22789
|
+
},
|
|
22790
|
+
"RateLimit-Remaining": {
|
|
22791
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22792
|
+
},
|
|
22793
|
+
"RateLimit-Reset": {
|
|
22794
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22795
|
+
},
|
|
22796
|
+
"RateLimit-Policy": {
|
|
22797
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22798
|
+
},
|
|
22799
|
+
"Idempotency-Key": {
|
|
22800
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22801
|
+
},
|
|
22802
|
+
"Idempotency-Replay": {
|
|
22803
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22804
|
+
}
|
|
22805
|
+
},
|
|
22806
|
+
"content": {
|
|
22807
|
+
"application/json": {
|
|
22808
|
+
"schema": {
|
|
22809
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22810
|
+
}
|
|
22811
|
+
}
|
|
22812
|
+
}
|
|
22813
|
+
},
|
|
22814
|
+
"503": {
|
|
22815
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
22816
|
+
"headers": {
|
|
22817
|
+
"Content-Type": {
|
|
22818
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22819
|
+
},
|
|
22820
|
+
"RateLimit-Limit": {
|
|
22821
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22822
|
+
},
|
|
22823
|
+
"RateLimit-Remaining": {
|
|
22824
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22825
|
+
},
|
|
22826
|
+
"RateLimit-Reset": {
|
|
22827
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22828
|
+
},
|
|
22829
|
+
"RateLimit-Policy": {
|
|
22830
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22831
|
+
},
|
|
22832
|
+
"Idempotency-Key": {
|
|
22833
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22834
|
+
},
|
|
22835
|
+
"Idempotency-Replay": {
|
|
22836
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22837
|
+
},
|
|
22838
|
+
"Retry-After": {
|
|
22839
|
+
"$ref": "#/components/headers/Retry-After"
|
|
22840
|
+
}
|
|
22841
|
+
},
|
|
22842
|
+
"content": {
|
|
22843
|
+
"application/json": {
|
|
22844
|
+
"schema": {
|
|
22845
|
+
"type": "string",
|
|
22846
|
+
"example": "Please wait some time, then try again."
|
|
22847
|
+
}
|
|
22848
|
+
}
|
|
22849
|
+
}
|
|
22850
|
+
}
|
|
22851
|
+
},
|
|
22852
|
+
"tags": [
|
|
22853
|
+
"Topics"
|
|
22854
|
+
],
|
|
22855
|
+
"security": [
|
|
22856
|
+
{
|
|
22857
|
+
"secretKey": []
|
|
22858
|
+
}
|
|
22859
|
+
]
|
|
22860
|
+
},
|
|
22861
|
+
"get": {
|
|
22862
|
+
"operationId": "TopicsController_listTopics",
|
|
22863
|
+
"summary": "Get topic list filtered ",
|
|
22864
|
+
"description": "Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter",
|
|
22865
|
+
"parameters": [
|
|
22866
|
+
{
|
|
22867
|
+
"name": "page",
|
|
22868
|
+
"required": false,
|
|
22869
|
+
"in": "query",
|
|
22870
|
+
"example": 0,
|
|
22871
|
+
"description": "The page number to retrieve (starts from 0)",
|
|
22872
|
+
"schema": {
|
|
22873
|
+
"format": "int64",
|
|
22874
|
+
"default": 0,
|
|
22875
|
+
"type": "integer"
|
|
22876
|
+
}
|
|
22877
|
+
},
|
|
22878
|
+
{
|
|
22879
|
+
"name": "pageSize",
|
|
22880
|
+
"required": false,
|
|
22881
|
+
"in": "query",
|
|
22882
|
+
"example": 10,
|
|
22883
|
+
"description": "The number of items to return per page (default: 10)",
|
|
22884
|
+
"schema": {
|
|
22885
|
+
"format": "int64",
|
|
22886
|
+
"default": 10,
|
|
22887
|
+
"type": "integer"
|
|
22888
|
+
}
|
|
22889
|
+
},
|
|
22890
|
+
{
|
|
22891
|
+
"name": "key",
|
|
22892
|
+
"required": false,
|
|
22893
|
+
"in": "query",
|
|
22894
|
+
"example": "exampleKey",
|
|
22895
|
+
"description": "A filter key to apply to the results",
|
|
22896
|
+
"schema": {
|
|
22897
|
+
"type": "string"
|
|
22898
|
+
}
|
|
22899
|
+
},
|
|
22900
|
+
{
|
|
22901
|
+
"name": "idempotency-key",
|
|
22902
|
+
"in": "header",
|
|
22903
|
+
"description": "A header for idempotency purposes",
|
|
22904
|
+
"required": false,
|
|
22905
|
+
"schema": {
|
|
22906
|
+
"type": "string"
|
|
22907
|
+
}
|
|
22908
|
+
}
|
|
22909
|
+
],
|
|
22910
|
+
"responses": {
|
|
22911
|
+
"200": {
|
|
22912
|
+
"headers": {
|
|
22913
|
+
"Content-Type": {
|
|
22914
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22915
|
+
},
|
|
22916
|
+
"RateLimit-Limit": {
|
|
22917
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22918
|
+
},
|
|
22919
|
+
"RateLimit-Remaining": {
|
|
22920
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22921
|
+
},
|
|
22922
|
+
"RateLimit-Reset": {
|
|
22923
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22924
|
+
},
|
|
22925
|
+
"RateLimit-Policy": {
|
|
22926
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22927
|
+
},
|
|
22928
|
+
"Idempotency-Key": {
|
|
22929
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22930
|
+
},
|
|
22931
|
+
"Idempotency-Replay": {
|
|
22932
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22933
|
+
}
|
|
22934
|
+
},
|
|
22935
|
+
"description": "",
|
|
22936
|
+
"content": {
|
|
22937
|
+
"application/json": {
|
|
22938
|
+
"schema": {
|
|
22939
|
+
"$ref": "#/components/schemas/FilterTopicsResponseDto"
|
|
22940
|
+
}
|
|
22941
|
+
}
|
|
22942
|
+
}
|
|
22943
|
+
},
|
|
22944
|
+
"400": {
|
|
22945
|
+
"description": "Bad Request",
|
|
22946
|
+
"headers": {
|
|
22947
|
+
"Content-Type": {
|
|
22948
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22949
|
+
},
|
|
22950
|
+
"RateLimit-Limit": {
|
|
22951
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22952
|
+
},
|
|
22953
|
+
"RateLimit-Remaining": {
|
|
22954
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22955
|
+
},
|
|
22956
|
+
"RateLimit-Reset": {
|
|
22957
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22958
|
+
},
|
|
22959
|
+
"RateLimit-Policy": {
|
|
22960
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22961
|
+
},
|
|
22962
|
+
"Idempotency-Key": {
|
|
22963
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22964
|
+
},
|
|
22965
|
+
"Idempotency-Replay": {
|
|
22966
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
22967
|
+
}
|
|
22968
|
+
},
|
|
22969
|
+
"content": {
|
|
22970
|
+
"application/json": {
|
|
22971
|
+
"schema": {
|
|
22972
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
22973
|
+
}
|
|
22974
|
+
}
|
|
22975
|
+
}
|
|
22976
|
+
},
|
|
22977
|
+
"401": {
|
|
22978
|
+
"description": "Unauthorized",
|
|
22979
|
+
"headers": {
|
|
22980
|
+
"Content-Type": {
|
|
22981
|
+
"$ref": "#/components/headers/Content-Type"
|
|
22982
|
+
},
|
|
22983
|
+
"RateLimit-Limit": {
|
|
22984
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
22985
|
+
},
|
|
22986
|
+
"RateLimit-Remaining": {
|
|
22987
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
22988
|
+
},
|
|
22989
|
+
"RateLimit-Reset": {
|
|
22990
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
22991
|
+
},
|
|
22992
|
+
"RateLimit-Policy": {
|
|
22993
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
22994
|
+
},
|
|
22995
|
+
"Idempotency-Key": {
|
|
22996
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
22997
|
+
},
|
|
22998
|
+
"Idempotency-Replay": {
|
|
22999
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23000
|
+
}
|
|
23001
|
+
},
|
|
23002
|
+
"content": {
|
|
23003
|
+
"application/json": {
|
|
23004
|
+
"schema": {
|
|
23005
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23006
|
+
}
|
|
23007
|
+
}
|
|
23008
|
+
}
|
|
23009
|
+
},
|
|
23010
|
+
"403": {
|
|
23011
|
+
"description": "Forbidden",
|
|
23012
|
+
"headers": {
|
|
23013
|
+
"Content-Type": {
|
|
23014
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23015
|
+
},
|
|
23016
|
+
"RateLimit-Limit": {
|
|
23017
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23018
|
+
},
|
|
23019
|
+
"RateLimit-Remaining": {
|
|
23020
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23021
|
+
},
|
|
23022
|
+
"RateLimit-Reset": {
|
|
23023
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23024
|
+
},
|
|
23025
|
+
"RateLimit-Policy": {
|
|
23026
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23027
|
+
},
|
|
23028
|
+
"Idempotency-Key": {
|
|
23029
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23030
|
+
},
|
|
23031
|
+
"Idempotency-Replay": {
|
|
23032
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23033
|
+
}
|
|
23034
|
+
},
|
|
23035
|
+
"content": {
|
|
23036
|
+
"application/json": {
|
|
23037
|
+
"schema": {
|
|
23038
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23039
|
+
}
|
|
23040
|
+
}
|
|
23041
|
+
}
|
|
23042
|
+
},
|
|
23043
|
+
"404": {
|
|
23044
|
+
"description": "Not Found",
|
|
23045
|
+
"headers": {
|
|
23046
|
+
"Content-Type": {
|
|
23047
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23048
|
+
},
|
|
23049
|
+
"RateLimit-Limit": {
|
|
23050
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23051
|
+
},
|
|
23052
|
+
"RateLimit-Remaining": {
|
|
23053
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23054
|
+
},
|
|
23055
|
+
"RateLimit-Reset": {
|
|
23056
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23057
|
+
},
|
|
23058
|
+
"RateLimit-Policy": {
|
|
23059
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23060
|
+
},
|
|
23061
|
+
"Idempotency-Key": {
|
|
23062
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23063
|
+
},
|
|
23064
|
+
"Idempotency-Replay": {
|
|
23065
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23066
|
+
}
|
|
23067
|
+
},
|
|
23068
|
+
"content": {
|
|
23069
|
+
"application/json": {
|
|
23070
|
+
"schema": {
|
|
23071
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23072
|
+
}
|
|
23073
|
+
}
|
|
23074
|
+
}
|
|
23075
|
+
},
|
|
23076
|
+
"405": {
|
|
23077
|
+
"description": "Method Not Allowed",
|
|
23078
|
+
"headers": {
|
|
23079
|
+
"Content-Type": {
|
|
23080
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23081
|
+
},
|
|
23082
|
+
"RateLimit-Limit": {
|
|
23083
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23084
|
+
},
|
|
23085
|
+
"RateLimit-Remaining": {
|
|
23086
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23087
|
+
},
|
|
23088
|
+
"RateLimit-Reset": {
|
|
23089
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23090
|
+
},
|
|
23091
|
+
"RateLimit-Policy": {
|
|
23092
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23093
|
+
},
|
|
23094
|
+
"Idempotency-Key": {
|
|
23095
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23096
|
+
},
|
|
23097
|
+
"Idempotency-Replay": {
|
|
23098
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23099
|
+
}
|
|
23100
|
+
},
|
|
23101
|
+
"content": {
|
|
23102
|
+
"application/json": {
|
|
23103
|
+
"schema": {
|
|
23104
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23105
|
+
}
|
|
23106
|
+
}
|
|
23107
|
+
}
|
|
23108
|
+
},
|
|
23109
|
+
"409": {
|
|
23110
|
+
"description": "Conflict",
|
|
23111
|
+
"headers": {
|
|
23112
|
+
"Content-Type": {
|
|
23113
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23114
|
+
},
|
|
23115
|
+
"RateLimit-Limit": {
|
|
23116
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23117
|
+
},
|
|
23118
|
+
"RateLimit-Remaining": {
|
|
23119
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23120
|
+
},
|
|
23121
|
+
"RateLimit-Reset": {
|
|
23122
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23123
|
+
},
|
|
23124
|
+
"RateLimit-Policy": {
|
|
23125
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23126
|
+
},
|
|
23127
|
+
"Idempotency-Key": {
|
|
23128
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23129
|
+
},
|
|
23130
|
+
"Idempotency-Replay": {
|
|
23131
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23132
|
+
}
|
|
23133
|
+
},
|
|
23134
|
+
"content": {
|
|
23135
|
+
"application/json": {
|
|
23136
|
+
"schema": {
|
|
23137
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23138
|
+
}
|
|
23139
|
+
}
|
|
23140
|
+
}
|
|
23141
|
+
},
|
|
23142
|
+
"413": {
|
|
23143
|
+
"description": "Payload Too Large",
|
|
23144
|
+
"headers": {
|
|
23145
|
+
"Content-Type": {
|
|
23146
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23147
|
+
},
|
|
23148
|
+
"RateLimit-Limit": {
|
|
23149
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23150
|
+
},
|
|
23151
|
+
"RateLimit-Remaining": {
|
|
23152
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23153
|
+
},
|
|
23154
|
+
"RateLimit-Reset": {
|
|
23155
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23156
|
+
},
|
|
23157
|
+
"RateLimit-Policy": {
|
|
23158
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23159
|
+
},
|
|
23160
|
+
"Idempotency-Key": {
|
|
23161
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23162
|
+
},
|
|
23163
|
+
"Idempotency-Replay": {
|
|
23164
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23165
|
+
}
|
|
23166
|
+
},
|
|
23167
|
+
"content": {
|
|
23168
|
+
"application/json": {
|
|
23169
|
+
"schema": {
|
|
23170
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23171
|
+
}
|
|
23172
|
+
}
|
|
23173
|
+
}
|
|
23174
|
+
},
|
|
23175
|
+
"414": {
|
|
23176
|
+
"description": "URI Too Long",
|
|
23177
|
+
"content": {
|
|
23178
|
+
"application/json": {
|
|
23179
|
+
"schema": {
|
|
23180
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23181
|
+
}
|
|
23182
|
+
}
|
|
23183
|
+
}
|
|
23184
|
+
},
|
|
23185
|
+
"415": {
|
|
23186
|
+
"description": "Unsupported Media Type",
|
|
23187
|
+
"headers": {
|
|
23188
|
+
"Content-Type": {
|
|
23189
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23190
|
+
},
|
|
23191
|
+
"RateLimit-Limit": {
|
|
23192
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23193
|
+
},
|
|
23194
|
+
"RateLimit-Remaining": {
|
|
23195
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23196
|
+
},
|
|
23197
|
+
"RateLimit-Reset": {
|
|
23198
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23199
|
+
},
|
|
23200
|
+
"RateLimit-Policy": {
|
|
23201
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23202
|
+
},
|
|
23203
|
+
"Idempotency-Key": {
|
|
23204
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23205
|
+
},
|
|
23206
|
+
"Idempotency-Replay": {
|
|
23207
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23208
|
+
}
|
|
23209
|
+
},
|
|
23210
|
+
"content": {
|
|
23211
|
+
"application/json": {
|
|
23212
|
+
"schema": {
|
|
23213
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23214
|
+
}
|
|
23215
|
+
}
|
|
23216
|
+
}
|
|
23217
|
+
},
|
|
23218
|
+
"422": {
|
|
23219
|
+
"description": "Unprocessable Entity",
|
|
23220
|
+
"headers": {
|
|
23221
|
+
"Content-Type": {
|
|
23222
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23223
|
+
},
|
|
23224
|
+
"RateLimit-Limit": {
|
|
23225
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23226
|
+
},
|
|
23227
|
+
"RateLimit-Remaining": {
|
|
23228
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23229
|
+
},
|
|
23230
|
+
"RateLimit-Reset": {
|
|
23231
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23232
|
+
},
|
|
23233
|
+
"RateLimit-Policy": {
|
|
23234
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23235
|
+
},
|
|
23236
|
+
"Idempotency-Key": {
|
|
23237
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23238
|
+
},
|
|
23239
|
+
"Idempotency-Replay": {
|
|
23240
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23241
|
+
}
|
|
23242
|
+
},
|
|
23243
|
+
"content": {
|
|
23244
|
+
"application/json": {
|
|
23245
|
+
"schema": {
|
|
23246
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
23247
|
+
}
|
|
23248
|
+
}
|
|
23249
|
+
}
|
|
23250
|
+
},
|
|
23251
|
+
"429": {
|
|
23252
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
23253
|
+
"headers": {
|
|
23254
|
+
"Content-Type": {
|
|
23255
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23256
|
+
},
|
|
23257
|
+
"RateLimit-Limit": {
|
|
23258
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23259
|
+
},
|
|
23260
|
+
"RateLimit-Remaining": {
|
|
23261
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23262
|
+
},
|
|
23263
|
+
"RateLimit-Reset": {
|
|
23264
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23265
|
+
},
|
|
23266
|
+
"RateLimit-Policy": {
|
|
23267
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23268
|
+
},
|
|
23269
|
+
"Idempotency-Key": {
|
|
23270
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23271
|
+
},
|
|
23272
|
+
"Idempotency-Replay": {
|
|
23273
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23274
|
+
},
|
|
23275
|
+
"Retry-After": {
|
|
23276
|
+
"$ref": "#/components/headers/Retry-After"
|
|
23277
|
+
}
|
|
23278
|
+
},
|
|
23279
|
+
"content": {
|
|
23280
|
+
"application/json": {
|
|
23281
|
+
"schema": {
|
|
23282
|
+
"type": "string",
|
|
23283
|
+
"example": "API rate limit exceeded"
|
|
23284
|
+
}
|
|
23285
|
+
}
|
|
23286
|
+
}
|
|
23287
|
+
},
|
|
23288
|
+
"500": {
|
|
23289
|
+
"description": "Internal Server Error",
|
|
23290
|
+
"headers": {
|
|
23291
|
+
"Content-Type": {
|
|
23292
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23293
|
+
},
|
|
23294
|
+
"RateLimit-Limit": {
|
|
23295
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23296
|
+
},
|
|
23297
|
+
"RateLimit-Remaining": {
|
|
23298
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23299
|
+
},
|
|
23300
|
+
"RateLimit-Reset": {
|
|
23301
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23302
|
+
},
|
|
23303
|
+
"RateLimit-Policy": {
|
|
23304
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23305
|
+
},
|
|
23306
|
+
"Idempotency-Key": {
|
|
23307
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23308
|
+
},
|
|
23309
|
+
"Idempotency-Replay": {
|
|
23310
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23311
|
+
}
|
|
23312
|
+
},
|
|
23313
|
+
"content": {
|
|
23314
|
+
"application/json": {
|
|
23315
|
+
"schema": {
|
|
23316
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23317
|
+
}
|
|
23318
|
+
}
|
|
23319
|
+
}
|
|
23320
|
+
},
|
|
23321
|
+
"503": {
|
|
23322
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
23323
|
+
"headers": {
|
|
23324
|
+
"Content-Type": {
|
|
23325
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23326
|
+
},
|
|
23327
|
+
"RateLimit-Limit": {
|
|
23328
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23329
|
+
},
|
|
23330
|
+
"RateLimit-Remaining": {
|
|
23331
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23332
|
+
},
|
|
23333
|
+
"RateLimit-Reset": {
|
|
23334
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23335
|
+
},
|
|
23336
|
+
"RateLimit-Policy": {
|
|
23337
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23338
|
+
},
|
|
23339
|
+
"Idempotency-Key": {
|
|
23340
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23341
|
+
},
|
|
23342
|
+
"Idempotency-Replay": {
|
|
23343
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23344
|
+
},
|
|
23345
|
+
"Retry-After": {
|
|
23346
|
+
"$ref": "#/components/headers/Retry-After"
|
|
23347
|
+
}
|
|
23348
|
+
},
|
|
23349
|
+
"content": {
|
|
23350
|
+
"application/json": {
|
|
23351
|
+
"schema": {
|
|
23352
|
+
"type": "string",
|
|
23353
|
+
"example": "Please wait some time, then try again."
|
|
23354
|
+
}
|
|
23355
|
+
}
|
|
23356
|
+
}
|
|
23357
|
+
}
|
|
23358
|
+
},
|
|
23359
|
+
"tags": [
|
|
23360
|
+
"Topics"
|
|
23361
|
+
],
|
|
23362
|
+
"security": [
|
|
23363
|
+
{
|
|
23364
|
+
"secretKey": []
|
|
23365
|
+
}
|
|
23366
|
+
]
|
|
23367
|
+
}
|
|
23368
|
+
},
|
|
23369
|
+
"/v1/topics/{topicKey}/subscribers": {
|
|
23370
|
+
"post": {
|
|
23371
|
+
"operationId": "TopicsController_assign",
|
|
23372
|
+
"x-speakeasy-name-override": "assign",
|
|
23373
|
+
"x-speakeasy-group": "Topics.Subscribers",
|
|
23374
|
+
"summary": "Subscribers addition",
|
|
23375
|
+
"description": "Add subscribers to a topic by key",
|
|
23376
|
+
"parameters": [
|
|
23377
|
+
{
|
|
23378
|
+
"name": "topicKey",
|
|
23379
|
+
"required": true,
|
|
23380
|
+
"in": "path",
|
|
23381
|
+
"description": "The topic key",
|
|
23382
|
+
"schema": {
|
|
23383
|
+
"type": "string"
|
|
23384
|
+
}
|
|
23385
|
+
},
|
|
23386
|
+
{
|
|
23387
|
+
"name": "idempotency-key",
|
|
23388
|
+
"in": "header",
|
|
23389
|
+
"description": "A header for idempotency purposes",
|
|
23390
|
+
"required": false,
|
|
23391
|
+
"schema": {
|
|
23392
|
+
"type": "string"
|
|
23393
|
+
}
|
|
23394
|
+
}
|
|
23395
|
+
],
|
|
23396
|
+
"requestBody": {
|
|
23397
|
+
"required": true,
|
|
23398
|
+
"content": {
|
|
23399
|
+
"application/json": {
|
|
23400
|
+
"schema": {
|
|
23401
|
+
"$ref": "#/components/schemas/AddSubscribersRequestDto"
|
|
23402
|
+
}
|
|
23403
|
+
}
|
|
23404
|
+
}
|
|
23405
|
+
},
|
|
23406
|
+
"responses": {
|
|
23407
|
+
"200": {
|
|
23408
|
+
"headers": {
|
|
23409
|
+
"Content-Type": {
|
|
23410
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23411
|
+
},
|
|
23412
|
+
"RateLimit-Limit": {
|
|
23413
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23414
|
+
},
|
|
23415
|
+
"RateLimit-Remaining": {
|
|
23416
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23417
|
+
},
|
|
23418
|
+
"RateLimit-Reset": {
|
|
23419
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23420
|
+
},
|
|
23421
|
+
"RateLimit-Policy": {
|
|
23422
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23423
|
+
},
|
|
23424
|
+
"Idempotency-Key": {
|
|
23425
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23426
|
+
},
|
|
23427
|
+
"Idempotency-Replay": {
|
|
23428
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23429
|
+
}
|
|
23430
|
+
},
|
|
23431
|
+
"description": "",
|
|
23432
|
+
"content": {
|
|
23433
|
+
"application/json": {
|
|
23434
|
+
"schema": {
|
|
23435
|
+
"$ref": "#/components/schemas/AssignSubscriberToTopicDto"
|
|
23436
|
+
}
|
|
23437
|
+
}
|
|
23438
|
+
}
|
|
23439
|
+
},
|
|
23440
|
+
"400": {
|
|
23441
|
+
"description": "Bad Request",
|
|
23442
|
+
"headers": {
|
|
23443
|
+
"Content-Type": {
|
|
23444
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23445
|
+
},
|
|
23446
|
+
"RateLimit-Limit": {
|
|
23447
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23448
|
+
},
|
|
23449
|
+
"RateLimit-Remaining": {
|
|
23450
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23451
|
+
},
|
|
23452
|
+
"RateLimit-Reset": {
|
|
23453
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23454
|
+
},
|
|
23455
|
+
"RateLimit-Policy": {
|
|
23456
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23457
|
+
},
|
|
23458
|
+
"Idempotency-Key": {
|
|
23459
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23460
|
+
},
|
|
23461
|
+
"Idempotency-Replay": {
|
|
23462
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23463
|
+
}
|
|
23464
|
+
},
|
|
23465
|
+
"content": {
|
|
23466
|
+
"application/json": {
|
|
23467
|
+
"schema": {
|
|
23468
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23469
|
+
}
|
|
23470
|
+
}
|
|
23471
|
+
}
|
|
23472
|
+
},
|
|
23473
|
+
"401": {
|
|
23474
|
+
"description": "Unauthorized",
|
|
23475
|
+
"headers": {
|
|
23476
|
+
"Content-Type": {
|
|
23477
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23478
|
+
},
|
|
23479
|
+
"RateLimit-Limit": {
|
|
23480
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23481
|
+
},
|
|
23482
|
+
"RateLimit-Remaining": {
|
|
23483
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23484
|
+
},
|
|
23485
|
+
"RateLimit-Reset": {
|
|
23486
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23487
|
+
},
|
|
23488
|
+
"RateLimit-Policy": {
|
|
23489
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23490
|
+
},
|
|
23491
|
+
"Idempotency-Key": {
|
|
23492
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23493
|
+
},
|
|
23494
|
+
"Idempotency-Replay": {
|
|
23495
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23496
|
+
}
|
|
23497
|
+
},
|
|
23498
|
+
"content": {
|
|
23499
|
+
"application/json": {
|
|
23500
|
+
"schema": {
|
|
23501
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23502
|
+
}
|
|
23503
|
+
}
|
|
23504
|
+
}
|
|
23505
|
+
},
|
|
23506
|
+
"403": {
|
|
23507
|
+
"description": "Forbidden",
|
|
23508
|
+
"headers": {
|
|
23509
|
+
"Content-Type": {
|
|
23510
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23511
|
+
},
|
|
23512
|
+
"RateLimit-Limit": {
|
|
23513
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23514
|
+
},
|
|
23515
|
+
"RateLimit-Remaining": {
|
|
23516
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23517
|
+
},
|
|
23518
|
+
"RateLimit-Reset": {
|
|
23519
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23520
|
+
},
|
|
23521
|
+
"RateLimit-Policy": {
|
|
23522
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23523
|
+
},
|
|
23524
|
+
"Idempotency-Key": {
|
|
23525
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23526
|
+
},
|
|
23527
|
+
"Idempotency-Replay": {
|
|
23528
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23529
|
+
}
|
|
23530
|
+
},
|
|
23531
|
+
"content": {
|
|
23532
|
+
"application/json": {
|
|
23533
|
+
"schema": {
|
|
23534
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23535
|
+
}
|
|
23536
|
+
}
|
|
23537
|
+
}
|
|
23538
|
+
},
|
|
23539
|
+
"404": {
|
|
23540
|
+
"description": "Not Found",
|
|
23541
|
+
"headers": {
|
|
23542
|
+
"Content-Type": {
|
|
23543
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23544
|
+
},
|
|
23545
|
+
"RateLimit-Limit": {
|
|
23546
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23547
|
+
},
|
|
23548
|
+
"RateLimit-Remaining": {
|
|
23549
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23550
|
+
},
|
|
23551
|
+
"RateLimit-Reset": {
|
|
23552
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23553
|
+
},
|
|
23554
|
+
"RateLimit-Policy": {
|
|
23555
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23556
|
+
},
|
|
23557
|
+
"Idempotency-Key": {
|
|
23558
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23559
|
+
},
|
|
23560
|
+
"Idempotency-Replay": {
|
|
23561
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23562
|
+
}
|
|
23563
|
+
},
|
|
23564
|
+
"content": {
|
|
23565
|
+
"application/json": {
|
|
23566
|
+
"schema": {
|
|
23567
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23568
|
+
}
|
|
23569
|
+
}
|
|
23570
|
+
}
|
|
23571
|
+
},
|
|
23572
|
+
"405": {
|
|
23573
|
+
"description": "Method Not Allowed",
|
|
23574
|
+
"headers": {
|
|
23575
|
+
"Content-Type": {
|
|
23576
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23577
|
+
},
|
|
23578
|
+
"RateLimit-Limit": {
|
|
23579
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23580
|
+
},
|
|
23581
|
+
"RateLimit-Remaining": {
|
|
23582
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23583
|
+
},
|
|
23584
|
+
"RateLimit-Reset": {
|
|
23585
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23586
|
+
},
|
|
23587
|
+
"RateLimit-Policy": {
|
|
23588
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23589
|
+
},
|
|
23590
|
+
"Idempotency-Key": {
|
|
23591
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23592
|
+
},
|
|
23593
|
+
"Idempotency-Replay": {
|
|
23594
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23595
|
+
}
|
|
23596
|
+
},
|
|
23597
|
+
"content": {
|
|
23598
|
+
"application/json": {
|
|
23599
|
+
"schema": {
|
|
23600
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23601
|
+
}
|
|
23602
|
+
}
|
|
23603
|
+
}
|
|
23604
|
+
},
|
|
23605
|
+
"409": {
|
|
23606
|
+
"description": "Conflict",
|
|
23607
|
+
"headers": {
|
|
23608
|
+
"Content-Type": {
|
|
23609
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23610
|
+
},
|
|
23611
|
+
"RateLimit-Limit": {
|
|
23612
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23613
|
+
},
|
|
23614
|
+
"RateLimit-Remaining": {
|
|
23615
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23616
|
+
},
|
|
23617
|
+
"RateLimit-Reset": {
|
|
23618
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23619
|
+
},
|
|
23620
|
+
"RateLimit-Policy": {
|
|
23621
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23622
|
+
},
|
|
23623
|
+
"Idempotency-Key": {
|
|
23624
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23625
|
+
},
|
|
23626
|
+
"Idempotency-Replay": {
|
|
23627
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23628
|
+
}
|
|
23629
|
+
},
|
|
23630
|
+
"content": {
|
|
23631
|
+
"application/json": {
|
|
23632
|
+
"schema": {
|
|
23633
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23634
|
+
}
|
|
23635
|
+
}
|
|
23636
|
+
}
|
|
23637
|
+
},
|
|
23638
|
+
"413": {
|
|
23639
|
+
"description": "Payload Too Large",
|
|
23640
|
+
"headers": {
|
|
23641
|
+
"Content-Type": {
|
|
23642
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23643
|
+
},
|
|
23644
|
+
"RateLimit-Limit": {
|
|
23645
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23646
|
+
},
|
|
23647
|
+
"RateLimit-Remaining": {
|
|
23648
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23649
|
+
},
|
|
23650
|
+
"RateLimit-Reset": {
|
|
23651
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23652
|
+
},
|
|
23653
|
+
"RateLimit-Policy": {
|
|
23654
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23655
|
+
},
|
|
23656
|
+
"Idempotency-Key": {
|
|
23657
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23658
|
+
},
|
|
23659
|
+
"Idempotency-Replay": {
|
|
23660
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23661
|
+
}
|
|
23662
|
+
},
|
|
23663
|
+
"content": {
|
|
23664
|
+
"application/json": {
|
|
23665
|
+
"schema": {
|
|
23666
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23667
|
+
}
|
|
23668
|
+
}
|
|
23669
|
+
}
|
|
23670
|
+
},
|
|
23671
|
+
"414": {
|
|
23672
|
+
"description": "URI Too Long",
|
|
23673
|
+
"content": {
|
|
23674
|
+
"application/json": {
|
|
23675
|
+
"schema": {
|
|
23676
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23677
|
+
}
|
|
23678
|
+
}
|
|
23679
|
+
}
|
|
23680
|
+
},
|
|
23681
|
+
"415": {
|
|
23682
|
+
"description": "Unsupported Media Type",
|
|
23683
|
+
"headers": {
|
|
23684
|
+
"Content-Type": {
|
|
23685
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23686
|
+
},
|
|
23687
|
+
"RateLimit-Limit": {
|
|
23688
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23689
|
+
},
|
|
23690
|
+
"RateLimit-Remaining": {
|
|
23691
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23692
|
+
},
|
|
23693
|
+
"RateLimit-Reset": {
|
|
23694
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23695
|
+
},
|
|
23696
|
+
"RateLimit-Policy": {
|
|
23697
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23698
|
+
},
|
|
23699
|
+
"Idempotency-Key": {
|
|
23700
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23701
|
+
},
|
|
23702
|
+
"Idempotency-Replay": {
|
|
23703
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23704
|
+
}
|
|
23705
|
+
},
|
|
23706
|
+
"content": {
|
|
23707
|
+
"application/json": {
|
|
23708
|
+
"schema": {
|
|
23709
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23710
|
+
}
|
|
23711
|
+
}
|
|
23712
|
+
}
|
|
23713
|
+
},
|
|
23714
|
+
"422": {
|
|
23715
|
+
"description": "Unprocessable Entity",
|
|
23716
|
+
"headers": {
|
|
23717
|
+
"Content-Type": {
|
|
23718
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23719
|
+
},
|
|
23720
|
+
"RateLimit-Limit": {
|
|
23721
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23722
|
+
},
|
|
23723
|
+
"RateLimit-Remaining": {
|
|
23724
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23725
|
+
},
|
|
23726
|
+
"RateLimit-Reset": {
|
|
23727
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23728
|
+
},
|
|
23729
|
+
"RateLimit-Policy": {
|
|
23730
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23731
|
+
},
|
|
23732
|
+
"Idempotency-Key": {
|
|
23733
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23734
|
+
},
|
|
23735
|
+
"Idempotency-Replay": {
|
|
23736
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23737
|
+
}
|
|
23738
|
+
},
|
|
23739
|
+
"content": {
|
|
23740
|
+
"application/json": {
|
|
23741
|
+
"schema": {
|
|
23742
|
+
"$ref": "#/components/schemas/ValidationErrorDto"
|
|
23743
|
+
}
|
|
23744
|
+
}
|
|
23745
|
+
}
|
|
23746
|
+
},
|
|
23747
|
+
"429": {
|
|
23748
|
+
"description": "The client has sent too many requests in a given amount of time. ",
|
|
23749
|
+
"headers": {
|
|
23750
|
+
"Content-Type": {
|
|
23751
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23752
|
+
},
|
|
23753
|
+
"RateLimit-Limit": {
|
|
23754
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23755
|
+
},
|
|
23756
|
+
"RateLimit-Remaining": {
|
|
23757
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23758
|
+
},
|
|
23759
|
+
"RateLimit-Reset": {
|
|
23760
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23761
|
+
},
|
|
23762
|
+
"RateLimit-Policy": {
|
|
23763
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23764
|
+
},
|
|
23765
|
+
"Idempotency-Key": {
|
|
23766
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23767
|
+
},
|
|
23768
|
+
"Idempotency-Replay": {
|
|
23769
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23770
|
+
},
|
|
23771
|
+
"Retry-After": {
|
|
23772
|
+
"$ref": "#/components/headers/Retry-After"
|
|
23773
|
+
}
|
|
23774
|
+
},
|
|
23775
|
+
"content": {
|
|
23776
|
+
"application/json": {
|
|
23777
|
+
"schema": {
|
|
23778
|
+
"type": "string",
|
|
23779
|
+
"example": "API rate limit exceeded"
|
|
23780
|
+
}
|
|
23781
|
+
}
|
|
23782
|
+
}
|
|
23783
|
+
},
|
|
23784
|
+
"500": {
|
|
23785
|
+
"description": "Internal Server Error",
|
|
23786
|
+
"headers": {
|
|
23787
|
+
"Content-Type": {
|
|
23788
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23789
|
+
},
|
|
23790
|
+
"RateLimit-Limit": {
|
|
23791
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23792
|
+
},
|
|
23793
|
+
"RateLimit-Remaining": {
|
|
23794
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23795
|
+
},
|
|
23796
|
+
"RateLimit-Reset": {
|
|
23797
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23798
|
+
},
|
|
23799
|
+
"RateLimit-Policy": {
|
|
23800
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23801
|
+
},
|
|
23802
|
+
"Idempotency-Key": {
|
|
23803
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23804
|
+
},
|
|
23805
|
+
"Idempotency-Replay": {
|
|
23806
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23807
|
+
}
|
|
23808
|
+
},
|
|
23809
|
+
"content": {
|
|
23810
|
+
"application/json": {
|
|
23811
|
+
"schema": {
|
|
23812
|
+
"$ref": "#/components/schemas/ErrorDto"
|
|
23813
|
+
}
|
|
23814
|
+
}
|
|
23815
|
+
}
|
|
23816
|
+
},
|
|
23817
|
+
"503": {
|
|
23818
|
+
"description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
|
|
23819
|
+
"headers": {
|
|
23820
|
+
"Content-Type": {
|
|
23821
|
+
"$ref": "#/components/headers/Content-Type"
|
|
23822
|
+
},
|
|
23823
|
+
"RateLimit-Limit": {
|
|
23824
|
+
"$ref": "#/components/headers/RateLimit-Limit"
|
|
23825
|
+
},
|
|
23826
|
+
"RateLimit-Remaining": {
|
|
23827
|
+
"$ref": "#/components/headers/RateLimit-Remaining"
|
|
23828
|
+
},
|
|
23829
|
+
"RateLimit-Reset": {
|
|
23830
|
+
"$ref": "#/components/headers/RateLimit-Reset"
|
|
23831
|
+
},
|
|
23832
|
+
"RateLimit-Policy": {
|
|
23833
|
+
"$ref": "#/components/headers/RateLimit-Policy"
|
|
23834
|
+
},
|
|
23835
|
+
"Idempotency-Key": {
|
|
23836
|
+
"$ref": "#/components/headers/Idempotency-Key"
|
|
23837
|
+
},
|
|
23838
|
+
"Idempotency-Replay": {
|
|
23839
|
+
"$ref": "#/components/headers/Idempotency-Replay"
|
|
23840
|
+
},
|
|
23841
|
+
"Retry-After": {
|
|
23842
|
+
"$ref": "#/components/headers/Retry-After"
|
|
23843
|
+
}
|
|
23844
|
+
},
|
|
23845
|
+
"content": {
|
|
23846
|
+
"application/json": {
|
|
23847
|
+
"schema": {
|
|
23848
|
+
"type": "string",
|
|
23849
|
+
"example": "Please wait some time, then try again."
|
|
23850
|
+
}
|
|
23851
|
+
}
|
|
23852
|
+
}
|
|
23853
|
+
}
|
|
23854
|
+
},
|
|
23855
|
+
"tags": [
|
|
23856
|
+
"Topics"
|
|
23857
|
+
],
|
|
23858
|
+
"security": [
|
|
23859
|
+
{
|
|
23860
|
+
"secretKey": []
|
|
23861
|
+
}
|
|
23862
|
+
]
|
|
23863
|
+
}
|
|
23864
|
+
},
|
|
23865
|
+
"/v1/topics/{topicKey}/subscribers/{externalSubscriberId}": {
|
|
23866
|
+
"get": {
|
|
23867
|
+
"operationId": "TopicsController_getTopicSubscriber",
|
|
23868
|
+
"x-speakeasy-group": "Topics.Subscribers",
|
|
23869
|
+
"summary": "Check topic subscriber",
|
|
23870
|
+
"description": "Check if a subscriber belongs to a certain topic",
|
|
23871
|
+
"parameters": [
|
|
23872
|
+
{
|
|
23873
|
+
"name": "externalSubscriberId",
|
|
23874
|
+
"required": true,
|
|
23875
|
+
"in": "path",
|
|
23876
|
+
"description": "The external subscriber id",
|
|
23877
|
+
"schema": {
|
|
23878
|
+
"type": "string"
|
|
23879
|
+
}
|
|
23880
|
+
},
|
|
23881
|
+
{
|
|
23882
|
+
"name": "topicKey",
|
|
23883
|
+
"required": true,
|
|
23884
|
+
"in": "path",
|
|
23885
|
+
"description": "The topic key",
|
|
23886
|
+
"schema": {
|
|
23887
|
+
"type": "string"
|
|
23888
|
+
}
|
|
23889
|
+
},
|
|
23890
|
+
{
|
|
23891
|
+
"name": "idempotency-key",
|
|
23892
|
+
"in": "header",
|
|
23893
|
+
"description": "A header for idempotency purposes",
|
|
23894
|
+
"required": false,
|
|
23895
|
+
"schema": {
|
|
23896
|
+
"type": "string"
|
|
20902
23897
|
}
|
|
20903
23898
|
}
|
|
20904
23899
|
],
|
|
@@ -21356,7 +24351,7 @@
|
|
|
21356
24351
|
],
|
|
21357
24352
|
"security": [
|
|
21358
24353
|
{
|
|
21359
|
-
"
|
|
24354
|
+
"secretKey": []
|
|
21360
24355
|
}
|
|
21361
24356
|
]
|
|
21362
24357
|
}
|
|
@@ -21845,7 +24840,7 @@
|
|
|
21845
24840
|
],
|
|
21846
24841
|
"security": [
|
|
21847
24842
|
{
|
|
21848
|
-
"
|
|
24843
|
+
"secretKey": []
|
|
21849
24844
|
}
|
|
21850
24845
|
]
|
|
21851
24846
|
}
|
|
@@ -22322,7 +25317,7 @@
|
|
|
22322
25317
|
],
|
|
22323
25318
|
"security": [
|
|
22324
25319
|
{
|
|
22325
|
-
"
|
|
25320
|
+
"secretKey": []
|
|
22326
25321
|
}
|
|
22327
25322
|
]
|
|
22328
25323
|
},
|
|
@@ -22804,7 +25799,7 @@
|
|
|
22804
25799
|
],
|
|
22805
25800
|
"security": [
|
|
22806
25801
|
{
|
|
22807
|
-
"
|
|
25802
|
+
"secretKey": []
|
|
22808
25803
|
}
|
|
22809
25804
|
]
|
|
22810
25805
|
},
|
|
@@ -23297,79 +26292,10 @@
|
|
|
23297
26292
|
],
|
|
23298
26293
|
"security": [
|
|
23299
26294
|
{
|
|
23300
|
-
"
|
|
26295
|
+
"secretKey": []
|
|
23301
26296
|
}
|
|
23302
26297
|
]
|
|
23303
26298
|
}
|
|
23304
|
-
},
|
|
23305
|
-
"/v1/support/user-organizations": {
|
|
23306
|
-
"post": {
|
|
23307
|
-
"operationId": "SupportController_fetchUserOrganizations",
|
|
23308
|
-
"parameters": [
|
|
23309
|
-
{
|
|
23310
|
-
"name": "idempotency-key",
|
|
23311
|
-
"in": "header",
|
|
23312
|
-
"description": "A header for idempotency purposes",
|
|
23313
|
-
"required": false,
|
|
23314
|
-
"schema": {
|
|
23315
|
-
"type": "string"
|
|
23316
|
-
}
|
|
23317
|
-
}
|
|
23318
|
-
],
|
|
23319
|
-
"requestBody": {
|
|
23320
|
-
"required": true,
|
|
23321
|
-
"content": {
|
|
23322
|
-
"application/json": {
|
|
23323
|
-
"schema": {
|
|
23324
|
-
"$ref": "#/components/schemas/PlainCardRequestDto"
|
|
23325
|
-
}
|
|
23326
|
-
}
|
|
23327
|
-
}
|
|
23328
|
-
},
|
|
23329
|
-
"responses": {
|
|
23330
|
-
"201": {
|
|
23331
|
-
"description": "",
|
|
23332
|
-
"content": {
|
|
23333
|
-
"application/json": {
|
|
23334
|
-
"schema": {
|
|
23335
|
-
"type": "object"
|
|
23336
|
-
}
|
|
23337
|
-
}
|
|
23338
|
-
}
|
|
23339
|
-
}
|
|
23340
|
-
}
|
|
23341
|
-
}
|
|
23342
|
-
},
|
|
23343
|
-
"/v1/support/create-thread": {
|
|
23344
|
-
"post": {
|
|
23345
|
-
"operationId": "SupportController_createThread",
|
|
23346
|
-
"parameters": [
|
|
23347
|
-
{
|
|
23348
|
-
"name": "idempotency-key",
|
|
23349
|
-
"in": "header",
|
|
23350
|
-
"description": "A header for idempotency purposes",
|
|
23351
|
-
"required": false,
|
|
23352
|
-
"schema": {
|
|
23353
|
-
"type": "string"
|
|
23354
|
-
}
|
|
23355
|
-
}
|
|
23356
|
-
],
|
|
23357
|
-
"requestBody": {
|
|
23358
|
-
"required": true,
|
|
23359
|
-
"content": {
|
|
23360
|
-
"application/json": {
|
|
23361
|
-
"schema": {
|
|
23362
|
-
"$ref": "#/components/schemas/CreateSupportThreadDto"
|
|
23363
|
-
}
|
|
23364
|
-
}
|
|
23365
|
-
}
|
|
23366
|
-
},
|
|
23367
|
-
"responses": {
|
|
23368
|
-
"201": {
|
|
23369
|
-
"description": ""
|
|
23370
|
-
}
|
|
23371
|
-
}
|
|
23372
|
-
}
|
|
23373
26299
|
}
|
|
23374
26300
|
},
|
|
23375
26301
|
"info": {
|
|
@@ -23519,10 +26445,10 @@
|
|
|
23519
26445
|
],
|
|
23520
26446
|
"components": {
|
|
23521
26447
|
"securitySchemes": {
|
|
23522
|
-
"
|
|
26448
|
+
"secretKey": {
|
|
23523
26449
|
"type": "apiKey",
|
|
23524
|
-
"in": "header",
|
|
23525
26450
|
"name": "Authorization",
|
|
26451
|
+
"in": "header",
|
|
23526
26452
|
"description": "API key authentication. Allowed headers-- \"Authorization: ApiKey \u003capi_key\u003e\"."
|
|
23527
26453
|
}
|
|
23528
26454
|
},
|
|
@@ -23907,26 +26833,14 @@
|
|
|
23907
26833
|
"type"
|
|
23908
26834
|
]
|
|
23909
26835
|
},
|
|
23910
|
-
"WorkflowToStepControlValuesDto": {
|
|
23911
|
-
"type": "object",
|
|
23912
|
-
"properties": {
|
|
23913
|
-
"steps": {
|
|
23914
|
-
"type": "object",
|
|
23915
|
-
"description": "A mapping of step IDs to their corresponding data.",
|
|
23916
|
-
"additionalProperties": {
|
|
23917
|
-
"type": "object",
|
|
23918
|
-
"additionalProperties": true
|
|
23919
|
-
}
|
|
23920
|
-
}
|
|
23921
|
-
}
|
|
23922
|
-
},
|
|
23923
26836
|
"TriggerEventRequestDto": {
|
|
23924
26837
|
"type": "object",
|
|
23925
26838
|
"properties": {
|
|
23926
26839
|
"name": {
|
|
23927
26840
|
"type": "string",
|
|
23928
26841
|
"description": "The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.",
|
|
23929
|
-
"example": "workflow_identifier"
|
|
26842
|
+
"example": "workflow_identifier",
|
|
26843
|
+
"x-speakeasy-name-override": "workflowId"
|
|
23930
26844
|
},
|
|
23931
26845
|
"payload": {
|
|
23932
26846
|
"type": "object",
|
|
@@ -23939,11 +26853,6 @@
|
|
|
23939
26853
|
}
|
|
23940
26854
|
}
|
|
23941
26855
|
},
|
|
23942
|
-
"bridgeUrl": {
|
|
23943
|
-
"type": "string",
|
|
23944
|
-
"description": "A URL to bridge for additional processing.",
|
|
23945
|
-
"example": "https://example.com/bridge"
|
|
23946
|
-
},
|
|
23947
26856
|
"overrides": {
|
|
23948
26857
|
"type": "object",
|
|
23949
26858
|
"description": "This could be used to override provider specific configurations",
|
|
@@ -24014,18 +26923,10 @@
|
|
|
24014
26923
|
"oneOf": [
|
|
24015
26924
|
{
|
|
24016
26925
|
"type": "string",
|
|
24017
|
-
"description": "Unique identifier of a tenant in your system"
|
|
24018
|
-
},
|
|
24019
|
-
{
|
|
24020
|
-
"$ref": "#/components/schemas/TenantPayloadDto"
|
|
24021
|
-
}
|
|
24022
|
-
]
|
|
24023
|
-
},
|
|
24024
|
-
"controls": {
|
|
24025
|
-
"description": "Additional control configurations.",
|
|
24026
|
-
"allOf": [
|
|
26926
|
+
"description": "Unique identifier of a tenant in your system"
|
|
26927
|
+
},
|
|
24027
26928
|
{
|
|
24028
|
-
"$ref": "#/components/schemas/
|
|
26929
|
+
"$ref": "#/components/schemas/TenantPayloadDto"
|
|
24029
26930
|
}
|
|
24030
26931
|
]
|
|
24031
26932
|
}
|
|
@@ -25362,7 +28263,7 @@
|
|
|
25362
28263
|
}
|
|
25363
28264
|
}
|
|
25364
28265
|
},
|
|
25365
|
-
"
|
|
28266
|
+
"ChannelSettingsDto": {
|
|
25366
28267
|
"type": "object",
|
|
25367
28268
|
"properties": {
|
|
25368
28269
|
"providerId": {
|
|
@@ -25451,11 +28352,12 @@
|
|
|
25451
28352
|
"description": "An array of channel settings associated with the subscriber.",
|
|
25452
28353
|
"type": "array",
|
|
25453
28354
|
"items": {
|
|
25454
|
-
"$ref": "#/components/schemas/
|
|
28355
|
+
"$ref": "#/components/schemas/ChannelSettingsDto"
|
|
25455
28356
|
}
|
|
25456
28357
|
},
|
|
25457
28358
|
"topics": {
|
|
25458
28359
|
"description": "An array of topics that the subscriber is subscribed to.",
|
|
28360
|
+
"deprecated": true,
|
|
25459
28361
|
"type": "array",
|
|
25460
28362
|
"items": {
|
|
25461
28363
|
"type": "string"
|
|
@@ -25492,6 +28394,12 @@
|
|
|
25492
28394
|
"__v": {
|
|
25493
28395
|
"type": "number",
|
|
25494
28396
|
"description": "The version of the subscriber document."
|
|
28397
|
+
},
|
|
28398
|
+
"data": {
|
|
28399
|
+
"type": "object",
|
|
28400
|
+
"description": "Additional custom data for the subscriber",
|
|
28401
|
+
"additionalProperties": true,
|
|
28402
|
+
"nullable": true
|
|
25495
28403
|
}
|
|
25496
28404
|
},
|
|
25497
28405
|
"required": [
|
|
@@ -27310,6 +30218,281 @@
|
|
|
27310
30218
|
"type": "object",
|
|
27311
30219
|
"properties": {}
|
|
27312
30220
|
},
|
|
30221
|
+
"ListSubscribersResponseDto": {
|
|
30222
|
+
"type": "object",
|
|
30223
|
+
"properties": {
|
|
30224
|
+
"data": {
|
|
30225
|
+
"description": "List of returned Subscribers",
|
|
30226
|
+
"type": "array",
|
|
30227
|
+
"items": {
|
|
30228
|
+
"$ref": "#/components/schemas/SubscriberResponseDto"
|
|
30229
|
+
}
|
|
30230
|
+
},
|
|
30231
|
+
"next": {
|
|
30232
|
+
"type": "string",
|
|
30233
|
+
"description": "The cursor for the next page of results, or null if there are no more pages.",
|
|
30234
|
+
"nullable": true
|
|
30235
|
+
},
|
|
30236
|
+
"previous": {
|
|
30237
|
+
"type": "string",
|
|
30238
|
+
"description": "The cursor for the previous page of results, or null if this is the first page.",
|
|
30239
|
+
"nullable": true
|
|
30240
|
+
}
|
|
30241
|
+
},
|
|
30242
|
+
"required": [
|
|
30243
|
+
"data",
|
|
30244
|
+
"next",
|
|
30245
|
+
"previous"
|
|
30246
|
+
]
|
|
30247
|
+
},
|
|
30248
|
+
"PatchSubscriberRequestDto": {
|
|
30249
|
+
"type": "object",
|
|
30250
|
+
"properties": {
|
|
30251
|
+
"subscriberId": {
|
|
30252
|
+
"type": "string",
|
|
30253
|
+
"nullable": true,
|
|
30254
|
+
"description": "Unique identifier of the subscriber"
|
|
30255
|
+
},
|
|
30256
|
+
"firstName": {
|
|
30257
|
+
"type": "string",
|
|
30258
|
+
"nullable": true,
|
|
30259
|
+
"description": "First name of the subscriber"
|
|
30260
|
+
},
|
|
30261
|
+
"lastName": {
|
|
30262
|
+
"type": "string",
|
|
30263
|
+
"nullable": true,
|
|
30264
|
+
"description": "Last name of the subscriber"
|
|
30265
|
+
},
|
|
30266
|
+
"email": {
|
|
30267
|
+
"type": "string",
|
|
30268
|
+
"nullable": true,
|
|
30269
|
+
"description": "Email address of the subscriber"
|
|
30270
|
+
},
|
|
30271
|
+
"phone": {
|
|
30272
|
+
"type": "string",
|
|
30273
|
+
"nullable": true,
|
|
30274
|
+
"description": "Phone number of the subscriber"
|
|
30275
|
+
},
|
|
30276
|
+
"avatar": {
|
|
30277
|
+
"type": "string",
|
|
30278
|
+
"nullable": true,
|
|
30279
|
+
"description": "Avatar URL or identifier"
|
|
30280
|
+
},
|
|
30281
|
+
"timezone": {
|
|
30282
|
+
"type": "string",
|
|
30283
|
+
"nullable": true,
|
|
30284
|
+
"description": "Timezone of the subscriber"
|
|
30285
|
+
},
|
|
30286
|
+
"locale": {
|
|
30287
|
+
"type": "string",
|
|
30288
|
+
"nullable": true,
|
|
30289
|
+
"description": "Locale of the subscriber"
|
|
30290
|
+
},
|
|
30291
|
+
"data": {
|
|
30292
|
+
"type": "object",
|
|
30293
|
+
"nullable": true,
|
|
30294
|
+
"description": "Additional custom data for the subscriber"
|
|
30295
|
+
}
|
|
30296
|
+
}
|
|
30297
|
+
},
|
|
30298
|
+
"RemoveSubscriberResponseDto": {
|
|
30299
|
+
"type": "object",
|
|
30300
|
+
"properties": {
|
|
30301
|
+
"acknowledged": {
|
|
30302
|
+
"type": "boolean",
|
|
30303
|
+
"description": "Indicates whether the operation was acknowledged by the server",
|
|
30304
|
+
"example": true
|
|
30305
|
+
},
|
|
30306
|
+
"status": {
|
|
30307
|
+
"type": "string",
|
|
30308
|
+
"description": "Status of the subscriber removal operation",
|
|
30309
|
+
"example": "success"
|
|
30310
|
+
}
|
|
30311
|
+
},
|
|
30312
|
+
"required": [
|
|
30313
|
+
"acknowledged",
|
|
30314
|
+
"status"
|
|
30315
|
+
]
|
|
30316
|
+
},
|
|
30317
|
+
"GlobalPreferenceDto": {
|
|
30318
|
+
"type": "object",
|
|
30319
|
+
"properties": {
|
|
30320
|
+
"enabled": {
|
|
30321
|
+
"type": "boolean",
|
|
30322
|
+
"description": "Whether notifications are enabled globally"
|
|
30323
|
+
},
|
|
30324
|
+
"channels": {
|
|
30325
|
+
"description": "Channel-specific preference settings",
|
|
30326
|
+
"allOf": [
|
|
30327
|
+
{
|
|
30328
|
+
"$ref": "#/components/schemas/PreferenceChannels"
|
|
30329
|
+
}
|
|
30330
|
+
]
|
|
30331
|
+
}
|
|
30332
|
+
},
|
|
30333
|
+
"required": [
|
|
30334
|
+
"enabled",
|
|
30335
|
+
"channels"
|
|
30336
|
+
]
|
|
30337
|
+
},
|
|
30338
|
+
"Overrides": {
|
|
30339
|
+
"type": "object",
|
|
30340
|
+
"properties": {
|
|
30341
|
+
"channel": {
|
|
30342
|
+
"enum": [
|
|
30343
|
+
"in_app",
|
|
30344
|
+
"email",
|
|
30345
|
+
"sms",
|
|
30346
|
+
"chat",
|
|
30347
|
+
"push"
|
|
30348
|
+
],
|
|
30349
|
+
"type": "string",
|
|
30350
|
+
"description": "The channel type which is overridden"
|
|
30351
|
+
},
|
|
30352
|
+
"source": {
|
|
30353
|
+
"enum": [
|
|
30354
|
+
"subscriber",
|
|
30355
|
+
"template",
|
|
30356
|
+
"workflowOverride"
|
|
30357
|
+
],
|
|
30358
|
+
"type": "string",
|
|
30359
|
+
"description": "The source of overrides"
|
|
30360
|
+
}
|
|
30361
|
+
},
|
|
30362
|
+
"required": [
|
|
30363
|
+
"channel",
|
|
30364
|
+
"source"
|
|
30365
|
+
]
|
|
30366
|
+
},
|
|
30367
|
+
"WorkflowInfoDto": {
|
|
30368
|
+
"type": "object",
|
|
30369
|
+
"properties": {
|
|
30370
|
+
"slug": {
|
|
30371
|
+
"type": "string",
|
|
30372
|
+
"description": "Workflow slug"
|
|
30373
|
+
},
|
|
30374
|
+
"identifier": {
|
|
30375
|
+
"type": "string",
|
|
30376
|
+
"description": "Unique identifier of the workflow"
|
|
30377
|
+
},
|
|
30378
|
+
"name": {
|
|
30379
|
+
"type": "string",
|
|
30380
|
+
"description": "Display name of the workflow"
|
|
30381
|
+
}
|
|
30382
|
+
},
|
|
30383
|
+
"required": [
|
|
30384
|
+
"slug",
|
|
30385
|
+
"identifier",
|
|
30386
|
+
"name"
|
|
30387
|
+
]
|
|
30388
|
+
},
|
|
30389
|
+
"WorkflowPreferenceDto": {
|
|
30390
|
+
"type": "object",
|
|
30391
|
+
"properties": {
|
|
30392
|
+
"enabled": {
|
|
30393
|
+
"type": "boolean",
|
|
30394
|
+
"description": "Whether notifications are enabled for this workflow"
|
|
30395
|
+
},
|
|
30396
|
+
"channels": {
|
|
30397
|
+
"description": "Channel-specific preference settings for this workflow",
|
|
30398
|
+
"allOf": [
|
|
30399
|
+
{
|
|
30400
|
+
"$ref": "#/components/schemas/PreferenceChannels"
|
|
30401
|
+
}
|
|
30402
|
+
]
|
|
30403
|
+
},
|
|
30404
|
+
"overrides": {
|
|
30405
|
+
"description": "List of preference overrides",
|
|
30406
|
+
"type": "array",
|
|
30407
|
+
"items": {
|
|
30408
|
+
"$ref": "#/components/schemas/Overrides"
|
|
30409
|
+
}
|
|
30410
|
+
},
|
|
30411
|
+
"workflow": {
|
|
30412
|
+
"description": "Workflow information",
|
|
30413
|
+
"allOf": [
|
|
30414
|
+
{
|
|
30415
|
+
"$ref": "#/components/schemas/WorkflowInfoDto"
|
|
30416
|
+
}
|
|
30417
|
+
]
|
|
30418
|
+
}
|
|
30419
|
+
},
|
|
30420
|
+
"required": [
|
|
30421
|
+
"enabled",
|
|
30422
|
+
"channels",
|
|
30423
|
+
"overrides",
|
|
30424
|
+
"workflow"
|
|
30425
|
+
]
|
|
30426
|
+
},
|
|
30427
|
+
"GetSubscriberPreferencesDto": {
|
|
30428
|
+
"type": "object",
|
|
30429
|
+
"properties": {
|
|
30430
|
+
"global": {
|
|
30431
|
+
"description": "Global preference settings",
|
|
30432
|
+
"allOf": [
|
|
30433
|
+
{
|
|
30434
|
+
"$ref": "#/components/schemas/GlobalPreferenceDto"
|
|
30435
|
+
}
|
|
30436
|
+
]
|
|
30437
|
+
},
|
|
30438
|
+
"workflows": {
|
|
30439
|
+
"description": "Workflow-specific preference settings",
|
|
30440
|
+
"type": "array",
|
|
30441
|
+
"items": {
|
|
30442
|
+
"$ref": "#/components/schemas/WorkflowPreferenceDto"
|
|
30443
|
+
}
|
|
30444
|
+
}
|
|
30445
|
+
},
|
|
30446
|
+
"required": [
|
|
30447
|
+
"global",
|
|
30448
|
+
"workflows"
|
|
30449
|
+
]
|
|
30450
|
+
},
|
|
30451
|
+
"PatchPreferenceChannelsDto": {
|
|
30452
|
+
"type": "object",
|
|
30453
|
+
"properties": {
|
|
30454
|
+
"email": {
|
|
30455
|
+
"type": "boolean",
|
|
30456
|
+
"description": "Email channel preference"
|
|
30457
|
+
},
|
|
30458
|
+
"sms": {
|
|
30459
|
+
"type": "boolean",
|
|
30460
|
+
"description": "SMS channel preference"
|
|
30461
|
+
},
|
|
30462
|
+
"in_app": {
|
|
30463
|
+
"type": "boolean",
|
|
30464
|
+
"description": "In-app channel preference"
|
|
30465
|
+
},
|
|
30466
|
+
"push": {
|
|
30467
|
+
"type": "boolean",
|
|
30468
|
+
"description": "Push channel preference"
|
|
30469
|
+
},
|
|
30470
|
+
"chat": {
|
|
30471
|
+
"type": "boolean",
|
|
30472
|
+
"description": "Chat channel preference"
|
|
30473
|
+
}
|
|
30474
|
+
}
|
|
30475
|
+
},
|
|
30476
|
+
"PatchSubscriberPreferencesDto": {
|
|
30477
|
+
"type": "object",
|
|
30478
|
+
"properties": {
|
|
30479
|
+
"channels": {
|
|
30480
|
+
"description": "Channel-specific preference settings",
|
|
30481
|
+
"allOf": [
|
|
30482
|
+
{
|
|
30483
|
+
"$ref": "#/components/schemas/PatchPreferenceChannelsDto"
|
|
30484
|
+
}
|
|
30485
|
+
]
|
|
30486
|
+
},
|
|
30487
|
+
"workflowId": {
|
|
30488
|
+
"type": "string",
|
|
30489
|
+
"description": "If provided, update workflow specific preferences, otherwise update global preferences"
|
|
30490
|
+
}
|
|
30491
|
+
},
|
|
30492
|
+
"required": [
|
|
30493
|
+
"channels"
|
|
30494
|
+
]
|
|
30495
|
+
},
|
|
27313
30496
|
"DeleteMessageResponseDto": {
|
|
27314
30497
|
"type": "object",
|
|
27315
30498
|
"properties": {
|
|
@@ -27619,46 +30802,6 @@
|
|
|
27619
30802
|
"GeneratePreviewResponseDto": {
|
|
27620
30803
|
"type": "object",
|
|
27621
30804
|
"properties": {}
|
|
27622
|
-
},
|
|
27623
|
-
"PlainCardRequestDto": {
|
|
27624
|
-
"type": "object",
|
|
27625
|
-
"properties": {
|
|
27626
|
-
"cardKeys": {
|
|
27627
|
-
"type": "array",
|
|
27628
|
-
"items": {
|
|
27629
|
-
"type": "string"
|
|
27630
|
-
}
|
|
27631
|
-
},
|
|
27632
|
-
"customer": {
|
|
27633
|
-
"type": "object",
|
|
27634
|
-
"nullable": true
|
|
27635
|
-
},
|
|
27636
|
-
"tenant": {
|
|
27637
|
-
"type": "object",
|
|
27638
|
-
"nullable": true
|
|
27639
|
-
},
|
|
27640
|
-
"thread": {
|
|
27641
|
-
"type": "object",
|
|
27642
|
-
"nullable": true
|
|
27643
|
-
},
|
|
27644
|
-
"timestamp": {
|
|
27645
|
-
"type": "string"
|
|
27646
|
-
}
|
|
27647
|
-
},
|
|
27648
|
-
"required": [
|
|
27649
|
-
"timestamp"
|
|
27650
|
-
]
|
|
27651
|
-
},
|
|
27652
|
-
"CreateSupportThreadDto": {
|
|
27653
|
-
"type": "object",
|
|
27654
|
-
"properties": {
|
|
27655
|
-
"text": {
|
|
27656
|
-
"type": "string"
|
|
27657
|
-
}
|
|
27658
|
-
},
|
|
27659
|
-
"required": [
|
|
27660
|
-
"text"
|
|
27661
|
-
]
|
|
27662
30805
|
}
|
|
27663
30806
|
},
|
|
27664
30807
|
"headers": {
|
|
@@ -27740,6 +30883,11 @@
|
|
|
27740
30883
|
"description": "Novu Documentation",
|
|
27741
30884
|
"url": "https://docs.novu.co"
|
|
27742
30885
|
},
|
|
30886
|
+
"security": [
|
|
30887
|
+
{
|
|
30888
|
+
"secretKey": []
|
|
30889
|
+
}
|
|
30890
|
+
],
|
|
27743
30891
|
"x-speakeasy-name-override": [
|
|
27744
30892
|
{
|
|
27745
30893
|
"operationId": "^.*get.*",
|