@novu/api 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (556) hide show
  1. package/FUNCTIONS.md +2 -3
  2. package/README.md +36 -42
  3. package/docs/sdks/authentication/README.md +10 -10
  4. package/docs/sdks/credentials/README.md +12 -12
  5. package/docs/sdks/integrations/README.md +18 -18
  6. package/docs/sdks/messages/README.md +9 -9
  7. package/docs/sdks/notifications/README.md +6 -6
  8. package/docs/sdks/novu/README.md +21 -179
  9. package/docs/sdks/novumessages/README.md +13 -13
  10. package/docs/sdks/novunotifications/README.md +10 -10
  11. package/docs/sdks/novusubscribers/README.md +9 -9
  12. package/docs/sdks/preferences/README.md +18 -18
  13. package/docs/sdks/properties/README.md +4 -4
  14. package/docs/sdks/stats/README.md +6 -6
  15. package/docs/sdks/subscribers/README.md +347 -33
  16. package/docs/sdks/topics/README.md +15 -15
  17. package/docs/sdks/webhooks/README.md +3 -3
  18. package/funcs/cancel.js +4 -4
  19. package/funcs/cancel.js.map +1 -1
  20. package/funcs/integrationsCreate.js +4 -4
  21. package/funcs/integrationsCreate.js.map +1 -1
  22. package/funcs/integrationsDelete.js +4 -4
  23. package/funcs/integrationsDelete.js.map +1 -1
  24. package/funcs/integrationsList.js +4 -4
  25. package/funcs/integrationsList.js.map +1 -1
  26. package/funcs/integrationsListActive.js +4 -4
  27. package/funcs/integrationsListActive.js.map +1 -1
  28. package/funcs/integrationsSetAsPrimary.js +4 -4
  29. package/funcs/integrationsSetAsPrimary.js.map +1 -1
  30. package/funcs/integrationsUpdate.js +4 -4
  31. package/funcs/integrationsUpdate.js.map +1 -1
  32. package/funcs/integrationsWebhooksRetrieve.js +4 -4
  33. package/funcs/integrationsWebhooksRetrieve.js.map +1 -1
  34. package/funcs/messagesDelete.js +4 -4
  35. package/funcs/messagesDelete.js.map +1 -1
  36. package/funcs/messagesDeleteByTransactionId.js +4 -4
  37. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  38. package/funcs/messagesRetrieve.js +4 -4
  39. package/funcs/messagesRetrieve.js.map +1 -1
  40. package/funcs/notificationsList.js +4 -4
  41. package/funcs/notificationsList.js.map +1 -1
  42. package/funcs/notificationsRetrieve.js +4 -4
  43. package/funcs/notificationsRetrieve.js.map +1 -1
  44. package/funcs/notificationsStatsGraph.js +4 -4
  45. package/funcs/notificationsStatsGraph.js.map +1 -1
  46. package/funcs/notificationsStatsRetrieve.js +4 -4
  47. package/funcs/notificationsStatsRetrieve.js.map +1 -1
  48. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts +1 -1
  49. package/funcs/subscribersAuthenticationChatAccessOauth.d.ts.map +1 -1
  50. package/funcs/subscribersAuthenticationChatAccessOauth.js +7 -7
  51. package/funcs/subscribersAuthenticationChatAccessOauth.js.map +1 -1
  52. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts +2 -2
  53. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.d.ts.map +1 -1
  54. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js +6 -6
  55. package/funcs/subscribersAuthenticationChatAccessOauthCallBack.js.map +1 -1
  56. package/funcs/subscribersCreate.d.ts +1 -1
  57. package/funcs/subscribersCreate.d.ts.map +1 -1
  58. package/funcs/subscribersCreate.js +6 -6
  59. package/funcs/subscribersCreate.js.map +1 -1
  60. package/funcs/subscribersCreateBulk.d.ts +1 -1
  61. package/funcs/subscribersCreateBulk.d.ts.map +1 -1
  62. package/funcs/subscribersCreateBulk.js +7 -6
  63. package/funcs/subscribersCreateBulk.js.map +1 -1
  64. package/funcs/subscribersCredentialsAppend.d.ts +1 -1
  65. package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
  66. package/funcs/subscribersCredentialsAppend.js +6 -6
  67. package/funcs/subscribersCredentialsAppend.js.map +1 -1
  68. package/funcs/subscribersCredentialsDelete.d.ts +1 -1
  69. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  70. package/funcs/subscribersCredentialsDelete.js +7 -7
  71. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  72. package/funcs/subscribersCredentialsUpdate.d.ts +1 -1
  73. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  74. package/funcs/subscribersCredentialsUpdate.js +6 -6
  75. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  76. package/funcs/subscribersDelete.js +5 -5
  77. package/funcs/subscribersDelete.js.map +1 -1
  78. package/funcs/subscribersDeleteLegacy.d.ts +18 -0
  79. package/funcs/subscribersDeleteLegacy.d.ts.map +1 -0
  80. package/funcs/{create.js → subscribersDeleteLegacy.js} +51 -20
  81. package/funcs/subscribersDeleteLegacy.js.map +1 -0
  82. package/funcs/subscribersList.d.ts +1 -1
  83. package/funcs/subscribersList.d.ts.map +1 -1
  84. package/funcs/subscribersList.js +6 -6
  85. package/funcs/subscribersList.js.map +1 -1
  86. package/funcs/subscribersMessagesMarkAll.d.ts +1 -1
  87. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  88. package/funcs/subscribersMessagesMarkAll.js +8 -7
  89. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  90. package/funcs/subscribersMessagesMarkAllAs.d.ts +1 -1
  91. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  92. package/funcs/subscribersMessagesMarkAllAs.js +6 -6
  93. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  94. package/funcs/subscribersMessagesUpdateAsSeen.d.ts +1 -1
  95. package/funcs/subscribersMessagesUpdateAsSeen.d.ts.map +1 -1
  96. package/funcs/subscribersMessagesUpdateAsSeen.js +6 -6
  97. package/funcs/subscribersMessagesUpdateAsSeen.js.map +1 -1
  98. package/funcs/subscribersNotificationsFeed.d.ts +1 -1
  99. package/funcs/subscribersNotificationsFeed.d.ts.map +1 -1
  100. package/funcs/subscribersNotificationsFeed.js +7 -6
  101. package/funcs/subscribersNotificationsFeed.js.map +1 -1
  102. package/funcs/subscribersNotificationsUnseenCount.d.ts +1 -1
  103. package/funcs/subscribersNotificationsUnseenCount.d.ts.map +1 -1
  104. package/funcs/subscribersNotificationsUnseenCount.js +6 -6
  105. package/funcs/subscribersNotificationsUnseenCount.js.map +1 -1
  106. package/funcs/subscribersPatch.d.ts +17 -0
  107. package/funcs/subscribersPatch.d.ts.map +1 -0
  108. package/funcs/{supportControllerFetchUserOrganizations.js → subscribersPatch.js} +48 -16
  109. package/funcs/subscribersPatch.js.map +1 -0
  110. package/funcs/subscribersPreferencesList.d.ts +1 -1
  111. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  112. package/funcs/subscribersPreferencesList.js +6 -6
  113. package/funcs/subscribersPreferencesList.js.map +1 -1
  114. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +1 -1
  115. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +1 -1
  116. package/funcs/subscribersPreferencesRetrieveByLevel.js +6 -6
  117. package/funcs/subscribersPreferencesRetrieveByLevel.js.map +1 -1
  118. package/funcs/subscribersPreferencesUpdate.d.ts +1 -1
  119. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  120. package/funcs/subscribersPreferencesUpdate.js +6 -6
  121. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  122. package/funcs/subscribersPreferencesUpdateGlobal.d.ts +1 -1
  123. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
  124. package/funcs/subscribersPreferencesUpdateGlobal.js +6 -6
  125. package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
  126. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +1 -1
  127. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
  128. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +6 -6
  129. package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  130. package/funcs/subscribersRetrieve.d.ts +1 -1
  131. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  132. package/funcs/subscribersRetrieve.js +6 -11
  133. package/funcs/subscribersRetrieve.js.map +1 -1
  134. package/funcs/subscribersRetrieveLegacy.d.ts +16 -0
  135. package/funcs/subscribersRetrieveLegacy.d.ts.map +1 -0
  136. package/funcs/subscribersRetrieveLegacy.js +144 -0
  137. package/funcs/subscribersRetrieveLegacy.js.map +1 -0
  138. package/funcs/subscribersSearch.d.ts +13 -0
  139. package/funcs/subscribersSearch.d.ts.map +1 -0
  140. package/funcs/subscribersSearch.js +138 -0
  141. package/funcs/subscribersSearch.js.map +1 -0
  142. package/funcs/subscribersUpdate.d.ts +1 -1
  143. package/funcs/subscribersUpdate.d.ts.map +1 -1
  144. package/funcs/subscribersUpdate.js +6 -6
  145. package/funcs/subscribersUpdate.js.map +1 -1
  146. package/funcs/topicsCreate.js +4 -4
  147. package/funcs/topicsCreate.js.map +1 -1
  148. package/funcs/topicsDelete.js +4 -4
  149. package/funcs/topicsDelete.js.map +1 -1
  150. package/funcs/topicsList.js +4 -4
  151. package/funcs/topicsList.js.map +1 -1
  152. package/funcs/topicsRename.js +4 -4
  153. package/funcs/topicsRename.js.map +1 -1
  154. package/funcs/topicsRetrieve.js +4 -4
  155. package/funcs/topicsRetrieve.js.map +1 -1
  156. package/funcs/topicsSubscribersAssign.js +4 -4
  157. package/funcs/topicsSubscribersAssign.js.map +1 -1
  158. package/funcs/topicsSubscribersRemove.js +4 -4
  159. package/funcs/topicsSubscribersRemove.js.map +1 -1
  160. package/funcs/topicsSubscribersRetrieve.js +4 -4
  161. package/funcs/topicsSubscribersRetrieve.js.map +1 -1
  162. package/funcs/trigger.js +4 -4
  163. package/funcs/trigger.js.map +1 -1
  164. package/funcs/triggerBroadcast.js +4 -4
  165. package/funcs/triggerBroadcast.js.map +1 -1
  166. package/funcs/triggerBulk.js +4 -4
  167. package/funcs/triggerBulk.js.map +1 -1
  168. package/jsr.json +1 -1
  169. package/lib/config.d.ts +4 -4
  170. package/lib/config.d.ts.map +1 -1
  171. package/lib/config.js +3 -3
  172. package/lib/config.js.map +1 -1
  173. package/lib/retries.js +0 -1
  174. package/lib/retries.js.map +1 -1
  175. package/lib/security.js +1 -1
  176. package/lib/security.js.map +1 -1
  177. package/models/components/{channelsettings.d.ts → channelsettingsdto.d.ts} +22 -22
  178. package/models/components/channelsettingsdto.d.ts.map +1 -0
  179. package/models/components/{channelsettings.js → channelsettingsdto.js} +29 -29
  180. package/models/components/channelsettingsdto.js.map +1 -0
  181. package/models/components/index.d.ts +4 -4
  182. package/models/components/index.d.ts.map +1 -1
  183. package/models/components/index.js +4 -4
  184. package/models/components/index.js.map +1 -1
  185. package/models/components/listsubscribersresponsedto.d.ts +43 -0
  186. package/models/components/listsubscribersresponsedto.d.ts.map +1 -0
  187. package/models/components/listsubscribersresponsedto.js +64 -0
  188. package/models/components/listsubscribersresponsedto.js.map +1 -0
  189. package/models/components/patchsubscriberrequestdto.d.ts +96 -0
  190. package/models/components/patchsubscriberrequestdto.d.ts.map +1 -0
  191. package/models/components/patchsubscriberrequestdto.js +100 -0
  192. package/models/components/patchsubscriberrequestdto.js.map +1 -0
  193. package/models/components/removesubscriberresponsedto.d.ts +37 -0
  194. package/models/components/removesubscriberresponsedto.d.ts.map +1 -0
  195. package/models/components/removesubscriberresponsedto.js +61 -0
  196. package/models/components/removesubscriberresponsedto.js.map +1 -0
  197. package/models/components/security.d.ts +2 -2
  198. package/models/components/security.d.ts.map +1 -1
  199. package/models/components/security.js +2 -11
  200. package/models/components/security.js.map +1 -1
  201. package/models/components/subscriberresponsedto.d.ts +14 -3
  202. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  203. package/models/components/subscriberresponsedto.js +5 -3
  204. package/models/components/subscriberresponsedto.js.map +1 -1
  205. package/models/components/triggereventrequestdto.d.ts +1 -12
  206. package/models/components/triggereventrequestdto.d.ts.map +1 -1
  207. package/models/components/triggereventrequestdto.js +10 -6
  208. package/models/components/triggereventrequestdto.js.map +1 -1
  209. package/models/operations/index.d.ts +23 -21
  210. package/models/operations/index.d.ts.map +1 -1
  211. package/models/operations/index.js +23 -21
  212. package/models/operations/index.js.map +1 -1
  213. package/models/operations/subscriberscontrollergetsubscriber.d.ts +0 -5
  214. package/models/operations/subscriberscontrollergetsubscriber.d.ts.map +1 -1
  215. package/models/operations/subscriberscontrollergetsubscriber.js +0 -2
  216. package/models/operations/subscriberscontrollergetsubscriber.js.map +1 -1
  217. package/models/operations/subscriberscontrollerpatchsubscriber.d.ts +68 -0
  218. package/models/operations/subscriberscontrollerpatchsubscriber.d.ts.map +1 -0
  219. package/models/operations/subscriberscontrollerpatchsubscriber.js +114 -0
  220. package/models/operations/subscriberscontrollerpatchsubscriber.js.map +1 -0
  221. package/models/operations/subscriberscontrollerremovesubscriber.d.ts +2 -2
  222. package/models/operations/subscriberscontrollerremovesubscriber.js +2 -2
  223. package/models/operations/subscriberscontrollersearchsubscribers.d.ts +126 -0
  224. package/models/operations/subscriberscontrollersearchsubscribers.d.ts.map +1 -0
  225. package/models/operations/subscriberscontrollersearchsubscribers.js +145 -0
  226. package/models/operations/subscriberscontrollersearchsubscribers.js.map +1 -0
  227. package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts +66 -0
  228. package/models/operations/subscribersv1controllerbulkcreatesubscribers.d.ts.map +1 -0
  229. package/models/operations/subscribersv1controllerbulkcreatesubscribers.js +112 -0
  230. package/models/operations/subscribersv1controllerbulkcreatesubscribers.js.map +1 -0
  231. package/models/operations/subscribersv1controllerchataccessoauth.d.ts +80 -0
  232. package/models/operations/subscribersv1controllerchataccessoauth.d.ts.map +1 -0
  233. package/models/operations/subscribersv1controllerchataccessoauth.js +113 -0
  234. package/models/operations/subscribersv1controllerchataccessoauth.js.map +1 -0
  235. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts +108 -0
  236. package/models/operations/subscribersv1controllerchatoauthcallback.d.ts.map +1 -0
  237. package/models/operations/subscribersv1controllerchatoauthcallback.js +143 -0
  238. package/models/operations/subscribersv1controllerchatoauthcallback.js.map +1 -0
  239. package/models/operations/subscribersv1controllercreatesubscriber.d.ts +66 -0
  240. package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +1 -0
  241. package/models/operations/subscribersv1controllercreatesubscriber.js +112 -0
  242. package/models/operations/subscribersv1controllercreatesubscriber.js.map +1 -0
  243. package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts +65 -0
  244. package/models/operations/subscribersv1controllerdeletesubscribercredentials.d.ts.map +1 -0
  245. package/models/operations/subscribersv1controllerdeletesubscribercredentials.js +111 -0
  246. package/models/operations/subscribersv1controllerdeletesubscribercredentials.js.map +1 -0
  247. package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts +79 -0
  248. package/models/operations/subscribersv1controllergetnotificationsfeed.d.ts.map +1 -0
  249. package/models/operations/subscribersv1controllergetnotificationsfeed.js +120 -0
  250. package/models/operations/subscribersv1controllergetnotificationsfeed.js.map +1 -0
  251. package/models/operations/subscribersv1controllergetsubscriber.d.ts +71 -0
  252. package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +1 -0
  253. package/models/operations/subscribersv1controllergetsubscriber.js +112 -0
  254. package/models/operations/subscribersv1controllergetsubscriber.js.map +1 -0
  255. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +108 -0
  256. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +1 -0
  257. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +141 -0
  258. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +1 -0
  259. package/models/operations/subscribersv1controllergetunseencount.d.ts +76 -0
  260. package/models/operations/subscribersv1controllergetunseencount.d.ts.map +1 -0
  261. package/models/operations/subscribersv1controllergetunseencount.js +114 -0
  262. package/models/operations/subscribersv1controllergetunseencount.js.map +1 -0
  263. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +71 -0
  264. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +1 -0
  265. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +116 -0
  266. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +1 -0
  267. package/models/operations/subscribersv1controllerlistsubscribers.d.ts +108 -0
  268. package/models/operations/subscribersv1controllerlistsubscribers.d.ts.map +1 -0
  269. package/models/operations/subscribersv1controllerlistsubscribers.js +145 -0
  270. package/models/operations/subscribersv1controllerlistsubscribers.js.map +1 -0
  271. package/models/operations/subscribersv1controllermarkactionasseen.d.ts +72 -0
  272. package/models/operations/subscribersv1controllermarkactionasseen.d.ts.map +1 -0
  273. package/models/operations/subscribersv1controllermarkactionasseen.js +118 -0
  274. package/models/operations/subscribersv1controllermarkactionasseen.js.map +1 -0
  275. package/models/operations/subscribersv1controllermarkallunreadasread.d.ts +68 -0
  276. package/models/operations/subscribersv1controllermarkallunreadasread.d.ts.map +1 -0
  277. package/models/operations/subscribersv1controllermarkallunreadasread.js +114 -0
  278. package/models/operations/subscribersv1controllermarkallunreadasread.js.map +1 -0
  279. package/models/operations/subscribersv1controllermarkmessagesas.d.ts +68 -0
  280. package/models/operations/subscribersv1controllermarkmessagesas.d.ts.map +1 -0
  281. package/models/operations/subscribersv1controllermarkmessagesas.js +114 -0
  282. package/models/operations/subscribersv1controllermarkmessagesas.js.map +1 -0
  283. package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts +68 -0
  284. package/models/operations/subscribersv1controllermodifysubscriberchannel.d.ts.map +1 -0
  285. package/models/operations/subscribersv1controllermodifysubscriberchannel.js +115 -0
  286. package/models/operations/subscribersv1controllermodifysubscriberchannel.js.map +1 -0
  287. package/models/operations/subscribersv1controllerremovesubscriber.d.ts +66 -0
  288. package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +1 -0
  289. package/models/operations/subscribersv1controllerremovesubscriber.js +110 -0
  290. package/models/operations/subscribersv1controllerremovesubscriber.js.map +1 -0
  291. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +68 -0
  292. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +1 -0
  293. package/models/operations/subscribersv1controllerupdatesubscriber.js +114 -0
  294. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +1 -0
  295. package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts +68 -0
  296. package/models/operations/subscribersv1controllerupdatesubscriberchannel.d.ts.map +1 -0
  297. package/models/operations/subscribersv1controllerupdatesubscriberchannel.js +115 -0
  298. package/models/operations/subscribersv1controllerupdatesubscriberchannel.js.map +1 -0
  299. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +68 -0
  300. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +1 -0
  301. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +118 -0
  302. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +1 -0
  303. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts +68 -0
  304. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.d.ts.map +1 -0
  305. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js +118 -0
  306. package/models/operations/subscribersv1controllerupdatesubscriberonlineflag.js.map +1 -0
  307. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +70 -0
  308. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +1 -0
  309. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +120 -0
  310. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +1 -0
  311. package/package.json +6 -7
  312. package/sdk/authentication.d.ts +3 -3
  313. package/sdk/authentication.d.ts.map +1 -1
  314. package/sdk/authentication.js.map +1 -1
  315. package/sdk/credentials.d.ts +3 -3
  316. package/sdk/credentials.d.ts.map +1 -1
  317. package/sdk/credentials.js.map +1 -1
  318. package/sdk/novumessages.d.ts +3 -3
  319. package/sdk/novumessages.d.ts.map +1 -1
  320. package/sdk/novumessages.js.map +1 -1
  321. package/sdk/novunotifications.d.ts +2 -2
  322. package/sdk/novunotifications.d.ts.map +1 -1
  323. package/sdk/novunotifications.js.map +1 -1
  324. package/sdk/preferences.d.ts +4 -4
  325. package/sdk/preferences.d.ts.map +1 -1
  326. package/sdk/preferences.js.map +1 -1
  327. package/sdk/properties.d.ts +1 -1
  328. package/sdk/properties.d.ts.map +1 -1
  329. package/sdk/sdk.d.ts +0 -8
  330. package/sdk/sdk.d.ts.map +1 -1
  331. package/sdk/sdk.js +0 -14
  332. package/sdk/sdk.js.map +1 -1
  333. package/sdk/subscribers.d.ts +33 -6
  334. package/sdk/subscribers.d.ts.map +1 -1
  335. package/sdk/subscribers.js +43 -4
  336. package/sdk/subscribers.js.map +1 -1
  337. package/sources/json-development.json +2327 -344
  338. package/src/funcs/cancel.ts +4 -4
  339. package/src/funcs/integrationsCreate.ts +4 -4
  340. package/src/funcs/integrationsDelete.ts +4 -4
  341. package/src/funcs/integrationsList.ts +4 -4
  342. package/src/funcs/integrationsListActive.ts +4 -4
  343. package/src/funcs/integrationsSetAsPrimary.ts +5 -5
  344. package/src/funcs/integrationsUpdate.ts +5 -5
  345. package/src/funcs/integrationsWebhooksRetrieve.ts +4 -4
  346. package/src/funcs/messagesDelete.ts +4 -4
  347. package/src/funcs/messagesDeleteByTransactionId.ts +4 -4
  348. package/src/funcs/messagesRetrieve.ts +4 -4
  349. package/src/funcs/notificationsList.ts +4 -4
  350. package/src/funcs/notificationsRetrieve.ts +4 -4
  351. package/src/funcs/notificationsStatsGraph.ts +4 -4
  352. package/src/funcs/notificationsStatsRetrieve.ts +4 -4
  353. package/src/funcs/subscribersAuthenticationChatAccessOauth.ts +10 -10
  354. package/src/funcs/subscribersAuthenticationChatAccessOauthCallBack.ts +11 -11
  355. package/src/funcs/subscribersCreate.ts +10 -10
  356. package/src/funcs/subscribersCreateBulk.ts +15 -15
  357. package/src/funcs/subscribersCredentialsAppend.ts +11 -11
  358. package/src/funcs/subscribersCredentialsDelete.ts +10 -10
  359. package/src/funcs/subscribersCredentialsUpdate.ts +11 -11
  360. package/src/funcs/subscribersDelete.ts +5 -5
  361. package/src/funcs/subscribersDeleteLegacy.ts +200 -0
  362. package/src/funcs/subscribersList.ts +11 -11
  363. package/src/funcs/subscribersMessagesMarkAll.ts +14 -11
  364. package/src/funcs/subscribersMessagesMarkAllAs.ts +10 -10
  365. package/src/funcs/subscribersMessagesUpdateAsSeen.ts +10 -10
  366. package/src/funcs/subscribersNotificationsFeed.ts +11 -10
  367. package/src/funcs/subscribersNotificationsUnseenCount.ts +10 -10
  368. package/src/funcs/{supportControllerFetchUserOrganizations.ts → subscribersPatch.ts} +73 -19
  369. package/src/funcs/subscribersPreferencesList.ts +10 -10
  370. package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +10 -10
  371. package/src/funcs/subscribersPreferencesUpdate.ts +10 -10
  372. package/src/funcs/subscribersPreferencesUpdateGlobal.ts +16 -15
  373. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +10 -10
  374. package/src/funcs/subscribersRetrieve.ts +6 -13
  375. package/src/funcs/subscribersRetrieveLegacy.ts +205 -0
  376. package/src/funcs/{create.ts → subscribersSearch.ts} +78 -31
  377. package/src/funcs/subscribersUpdate.ts +10 -10
  378. package/src/funcs/topicsCreate.ts +4 -4
  379. package/src/funcs/topicsDelete.ts +4 -4
  380. package/src/funcs/topicsList.ts +4 -4
  381. package/src/funcs/topicsRename.ts +4 -4
  382. package/src/funcs/topicsRetrieve.ts +4 -4
  383. package/src/funcs/topicsSubscribersAssign.ts +4 -4
  384. package/src/funcs/topicsSubscribersRemove.ts +4 -4
  385. package/src/funcs/topicsSubscribersRetrieve.ts +4 -4
  386. package/src/funcs/trigger.ts +4 -4
  387. package/src/funcs/triggerBroadcast.ts +4 -4
  388. package/src/funcs/triggerBulk.ts +4 -4
  389. package/src/lib/config.ts +4 -4
  390. package/src/lib/retries.ts +0 -1
  391. package/src/lib/security.ts +1 -1
  392. package/src/models/components/{channelsettings.ts → channelsettingsdto.ts} +40 -38
  393. package/src/models/components/index.ts +4 -4
  394. package/src/models/components/listsubscribersresponsedto.ts +89 -0
  395. package/src/models/components/patchsubscriberrequestdto.ts +182 -0
  396. package/src/models/components/removesubscriberresponsedto.ts +78 -0
  397. package/src/models/components/security.ts +4 -13
  398. package/src/models/components/subscriberresponsedto.ts +18 -9
  399. package/src/models/components/triggereventrequestdto.ts +11 -22
  400. package/src/models/operations/index.ts +23 -21
  401. package/src/models/operations/subscriberscontrollergetsubscriber.ts +0 -7
  402. package/src/models/operations/subscriberscontrollerpatchsubscriber.ts +189 -0
  403. package/src/models/operations/subscriberscontrollerremovesubscriber.ts +4 -4
  404. package/src/models/operations/subscriberscontrollersearchsubscribers.ts +260 -0
  405. package/src/models/operations/subscribersv1controllerbulkcreatesubscribers.ts +185 -0
  406. package/src/models/operations/{subscriberscontrollerchataccessoauth.ts → subscribersv1controllerchataccessoauth.ts} +47 -46
  407. package/src/models/operations/subscribersv1controllerchatoauthcallback.ts +281 -0
  408. package/src/models/operations/subscribersv1controllercreatesubscriber.ts +187 -0
  409. package/src/models/operations/subscribersv1controllerdeletesubscribercredentials.ts +178 -0
  410. package/src/models/operations/{subscriberscontrollergetnotificationsfeed.ts → subscribersv1controllergetnotificationsfeed.ts} +46 -46
  411. package/src/models/operations/subscribersv1controllergetsubscriber.ts +188 -0
  412. package/src/models/operations/{subscriberscontrollergetsubscriberpreferencebylevel.ts → subscribersv1controllergetsubscriberpreferencebylevel.ts} +46 -46
  413. package/src/models/operations/subscribersv1controllergetunseencount.ts +195 -0
  414. package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +191 -0
  415. package/src/models/operations/subscribersv1controllerlistsubscribers.ts +283 -0
  416. package/src/models/operations/{subscriberscontrollermarkactionasseen.ts → subscribersv1controllermarkactionasseen.ts} +48 -46
  417. package/src/models/operations/subscribersv1controllermarkallunreadasread.ts +191 -0
  418. package/src/models/operations/subscribersv1controllermarkmessagesas.ts +187 -0
  419. package/src/models/operations/subscribersv1controllermodifysubscriberchannel.ts +192 -0
  420. package/src/models/operations/subscribersv1controllerremovesubscriber.ts +183 -0
  421. package/src/models/operations/{subscriberscontrollerupdatesubscriber.ts → subscribersv1controllerupdatesubscriber.ts} +48 -46
  422. package/src/models/operations/subscribersv1controllerupdatesubscriberchannel.ts +192 -0
  423. package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +195 -0
  424. package/src/models/operations/subscribersv1controllerupdatesubscriberonlineflag.ts +193 -0
  425. package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +197 -0
  426. package/src/sdk/authentication.ts +4 -4
  427. package/src/sdk/credentials.ts +7 -3
  428. package/src/sdk/novumessages.ts +4 -4
  429. package/src/sdk/novunotifications.ts +4 -4
  430. package/src/sdk/preferences.ts +7 -6
  431. package/src/sdk/properties.ts +1 -1
  432. package/src/sdk/sdk.ts +0 -34
  433. package/src/sdk/subscribers.ts +89 -10
  434. package/funcs/create.d.ts +0 -9
  435. package/funcs/create.d.ts.map +0 -1
  436. package/funcs/create.js.map +0 -1
  437. package/funcs/supportControllerFetchUserOrganizations.d.ts +0 -10
  438. package/funcs/supportControllerFetchUserOrganizations.d.ts.map +0 -1
  439. package/funcs/supportControllerFetchUserOrganizations.js.map +0 -1
  440. package/models/components/channelsettings.d.ts.map +0 -1
  441. package/models/components/channelsettings.js.map +0 -1
  442. package/models/components/createsupportthreaddto.d.ts +0 -29
  443. package/models/components/createsupportthreaddto.d.ts.map +0 -1
  444. package/models/components/createsupportthreaddto.js +0 -59
  445. package/models/components/createsupportthreaddto.js.map +0 -1
  446. package/models/components/plaincardrequestdto.d.ts +0 -100
  447. package/models/components/plaincardrequestdto.d.ts.map +0 -1
  448. package/models/components/plaincardrequestdto.js +0 -139
  449. package/models/components/plaincardrequestdto.js.map +0 -1
  450. package/models/components/workflowtostepcontrolvaluesdto.d.ts +0 -40
  451. package/models/components/workflowtostepcontrolvaluesdto.d.ts.map +0 -1
  452. package/models/components/workflowtostepcontrolvaluesdto.js +0 -59
  453. package/models/components/workflowtostepcontrolvaluesdto.js.map +0 -1
  454. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts +0 -66
  455. package/models/operations/subscriberscontrollerbulkcreatesubscribers.d.ts.map +0 -1
  456. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js +0 -112
  457. package/models/operations/subscriberscontrollerbulkcreatesubscribers.js.map +0 -1
  458. package/models/operations/subscriberscontrollerchataccessoauth.d.ts +0 -80
  459. package/models/operations/subscriberscontrollerchataccessoauth.d.ts.map +0 -1
  460. package/models/operations/subscriberscontrollerchataccessoauth.js +0 -113
  461. package/models/operations/subscriberscontrollerchataccessoauth.js.map +0 -1
  462. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts +0 -108
  463. package/models/operations/subscriberscontrollerchatoauthcallback.d.ts.map +0 -1
  464. package/models/operations/subscriberscontrollerchatoauthcallback.js +0 -142
  465. package/models/operations/subscriberscontrollerchatoauthcallback.js.map +0 -1
  466. package/models/operations/subscriberscontrollercreatesubscriber.d.ts +0 -66
  467. package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +0 -1
  468. package/models/operations/subscriberscontrollercreatesubscriber.js +0 -112
  469. package/models/operations/subscriberscontrollercreatesubscriber.js.map +0 -1
  470. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts +0 -65
  471. package/models/operations/subscriberscontrollerdeletesubscribercredentials.d.ts.map +0 -1
  472. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js +0 -111
  473. package/models/operations/subscriberscontrollerdeletesubscribercredentials.js.map +0 -1
  474. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts +0 -79
  475. package/models/operations/subscriberscontrollergetnotificationsfeed.d.ts.map +0 -1
  476. package/models/operations/subscriberscontrollergetnotificationsfeed.js +0 -120
  477. package/models/operations/subscriberscontrollergetnotificationsfeed.js.map +0 -1
  478. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts +0 -108
  479. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.d.ts.map +0 -1
  480. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js +0 -141
  481. package/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.js.map +0 -1
  482. package/models/operations/subscriberscontrollergetunseencount.d.ts +0 -76
  483. package/models/operations/subscriberscontrollergetunseencount.d.ts.map +0 -1
  484. package/models/operations/subscriberscontrollergetunseencount.js +0 -114
  485. package/models/operations/subscriberscontrollergetunseencount.js.map +0 -1
  486. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts +0 -71
  487. package/models/operations/subscriberscontrollerlistsubscriberpreferences.d.ts.map +0 -1
  488. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js +0 -113
  489. package/models/operations/subscriberscontrollerlistsubscriberpreferences.js.map +0 -1
  490. package/models/operations/subscriberscontrollerlistsubscribers.d.ts +0 -108
  491. package/models/operations/subscriberscontrollerlistsubscribers.d.ts.map +0 -1
  492. package/models/operations/subscriberscontrollerlistsubscribers.js +0 -145
  493. package/models/operations/subscriberscontrollerlistsubscribers.js.map +0 -1
  494. package/models/operations/subscriberscontrollermarkactionasseen.d.ts +0 -72
  495. package/models/operations/subscriberscontrollermarkactionasseen.d.ts.map +0 -1
  496. package/models/operations/subscriberscontrollermarkactionasseen.js +0 -118
  497. package/models/operations/subscriberscontrollermarkactionasseen.js.map +0 -1
  498. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts +0 -68
  499. package/models/operations/subscriberscontrollermarkallunreadasread.d.ts.map +0 -1
  500. package/models/operations/subscriberscontrollermarkallunreadasread.js +0 -114
  501. package/models/operations/subscriberscontrollermarkallunreadasread.js.map +0 -1
  502. package/models/operations/subscriberscontrollermarkmessagesas.d.ts +0 -68
  503. package/models/operations/subscriberscontrollermarkmessagesas.d.ts.map +0 -1
  504. package/models/operations/subscriberscontrollermarkmessagesas.js +0 -114
  505. package/models/operations/subscriberscontrollermarkmessagesas.js.map +0 -1
  506. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts +0 -68
  507. package/models/operations/subscriberscontrollermodifysubscriberchannel.d.ts.map +0 -1
  508. package/models/operations/subscriberscontrollermodifysubscriberchannel.js +0 -114
  509. package/models/operations/subscriberscontrollermodifysubscriberchannel.js.map +0 -1
  510. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts +0 -68
  511. package/models/operations/subscriberscontrollerupdatesubscriber.d.ts.map +0 -1
  512. package/models/operations/subscriberscontrollerupdatesubscriber.js +0 -114
  513. package/models/operations/subscriberscontrollerupdatesubscriber.js.map +0 -1
  514. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts +0 -68
  515. package/models/operations/subscriberscontrollerupdatesubscriberchannel.d.ts.map +0 -1
  516. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js +0 -114
  517. package/models/operations/subscriberscontrollerupdatesubscriberchannel.js.map +0 -1
  518. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts +0 -68
  519. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.d.ts.map +0 -1
  520. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js +0 -118
  521. package/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.js.map +0 -1
  522. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts +0 -68
  523. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.d.ts.map +0 -1
  524. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js +0 -117
  525. package/models/operations/subscriberscontrollerupdatesubscriberonlineflag.js.map +0 -1
  526. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts +0 -70
  527. package/models/operations/subscriberscontrollerupdatesubscriberpreference.d.ts.map +0 -1
  528. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js +0 -119
  529. package/models/operations/subscriberscontrollerupdatesubscriberpreference.js.map +0 -1
  530. package/models/operations/supportcontrollercreatethread.d.ts +0 -35
  531. package/models/operations/supportcontrollercreatethread.d.ts.map +0 -1
  532. package/models/operations/supportcontrollercreatethread.js +0 -73
  533. package/models/operations/supportcontrollercreatethread.js.map +0 -1
  534. package/models/operations/supportcontrollerfetchuserorganizations.d.ts +0 -56
  535. package/models/operations/supportcontrollerfetchuserorganizations.d.ts.map +0 -1
  536. package/models/operations/supportcontrollerfetchuserorganizations.js +0 -96
  537. package/models/operations/supportcontrollerfetchuserorganizations.js.map +0 -1
  538. package/src/models/components/createsupportthreaddto.ts +0 -66
  539. package/src/models/components/plaincardrequestdto.ts +0 -223
  540. package/src/models/components/workflowtostepcontrolvaluesdto.ts +0 -71
  541. package/src/models/operations/subscriberscontrollerbulkcreatesubscribers.ts +0 -185
  542. package/src/models/operations/subscriberscontrollerchatoauthcallback.ts +0 -281
  543. package/src/models/operations/subscriberscontrollercreatesubscriber.ts +0 -185
  544. package/src/models/operations/subscriberscontrollerdeletesubscribercredentials.ts +0 -177
  545. package/src/models/operations/subscriberscontrollergetunseencount.ts +0 -192
  546. package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts +0 -193
  547. package/src/models/operations/subscriberscontrollerlistsubscribers.ts +0 -282
  548. package/src/models/operations/subscriberscontrollermarkallunreadasread.ts +0 -191
  549. package/src/models/operations/subscriberscontrollermarkmessagesas.ts +0 -184
  550. package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts +0 -193
  551. package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts +0 -193
  552. package/src/models/operations/subscriberscontrollerupdatesubscriberglobalpreferences.ts +0 -195
  553. package/src/models/operations/subscriberscontrollerupdatesubscriberonlineflag.ts +0 -192
  554. package/src/models/operations/subscriberscontrollerupdatesubscriberpreference.ts +0 -196
  555. package/src/models/operations/supportcontrollercreatethread.ts +0 -90
  556. package/src/models/operations/supportcontrollerfetchuserorganizations.ts +0 -163
