@novu/api 1.6.1-rc.0 → 1.7.0

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 (266) hide show
  1. package/README.md +14 -17
  2. package/bin/mcp-server.js +389 -236
  3. package/bin/mcp-server.js.map +62 -58
  4. package/docs/sdks/groups/README.md +23 -23
  5. package/docs/sdks/master/README.md +4 -4
  6. package/docs/sdks/preferences/README.md +136 -2
  7. package/docs/sdks/translations/README.md +11 -11
  8. package/examples/package-lock.json +1 -1
  9. package/funcs/translationsCreate.d.ts +2 -2
  10. package/funcs/translationsCreate.js +2 -2
  11. package/funcs/translationsDelete.d.ts +1 -1
  12. package/funcs/translationsDelete.js +1 -1
  13. package/funcs/translationsGroupsDelete.d.ts +1 -1
  14. package/funcs/translationsGroupsDelete.js +1 -1
  15. package/funcs/translationsGroupsRetrieve.d.ts +2 -2
  16. package/funcs/translationsGroupsRetrieve.js +2 -2
  17. package/funcs/translationsMasterImport.d.ts +1 -1
  18. package/funcs/translationsMasterImport.js +1 -1
  19. package/funcs/translationsMasterRetrieve.d.ts +2 -2
  20. package/funcs/translationsMasterRetrieve.js +2 -2
  21. package/funcs/translationsMasterUpload.d.ts +1 -1
  22. package/funcs/translationsMasterUpload.js +1 -1
  23. package/funcs/translationsRetrieve.d.ts +2 -2
  24. package/funcs/translationsRetrieve.js +2 -2
  25. package/funcs/translationsUpload.d.ts +1 -1
  26. package/funcs/translationsUpload.js +1 -1
  27. package/jsr.json +1 -1
  28. package/lib/config.d.ts +3 -3
  29. package/lib/config.js +3 -3
  30. package/lib/config.js.map +1 -1
  31. package/lib/url.js +1 -1
  32. package/lib/url.js.map +1 -1
  33. package/mcp-server/mcp-server.js +1 -1
  34. package/mcp-server/mcp-server.js.map +1 -1
  35. package/mcp-server/server.js +1 -1
  36. package/mcp-server/server.js.map +1 -1
  37. package/mcp-server/tools/translationsCreate.js +2 -2
  38. package/mcp-server/tools/translationsCreate.js.map +1 -1
  39. package/mcp-server/tools/translationsDelete.js +1 -1
  40. package/mcp-server/tools/translationsGroupsDelete.js +1 -1
  41. package/mcp-server/tools/translationsGroupsRetrieve.js +2 -2
  42. package/mcp-server/tools/translationsGroupsRetrieve.js.map +1 -1
  43. package/mcp-server/tools/translationsMasterImport.js +1 -1
  44. package/mcp-server/tools/translationsMasterImport.js.map +1 -1
  45. package/mcp-server/tools/translationsMasterRetrieve.js +2 -2
  46. package/mcp-server/tools/translationsMasterRetrieve.js.map +1 -1
  47. package/mcp-server/tools/translationsMasterUpload.js +1 -1
  48. package/mcp-server/tools/translationsMasterUpload.js.map +1 -1
  49. package/mcp-server/tools/translationsRetrieve.js +2 -2
  50. package/mcp-server/tools/translationsRetrieve.js.map +1 -1
  51. package/mcp-server/tools/translationsUpload.js +1 -1
  52. package/models/components/activitynotificationjobresponsedto.d.ts +8 -0
  53. package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
  54. package/models/components/activitynotificationjobresponsedto.js +3 -0
  55. package/models/components/activitynotificationjobresponsedto.js.map +1 -1
  56. package/models/components/activitynotificationresponsedto.d.ts +23 -78
  57. package/models/components/activitynotificationresponsedto.d.ts.map +1 -1
  58. package/models/components/activitynotificationresponsedto.js +9 -78
  59. package/models/components/activitynotificationresponsedto.js.map +1 -1
  60. package/models/components/chatstepresponsedto.d.ts +2 -26
  61. package/models/components/chatstepresponsedto.d.ts.map +1 -1
  62. package/models/components/chatstepresponsedto.js +3 -26
  63. package/models/components/chatstepresponsedto.js.map +1 -1
  64. package/models/components/constraintvalidation.d.ts +4 -4
  65. package/models/components/constraintvalidation.d.ts.map +1 -1
  66. package/models/components/constraintvalidation.js +4 -4
  67. package/models/components/constraintvalidation.js.map +1 -1
  68. package/models/components/createworkflowdto.d.ts +9 -0
  69. package/models/components/createworkflowdto.d.ts.map +1 -1
  70. package/models/components/createworkflowdto.js +13 -0
  71. package/models/components/createworkflowdto.js.map +1 -1
  72. package/models/components/customstepresponsedto.d.ts +2 -26
  73. package/models/components/customstepresponsedto.d.ts.map +1 -1
  74. package/models/components/customstepresponsedto.js +3 -26
  75. package/models/components/customstepresponsedto.js.map +1 -1
  76. package/models/components/delaystepresponsedto.d.ts +2 -26
  77. package/models/components/delaystepresponsedto.d.ts.map +1 -1
  78. package/models/components/delaystepresponsedto.js +3 -26
  79. package/models/components/delaystepresponsedto.js.map +1 -1
  80. package/models/components/digeststepresponsedto.d.ts +2 -26
  81. package/models/components/digeststepresponsedto.d.ts.map +1 -1
  82. package/models/components/digeststepresponsedto.js +3 -26
  83. package/models/components/digeststepresponsedto.js.map +1 -1
  84. package/models/components/emailstepresponsedto.d.ts +2 -26
  85. package/models/components/emailstepresponsedto.d.ts.map +1 -1
  86. package/models/components/emailstepresponsedto.js +3 -26
  87. package/models/components/emailstepresponsedto.js.map +1 -1
  88. package/models/components/inappstepresponsedto.d.ts +2 -26
  89. package/models/components/inappstepresponsedto.d.ts.map +1 -1
  90. package/models/components/inappstepresponsedto.js +3 -26
  91. package/models/components/inappstepresponsedto.js.map +1 -1
  92. package/models/components/index.d.ts +4 -0
  93. package/models/components/index.d.ts.map +1 -1
  94. package/models/components/index.js +4 -0
  95. package/models/components/index.js.map +1 -1
  96. package/models/components/layoutresponsedto.d.ts +4 -52
  97. package/models/components/layoutresponsedto.d.ts.map +1 -1
  98. package/models/components/layoutresponsedto.js +5 -52
  99. package/models/components/layoutresponsedto.js.map +1 -1
  100. package/models/components/listsubscribersresponsedto.d.ts +10 -0
  101. package/models/components/listsubscribersresponsedto.d.ts.map +1 -1
  102. package/models/components/listsubscribersresponsedto.js +4 -0
  103. package/models/components/listsubscribersresponsedto.js.map +1 -1
  104. package/models/components/listtopicsresponsedto.d.ts +10 -0
  105. package/models/components/listtopicsresponsedto.d.ts.map +1 -1
  106. package/models/components/listtopicsresponsedto.js +4 -0
  107. package/models/components/listtopicsresponsedto.js.map +1 -1
  108. package/models/components/listtopicsubscriptionsresponsedto.d.ts +10 -0
  109. package/models/components/listtopicsubscriptionsresponsedto.d.ts.map +1 -1
  110. package/models/components/listtopicsubscriptionsresponsedto.js +4 -0
  111. package/models/components/listtopicsubscriptionsresponsedto.js.map +1 -1
  112. package/models/components/patchsubscriberpreferencesdto.d.ts +8 -2
  113. package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -1
  114. package/models/components/patchsubscriberpreferencesdto.js +5 -2
  115. package/models/components/patchsubscriberpreferencesdto.js.map +1 -1
  116. package/models/components/payloadvalidationerrordto.d.ts +4 -4
  117. package/models/components/payloadvalidationerrordto.d.ts.map +1 -1
  118. package/models/components/payloadvalidationerrordto.js +4 -4
  119. package/models/components/payloadvalidationerrordto.js.map +1 -1
  120. package/models/components/pushstepresponsedto.d.ts +2 -26
  121. package/models/components/pushstepresponsedto.d.ts.map +1 -1
  122. package/models/components/pushstepresponsedto.js +3 -26
  123. package/models/components/pushstepresponsedto.js.map +1 -1
  124. package/models/components/smsstepresponsedto.d.ts +2 -26
  125. package/models/components/smsstepresponsedto.d.ts.map +1 -1
  126. package/models/components/smsstepresponsedto.js +3 -26
  127. package/models/components/smsstepresponsedto.js.map +1 -1
  128. package/models/components/steplistresponsedto.d.ts +2 -26
  129. package/models/components/steplistresponsedto.d.ts.map +1 -1
  130. package/models/components/steplistresponsedto.js +3 -26
  131. package/models/components/steplistresponsedto.js.map +1 -1
  132. package/models/components/stepresponsedto.d.ts +2 -26
  133. package/models/components/stepresponsedto.d.ts.map +1 -1
  134. package/models/components/stepresponsedto.js +3 -26
  135. package/models/components/stepresponsedto.js.map +1 -1
  136. package/models/components/steptypeenum.d.ts +3 -0
  137. package/models/components/steptypeenum.d.ts.map +1 -1
  138. package/models/components/steptypeenum.js +1 -0
  139. package/models/components/steptypeenum.js.map +1 -1
  140. package/models/components/throttlecontroldto.d.ts +132 -0
  141. package/models/components/throttlecontroldto.d.ts.map +1 -0
  142. package/models/components/throttlecontroldto.js +126 -0
  143. package/models/components/throttlecontroldto.js.map +1 -0
  144. package/models/components/throttlecontrolsmetadataresponsedto.d.ts +48 -0
  145. package/models/components/throttlecontrolsmetadataresponsedto.d.ts.map +1 -0
  146. package/models/components/throttlecontrolsmetadataresponsedto.js +75 -0
  147. package/models/components/throttlecontrolsmetadataresponsedto.js.map +1 -0
  148. package/models/components/throttlestepresponsedto.d.ts +230 -0
  149. package/models/components/throttlestepresponsedto.d.ts.map +1 -0
  150. package/models/components/throttlestepresponsedto.js +196 -0
  151. package/models/components/throttlestepresponsedto.js.map +1 -0
  152. package/models/components/throttlestepupsertdto.d.ts +81 -0
  153. package/models/components/throttlestepupsertdto.d.ts.map +1 -0
  154. package/models/components/throttlestepupsertdto.js +111 -0
  155. package/models/components/throttlestepupsertdto.js.map +1 -0
  156. package/models/components/triggereventrequestdto.d.ts +4 -4
  157. package/models/components/triggereventrequestdto.d.ts.map +1 -1
  158. package/models/components/triggereventrequestdto.js +4 -4
  159. package/models/components/triggereventrequestdto.js.map +1 -1
  160. package/models/components/triggereventtoallrequestdto.d.ts +4 -4
  161. package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
  162. package/models/components/triggereventtoallrequestdto.js +4 -4
  163. package/models/components/triggereventtoallrequestdto.js.map +1 -1
  164. package/models/components/uicomponentenum.d.ts +21 -0
  165. package/models/components/uicomponentenum.d.ts.map +1 -1
  166. package/models/components/uicomponentenum.js +7 -0
  167. package/models/components/uicomponentenum.js.map +1 -1
  168. package/models/components/uischemagroupenum.d.ts +3 -0
  169. package/models/components/uischemagroupenum.d.ts.map +1 -1
  170. package/models/components/uischemagroupenum.js +1 -0
  171. package/models/components/uischemagroupenum.js.map +1 -1
  172. package/models/components/workflowlistresponsedto.d.ts +4 -52
  173. package/models/components/workflowlistresponsedto.d.ts.map +1 -1
  174. package/models/components/workflowlistresponsedto.js +5 -51
  175. package/models/components/workflowlistresponsedto.js.map +1 -1
  176. package/models/components/workflowresponsedto.d.ts +15 -78
  177. package/models/components/workflowresponsedto.d.ts.map +1 -1
  178. package/models/components/workflowresponsedto.js +20 -78
  179. package/models/components/workflowresponsedto.js.map +1 -1
  180. package/models/errors/errordto.d.ts +4 -4
  181. package/models/errors/errordto.d.ts.map +1 -1
  182. package/models/errors/errordto.js +4 -4
  183. package/models/errors/errordto.js.map +1 -1
  184. package/models/errors/index.d.ts +1 -0
  185. package/models/errors/index.d.ts.map +1 -1
  186. package/models/errors/index.js +1 -0
  187. package/models/errors/index.js.map +1 -1
  188. package/models/errors/payloadvalidationexceptiondto.d.ts +4 -4
  189. package/models/errors/payloadvalidationexceptiondto.d.ts.map +1 -1
  190. package/models/errors/payloadvalidationexceptiondto.js +4 -4
  191. package/models/errors/payloadvalidationexceptiondto.js.map +1 -1
  192. package/models/errors/validationerrordto.d.ts +4 -4
  193. package/models/errors/validationerrordto.d.ts.map +1 -1
  194. package/models/errors/validationerrordto.js +4 -4
  195. package/models/errors/validationerrordto.js.map +1 -1
  196. package/models/operations/translationcontrolleruploadtranslationfiles.d.ts +1 -1
  197. package/package.json +1 -1
  198. package/sdk/groups.d.ts +3 -3
  199. package/sdk/groups.js +3 -3
  200. package/sdk/master.d.ts +4 -4
  201. package/sdk/master.js +4 -4
  202. package/sdk/translations.d.ts +6 -6
  203. package/sdk/translations.js +6 -6
  204. package/sources/json-development.json +335 -37
  205. package/src/funcs/translationsCreate.ts +2 -2
  206. package/src/funcs/translationsDelete.ts +1 -1
  207. package/src/funcs/translationsGroupsDelete.ts +1 -1
  208. package/src/funcs/translationsGroupsRetrieve.ts +2 -2
  209. package/src/funcs/translationsMasterImport.ts +1 -1
  210. package/src/funcs/translationsMasterRetrieve.ts +2 -2
  211. package/src/funcs/translationsMasterUpload.ts +1 -1
  212. package/src/funcs/translationsRetrieve.ts +2 -2
  213. package/src/funcs/translationsUpload.ts +1 -1
  214. package/src/lib/config.ts +3 -3
  215. package/src/lib/url.ts +1 -1
  216. package/src/mcp-server/mcp-server.ts +1 -1
  217. package/src/mcp-server/server.ts +1 -1
  218. package/src/mcp-server/tools/translationsCreate.ts +2 -2
  219. package/src/mcp-server/tools/translationsDelete.ts +1 -1
  220. package/src/mcp-server/tools/translationsGroupsDelete.ts +1 -1
  221. package/src/mcp-server/tools/translationsGroupsRetrieve.ts +2 -2
  222. package/src/mcp-server/tools/translationsMasterImport.ts +1 -1
  223. package/src/mcp-server/tools/translationsMasterRetrieve.ts +2 -2
  224. package/src/mcp-server/tools/translationsMasterUpload.ts +1 -1
  225. package/src/mcp-server/tools/translationsRetrieve.ts +2 -2
  226. package/src/mcp-server/tools/translationsUpload.ts +1 -1
  227. package/src/models/components/activitynotificationjobresponsedto.ts +8 -0
  228. package/src/models/components/activitynotificationresponsedto.ts +19 -178
  229. package/src/models/components/chatstepresponsedto.ts +4 -57
  230. package/src/models/components/constraintvalidation.ts +8 -8
  231. package/src/models/components/createworkflowdto.ts +30 -0
  232. package/src/models/components/customstepresponsedto.ts +4 -57
  233. package/src/models/components/delaystepresponsedto.ts +4 -57
  234. package/src/models/components/digeststepresponsedto.ts +4 -57
  235. package/src/models/components/emailstepresponsedto.ts +4 -57
  236. package/src/models/components/inappstepresponsedto.ts +4 -57
  237. package/src/models/components/index.ts +4 -0
  238. package/src/models/components/layoutresponsedto.ts +8 -100
  239. package/src/models/components/listsubscribersresponsedto.ts +14 -0
  240. package/src/models/components/listtopicsresponsedto.ts +14 -0
  241. package/src/models/components/listtopicsubscriptionsresponsedto.ts +14 -0
  242. package/src/models/components/patchsubscriberpreferencesdto.ts +17 -4
  243. package/src/models/components/payloadvalidationerrordto.ts +8 -8
  244. package/src/models/components/pushstepresponsedto.ts +4 -57
  245. package/src/models/components/smsstepresponsedto.ts +4 -57
  246. package/src/models/components/steplistresponsedto.ts +4 -57
  247. package/src/models/components/stepresponsedto.ts +4 -57
  248. package/src/models/components/steptypeenum.ts +1 -0
  249. package/src/models/components/throttlecontroldto.ts +179 -0
  250. package/src/models/components/throttlecontrolsmetadataresponsedto.ts +100 -0
  251. package/src/models/components/throttlestepresponsedto.ts +381 -0
  252. package/src/models/components/throttlestepupsertdto.ts +176 -0
  253. package/src/models/components/triggereventrequestdto.ts +8 -8
  254. package/src/models/components/triggereventtoallrequestdto.ts +9 -9
  255. package/src/models/components/uicomponentenum.ts +7 -0
  256. package/src/models/components/uischemagroupenum.ts +1 -0
  257. package/src/models/components/workflowlistresponsedto.ts +8 -141
  258. package/src/models/components/workflowresponsedto.ts +44 -194
  259. package/src/models/errors/errordto.ts +8 -8
  260. package/src/models/errors/index.ts +1 -0
  261. package/src/models/errors/payloadvalidationexceptiondto.ts +8 -8
  262. package/src/models/errors/validationerrordto.ts +8 -8
  263. package/src/models/operations/translationcontrolleruploadtranslationfiles.ts +1 -1
  264. package/src/sdk/groups.ts +3 -3
  265. package/src/sdk/master.ts +4 -4
  266. package/src/sdk/translations.ts +6 -6
