@novu/api 3.12.0-rc.0 → 3.13.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 (242) hide show
  1. package/README.md +25 -23
  2. package/_speakeasy/.github/action-inputs-config.json +53 -0
  3. package/_speakeasy/.github/action-security-config.json +88 -0
  4. package/examples/package-lock.json +1 -1
  5. package/funcs/channelConnectionsCreate.d.ts +1 -1
  6. package/funcs/channelConnectionsCreate.js +1 -1
  7. package/funcs/channelConnectionsDelete.d.ts +1 -1
  8. package/funcs/channelConnectionsDelete.js +1 -1
  9. package/funcs/channelConnectionsList.d.ts +2 -2
  10. package/funcs/channelConnectionsList.js +2 -2
  11. package/funcs/channelConnectionsRetrieve.d.ts +1 -1
  12. package/funcs/channelConnectionsRetrieve.js +1 -1
  13. package/funcs/channelConnectionsUpdate.d.ts +1 -1
  14. package/funcs/channelConnectionsUpdate.js +1 -1
  15. package/funcs/channelEndpointsCreate.d.ts +1 -1
  16. package/funcs/channelEndpointsCreate.js +1 -1
  17. package/funcs/channelEndpointsDelete.d.ts +1 -1
  18. package/funcs/channelEndpointsDelete.js +1 -1
  19. package/funcs/channelEndpointsList.d.ts +2 -2
  20. package/funcs/channelEndpointsList.js +2 -2
  21. package/funcs/channelEndpointsRetrieve.d.ts +1 -1
  22. package/funcs/channelEndpointsRetrieve.js +1 -1
  23. package/funcs/channelEndpointsUpdate.d.ts +1 -1
  24. package/funcs/channelEndpointsUpdate.js +1 -1
  25. package/funcs/notificationsList.js +1 -0
  26. package/funcs/notificationsList.js.map +1 -1
  27. package/funcs/subscribersPreferencesList.d.ts +1 -1
  28. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  29. package/funcs/subscribersPreferencesList.js +5 -9
  30. package/funcs/subscribersPreferencesList.js.map +1 -1
  31. package/funcs/subscribersTopicsList.js +1 -0
  32. package/funcs/subscribersTopicsList.js.map +1 -1
  33. package/funcs/topicsSubscriptionsGetSubscription.d.ts +18 -0
  34. package/funcs/topicsSubscriptionsGetSubscription.d.ts.map +1 -0
  35. package/funcs/topicsSubscriptionsGetSubscription.js +160 -0
  36. package/funcs/topicsSubscriptionsGetSubscription.js.map +1 -0
  37. package/funcs/topicsSubscriptionsList.js +1 -0
  38. package/funcs/topicsSubscriptionsList.js.map +1 -1
  39. package/funcs/topicsSubscriptionsUpdate.d.ts +1 -1
  40. package/funcs/topicsSubscriptionsUpdate.js +6 -3
  41. package/funcs/topicsSubscriptionsUpdate.js.map +1 -1
  42. package/funcs/trigger.d.ts +1 -1
  43. package/funcs/trigger.js +1 -1
  44. package/jsr.json +1 -1
  45. package/lib/config.d.ts +4 -4
  46. package/lib/config.js +4 -4
  47. package/lib/config.js.map +1 -1
  48. package/lib/sdks.js +2 -2
  49. package/lib/sdks.js.map +1 -1
  50. package/models/components/activitynotificationjobresponsedto.d.ts +4 -4
  51. package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
  52. package/models/components/activitynotificationjobresponsedto.js +6 -7
  53. package/models/components/activitynotificationjobresponsedto.js.map +1 -1
  54. package/models/components/bulkupdatesubscriberpreferencesdto.d.ts +34 -0
  55. package/models/components/bulkupdatesubscriberpreferencesdto.d.ts.map +1 -1
  56. package/models/components/bulkupdatesubscriberpreferencesdto.js +17 -1
  57. package/models/components/bulkupdatesubscriberpreferencesdto.js.map +1 -1
  58. package/models/components/createchannelconnectionrequestdto.d.ts +10 -10
  59. package/models/components/createchannelconnectionrequestdto.d.ts.map +1 -1
  60. package/models/components/createchannelconnectionrequestdto.js +16 -12
  61. package/models/components/createchannelconnectionrequestdto.js.map +1 -1
  62. package/models/components/createslackchannelendpointdto.d.ts +8 -8
  63. package/models/components/createslackchannelendpointdto.d.ts.map +1 -1
  64. package/models/components/createslackchannelendpointdto.js +13 -7
  65. package/models/components/createslackchannelendpointdto.js.map +1 -1
  66. package/models/components/createtopicsubscriptionsrequestdto.d.ts +34 -0
  67. package/models/components/createtopicsubscriptionsrequestdto.d.ts.map +1 -1
  68. package/models/components/createtopicsubscriptionsrequestdto.js +23 -1
  69. package/models/components/createtopicsubscriptionsrequestdto.js.map +1 -1
  70. package/models/components/delaystepresponsedto.d.ts +1 -1
  71. package/models/components/delaystepresponsedto.d.ts.map +1 -1
  72. package/models/components/emailstepresponsedto.d.ts +3 -3
  73. package/models/components/emailstepresponsedto.d.ts.map +1 -1
  74. package/models/components/generatechatoauthurlrequestdto.d.ts +1 -1
  75. package/models/components/inappcontroldto.d.ts +1 -1
  76. package/models/components/inappstepresponsedto.d.ts +2 -2
  77. package/models/components/inappstepresponsedto.d.ts.map +1 -1
  78. package/models/components/index.d.ts +1 -0
  79. package/models/components/index.d.ts.map +1 -1
  80. package/models/components/index.js +1 -0
  81. package/models/components/index.js.map +1 -1
  82. package/models/components/messageactionresult.d.ts +3 -8
  83. package/models/components/messageactionresult.d.ts.map +1 -1
  84. package/models/components/messageactionresult.js +2 -8
  85. package/models/components/messageactionresult.js.map +1 -1
  86. package/models/components/messageresponsedto.d.ts +6 -16
  87. package/models/components/messageresponsedto.d.ts.map +1 -1
  88. package/models/components/messageresponsedto.js +3 -15
  89. package/models/components/messageresponsedto.js.map +1 -1
  90. package/models/components/notificationfeeditemdto.d.ts +4 -0
  91. package/models/components/notificationfeeditemdto.d.ts.map +1 -1
  92. package/models/components/notificationfeeditemdto.js +1 -0
  93. package/models/components/notificationfeeditemdto.js.map +1 -1
  94. package/models/components/patchsubscriberpreferencesdto.d.ts +34 -0
  95. package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -1
  96. package/models/components/patchsubscriberpreferencesdto.js +19 -1
  97. package/models/components/patchsubscriberpreferencesdto.js.map +1 -1
  98. package/models/components/redirectdto.d.ts +1 -1
  99. package/models/components/subscriberworkflowpreferencedto.d.ts +4 -0
  100. package/models/components/subscriberworkflowpreferencedto.d.ts.map +1 -1
  101. package/models/components/subscriberworkflowpreferencedto.js +1 -0
  102. package/models/components/subscriberworkflowpreferencedto.js.map +1 -1
  103. package/models/components/subscriptiondetailsresponsedto.d.ts +30 -0
  104. package/models/components/subscriptiondetailsresponsedto.d.ts.map +1 -0
  105. package/models/components/{createtopicsubscriptionsresponsedto.js → subscriptiondetailsresponsedto.js} +12 -12
  106. package/models/components/subscriptiondetailsresponsedto.js.map +1 -0
  107. package/models/components/subscriptiondto.d.ts +4 -0
  108. package/models/components/subscriptiondto.d.ts.map +1 -1
  109. package/models/components/subscriptiondto.js +1 -0
  110. package/models/components/subscriptiondto.js.map +1 -1
  111. package/models/components/subscriptionresponsedto.d.ts +4 -0
  112. package/models/components/subscriptionresponsedto.d.ts.map +1 -1
  113. package/models/components/subscriptionresponsedto.js +1 -0
  114. package/models/components/subscriptionresponsedto.js.map +1 -1
  115. package/models/components/throttlestepresponsedto.d.ts +2 -2
  116. package/models/components/throttlestepresponsedto.d.ts.map +1 -1
  117. package/models/components/topicsubscriptionresponsedto.d.ts +8 -0
  118. package/models/components/topicsubscriptionresponsedto.d.ts.map +1 -1
  119. package/models/components/topicsubscriptionresponsedto.js +2 -0
  120. package/models/components/topicsubscriptionresponsedto.js.map +1 -1
  121. package/models/components/triggereventrequestdto.d.ts +2 -2
  122. package/models/components/workflowresponsedto.d.ts +2 -2
  123. package/models/components/workflowresponsedto.d.ts.map +1 -1
  124. package/models/operations/inboundwebhookscontrollerhandlewebhook.d.ts +6 -2
  125. package/models/operations/inboundwebhookscontrollerhandlewebhook.d.ts.map +1 -1
  126. package/models/operations/inboundwebhookscontrollerhandlewebhook.js +1 -1
  127. package/models/operations/inboundwebhookscontrollerhandlewebhook.js.map +1 -1
  128. package/models/operations/index.d.ts +1 -0
  129. package/models/operations/index.d.ts.map +1 -1
  130. package/models/operations/index.js +1 -0
  131. package/models/operations/index.js.map +1 -1
  132. package/models/operations/notificationscontrollerlistnotifications.d.ts +5 -0
  133. package/models/operations/notificationscontrollerlistnotifications.d.ts.map +1 -1
  134. package/models/operations/notificationscontrollerlistnotifications.js +1 -0
  135. package/models/operations/notificationscontrollerlistnotifications.js.map +1 -1
  136. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts +5 -0
  137. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -1
  138. package/models/operations/subscriberscontrollergetsubscriberpreferences.js +1 -0
  139. package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -1
  140. package/models/operations/subscriberscontrollerlistsubscribertopics.d.ts +5 -0
  141. package/models/operations/subscriberscontrollerlistsubscribertopics.d.ts.map +1 -1
  142. package/models/operations/subscriberscontrollerlistsubscribertopics.js +1 -0
  143. package/models/operations/subscriberscontrollerlistsubscribertopics.js.map +1 -1
  144. package/models/operations/topicscontrollergettopicsubscription.d.ts +37 -0
  145. package/models/operations/topicscontrollergettopicsubscription.d.ts.map +1 -0
  146. package/models/operations/topicscontrollergettopicsubscription.js +72 -0
  147. package/models/operations/topicscontrollergettopicsubscription.js.map +1 -0
  148. package/models/operations/topicscontrollerlisttopicsubscriptions.d.ts +5 -0
  149. package/models/operations/topicscontrollerlisttopicsubscriptions.d.ts.map +1 -1
  150. package/models/operations/topicscontrollerlisttopicsubscriptions.js +1 -0
  151. package/models/operations/topicscontrollerlisttopicsubscriptions.js.map +1 -1
  152. package/models/operations/topicscontrollerupdatetopicsubscription.d.ts +2 -2
  153. package/models/operations/topicscontrollerupdatetopicsubscription.d.ts.map +1 -1
  154. package/models/operations/topicscontrollerupdatetopicsubscription.js +1 -1
  155. package/models/operations/topicscontrollerupdatetopicsubscription.js.map +1 -1
  156. package/package.json +1 -1
  157. package/sdk/channelconnections.d.ts +6 -6
  158. package/sdk/channelconnections.js +6 -6
  159. package/sdk/channelendpoints.d.ts +6 -6
  160. package/sdk/channelendpoints.js +6 -6
  161. package/sdk/preferences.d.ts +1 -1
  162. package/sdk/preferences.d.ts.map +1 -1
  163. package/sdk/preferences.js +2 -2
  164. package/sdk/preferences.js.map +1 -1
  165. package/sdk/sdk.d.ts +1 -1
  166. package/sdk/sdk.js +1 -1
  167. package/sdk/subscriptions.d.ts +8 -1
  168. package/sdk/subscriptions.d.ts.map +1 -1
  169. package/sdk/subscriptions.js +11 -1
  170. package/sdk/subscriptions.js.map +1 -1
  171. package/sources/json-development.json +954 -183
  172. package/src/funcs/channelConnectionsCreate.ts +1 -1
  173. package/src/funcs/channelConnectionsDelete.ts +1 -1
  174. package/src/funcs/channelConnectionsList.ts +2 -2
  175. package/src/funcs/channelConnectionsRetrieve.ts +1 -1
  176. package/src/funcs/channelConnectionsUpdate.ts +1 -1
  177. package/src/funcs/channelEndpointsCreate.ts +1 -1
  178. package/src/funcs/channelEndpointsDelete.ts +1 -1
  179. package/src/funcs/channelEndpointsList.ts +2 -2
  180. package/src/funcs/channelEndpointsRetrieve.ts +1 -1
  181. package/src/funcs/channelEndpointsUpdate.ts +1 -1
  182. package/src/funcs/notificationsList.ts +1 -0
  183. package/src/funcs/subscribersPreferencesList.ts +5 -17
  184. package/src/funcs/subscribersTopicsList.ts +1 -0
  185. package/src/funcs/topicsSubscriptionsGetSubscription.ts +242 -0
  186. package/src/funcs/topicsSubscriptionsList.ts +1 -0
  187. package/src/funcs/topicsSubscriptionsUpdate.ts +8 -9
  188. package/src/funcs/trigger.ts +1 -1
  189. package/src/lib/config.ts +4 -4
  190. package/src/lib/sdks.ts +2 -2
  191. package/src/models/components/activitynotificationjobresponsedto.ts +9 -19
  192. package/src/models/components/bulkupdatesubscriberpreferencesdto.ts +62 -0
  193. package/src/models/components/createchannelconnectionrequestdto.ts +51 -18
  194. package/src/models/components/createslackchannelendpointdto.ts +31 -13
  195. package/src/models/components/createtopicsubscriptionsrequestdto.ts +82 -0
  196. package/src/models/components/delaystepresponsedto.ts +1 -1
  197. package/src/models/components/emailstepresponsedto.ts +3 -3
  198. package/src/models/components/generatechatoauthurlrequestdto.ts +1 -1
  199. package/src/models/components/inappcontroldto.ts +1 -1
  200. package/src/models/components/inappstepresponsedto.ts +2 -2
  201. package/src/models/components/index.ts +1 -0
  202. package/src/models/components/messageactionresult.ts +2 -21
  203. package/src/models/components/messageresponsedto.ts +4 -48
  204. package/src/models/components/notificationfeeditemdto.ts +5 -0
  205. package/src/models/components/patchsubscriberpreferencesdto.ts +48 -0
  206. package/src/models/components/redirectdto.ts +1 -1
  207. package/src/models/components/subscriberworkflowpreferencedto.ts +5 -0
  208. package/src/models/components/subscriptiondetailsresponsedto.ts +58 -0
  209. package/src/models/components/subscriptiondto.ts +5 -0
  210. package/src/models/components/subscriptionresponsedto.ts +5 -0
  211. package/src/models/components/throttlestepresponsedto.ts +2 -2
  212. package/src/models/components/topicsubscriptionresponsedto.ts +10 -0
  213. package/src/models/components/triggereventrequestdto.ts +2 -2
  214. package/src/models/components/workflowresponsedto.ts +2 -2
  215. package/src/models/operations/inboundwebhookscontrollerhandlewebhook.ts +3 -3
  216. package/src/models/operations/index.ts +1 -0
  217. package/src/models/operations/notificationscontrollerlistnotifications.ts +6 -0
  218. package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +6 -0
  219. package/src/models/operations/subscriberscontrollerlistsubscribertopics.ts +6 -0
  220. package/src/models/operations/topicscontrollergettopicsubscription.ts +96 -0
  221. package/src/models/operations/topicscontrollerlisttopicsubscriptions.ts +6 -0
  222. package/src/models/operations/topicscontrollerupdatetopicsubscription.ts +3 -3
  223. package/src/sdk/channelconnections.ts +6 -6
  224. package/src/sdk/channelendpoints.ts +6 -6
  225. package/src/sdk/preferences.ts +2 -6
  226. package/src/sdk/sdk.ts +1 -1
  227. package/src/sdk/subscriptions.ts +23 -1
  228. package/models/components/createtopicsubscriptionsresponsedto.d.ts +0 -24
  229. package/models/components/createtopicsubscriptionsresponsedto.d.ts.map +0 -1
  230. package/models/components/createtopicsubscriptionsresponsedto.js.map +0 -1
  231. package/models/components/steptypeenum.d.ts +0 -26
  232. package/models/components/steptypeenum.d.ts.map +0 -1
  233. package/models/components/steptypeenum.js +0 -60
  234. package/models/components/steptypeenum.js.map +0 -1
  235. package/models/components/uploadtranslationsrequestdto.d.ts +0 -34
  236. package/models/components/uploadtranslationsrequestdto.d.ts.map +0 -1
  237. package/models/components/uploadtranslationsrequestdto.js +0 -60
  238. package/models/components/uploadtranslationsrequestdto.js.map +0 -1
  239. package/src/models/components/createtopicsubscriptionsresponsedto.ts +0 -54
  240. package/src/models/components/steptypeenum.ts +0 -33
  241. package/src/models/components/uploadtranslationsrequestdto.ts +0 -62
  242. package/temp/example.ts +0 -5