@@ -486,7 +486,7 @@
486
486
  ],
487
487
  "security": [
488
488
  {
489
- "api-key": []
489
+ "secretKey": []
490
490
  }
491
491
  ]
492
492
  }
@@ -979,7 +979,7 @@
979
979
  ],
980
980
  "security": [
981
981
  {
982
- "api-key": []
982
+ "secretKey": []
983
983
  }
984
984
  ]
985
985
  }
@@ -1502,7 +1502,7 @@
1502
1502
  ],
1503
1503
  "security": [
1504
1504
  {
1505
- "api-key": []
1505
+ "secretKey": []
1506
1506
  }
1507
1507
  ]
1508
1508
  }
@@ -1990,7 +1990,7 @@
1990
1990
  ],
1991
1991
  "security": [
1992
1992
  {
1993
- "api-key": []
1993
+ "secretKey": []
1994
1994
  }
1995
1995
  ]
1996
1996
  }
@@ -2559,7 +2559,7 @@
2559
2559
  ],
2560
2560
  "security": [
2561
2561
  {
2562
- "api-key": []
2562
+ "secretKey": []
2563
2563
  }
2564
2564
  ]
2565
2565
  }
@@ -3034,7 +3034,7 @@
3034
3034
  ],
3035
3035
  "security": [
3036
3036
  {
3037
- "api-key": []
3037
+ "secretKey": []
3038
3038
  }
3039
3039
  ]