package/README.md CHANGED
@@ -83,10 +83,7 @@ bun add @novu/api
83
83
  ### Yarn
84
84
 
85
85
  ```bash
86
- yarn add @novu/api zod
87
-
88
- # Note that Yarn does not install peer dependencies automatically. You will need
89
- # to install zod as shown above.
86
+ yarn add @novu/api
90
87
  ```
91
88
 
92
89
 
@@ -438,19 +435,19 @@ run();
438
435
 
439
436
  ### [translations](docs/sdks/translations/README.md)
440
437
 
441
- * [create](docs/sdks/translations/README.md#create) - Create or update translation
442
- * [retrieve](docs/sdks/translations/README.md#retrieve) - Get single translation
443
- * [delete](docs/sdks/translations/README.md#delete) - Delete translation
438
+ * [create](docs/sdks/translations/README.md#create) - Create a translation
439
+ * [retrieve](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
440
+ * [delete](docs/sdks/translations/README.md#delete) - Delete a translation
444
441
  * [upload](docs/sdks/translations/README.md#upload) - Upload translation files
445
442
 
446
443
  #### [translations.groups](docs/sdks/groups/README.md)
447
444
 
448
- * [delete](docs/sdks/groups/README.md#delete) - Delete translation group
449
- * [retrieve](docs/sdks/groups/README.md#retrieve) - Get translation group
445
+ * [delete](docs/sdks/groups/README.md#delete) - Delete a translation group
446
+ * [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group
450
447
 
451
448
  #### [translations.master](docs/sdks/master/README.md)
452
449
 
453
- * [retrieve](docs/sdks/master/README.md#retrieve) - Get master translations JSON
450
+ * [retrieve](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
454
451
  * [import](docs/sdks/master/README.md#import) - Import master translations JSON
455
452
  * [upload](docs/sdks/master/README.md#upload) - Upload master translations JSON file
456
453
 
@@ -541,14 +538,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
541
538
  - [`topicsSubscriptionsDelete`](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
542
539
  - [`topicsSubscriptionsList`](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
543
540
  - [`topicsUpdate`](docs/sdks/topics/README.md#update) - Update a topic
544
- - [`translationsCreate`](docs/sdks/translations/README.md#create) - Create or update translation
545
- - [`translationsDelete`](docs/sdks/translations/README.md#delete) - Delete translation
546
- - [`translationsGroupsDelete`](docs/sdks/groups/README.md#delete) - Delete translation group
547
- - [`translationsGroupsRetrieve`](docs/sdks/groups/README.md#retrieve) - Get translation group
541
+ - [`translationsCreate`](docs/sdks/translations/README.md#create) - Create a translation
542
+ - [`translationsDelete`](docs/sdks/translations/README.md#delete) - Delete a translation
543
+ - [`translationsGroupsDelete`](docs/sdks/groups/README.md#delete) - Delete a translation group
544
+ - [`translationsGroupsRetrieve`](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group
548
545
  - [`translationsMasterImport`](docs/sdks/master/README.md#import) - Import master translations JSON
549
- - [`translationsMasterRetrieve`](docs/sdks/master/README.md#retrieve) - Get master translations JSON
546
+ - [`translationsMasterRetrieve`](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
550
547
  - [`translationsMasterUpload`](docs/sdks/master/README.md#upload) - Upload master translations JSON file
551
- - [`translationsRetrieve`](docs/sdks/translations/README.md#retrieve) - Get single translation
548
+ - [`translationsRetrieve`](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
552
549
  - [`translationsUpload`](docs/sdks/translations/README.md#upload) - Upload translation files
553
550
  - [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
554
551
  - [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
@@ -751,7 +748,7 @@ httpClient.addHook("requestError", (error, request) => {
751
748
  console.groupEnd();
752
749
  });
753
750
 
754
- const sdk = new Novu({ httpClient });
751
+ const sdk = new Novu({ httpClient: httpClient });
755
752
  ```
756
753
  <!-- End Custom HTTP Client [http-client] -->
757
754