@@ -13,16 +13,16 @@ const sdks_js_1 = require("../lib/sdks.js");
13
13
  const fp_js_1 = require("../types/fp.js");
14
14
  class ChannelConnections extends sdks_js_1.ClientSDK {
15
15
  /**
16
- * List channel connections
16
+ * List all channel connections
17
17
  *
18
18
  * @remarks
19
- * Retrieve all channel connections for a resource.
19
+ * List all channel connections for a resource.
20
20
  */
21
21
  async list(request, options) {
22
22
  return (0, fp_js_1.unwrapAsync)((0, channelConnectionsList_js_1.channelConnectionsList)(this, request, options));
23
23
  }
24
24
  /**
25
- * Create channel connection for a resource and integration
25
+ * Create a channel connection
26
26
  *
27
27
  * @remarks
28
28
  * Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration.
@@ -31,7 +31,7 @@ class ChannelConnections extends sdks_js_1.ClientSDK {
31
31
  return (0, fp_js_1.unwrapAsync)((0, channelConnectionsCreate_js_1.channelConnectionsCreate)(this, createChannelConnectionRequestDto, idempotencyKey, options));
32
32
  }
33
33
  /**
34
- * Retrieve channel connection by identifier
34
+ * Retrieve a channel connection
35
35
  *
36
36
  * @remarks
37
37
  * Retrieve a specific channel connection by its unique identifier.
@@ -40,7 +40,7 @@ class ChannelConnections extends sdks_js_1.ClientSDK {
40
40
  return (0, fp_js_1.unwrapAsync)((0, channelConnectionsRetrieve_js_1.channelConnectionsRetrieve)(this, identifier, idempotencyKey, options));
41
41
  }
42
42
  /**
43
- * Update channel connection
43
+ * Update a channel connection
44
44
  *
45
45
  * @remarks
46
46
  * Update an existing channel connection by its unique identifier.
@@ -49,7 +49,7 @@ class ChannelConnections extends sdks_js_1.ClientSDK {
49
49
  return (0, fp_js_1.unwrapAsync)((0, channelConnectionsUpdate_js_1.channelConnectionsUpdate)(this, updateChannelConnectionRequestDto, identifier, idempotencyKey, options));
50
50
  }
51
51
  /**
52
- * Delete channel connection
52
+ * Delete a channel connection
53
53
  *
54
54
  * @remarks
55
55
  * Delete a specific channel connection by its unique identifier.
@@ -3,35 +3,35 @@ import * as components from "../models/components/index.js";
3
3
  import * as operations from "../models/operations/index.js";
4
4
  export declare class ChannelEndpoints extends ClientSDK {
5
5
  /**
6
- * List channel endpoints
6
+ * List all channel endpoints
7
7
  *
8
8
  * @remarks
9
- * Retrieve all channel endpoints for a resource based on query filters.
9
+ * List all channel endpoints for a resource based on query filters.
10
10
  */
11
11
  list(request: operations.ChannelEndpointsControllerListChannelEndpointsRequest, options?: RequestOptions): Promise<operations.ChannelEndpointsControllerListChannelEndpointsResponse>;
12
12
  /**
13
- * Create channel endpoint for a resource
13
+ * Create a channel endpoint
14
14
  *
15
15
  * @remarks
16
16
  * Create a new channel endpoint for a resource.
17
17
  */
18
18
  create(requestBody: operations.ChannelEndpointsControllerCreateChannelEndpointRequestBody, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.ChannelEndpointsControllerCreateChannelEndpointResponse>;
19
19
  /**
20
- * Retrieve channel endpoint by identifier
20
+ * Retrieve a channel endpoint
21
21
  *
22
22
  * @remarks
23
23
  * Retrieve a specific channel endpoint by its unique identifier.
24
24
  */
25
25
  retrieve(identifier: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.ChannelEndpointsControllerGetChannelEndpointResponse>;
26
26
  /**
27
- * Update channel endpoint
27
+ * Update a channel endpoint
28
28
  *
29
29
  * @remarks
30
30
  * Update an existing channel endpoint by its unique identifier.
31
31
  */
32
32
  update(updateChannelEndpointRequestDto: components.UpdateChannelEndpointRequestDto, identifier: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.ChannelEndpointsControllerUpdateChannelEndpointResponse>;
33
33
  /**
34
- * Delete channel endpoint by identifier
34
+ * Delete a channel endpoint
35
35
  *
36
36
  * @remarks
37
37
  * Delete a specific channel endpoint by its unique identifier.
@@ -13,16 +13,16 @@ const sdks_js_1 = require("../lib/sdks.js");
13
13
  const fp_js_1 = require("../types/fp.js");
14
14
  class ChannelEndpoints extends sdks_js_1.ClientSDK {
15
15
  /**
16
- * List channel endpoints
16
+ * List all channel endpoints
17
17
  *
18
18
  * @remarks
19
- * Retrieve all channel endpoints for a resource based on query filters.
19
+ * List all channel endpoints for a resource based on query filters.
20
20
  */
21
21
  async list(request, options) {
22
22
  return (0, fp_js_1.unwrapAsync)((0, channelEndpointsList_js_1.channelEndpointsList)(this, request, options));
23
23
  }
24
24
  /**
25
- * Create channel endpoint for a resource
25
+ * Create a channel endpoint
26
26
  *
27
27
  * @remarks
28
28
  * Create a new channel endpoint for a resource.
@@ -31,7 +31,7 @@ class ChannelEndpoints extends sdks_js_1.ClientSDK {
31
31
  return (0, fp_js_1.unwrapAsync)((0, channelEndpointsCreate_js_1.channelEndpointsCreate)(this, requestBody, idempotencyKey, options));
32
32
  }
33
33
  /**
34
- * Retrieve channel endpoint by identifier
34
+ * Retrieve a channel endpoint
35
35
  *
36
36
  * @remarks
37
37
  * Retrieve a specific channel endpoint by its unique identifier.
@@ -40,7 +40,7 @@ class ChannelEndpoints extends sdks_js_1.ClientSDK {
40
40
  return (0, fp_js_1.unwrapAsync)((0, channelEndpointsRetrieve_js_1.channelEndpointsRetrieve)(this, identifier, idempotencyKey, options));
41
41
  }
42
42
  /**
43
- * Update channel endpoint
43
+ * Update a channel endpoint
44
44
  *
45
45
  * @remarks
46
46
  * Update an existing channel endpoint by its unique identifier.
@@ -49,7 +49,7 @@ class ChannelEndpoints extends sdks_js_1.ClientSDK {
49
49
  return (0, fp_js_1.unwrapAsync)((0, channelEndpointsUpdate_js_1.channelEndpointsUpdate)(this, updateChannelEndpointRequestDto, identifier, idempotencyKey, options));
50
50
  }
51
51
  /**
52
- * Delete channel endpoint by identifier
52
+ * Delete a channel endpoint
53
53
  *
54
54
  * @remarks
55
55
  * Delete a specific channel endpoint by its unique identifier.
@@ -9,7 +9,7 @@ export declare class Preferences extends ClientSDK {
9
9
  * Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
10
10
  * This API returns all five channels preferences for all workflows and global preferences.
11
11
  */
12
- list(subscriberId: string, criticality?: operations.Criticality | undefined, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse>;
12
+ list(request: operations.SubscribersControllerGetSubscriberPreferencesRequest, options?: RequestOptions): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse>;
13
13
  /**
14
14
  * Update subscriber preferences
15
15
  *
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;;OAMG;IACG,IAAI,CACR,YAAY,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,GAAG,SAAS,EAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qDAAqD,CAAC;IAU5E;;;;;;;OAOG;IACG,MAAM,CACV,6BAA6B,EAAE,UAAU,CAAC,6BAA6B,EACvE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;IAUD;;;;;;OAMG;IACG,UAAU,CACd,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,4DAA4D,CACxE;CASF"}
1
+ {"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;;OAMG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,oDAAoD,EACxE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qDAAqD,CAAC;IAQ5E;;;;;;;OAOG;IACG,MAAM,CACV,6BAA6B,EAAE,UAAU,CAAC,6BAA6B,EACvE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;IAUD;;;;;;OAMG;IACG,UAAU,CACd,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,4DAA4D,CACxE;CASF"}
@@ -17,8 +17,8 @@ class Preferences extends sdks_js_1.ClientSDK {
17
17
  * Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
18
18
  * This API returns all five channels preferences for all workflows and global preferences.
19
19
  */
20
- async list(subscriberId, criticality, idempotencyKey, options) {
21
- return (0, fp_js_1.unwrapAsync)((0, subscribersPreferencesList_js_1.subscribersPreferencesList)(this, subscriberId, criticality, idempotencyKey, options));
20
+ async list(request, options) {
21
+ return (0, fp_js_1.unwrapAsync)((0, subscribersPreferencesList_js_1.subscribersPreferencesList)(this, request, options));
22
22
  }
23
23
  /**
24
24
  * Update subscriber preferences
@@ -1 +1 @@
1
- {"version":3,"file":"preferences.js","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,sGAAgG;AAChG,0FAAoF;AACpF,8FAAwF;AACxF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IACxC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,WAAgD,EAChD,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,YAAY,EACZ,WAAW,EACX,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,6BAAuE,EACvE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,6BAA6B,EAC7B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,kCAC+C,EAC/C,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,sEAAgC,EACjD,IAAI,EACJ,kCAAkC,EAClC,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAxED,kCAwEC"}
1
+ {"version":3,"file":"preferences.js","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,sGAAgG;AAChG,0FAAoF;AACpF,8FAAwF;AACxF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IACxC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,OAAwE,EACxE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,6BAAuE,EACvE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,6BAA6B,EAC7B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,kCAC+C,EAC/C,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,sEAAgC,EACjD,IAAI,EACJ,kCAAkC,EAClC,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AApED,kCAoEC"}
package/sdk/sdk.d.ts CHANGED
@@ -46,7 +46,7 @@ export declare class Novu extends ClientSDK {
46
46
  *
47
47
  * @remarks
48
48
  *
49
- * Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
49
+ * Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.
50
50
  * To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.
51
51
  */
52
52
  trigger(triggerEventRequestDto: components.TriggerEventRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.EventsControllerTriggerResponse>;
package/sdk/sdk.js CHANGED
@@ -68,7 +68,7 @@ class Novu extends sdks_js_1.ClientSDK {
68
68
  *
69
69
  * @remarks
70
70
  *
71
- * Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
71
+ * Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.
72
72
  * To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.
73
73
  */
74
74
  async trigger(triggerEventRequestDto, idempotencyKey, options) {
@@ -25,11 +25,18 @@ export declare class Subscriptions extends ClientSDK {
25
25
  * Delete subscriptions for subscriberIds for a topic.
26
26
  */
27
27
  delete(deleteTopicSubscriptionsRequestDto: components.DeleteTopicSubscriptionsRequestDto, topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerDeleteTopicSubscriptionsResponse>;
28
+ /**
29
+ * Get a topic subscription
30
+ *
31
+ * @remarks
32
+ * Get a subscription by its unique identifier for a topic.
33
+ */
34
+ getSubscription(topicKey: string, identifier: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerGetTopicSubscriptionResponse>;
28
35
  /**
29
36
  * Update a topic subscription
30
37
  *
31
38
  * @remarks
32
- * Update a subscription by its unique identifier **subscriptionIdOrIdentifier** for a topic. You can update the preferences and name associated with the subscription.
39
+ * Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription.
33
40
  */
34
41
  update(request: operations.TopicsControllerUpdateTopicSubscriptionRequest, options?: RequestOptions): Promise<operations.TopicsControllerUpdateTopicSubscriptionResponse>;
35
42
  }
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;OAMG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;;OAMG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAUvE;;;;;OAKG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAUvE;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,8CAA8C,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;CAOvE"}
1
+ {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;OAMG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;;OAMG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAUvE;;;;;OAKG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAUvE;;;;;OAKG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4CAA4C,CAAC;IAUnE;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,8CAA8C,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;CAOvE"}
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.Subscriptions = void 0;
7
7
  const topicsSubscriptionsCreate_js_1 = require("../funcs/topicsSubscriptionsCreate.js");
8
8
  const topicsSubscriptionsDelete_js_1 = require("../funcs/topicsSubscriptionsDelete.js");
9
+ const topicsSubscriptionsGetSubscription_js_1 = require("../funcs/topicsSubscriptionsGetSubscription.js");
9
10
  const topicsSubscriptionsList_js_1 = require("../funcs/topicsSubscriptionsList.js");
10
11
  const topicsSubscriptionsUpdate_js_1 = require("../funcs/topicsSubscriptionsUpdate.js");
11
12
  const sdks_js_1 = require("../lib/sdks.js");
@@ -40,11 +41,20 @@ class Subscriptions extends sdks_js_1.ClientSDK {
40
41
  async delete(deleteTopicSubscriptionsRequestDto, topicKey, idempotencyKey, options) {
41
42
  return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsDelete_js_1.topicsSubscriptionsDelete)(this, deleteTopicSubscriptionsRequestDto, topicKey, idempotencyKey, options));
42
43
  }
44
+ /**
45
+ * Get a topic subscription
46
+ *
47
+ * @remarks
48
+ * Get a subscription by its unique identifier for a topic.
49
+ */
50
+ async getSubscription(topicKey, identifier, idempotencyKey, options) {
51
+ return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsGetSubscription_js_1.topicsSubscriptionsGetSubscription)(this, topicKey, identifier, idempotencyKey, options));
52
+ }
43
53
  /**
44
54
  * Update a topic subscription
45
55
  *
46
56
  * @remarks
47
- * Update a subscription by its unique identifier **subscriptionIdOrIdentifier** for a topic. You can update the preferences and name associated with the subscription.
57
+ * Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription.
48
58
  */
49
59
  async update(request, options) {
50
60
  return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsUpdate_js_1.topicsSubscriptionsUpdate)(this, request, options));
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wFAAkF;AAClF,wFAAkF;AAClF,oFAA8E;AAC9E,wFAAkF;AAClF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAkE,EAClE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAhFD,sCAgFC"}
1
+ {"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wFAAkF;AAClF,wFAAkF;AAClF,0GAAoG;AACpG,oFAA8E;AAC9E,wFAAkF;AAClF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,QAAgB,EAChB,UAAkB,EAClB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAkC,EACnD,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAkE,EAClE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AArGD,sCAqGC"}