3040
3040
  }
@@ -3521,7 +3521,7 @@
3521
3521
  ],
3522
3522
  "security": [
3523
3523
  {
3524
- "api-key": []
3524
+ "secretKey": []
3525
3525
  }
3526
3526
  ]
3527
3527
  }
@@ -4003,7 +4003,7 @@
4003
4003
  ],
4004
4004
  "security": [
4005
4005
  {
4006
- "api-key": []
4006
+ "secretKey": []
4007
4007
  }
4008
4008
  ]
4009
4009
  }
@@ -4481,7 +4481,7 @@
4481
4481
  ],
4482
4482
  "security": [
4483
4483
  {
4484
- "api-key": []
4484
+ "secretKey": []
4485
4485
  }
4486
4486
  ]
4487
4487
  },
@@ -4964,7 +4964,7 @@
4964
4964
  ],
4965
4965
  "security": [
4966
4966
  {
4967
- "api-key": []
4967
+ "secretKey": []
4968
4968
  }
4969
4969
  ]
4970
4970
  }
@@ -5443,7 +5443,7 @@
5443
5443
  ],
5444
5444
  "security": [
5445
5445
  {
5446
- "api-key": []
5446
+ "secretKey": []
5447
5447
  }
5448
5448
  ]
5449
5449
  }
@@ -5927,7 +5927,7 @@
5927
5927
  ],
5928
5928
  "security": [
5929
5929
  {
5930
- "api-key": []
5930
+ "secretKey": []
5931
5931
  }
5932
5932
  ]
5933
5933
  }
@@ -6412,7 +6412,7 @@
6412
6412
  ],
6413
6413
  "security": [
6414
6414
  {
6415
- "api-key": []
6415
+ "secretKey": []
6416
6416
  }
6417
6417
  ]
6418
6418
  },
@@ -6895,7 +6895,7 @@
6895
6895
  ],
6896
6896
  "security": [
6897
6897
  {
6898
- "api-key": []
6898
+ "secretKey": []
6899
6899
  }
6900
6900
  ]
6901
6901
  }
@@ -7371,14 +7371,14 @@
7371
7371
  ],
7372
7372
  "security": [
7373
7373
  {
7374
- "api-key": []
7374
+ "secretKey": []
7375
7375
  }
7376
7376
  ]
7377
7377
  }
7378
7378
  },
7379
7379
  "/v1/subscribers": {
7380
7380
  "get": {
7381
- "operationId": "SubscribersController_listSubscribers",
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
- "api-key": []
7899
+ "secretKey": []
7900
7900
  }
7901
7901
  ]
7902
7902
  },
7903
7903
  "post": {
7904
- "operationId": "SubscribersController_createSubscriber",
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
- "api-key": []
8382
+ "secretKey": []
8383
8383
  }
8384
8384
  ]
8385
8385
  }
8386
8386
  },
8387
8387
  "/v1/subscribers/{subscriberId}": {
8388
8388
  "get": {
8389
- "operationId": "SubscribersController_getSubscriber",
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
- "api-key": []
8875
+ "secretKey": []
8875
8876
  }
8876
8877
  ]
8877
8878
  },
8878
8879
  "put": {
8879
- "operationId": "SubscribersController_updateSubscriber",
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
- "api-key": []
9366
+ "secretKey": []
9366
9367
  }
9367
9368
  ]
9368
9369
  },
9369
9370
  "delete": {
9370
- "operationId": "SubscribersController_removeSubscriber",
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
- "api-key": []
9849
+ "secretKey": []
9847
9850
  }
9848
9851
  ]
9849
9852
  }
9850
9853
  },
9851
9854
  "/v1/subscribers/bulk": {
9852
9855
  "post": {
9853
- "operationId": "SubscribersController_bulkCreateSubscribers",
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
- "api-key": []
10335
+ "secretKey": []
10333
10336
  }
10334
10337
  ]
10335
10338
  }
10336
10339
  },
10337
10340
  "/v1/subscribers/{subscriberId}/credentials": {
10338
10341
  "put": {
10339
- "operationId": "SubscribersController_updateSubscriberChannel",
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
- "api-key": []
10829
+ "secretKey": []
10827
10830
  }
10828
10831
  ]
10829
10832
  },
10830
10833
  "patch": {
10831
- "operationId": "SubscribersController_modifySubscriberChannel",
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
- "api-key": []
11322
+ "secretKey": []
11320
11323
  }
11321
11324
  ]
11322
11325
  }
11323
11326
  },
11324
11327
  "/v1/subscribers/{subscriberId}/credentials/{providerId}": {
11325
11328
  "delete": {
11326
- "operationId": "SubscribersController_deleteSubscriberCredentials",
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
- "api-key": []
11807
+ "secretKey": []
11805
11808
  }
11806
11809
  ]
11807
11810
  }
11808
11811
  },
11809
11812
  "/v1/subscribers/{subscriberId}/online-status": {
11810
11813
  "patch": {
11811
- "operationId": "SubscribersController_updateSubscriberOnlineFlag",
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
- "api-key": []
12302
+ "secretKey": []
12300
12303
  }
12301
12304
  ]
12302
12305
  }
12303
12306
  },
12304
12307
  "/v1/subscribers/{subscriberId}/preferences": {
12305
12308
  "get": {
12306
- "operationId": "SubscribersController_listSubscriberPreferences",
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
- "api-key": []
12798
+ "secretKey": []
12796
12799
  }
12797
12800
  ]
12798
12801
  },
12799
12802
  "patch": {
12800
- "operationId": "SubscribersController_updateSubscriberGlobalPreferences",
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
- "api-key": []
13290
+ "secretKey": []
13288
13291
  }
13289
13292
  ]
13290
13293
  }
13291
13294
  },
13292
13295
  "/v1/subscribers/{subscriberId}/preferences/{parameter}": {
13293
13296
  "get": {
13294
- "operationId": "SubscribersController_getSubscriberPreferenceByLevel",
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,12 @@
13794
13797
  ],
13795
13798
  "security": [
13796
13799
  {
13797
- "api-key": []
13800
+ "secretKey": []
13798
13801
  }
13799
13802
  ]
13800
13803
  },
13801
13804
  "patch": {
13802
- "operationId": "SubscribersController_updateSubscriberPreference",
13805
+ "operationId": "SubscribersV1Controller_updateSubscriberPreference",
13803
13806
  "x-speakeasy-group": "Subscribers.Preferences",
13804
13807
  "summary": "Update subscriber preference",
13805
13808
  "parameters": [
@@ -14294,14 +14297,14 @@
14294
14297
  ],
14295
14298
  "security": [
14296
14299
  {
14297
- "api-key": []
14300
+ "secretKey": []
14298
14301
  }
14299
14302
  ]
14300
14303
  }
14301
14304
  },
14302
14305
  "/v1/subscribers/{subscriberId}/notifications/feed": {
14303
14306
  "get": {
14304
- "operationId": "SubscribersController_getNotificationsFeed",
14307
+ "operationId": "SubscribersV1Controller_getNotificationsFeed",
14305
14308
  "x-speakeasy-name-override": "feed",
14306
14309
  "x-speakeasy-group": "Subscribers.Notifications",
14307
14310
  "summary": "Get in-app notification feed for a particular subscriber",
@@ -14822,14 +14825,14 @@
14822
14825
  ],
14823
14826
  "security": [
14824
14827
  {
14825
- "api-key": []
14828
+ "secretKey": []
14826
14829
  }
14827
14830
  ]
14828
14831
  }
14829
14832
  },
14830
14833
  "/v1/subscribers/{subscriberId}/notifications/unseen": {
14831
14834
  "get": {
14832
- "operationId": "SubscribersController_getUnseenCount",
14835
+ "operationId": "SubscribersV1Controller_getUnseenCount",
14833
14836
  "x-speakeasy-name-override": "unseenCount",
14834
14837
  "x-speakeasy-group": "Subscribers.Notifications",
14835
14838
  "summary": "Get the unseen in-app notifications count for subscribers feed",
@@ -15326,14 +15329,14 @@
15326
15329
  ],
15327
15330
  "security": [
15328
15331
  {
15329
- "api-key": []
15332
+ "secretKey": []
15330
15333
  }
15331
15334
  ]
15332
15335
  }
15333
15336
  },
15334
15337
  "/v1/subscribers/{subscriberId}/messages/mark-as": {
15335
15338
  "post": {
15336
- "operationId": "SubscribersController_markMessagesAs",
15339
+ "operationId": "SubscribersV1Controller_markMessagesAs",
15337
15340
  "x-speakeasy-name-override": "markAllAs",
15338
15341
  "x-speakeasy-group": "Subscribers.Messages",
15339
15342
  "summary": "Mark a subscriber messages as seen, read, unseen or unread",
@@ -15823,14 +15826,14 @@
15823
15826
  ],
15824
15827
  "security": [
15825
15828
  {
15826
- "api-key": []
15829
+ "secretKey": []
15827
15830
  }
15828
15831
  ]
15829
15832
  }
15830
15833
  },
15831
15834
  "/v1/subscribers/{subscriberId}/messages/mark-all": {
15832
15835
  "post": {
15833
- "operationId": "SubscribersController_markAllUnreadAsRead",
15836
+ "operationId": "SubscribersV1Controller_markAllUnreadAsRead",
15834
15837
  "x-speakeasy-name-override": "markAll",
15835
15838
  "x-speakeasy-group": "Subscribers.Messages",
15836
15839
  "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 +16320,14 @@
16317
16320
  ],
16318
16321
  "security": [
16319
16322
  {
16320
- "api-key": []
16323
+ "secretKey": []
16321
16324
  }
16322
16325
  ]
16323
16326
  }
16324
16327
  },
16325
16328
  "/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}": {
16326
16329
  "post": {
16327
- "operationId": "SubscribersController_markActionAsSeen",
16330
+ "operationId": "SubscribersV1Controller_markActionAsSeen",
16328
16331
  "x-speakeasy-name-override": "updateAsSeen",
16329
16332
  "x-speakeasy-group": "Subscribers.Messages",
16330
16333
  "summary": "Mark message action as seen",
@@ -16825,14 +16828,14 @@
16825
16828
  ],
16826
16829
  "security": [
16827
16830
  {
16828
- "api-key": []
16831
+ "secretKey": []
16829
16832
  }
16830
16833
  ]
16831
16834
  }
16832
16835
  },
16833
16836
  "/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth/callback": {
16834
16837
  "get": {
16835
- "operationId": "SubscribersController_chatOauthCallback",
16838
+ "operationId": "SubscribersV1Controller_chatOauthCallback",
16836
16839
  "x-speakeasy-name-override": "chatAccessOauthCallBack",
16837
16840
  "x-speakeasy-group": "Subscribers.Authentication",
16838
16841
  "summary": "Handle providers oauth redirect",
@@ -17391,14 +17394,14 @@
17391
17394
  ],
17392
17395
  "security": [
17393
17396
  {
17394
- "api-key": []
17397
+ "secretKey": []
17395
17398
  }
17396
17399
  ]
17397
17400
  }
17398
17401
  },
17399
17402
  "/v1/subscribers/{subscriberId}/credentials/{providerId}/oauth": {
17400
17403
  "get": {
17401
- "operationId": "SubscribersController_chatAccessOauth",
17404
+ "operationId": "SubscribersV1Controller_chatAccessOauth",
17402
17405
  "x-speakeasy-name-override": "chatAccessOauth",
17403
17406
  "x-speakeasy-group": "Subscribers.Authentication",
17404
17407
  "summary": "Handle chat oauth",
@@ -17878,51 +17881,69 @@
17878
17881
  ],
17879
17882
  "security": [
17880
17883
  {
17881
- "api-key": []
17884
+ "secretKey": []
17882
17885
  }
17883
17886
  ]
17884
17887
  }
17885
17888
  },
