@novu/api 0.6.2 → 0.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 (253) hide show
  1. package/FUNCTIONS.md +12 -3
  2. package/README.md +143 -30
  3. package/bin/mcp-server.js +644 -433
  4. package/bin/mcp-server.js.map +53 -48
  5. package/docs/sdks/novu/README.md +142 -24
  6. package/jsr.json +1 -1
  7. package/lib/config.d.ts +4 -4
  8. package/lib/config.js +4 -4
  9. package/lib/config.js.map +1 -1
  10. package/lib/matchers.d.ts +3 -1
  11. package/lib/matchers.d.ts.map +1 -1
  12. package/lib/matchers.js +13 -1
  13. package/lib/matchers.js.map +1 -1
  14. package/lib/sdks.d.ts +3 -1
  15. package/lib/sdks.d.ts.map +1 -1
  16. package/lib/sdks.js +13 -13
  17. package/lib/sdks.js.map +1 -1
  18. package/mcp-server/mcp-server.js +1 -1
  19. package/mcp-server/prompts.d.ts.map +1 -1
  20. package/mcp-server/prompts.js +5 -1
  21. package/mcp-server/prompts.js.map +1 -1
  22. package/mcp-server/resources.d.ts.map +1 -1
  23. package/mcp-server/resources.js +10 -2
  24. package/mcp-server/resources.js.map +1 -1
  25. package/mcp-server/server.d.ts.map +1 -1
  26. package/mcp-server/server.js +2 -3
  27. package/mcp-server/server.js.map +1 -1
  28. package/mcp-server/tools.d.ts.map +1 -1
  29. package/mcp-server/tools.js +4 -3
  30. package/mcp-server/tools.js.map +1 -1
  31. package/models/components/activitynotificationjobresponsedto.d.ts +15 -15
  32. package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
  33. package/models/components/activitynotificationjobresponsedto.js +19 -18
  34. package/models/components/activitynotificationjobresponsedto.js.map +1 -1
  35. package/models/components/activitynotificationstepresponsedto.d.ts +15 -15
  36. package/models/components/activitynotificationstepresponsedto.d.ts.map +1 -1
  37. package/models/components/activitynotificationstepresponsedto.js +18 -18
  38. package/models/components/activitynotificationstepresponsedto.js.map +1 -1
  39. package/models/components/channelsettingsdto.d.ts +2 -78
  40. package/models/components/channelsettingsdto.d.ts.map +1 -1
  41. package/models/components/channelsettingsdto.js +4 -41
  42. package/models/components/channelsettingsdto.js.map +1 -1
  43. package/models/components/chatorpushproviderenum.d.ts +79 -0
  44. package/models/components/chatorpushproviderenum.d.ts.map +1 -0
  45. package/models/components/chatorpushproviderenum.js +68 -0
  46. package/models/components/chatorpushproviderenum.js.map +1 -0
  47. package/models/components/constraintvalidation.d.ts +115 -0
  48. package/models/components/constraintvalidation.d.ts.map +1 -0
  49. package/models/components/constraintvalidation.js +157 -0
  50. package/models/components/constraintvalidation.js.map +1 -0
  51. package/models/components/digestmetadatadto.d.ts +8 -8
  52. package/models/components/digestmetadatadto.d.ts.map +1 -1
  53. package/models/components/digestmetadatadto.js +13 -13
  54. package/models/components/digestmetadatadto.js.map +1 -1
  55. package/models/components/digestregularmetadata.d.ts +16 -16
  56. package/models/components/digestregularmetadata.d.ts.map +1 -1
  57. package/models/components/digestregularmetadata.js +25 -25
  58. package/models/components/digestregularmetadata.js.map +1 -1
  59. package/models/components/digesttimedconfigdto.d.ts +8 -8
  60. package/models/components/digesttimedconfigdto.d.ts.map +1 -1
  61. package/models/components/digesttimedconfigdto.js +13 -14
  62. package/models/components/digesttimedconfigdto.js.map +1 -1
  63. package/models/components/getsubscriberpreferencesdto.d.ts +6 -6
  64. package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -1
  65. package/models/components/getsubscriberpreferencesdto.js +6 -6
  66. package/models/components/getsubscriberpreferencesdto.js.map +1 -1
  67. package/models/components/index.d.ts +10 -5
  68. package/models/components/index.d.ts.map +1 -1
  69. package/models/components/index.js +10 -5
  70. package/models/components/index.js.map +1 -1
  71. package/models/components/integrationresponsedto.d.ts +8 -8
  72. package/models/components/integrationresponsedto.d.ts.map +1 -1
  73. package/models/components/integrationresponsedto.js +14 -13
  74. package/models/components/integrationresponsedto.js.map +1 -1
  75. package/models/components/messageactionresult.d.ts +15 -15
  76. package/models/components/messageactionresult.d.ts.map +1 -1
  77. package/models/components/messageactionresult.js +18 -18
  78. package/models/components/messageactionresult.js.map +1 -1
  79. package/models/components/messagecta.d.ts +2 -2
  80. package/models/components/messagecta.d.ts.map +1 -1
  81. package/models/components/messagecta.js +2 -2
  82. package/models/components/messagecta.js.map +1 -1
  83. package/models/components/messageresponsedto.d.ts +14 -4
  84. package/models/components/messageresponsedto.d.ts.map +1 -1
  85. package/models/components/messageresponsedto.js +8 -4
  86. package/models/components/messageresponsedto.js.map +1 -1
  87. package/models/components/messagesresponsedto.d.ts +53 -0
  88. package/models/components/messagesresponsedto.d.ts.map +1 -0
  89. package/models/components/messagesresponsedto.js +68 -0
  90. package/models/components/messagesresponsedto.js.map +1 -0
  91. package/models/components/notificationfeeditemdto.d.ts +0 -5
  92. package/models/components/notificationfeeditemdto.d.ts.map +1 -1
  93. package/models/components/notificationfeeditemdto.js +0 -2
  94. package/models/components/notificationfeeditemdto.js.map +1 -1
  95. package/models/components/notificationstepdto.d.ts +13 -13
  96. package/models/components/notificationstepdto.d.ts.map +1 -1
  97. package/models/components/notificationstepdto.js +16 -16
  98. package/models/components/notificationstepdto.js.map +1 -1
  99. package/models/components/notificationtriggerdto.d.ts +8 -8
  100. package/models/components/notificationtriggerdto.d.ts.map +1 -1
  101. package/models/components/notificationtriggerdto.js +13 -13
  102. package/models/components/notificationtriggerdto.js.map +1 -1
  103. package/models/components/patchsubscriberpreferencesdto.d.ts +1 -1
  104. package/models/components/preferenceoverridesourceenum.d.ts +37 -0
  105. package/models/components/preferenceoverridesourceenum.d.ts.map +1 -0
  106. package/models/components/preferenceoverridesourceenum.js +54 -0
  107. package/models/components/preferenceoverridesourceenum.js.map +1 -0
  108. package/models/components/providersidenum.d.ts +3 -0
  109. package/models/components/providersidenum.d.ts.map +1 -1
  110. package/models/components/providersidenum.js +1 -0
  111. package/models/components/providersidenum.js.map +1 -1
  112. package/models/components/stepfilterdto.d.ts +8 -8
  113. package/models/components/stepfilterdto.d.ts.map +1 -1
  114. package/models/components/stepfilterdto.js +13 -13
  115. package/models/components/stepfilterdto.js.map +1 -1
  116. package/models/components/stepsoverrides.d.ts +40 -0
  117. package/models/components/stepsoverrides.d.ts.map +1 -0
  118. package/models/components/{workflowinfodto.js → stepsoverrides.js} +19 -25
  119. package/models/components/stepsoverrides.js.map +1 -0
  120. package/models/components/steptypeenum.d.ts +2 -2
  121. package/models/components/steptypeenum.js +1 -1
  122. package/models/components/subscriberchanneldto.d.ts +8 -8
  123. package/models/components/subscriberchanneldto.d.ts.map +1 -1
  124. package/models/components/subscriberchanneldto.js +14 -13
  125. package/models/components/subscriberchanneldto.js.map +1 -1
  126. package/models/components/subscriberglobalpreferencedto.d.ts +38 -0
  127. package/models/components/subscriberglobalpreferencedto.d.ts.map +1 -0
  128. package/models/components/subscriberglobalpreferencedto.js +62 -0
  129. package/models/components/subscriberglobalpreferencedto.js.map +1 -0
  130. package/models/components/subscriberpreferencechannels.d.ts +52 -0
  131. package/models/components/subscriberpreferencechannels.d.ts.map +1 -0
  132. package/models/components/{preferencechannels.js → subscriberpreferencechannels.js} +17 -17
  133. package/models/components/subscriberpreferencechannels.js.map +1 -0
  134. package/models/components/subscriberpreferenceoverridedto.d.ts +39 -0
  135. package/models/components/subscriberpreferenceoverridedto.d.ts.map +1 -0
  136. package/models/components/subscriberpreferenceoverridedto.js +63 -0
  137. package/models/components/subscriberpreferenceoverridedto.js.map +1 -0
  138. package/models/components/subscriberpreferencesworkflowinfodto.d.ts +47 -0
  139. package/models/components/subscriberpreferencesworkflowinfodto.d.ts.map +1 -0
  140. package/models/components/subscriberpreferencesworkflowinfodto.js +65 -0
  141. package/models/components/subscriberpreferencesworkflowinfodto.js.map +1 -0
  142. package/models/components/subscriberresponsedto.d.ts +26 -26
  143. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  144. package/models/components/subscriberresponsedto.js +12 -12
  145. package/models/components/subscriberresponsedto.js.map +1 -1
  146. package/models/components/subscriberworkflowpreferencedto.d.ts +50 -0
  147. package/models/components/subscriberworkflowpreferencedto.d.ts.map +1 -0
  148. package/models/components/subscriberworkflowpreferencedto.js +68 -0
  149. package/models/components/subscriberworkflowpreferencedto.js.map +1 -0
  150. package/models/components/timedconfig.d.ts +8 -8
  151. package/models/components/timedconfig.d.ts.map +1 -1
  152. package/models/components/timedconfig.js +14 -13
  153. package/models/components/timedconfig.js.map +1 -1
  154. package/models/components/triggereventrequestdto.d.ts +102 -10
  155. package/models/components/triggereventrequestdto.d.ts.map +1 -1
  156. package/models/components/triggereventrequestdto.js +43 -3
  157. package/models/components/triggereventrequestdto.js.map +1 -1
  158. package/models/components/triggereventtoallrequestdto.d.ts +84 -2
  159. package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
  160. package/models/components/triggereventtoallrequestdto.js +28 -2
  161. package/models/components/triggereventtoallrequestdto.js.map +1 -1
  162. package/models/components/updatesubscriberchannelrequestdto.d.ts +2 -78
  163. package/models/components/updatesubscriberchannelrequestdto.d.ts.map +1 -1
  164. package/models/components/updatesubscriberchannelrequestdto.js +4 -41
  165. package/models/components/updatesubscriberchannelrequestdto.js.map +1 -1
  166. package/models/components/workflowresponse.d.ts +3 -3
  167. package/models/components/workflowresponse.d.ts.map +1 -1
  168. package/models/components/workflowresponse.js +3 -3
  169. package/models/components/workflowresponse.js.map +1 -1
  170. package/models/errors/errordto.d.ts +83 -3
  171. package/models/errors/errordto.d.ts.map +1 -1
  172. package/models/errors/errordto.js +99 -3
  173. package/models/errors/errordto.js.map +1 -1
  174. package/models/errors/validationerrordto.d.ts +66 -51
  175. package/models/errors/validationerrordto.d.ts.map +1 -1
  176. package/models/errors/validationerrordto.js +83 -67
  177. package/models/errors/validationerrordto.js.map +1 -1
  178. package/models/operations/messagescontrollergetmessages.d.ts +2 -2
  179. package/models/operations/messagescontrollergetmessages.d.ts.map +1 -1
  180. package/models/operations/messagescontrollergetmessages.js +2 -2
  181. package/models/operations/messagescontrollergetmessages.js.map +1 -1
  182. package/package.json +3 -3
  183. package/sources/json-development.json +2037 -305
  184. package/src/lib/config.ts +4 -4
  185. package/src/lib/matchers.ts +20 -0
  186. package/src/lib/sdks.ts +19 -13
  187. package/src/mcp-server/mcp-server.ts +1 -1
  188. package/src/mcp-server/prompts.ts +8 -1
  189. package/src/mcp-server/resources.ts +16 -2
  190. package/src/mcp-server/server.ts +3 -3
  191. package/src/mcp-server/tools.ts +6 -3
  192. package/src/models/components/activitynotificationjobresponsedto.ts +48 -26
  193. package/src/models/components/activitynotificationstepresponsedto.ts +50 -29
  194. package/src/models/components/channelsettingsdto.ts +8 -50
  195. package/src/models/components/chatorpushproviderenum.ts +54 -0
  196. package/src/models/components/constraintvalidation.ts +270 -0
  197. package/src/models/components/digestmetadatadto.ts +16 -15
  198. package/src/models/components/digestregularmetadata.ts +30 -36
  199. package/src/models/components/digesttimedconfigdto.ts +18 -14
  200. package/src/models/components/getsubscriberpreferencesdto.ts +18 -18
  201. package/src/models/components/index.ts +10 -5
  202. package/src/models/components/integrationresponsedto.ts +14 -18
  203. package/src/models/components/messageactionresult.ts +24 -31
  204. package/src/models/components/messagecta.ts +4 -4
  205. package/src/models/components/messageresponsedto.ts +22 -8
  206. package/src/models/components/messagesresponsedto.ts +103 -0
  207. package/src/models/components/notificationfeeditemdto.ts +0 -7
  208. package/src/models/components/notificationstepdto.ts +20 -26
  209. package/src/models/components/notificationtriggerdto.ts +18 -15
  210. package/src/models/components/patchsubscriberpreferencesdto.ts +1 -1
  211. package/src/models/components/preferenceoverridesourceenum.ts +42 -0
  212. package/src/models/components/providersidenum.ts +1 -0
  213. package/src/models/components/stepfilterdto.ts +16 -15
  214. package/src/models/components/stepsoverrides.ts +65 -0
  215. package/src/models/components/steptypeenum.ts +2 -2
  216. package/src/models/components/subscriberchanneldto.ts +14 -18
  217. package/src/models/components/subscriberglobalpreferencedto.ts +84 -0
  218. package/src/models/components/subscriberpreferencechannels.ts +108 -0
  219. package/src/models/components/subscriberpreferenceoverridedto.ts +88 -0
  220. package/src/models/components/subscriberpreferencesworkflowinfodto.ts +95 -0
  221. package/src/models/components/subscriberresponsedto.ts +34 -34
  222. package/src/models/components/subscriberworkflowpreferencedto.ts +110 -0
  223. package/src/models/components/timedconfig.ts +14 -16
  224. package/src/models/components/triggereventrequestdto.ts +122 -4
  225. package/src/models/components/triggereventtoallrequestdto.ts +92 -5
  226. package/src/models/components/updatesubscriberchannelrequestdto.ts +8 -56
  227. package/src/models/components/workflowresponse.ts +9 -9
  228. package/src/models/errors/errordto.ts +202 -5
  229. package/src/models/errors/validationerrordto.ts +178 -110
  230. package/src/models/operations/messagescontrollergetmessages.ts +4 -4
  231. package/models/components/globalpreferencedto.d.ts +0 -38
  232. package/models/components/globalpreferencedto.d.ts.map +0 -1
  233. package/models/components/globalpreferencedto.js +0 -62
  234. package/models/components/globalpreferencedto.js.map +0 -1
  235. package/models/components/overrides.d.ts +0 -112
  236. package/models/components/overrides.d.ts.map +0 -1
  237. package/models/components/overrides.js +0 -111
  238. package/models/components/overrides.js.map +0 -1
  239. package/models/components/preferencechannels.d.ts +0 -37
  240. package/models/components/preferencechannels.d.ts.map +0 -1
  241. package/models/components/preferencechannels.js.map +0 -1
  242. package/models/components/workflowinfodto.d.ts +0 -47
  243. package/models/components/workflowinfodto.d.ts.map +0 -1
  244. package/models/components/workflowinfodto.js.map +0 -1
  245. package/models/components/workflowpreferencedto.d.ts +0 -50
  246. package/models/components/workflowpreferencedto.d.ts.map +0 -1
  247. package/models/components/workflowpreferencedto.js +0 -68
  248. package/models/components/workflowpreferencedto.js.map +0 -1
  249. package/src/models/components/globalpreferencedto.ts +0 -82
  250. package/src/models/components/overrides.ts +0 -139
  251. package/src/models/components/preferencechannels.ts +0 -91
  252. package/src/models/components/workflowinfodto.ts +0 -88
  253. package/src/models/components/workflowpreferencedto.ts +0 -108
