@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
@@ -24,7 +24,7 @@ import {
24
24
  /**
25
25
  * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
26
26
  */
27
- export const IntegrationResponseDtoChannel = {
27
+ export const Channel = {
28
28
  InApp: "in_app",
29
29
  Email: "email",
30
30
  Sms: "sms",
@@ -34,9 +34,7 @@ export const IntegrationResponseDtoChannel = {
34
34
  /**
35
35
  * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
36
36
  */
37
- export type IntegrationResponseDtoChannel = ClosedEnum<
38
- typeof IntegrationResponseDtoChannel
39
- >;
37
+ export type Channel = ClosedEnum<typeof Channel>;
40
38
 
41
39
  export type IntegrationResponseDto = {
42
40
  /**
@@ -66,7 +64,7 @@ export type IntegrationResponseDto = {
66
64
  /**
67
65
  * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
68
66
  */
69
- channel: IntegrationResponseDtoChannel;
67
+ channel: Channel;
70
68
  /**
71
69
  * The credentials required for the integration to function, including API keys and other sensitive information.
72
70
  */
@@ -98,24 +96,22 @@ export type IntegrationResponseDto = {
98
96
  };
99
97
 
100
98
  /** @internal */
101
- export const IntegrationResponseDtoChannel$inboundSchema: z.ZodNativeEnum<
102
- typeof IntegrationResponseDtoChannel
103
- > = z.nativeEnum(IntegrationResponseDtoChannel);
99
+ export const Channel$inboundSchema: z.ZodNativeEnum<typeof Channel> = z
100
+ .nativeEnum(Channel);
104
101
 
105
102
  /** @internal */
106
- export const IntegrationResponseDtoChannel$outboundSchema: z.ZodNativeEnum<
107
- typeof IntegrationResponseDtoChannel
108
- > = IntegrationResponseDtoChannel$inboundSchema;
103
+ export const Channel$outboundSchema: z.ZodNativeEnum<typeof Channel> =
104
+ Channel$inboundSchema;
109
105
 
110
106
  /**
111
107
  * @internal
112
108
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
113
109
  */
114
- export namespace IntegrationResponseDtoChannel$ {
115
- /** @deprecated use `IntegrationResponseDtoChannel$inboundSchema` instead. */
116
- export const inboundSchema = IntegrationResponseDtoChannel$inboundSchema;
117
- /** @deprecated use `IntegrationResponseDtoChannel$outboundSchema` instead. */
118
- export const outboundSchema = IntegrationResponseDtoChannel$outboundSchema;
110
+ export namespace Channel$ {
111
+ /** @deprecated use `Channel$inboundSchema` instead. */
112
+ export const inboundSchema = Channel$inboundSchema;
113
+ /** @deprecated use `Channel$outboundSchema` instead. */
114
+ export const outboundSchema = Channel$outboundSchema;
119
115
  }
120
116
 
121
117
  /** @internal */
@@ -130,7 +126,7 @@ export const IntegrationResponseDto$inboundSchema: z.ZodType<
130
126
  name: z.string(),
131
127
  identifier: z.string(),
132
128
  providerId: z.string(),
133
- channel: IntegrationResponseDtoChannel$inboundSchema,
129
+ channel: Channel$inboundSchema,
134
130
  credentials: CredentialsDto$inboundSchema,
135
131
  active: z.boolean(),
136
132
  deleted: z.boolean(),
@@ -176,7 +172,7 @@ export const IntegrationResponseDto$outboundSchema: z.ZodType<
176
172
  name: z.string(),
177
173
  identifier: z.string(),
178
174
  providerId: z.string(),
179
- channel: IntegrationResponseDtoChannel$outboundSchema,
175
+ channel: Channel$outboundSchema,
180
176
  credentials: CredentialsDto$outboundSchema,
181
177
  active: z.boolean(),
182
178
  deleted: z.boolean(),
@@ -15,13 +15,13 @@ import {
15
15
  /**
16
16
  * Payload of the action result
17
17
  */
18
- export type MessageActionResultPayload = {};
18
+ export type Payload = {};
19
19
 
20
20
  export type MessageActionResult = {
21
21
  /**
22
22
  * Payload of the action result
23
23
  */
24
- payload?: MessageActionResultPayload | undefined;
24
+ payload?: Payload | undefined;
25
25
  /**
26
26
  * Type of button for the action result
27
27
  */
@@ -29,50 +29,43 @@ export type MessageActionResult = {
29
29
  };
30
30
 
31
31
  /** @internal */
32
- export const MessageActionResultPayload$inboundSchema: z.ZodType<
33
- MessageActionResultPayload,
34
- z.ZodTypeDef,
35
- unknown
36
- > = z.object({});
32
+ export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
33
+ z.object({});
37
34
 
38
35
  /** @internal */
39
- export type MessageActionResultPayload$Outbound = {};
36
+ export type Payload$Outbound = {};
40
37
 
41
38
  /** @internal */
42
- export const MessageActionResultPayload$outboundSchema: z.ZodType<
43
- MessageActionResultPayload$Outbound,
39
+ export const Payload$outboundSchema: z.ZodType<
40
+ Payload$Outbound,
44
41
  z.ZodTypeDef,
45
- MessageActionResultPayload
42
+ Payload
46
43
  > = z.object({});
47
44
 
48
45
  /**
49
46
  * @internal
50
47
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
51
48
  */
52
- export namespace MessageActionResultPayload$ {
53
- /** @deprecated use `MessageActionResultPayload$inboundSchema` instead. */
54
- export const inboundSchema = MessageActionResultPayload$inboundSchema;
55
- /** @deprecated use `MessageActionResultPayload$outboundSchema` instead. */
56
- export const outboundSchema = MessageActionResultPayload$outboundSchema;
57
- /** @deprecated use `MessageActionResultPayload$Outbound` instead. */
58
- export type Outbound = MessageActionResultPayload$Outbound;
49
+ export namespace Payload$ {
50
+ /** @deprecated use `Payload$inboundSchema` instead. */
51
+ export const inboundSchema = Payload$inboundSchema;
52
+ /** @deprecated use `Payload$outboundSchema` instead. */
53
+ export const outboundSchema = Payload$outboundSchema;
54
+ /** @deprecated use `Payload$Outbound` instead. */
55
+ export type Outbound = Payload$Outbound;
59
56
  }
60
57
 
61
- export function messageActionResultPayloadToJSON(
62
- messageActionResultPayload: MessageActionResultPayload,
63
- ): string {
64
- return JSON.stringify(
65
- MessageActionResultPayload$outboundSchema.parse(messageActionResultPayload),
66
- );
58
+ export function payloadToJSON(payload: Payload): string {
59
+ return JSON.stringify(Payload$outboundSchema.parse(payload));
67
60
  }
68
61
 
69
- export function messageActionResultPayloadFromJSON(
62
+ export function payloadFromJSON(
70
63
  jsonString: string,
71
- ): SafeParseResult<MessageActionResultPayload, SDKValidationError> {
64
+ ): SafeParseResult<Payload, SDKValidationError> {
72
65
  return safeParse(
73
66
  jsonString,
74
- (x) => MessageActionResultPayload$inboundSchema.parse(JSON.parse(x)),
75
- `Failed to parse 'MessageActionResultPayload' from JSON`,
67
+ (x) => Payload$inboundSchema.parse(JSON.parse(x)),
68
+ `Failed to parse 'Payload' from JSON`,
76
69
  );
77
70
  }
78
71
 
@@ -82,13 +75,13 @@ export const MessageActionResult$inboundSchema: z.ZodType<
82
75
  z.ZodTypeDef,
83
76
  unknown
84
77
  > = z.object({
85
- payload: z.lazy(() => MessageActionResultPayload$inboundSchema).optional(),
78
+ payload: z.lazy(() => Payload$inboundSchema).optional(),
86
79
  type: ButtonTypeEnum$inboundSchema.optional(),
87
80
  });
88
81
 
89
82
  /** @internal */
90
83
  export type MessageActionResult$Outbound = {
91
- payload?: MessageActionResultPayload$Outbound | undefined;
84
+ payload?: Payload$Outbound | undefined;
92
85
  type?: string | undefined;
93
86
  };
94
87
 
@@ -98,7 +91,7 @@ export const MessageActionResult$outboundSchema: z.ZodType<
98
91
  z.ZodTypeDef,
99
92
  MessageActionResult
100
93
  > = z.object({
101
- payload: z.lazy(() => MessageActionResultPayload$outboundSchema).optional(),
94
+ payload: z.lazy(() => Payload$outboundSchema).optional(),
102
95
  type: ButtonTypeEnum$outboundSchema.optional(),
103
96
  });
104
97
 
@@ -32,7 +32,7 @@ export type MessageCTA = {
32
32
  /**
33
33
  * Data associated with the call to action
34
34
  */
35
- data: MessageCTAData;
35
+ data?: MessageCTAData | undefined;
36
36
  /**
37
37
  * Action associated with the call to action
38
38
  */
@@ -46,14 +46,14 @@ export const MessageCTA$inboundSchema: z.ZodType<
46
46
  unknown
47
47
  > = z.object({
48
48
  type: ChannelCTATypeEnum$inboundSchema.optional(),
49
- data: MessageCTAData$inboundSchema,
49
+ data: MessageCTAData$inboundSchema.optional(),
50
50
  action: MessageAction$inboundSchema.optional(),
51
51
  });
52
52
 
53
53
  /** @internal */
54
54
  export type MessageCTA$Outbound = {
55
55
  type?: string | undefined;
56
- data: MessageCTAData$Outbound;
56
+ data?: MessageCTAData$Outbound | undefined;
57
57
  action?: MessageAction$Outbound | undefined;
58
58
  };
59
59
 
@@ -64,7 +64,7 @@ export const MessageCTA$outboundSchema: z.ZodType<
64
64
  MessageCTA
65
65
  > = z.object({
66
66
  type: ChannelCTATypeEnum$outboundSchema.optional(),
67
- data: MessageCTAData$outboundSchema,
67
+ data: MessageCTAData$outboundSchema.optional(),
68
68
  action: MessageAction$outboundSchema.optional(),
69
69
  });
70
70
 
@@ -45,7 +45,7 @@ import {
45
45
  /**
46
46
  * Content of the message, can be an email block or a string
47
47
  */
48
- export type Content = EmailBlock | string;
48
+ export type Content = Array<EmailBlock> | string;
49
49
 
50
50
  /**
51
51
  * The payload that was used to send the notification trigger
@@ -102,6 +102,10 @@ export type MessageResponseDto = {
102
102
  * Creation date of the message
103
103
  */
104
104
  createdAt: string;
105
+ /**
106
+ * Array of delivery dates for the message, if the message has multiple delivery dates, for example after being snoozed
107
+ */
108
+ deliveredAt?: Array<string> | undefined;
105
109
  /**
106
110
  * Last seen date of the message, if available
107
111
  */
@@ -113,7 +117,7 @@ export type MessageResponseDto = {
113
117
  /**
114
118
  * Content of the message, can be an email block or a string
115
119
  */
116
- content: EmailBlock | string;
120
+ content: Array<EmailBlock> | string;
117
121
  /**
118
122
  * Transaction ID associated with the message
119
123
  */
@@ -134,6 +138,10 @@ export type MessageResponseDto = {
134
138
  * Indicates if the message has been seen
135
139
  */
136
140
  seen: boolean;
141
+ /**
142
+ * Date when the message will be unsnoozed
143
+ */
144
+ snoozedUntil?: string | undefined;
137
145
  /**
138
146
  * Email address associated with the message, if applicable
139
147
  */
@@ -190,17 +198,17 @@ export type MessageResponseDto = {
190
198
 
191
199
  /** @internal */
192
200
  export const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> =
193
- z.union([EmailBlock$inboundSchema, z.string()]);
201
+ z.union([z.array(EmailBlock$inboundSchema), z.string()]);
194
202
 
195
203
  /** @internal */
196
- export type Content$Outbound = EmailBlock$Outbound | string;
204
+ export type Content$Outbound = Array<EmailBlock$Outbound> | string;
197
205
 
198
206
  /** @internal */
199
207
  export const Content$outboundSchema: z.ZodType<
200
208
  Content$Outbound,
201
209
  z.ZodTypeDef,
202
210
  Content
203
- > = z.union([EmailBlock$outboundSchema, z.string()]);
211
+ > = z.union([z.array(EmailBlock$outboundSchema), z.string()]);
204
212
 
205
213
  /**
206
214
  * @internal
@@ -344,14 +352,16 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
344
352
  template: WorkflowResponse$inboundSchema.optional(),
345
353
  templateIdentifier: z.string().optional(),
346
354
  createdAt: z.string(),
355
+ deliveredAt: z.array(z.string()).optional(),
347
356
  lastSeenDate: z.string().optional(),
348
357
  lastReadDate: z.string().optional(),
349
- content: z.union([EmailBlock$inboundSchema, z.string()]),
358
+ content: z.union([z.array(EmailBlock$inboundSchema), z.string()]),
350
359
  transactionId: z.string(),
351
360
  subject: z.string().optional(),
352
361
  channel: ChannelTypeEnum$inboundSchema,
353
362
  read: z.boolean(),
354
363
  seen: z.boolean(),
364
+ snoozedUntil: z.string().optional(),
355
365
  email: z.string().optional(),
356
366
  phone: z.string().optional(),
357
367
  directWebhookUrl: z.string().optional(),
@@ -391,14 +401,16 @@ export type MessageResponseDto$Outbound = {
391
401
  template?: WorkflowResponse$Outbound | undefined;
392
402
  templateIdentifier?: string | undefined;
393
403
  createdAt: string;
404
+ deliveredAt?: Array<string> | undefined;
394
405
  lastSeenDate?: string | undefined;
395
406
  lastReadDate?: string | undefined;
396
- content: EmailBlock$Outbound | string;
407
+ content: Array<EmailBlock$Outbound> | string;
397
408
  transactionId: string;
398
409
  subject?: string | undefined;
399
410
  channel: string;
400
411
  read: boolean;
401
412
  seen: boolean;
413
+ snoozedUntil?: string | undefined;
402
414
  email?: string | undefined;
403
415
  phone?: string | undefined;
404
416
  directWebhookUrl?: string | undefined;
@@ -431,14 +443,16 @@ export const MessageResponseDto$outboundSchema: z.ZodType<
431
443
  template: WorkflowResponse$outboundSchema.optional(),
432
444
  templateIdentifier: z.string().optional(),
433
445
  createdAt: z.string(),
446
+ deliveredAt: z.array(z.string()).optional(),
434
447
  lastSeenDate: z.string().optional(),
435
448
  lastReadDate: z.string().optional(),
436
- content: z.union([EmailBlock$outboundSchema, z.string()]),
449
+ content: z.union([z.array(EmailBlock$outboundSchema), z.string()]),
437
450
  transactionId: z.string(),
438
451
  subject: z.string().optional(),
439
452
  channel: ChannelTypeEnum$outboundSchema,
440
453
  read: z.boolean(),
441
454
  seen: z.boolean(),
455
+ snoozedUntil: z.string().optional(),
442
456
  email: z.string().optional(),
443
457
  phone: z.string().optional(),
444
458
  directWebhookUrl: z.string().optional(),
@@ -0,0 +1,103 @@
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
+ MessageResponseDto,
11
+ MessageResponseDto$inboundSchema,
12
+ MessageResponseDto$Outbound,
13
+ MessageResponseDto$outboundSchema,
14
+ } from "./messageresponsedto.js";
15
+
16
+ export type MessagesResponseDto = {
17
+ /**
18
+ * Total number of messages available
19
+ */
20
+ totalCount?: number | undefined;
21
+ /**
22
+ * Indicates if there are more messages available
23
+ */
24
+ hasMore: boolean;
25
+ /**
26
+ * List of messages
27
+ */
28
+ data: Array<MessageResponseDto>;
29
+ /**
30
+ * Number of messages per page
31
+ */
32
+ pageSize: number;
33
+ /**
34
+ * Current page number
35
+ */
36
+ page: number;
37
+ };
38
+
39
+ /** @internal */
40
+ export const MessagesResponseDto$inboundSchema: z.ZodType<
41
+ MessagesResponseDto,
42
+ z.ZodTypeDef,
43
+ unknown
44
+ > = z.object({
45
+ totalCount: z.number().optional(),
46
+ hasMore: z.boolean(),
47
+ data: z.array(MessageResponseDto$inboundSchema),
48
+ pageSize: z.number(),
49
+ page: z.number(),
50
+ });
51
+
52
+ /** @internal */
53
+ export type MessagesResponseDto$Outbound = {
54
+ totalCount?: number | undefined;
55
+ hasMore: boolean;
56
+ data: Array<MessageResponseDto$Outbound>;
57
+ pageSize: number;
58
+ page: number;
59
+ };
60
+
61
+ /** @internal */
62
+ export const MessagesResponseDto$outboundSchema: z.ZodType<
63
+ MessagesResponseDto$Outbound,
64
+ z.ZodTypeDef,
65
+ MessagesResponseDto
66
+ > = z.object({
67
+ totalCount: z.number().optional(),
68
+ hasMore: z.boolean(),
69
+ data: z.array(MessageResponseDto$outboundSchema),
70
+ pageSize: z.number(),
71
+ page: z.number(),
72
+ });
73
+
74
+ /**
75
+ * @internal
76
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
77
+ */
78
+ export namespace MessagesResponseDto$ {
79
+ /** @deprecated use `MessagesResponseDto$inboundSchema` instead. */
80
+ export const inboundSchema = MessagesResponseDto$inboundSchema;
81
+ /** @deprecated use `MessagesResponseDto$outboundSchema` instead. */
82
+ export const outboundSchema = MessagesResponseDto$outboundSchema;
83
+ /** @deprecated use `MessagesResponseDto$Outbound` instead. */
84
+ export type Outbound = MessagesResponseDto$Outbound;
85
+ }
86
+
87
+ export function messagesResponseDtoToJSON(
88
+ messagesResponseDto: MessagesResponseDto,
89
+ ): string {
90
+ return JSON.stringify(
91
+ MessagesResponseDto$outboundSchema.parse(messagesResponseDto),
92
+ );
93
+ }
94
+
95
+ export function messagesResponseDtoFromJSON(
96
+ jsonString: string,
97
+ ): SafeParseResult<MessagesResponseDto, SDKValidationError> {
98
+ return safeParse(
99
+ jsonString,
100
+ (x) => MessagesResponseDto$inboundSchema.parse(JSON.parse(x)),
101
+ `Failed to parse 'MessagesResponseDto' from JSON`,
102
+ );
103
+ }
@@ -132,10 +132,6 @@ export type NotificationFeedItemDto = {
132
132
  * Indicates whether the notification has been seen by the subscriber.
133
133
  */
134
134
  seen: boolean;
135
- /**
136
- * Indicates whether the notification has been deleted.
137
- */
138
- deleted: boolean;
139
135
  /**
140
136
  * Device tokens for push notifications, if applicable.
141
137
  */
@@ -210,7 +206,6 @@ export const NotificationFeedItemDto$inboundSchema: z.ZodType<
210
206
  channel: ChannelTypeEnum$inboundSchema,
211
207
  read: z.boolean(),
212
208
  seen: z.boolean(),
213
- deleted: z.boolean(),
214
209
  deviceTokens: z.nullable(z.array(z.string())).optional(),
215
210
  cta: MessageCTA$inboundSchema,
216
211
  status: NotificationFeedItemDtoStatus$inboundSchema,
@@ -253,7 +248,6 @@ export type NotificationFeedItemDto$Outbound = {
253
248
  channel: string;
254
249
  read: boolean;
255
250
  seen: boolean;
256
- deleted: boolean;
257
251
  deviceTokens?: Array<string> | null | undefined;
258
252
  cta: MessageCTA$Outbound;
259
253
  status: string;
@@ -288,7 +282,6 @@ export const NotificationFeedItemDto$outboundSchema: z.ZodType<
288
282
  channel: ChannelTypeEnum$outboundSchema,
289
283
  read: z.boolean(),
290
284
  seen: z.boolean(),
291
- deleted: z.boolean(),
292
285
  deviceTokens: z.nullable(z.array(z.string())).optional(),
293
286
  cta: MessageCTA$outboundSchema,
294
287
  status: NotificationFeedItemDtoStatus$outboundSchema,
@@ -59,7 +59,7 @@ import {
59
59
  /**
60
60
  * Metadata associated with the workflow step. Can vary based on the type of step.
61
61
  */
62
- export type NotificationStepDtoMetadata =
62
+ export type Metadata =
63
63
  | DelayScheduledMetadata
64
64
  | DelayRegularMetadata
65
65
  | DigestTimedMetadata
@@ -119,8 +119,8 @@ export type NotificationStepDto = {
119
119
  };
120
120
 
121
121
  /** @internal */
122
- export const NotificationStepDtoMetadata$inboundSchema: z.ZodType<
123
- NotificationStepDtoMetadata,
122
+ export const Metadata$inboundSchema: z.ZodType<
123
+ Metadata,
124
124
  z.ZodTypeDef,
125
125
  unknown
126
126
  > = z.union([
@@ -131,17 +131,17 @@ export const NotificationStepDtoMetadata$inboundSchema: z.ZodType<
131
131
  ]);
132
132
 
133
133
  /** @internal */
134
- export type NotificationStepDtoMetadata$Outbound =
134
+ export type Metadata$Outbound =
135
135
  | DelayScheduledMetadata$Outbound
136
136
  | DelayRegularMetadata$Outbound
137
137
  | DigestTimedMetadata$Outbound
138
138
  | DigestRegularMetadata$Outbound;
139
139
 
140
140
  /** @internal */
141
- export const NotificationStepDtoMetadata$outboundSchema: z.ZodType<
142
- NotificationStepDtoMetadata$Outbound,
141
+ export const Metadata$outboundSchema: z.ZodType<
142
+ Metadata$Outbound,
143
143
  z.ZodTypeDef,
144
- NotificationStepDtoMetadata
144
+ Metadata
145
145
  > = z.union([
146
146
  DelayScheduledMetadata$outboundSchema,
147
147
  DelayRegularMetadata$outboundSchema,
@@ -153,32 +153,26 @@ export const NotificationStepDtoMetadata$outboundSchema: z.ZodType<
153
153
  * @internal
154
154
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
155
155
  */
156
- export namespace NotificationStepDtoMetadata$ {
157
- /** @deprecated use `NotificationStepDtoMetadata$inboundSchema` instead. */
158
- export const inboundSchema = NotificationStepDtoMetadata$inboundSchema;
159
- /** @deprecated use `NotificationStepDtoMetadata$outboundSchema` instead. */
160
- export const outboundSchema = NotificationStepDtoMetadata$outboundSchema;
161
- /** @deprecated use `NotificationStepDtoMetadata$Outbound` instead. */
162
- export type Outbound = NotificationStepDtoMetadata$Outbound;
156
+ export namespace Metadata$ {
157
+ /** @deprecated use `Metadata$inboundSchema` instead. */
158
+ export const inboundSchema = Metadata$inboundSchema;
159
+ /** @deprecated use `Metadata$outboundSchema` instead. */
160
+ export const outboundSchema = Metadata$outboundSchema;
161
+ /** @deprecated use `Metadata$Outbound` instead. */
162
+ export type Outbound = Metadata$Outbound;
163
163
  }
164
164
 
165
- export function notificationStepDtoMetadataToJSON(
166
- notificationStepDtoMetadata: NotificationStepDtoMetadata,
167
- ): string {
168
- return JSON.stringify(
169
- NotificationStepDtoMetadata$outboundSchema.parse(
170
- notificationStepDtoMetadata,
171
- ),
172
- );
165
+ export function metadataToJSON(metadata: Metadata): string {
166
+ return JSON.stringify(Metadata$outboundSchema.parse(metadata));
173
167
  }
174
168
 
175
- export function notificationStepDtoMetadataFromJSON(
169
+ export function metadataFromJSON(
176
170
  jsonString: string,
177
- ): SafeParseResult<NotificationStepDtoMetadata, SDKValidationError> {
171
+ ): SafeParseResult<Metadata, SDKValidationError> {
178
172
  return safeParse(
179
173
  jsonString,
180
- (x) => NotificationStepDtoMetadata$inboundSchema.parse(JSON.parse(x)),
181
- `Failed to parse 'NotificationStepDtoMetadata' from JSON`,
174
+ (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
175
+ `Failed to parse 'Metadata' from JSON`,
182
176
  );
183
177
  }
184
178
 
@@ -17,19 +17,21 @@ import {
17
17
  /**
18
18
  * Type of the trigger
19
19
  */
20
- export const Type = {
20
+ export const NotificationTriggerDtoType = {
21
21
  Event: "event",
22
22
  } as const;
23
23
  /**
24
24
  * Type of the trigger
25
25
  */
26
- export type Type = ClosedEnum<typeof Type>;
26
+ export type NotificationTriggerDtoType = ClosedEnum<
27
+ typeof NotificationTriggerDtoType
28
+ >;
27
29
 
28
30
  export type NotificationTriggerDto = {
29
31
  /**
30
32
  * Type of the trigger
31
33
  */
32
- type: Type;
34
+ type: NotificationTriggerDtoType;
33
35
  /**
34
36
  * Identifier of the trigger
35
37
  */
@@ -45,23 +47,24 @@ export type NotificationTriggerDto = {
45
47
  };
46
48
 
47
49
  /** @internal */
48
- export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
49
- Type,
50
- );
50
+ export const NotificationTriggerDtoType$inboundSchema: z.ZodNativeEnum<
51
+ typeof NotificationTriggerDtoType
52
+ > = z.nativeEnum(NotificationTriggerDtoType);
51
53
 
52
54
  /** @internal */
53
- export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
54
- Type$inboundSchema;
55
+ export const NotificationTriggerDtoType$outboundSchema: z.ZodNativeEnum<
56
+ typeof NotificationTriggerDtoType
57
+ > = NotificationTriggerDtoType$inboundSchema;
55
58
 
56
59
  /**
57
60
  * @internal
58
61
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
59
62
  */
60
- export namespace Type$ {
61
- /** @deprecated use `Type$inboundSchema` instead. */
62
- export const inboundSchema = Type$inboundSchema;
63
- /** @deprecated use `Type$outboundSchema` instead. */
64
- export const outboundSchema = Type$outboundSchema;
63
+ export namespace NotificationTriggerDtoType$ {
64
+ /** @deprecated use `NotificationTriggerDtoType$inboundSchema` instead. */
65
+ export const inboundSchema = NotificationTriggerDtoType$inboundSchema;
66
+ /** @deprecated use `NotificationTriggerDtoType$outboundSchema` instead. */
67
+ export const outboundSchema = NotificationTriggerDtoType$outboundSchema;
65
68
  }
66
69
 
67
70
  /** @internal */
@@ -70,7 +73,7 @@ export const NotificationTriggerDto$inboundSchema: z.ZodType<
70
73
  z.ZodTypeDef,
71
74
  unknown
72
75
  > = z.object({
73
- type: Type$inboundSchema,
76
+ type: NotificationTriggerDtoType$inboundSchema,
74
77
  identifier: z.string(),
75
78
  variables: z.array(NotificationTriggerVariable$inboundSchema),
76
79
  subscriberVariables: z.array(NotificationTriggerVariable$inboundSchema)
@@ -91,7 +94,7 @@ export const NotificationTriggerDto$outboundSchema: z.ZodType<
91
94
  z.ZodTypeDef,
92
95
  NotificationTriggerDto
93
96
  > = z.object({
94
- type: Type$outboundSchema,
97
+ type: NotificationTriggerDtoType$outboundSchema,
95
98
  identifier: z.string(),
96
99
  variables: z.array(NotificationTriggerVariable$outboundSchema),
97
100
  subscriberVariables: z.array(NotificationTriggerVariable$outboundSchema)
@@ -19,7 +19,7 @@ export type PatchSubscriberPreferencesDto = {
19
19
  */
20
20
  channels: PatchPreferenceChannelsDto;
21
21
  /**
22
- * If provided, update workflow specific preferences, otherwise update global preferences
22
+ * Workflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences
23
23
  */
24
24
  workflowId?: string | undefined;
25
25
  };