17886
- "/v1/messages": {
17889
+ "/v2/subscribers": {
17887
17890
  "get": {
17888
- "operationId": "MessagesController_getMessages",
17889
- "summary": "Get messages",
17890
- "description": "Returns a list of messages, could paginate using the `page` query parameter",
17891
+ "operationId": "SubscribersController_searchSubscribers",
17892
+ "x-speakeasy-name-override": "search",
17893
+ "summary": "Search for subscribers",
17891
17894
  "parameters": [
17892
17895
  {
17893
- "name": "channel",
17896
+ "name": "after",
17894
17897
  "required": false,
17895
17898
  "in": "query",
17899
+ "description": "Cursor for pagination indicating the starting point after which to fetch results.",
17896
17900
  "schema": {
17897
- "$ref": "#/components/schemas/ChannelTypeEnum"
17901
+ "type": "string"
17898
17902
  }
17899
17903
  },
17900
17904
  {
17901
- "name": "subscriberId",
17905
+ "name": "before",
17902
17906
  "required": false,
17903
17907
  "in": "query",
17908
+ "description": "Cursor for pagination indicating the ending point before which to fetch results.",
17904
17909
  "schema": {
17905
17910
  "type": "string"
17906
17911
  }
17907
17912
  },
17908
17913
  {
17909
- "name": "transactionId",
17914
+ "name": "email",
17910
17915
  "required": false,
17911
17916
  "in": "query",
17917
+ "description": "Email address of the subscriber to filter results.",
17912
17918
  "schema": {
17913
- "type": "array",
17914
- "items": {
17915
- "type": "string"
17916
- }
17919
+ "type": "string"
17917
17920
  }
17918
17921
  },
17919
17922
  {
17920
- "name": "page",
17923
+ "name": "name",
17921
17924
  "required": false,
17922
17925
  "in": "query",
17926
+ "description": "Name of the subscriber to filter results.",
17923
17927
  "schema": {
17924
- "default": 0,
17925
- "type": "number"
17928
+ "type": "string"
17929
+ }
17930
+ },
17931
+ {
17932
+ "name": "phone",
17933
+ "required": false,
17934
+ "in": "query",
17935
+ "description": "Phone number of the subscriber to filter results.",
17936
+ "schema": {
17937
+ "type": "string"
17938
+ }
17939
+ },
17940
+ {
17941
+ "name": "subscriberId",
17942
+ "required": false,
17943
+ "in": "query",
17944
+ "description": "Unique identifier of the subscriber to filter results.",
17945
+ "schema": {
17946
+ "type": "string"
17926
17947
  }
17927
17948
  },
17928
17949
  {
@@ -17930,10 +17951,27 @@
17930
17951
  "required": false,
17931
17952
  "in": "query",
17932
17953
  "schema": {
17933
- "default": 10,
17934
17954
  "type": "number"
17935
17955
  }
17936
17956
  },
17957
+ {
17958
+ "name": "orderDirection",
17959
+ "required": false,
17960
+ "in": "query",
17961
+ "schema": {
17962
+ "enum": [
17963
+ "ASC",
17964
+ "DESC"
17965
+ ],
17966
+ "type": "string"
17967
+ }
17968
+ },
17969
+ {
17970
+ "name": "orderBy",
17971
+ "required": false,
17972
+ "in": "query",
17973
+ "schema": {}
17974
+ },
17937
17975
  {
17938
17976
  "name": "idempotency-key",
17939
17977
  "in": "header",
@@ -17946,6 +17984,7 @@
17946
17984
  ],
17947
17985
  "responses": {
17948
17986
  "200": {
17987
+ "description": "OK",
17949
17988
  "headers": {
17950
17989
  "Content-Type": {
17951
17990
  "$ref": "#/components/headers/Content-Type"
@@ -17969,11 +18008,10 @@
17969
18008
  "$ref": "#/components/headers/Idempotency-Replay"
17970
18009
  }
17971
18010
  },
17972
- "description": "",
17973
18011
  "content": {
17974
18012
  "application/json": {
17975
18013
  "schema": {
17976
- "$ref": "#/components/schemas/ActivitiesResponseDto"
18014
+ "$ref": "#/components/schemas/ListSubscribersResponseDto"
17977
18015
  }
17978
18016
  }
17979
18017
  }
@@ -18394,23 +18432,24 @@
18394
18432
  }
18395
18433
  },
18396
18434
  "tags": [
18397
- "Messages"
18435
+ "Subscribers"
18398
18436
  ],
18399
18437
  "security": [
18400
18438
  {
18401
- "api-key": []
18439
+ "secretKey": []
18402
18440
  }
18403
18441
  ]
18404
18442
  }
18405
18443
  },
18406
- "/v1/messages/{messageId}": {
18407
- "delete": {
18408
- "operationId": "MessagesController_deleteMessage",
18409
- "summary": "Delete message",
18410
- "description": "Deletes a message entity from the Novu platform",
18444
+ "/v2/subscribers/{subscriberId}": {
18445
+ "get": {
18446
+ "operationId": "SubscribersController_getSubscriber",
18447
+ "x-speakeasy-name-override": "retrieve",
18448
+ "summary": "Get subscriber",
18449
+ "description": "Get subscriber by your internal id used to identify the subscriber",
18411
18450
  "parameters": [
18412
18451
  {
18413
- "name": "messageId",
18452
+ "name": "subscriberId",
18414
18453
  "required": true,
18415
18454
  "in": "path",
18416
18455
  "schema": {
@@ -18456,7 +18495,7 @@
18456
18495
  "content": {
18457
18496
  "application/json": {
18458
18497
  "schema": {
18459
- "$ref": "#/components/schemas/DeleteMessageResponseDto"
18498
+ "$ref": "#/components/schemas/SubscriberResponseDto"
18460
18499
  }
18461
18500
  }
18462
18501
  }
@@ -18877,40 +18916,22 @@
18877
18916
  }
18878
18917
  },
18879
18918
  "tags": [
18880
- "Messages"
18919
+ "Subscribers"
18881
18920
  ],
18882
18921
  "security": [
18883
18922
  {
18884
- "api-key": []
18923
+ "secretKey": []
18885
18924
  }
18886
18925
  ]
18887
- }
18888
- },
18889
- "/v1/messages/transaction/{transactionId}": {
18890
- "delete": {
18891
- "operationId": "MessagesController_deleteMessagesByTransactionId",
18892
- "x-speakeasy-name-override": "deleteByTransactionId",
18893
- "summary": "Delete messages by transactionId",
18894
- "description": "Deletes messages entity from the Novu platform using TransactionId of message",
18926
+ },
18927
+ "patch": {
18928
+ "operationId": "SubscribersController_patchSubscriber",
18929
+ "x-speakeasy-name-override": "patch",
18930
+ "summary": "Patch subscriber",
18931
+ "description": "Patch subscriber by your internal id used to identify the subscriber",
18895
18932
  "parameters": [
18896
18933
  {
18897
- "name": "channel",
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",
18934
+ "name": "subscriberId",
18914
18935
  "required": true,
18915
18936
  "in": "path",
18916
18937
  "schema": {
@@ -18927,8 +18948,19 @@
18927
18948
  }
18928
18949
  }
18929
18950
  ],
18951
+ "requestBody": {
18952
+ "required": true,
18953
+ "content": {
18954
+ "application/json": {
18955
+ "schema": {
18956
+ "$ref": "#/components/schemas/PatchSubscriberRequestDto"
18957
+ }
18958
+ }
18959
+ }
18960
+ },
18930
18961
  "responses": {
18931
- "204": {
18962
+ "200": {
18963
+ "description": "OK",
18932
18964
  "headers": {
18933
18965
  "Content-Type": {
18934
18966
  "$ref": "#/components/headers/Content-Type"
@@ -18952,7 +18984,13 @@
18952
18984
  "$ref": "#/components/headers/Idempotency-Replay"
18953
18985
  }
18954
18986
  },
18955
- "description": ""
18987
+ "content": {
18988
+ "application/json": {
18989
+ "schema": {
18990
+ "$ref": "#/components/schemas/SubscriberResponseDto"
18991
+ }
18992
+ }
18993
+ }
18956
18994
  },
18957
18995
  "400": {
18958
18996
  "description": "Bad Request",
@@ -19370,21 +19408,28 @@
19370
19408
  }
19371
19409
  },
19372
19410
  "tags": [
19373
- "Messages"
19411
+ "Subscribers"
19374
19412
  ],
19375
19413
  "security": [
19376
19414
  {
19377
- "api-key": []
19415
+ "secretKey": []
19378
19416
  }
19379
19417
  ]
19380
- }
19381
- },
19382
- "/v1/topics": {
19383
- "post": {
19384
- "operationId": "TopicsController_createTopic",
19385
- "summary": "Topic creation",
19386
- "description": "Create a topic",
19418
+ },
19419
+ "delete": {
19420
+ "operationId": "SubscribersController_removeSubscriber",
19421
+ "x-speakeasy-name-override": "delete",
19422
+ "summary": "Delete subscriber",
19423
+ "description": "Deletes a subscriber entity from the Novu platform",
19387
19424
  "parameters": [
19425
+ {
19426
+ "name": "subscriberId",
19427
+ "required": true,
19428
+ "in": "path",
19429
+ "schema": {
19430
+ "type": "string"
19431
+ }
19432
+ },
19388
19433
  {
19389
19434
  "name": "idempotency-key",
19390
19435
  "in": "header",
@@ -19395,19 +19440,9 @@
19395
19440
  }
19396
19441
  }
19397
19442
  ],
19398
- "requestBody": {
19399
- "required": true,
19400
- "content": {
19401
- "application/json": {
19402
- "schema": {
19403
- "$ref": "#/components/schemas/CreateTopicRequestDto"
19404
- }
19405
- }
19406
- }
19407
- },
19408
19443
  "responses": {
19409
- "201": {
19410
- "description": "Created",
19444
+ "200": {
19445
+ "description": "OK",
19411
19446
  "headers": {
19412
19447
  "Content-Type": {
19413
19448
  "$ref": "#/components/headers/Content-Type"
@@ -19434,7 +19469,7 @@
19434
19469
  "content": {
19435
19470
  "application/json": {
19436
19471
  "schema": {
19437
- "$ref": "#/components/schemas/CreateTopicResponseDto"
19472
+ "$ref": "#/components/schemas/RemoveSubscriberResponseDto"
19438
19473
  }
19439
19474
  }
19440
19475
  }
@@ -19855,51 +19890,64 @@
19855
19890
  }
19856
19891
  },
19857
19892
  "tags": [
19858
- "Topics"
19893
+ "Subscribers"
19859
19894
  ],
19860
19895
  "security": [
19861
19896
  {
19862
- "api-key": []
19897
+ "secretKey": []
19863
19898
  }
19864
19899
  ]
19865
- },
19900
+ }
19901
+ },
19902
+ "/v1/messages": {
19866
19903
  "get": {
19867
- "operationId": "TopicsController_listTopics",
19868
- "summary": "Get topic list filtered ",
19869
- "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",
19904
+ "operationId": "MessagesController_getMessages",
19905
+ "summary": "Get messages",
19906
+ "description": "Returns a list of messages, could paginate using the `page` query parameter",
19870
19907
  "parameters": [
19871
19908
  {
19872
- "name": "page",
19909
+ "name": "channel",
19873
19910
  "required": false,
19874
19911
  "in": "query",
19875
- "example": 0,
19876
- "description": "The page number to retrieve (starts from 0)",
19877
19912
  "schema": {
19878
- "format": "int64",
19879
- "default": 0,
19880
- "type": "integer"
19913
+ "$ref": "#/components/schemas/ChannelTypeEnum"
19881
19914
  }
19882
19915
  },
19883
19916
  {
19884
- "name": "pageSize",
19917
+ "name": "subscriberId",
19885
19918
  "required": false,
19886
19919
  "in": "query",
19887
- "example": 10,
19888
- "description": "The number of items to return per page (default: 10)",
19889
19920
  "schema": {
19890
- "format": "int64",
19891
- "default": 10,
19892
- "type": "integer"
19921
+ "type": "string"
19893
19922
  }
19894
19923
  },
19895
19924
  {
19896
- "name": "key",
19925
+ "name": "transactionId",
19897
19926
  "required": false,
19898
19927
  "in": "query",
19899
- "example": "exampleKey",
19900
- "description": "A filter key to apply to the results",
19901
19928
  "schema": {
19902
- "type": "string"
19929
+ "type": "array",
19930
+ "items": {
19931
+ "type": "string"
19932
+ }
19933
+ }
19934
+ },
19935
+ {
19936
+ "name": "page",
19937
+ "required": false,
19938
+ "in": "query",
19939
+ "schema": {
19940
+ "default": 0,
19941
+ "type": "number"
19942
+ }
19943
+ },
19944
+ {
19945
+ "name": "limit",
19946
+ "required": false,
19947
+ "in": "query",
19948
+ "schema": {
19949
+ "default": 10,
19950
+ "type": "number"
19903
19951
  }
19904
19952
  },
19905
19953
  {
@@ -19941,7 +19989,7 @@
19941
19989
  "content": {
19942
19990
  "application/json": {
19943
19991
  "schema": {
19944
- "$ref": "#/components/schemas/FilterTopicsResponseDto"
19992
+ "$ref": "#/components/schemas/ActivitiesResponseDto"
19945
19993
  }
19946
19994
  }
19947
19995
  }
@@ -20362,28 +20410,25 @@
20362
20410
  }
20363
20411
  },
20364
20412
  "tags": [
20365
- "Topics"
20413
+ "Messages"
20366
20414
  ],
20367
20415
  "security": [
20368
20416
  {
20369
- "api-key": []
20417
+ "secretKey": []
20370
20418
  }
20371
20419
  ]
20372
20420
  }
20373
20421
  },
20374
- "/v1/topics/{topicKey}/subscribers": {
20375
- "post": {
20376
- "operationId": "TopicsController_assign",
20377
- "x-speakeasy-name-override": "assign",
20378
- "x-speakeasy-group": "Topics.Subscribers",
20379
- "summary": "Subscribers addition",
20380
- "description": "Add subscribers to a topic by key",
20422
+ "/v1/messages/{messageId}": {
20423
+ "delete": {
20424
+ "operationId": "MessagesController_deleteMessage",
20425
+ "summary": "Delete message",
20426
+ "description": "Deletes a message entity from the Novu platform",
20381
20427
  "parameters": [
20382
20428
  {
20383
- "name": "topicKey",
20429
+ "name": "messageId",
20384
20430
  "required": true,
20385
20431
  "in": "path",
20386
- "description": "The topic key",
20387
20432
  "schema": {
20388
20433
  "type": "string"
20389
20434
  }
@@ -20398,18 +20443,9 @@
20398
20443
  }
20399
20444
  }
20400
20445
  ],
20401
- "requestBody": {
20402
- "required": true,
20403
- "content": {
20404
- "application/json": {
20405
- "schema": {
20406
- "$ref": "#/components/schemas/AddSubscribersRequestDto"
20407
- }
20408
- }
20409
- }
20410
- },
20411
20446
  "responses": {
20412
20447
  "200": {
20448
+ "description": "OK",
20413
20449
  "headers": {
20414
20450
  "Content-Type": {
20415
20451
  "$ref": "#/components/headers/Content-Type"
@@ -20433,11 +20469,10 @@
20433
20469
  "$ref": "#/components/headers/Idempotency-Replay"
20434
20470
  }
20435
20471
  },
20436
- "description": "",
20437
20472
  "content": {
20438
20473
  "application/json": {
20439
20474
  "schema": {
20440
- "$ref": "#/components/schemas/AssignSubscriberToTopicDto"
20475
+ "$ref": "#/components/schemas/DeleteMessageResponseDto"
20441
20476
  }
20442
20477
  }
20443
20478
  }
@@ -20858,24 +20893,2005 @@
20858
20893
  }
20859
20894
  },
20860
20895
  "tags": [
20861
- "Topics"
20896
+ "Messages"
20862
20897
  ],
20863
20898
  "security": [
20864
20899
  {
20865
- "api-key": []
20900
+ "secretKey": []
20866
20901
  }
20867
20902
  ]
20868
20903
  }
20869
20904
  },
20870
- "/v1/topics/{topicKey}/subscribers/{externalSubscriberId}": {
20871
- "get": {
20872
- "operationId": "TopicsController_getTopicSubscriber",
20873
- "x-speakeasy-group": "Topics.Subscribers",
20874
- "summary": "Check topic subscriber",
20875
- "description": "Check if a subscriber belongs to a certain topic",
20876
- "parameters": [
20877
- {
20878
- "name": "externalSubscriberId",
20905
+ "/v1/messages/transaction/{transactionId}": {
20906
+ "delete": {
20907
+ "operationId": "MessagesController_deleteMessagesByTransactionId",
20908
+ "x-speakeasy-name-override": "deleteByTransactionId",
20909
+ "summary": "Delete messages by transactionId",
20910
+ "description": "Deletes messages entity from the Novu platform using TransactionId of message",
20911
+ "parameters": [
20912
+ {
20913
+ "name": "channel",
20914
+ "required": false,
20915
+ "in": "query",
20916
+ "description": "The channel of the message to be deleted",
20917
+ "schema": {
20918
+ "enum": [
20919
+ "in_app",
20920
+ "email",
20921
+ "sms",
20922
+ "chat",
20923
+ "push"
20924
+ ],
20925
+ "type": "string"
20926
+ }
20927
+ },
20928
+ {
20929
+ "name": "transactionId",
20930
+ "required": true,
20931
+ "in": "path",
20932
+ "schema": {
20933
+ "type": "string"
20934
+ }
20935
+ },
20936
+ {
20937
+ "name": "idempotency-key",
20938
+ "in": "header",
20939
+ "description": "A header for idempotency purposes",
20940
+ "required": false,
20941
+ "schema": {
20942
+ "type": "string"
20943
+ }
20944
+ }
20945
+ ],
20946
+ "responses": {
20947
+ "204": {
20948
+ "headers": {
20949
+ "Content-Type": {
20950
+ "$ref": "#/components/headers/Content-Type"
20951
+ },
20952
+ "RateLimit-Limit": {
20953
+ "$ref": "#/components/headers/RateLimit-Limit"
20954
+ },
20955
+ "RateLimit-Remaining": {
20956
+ "$ref": "#/components/headers/RateLimit-Remaining"
20957
+ },
20958
+ "RateLimit-Reset": {
20959
+ "$ref": "#/components/headers/RateLimit-Reset"
20960
+ },
20961
+ "RateLimit-Policy": {
20962
+ "$ref": "#/components/headers/RateLimit-Policy"
20963
+ },
20964
+ "Idempotency-Key": {
20965
+ "$ref": "#/components/headers/Idempotency-Key"
20966
+ },
20967
+ "Idempotency-Replay": {
20968
+ "$ref": "#/components/headers/Idempotency-Replay"
20969
+ }
20970
+ },
20971
+ "description": ""
20972
+ },
20973
+ "400": {
20974
+ "description": "Bad Request",
20975
+ "headers": {
20976
+ "Content-Type": {
20977
+ "$ref": "#/components/headers/Content-Type"
20978
+ },
20979
+ "RateLimit-Limit": {
20980
+ "$ref": "#/components/headers/RateLimit-Limit"
20981
+ },
20982
+ "RateLimit-Remaining": {
20983
+ "$ref": "#/components/headers/RateLimit-Remaining"
20984
+ },
20985
+ "RateLimit-Reset": {
20986
+ "$ref": "#/components/headers/RateLimit-Reset"
20987
+ },
20988
+ "RateLimit-Policy": {
20989
+ "$ref": "#/components/headers/RateLimit-Policy"
20990
+ },
20991
+ "Idempotency-Key": {
20992
+ "$ref": "#/components/headers/Idempotency-Key"
20993
+ },
20994
+ "Idempotency-Replay": {
20995
+ "$ref": "#/components/headers/Idempotency-Replay"
20996
+ }
20997
+ },
20998
+ "content": {
20999
+ "application/json": {
21000
+ "schema": {
21001
+ "$ref": "#/components/schemas/ErrorDto"
21002
+ }
21003
+ }
21004
+ }
21005
+ },
21006
+ "401": {
21007
+ "description": "Unauthorized",
21008
+ "headers": {
21009
+ "Content-Type": {
21010
+ "$ref": "#/components/headers/Content-Type"
21011
+ },
21012
+ "RateLimit-Limit": {
21013
+ "$ref": "#/components/headers/RateLimit-Limit"
21014
+ },
21015
+ "RateLimit-Remaining": {
21016
+ "$ref": "#/components/headers/RateLimit-Remaining"
21017
+ },
21018
+ "RateLimit-Reset": {
21019
+ "$ref": "#/components/headers/RateLimit-Reset"
21020
+ },
21021
+ "RateLimit-Policy": {
21022
+ "$ref": "#/components/headers/RateLimit-Policy"
21023
+ },
21024
+ "Idempotency-Key": {
21025
+ "$ref": "#/components/headers/Idempotency-Key"
21026
+ },
21027
+ "Idempotency-Replay": {
21028
+ "$ref": "#/components/headers/Idempotency-Replay"
21029
+ }
21030
+ },
21031
+ "content": {
21032
+ "application/json": {
21033
+ "schema": {
21034
+ "$ref": "#/components/schemas/ErrorDto"
21035
+ }
21036
+ }
21037
+ }
21038
+ },
21039
+ "403": {
21040
+ "description": "Forbidden",
21041
+ "headers": {
21042
+ "Content-Type": {
21043
+ "$ref": "#/components/headers/Content-Type"
21044
+ },
21045
+ "RateLimit-Limit": {
21046
+ "$ref": "#/components/headers/RateLimit-Limit"
21047
+ },
21048
+ "RateLimit-Remaining": {
21049
+ "$ref": "#/components/headers/RateLimit-Remaining"
21050
+ },
21051
+ "RateLimit-Reset": {
21052
+ "$ref": "#/components/headers/RateLimit-Reset"
21053
+ },
21054
+ "RateLimit-Policy": {
21055
+ "$ref": "#/components/headers/RateLimit-Policy"
21056
+ },
21057
+ "Idempotency-Key": {
21058
+ "$ref": "#/components/headers/Idempotency-Key"
21059
+ },
21060
+ "Idempotency-Replay": {
21061
+ "$ref": "#/components/headers/Idempotency-Replay"
21062
+ }
21063
+ },
21064
+ "content": {
21065
+ "application/json": {
21066
+ "schema": {
21067
+ "$ref": "#/components/schemas/ErrorDto"
21068
+ }
21069
+ }
21070
+ }
21071
+ },
21072
+ "404": {
21073
+ "description": "Not Found",
21074
+ "headers": {
21075
+ "Content-Type": {
21076
+ "$ref": "#/components/headers/Content-Type"
21077
+ },
21078
+ "RateLimit-Limit": {
21079
+ "$ref": "#/components/headers/RateLimit-Limit"
21080
+ },
21081
+ "RateLimit-Remaining": {
21082
+ "$ref": "#/components/headers/RateLimit-Remaining"
21083
+ },
21084
+ "RateLimit-Reset": {
21085
+ "$ref": "#/components/headers/RateLimit-Reset"
21086
+ },
21087
+ "RateLimit-Policy": {
21088
+ "$ref": "#/components/headers/RateLimit-Policy"
21089
+ },
21090
+ "Idempotency-Key": {
21091
+ "$ref": "#/components/headers/Idempotency-Key"
21092
+ },
21093
+ "Idempotency-Replay": {
21094
+ "$ref": "#/components/headers/Idempotency-Replay"
21095
+ }
21096
+ },
21097
+ "content": {
21098
+ "application/json": {
21099
+ "schema": {
21100
+ "$ref": "#/components/schemas/ErrorDto"
21101
+ }
21102
+ }
21103
+ }
21104
+ },
21105
+ "405": {
21106
+ "description": "Method Not Allowed",
21107
+ "headers": {
21108
+ "Content-Type": {
21109
+ "$ref": "#/components/headers/Content-Type"
21110
+ },
21111
+ "RateLimit-Limit": {
21112
+ "$ref": "#/components/headers/RateLimit-Limit"
21113
+ },
21114
+ "RateLimit-Remaining": {
21115
+ "$ref": "#/components/headers/RateLimit-Remaining"
21116
+ },
21117
+ "RateLimit-Reset": {
21118
+ "$ref": "#/components/headers/RateLimit-Reset"
21119
+ },
21120
+ "RateLimit-Policy": {
21121
+ "$ref": "#/components/headers/RateLimit-Policy"
21122
+ },
21123
+ "Idempotency-Key": {
21124
+ "$ref": "#/components/headers/Idempotency-Key"
21125
+ },
21126
+ "Idempotency-Replay": {
21127
+ "$ref": "#/components/headers/Idempotency-Replay"
21128
+ }
21129
+ },
21130
+ "content": {
21131
+ "application/json": {
21132
+ "schema": {
21133
+ "$ref": "#/components/schemas/ErrorDto"
21134
+ }
21135
+ }
21136
+ }
21137
+ },
21138
+ "409": {
21139
+ "description": "Conflict",
21140
+ "headers": {
21141
+ "Content-Type": {
21142
+ "$ref": "#/components/headers/Content-Type"
21143
+ },
21144
+ "RateLimit-Limit": {
21145
+ "$ref": "#/components/headers/RateLimit-Limit"
21146
+ },
21147
+ "RateLimit-Remaining": {
21148
+ "$ref": "#/components/headers/RateLimit-Remaining"
21149
+ },
21150
+ "RateLimit-Reset": {
21151
+ "$ref": "#/components/headers/RateLimit-Reset"
21152
+ },
21153
+ "RateLimit-Policy": {
21154
+ "$ref": "#/components/headers/RateLimit-Policy"
21155
+ },
21156
+ "Idempotency-Key": {
21157
+ "$ref": "#/components/headers/Idempotency-Key"
21158
+ },
21159
+ "Idempotency-Replay": {
21160
+ "$ref": "#/components/headers/Idempotency-Replay"
21161
+ }
21162
+ },
21163
+ "content": {
21164
+ "application/json": {
21165
+ "schema": {
21166
+ "$ref": "#/components/schemas/ErrorDto"
21167
+ }
21168
+ }
21169
+ }
21170
+ },
21171
+ "413": {
21172
+ "description": "Payload Too Large",
21173
+ "headers": {
21174
+ "Content-Type": {
21175
+ "$ref": "#/components/headers/Content-Type"
21176
+ },
21177
+ "RateLimit-Limit": {
21178
+ "$ref": "#/components/headers/RateLimit-Limit"
21179
+ },
21180
+ "RateLimit-Remaining": {
21181
+ "$ref": "#/components/headers/RateLimit-Remaining"
21182
+ },
21183
+ "RateLimit-Reset": {
21184
+ "$ref": "#/components/headers/RateLimit-Reset"
21185
+ },
21186
+ "RateLimit-Policy": {
21187
+ "$ref": "#/components/headers/RateLimit-Policy"
21188
+ },
21189
+ "Idempotency-Key": {
21190
+ "$ref": "#/components/headers/Idempotency-Key"
21191
+ },
21192
+ "Idempotency-Replay": {
21193
+ "$ref": "#/components/headers/Idempotency-Replay"
21194
+ }
21195
+ },
21196
+ "content": {
21197
+ "application/json": {
21198
+ "schema": {
21199
+ "$ref": "#/components/schemas/ErrorDto"
21200
+ }
21201
+ }
21202
+ }
21203
+ },
21204
+ "414": {
21205
+ "description": "URI Too Long",
21206
+ "content": {
21207
+ "application/json": {
21208
+ "schema": {
21209
+ "$ref": "#/components/schemas/ErrorDto"
21210
+ }
21211
+ }
21212
+ }
21213
+ },
21214
+ "415": {
21215
+ "description": "Unsupported Media Type",
21216
+ "headers": {
21217
+ "Content-Type": {
21218
+ "$ref": "#/components/headers/Content-Type"
21219
+ },
21220
+ "RateLimit-Limit": {
21221
+ "$ref": "#/components/headers/RateLimit-Limit"
21222
+ },
21223
+ "RateLimit-Remaining": {
21224
+ "$ref": "#/components/headers/RateLimit-Remaining"
21225
+ },
21226
+ "RateLimit-Reset": {
21227
+ "$ref": "#/components/headers/RateLimit-Reset"
21228
+ },
21229
+ "RateLimit-Policy": {
21230
+ "$ref": "#/components/headers/RateLimit-Policy"
21231
+ },
21232
+ "Idempotency-Key": {
21233
+ "$ref": "#/components/headers/Idempotency-Key"
21234
+ },
21235
+ "Idempotency-Replay": {
21236
+ "$ref": "#/components/headers/Idempotency-Replay"
21237
+ }
21238
+ },
21239
+ "content": {
21240
+ "application/json": {
21241
+ "schema": {
21242
+ "$ref": "#/components/schemas/ErrorDto"
21243
+ }
21244
+ }
21245
+ }
21246
+ },
21247
+ "422": {
21248
+ "description": "Unprocessable Entity",
21249
+ "headers": {
21250
+ "Content-Type": {
21251
+ "$ref": "#/components/headers/Content-Type"
21252
+ },
21253
+ "RateLimit-Limit": {
21254
+ "$ref": "#/components/headers/RateLimit-Limit"
21255
+ },
21256
+ "RateLimit-Remaining": {
21257
+ "$ref": "#/components/headers/RateLimit-Remaining"
21258
+ },
21259
+ "RateLimit-Reset": {
21260
+ "$ref": "#/components/headers/RateLimit-Reset"
21261
+ },
21262
+ "RateLimit-Policy": {
21263
+ "$ref": "#/components/headers/RateLimit-Policy"
21264
+ },
21265
+ "Idempotency-Key": {
21266
+ "$ref": "#/components/headers/Idempotency-Key"
21267
+ },
21268
+ "Idempotency-Replay": {
21269
+ "$ref": "#/components/headers/Idempotency-Replay"
21270
+ }
21271
+ },
21272
+ "content": {
21273
+ "application/json": {
21274
+ "schema": {
21275
+ "$ref": "#/components/schemas/ValidationErrorDto"
21276
+ }
21277
+ }
21278
+ }
21279
+ },
21280
+ "429": {
21281
+ "description": "The client has sent too many requests in a given amount of time. ",
21282
+ "headers": {
21283
+ "Content-Type": {
21284
+ "$ref": "#/components/headers/Content-Type"
21285
+ },
21286
+ "RateLimit-Limit": {
21287
+ "$ref": "#/components/headers/RateLimit-Limit"
21288
+ },
21289
+ "RateLimit-Remaining": {
21290
+ "$ref": "#/components/headers/RateLimit-Remaining"
21291
+ },
21292
+ "RateLimit-Reset": {
21293
+ "$ref": "#/components/headers/RateLimit-Reset"
21294
+ },
21295
+ "RateLimit-Policy": {
21296
+ "$ref": "#/components/headers/RateLimit-Policy"
21297
+ },
21298
+ "Idempotency-Key": {
21299
+ "$ref": "#/components/headers/Idempotency-Key"
21300
+ },
21301
+ "Idempotency-Replay": {
21302
+ "$ref": "#/components/headers/Idempotency-Replay"
21303
+ },
21304
+ "Retry-After": {
21305
+ "$ref": "#/components/headers/Retry-After"
21306
+ }
21307
+ },
21308
+ "content": {
21309
+ "application/json": {
21310
+ "schema": {
21311
+ "type": "string",
21312
+ "example": "API rate limit exceeded"
21313
+ }
21314
+ }
21315
+ }
21316
+ },
21317
+ "500": {
21318
+ "description": "Internal Server Error",
21319
+ "headers": {
21320
+ "Content-Type": {
21321
+ "$ref": "#/components/headers/Content-Type"
21322
+ },
21323
+ "RateLimit-Limit": {
21324
+ "$ref": "#/components/headers/RateLimit-Limit"
21325
+ },
21326
+ "RateLimit-Remaining": {
21327
+ "$ref": "#/components/headers/RateLimit-Remaining"
21328
+ },
21329
+ "RateLimit-Reset": {
21330
+ "$ref": "#/components/headers/RateLimit-Reset"
21331
+ },
21332
+ "RateLimit-Policy": {
21333
+ "$ref": "#/components/headers/RateLimit-Policy"
21334
+ },
21335
+ "Idempotency-Key": {
21336
+ "$ref": "#/components/headers/Idempotency-Key"
21337
+ },
21338
+ "Idempotency-Replay": {
21339
+ "$ref": "#/components/headers/Idempotency-Replay"
21340
+ }
21341
+ },
21342
+ "content": {
21343
+ "application/json": {
21344
+ "schema": {
21345
+ "$ref": "#/components/schemas/ErrorDto"
21346
+ }
21347
+ }
21348
+ }
21349
+ },
21350
+ "503": {
21351
+ "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.",
21352
+ "headers": {
21353
+ "Content-Type": {
21354
+ "$ref": "#/components/headers/Content-Type"
21355
+ },
21356
+ "RateLimit-Limit": {
21357
+ "$ref": "#/components/headers/RateLimit-Limit"
21358
+ },
21359
+ "RateLimit-Remaining": {
21360
+ "$ref": "#/components/headers/RateLimit-Remaining"
21361
+ },
21362
+ "RateLimit-Reset": {
21363
+ "$ref": "#/components/headers/RateLimit-Reset"
21364
+ },
21365
+ "RateLimit-Policy": {
21366
+ "$ref": "#/components/headers/RateLimit-Policy"
21367
+ },
21368
+ "Idempotency-Key": {
21369
+ "$ref": "#/components/headers/Idempotency-Key"
21370
+ },
21371
+ "Idempotency-Replay": {
21372
+ "$ref": "#/components/headers/Idempotency-Replay"
21373
+ },
21374
+ "Retry-After": {
21375
+ "$ref": "#/components/headers/Retry-After"
21376
+ }
21377
+ },
21378
+ "content": {
21379
+ "application/json": {
21380
+ "schema": {
21381
+ "type": "string",
21382
+ "example": "Please wait some time, then try again."
21383
+ }
21384
+ }
21385
+ }
21386
+ }
21387
+ },
21388
+ "tags": [
21389
+ "Messages"
21390
+ ],
21391
+ "security": [
21392
+ {
21393
+ "secretKey": []
21394
+ }
21395
+ ]
21396
+ }
21397
+ },
21398
+ "/v1/topics": {
21399
+ "post": {
21400
+ "operationId": "TopicsController_createTopic",
21401
+ "summary": "Topic creation",
21402
+ "description": "Create a topic",
21403
+ "parameters": [
21404
+ {
21405
+ "name": "idempotency-key",
21406
+ "in": "header",
21407
+ "description": "A header for idempotency purposes",
21408
+ "required": false,
21409
+ "schema": {
21410
+ "type": "string"
21411
+ }
21412
+ }
21413
+ ],
21414
+ "requestBody": {
21415
+ "required": true,
21416
+ "content": {
21417
+ "application/json": {
21418
+ "schema": {
21419
+ "$ref": "#/components/schemas/CreateTopicRequestDto"
21420
+ }
21421
+ }
21422
+ }
21423
+ },
21424
+ "responses": {
21425
+ "201": {
21426
+ "description": "Created",
21427
+ "headers": {
21428
+ "Content-Type": {
21429
+ "$ref": "#/components/headers/Content-Type"
21430
+ },
21431
+ "RateLimit-Limit": {
21432
+ "$ref": "#/components/headers/RateLimit-Limit"
21433
+ },
21434
+ "RateLimit-Remaining": {
21435
+ "$ref": "#/components/headers/RateLimit-Remaining"
21436
+ },
21437
+ "RateLimit-Reset": {
21438
+ "$ref": "#/components/headers/RateLimit-Reset"
21439
+ },
21440
+ "RateLimit-Policy": {
21441
+ "$ref": "#/components/headers/RateLimit-Policy"
21442
+ },
21443
+ "Idempotency-Key": {
21444
+ "$ref": "#/components/headers/Idempotency-Key"
21445
+ },
21446
+ "Idempotency-Replay": {
21447
+ "$ref": "#/components/headers/Idempotency-Replay"
21448
+ }
21449
+ },
21450
+ "content": {
21451
+ "application/json": {
21452
+ "schema": {
21453
+ "$ref": "#/components/schemas/CreateTopicResponseDto"
21454
+ }
21455
+ }
21456
+ }
21457
+ },
21458
+ "400": {
21459
+ "description": "Bad Request",
21460
+ "headers": {
21461
+ "Content-Type": {
21462
+ "$ref": "#/components/headers/Content-Type"
21463
+ },
21464
+ "RateLimit-Limit": {
21465
+ "$ref": "#/components/headers/RateLimit-Limit"
21466
+ },
21467
+ "RateLimit-Remaining": {
21468
+ "$ref": "#/components/headers/RateLimit-Remaining"
21469
+ },
21470
+ "RateLimit-Reset": {
21471
+ "$ref": "#/components/headers/RateLimit-Reset"
21472
+ },
21473
+ "RateLimit-Policy": {
21474
+ "$ref": "#/components/headers/RateLimit-Policy"
21475
+ },
21476
+ "Idempotency-Key": {
21477
+ "$ref": "#/components/headers/Idempotency-Key"
21478
+ },
21479
+ "Idempotency-Replay": {
21480
+ "$ref": "#/components/headers/Idempotency-Replay"
21481
+ }
21482
+ },
21483
+ "content": {
21484
+ "application/json": {
21485
+ "schema": {
21486
+ "$ref": "#/components/schemas/ErrorDto"
21487
+ }
21488
+ }
21489
+ }
21490
+ },
21491
+ "401": {
21492
+ "description": "Unauthorized",
21493
+ "headers": {
21494
+ "Content-Type": {
21495
+ "$ref": "#/components/headers/Content-Type"
21496
+ },
21497
+ "RateLimit-Limit": {
21498
+ "$ref": "#/components/headers/RateLimit-Limit"
21499
+ },
21500
+ "RateLimit-Remaining": {
21501
+ "$ref": "#/components/headers/RateLimit-Remaining"
21502
+ },
21503
+ "RateLimit-Reset": {
21504
+ "$ref": "#/components/headers/RateLimit-Reset"
21505
+ },
21506
+ "RateLimit-Policy": {
21507
+ "$ref": "#/components/headers/RateLimit-Policy"
21508
+ },
21509
+ "Idempotency-Key": {
21510
+ "$ref": "#/components/headers/Idempotency-Key"
21511
+ },
21512
+ "Idempotency-Replay": {
21513
+ "$ref": "#/components/headers/Idempotency-Replay"
21514
+ }
21515
+ },
21516
+ "content": {
21517
+ "application/json": {
21518
+ "schema": {
21519
+ "$ref": "#/components/schemas/ErrorDto"
21520
+ }
21521
+ }
21522
+ }
21523
+ },
21524
+ "403": {
21525
+ "description": "Forbidden",
21526
+ "headers": {
21527
+ "Content-Type": {
21528
+ "$ref": "#/components/headers/Content-Type"
21529
+ },
21530
+ "RateLimit-Limit": {
21531
+ "$ref": "#/components/headers/RateLimit-Limit"
21532
+ },
21533
+ "RateLimit-Remaining": {
21534
+ "$ref": "#/components/headers/RateLimit-Remaining"
21535
+ },
21536
+ "RateLimit-Reset": {
21537
+ "$ref": "#/components/headers/RateLimit-Reset"
21538
+ },
21539
+ "RateLimit-Policy": {
21540
+ "$ref": "#/components/headers/RateLimit-Policy"
21541
+ },
21542
+ "Idempotency-Key": {
21543
+ "$ref": "#/components/headers/Idempotency-Key"
21544
+ },
21545
+ "Idempotency-Replay": {
21546
+ "$ref": "#/components/headers/Idempotency-Replay"
21547
+ }
21548
+ },
21549
+ "content": {
21550
+ "application/json": {
21551
+ "schema": {
21552
+ "$ref": "#/components/schemas/ErrorDto"
21553
+ }
21554
+ }
21555
+ }
21556
+ },
21557
+ "404": {
21558
+ "description": "Not Found",
21559
+ "headers": {
21560
+ "Content-Type": {
21561
+ "$ref": "#/components/headers/Content-Type"
21562
+ },
21563
+ "RateLimit-Limit": {
21564
+ "$ref": "#/components/headers/RateLimit-Limit"
21565
+ },
21566
+ "RateLimit-Remaining": {
21567
+ "$ref": "#/components/headers/RateLimit-Remaining"
21568
+ },
21569
+ "RateLimit-Reset": {
21570
+ "$ref": "#/components/headers/RateLimit-Reset"
21571
+ },
21572
+ "RateLimit-Policy": {
21573
+ "$ref": "#/components/headers/RateLimit-Policy"
21574
+ },
21575
+ "Idempotency-Key": {
21576
+ "$ref": "#/components/headers/Idempotency-Key"
21577
+ },
21578
+ "Idempotency-Replay": {
21579
+ "$ref": "#/components/headers/Idempotency-Replay"
21580
+ }
21581
+ },
21582
+ "content": {
21583
+ "application/json": {
21584
+ "schema": {
21585
+ "$ref": "#/components/schemas/ErrorDto"
21586
+ }
21587
+ }
21588
+ }
21589
+ },
21590
+ "405": {
21591
+ "description": "Method Not Allowed",
21592
+ "headers": {
21593
+ "Content-Type": {
21594
+ "$ref": "#/components/headers/Content-Type"
21595
+ },
21596
+ "RateLimit-Limit": {
21597
+ "$ref": "#/components/headers/RateLimit-Limit"
21598
+ },
21599
+ "RateLimit-Remaining": {
21600
+ "$ref": "#/components/headers/RateLimit-Remaining"
21601
+ },
21602
+ "RateLimit-Reset": {
21603
+ "$ref": "#/components/headers/RateLimit-Reset"
21604
+ },
21605
+ "RateLimit-Policy": {
21606
+ "$ref": "#/components/headers/RateLimit-Policy"
21607
+ },
21608
+ "Idempotency-Key": {
21609
+ "$ref": "#/components/headers/Idempotency-Key"
21610
+ },
21611
+ "Idempotency-Replay": {
21612
+ "$ref": "#/components/headers/Idempotency-Replay"
21613
+ }
21614
+ },
21615
+ "content": {
21616
+ "application/json": {
21617
+ "schema": {
21618
+ "$ref": "#/components/schemas/ErrorDto"
21619
+ }
21620
+ }
21621
+ }
21622
+ },
21623
+ "409": {
21624
+ "description": "Conflict",
21625
+ "headers": {
21626
+ "Content-Type": {
21627
+ "$ref": "#/components/headers/Content-Type"
21628
+ },
21629
+ "RateLimit-Limit": {
21630
+ "$ref": "#/components/headers/RateLimit-Limit"
21631
+ },
21632
+ "RateLimit-Remaining": {
21633
+ "$ref": "#/components/headers/RateLimit-Remaining"
21634
+ },
21635
+ "RateLimit-Reset": {
21636
+ "$ref": "#/components/headers/RateLimit-Reset"
21637
+ },
21638
+ "RateLimit-Policy": {
21639
+ "$ref": "#/components/headers/RateLimit-Policy"
21640
+ },
21641
+ "Idempotency-Key": {
21642
+ "$ref": "#/components/headers/Idempotency-Key"
21643
+ },
21644
+ "Idempotency-Replay": {
21645
+ "$ref": "#/components/headers/Idempotency-Replay"
21646
+ }
21647
+ },
21648
+ "content": {
21649
+ "application/json": {
21650
+ "schema": {
21651
+ "$ref": "#/components/schemas/ErrorDto"
21652
+ }
21653
+ }
21654
+ }
21655
+ },
21656
+ "413": {
21657
+ "description": "Payload Too Large",
21658
+ "headers": {
21659
+ "Content-Type": {
21660
+ "$ref": "#/components/headers/Content-Type"
21661
+ },
21662
+ "RateLimit-Limit": {
21663
+ "$ref": "#/components/headers/RateLimit-Limit"
21664
+ },
21665
+ "RateLimit-Remaining": {
21666
+ "$ref": "#/components/headers/RateLimit-Remaining"
21667
+ },
21668
+ "RateLimit-Reset": {
21669
+ "$ref": "#/components/headers/RateLimit-Reset"
21670
+ },
21671
+ "RateLimit-Policy": {
21672
+ "$ref": "#/components/headers/RateLimit-Policy"
21673
+ },
21674
+ "Idempotency-Key": {
21675
+ "$ref": "#/components/headers/Idempotency-Key"
21676
+ },
21677
+ "Idempotency-Replay": {
21678
+ "$ref": "#/components/headers/Idempotency-Replay"
21679
+ }
21680
+ },
21681
+ "content": {
21682
+ "application/json": {
21683
+ "schema": {
21684
+ "$ref": "#/components/schemas/ErrorDto"
21685
+ }
21686
+ }
21687
+ }
21688
+ },
21689
+ "414": {
21690
+ "description": "URI Too Long",
21691
+ "content": {
21692
+ "application/json": {
21693
+ "schema": {
21694
+ "$ref": "#/components/schemas/ErrorDto"
21695
+ }
21696
+ }
21697
+ }
21698
+ },
21699
+ "415": {
21700
+ "description": "Unsupported Media Type",
21701
+ "headers": {
21702
+ "Content-Type": {
21703
+ "$ref": "#/components/headers/Content-Type"
21704
+ },
21705
+ "RateLimit-Limit": {
21706
+ "$ref": "#/components/headers/RateLimit-Limit"
21707
+ },
21708
+ "RateLimit-Remaining": {
21709
+ "$ref": "#/components/headers/RateLimit-Remaining"
21710
+ },
21711
+ "RateLimit-Reset": {
21712
+ "$ref": "#/components/headers/RateLimit-Reset"
21713
+ },
21714
+ "RateLimit-Policy": {
21715
+ "$ref": "#/components/headers/RateLimit-Policy"
21716
+ },
21717
+ "Idempotency-Key": {
21718
+ "$ref": "#/components/headers/Idempotency-Key"
21719
+ },
21720
+ "Idempotency-Replay": {
21721
+ "$ref": "#/components/headers/Idempotency-Replay"
21722
+ }
21723
+ },
21724
+ "content": {
21725
+ "application/json": {
21726
+ "schema": {
21727
+ "$ref": "#/components/schemas/ErrorDto"
21728
+ }
21729
+ }
21730
+ }
21731
+ },
21732
+ "422": {
21733
+ "description": "Unprocessable Entity",
21734
+ "headers": {
21735
+ "Content-Type": {
21736
+ "$ref": "#/components/headers/Content-Type"
21737
+ },
21738
+ "RateLimit-Limit": {
21739
+ "$ref": "#/components/headers/RateLimit-Limit"
21740
+ },
21741
+ "RateLimit-Remaining": {
21742
+ "$ref": "#/components/headers/RateLimit-Remaining"
21743
+ },
21744
+ "RateLimit-Reset": {
21745
+ "$ref": "#/components/headers/RateLimit-Reset"
21746
+ },
21747
+ "RateLimit-Policy": {
21748
+ "$ref": "#/components/headers/RateLimit-Policy"
21749
+ },
21750
+ "Idempotency-Key": {
21751
+ "$ref": "#/components/headers/Idempotency-Key"
21752
+ },
21753
+ "Idempotency-Replay": {
21754
+ "$ref": "#/components/headers/Idempotency-Replay"
21755
+ }
21756
+ },
21757
+ "content": {
21758
+ "application/json": {
21759
+ "schema": {
21760
+ "$ref": "#/components/schemas/ValidationErrorDto"
21761
+ }
21762
+ }
21763
+ }
21764
+ },
21765
+ "429": {
21766
+ "description": "The client has sent too many requests in a given amount of time. ",
21767
+ "headers": {
21768
+ "Content-Type": {
21769
+ "$ref": "#/components/headers/Content-Type"
21770
+ },
21771
+ "RateLimit-Limit": {
21772
+ "$ref": "#/components/headers/RateLimit-Limit"
21773
+ },
21774
+ "RateLimit-Remaining": {
21775
+ "$ref": "#/components/headers/RateLimit-Remaining"
21776
+ },
21777
+ "RateLimit-Reset": {
21778
+ "$ref": "#/components/headers/RateLimit-Reset"
21779
+ },
21780
+ "RateLimit-Policy": {
21781
+ "$ref": "#/components/headers/RateLimit-Policy"
21782
+ },
21783
+ "Idempotency-Key": {
21784
+ "$ref": "#/components/headers/Idempotency-Key"
21785
+ },
21786
+ "Idempotency-Replay": {
21787
+ "$ref": "#/components/headers/Idempotency-Replay"
21788
+ },
21789
+ "Retry-After": {
21790
+ "$ref": "#/components/headers/Retry-After"
21791
+ }
21792
+ },
21793
+ "content": {
21794
+ "application/json": {
21795
+ "schema": {
21796
+ "type": "string",
21797
+ "example": "API rate limit exceeded"
21798
+ }
21799
+ }
21800
+ }
21801
+ },
21802
+ "500": {
21803
+ "description": "Internal Server Error",
21804
+ "headers": {
21805
+ "Content-Type": {
21806
+ "$ref": "#/components/headers/Content-Type"
21807
+ },
21808
+ "RateLimit-Limit": {
21809
+ "$ref": "#/components/headers/RateLimit-Limit"
21810
+ },
21811
+ "RateLimit-Remaining": {
21812
+ "$ref": "#/components/headers/RateLimit-Remaining"
21813
+ },
21814
+ "RateLimit-Reset": {
21815
+ "$ref": "#/components/headers/RateLimit-Reset"
21816
+ },
21817
+ "RateLimit-Policy": {
21818
+ "$ref": "#/components/headers/RateLimit-Policy"
21819
+ },
21820
+ "Idempotency-Key": {
21821
+ "$ref": "#/components/headers/Idempotency-Key"
21822
+ },
21823
+ "Idempotency-Replay": {
21824
+ "$ref": "#/components/headers/Idempotency-Replay"
21825
+ }
21826
+ },
21827
+ "content": {
21828
+ "application/json": {
21829
+ "schema": {
21830
+ "$ref": "#/components/schemas/ErrorDto"
21831
+ }
21832
+ }
21833
+ }
21834
+ },
21835
+ "503": {
21836
+ "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.",
21837
+ "headers": {
21838
+ "Content-Type": {
21839
+ "$ref": "#/components/headers/Content-Type"
21840
+ },
21841
+ "RateLimit-Limit": {
21842
+ "$ref": "#/components/headers/RateLimit-Limit"
21843
+ },
21844
+ "RateLimit-Remaining": {
21845
+ "$ref": "#/components/headers/RateLimit-Remaining"
21846
+ },
21847
+ "RateLimit-Reset": {
21848
+ "$ref": "#/components/headers/RateLimit-Reset"
21849
+ },
21850
+ "RateLimit-Policy": {
21851
+ "$ref": "#/components/headers/RateLimit-Policy"
21852
+ },
21853
+ "Idempotency-Key": {
21854
+ "$ref": "#/components/headers/Idempotency-Key"
21855
+ },
21856
+ "Idempotency-Replay": {
21857
+ "$ref": "#/components/headers/Idempotency-Replay"
21858
+ },
21859
+ "Retry-After": {
21860
+ "$ref": "#/components/headers/Retry-After"
21861
+ }
21862
+ },
21863
+ "content": {
21864
+ "application/json": {
21865
+ "schema": {
21866
+ "type": "string",
21867
+ "example": "Please wait some time, then try again."
21868
+ }
21869
+ }
21870
+ }
21871
+ }
21872
+ },
21873
+ "tags": [
21874
+ "Topics"
21875
+ ],
21876
+ "security": [
21877
+ {
21878
+ "secretKey": []
21879
+ }
21880
+ ]
21881
+ },
21882
+ "get": {
21883
+ "operationId": "TopicsController_listTopics",
21884
+ "summary": "Get topic list filtered ",
21885
+ "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",
21886
+ "parameters": [
21887
+ {
21888
+ "name": "page",
21889
+ "required": false,
21890
+ "in": "query",
21891
+ "example": 0,
21892
+ "description": "The page number to retrieve (starts from 0)",
21893
+ "schema": {
21894
+ "format": "int64",
21895
+ "default": 0,
21896
+ "type": "integer"
21897
+ }
21898
+ },
21899
+ {
21900
+ "name": "pageSize",
21901
+ "required": false,
21902
+ "in": "query",
21903
+ "example": 10,
21904
+ "description": "The number of items to return per page (default: 10)",
21905
+ "schema": {
21906
+ "format": "int64",
21907
+ "default": 10,
21908
+ "type": "integer"
21909
+ }
21910
+ },
21911
+ {
21912
+ "name": "key",
21913
+ "required": false,
21914
+ "in": "query",
21915
+ "example": "exampleKey",
21916
+ "description": "A filter key to apply to the results",
21917
+ "schema": {
21918
+ "type": "string"
21919
+ }
21920
+ },
21921
+ {
21922
+ "name": "idempotency-key",
21923
+ "in": "header",
21924
+ "description": "A header for idempotency purposes",
21925
+ "required": false,
21926
+ "schema": {
21927
+ "type": "string"
21928
+ }
21929
+ }
21930
+ ],
21931
+ "responses": {
21932
+ "200": {
21933
+ "headers": {
21934
+ "Content-Type": {
21935
+ "$ref": "#/components/headers/Content-Type"
21936
+ },
21937
+ "RateLimit-Limit": {
21938
+ "$ref": "#/components/headers/RateLimit-Limit"
21939
+ },
21940
+ "RateLimit-Remaining": {
21941
+ "$ref": "#/components/headers/RateLimit-Remaining"
21942
+ },
21943
+ "RateLimit-Reset": {
21944
+ "$ref": "#/components/headers/RateLimit-Reset"
21945
+ },
21946
+ "RateLimit-Policy": {
21947
+ "$ref": "#/components/headers/RateLimit-Policy"
21948
+ },
21949
+ "Idempotency-Key": {
21950
+ "$ref": "#/components/headers/Idempotency-Key"
21951
+ },
21952
+ "Idempotency-Replay": {
21953
+ "$ref": "#/components/headers/Idempotency-Replay"
21954
+ }
21955
+ },
21956
+ "description": "",
21957
+ "content": {
21958
+ "application/json": {
21959
+ "schema": {
21960
+ "$ref": "#/components/schemas/FilterTopicsResponseDto"
21961
+ }
21962
+ }
21963
+ }
21964
+ },
21965
+ "400": {
21966
+ "description": "Bad Request",
21967
+ "headers": {
21968
+ "Content-Type": {
21969
+ "$ref": "#/components/headers/Content-Type"
21970
+ },
21971
+ "RateLimit-Limit": {
21972
+ "$ref": "#/components/headers/RateLimit-Limit"
21973
+ },
21974
+ "RateLimit-Remaining": {
21975
+ "$ref": "#/components/headers/RateLimit-Remaining"
21976
+ },
21977
+ "RateLimit-Reset": {
21978
+ "$ref": "#/components/headers/RateLimit-Reset"
21979
+ },
21980
+ "RateLimit-Policy": {
21981
+ "$ref": "#/components/headers/RateLimit-Policy"
21982
+ },
21983
+ "Idempotency-Key": {
21984
+ "$ref": "#/components/headers/Idempotency-Key"
21985
+ },
21986
+ "Idempotency-Replay": {
21987
+ "$ref": "#/components/headers/Idempotency-Replay"
21988
+ }
21989
+ },
21990
+ "content": {
21991
+ "application/json": {
21992
+ "schema": {
21993
+ "$ref": "#/components/schemas/ErrorDto"
21994
+ }
21995
+ }
21996
+ }
21997
+ },
21998
+ "401": {
21999
+ "description": "Unauthorized",
22000
+ "headers": {
22001
+ "Content-Type": {
22002
+ "$ref": "#/components/headers/Content-Type"
22003
+ },
22004
+ "RateLimit-Limit": {
22005
+ "$ref": "#/components/headers/RateLimit-Limit"
22006
+ },
22007
+ "RateLimit-Remaining": {
22008
+ "$ref": "#/components/headers/RateLimit-Remaining"
22009
+ },
22010
+ "RateLimit-Reset": {
22011
+ "$ref": "#/components/headers/RateLimit-Reset"
22012
+ },
22013
+ "RateLimit-Policy": {
22014
+ "$ref": "#/components/headers/RateLimit-Policy"
22015
+ },
22016
+ "Idempotency-Key": {
22017
+ "$ref": "#/components/headers/Idempotency-Key"
22018
+ },
22019
+ "Idempotency-Replay": {
22020
+ "$ref": "#/components/headers/Idempotency-Replay"
22021
+ }
22022
+ },
22023
+ "content": {
22024
+ "application/json": {
22025
+ "schema": {
22026
+ "$ref": "#/components/schemas/ErrorDto"
22027
+ }
22028
+ }
22029
+ }
22030
+ },
22031
+ "403": {
22032
+ "description": "Forbidden",
22033
+ "headers": {
22034
+ "Content-Type": {
22035
+ "$ref": "#/components/headers/Content-Type"
22036
+ },
22037
+ "RateLimit-Limit": {
22038
+ "$ref": "#/components/headers/RateLimit-Limit"
22039
+ },
22040
+ "RateLimit-Remaining": {
22041
+ "$ref": "#/components/headers/RateLimit-Remaining"
22042
+ },
22043
+ "RateLimit-Reset": {
22044
+ "$ref": "#/components/headers/RateLimit-Reset"
22045
+ },
22046
+ "RateLimit-Policy": {
22047
+ "$ref": "#/components/headers/RateLimit-Policy"
22048
+ },
22049
+ "Idempotency-Key": {
22050
+ "$ref": "#/components/headers/Idempotency-Key"
22051
+ },
22052
+ "Idempotency-Replay": {
22053
+ "$ref": "#/components/headers/Idempotency-Replay"
22054
+ }
22055
+ },
22056
+ "content": {
22057
+ "application/json": {
22058
+ "schema": {
22059
+ "$ref": "#/components/schemas/ErrorDto"
22060
+ }
22061
+ }
22062
+ }
22063
+ },
22064
+ "404": {
22065
+ "description": "Not Found",
22066
+ "headers": {
22067
+ "Content-Type": {
22068
+ "$ref": "#/components/headers/Content-Type"
22069
+ },
22070
+ "RateLimit-Limit": {
22071
+ "$ref": "#/components/headers/RateLimit-Limit"
22072
+ },
22073
+ "RateLimit-Remaining": {
22074
+ "$ref": "#/components/headers/RateLimit-Remaining"
22075
+ },
22076
+ "RateLimit-Reset": {
22077
+ "$ref": "#/components/headers/RateLimit-Reset"
22078
+ },
22079
+ "RateLimit-Policy": {
22080
+ "$ref": "#/components/headers/RateLimit-Policy"
22081
+ },
22082
+ "Idempotency-Key": {
22083
+ "$ref": "#/components/headers/Idempotency-Key"
22084
+ },
22085
+ "Idempotency-Replay": {
22086
+ "$ref": "#/components/headers/Idempotency-Replay"
22087
+ }
22088
+ },
22089
+ "content": {
22090
+ "application/json": {
22091
+ "schema": {
22092
+ "$ref": "#/components/schemas/ErrorDto"
22093
+ }
22094
+ }
22095
+ }
22096
+ },
22097
+ "405": {
22098
+ "description": "Method Not Allowed",
22099
+ "headers": {
22100
+ "Content-Type": {
22101
+ "$ref": "#/components/headers/Content-Type"
22102
+ },
22103
+ "RateLimit-Limit": {
22104
+ "$ref": "#/components/headers/RateLimit-Limit"
22105
+ },
22106
+ "RateLimit-Remaining": {
22107
+ "$ref": "#/components/headers/RateLimit-Remaining"
22108
+ },
22109
+ "RateLimit-Reset": {
22110
+ "$ref": "#/components/headers/RateLimit-Reset"
22111
+ },
22112
+ "RateLimit-Policy": {
22113
+ "$ref": "#/components/headers/RateLimit-Policy"
22114
+ },
22115
+ "Idempotency-Key": {
22116
+ "$ref": "#/components/headers/Idempotency-Key"
22117
+ },
22118
+ "Idempotency-Replay": {
22119
+ "$ref": "#/components/headers/Idempotency-Replay"
22120
+ }
22121
+ },
22122
+ "content": {
22123
+ "application/json": {
22124
+ "schema": {
22125
+ "$ref": "#/components/schemas/ErrorDto"
22126
+ }
22127
+ }
22128
+ }
22129
+ },
22130
+ "409": {
22131
+ "description": "Conflict",
22132
+ "headers": {
22133
+ "Content-Type": {
22134
+ "$ref": "#/components/headers/Content-Type"
22135
+ },
22136
+ "RateLimit-Limit": {
22137
+ "$ref": "#/components/headers/RateLimit-Limit"
22138
+ },
22139
+ "RateLimit-Remaining": {
22140
+ "$ref": "#/components/headers/RateLimit-Remaining"
22141
+ },
22142
+ "RateLimit-Reset": {
22143
+ "$ref": "#/components/headers/RateLimit-Reset"
22144
+ },
22145
+ "RateLimit-Policy": {
22146
+ "$ref": "#/components/headers/RateLimit-Policy"
22147
+ },
22148
+ "Idempotency-Key": {
22149
+ "$ref": "#/components/headers/Idempotency-Key"
22150
+ },
22151
+ "Idempotency-Replay": {
22152
+ "$ref": "#/components/headers/Idempotency-Replay"
22153
+ }
22154
+ },
22155
+ "content": {
22156
+ "application/json": {
22157
+ "schema": {
22158
+ "$ref": "#/components/schemas/ErrorDto"
22159
+ }
22160
+ }
22161
+ }
22162
+ },
22163
+ "413": {
22164
+ "description": "Payload Too Large",
22165
+ "headers": {
22166
+ "Content-Type": {
22167
+ "$ref": "#/components/headers/Content-Type"
22168
+ },
22169
+ "RateLimit-Limit": {
22170
+ "$ref": "#/components/headers/RateLimit-Limit"
22171
+ },
22172
+ "RateLimit-Remaining": {
22173
+ "$ref": "#/components/headers/RateLimit-Remaining"
22174
+ },
22175
+ "RateLimit-Reset": {
22176
+ "$ref": "#/components/headers/RateLimit-Reset"
22177
+ },
22178
+ "RateLimit-Policy": {
22179
+ "$ref": "#/components/headers/RateLimit-Policy"
22180
+ },
22181
+ "Idempotency-Key": {
22182
+ "$ref": "#/components/headers/Idempotency-Key"
22183
+ },
22184
+ "Idempotency-Replay": {
22185
+ "$ref": "#/components/headers/Idempotency-Replay"
22186
+ }
22187
+ },
22188
+ "content": {
22189
+ "application/json": {
22190
+ "schema": {
22191
+ "$ref": "#/components/schemas/ErrorDto"
22192
+ }
22193
+ }
22194
+ }
22195
+ },
22196
+ "414": {
22197
+ "description": "URI Too Long",
22198
+ "content": {
22199
+ "application/json": {
22200
+ "schema": {
22201
+ "$ref": "#/components/schemas/ErrorDto"
22202
+ }
22203
+ }
22204
+ }
22205
+ },
22206
+ "415": {
22207
+ "description": "Unsupported Media Type",
22208
+ "headers": {
22209
+ "Content-Type": {
22210
+ "$ref": "#/components/headers/Content-Type"
22211
+ },
22212
+ "RateLimit-Limit": {
22213
+ "$ref": "#/components/headers/RateLimit-Limit"
22214
+ },
22215
+ "RateLimit-Remaining": {
22216
+ "$ref": "#/components/headers/RateLimit-Remaining"
22217
+ },
22218
+ "RateLimit-Reset": {
22219
+ "$ref": "#/components/headers/RateLimit-Reset"
22220
+ },
22221
+ "RateLimit-Policy": {
22222
+ "$ref": "#/components/headers/RateLimit-Policy"
22223
+ },
22224
+ "Idempotency-Key": {
22225
+ "$ref": "#/components/headers/Idempotency-Key"
22226
+ },
22227
+ "Idempotency-Replay": {
22228
+ "$ref": "#/components/headers/Idempotency-Replay"
22229
+ }
22230
+ },
22231
+ "content": {
22232
+ "application/json": {
22233
+ "schema": {
22234
+ "$ref": "#/components/schemas/ErrorDto"
22235
+ }
22236
+ }
22237
+ }
22238
+ },
22239
+ "422": {
22240
+ "description": "Unprocessable Entity",
22241
+ "headers": {
22242
+ "Content-Type": {
22243
+ "$ref": "#/components/headers/Content-Type"
22244
+ },
22245
+ "RateLimit-Limit": {
22246
+ "$ref": "#/components/headers/RateLimit-Limit"
22247
+ },
22248
+ "RateLimit-Remaining": {
22249
+ "$ref": "#/components/headers/RateLimit-Remaining"
22250
+ },
22251
+ "RateLimit-Reset": {
22252
+ "$ref": "#/components/headers/RateLimit-Reset"
22253
+ },
22254
+ "RateLimit-Policy": {
22255
+ "$ref": "#/components/headers/RateLimit-Policy"
22256
+ },
22257
+ "Idempotency-Key": {
22258
+ "$ref": "#/components/headers/Idempotency-Key"
22259
+ },
22260
+ "Idempotency-Replay": {
22261
+ "$ref": "#/components/headers/Idempotency-Replay"
22262
+ }
22263
+ },
22264
+ "content": {
22265
+ "application/json": {
22266
+ "schema": {
22267
+ "$ref": "#/components/schemas/ValidationErrorDto"
22268
+ }
22269
+ }
22270
+ }
22271
+ },
22272
+ "429": {
22273
+ "description": "The client has sent too many requests in a given amount of time. ",
22274
+ "headers": {
22275
+ "Content-Type": {
22276
+ "$ref": "#/components/headers/Content-Type"
22277
+ },
22278
+ "RateLimit-Limit": {
22279
+ "$ref": "#/components/headers/RateLimit-Limit"
22280
+ },
22281
+ "RateLimit-Remaining": {
22282
+ "$ref": "#/components/headers/RateLimit-Remaining"
22283
+ },
22284
+ "RateLimit-Reset": {
22285
+ "$ref": "#/components/headers/RateLimit-Reset"
22286
+ },
22287
+ "RateLimit-Policy": {
22288
+ "$ref": "#/components/headers/RateLimit-Policy"
22289
+ },
22290
+ "Idempotency-Key": {
22291
+ "$ref": "#/components/headers/Idempotency-Key"
22292
+ },
22293
+ "Idempotency-Replay": {
22294
+ "$ref": "#/components/headers/Idempotency-Replay"
22295
+ },
22296
+ "Retry-After": {
22297
+ "$ref": "#/components/headers/Retry-After"
22298
+ }
22299
+ },
22300
+ "content": {
22301
+ "application/json": {
22302
+ "schema": {
22303
+ "type": "string",
22304
+ "example": "API rate limit exceeded"
22305
+ }
22306
+ }
22307
+ }
22308
+ },
22309
+ "500": {
22310
+ "description": "Internal Server Error",
22311
+ "headers": {
22312
+ "Content-Type": {
22313
+ "$ref": "#/components/headers/Content-Type"
22314
+ },
22315
+ "RateLimit-Limit": {
22316
+ "$ref": "#/components/headers/RateLimit-Limit"
22317
+ },
22318
+ "RateLimit-Remaining": {
22319
+ "$ref": "#/components/headers/RateLimit-Remaining"
22320
+ },
22321
+ "RateLimit-Reset": {
22322
+ "$ref": "#/components/headers/RateLimit-Reset"
22323
+ },
22324
+ "RateLimit-Policy": {
22325
+ "$ref": "#/components/headers/RateLimit-Policy"
22326
+ },
22327
+ "Idempotency-Key": {
22328
+ "$ref": "#/components/headers/Idempotency-Key"
22329
+ },
22330
+ "Idempotency-Replay": {
22331
+ "$ref": "#/components/headers/Idempotency-Replay"
22332
+ }
22333
+ },
22334
+ "content": {
22335
+ "application/json": {
22336
+ "schema": {
22337
+ "$ref": "#/components/schemas/ErrorDto"
22338
+ }
22339
+ }
22340
+ }
22341
+ },
22342
+ "503": {
22343
+ "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.",
22344
+ "headers": {
22345
+ "Content-Type": {
22346
+ "$ref": "#/components/headers/Content-Type"
22347
+ },
22348
+ "RateLimit-Limit": {
22349
+ "$ref": "#/components/headers/RateLimit-Limit"
22350
+ },
22351
+ "RateLimit-Remaining": {
22352
+ "$ref": "#/components/headers/RateLimit-Remaining"
22353
+ },
22354
+ "RateLimit-Reset": {
22355
+ "$ref": "#/components/headers/RateLimit-Reset"
22356
+ },
22357
+ "RateLimit-Policy": {
22358
+ "$ref": "#/components/headers/RateLimit-Policy"
22359
+ },
22360
+ "Idempotency-Key": {
22361
+ "$ref": "#/components/headers/Idempotency-Key"
22362
+ },
22363
+ "Idempotency-Replay": {
22364
+ "$ref": "#/components/headers/Idempotency-Replay"
22365
+ },
22366
+ "Retry-After": {
22367
+ "$ref": "#/components/headers/Retry-After"
22368
+ }
22369
+ },
22370
+ "content": {
22371
+ "application/json": {
22372
+ "schema": {
22373
+ "type": "string",
22374
+ "example": "Please wait some time, then try again."
22375
+ }
22376
+ }
22377
+ }
22378
+ }
22379
+ },
22380
+ "tags": [
22381
+ "Topics"
22382
+ ],
22383
+ "security": [
22384
+ {
22385
+ "secretKey": []
22386
+ }
22387
+ ]
22388
+ }
22389
+ },
22390
+ "/v1/topics/{topicKey}/subscribers": {
22391
+ "post": {
22392
+ "operationId": "TopicsController_assign",
22393
+ "x-speakeasy-name-override": "assign",
22394
+ "x-speakeasy-group": "Topics.Subscribers",
22395
+ "summary": "Subscribers addition",
22396
+ "description": "Add subscribers to a topic by key",
22397
+ "parameters": [
22398
+ {
22399
+ "name": "topicKey",
22400
+ "required": true,
22401
+ "in": "path",
22402
+ "description": "The topic key",
22403
+ "schema": {
22404
+ "type": "string"
22405
+ }
22406
+ },
22407
+ {
22408
+ "name": "idempotency-key",
22409
+ "in": "header",
22410
+ "description": "A header for idempotency purposes",
22411
+ "required": false,
22412
+ "schema": {
22413
+ "type": "string"
22414
+ }
22415
+ }
22416
+ ],
22417
+ "requestBody": {
22418
+ "required": true,
22419
+ "content": {
22420
+ "application/json": {
22421
+ "schema": {
22422
+ "$ref": "#/components/schemas/AddSubscribersRequestDto"
22423
+ }
22424
+ }
22425
+ }
22426
+ },
22427
+ "responses": {
22428
+ "200": {
22429
+ "headers": {
22430
+ "Content-Type": {
22431
+ "$ref": "#/components/headers/Content-Type"
22432
+ },
22433
+ "RateLimit-Limit": {
22434
+ "$ref": "#/components/headers/RateLimit-Limit"
22435
+ },
22436
+ "RateLimit-Remaining": {
22437
+ "$ref": "#/components/headers/RateLimit-Remaining"
22438
+ },
22439
+ "RateLimit-Reset": {
22440
+ "$ref": "#/components/headers/RateLimit-Reset"
22441
+ },
22442
+ "RateLimit-Policy": {
22443
+ "$ref": "#/components/headers/RateLimit-Policy"
22444
+ },
22445
+ "Idempotency-Key": {
22446
+ "$ref": "#/components/headers/Idempotency-Key"
22447
+ },
22448
+ "Idempotency-Replay": {
22449
+ "$ref": "#/components/headers/Idempotency-Replay"
22450
+ }
22451
+ },
22452
+ "description": "",
22453
+ "content": {
22454
+ "application/json": {
22455
+ "schema": {
22456
+ "$ref": "#/components/schemas/AssignSubscriberToTopicDto"
22457
+ }
22458
+ }
22459
+ }
22460
+ },
22461
+ "400": {
22462
+ "description": "Bad Request",
22463
+ "headers": {
22464
+ "Content-Type": {
22465
+ "$ref": "#/components/headers/Content-Type"
22466
+ },
22467
+ "RateLimit-Limit": {
22468
+ "$ref": "#/components/headers/RateLimit-Limit"
22469
+ },
22470
+ "RateLimit-Remaining": {
22471
+ "$ref": "#/components/headers/RateLimit-Remaining"
22472
+ },
22473
+ "RateLimit-Reset": {
22474
+ "$ref": "#/components/headers/RateLimit-Reset"
22475
+ },
22476
+ "RateLimit-Policy": {
22477
+ "$ref": "#/components/headers/RateLimit-Policy"
22478
+ },
22479
+ "Idempotency-Key": {
22480
+ "$ref": "#/components/headers/Idempotency-Key"
22481
+ },
22482
+ "Idempotency-Replay": {
22483
+ "$ref": "#/components/headers/Idempotency-Replay"
22484
+ }
22485
+ },
22486
+ "content": {
22487
+ "application/json": {
22488
+ "schema": {
22489
+ "$ref": "#/components/schemas/ErrorDto"
22490
+ }
22491
+ }
22492
+ }
22493
+ },
22494
+ "401": {
22495
+ "description": "Unauthorized",
22496
+ "headers": {
22497
+ "Content-Type": {
22498
+ "$ref": "#/components/headers/Content-Type"
22499
+ },
22500
+ "RateLimit-Limit": {
22501
+ "$ref": "#/components/headers/RateLimit-Limit"
22502
+ },
22503
+ "RateLimit-Remaining": {
22504
+ "$ref": "#/components/headers/RateLimit-Remaining"
22505
+ },
22506
+ "RateLimit-Reset": {
22507
+ "$ref": "#/components/headers/RateLimit-Reset"
22508
+ },
22509
+ "RateLimit-Policy": {
22510
+ "$ref": "#/components/headers/RateLimit-Policy"
22511
+ },
22512
+ "Idempotency-Key": {
22513
+ "$ref": "#/components/headers/Idempotency-Key"
22514
+ },
22515
+ "Idempotency-Replay": {
22516
+ "$ref": "#/components/headers/Idempotency-Replay"
22517
+ }
22518
+ },
22519
+ "content": {
22520
+ "application/json": {
22521
+ "schema": {
22522
+ "$ref": "#/components/schemas/ErrorDto"
22523
+ }
22524
+ }
22525
+ }
22526
+ },
22527
+ "403": {
22528
+ "description": "Forbidden",
22529
+ "headers": {
22530
+ "Content-Type": {
22531
+ "$ref": "#/components/headers/Content-Type"
22532
+ },
22533
+ "RateLimit-Limit": {
22534
+ "$ref": "#/components/headers/RateLimit-Limit"
22535
+ },
22536
+ "RateLimit-Remaining": {
22537
+ "$ref": "#/components/headers/RateLimit-Remaining"
22538
+ },
22539
+ "RateLimit-Reset": {
22540
+ "$ref": "#/components/headers/RateLimit-Reset"
22541
+ },
22542
+ "RateLimit-Policy": {
22543
+ "$ref": "#/components/headers/RateLimit-Policy"
22544
+ },
22545
+ "Idempotency-Key": {
22546
+ "$ref": "#/components/headers/Idempotency-Key"
22547
+ },
22548
+ "Idempotency-Replay": {
22549
+ "$ref": "#/components/headers/Idempotency-Replay"
22550
+ }
22551
+ },
22552
+ "content": {
22553
+ "application/json": {
22554
+ "schema": {
22555
+ "$ref": "#/components/schemas/ErrorDto"
22556
+ }
22557
+ }
22558
+ }
22559
+ },
22560
+ "404": {
22561
+ "description": "Not Found",
22562
+ "headers": {
22563
+ "Content-Type": {
22564
+ "$ref": "#/components/headers/Content-Type"
22565
+ },
22566
+ "RateLimit-Limit": {
22567
+ "$ref": "#/components/headers/RateLimit-Limit"
22568
+ },
22569
+ "RateLimit-Remaining": {
22570
+ "$ref": "#/components/headers/RateLimit-Remaining"
22571
+ },
22572
+ "RateLimit-Reset": {
22573
+ "$ref": "#/components/headers/RateLimit-Reset"
22574
+ },
22575
+ "RateLimit-Policy": {
22576
+ "$ref": "#/components/headers/RateLimit-Policy"
22577
+ },
22578
+ "Idempotency-Key": {
22579
+ "$ref": "#/components/headers/Idempotency-Key"
22580
+ },
22581
+ "Idempotency-Replay": {
22582
+ "$ref": "#/components/headers/Idempotency-Replay"
22583
+ }
22584
+ },
22585
+ "content": {
22586
+ "application/json": {
22587
+ "schema": {
22588
+ "$ref": "#/components/schemas/ErrorDto"
22589
+ }
22590
+ }
22591
+ }
22592
+ },
22593
+ "405": {
22594
+ "description": "Method Not Allowed",
22595
+ "headers": {
22596
+ "Content-Type": {
22597
+ "$ref": "#/components/headers/Content-Type"
22598
+ },
22599
+ "RateLimit-Limit": {
22600
+ "$ref": "#/components/headers/RateLimit-Limit"
22601
+ },
22602
+ "RateLimit-Remaining": {
22603
+ "$ref": "#/components/headers/RateLimit-Remaining"
22604
+ },
22605
+ "RateLimit-Reset": {
22606
+ "$ref": "#/components/headers/RateLimit-Reset"
22607
+ },
22608
+ "RateLimit-Policy": {
22609
+ "$ref": "#/components/headers/RateLimit-Policy"
22610
+ },
22611
+ "Idempotency-Key": {
22612
+ "$ref": "#/components/headers/Idempotency-Key"
22613
+ },
22614
+ "Idempotency-Replay": {
22615
+ "$ref": "#/components/headers/Idempotency-Replay"
22616
+ }
22617
+ },
22618
+ "content": {
22619
+ "application/json": {
22620
+ "schema": {
22621
+ "$ref": "#/components/schemas/ErrorDto"
22622
+ }
22623
+ }
22624
+ }
22625
+ },
22626
+ "409": {
22627
+ "description": "Conflict",
22628
+ "headers": {
22629
+ "Content-Type": {
22630
+ "$ref": "#/components/headers/Content-Type"
22631
+ },
22632
+ "RateLimit-Limit": {
22633
+ "$ref": "#/components/headers/RateLimit-Limit"
22634
+ },
22635
+ "RateLimit-Remaining": {
22636
+ "$ref": "#/components/headers/RateLimit-Remaining"
22637
+ },
22638
+ "RateLimit-Reset": {
22639
+ "$ref": "#/components/headers/RateLimit-Reset"
22640
+ },
22641
+ "RateLimit-Policy": {
22642
+ "$ref": "#/components/headers/RateLimit-Policy"
22643
+ },
22644
+ "Idempotency-Key": {
22645
+ "$ref": "#/components/headers/Idempotency-Key"
22646
+ },
22647
+ "Idempotency-Replay": {
22648
+ "$ref": "#/components/headers/Idempotency-Replay"
22649
+ }
22650
+ },
22651
+ "content": {
22652
+ "application/json": {
22653
+ "schema": {
22654
+ "$ref": "#/components/schemas/ErrorDto"
22655
+ }
22656
+ }
22657
+ }
22658
+ },
22659
+ "413": {
22660
+ "description": "Payload Too Large",
22661
+ "headers": {
22662
+ "Content-Type": {
22663
+ "$ref": "#/components/headers/Content-Type"
22664
+ },
22665
+ "RateLimit-Limit": {
22666
+ "$ref": "#/components/headers/RateLimit-Limit"
22667
+ },
22668
+ "RateLimit-Remaining": {
22669
+ "$ref": "#/components/headers/RateLimit-Remaining"
22670
+ },
22671
+ "RateLimit-Reset": {
22672
+ "$ref": "#/components/headers/RateLimit-Reset"
22673
+ },
22674
+ "RateLimit-Policy": {
22675
+ "$ref": "#/components/headers/RateLimit-Policy"
22676
+ },
22677
+ "Idempotency-Key": {
22678
+ "$ref": "#/components/headers/Idempotency-Key"
22679
+ },
22680
+ "Idempotency-Replay": {
22681
+ "$ref": "#/components/headers/Idempotency-Replay"
22682
+ }
22683
+ },
22684
+ "content": {
22685
+ "application/json": {
22686
+ "schema": {
22687
+ "$ref": "#/components/schemas/ErrorDto"
22688
+ }
22689
+ }
22690
+ }
22691
+ },
22692
+ "414": {
22693
+ "description": "URI Too Long",
22694
+ "content": {
22695
+ "application/json": {
22696
+ "schema": {
22697
+ "$ref": "#/components/schemas/ErrorDto"
22698
+ }
22699
+ }
22700
+ }
22701
+ },
22702
+ "415": {
22703
+ "description": "Unsupported Media Type",
22704
+ "headers": {
22705
+ "Content-Type": {
22706
+ "$ref": "#/components/headers/Content-Type"
22707
+ },
22708
+ "RateLimit-Limit": {
22709
+ "$ref": "#/components/headers/RateLimit-Limit"
22710
+ },
22711
+ "RateLimit-Remaining": {
22712
+ "$ref": "#/components/headers/RateLimit-Remaining"
22713
+ },
22714
+ "RateLimit-Reset": {
22715
+ "$ref": "#/components/headers/RateLimit-Reset"
22716
+ },
22717
+ "RateLimit-Policy": {
22718
+ "$ref": "#/components/headers/RateLimit-Policy"
22719
+ },
22720
+ "Idempotency-Key": {
22721
+ "$ref": "#/components/headers/Idempotency-Key"
22722
+ },
22723
+ "Idempotency-Replay": {
22724
+ "$ref": "#/components/headers/Idempotency-Replay"
22725
+ }
22726
+ },
22727
+ "content": {
22728
+ "application/json": {
22729
+ "schema": {
22730
+ "$ref": "#/components/schemas/ErrorDto"
22731
+ }
22732
+ }
22733
+ }
22734
+ },
22735
+ "422": {
22736
+ "description": "Unprocessable Entity",
22737
+ "headers": {
22738
+ "Content-Type": {
22739
+ "$ref": "#/components/headers/Content-Type"
22740
+ },
22741
+ "RateLimit-Limit": {
22742
+ "$ref": "#/components/headers/RateLimit-Limit"
22743
+ },
22744
+ "RateLimit-Remaining": {
22745
+ "$ref": "#/components/headers/RateLimit-Remaining"
22746
+ },
22747
+ "RateLimit-Reset": {
22748
+ "$ref": "#/components/headers/RateLimit-Reset"
22749
+ },
22750
+ "RateLimit-Policy": {
22751
+ "$ref": "#/components/headers/RateLimit-Policy"
22752
+ },
22753
+ "Idempotency-Key": {
22754
+ "$ref": "#/components/headers/Idempotency-Key"
22755
+ },
22756
+ "Idempotency-Replay": {
22757
+ "$ref": "#/components/headers/Idempotency-Replay"
22758
+ }
22759
+ },
22760
+ "content": {
22761
+ "application/json": {
22762
+ "schema": {
22763
+ "$ref": "#/components/schemas/ValidationErrorDto"
22764
+ }
22765
+ }
22766
+ }
22767
+ },
22768
+ "429": {
22769
+ "description": "The client has sent too many requests in a given amount of time. ",
22770
+ "headers": {
22771
+ "Content-Type": {
22772
+ "$ref": "#/components/headers/Content-Type"
22773
+ },
22774
+ "RateLimit-Limit": {
22775
+ "$ref": "#/components/headers/RateLimit-Limit"
22776
+ },
22777
+ "RateLimit-Remaining": {
22778
+ "$ref": "#/components/headers/RateLimit-Remaining"
22779
+ },
22780
+ "RateLimit-Reset": {
22781
+ "$ref": "#/components/headers/RateLimit-Reset"
22782
+ },
22783
+ "RateLimit-Policy": {
22784
+ "$ref": "#/components/headers/RateLimit-Policy"
22785
+ },
22786
+ "Idempotency-Key": {
22787
+ "$ref": "#/components/headers/Idempotency-Key"
22788
+ },
22789
+ "Idempotency-Replay": {
22790
+ "$ref": "#/components/headers/Idempotency-Replay"
22791
+ },
22792
+ "Retry-After": {
22793
+ "$ref": "#/components/headers/Retry-After"
22794
+ }
22795
+ },
22796
+ "content": {
22797
+ "application/json": {
22798
+ "schema": {
22799
+ "type": "string",
22800
+ "example": "API rate limit exceeded"
22801
+ }
22802
+ }
22803
+ }
22804
+ },
22805
+ "500": {
22806
+ "description": "Internal Server Error",
22807
+ "headers": {
22808
+ "Content-Type": {
22809
+ "$ref": "#/components/headers/Content-Type"
22810
+ },
22811
+ "RateLimit-Limit": {
22812
+ "$ref": "#/components/headers/RateLimit-Limit"
22813
+ },
22814
+ "RateLimit-Remaining": {
22815
+ "$ref": "#/components/headers/RateLimit-Remaining"
22816
+ },
22817
+ "RateLimit-Reset": {
22818
+ "$ref": "#/components/headers/RateLimit-Reset"
22819
+ },
22820
+ "RateLimit-Policy": {
22821
+ "$ref": "#/components/headers/RateLimit-Policy"
22822
+ },
22823
+ "Idempotency-Key": {
22824
+ "$ref": "#/components/headers/Idempotency-Key"
22825
+ },
22826
+ "Idempotency-Replay": {
22827
+ "$ref": "#/components/headers/Idempotency-Replay"
22828
+ }
22829
+ },
22830
+ "content": {
22831
+ "application/json": {
22832
+ "schema": {
22833
+ "$ref": "#/components/schemas/ErrorDto"
22834
+ }
22835
+ }
22836
+ }
22837
+ },
22838
+ "503": {
22839
+ "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.",
22840
+ "headers": {
22841
+ "Content-Type": {
22842
+ "$ref": "#/components/headers/Content-Type"
22843
+ },
22844
+ "RateLimit-Limit": {
22845
+ "$ref": "#/components/headers/RateLimit-Limit"
22846
+ },
22847
+ "RateLimit-Remaining": {
22848
+ "$ref": "#/components/headers/RateLimit-Remaining"
22849
+ },
22850
+ "RateLimit-Reset": {
22851
+ "$ref": "#/components/headers/RateLimit-Reset"
22852
+ },
22853
+ "RateLimit-Policy": {
22854
+ "$ref": "#/components/headers/RateLimit-Policy"
22855
+ },
22856
+ "Idempotency-Key": {
22857
+ "$ref": "#/components/headers/Idempotency-Key"
22858
+ },
22859
+ "Idempotency-Replay": {
22860
+ "$ref": "#/components/headers/Idempotency-Replay"
22861
+ },
22862
+ "Retry-After": {
22863
+ "$ref": "#/components/headers/Retry-After"
22864
+ }
22865
+ },
22866
+ "content": {
22867
+ "application/json": {
22868
+ "schema": {
22869
+ "type": "string",
22870
+ "example": "Please wait some time, then try again."
22871
+ }
22872
+ }
22873
+ }
22874
+ }
22875
+ },
22876
+ "tags": [
22877
+ "Topics"
22878
+ ],
22879
+ "security": [
22880
+ {
22881
+ "secretKey": []
22882
+ }
22883
+ ]
22884
+ }
22885
+ },
22886
+ "/v1/topics/{topicKey}/subscribers/{externalSubscriberId}": {
22887
+ "get": {
22888
+ "operationId": "TopicsController_getTopicSubscriber",
22889
+ "x-speakeasy-group": "Topics.Subscribers",
22890
+ "summary": "Check topic subscriber",
22891
+ "description": "Check if a subscriber belongs to a certain topic",
22892
+ "parameters": [
22893
+ {
22894
+ "name": "externalSubscriberId",
20879
22895
  "required": true,
20880
22896
  "in": "path",
20881
22897
  "description": "The external subscriber id",
@@ -21356,7 +23372,7 @@
21356
23372
  ],
21357
23373
  "security": [
21358
23374
  {
21359
- "api-key": []
23375
+ "secretKey": []
21360
23376
  }
21361
23377
  ]
21362
23378
  }
@@ -21845,7 +23861,7 @@
21845
23861
  ],
21846
23862
  "security": [
21847
23863
  {
21848
- "api-key": []
23864
+ "secretKey": []
21849
23865
  }
21850
23866
  ]
21851
23867
  }
@@ -22322,7 +24338,7 @@
22322
24338
  ],
22323
24339
  "security": [
22324
24340
  {
22325
- "api-key": []
24341
+ "secretKey": []
22326
24342
  }
22327
24343
  ]
22328
24344
  },
@@ -22804,7 +24820,7 @@
22804
24820
  ],
22805
24821
  "security": [
22806
24822
  {
22807
- "api-key": []
24823
+ "secretKey": []
22808
24824
  }
22809
24825
  ]
22810
24826
  },
@@ -23297,79 +25313,10 @@
23297
25313
  ],
23298
25314
  "security": [
23299
25315
  {
23300
- "api-key": []
25316
+ "secretKey": []
23301
25317
  }
23302
25318
  ]
23303
25319
  }
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
25320
  }
23374
25321
  },
23375
25322
  "info": {
@@ -23500,13 +25447,6 @@
23500
25447
  "externalDocs": {
23501
25448
  "url": "https://docs.novu.co/activity-feed"
23502
25449
  }
23503
- },
23504
- {
23505
- "name": "Translations",
23506
- "description": "Translations are used to localize your messages for different languages and regions. Novu provides a way to create and manage translations for your messages. You can create translations for your messages in different languages and regions, and assign them to your subscribers based on their preferences.",
23507
- "externalDocs": {
23508
- "url": "https://docs.novu.co/content-creation-design/translations"
23509
- }
23510
25450
  }
23511
25451
  ],
23512
25452
  "servers": [
@@ -23519,10 +25459,10 @@
23519
25459
  ],
23520
25460
  "components": {
23521
25461
  "securitySchemes": {
23522
- "api-key": {
25462
+ "secretKey": {
23523
25463
  "type": "apiKey",
23524
- "in": "header",
23525
25464
  "name": "Authorization",
25465
+ "in": "header",
23526
25466
  "description": "API key authentication. Allowed headers-- \"Authorization: ApiKey \u003capi_key\u003e\"."
23527
25467
  }
23528
25468
  },
@@ -23907,26 +25847,14 @@
23907
25847
  "type"
23908
25848
  ]
23909
25849
  },
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
25850
  "TriggerEventRequestDto": {
23924
25851
  "type": "object",
23925
25852
  "properties": {
23926
25853
  "name": {
23927
25854
  "type": "string",
23928
25855
  "description": "The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.",
23929
- "example": "workflow_identifier"
25856
+ "example": "workflow_identifier",
25857
+ "x-speakeasy-name-override": "workflowId"
23930
25858
  },
23931
25859
  "payload": {
23932
25860
  "type": "object",
@@ -23939,11 +25867,6 @@
23939
25867
  }
23940
25868
  }
23941
25869
  },
23942
- "bridgeUrl": {
23943
- "type": "string",
23944
- "description": "A URL to bridge for additional processing.",
23945
- "example": "https://example.com/bridge"
23946
- },
23947
25870
  "overrides": {
23948
25871
  "type": "object",
23949
25872
  "description": "This could be used to override provider specific configurations",
@@ -24020,14 +25943,6 @@
24020
25943
  "$ref": "#/components/schemas/TenantPayloadDto"
24021
25944
  }
24022
25945
  ]
24023
- },
24024
- "controls": {
24025
- "description": "Additional control configurations.",
24026
- "allOf": [
24027
- {
24028
- "$ref": "#/components/schemas/WorkflowToStepControlValuesDto"
24029
- }
24030
- ]
24031
25946
  }
24032
25947
  },