@@ -30,7 +30,7 @@ export type SubscriberResponseDto = {
30
30
  /**
31
31
  * The email address of the subscriber.
32
32
  */
33
- email?: string | null | undefined;
33
+ email?: string | undefined;
34
34
  /**
35
35
  * The phone number of the subscriber.
36
36
  */
@@ -43,10 +43,6 @@ export type SubscriberResponseDto = {
43
43
  * The locale setting of the subscriber, indicating their preferred language or region.
44
44
  */
45
45
  locale?: string | undefined;
46
- /**
47
- * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
48
- */
49
- subscriberId: string;
50
46
  /**
51
47
  * An array of channel settings associated with the subscriber.
52
48
  */
@@ -65,6 +61,22 @@ export type SubscriberResponseDto = {
65
61
  * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
66
62
  */
67
63
  lastOnlineAt?: string | undefined;
64
+ /**
65
+ * The version of the subscriber document.
66
+ */
67
+ v?: number | undefined;
68
+ /**
69
+ * Additional custom data for the subscriber
70
+ */
71
+ data?: { [k: string]: any } | null | undefined;
72
+ /**
73
+ * Timezone of the subscriber
74
+ */
75
+ timezone?: string | undefined;
76
+ /**
77
+ * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
78
+ */
79
+ subscriberId: string;
68
80
  /**
69
81
  * The unique identifier of the organization to which the subscriber belongs.
70
82
  */
@@ -85,18 +97,6 @@ export type SubscriberResponseDto = {
85
97
  * The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
86
98
  */
87
99
  updatedAt: string;
88
- /**
89
- * The version of the subscriber document.
90
- */
91
- v?: number | undefined;
92
- /**
93
- * Additional custom data for the subscriber
94
- */
95
- data?: { [k: string]: any } | null | undefined;
96
- /**
97
- * Timezone of the subscriber
98
- */
99
- timezone?: string | undefined;
100
100
  };
101
101
 
102
102
  /** @internal */
@@ -108,29 +108,29 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
108
108
  _id: z.string().optional(),
109
109
  firstName: z.string().optional(),
110
110
  lastName: z.string().optional(),
111
- email: z.nullable(z.string()).optional(),
111
+ email: z.string().optional(),
112
112
  phone: z.string().optional(),
113
113
  avatar: z.string().optional(),
114
114
  locale: z.string().optional(),
115
- subscriberId: z.string(),
116
115
  channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
117
116
  topics: z.array(z.string()).optional(),
118
117
  isOnline: z.boolean().optional(),
119
118
  lastOnlineAt: z.string().optional(),
119
+ __v: z.number().optional(),
120
+ data: z.nullable(z.record(z.any())).optional(),
121
+ timezone: z.string().optional(),
122
+ subscriberId: z.string(),
120
123
  _organizationId: z.string(),
121
124
  _environmentId: z.string(),
122
125
  deleted: z.boolean(),
123
126
  createdAt: z.string(),
124
127
  updatedAt: z.string(),
125
- __v: z.number().optional(),
126
- data: z.nullable(z.record(z.any())).optional(),
127
- timezone: z.string().optional(),
128
128
  }).transform((v) => {
129
129
  return remap$(v, {
130
130
  "_id": "id",
131
+ "__v": "v",
131
132
  "_organizationId": "organizationId",
132
133
  "_environmentId": "environmentId",
133
- "__v": "v",
134
134
  });
135
135
  });
136
136
 
@@ -139,23 +139,23 @@ export type SubscriberResponseDto$Outbound = {
139
139
  _id?: string | undefined;
140
140
  firstName?: string | undefined;
141
141
  lastName?: string | undefined;
142
- email?: string | null | undefined;
142
+ email?: string | undefined;
143
143
  phone?: string | undefined;
144
144
  avatar?: string | undefined;
145
145
  locale?: string | undefined;
146
- subscriberId: string;
147
146
  channels?: Array<ChannelSettingsDto$Outbound> | undefined;
148
147
  topics?: Array<string> | undefined;
149
148
  isOnline?: boolean | undefined;
150
149
  lastOnlineAt?: string | undefined;
150
+ __v?: number | undefined;
151
+ data?: { [k: string]: any } | null | undefined;
152
+ timezone?: string | undefined;
153
+ subscriberId: string;
151
154
  _organizationId: string;
152
155
  _environmentId: string;
153
156
  deleted: boolean;
154
157
  createdAt: string;
155
158
  updatedAt: string;
156
- __v?: number | undefined;
157
- data?: { [k: string]: any } | null | undefined;
158
- timezone?: string | undefined;
159
159
  };
160
160
 
161
161
  /** @internal */
@@ -167,29 +167,29 @@ export const SubscriberResponseDto$outboundSchema: z.ZodType<
167
167
  id: z.string().optional(),
168
168
  firstName: z.string().optional(),
169
169
  lastName: z.string().optional(),
170
- email: z.nullable(z.string()).optional(),
170
+ email: z.string().optional(),
171
171
  phone: z.string().optional(),
172
172
  avatar: z.string().optional(),
173
173
  locale: z.string().optional(),
174
- subscriberId: z.string(),
175
174
  channels: z.array(ChannelSettingsDto$outboundSchema).optional(),
176
175
  topics: z.array(z.string()).optional(),
177
176
  isOnline: z.boolean().optional(),
178
177
  lastOnlineAt: z.string().optional(),
178
+ v: z.number().optional(),
179
+ data: z.nullable(z.record(z.any())).optional(),
180
+ timezone: z.string().optional(),
181
+ subscriberId: z.string(),
179
182
  organizationId: z.string(),
180
183
  environmentId: z.string(),
181
184
  deleted: z.boolean(),
182
185
  createdAt: z.string(),
183
186
  updatedAt: z.string(),
184
- v: z.number().optional(),
185
- data: z.nullable(z.record(z.any())).optional(),
186
- timezone: z.string().optional(),
187
187
  }).transform((v) => {
188
188
  return remap$(v, {
189
189
  id: "_id",
190
+ v: "__v",
190
191
  organizationId: "_organizationId",
191
192
  environmentId: "_environmentId",
192
- v: "__v",
193
193
  });
194
194
  });
