@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
@@ -0,0 +1,42 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+
8
+ /**
9
+ * The source of overrides
10
+ */
11
+ export const PreferenceOverrideSourceEnum = {
12
+ Subscriber: "subscriber",
13
+ Template: "template",
14
+ WorkflowOverride: "workflowOverride",
15
+ } as const;
16
+ /**
17
+ * The source of overrides
18
+ */
19
+ export type PreferenceOverrideSourceEnum = ClosedEnum<
20
+ typeof PreferenceOverrideSourceEnum
21
+ >;
22
+
23
+ /** @internal */
24
+ export const PreferenceOverrideSourceEnum$inboundSchema: z.ZodNativeEnum<
25
+ typeof PreferenceOverrideSourceEnum
26
+ > = z.nativeEnum(PreferenceOverrideSourceEnum);
27
+
28
+ /** @internal */
29
+ export const PreferenceOverrideSourceEnum$outboundSchema: z.ZodNativeEnum<
30
+ typeof PreferenceOverrideSourceEnum
31
+ > = PreferenceOverrideSourceEnum$inboundSchema;
32
+
33
+ /**
34
+ * @internal
35
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
36
+ */
37
+ export namespace PreferenceOverrideSourceEnum$ {
38
+ /** @deprecated use `PreferenceOverrideSourceEnum$inboundSchema` instead. */
39
+ export const inboundSchema = PreferenceOverrideSourceEnum$inboundSchema;
40
+ /** @deprecated use `PreferenceOverrideSourceEnum$outboundSchema` instead. */
41
+ export const outboundSchema = PreferenceOverrideSourceEnum$outboundSchema;
42
+ }
@@ -60,6 +60,7 @@ export const ProvidersIdEnum = {
60
60
  BrevoSms: "brevo-sms",
61
61
  EazySms: "eazy-sms",
62
62
  Mobishastra: "mobishastra",
63
+ AfroMessage: "afro-message",
63
64
  Fcm: "fcm",
64
65
  Apns: "apns",
65
66
  Expo: "expo",
@@ -19,37 +19,38 @@ import {
19
19
  FieldFilterPartDto$outboundSchema,
20
20
  } from "./fieldfilterpartdto.js";
21
21
 
22
- export const Value = {
22
+ export const StepFilterDtoValue = {
23
23
  And: "AND",
24
24
  Or: "OR",
25
25
  } as const;
26
- export type Value = ClosedEnum<typeof Value>;
26
+ export type StepFilterDtoValue = ClosedEnum<typeof StepFilterDtoValue>;
27
27
 
28
28
  export type StepFilterDto = {
29
29
  isNegated: boolean;
30
30
  type: BuilderFieldTypeEnum;
31
- value: Value;
31
+ value: StepFilterDtoValue;
32
32
  children: Array<FieldFilterPartDto>;
33
33
  };
34
34
 
35
35
  /** @internal */
36
- export const Value$inboundSchema: z.ZodNativeEnum<typeof Value> = z.nativeEnum(
37
- Value,
38
- );
36
+ export const StepFilterDtoValue$inboundSchema: z.ZodNativeEnum<
37
+ typeof StepFilterDtoValue
38
+ > = z.nativeEnum(StepFilterDtoValue);
39
39
 
40
40
  /** @internal */
41
- export const Value$outboundSchema: z.ZodNativeEnum<typeof Value> =
42
- Value$inboundSchema;
41
+ export const StepFilterDtoValue$outboundSchema: z.ZodNativeEnum<
42
+ typeof StepFilterDtoValue
43
+ > = StepFilterDtoValue$inboundSchema;
43
44
 
44
45
  /**
45
46
  * @internal
46
47
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
47
48
  */
48
- export namespace Value$ {
49
- /** @deprecated use `Value$inboundSchema` instead. */
50
- export const inboundSchema = Value$inboundSchema;
51
- /** @deprecated use `Value$outboundSchema` instead. */
52
- export const outboundSchema = Value$outboundSchema;
49
+ export namespace StepFilterDtoValue$ {
50
+ /** @deprecated use `StepFilterDtoValue$inboundSchema` instead. */
51
+ export const inboundSchema = StepFilterDtoValue$inboundSchema;
52
+ /** @deprecated use `StepFilterDtoValue$outboundSchema` instead. */
53
+ export const outboundSchema = StepFilterDtoValue$outboundSchema;
53
54
  }
54
55
 
55
56
  /** @internal */
@@ -60,7 +61,7 @@ export const StepFilterDto$inboundSchema: z.ZodType<
60
61
  > = z.object({
61
62
  isNegated: z.boolean(),
62
63
  type: BuilderFieldTypeEnum$inboundSchema,
63
- value: Value$inboundSchema,
64
+ value: StepFilterDtoValue$inboundSchema,
64
65
  children: z.array(FieldFilterPartDto$inboundSchema),
65
66
  });
66
67
 
@@ -80,7 +81,7 @@ export const StepFilterDto$outboundSchema: z.ZodType<
80
81
  > = z.object({
81
82
  isNegated: z.boolean(),
82
83
  type: BuilderFieldTypeEnum$outboundSchema,
83
- value: Value$outboundSchema,
84
+ value: StepFilterDtoValue$outboundSchema,
84
85
  children: z.array(FieldFilterPartDto$outboundSchema),
85
86
  });
86
87
 
@@ -0,0 +1,65 @@
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
+
10
+ export type StepsOverrides = {
11
+ /**
12
+ * Passing the provider id and the provider specific configurations
13
+ */
14
+ providers: { [k: string]: { [k: string]: any } };
15
+ };
16
+
17
+ /** @internal */
18
+ export const StepsOverrides$inboundSchema: z.ZodType<
19
+ StepsOverrides,
20
+ z.ZodTypeDef,
21
+ unknown
22
+ > = z.object({
23
+ providers: z.record(z.record(z.any())),
24
+ });
25
+
26
+ /** @internal */
27
+ export type StepsOverrides$Outbound = {
28
+ providers: { [k: string]: { [k: string]: any } };
29
+ };
30
+
31
+ /** @internal */
32
+ export const StepsOverrides$outboundSchema: z.ZodType<
33
+ StepsOverrides$Outbound,
34
+ z.ZodTypeDef,
35
+ StepsOverrides
36
+ > = z.object({
37
+ providers: z.record(z.record(z.any())),
38
+ });
39
+
40
+ /**
41
+ * @internal
42
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
43
+ */
44
+ export namespace StepsOverrides$ {
45
+ /** @deprecated use `StepsOverrides$inboundSchema` instead. */
46
+ export const inboundSchema = StepsOverrides$inboundSchema;
47
+ /** @deprecated use `StepsOverrides$outboundSchema` instead. */
48
+ export const outboundSchema = StepsOverrides$outboundSchema;
49
+ /** @deprecated use `StepsOverrides$Outbound` instead. */
50
+ export type Outbound = StepsOverrides$Outbound;
51
+ }
52
+
53
+ export function stepsOverridesToJSON(stepsOverrides: StepsOverrides): string {
54
+ return JSON.stringify(StepsOverrides$outboundSchema.parse(stepsOverrides));
55
+ }
56
+
57
+ export function stepsOverridesFromJSON(
58
+ jsonString: string,
59
+ ): SafeParseResult<StepsOverrides, SDKValidationError> {
60
+ return safeParse(
61
+ jsonString,
62
+ (x) => StepsOverrides$inboundSchema.parse(JSON.parse(x)),
63
+ `Failed to parse 'StepsOverrides' from JSON`,
64
+ );
65
+ }
@@ -6,7 +6,7 @@ import * as z from "zod";
6
6
  import { ClosedEnum } from "../../types/enums.js";
7
7
 
8
8
  /**
9
- * Channels of the notification
9
+ * Type of the step
10
10
  */
11
11
  export const StepTypeEnum = {
12
12
  InApp: "in_app",
@@ -20,7 +20,7 @@ export const StepTypeEnum = {
20
20
  Custom: "custom",
21
21
  } as const;
22
22
  /**
23
- * Channels of the notification
23
+ * Type of the step
24
24
  */
25
25
  export type StepTypeEnum = ClosedEnum<typeof StepTypeEnum>;
26
26
 
@@ -17,7 +17,7 @@ import {
17
17
  /**
18
18
  * The ID of the chat or push provider.
19
19
  */
20
- export const SubscriberChannelDtoProviderId = {
20
+ export const ProviderId = {
21
21
  Slack: "slack",
22
22
  Discord: "discord",
23
23
  Msteams: "msteams",
@@ -39,15 +39,13 @@ export const SubscriberChannelDtoProviderId = {
39
39
  /**
40
40
  * The ID of the chat or push provider.
41
41
  */
42
- export type SubscriberChannelDtoProviderId = ClosedEnum<
43
- typeof SubscriberChannelDtoProviderId
44
- >;
42
+ export type ProviderId = ClosedEnum<typeof ProviderId>;
45
43
 
46
44
  export type SubscriberChannelDto = {
47
45
  /**
48
46
  * The ID of the chat or push provider.
49
47
  */
50
- providerId: SubscriberChannelDtoProviderId;
48
+ providerId: ProviderId;
51
49
  /**
52
50
  * An optional identifier for the integration.
53
51
  */
@@ -59,24 +57,22 @@ export type SubscriberChannelDto = {
59
57
  };
60
58
 
61
59
  /** @internal */
62
- export const SubscriberChannelDtoProviderId$inboundSchema: z.ZodNativeEnum<
63
- typeof SubscriberChannelDtoProviderId
64
- > = z.nativeEnum(SubscriberChannelDtoProviderId);
60
+ export const ProviderId$inboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
61
+ .nativeEnum(ProviderId);
65
62
 
66
63
  /** @internal */
67
- export const SubscriberChannelDtoProviderId$outboundSchema: z.ZodNativeEnum<
68
- typeof SubscriberChannelDtoProviderId
69
- > = SubscriberChannelDtoProviderId$inboundSchema;
64
+ export const ProviderId$outboundSchema: z.ZodNativeEnum<typeof ProviderId> =
65
+ ProviderId$inboundSchema;
70
66
 
71
67
  /**
72
68
  * @internal
73
69
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
74
70
  */
75
- export namespace SubscriberChannelDtoProviderId$ {
76
- /** @deprecated use `SubscriberChannelDtoProviderId$inboundSchema` instead. */
77
- export const inboundSchema = SubscriberChannelDtoProviderId$inboundSchema;
78
- /** @deprecated use `SubscriberChannelDtoProviderId$outboundSchema` instead. */
79
- export const outboundSchema = SubscriberChannelDtoProviderId$outboundSchema;
71
+ export namespace ProviderId$ {
72
+ /** @deprecated use `ProviderId$inboundSchema` instead. */
73
+ export const inboundSchema = ProviderId$inboundSchema;
74
+ /** @deprecated use `ProviderId$outboundSchema` instead. */
75
+ export const outboundSchema = ProviderId$outboundSchema;
80
76
  }
81
77
 
82
78
  /** @internal */
@@ -85,7 +81,7 @@ export const SubscriberChannelDto$inboundSchema: z.ZodType<
85
81
  z.ZodTypeDef,
86
82
  unknown
87
83
  > = z.object({
88
- providerId: SubscriberChannelDtoProviderId$inboundSchema,
84
+ providerId: ProviderId$inboundSchema,
89
85
  integrationIdentifier: z.string().optional(),
90
86
  credentials: ChannelCredentialsDto$inboundSchema,
91
87
  });
@@ -103,7 +99,7 @@ export const SubscriberChannelDto$outboundSchema: z.ZodType<
103
99
  z.ZodTypeDef,
104
100
  SubscriberChannelDto
105
101
  > = z.object({
106
- providerId: SubscriberChannelDtoProviderId$outboundSchema,
102
+ providerId: ProviderId$outboundSchema,
107
103
  integrationIdentifier: z.string().optional(),
108
104
  credentials: ChannelCredentialsDto$outboundSchema,
109
105
  });
@@ -0,0 +1,84 @@
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
+
16
+ export type SubscriberGlobalPreferenceDto = {
17
+ /**
18
+ * Whether notifications are enabled globally
19
+ */
20
+ enabled: boolean;
21
+ /**
22
+ * Channel-specific preference settings
23
+ */
24
+ channels: SubscriberPreferenceChannels;
25
+ };
26
+
27
+ /** @internal */
28
+ export const SubscriberGlobalPreferenceDto$inboundSchema: z.ZodType<
29
+ SubscriberGlobalPreferenceDto,
30
+ z.ZodTypeDef,
31
+ unknown
32
+ > = z.object({
33
+ enabled: z.boolean(),
34
+ channels: SubscriberPreferenceChannels$inboundSchema,
35
+ });
36
+
37
+ /** @internal */
38
+ export type SubscriberGlobalPreferenceDto$Outbound = {
39
+ enabled: boolean;
40
+ channels: SubscriberPreferenceChannels$Outbound;
41
+ };
42
+
43
+ /** @internal */
44
+ export const SubscriberGlobalPreferenceDto$outboundSchema: z.ZodType<
45
+ SubscriberGlobalPreferenceDto$Outbound,
46
+ z.ZodTypeDef,
47
+ SubscriberGlobalPreferenceDto
48
+ > = z.object({
49
+ enabled: z.boolean(),
50
+ channels: SubscriberPreferenceChannels$outboundSchema,
51
+ });
52
+
53
+ /**
54
+ * @internal
55
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
56
+ */
57
+ export namespace SubscriberGlobalPreferenceDto$ {
58
+ /** @deprecated use `SubscriberGlobalPreferenceDto$inboundSchema` instead. */
59
+ export const inboundSchema = SubscriberGlobalPreferenceDto$inboundSchema;
60
+ /** @deprecated use `SubscriberGlobalPreferenceDto$outboundSchema` instead. */
61
+ export const outboundSchema = SubscriberGlobalPreferenceDto$outboundSchema;
62
+ /** @deprecated use `SubscriberGlobalPreferenceDto$Outbound` instead. */
63
+ export type Outbound = SubscriberGlobalPreferenceDto$Outbound;
64
+ }
65
+
66
+ export function subscriberGlobalPreferenceDtoToJSON(
67
+ subscriberGlobalPreferenceDto: SubscriberGlobalPreferenceDto,
68
+ ): string {
69
+ return JSON.stringify(
70
+ SubscriberGlobalPreferenceDto$outboundSchema.parse(
71
+ subscriberGlobalPreferenceDto,
72
+ ),
73
+ );
74
+ }
75
+
76
+ export function subscriberGlobalPreferenceDtoFromJSON(
77
+ jsonString: string,
78
+ ): SafeParseResult<SubscriberGlobalPreferenceDto, SDKValidationError> {
79
+ return safeParse(
80
+ jsonString,
81
+ (x) => SubscriberGlobalPreferenceDto$inboundSchema.parse(JSON.parse(x)),
82
+ `Failed to parse 'SubscriberGlobalPreferenceDto' from JSON`,
83
+ );
84
+ }
@@ -0,0 +1,108 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ export type SubscriberPreferenceChannels = {
12
+ /**
13
+ * Email channel preference
14
+ */
15
+ email?: boolean | undefined;
16
+ /**
17
+ * SMS channel preference
18
+ */
19
+ sms?: boolean | undefined;
20
+ /**
21
+ * In-app channel preference
22
+ */
23
+ inApp?: boolean | undefined;
24
+ /**
25
+ * Chat channel preference
26
+ */
27
+ chat?: boolean | undefined;
28
+ /**
29
+ * Push notification channel preference
30
+ */
31
+ push?: boolean | undefined;
32
+ };
33
+
34
+ /** @internal */
35
+ export const SubscriberPreferenceChannels$inboundSchema: z.ZodType<
36
+ SubscriberPreferenceChannels,
37
+ z.ZodTypeDef,
38
+ unknown
39
+ > = z.object({
40
+ email: z.boolean().optional(),
41
+ sms: z.boolean().optional(),
42
+ in_app: z.boolean().optional(),
43
+ chat: z.boolean().optional(),
44
+ push: z.boolean().optional(),
45
+ }).transform((v) => {
46
+ return remap$(v, {
47
+ "in_app": "inApp",
48
+ });
49
+ });
50
+
51
+ /** @internal */
52
+ export type SubscriberPreferenceChannels$Outbound = {
53
+ email?: boolean | undefined;
54
+ sms?: boolean | undefined;
55
+ in_app?: boolean | undefined;
56
+ chat?: boolean | undefined;
57
+ push?: boolean | undefined;
58
+ };
59
+
60
+ /** @internal */
61
+ export const SubscriberPreferenceChannels$outboundSchema: z.ZodType<
62
+ SubscriberPreferenceChannels$Outbound,
63
+ z.ZodTypeDef,
64
+ SubscriberPreferenceChannels
65
+ > = z.object({
66
+ email: z.boolean().optional(),
67
+ sms: z.boolean().optional(),
68
+ inApp: z.boolean().optional(),
69
+ chat: z.boolean().optional(),
70
+ push: z.boolean().optional(),
71
+ }).transform((v) => {
72
+ return remap$(v, {
73
+ inApp: "in_app",
74
+ });
75
+ });
76
+
77
+ /**
78
+ * @internal
79
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
80
+ */
81
+ export namespace SubscriberPreferenceChannels$ {
82
+ /** @deprecated use `SubscriberPreferenceChannels$inboundSchema` instead. */
83
+ export const inboundSchema = SubscriberPreferenceChannels$inboundSchema;
84
+ /** @deprecated use `SubscriberPreferenceChannels$outboundSchema` instead. */
85
+ export const outboundSchema = SubscriberPreferenceChannels$outboundSchema;
86
+ /** @deprecated use `SubscriberPreferenceChannels$Outbound` instead. */
87
+ export type Outbound = SubscriberPreferenceChannels$Outbound;
88
+ }
89
+
90
+ export function subscriberPreferenceChannelsToJSON(
91
+ subscriberPreferenceChannels: SubscriberPreferenceChannels,
92
+ ): string {
93
+ return JSON.stringify(
94
+ SubscriberPreferenceChannels$outboundSchema.parse(
95
+ subscriberPreferenceChannels,
96
+ ),
97
+ );
98
+ }
99
+
100
+ export function subscriberPreferenceChannelsFromJSON(
101
+ jsonString: string,
102
+ ): SafeParseResult<SubscriberPreferenceChannels, SDKValidationError> {
103
+ return safeParse(
104
+ jsonString,
105
+ (x) => SubscriberPreferenceChannels$inboundSchema.parse(JSON.parse(x)),
106
+ `Failed to parse 'SubscriberPreferenceChannels' from JSON`,
107
+ );
108
+ }
@@ -0,0 +1,88 @@
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
+ ChannelTypeEnum,
11
+ ChannelTypeEnum$inboundSchema,
12
+ ChannelTypeEnum$outboundSchema,
13
+ } from "./channeltypeenum.js";
14
+ import {
15
+ PreferenceOverrideSourceEnum,
16
+ PreferenceOverrideSourceEnum$inboundSchema,
17
+ PreferenceOverrideSourceEnum$outboundSchema,
18
+ } from "./preferenceoverridesourceenum.js";
19
+
20
+ export type SubscriberPreferenceOverrideDto = {
21
+ /**
22
+ * Channel type through which the message is sent
23
+ */
24
+ channel: ChannelTypeEnum;
25
+ /**
26
+ * The source of overrides
27
+ */
28
+ source: PreferenceOverrideSourceEnum;
29
+ };
30
+
31
+ /** @internal */
32
+ export const SubscriberPreferenceOverrideDto$inboundSchema: z.ZodType<
33
+ SubscriberPreferenceOverrideDto,
34
+ z.ZodTypeDef,
35
+ unknown
36
+ > = z.object({
37
+ channel: ChannelTypeEnum$inboundSchema,
38
+ source: PreferenceOverrideSourceEnum$inboundSchema,
39
+ });
40
+
41
+ /** @internal */
42
+ export type SubscriberPreferenceOverrideDto$Outbound = {
43
+ channel: string;
44
+ source: string;
45
+ };
46
+
47
+ /** @internal */
48
+ export const SubscriberPreferenceOverrideDto$outboundSchema: z.ZodType<
49
+ SubscriberPreferenceOverrideDto$Outbound,
50
+ z.ZodTypeDef,
51
+ SubscriberPreferenceOverrideDto
52
+ > = z.object({
53
+ channel: ChannelTypeEnum$outboundSchema,
54
+ source: PreferenceOverrideSourceEnum$outboundSchema,
55
+ });
56
+
57
+ /**
58
+ * @internal
59
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
60
+ */
61
+ export namespace SubscriberPreferenceOverrideDto$ {
62
+ /** @deprecated use `SubscriberPreferenceOverrideDto$inboundSchema` instead. */
63
+ export const inboundSchema = SubscriberPreferenceOverrideDto$inboundSchema;
64
+ /** @deprecated use `SubscriberPreferenceOverrideDto$outboundSchema` instead. */
65
+ export const outboundSchema = SubscriberPreferenceOverrideDto$outboundSchema;
66
+ /** @deprecated use `SubscriberPreferenceOverrideDto$Outbound` instead. */
67
+ export type Outbound = SubscriberPreferenceOverrideDto$Outbound;
68
+ }
69
+
70
+ export function subscriberPreferenceOverrideDtoToJSON(
71
+ subscriberPreferenceOverrideDto: SubscriberPreferenceOverrideDto,
72
+ ): string {
73
+ return JSON.stringify(
74
+ SubscriberPreferenceOverrideDto$outboundSchema.parse(
75
+ subscriberPreferenceOverrideDto,
76
+ ),
77
+ );
78
+ }
79
+
80
+ export function subscriberPreferenceOverrideDtoFromJSON(
81
+ jsonString: string,
82
+ ): SafeParseResult<SubscriberPreferenceOverrideDto, SDKValidationError> {
83
+ return safeParse(
84
+ jsonString,
85
+ (x) => SubscriberPreferenceOverrideDto$inboundSchema.parse(JSON.parse(x)),
86
+ `Failed to parse 'SubscriberPreferenceOverrideDto' from JSON`,
87
+ );
88
+ }
@@ -0,0 +1,95 @@
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
+
10
+ export type SubscriberPreferencesWorkflowInfoDto = {
11
+ /**
12
+ * Workflow slug
13
+ */
14
+ slug: string;
15
+ /**
16
+ * Unique identifier of the workflow
17
+ */
18
+ identifier: string;
19
+ /**
20
+ * Display name of the workflow
21
+ */
22
+ name: string;
23
+ /**
24
+ * last updated date
25
+ */
26
+ updatedAt?: string | undefined;
27
+ };
28
+
29
+ /** @internal */
30
+ export const SubscriberPreferencesWorkflowInfoDto$inboundSchema: z.ZodType<
31
+ SubscriberPreferencesWorkflowInfoDto,
32
+ z.ZodTypeDef,
33
+ unknown
34
+ > = z.object({
35
+ slug: z.string(),
36
+ identifier: z.string(),
37
+ name: z.string(),
38
+ updatedAt: z.string().optional(),
39
+ });
40
+
41
+ /** @internal */
42
+ export type SubscriberPreferencesWorkflowInfoDto$Outbound = {
43
+ slug: string;
44
+ identifier: string;
45
+ name: string;
46
+ updatedAt?: string | undefined;
47
+ };
48
+
49
+ /** @internal */
50
+ export const SubscriberPreferencesWorkflowInfoDto$outboundSchema: z.ZodType<
51
+ SubscriberPreferencesWorkflowInfoDto$Outbound,
52
+ z.ZodTypeDef,
53
+ SubscriberPreferencesWorkflowInfoDto
54
+ > = z.object({
55
+ slug: z.string(),
56
+ identifier: z.string(),
57
+ name: z.string(),
58
+ updatedAt: z.string().optional(),
59
+ });
60
+
61
+ /**
62
+ * @internal
63
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
64
+ */
65
+ export namespace SubscriberPreferencesWorkflowInfoDto$ {
66
+ /** @deprecated use `SubscriberPreferencesWorkflowInfoDto$inboundSchema` instead. */
67
+ export const inboundSchema =
68
+ SubscriberPreferencesWorkflowInfoDto$inboundSchema;
69
+ /** @deprecated use `SubscriberPreferencesWorkflowInfoDto$outboundSchema` instead. */
70
+ export const outboundSchema =
71
+ SubscriberPreferencesWorkflowInfoDto$outboundSchema;
72
+ /** @deprecated use `SubscriberPreferencesWorkflowInfoDto$Outbound` instead. */
73
+ export type Outbound = SubscriberPreferencesWorkflowInfoDto$Outbound;
74
+ }
75
+
76
+ export function subscriberPreferencesWorkflowInfoDtoToJSON(
77
+ subscriberPreferencesWorkflowInfoDto: SubscriberPreferencesWorkflowInfoDto,
78
+ ): string {
79
+ return JSON.stringify(
80
+ SubscriberPreferencesWorkflowInfoDto$outboundSchema.parse(
81
+ subscriberPreferencesWorkflowInfoDto,
82
+ ),
83
+ );
84
+ }
85
+
86
+ export function subscriberPreferencesWorkflowInfoDtoFromJSON(
87
+ jsonString: string,
88
+ ): SafeParseResult<SubscriberPreferencesWorkflowInfoDto, SDKValidationError> {
89
+ return safeParse(
90
+ jsonString,
91
+ (x) =>
92
+ SubscriberPreferencesWorkflowInfoDto$inboundSchema.parse(JSON.parse(x)),
93
+ `Failed to parse 'SubscriberPreferencesWorkflowInfoDto' from JSON`,
94
+ );
95
+ }