24033
25948
  "required": [
@@ -25362,7 +27277,7 @@
25362
27277
  }
25363
27278
  }
25364
27279
  },
25365
- "ChannelSettings": {
27280
+ "ChannelSettingsDto": {
25366
27281
  "type": "object",
25367
27282
  "properties": {
25368
27283
  "providerId": {
@@ -25451,11 +27366,12 @@
25451
27366
  "description": "An array of channel settings associated with the subscriber.",
25452
27367
  "type": "array",
25453
27368
  "items": {
25454
- "$ref": "#/components/schemas/ChannelSettings"
27369
+ "$ref": "#/components/schemas/ChannelSettingsDto"
25455
27370
  }
25456
27371
  },
25457
27372
  "topics": {
25458
27373
  "description": "An array of topics that the subscriber is subscribed to.",
27374
+ "deprecated": true,
25459
27375
  "type": "array",
25460
27376
  "items": {
25461
27377
  "type": "string"
@@ -25492,6 +27408,12 @@
25492
27408
  "__v": {
25493
27409
  "type": "number",
25494
27410
  "description": "The version of the subscriber document."
27411
+ },
27412
+ "data": {
27413
+ "type": "object",
27414
+ "description": "Additional custom data for the subscriber",
27415
+ "additionalProperties": true,
27416
+ "nullable": true
25495
27417
  }
25496
27418
  },
25497
27419
  "required": [
@@ -27310,6 +29232,102 @@
27310
29232
  "type": "object",
27311
29233
  "properties": {}
27312
29234
  },
29235
+ "ListSubscribersResponseDto": {
29236
+ "type": "object",
29237
+ "properties": {
29238
+ "data": {
29239
+ "description": "List of returned Subscribers",
29240
+ "type": "array",
29241
+ "items": {
29242
+ "$ref": "#/components/schemas/SubscriberResponseDto"
29243
+ }
29244
+ },
29245
+ "next": {
29246
+ "type": "string",
29247
+ "description": "The cursor for the next page of results, or null if there are no more pages.",
29248
+ "nullable": true
29249
+ },
29250
+ "previous": {
29251
+ "type": "string",
29252
+ "description": "The cursor for the previous page of results, or null if this is the first page.",
29253
+ "nullable": true
29254
+ }
29255
+ },
29256
+ "required": [
29257
+ "data",
29258
+ "next",
29259
+ "previous"
29260
+ ]
29261
+ },
29262
+ "PatchSubscriberRequestDto": {
29263
+ "type": "object",
29264
+ "properties": {
29265
+ "subscriberId": {
29266
+ "type": "string",
29267
+ "nullable": true,
29268
+ "description": "Unique identifier of the subscriber"
29269
+ },
29270
+ "firstName": {
29271
+ "type": "string",
29272
+ "nullable": true,
29273
+ "description": "First name of the subscriber"
29274
+ },
29275
+ "lastName": {
29276
+ "type": "string",
29277
+ "nullable": true,
29278
+ "description": "Last name of the subscriber"
29279
+ },
29280
+ "email": {
29281
+ "type": "string",
29282
+ "nullable": true,
29283
+ "description": "Email address of the subscriber"
29284
+ },
29285
+ "phone": {
29286
+ "type": "string",
29287
+ "nullable": true,
29288
+ "description": "Phone number of the subscriber"
29289
+ },
29290
+ "avatar": {
29291
+ "type": "string",
29292
+ "nullable": true,
29293
+ "description": "Avatar URL or identifier"
29294
+ },
29295
+ "timezone": {
29296
+ "type": "string",
29297
+ "nullable": true,
29298
+ "description": "Timezone of the subscriber"
29299
+ },
29300
+ "locale": {
29301
+ "type": "string",
29302
+ "nullable": true,
29303
+ "description": "Locale of the subscriber"
29304
+ },
29305
+ "data": {
29306
+ "type": "object",
29307
+ "nullable": true,
29308
+ "description": "Additional custom data for the subscriber"
29309
+ }
29310
+ }
29311
+ },
29312
+ "RemoveSubscriberResponseDto": {
29313
+ "type": "object",
29314
+ "properties": {
29315
+ "acknowledged": {
29316
+ "type": "boolean",
29317
+ "description": "Indicates whether the operation was acknowledged by the server",
29318
+ "example": true
29319
+ },
29320
+ "status": {
29321
+ "type": "string",
29322
+ "description": "Status of the subscriber removal operation",
29323
+ "example": "success"
29324
+ }
29325
+ },
29326
+ "required": [
29327
+ "acknowledged",
29328
+ "status"
29329
+ ]
29330
+ },
27313
29331
  "DeleteMessageResponseDto": {
27314
29332
  "type": "object",
27315
29333
  "properties": {
@@ -27619,46 +29637,6 @@
27619
29637
  "GeneratePreviewResponseDto": {
27620
29638
  "type": "object",
27621
29639
  "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
29640
  }
27663
29641
  },
27664
29642
  "headers": {
@@ -27740,6 +29718,11 @@
27740
29718
  "description": "Novu Documentation",
27741
29719
  "url": "https://docs.novu.co"
27742
29720
  },
29721
+ "security": [
29722
+ {
29723
+ "secretKey": []
29724
+ }
29725
+ ],
27743
29726
  "x-speakeasy-name-override": [
27744
29727
  {
27745
29728
  "operationId": "^.*get.*",