195
195
 
@@ -0,0 +1,110 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import {
10
+ SubscriberPreferenceChannels,
11
+ SubscriberPreferenceChannels$inboundSchema,
12
+ SubscriberPreferenceChannels$Outbound,
13
+ SubscriberPreferenceChannels$outboundSchema,
14
+ } from "./subscriberpreferencechannels.js";
15
+ import {
16
+ SubscriberPreferenceOverrideDto,
17
+ SubscriberPreferenceOverrideDto$inboundSchema,
18
+ SubscriberPreferenceOverrideDto$Outbound,
19
+ SubscriberPreferenceOverrideDto$outboundSchema,
20
+ } from "./subscriberpreferenceoverridedto.js";
21
+ import {
22
+ SubscriberPreferencesWorkflowInfoDto,
23
+ SubscriberPreferencesWorkflowInfoDto$inboundSchema,
24
+ SubscriberPreferencesWorkflowInfoDto$Outbound,
25
+ SubscriberPreferencesWorkflowInfoDto$outboundSchema,
26
+ } from "./subscriberpreferencesworkflowinfodto.js";
27
+
28
+ export type SubscriberWorkflowPreferenceDto = {
29
+ /**
30
+ * Whether notifications are enabled for this workflow
31
+ */
32
+ enabled: boolean;
33
+ /**
34
+ * Channel-specific preference settings for this workflow
35
+ */
36
+ channels: SubscriberPreferenceChannels;
37
+ /**
38
+ * List of preference overrides
39
+ */
40
+ overrides: Array<SubscriberPreferenceOverrideDto>;
41
+ /**
42
+ * Workflow information
43
+ */
44
+ workflow: SubscriberPreferencesWorkflowInfoDto;
45
+ };
46
+
47
+ /** @internal */
48
+ export const SubscriberWorkflowPreferenceDto$inboundSchema: z.ZodType<
49
+ SubscriberWorkflowPreferenceDto,
50
+ z.ZodTypeDef,
51
+ unknown
52
+ > = z.object({
53
+ enabled: z.boolean(),
54
+ channels: SubscriberPreferenceChannels$inboundSchema,
55
+ overrides: z.array(SubscriberPreferenceOverrideDto$inboundSchema),
56
+ workflow: SubscriberPreferencesWorkflowInfoDto$inboundSchema,
57
+ });
58
+
59
+ /** @internal */
60
+ export type SubscriberWorkflowPreferenceDto$Outbound = {
61
+ enabled: boolean;
62
+ channels: SubscriberPreferenceChannels$Outbound;
63
+ overrides: Array<SubscriberPreferenceOverrideDto$Outbound>;
64
+ workflow: SubscriberPreferencesWorkflowInfoDto$Outbound;
65
+ };
66
+
67
+ /** @internal */
68
+ export const SubscriberWorkflowPreferenceDto$outboundSchema: z.ZodType<
69
+ SubscriberWorkflowPreferenceDto$Outbound,
70
+ z.ZodTypeDef,
71
+ SubscriberWorkflowPreferenceDto
72
+ > = z.object({
73
+ enabled: z.boolean(),
74
+ channels: SubscriberPreferenceChannels$outboundSchema,
75
+ overrides: z.array(SubscriberPreferenceOverrideDto$outboundSchema),
76
+ workflow: SubscriberPreferencesWorkflowInfoDto$outboundSchema,
77
+ });
78
+
79
+ /**
80
+ * @internal
81
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
82
+ */
83
+ export namespace SubscriberWorkflowPreferenceDto$ {
84
+ /** @deprecated use `SubscriberWorkflowPreferenceDto$inboundSchema` instead. */
85
+ export const inboundSchema = SubscriberWorkflowPreferenceDto$inboundSchema;
86
+ /** @deprecated use `SubscriberWorkflowPreferenceDto$outboundSchema` instead. */
87
+ export const outboundSchema = SubscriberWorkflowPreferenceDto$outboundSchema;
88
+ /** @deprecated use `SubscriberWorkflowPreferenceDto$Outbound` instead. */
89
+ export type Outbound = SubscriberWorkflowPreferenceDto$Outbound;
90
+ }
91
+
92
+ export function subscriberWorkflowPreferenceDtoToJSON(
93
+ subscriberWorkflowPreferenceDto: SubscriberWorkflowPreferenceDto,
94
+ ): string {
95
+ return JSON.stringify(
96
+ SubscriberWorkflowPreferenceDto$outboundSchema.parse(
97
+ subscriberWorkflowPreferenceDto,
98
+ ),
99
+ );
100
+ }
101
+
102
+ export function subscriberWorkflowPreferenceDtoFromJSON(
103
+ jsonString: string,
104
+ ): SafeParseResult<SubscriberWorkflowPreferenceDto, SDKValidationError> {
105
+ return safeParse(
106
+ jsonString,
107
+ (x) => SubscriberWorkflowPreferenceDto$inboundSchema.parse(JSON.parse(x)),
108
+ `Failed to parse 'SubscriberWorkflowPreferenceDto' from JSON`,
109
+ );
110
+ }
@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
- export const TimedConfigWeekDays = {
11
+ export const WeekDays = {
12
12
  Monday: "monday",
13
13
  Tuesday: "tuesday",
14
14
  Wednesday: "wednesday",
@@ -17,7 +17,7 @@ export const TimedConfigWeekDays = {
17
17
  Saturday: "saturday",
18
18
  Sunday: "sunday",
19
19
  } as const;
20
- export type TimedConfigWeekDays = ClosedEnum<typeof TimedConfigWeekDays>;
20
+ export type WeekDays = ClosedEnum<typeof WeekDays>;
21
21
 
22
22
  export const Ordinal = {
23
23
  One: "1",
@@ -51,7 +51,7 @@ export type MonthlyType = ClosedEnum<typeof MonthlyType>;
51
51
 
52
52
  export type TimedConfig = {
53
53
  atTime?: string | undefined;
54
- weekDays?: Array<TimedConfigWeekDays> | undefined;
54
+ weekDays?: Array<WeekDays> | undefined;
55
55
  monthDays?: Array<string> | undefined;
56
56
  ordinal?: Ordinal | undefined;
57
57
  ordinalValue?: OrdinalValue | undefined;
@@ -59,24 +59,22 @@ export type TimedConfig = {
59
59
  };
60
60
 
61
61
  /** @internal */
62
- export const TimedConfigWeekDays$inboundSchema: z.ZodNativeEnum<
63
- typeof TimedConfigWeekDays
64
- > = z.nativeEnum(TimedConfigWeekDays);
62
+ export const WeekDays$inboundSchema: z.ZodNativeEnum<typeof WeekDays> = z
63
+ .nativeEnum(WeekDays);
65
64
 
66
65
  /** @internal */
67
- export const TimedConfigWeekDays$outboundSchema: z.ZodNativeEnum<
68
- typeof TimedConfigWeekDays
69
- > = TimedConfigWeekDays$inboundSchema;
66
+ export const WeekDays$outboundSchema: z.ZodNativeEnum<typeof WeekDays> =
67
+ WeekDays$inboundSchema;
70
68
 
71
69
  /**
72
70
  * @internal
73
71
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
74
72
  */
75
- export namespace TimedConfigWeekDays$ {
76
- /** @deprecated use `TimedConfigWeekDays$inboundSchema` instead. */
77
- export const inboundSchema = TimedConfigWeekDays$inboundSchema;
78
- /** @deprecated use `TimedConfigWeekDays$outboundSchema` instead. */
79
- export const outboundSchema = TimedConfigWeekDays$outboundSchema;
73
+ export namespace WeekDays$ {
74
+ /** @deprecated use `WeekDays$inboundSchema` instead. */
75
+ export const inboundSchema = WeekDays$inboundSchema;
76
+ /** @deprecated use `WeekDays$outboundSchema` instead. */
77
+ export const outboundSchema = WeekDays$outboundSchema;
80
78
  }
81
79
 
82
80
  /** @internal */
@@ -143,7 +141,7 @@ export const TimedConfig$inboundSchema: z.ZodType<
143
141
  unknown
144
142
  > = z.object({
145
143
  atTime: z.string().optional(),
146
- weekDays: z.array(TimedConfigWeekDays$inboundSchema).optional(),
144
+ weekDays: z.array(WeekDays$inboundSchema).optional(),
147
145
  monthDays: z.array(z.string()).optional(),
148
146
  ordinal: Ordinal$inboundSchema.optional(),
149
147
  ordinalValue: OrdinalValue$inboundSchema.optional(),
@@ -167,7 +165,7 @@ export const TimedConfig$outboundSchema: z.ZodType<
167
165
  TimedConfig
168
166
  > = z.object({
169
167
  atTime: z.string().optional(),
170
- weekDays: z.array(TimedConfigWeekDays$outboundSchema).optional(),
168
+ weekDays: z.array(WeekDays$outboundSchema).optional(),
171
169
  monthDays: z.array(z.string()).optional(),
172
170
  ordinal: Ordinal$outboundSchema.optional(),
173
171
  ordinalValue: OrdinalValue$outboundSchema.optional(),
@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+ import {
11
+ StepsOverrides,
12
+ StepsOverrides$inboundSchema,
13
+ StepsOverrides$Outbound,
14
+ StepsOverrides$outboundSchema,
15
+ } from "./stepsoverrides.js";
10
16
  import {
11
17
  SubscriberPayloadDto,
12
18
  SubscriberPayloadDto$inboundSchema,
@@ -26,6 +32,50 @@ import {
26
32
  TopicPayloadDto$outboundSchema,
27
33
  } from "./topicpayloaddto.js";
28
34
 
35
+ /**
36
+ * This could be used to override provider specific configurations
37
+ */
38
+ export type Overrides = {
39
+ /**
40
+ * This could be used to override provider specific configurations
41
+ */
42
+ steps?: { [k: string]: StepsOverrides } | undefined;
43
+ /**
44
+ * Overrides the provider configuration for the entire workflow and all steps
45
+ */
46
+ providers?: { [k: string]: { [k: string]: any } } | undefined;
47
+ /**
48
+ * Override the email provider specific configurations for the entire workflow
49
+ *
50
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
51
+ */
52
+ email?: { [k: string]: any } | undefined;
53
+ /**
54
+ * Override the push provider specific configurations for the entire workflow
55
+ *
56
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
57
+ */
58
+ push?: { [k: string]: any } | undefined;
59
+ /**
60
+ * Override the sms provider specific configurations for the entire workflow
61
+ *
62
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
63
+ */
64
+ sms?: { [k: string]: any } | undefined;
65
+ /**
66
+ * Override the chat provider specific configurations for the entire workflow
67
+ *
68
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
69
+ */
70
+ chat?: { [k: string]: any } | undefined;
71
+ /**
72
+ * Override the layout identifier for the entire workflow
73
+ *
74
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
75
+ */
76
+ layoutIdentifier?: string | undefined;
77
+ };
78
+
29
79
  export type One = TopicPayloadDto | SubscriberPayloadDto | string;
30
80
 
31
81
  /**
@@ -69,7 +119,7 @@ export type TriggerEventRequestDto = {
69
119
  /**
70
120
  * This could be used to override provider specific configurations
71
121
  */
72
- overrides?: { [k: string]: { [k: string]: any } } | undefined;
122
+ overrides?: Overrides | undefined;
73
123
  /**
74
124
  * The recipients list of people who will receive the notification.
75
125
  */
@@ -98,6 +148,74 @@ export type TriggerEventRequestDto = {
98
148
  tenant?: TenantPayloadDto | string | undefined;
99
149
  };
100
150
 
151
+ /** @internal */
152
+ export const Overrides$inboundSchema: z.ZodType<
153
+ Overrides,
154
+ z.ZodTypeDef,
155
+ unknown
156
+ > = z.object({
157
+ steps: z.record(StepsOverrides$inboundSchema).optional(),
158
+ providers: z.record(z.record(z.any())).optional(),
159
+ email: z.record(z.any()).optional(),
160
+ push: z.record(z.any()).optional(),
161
+ sms: z.record(z.any()).optional(),
162
+ chat: z.record(z.any()).optional(),
163
+ layoutIdentifier: z.string().optional(),
164
+ });
165
+
166
+ /** @internal */
167
+ export type Overrides$Outbound = {
168
+ steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
169
+ providers?: { [k: string]: { [k: string]: any } } | undefined;
170
+ email?: { [k: string]: any } | undefined;
171
+ push?: { [k: string]: any } | undefined;
172
+ sms?: { [k: string]: any } | undefined;
173
+ chat?: { [k: string]: any } | undefined;
174
+ layoutIdentifier?: string | undefined;
175
+ };
176
+
177
+ /** @internal */
178
+ export const Overrides$outboundSchema: z.ZodType<
179
+ Overrides$Outbound,
180
+ z.ZodTypeDef,
181
+ Overrides
182
+ > = z.object({
183
+ steps: z.record(StepsOverrides$outboundSchema).optional(),
184
+ providers: z.record(z.record(z.any())).optional(),
185
+ email: z.record(z.any()).optional(),
186
+ push: z.record(z.any()).optional(),
187
+ sms: z.record(z.any()).optional(),
188
+ chat: z.record(z.any()).optional(),
189
+ layoutIdentifier: z.string().optional(),
190
+ });
191
+
192
+ /**
193
+ * @internal
194
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
195
+ */
196
+ export namespace Overrides$ {
197
+ /** @deprecated use `Overrides$inboundSchema` instead. */
198
+ export const inboundSchema = Overrides$inboundSchema;
199
+ /** @deprecated use `Overrides$outboundSchema` instead. */
200
+ export const outboundSchema = Overrides$outboundSchema;
201
+ /** @deprecated use `Overrides$Outbound` instead. */
202
+ export type Outbound = Overrides$Outbound;
203
+ }
204
+
205
+ export function overridesToJSON(overrides: Overrides): string {
206
+ return JSON.stringify(Overrides$outboundSchema.parse(overrides));
207
+ }
208
+
209
+ export function overridesFromJSON(
210
+ jsonString: string,
211
+ ): SafeParseResult<Overrides, SDKValidationError> {
212
+ return safeParse(
213
+ jsonString,
214
+ (x) => Overrides$inboundSchema.parse(JSON.parse(x)),
215
+ `Failed to parse 'Overrides' from JSON`,
216
+ );
217
+ }
218
+
101
219
  /** @internal */
102
220
  export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z.union(
103
221
  [
@@ -301,7 +419,7 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
301
419
  > = z.object({
302
420
  name: z.string(),
303
421
  payload: z.record(z.any()).optional(),
304
- overrides: z.record(z.record(z.any())).optional(),
422
+ overrides: z.lazy(() => Overrides$inboundSchema).optional(),
305
423
  to: z.union([
306
424
  TopicPayloadDto$inboundSchema,
307
425
  SubscriberPayloadDto$inboundSchema,
@@ -327,7 +445,7 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
327
445
  export type TriggerEventRequestDto$Outbound = {
328
446
  name: string;
329
447
  payload?: { [k: string]: any } | undefined;
330
- overrides?: { [k: string]: { [k: string]: any } } | undefined;
448
+ overrides?: Overrides$Outbound | undefined;
331
449
  to:
332
450
  | TopicPayloadDto$Outbound
333
451
  | SubscriberPayloadDto$Outbound
@@ -346,7 +464,7 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
346
464
  > = z.object({
347
465
  workflowId: z.string(),
348
466
  payload: z.record(z.any()).optional(),
349
- overrides: z.record(z.record(z.any())).optional(),
467
+ overrides: z.lazy(() => Overrides$outboundSchema).optional(),
350
468
  to: z.union([
351
469
  TopicPayloadDto$outboundSchema,
352
470
  SubscriberPayloadDto$outboundSchema,
@@ -3,9 +3,19 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
- import { safeParse } from "../../lib/schemas.js";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import {
8
+ collectExtraKeys as collectExtraKeys$,
9
+ safeParse,
10
+ } from "../../lib/schemas.js";
7
11
  import { Result as SafeParseResult } from "../../types/fp.js";
8
12
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
13
+ import {
14
+ StepsOverrides,
15
+ StepsOverrides$inboundSchema,
16
+ StepsOverrides$Outbound,
17
+ StepsOverrides$outboundSchema,
18
+ } from "./stepsoverrides.js";
9
19
  import {
10
20
  SubscriberPayloadDto,
11
21
  SubscriberPayloadDto$inboundSchema,
@@ -22,7 +32,47 @@ import {
22
32
  /**
23
33
  * This could be used to override provider specific configurations
24
34
  */
25
- export type TriggerEventToAllRequestDtoOverrides = {};
35
+ export type TriggerEventToAllRequestDtoOverrides = {
36
+ /**
37
+ * This could be used to override provider specific configurations
38
+ */
39
+ steps?: { [k: string]: StepsOverrides } | undefined;
40
+ /**
41
+ * Overrides the provider configuration for the entire workflow and all steps
42
+ */
43
+ providers?: { [k: string]: { [k: string]: any } } | undefined;
44
+ /**
45
+ * Override the email provider specific configurations for the entire workflow
46
+ *
47
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
48
+ */
49
+ email?: { [k: string]: any } | undefined;
50
+ /**
51
+ * Override the push provider specific configurations for the entire workflow
52
+ *
53
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
54
+ */
55
+ push?: { [k: string]: any } | undefined;
56
+ /**
57
+ * Override the sms provider specific configurations for the entire workflow
58
+ *
59
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
60
+ */
61
+ sms?: { [k: string]: any } | undefined;
62
+ /**
63
+ * Override the chat provider specific configurations for the entire workflow
64
+ *
65
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
66
+ */
67
+ chat?: { [k: string]: any } | undefined;
68
+ /**
69
+ * Override the layout identifier for the entire workflow
70
+ *
71
+ * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
72
+ */
73
+ layoutIdentifier?: string | undefined;
74
+ additionalProperties?: { [k: string]: { [k: string]: any } };
75
+ };
26
76
 
27
77
  /**
28
78
  * It is used to display the Avatar of the provided actor's subscriber id or actor object.
@@ -82,17 +132,54 @@ export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
82
132
  TriggerEventToAllRequestDtoOverrides,
83
133
  z.ZodTypeDef,
84
134
  unknown
85
- > = z.object({});
135
+ > = collectExtraKeys$(
136
+ z.object({
137
+ steps: z.record(StepsOverrides$inboundSchema).optional(),
138
+ providers: z.record(z.record(z.any())).optional(),
139
+ email: z.record(z.any()).optional(),
140
+ push: z.record(z.any()).optional(),
141
+ sms: z.record(z.any()).optional(),
142
+ chat: z.record(z.any()).optional(),
143
+ layoutIdentifier: z.string().optional(),
144
+ }).catchall(z.record(z.any())),
145
+ "additionalProperties",
146
+ true,
147
+ );
86
148
 
87
149
  /** @internal */
88
- export type TriggerEventToAllRequestDtoOverrides$Outbound = {};
150
+ export type TriggerEventToAllRequestDtoOverrides$Outbound = {
151
+ steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
152
+ providers?: { [k: string]: { [k: string]: any } } | undefined;
153
+ email?: { [k: string]: any } | undefined;
154
+ push?: { [k: string]: any } | undefined;
155
+ sms?: { [k: string]: any } | undefined;
156
+ chat?: { [k: string]: any } | undefined;
157
+ layoutIdentifier?: string | undefined;
158
+ [additionalProperties: string]: unknown;
159
+ };
89
160
 
90
161
  /** @internal */
91
162
  export const TriggerEventToAllRequestDtoOverrides$outboundSchema: z.ZodType<
92
163
  TriggerEventToAllRequestDtoOverrides$Outbound,
93
164
  z.ZodTypeDef,
94
165
  TriggerEventToAllRequestDtoOverrides
95
- > = z.object({});
166
+ > = z.object({
167
+ steps: z.record(StepsOverrides$outboundSchema).optional(),
168
+ providers: z.record(z.record(z.any())).optional(),
169
+ email: z.record(z.any()).optional(),
170
+ push: z.record(z.any()).optional(),
171
+ sms: z.record(z.any()).optional(),
172
+ chat: z.record(z.any()).optional(),
173
+ layoutIdentifier: z.string().optional(),
174
+ additionalProperties: z.record(z.record(z.any())),
175
+ }).transform((v) => {
176
+ return {
177
+ ...v.additionalProperties,
178
+ ...remap$(v, {
179
+ additionalProperties: null,
180
+ }),
181
+ };
182
+ });
96
183
 
97
184
  /**
98
185
  * @internal