@novu/api 0.1.6 → 0.2.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 (216) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/README.md +14 -31
  3. package/docs/sdks/authentication/README.md +4 -4
  4. package/docs/sdks/credentials/README.md +6 -6
  5. package/docs/sdks/integrations/README.md +12 -12
  6. package/docs/sdks/messages/README.md +6 -6
  7. package/docs/sdks/notifications/README.md +4 -4
  8. package/docs/sdks/novu/README.md +8 -8
  9. package/docs/sdks/novumessages/README.md +6 -6
  10. package/docs/sdks/novunotifications/README.md +4 -4
  11. package/docs/sdks/novusubscribers/README.md +6 -6
  12. package/docs/sdks/preferences/README.md +9 -260
  13. package/docs/sdks/properties/README.md +2 -2
  14. package/docs/sdks/stats/README.md +4 -4
  15. package/docs/sdks/subscribers/README.md +50 -322
  16. package/docs/sdks/topics/README.md +10 -10
  17. package/docs/sdks/webhooks/README.md +2 -2
  18. package/funcs/subscribersCreate.d.ts +2 -2
  19. package/funcs/subscribersCreate.d.ts.map +1 -1
  20. package/funcs/subscribersCreate.js +5 -5
  21. package/funcs/subscribersCreate.js.map +1 -1
  22. package/funcs/{subscribersPreferencesRetrieve.d.ts → subscribersPreferencesList.d.ts} +2 -2
  23. package/funcs/subscribersPreferencesList.d.ts.map +1 -0
  24. package/funcs/{subscribersPreferencesRetrieve.js → subscribersPreferencesList.js} +4 -4
  25. package/funcs/subscribersPreferencesList.js.map +1 -0
  26. package/jsr.json +1 -1
  27. package/lib/config.d.ts +3 -3
  28. package/lib/config.js +3 -3
  29. package/models/components/index.d.ts +0 -14
  30. package/models/components/index.d.ts.map +1 -1
  31. package/models/components/index.js +0 -14
  32. package/models/components/index.js.map +1 -1
  33. package/models/components/subscriberresponsedto.d.ts +5 -0
  34. package/models/components/subscriberresponsedto.d.ts.map +1 -1
  35. package/models/components/subscriberresponsedto.js +2 -0
  36. package/models/components/subscriberresponsedto.js.map +1 -1
  37. package/models/operations/index.d.ts +1 -8
  38. package/models/operations/index.d.ts.map +1 -1
  39. package/models/operations/index.js +1 -8
  40. package/models/operations/index.js.map +1 -1
  41. package/models/operations/subscriberscontrollercreatesubscriber.d.ts +66 -0
  42. package/models/operations/subscriberscontrollercreatesubscriber.d.ts.map +1 -0
  43. package/models/operations/subscriberscontrollercreatesubscriber.js +112 -0
  44. package/models/operations/subscriberscontrollercreatesubscriber.js.map +1 -0
  45. package/package.json +1 -1
  46. package/sdk/preferences.d.ts +1 -20
  47. package/sdk/preferences.d.ts.map +1 -1
  48. package/sdk/preferences.js +3 -32
  49. package/sdk/preferences.js.map +1 -1
  50. package/sdk/subscribers.d.ts +9 -32
  51. package/sdk/subscribers.d.ts.map +1 -1
  52. package/sdk/subscribers.js +12 -44
  53. package/sdk/subscribers.js.map +1 -1
  54. package/sources/json-development.json +2313 -6112
  55. package/src/funcs/subscribersCreate.ts +9 -9
  56. package/src/funcs/{subscribersPreferencesRetrieve.ts → subscribersPreferencesList.ts} +1 -1
  57. package/src/lib/config.ts +3 -3
  58. package/src/models/components/index.ts +0 -14
  59. package/src/models/components/subscriberresponsedto.ts +7 -0
  60. package/src/models/operations/index.ts +1 -8
  61. package/src/models/operations/subscriberscontrollercreatesubscriber.ts +185 -0
  62. package/src/sdk/preferences.ts +3 -70
  63. package/src/sdk/subscribers.ts +24 -90
  64. package/docs/sdks/legacy/README.md +0 -86
  65. package/funcs/subscribersDeleteLegacy.d.ts +0 -18
  66. package/funcs/subscribersDeleteLegacy.d.ts.map +0 -1
  67. package/funcs/subscribersDeleteLegacy.js +0 -141
  68. package/funcs/subscribersDeleteLegacy.js.map +0 -1
  69. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts +0 -14
  70. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts.map +0 -1
  71. package/funcs/subscribersPreferencesLegacyUpdateGlobal.js +0 -140
  72. package/funcs/subscribersPreferencesLegacyUpdateGlobal.js.map +0 -1
  73. package/funcs/subscribersPreferencesListLegacy.d.ts +0 -15
  74. package/funcs/subscribersPreferencesListLegacy.d.ts.map +0 -1
  75. package/funcs/subscribersPreferencesListLegacy.js +0 -145
  76. package/funcs/subscribersPreferencesListLegacy.js.map +0 -1
  77. package/funcs/subscribersPreferencesRetrieve.d.ts.map +0 -1
  78. package/funcs/subscribersPreferencesRetrieve.js.map +0 -1
  79. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts +0 -15
  80. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts.map +0 -1
  81. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.js +0 -144
  82. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.js.map +0 -1
  83. package/funcs/subscribersPreferencesUpdateLegacy.d.ts +0 -13
  84. package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +0 -1
  85. package/funcs/subscribersPreferencesUpdateLegacy.js +0 -139
  86. package/funcs/subscribersPreferencesUpdateLegacy.js.map +0 -1
  87. package/funcs/subscribersRetrieveLegacy.d.ts +0 -16
  88. package/funcs/subscribersRetrieveLegacy.d.ts.map +0 -1
  89. package/funcs/subscribersRetrieveLegacy.js +0 -144
  90. package/funcs/subscribersRetrieveLegacy.js.map +0 -1
  91. package/funcs/subscribersUpdateLegacy.d.ts +0 -17
  92. package/funcs/subscribersUpdateLegacy.d.ts.map +0 -1
  93. package/funcs/subscribersUpdateLegacy.js +0 -143
  94. package/funcs/subscribersUpdateLegacy.js.map +0 -1
  95. package/models/components/channelpreference.d.ts +0 -38
  96. package/models/components/channelpreference.d.ts.map +0 -1
  97. package/models/components/channelpreference.js +0 -62
  98. package/models/components/channelpreference.js.map +0 -1
  99. package/models/components/deletesubscriberresponsedto.d.ts +0 -66
  100. package/models/components/deletesubscriberresponsedto.d.ts.map +0 -1
  101. package/models/components/deletesubscriberresponsedto.js +0 -82
  102. package/models/components/deletesubscriberresponsedto.js.map +0 -1
  103. package/models/components/getsubscriberpreferencesresponsedto.d.ts +0 -39
  104. package/models/components/getsubscriberpreferencesresponsedto.d.ts.map +0 -1
  105. package/models/components/getsubscriberpreferencesresponsedto.js +0 -63
  106. package/models/components/getsubscriberpreferencesresponsedto.js.map +0 -1
  107. package/models/components/notificationtriggerresponse.d.ts +0 -55
  108. package/models/components/notificationtriggerresponse.d.ts.map +0 -1
  109. package/models/components/notificationtriggerresponse.js +0 -72
  110. package/models/components/notificationtriggerresponse.js.map +0 -1
  111. package/models/components/notificationtriggervariableresponse.d.ts +0 -101
  112. package/models/components/notificationtriggervariableresponse.d.ts.map +0 -1
  113. package/models/components/notificationtriggervariableresponse.js +0 -112
  114. package/models/components/notificationtriggervariableresponse.js.map +0 -1
  115. package/models/components/preference.d.ts +0 -38
  116. package/models/components/preference.d.ts.map +0 -1
  117. package/models/components/preference.js +0 -62
  118. package/models/components/preference.js.map +0 -1
  119. package/models/components/templateresponse.d.ts +0 -48
  120. package/models/components/templateresponse.d.ts.map +0 -1
  121. package/models/components/templateresponse.js +0 -75
  122. package/models/components/templateresponse.js.map +0 -1
  123. package/models/components/triggerreservedvariableresponse.d.ts +0 -69
  124. package/models/components/triggerreservedvariableresponse.d.ts.map +0 -1
  125. package/models/components/triggerreservedvariableresponse.js +0 -83
  126. package/models/components/triggerreservedvariableresponse.js.map +0 -1
  127. package/models/components/triggertypeenum.d.ts +0 -31
  128. package/models/components/triggertypeenum.d.ts.map +0 -1
  129. package/models/components/triggertypeenum.js +0 -52
  130. package/models/components/triggertypeenum.js.map +0 -1
  131. package/models/components/updatesubscriberglobalpreferencesrequestdto.d.ts +0 -38
  132. package/models/components/updatesubscriberglobalpreferencesrequestdto.d.ts.map +0 -1
  133. package/models/components/updatesubscriberglobalpreferencesrequestdto.js +0 -62
  134. package/models/components/updatesubscriberglobalpreferencesrequestdto.js.map +0 -1
  135. package/models/components/updatesubscriberpreferenceglobalresponsedto.d.ts +0 -33
  136. package/models/components/updatesubscriberpreferenceglobalresponsedto.d.ts.map +0 -1
  137. package/models/components/updatesubscriberpreferenceglobalresponsedto.js +0 -60
  138. package/models/components/updatesubscriberpreferenceglobalresponsedto.js.map +0 -1
  139. package/models/components/updatesubscriberpreferencerequestdto.d.ts +0 -38
  140. package/models/components/updatesubscriberpreferencerequestdto.d.ts.map +0 -1
  141. package/models/components/updatesubscriberpreferencerequestdto.js +0 -62
  142. package/models/components/updatesubscriberpreferencerequestdto.js.map +0 -1
  143. package/models/components/updatesubscriberpreferenceresponsedto.d.ts +0 -39
  144. package/models/components/updatesubscriberpreferenceresponsedto.d.ts.map +0 -1
  145. package/models/components/updatesubscriberpreferenceresponsedto.js +0 -63
  146. package/models/components/updatesubscriberpreferenceresponsedto.js.map +0 -1
  147. package/models/components/updatesubscriberrequestdto.d.ts +0 -72
  148. package/models/components/updatesubscriberrequestdto.d.ts.map +0 -1
  149. package/models/components/updatesubscriberrequestdto.js +0 -74
  150. package/models/components/updatesubscriberrequestdto.js.map +0 -1
  151. package/models/operations/subscribersv1controllercreatesubscriber.d.ts +0 -66
  152. package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +0 -1
  153. package/models/operations/subscribersv1controllercreatesubscriber.js +0 -112
  154. package/models/operations/subscribersv1controllercreatesubscriber.js.map +0 -1
  155. package/models/operations/subscribersv1controllergetsubscriber.d.ts +0 -71
  156. package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +0 -1
  157. package/models/operations/subscribersv1controllergetsubscriber.js +0 -112
  158. package/models/operations/subscribersv1controllergetsubscriber.js.map +0 -1
  159. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +0 -108
  160. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +0 -1
  161. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +0 -141
  162. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +0 -1
  163. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +0 -71
  164. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +0 -1
  165. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +0 -116
  166. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +0 -1
  167. package/models/operations/subscribersv1controllerremovesubscriber.d.ts +0 -66
  168. package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +0 -1
  169. package/models/operations/subscribersv1controllerremovesubscriber.js +0 -110
  170. package/models/operations/subscribersv1controllerremovesubscriber.js.map +0 -1
  171. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +0 -68
  172. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +0 -1
  173. package/models/operations/subscribersv1controllerupdatesubscriber.js +0 -114
  174. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +0 -1
  175. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +0 -68
  176. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +0 -1
  177. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +0 -118
  178. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +0 -1
  179. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +0 -70
  180. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +0 -1
  181. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +0 -120
  182. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +0 -1
  183. package/sdk/legacy.d.ts +0 -10
  184. package/sdk/legacy.d.ts.map +0 -1
  185. package/sdk/legacy.js +0 -19
  186. package/sdk/legacy.js.map +0 -1
  187. package/src/funcs/subscribersDeleteLegacy.ts +0 -200
  188. package/src/funcs/subscribersPreferencesLegacyUpdateGlobal.ts +0 -211
  189. package/src/funcs/subscribersPreferencesListLegacy.ts +0 -209
  190. package/src/funcs/subscribersPreferencesRetrieveByLevelLegacy.ts +0 -205
  191. package/src/funcs/subscribersPreferencesUpdateLegacy.ts +0 -202
  192. package/src/funcs/subscribersRetrieveLegacy.ts +0 -205
  193. package/src/funcs/subscribersUpdateLegacy.ts +0 -204
  194. package/src/models/components/channelpreference.ts +0 -81
  195. package/src/models/components/deletesubscriberresponsedto.ts +0 -114
  196. package/src/models/components/getsubscriberpreferencesresponsedto.ts +0 -93
  197. package/src/models/components/notificationtriggerresponse.ts +0 -126
  198. package/src/models/components/notificationtriggervariableresponse.ts +0 -193
  199. package/src/models/components/preference.ts +0 -78
  200. package/src/models/components/templateresponse.ts +0 -105
  201. package/src/models/components/triggerreservedvariableresponse.ts +0 -116
  202. package/src/models/components/triggertypeenum.ts +0 -38
  203. package/src/models/components/updatesubscriberglobalpreferencesrequestdto.ts +0 -95
  204. package/src/models/components/updatesubscriberpreferenceglobalresponsedto.ts +0 -88
  205. package/src/models/components/updatesubscriberpreferencerequestdto.ts +0 -87
  206. package/src/models/components/updatesubscriberpreferenceresponsedto.ts +0 -93
  207. package/src/models/components/updatesubscriberrequestdto.ts +0 -124
  208. package/src/models/operations/subscribersv1controllercreatesubscriber.ts +0 -187
  209. package/src/models/operations/subscribersv1controllergetsubscriber.ts +0 -188
  210. package/src/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.ts +0 -231
  211. package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +0 -191
  212. package/src/models/operations/subscribersv1controllerremovesubscriber.ts +0 -183
  213. package/src/models/operations/subscribersv1controllerupdatesubscriber.ts +0 -191
  214. package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +0 -195
  215. package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +0 -197
  216. package/src/sdk/legacy.ts +0 -32
@@ -1,126 +0,0 @@
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
- NotificationTriggerVariableResponse,
11
- NotificationTriggerVariableResponse$inboundSchema,
12
- NotificationTriggerVariableResponse$Outbound,
13
- NotificationTriggerVariableResponse$outboundSchema,
14
- } from "./notificationtriggervariableresponse.js";
15
- import {
16
- TriggerReservedVariableResponse,
17
- TriggerReservedVariableResponse$inboundSchema,
18
- TriggerReservedVariableResponse$Outbound,
19
- TriggerReservedVariableResponse$outboundSchema,
20
- } from "./triggerreservedvariableresponse.js";
21
- import {
22
- TriggerTypeEnum,
23
- TriggerTypeEnum$inboundSchema,
24
- TriggerTypeEnum$outboundSchema,
25
- } from "./triggertypeenum.js";
26
-
27
- export type NotificationTriggerResponse = {
28
- /**
29
- * The type of the trigger
30
- */
31
- type: TriggerTypeEnum;
32
- /**
33
- * The identifier of the trigger
34
- */
35
- identifier: string;
36
- /**
37
- * The variables of the trigger
38
- */
39
- variables: Array<NotificationTriggerVariableResponse>;
40
- /**
41
- * The subscriber variables of the trigger
42
- */
43
- subscriberVariables?: Array<NotificationTriggerVariableResponse> | undefined;
44
- /**
45
- * The reserved variables of the trigger
46
- */
47
- reservedVariables?: Array<TriggerReservedVariableResponse> | undefined;
48
- };
49
-
50
- /** @internal */
51
- export const NotificationTriggerResponse$inboundSchema: z.ZodType<
52
- NotificationTriggerResponse,
53
- z.ZodTypeDef,
54
- unknown
55
- > = z.object({
56
- type: TriggerTypeEnum$inboundSchema,
57
- identifier: z.string(),
58
- variables: z.array(NotificationTriggerVariableResponse$inboundSchema),
59
- subscriberVariables: z.array(
60
- NotificationTriggerVariableResponse$inboundSchema,
61
- ).optional(),
62
- reservedVariables: z.array(TriggerReservedVariableResponse$inboundSchema)
63
- .optional(),
64
- });
65
-
66
- /** @internal */
67
- export type NotificationTriggerResponse$Outbound = {
68
- type: string;
69
- identifier: string;
70
- variables: Array<NotificationTriggerVariableResponse$Outbound>;
71
- subscriberVariables?:
72
- | Array<NotificationTriggerVariableResponse$Outbound>
73
- | undefined;
74
- reservedVariables?:
75
- | Array<TriggerReservedVariableResponse$Outbound>
76
- | undefined;
77
- };
78
-
79
- /** @internal */
80
- export const NotificationTriggerResponse$outboundSchema: z.ZodType<
81
- NotificationTriggerResponse$Outbound,
82
- z.ZodTypeDef,
83
- NotificationTriggerResponse
84
- > = z.object({
85
- type: TriggerTypeEnum$outboundSchema,
86
- identifier: z.string(),
87
- variables: z.array(NotificationTriggerVariableResponse$outboundSchema),
88
- subscriberVariables: z.array(
89
- NotificationTriggerVariableResponse$outboundSchema,
90
- ).optional(),
91
- reservedVariables: z.array(TriggerReservedVariableResponse$outboundSchema)
92
- .optional(),
93
- });
94
-
95
- /**
96
- * @internal
97
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
98
- */
99
- export namespace NotificationTriggerResponse$ {
100
- /** @deprecated use `NotificationTriggerResponse$inboundSchema` instead. */
101
- export const inboundSchema = NotificationTriggerResponse$inboundSchema;
102
- /** @deprecated use `NotificationTriggerResponse$outboundSchema` instead. */
103
- export const outboundSchema = NotificationTriggerResponse$outboundSchema;
104
- /** @deprecated use `NotificationTriggerResponse$Outbound` instead. */
105
- export type Outbound = NotificationTriggerResponse$Outbound;
106
- }
107
-
108
- export function notificationTriggerResponseToJSON(
109
- notificationTriggerResponse: NotificationTriggerResponse,
110
- ): string {
111
- return JSON.stringify(
112
- NotificationTriggerResponse$outboundSchema.parse(
113
- notificationTriggerResponse,
114
- ),
115
- );
116
- }
117
-
118
- export function notificationTriggerResponseFromJSON(
119
- jsonString: string,
120
- ): SafeParseResult<NotificationTriggerResponse, SDKValidationError> {
121
- return safeParse(
122
- jsonString,
123
- (x) => NotificationTriggerResponse$inboundSchema.parse(JSON.parse(x)),
124
- `Failed to parse 'NotificationTriggerResponse' from JSON`,
125
- );
126
- }
@@ -1,193 +0,0 @@
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 { ClosedEnum } from "../../types/enums.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
-
11
- /**
12
- * The value of the variable
13
- */
14
- export type NotificationTriggerVariableResponseValue = {};
15
-
16
- /**
17
- * The type of the variable
18
- */
19
- export const NotificationTriggerVariableResponseType = {
20
- String: "String",
21
- Array: "Array",
22
- Boolean: "Boolean",
23
- } as const;
24
- /**
25
- * The type of the variable
26
- */
27
- export type NotificationTriggerVariableResponseType = ClosedEnum<
28
- typeof NotificationTriggerVariableResponseType
29
- >;
30
-
31
- export type NotificationTriggerVariableResponse = {
32
- /**
33
- * The name of the variable
34
- */
35
- name: string;
36
- /**
37
- * The value of the variable
38
- */
39
- value?: NotificationTriggerVariableResponseValue | undefined;
40
- /**
41
- * The type of the variable
42
- */
43
- type?: NotificationTriggerVariableResponseType | undefined;
44
- };
45
-
46
- /** @internal */
47
- export const NotificationTriggerVariableResponseValue$inboundSchema: z.ZodType<
48
- NotificationTriggerVariableResponseValue,
49
- z.ZodTypeDef,
50
- unknown
51
- > = z.object({});
52
-
53
- /** @internal */
54
- export type NotificationTriggerVariableResponseValue$Outbound = {};
55
-
56
- /** @internal */
57
- export const NotificationTriggerVariableResponseValue$outboundSchema: z.ZodType<
58
- NotificationTriggerVariableResponseValue$Outbound,
59
- z.ZodTypeDef,
60
- NotificationTriggerVariableResponseValue
61
- > = z.object({});
62
-
63
- /**
64
- * @internal
65
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
66
- */
67
- export namespace NotificationTriggerVariableResponseValue$ {
68
- /** @deprecated use `NotificationTriggerVariableResponseValue$inboundSchema` instead. */
69
- export const inboundSchema =
70
- NotificationTriggerVariableResponseValue$inboundSchema;
71
- /** @deprecated use `NotificationTriggerVariableResponseValue$outboundSchema` instead. */
72
- export const outboundSchema =
73
- NotificationTriggerVariableResponseValue$outboundSchema;
74
- /** @deprecated use `NotificationTriggerVariableResponseValue$Outbound` instead. */
75
- export type Outbound = NotificationTriggerVariableResponseValue$Outbound;
76
- }
77
-
78
- export function notificationTriggerVariableResponseValueToJSON(
79
- notificationTriggerVariableResponseValue:
80
- NotificationTriggerVariableResponseValue,
81
- ): string {
82
- return JSON.stringify(
83
- NotificationTriggerVariableResponseValue$outboundSchema.parse(
84
- notificationTriggerVariableResponseValue,
85
- ),
86
- );
87
- }
88
-
89
- export function notificationTriggerVariableResponseValueFromJSON(
90
- jsonString: string,
91
- ): SafeParseResult<
92
- NotificationTriggerVariableResponseValue,
93
- SDKValidationError
94
- > {
95
- return safeParse(
96
- jsonString,
97
- (x) =>
98
- NotificationTriggerVariableResponseValue$inboundSchema.parse(
99
- JSON.parse(x),
100
- ),
101
- `Failed to parse 'NotificationTriggerVariableResponseValue' from JSON`,
102
- );
103
- }
104
-
105
- /** @internal */
106
- export const NotificationTriggerVariableResponseType$inboundSchema:
107
- z.ZodNativeEnum<typeof NotificationTriggerVariableResponseType> = z
108
- .nativeEnum(NotificationTriggerVariableResponseType);
109
-
110
- /** @internal */
111
- export const NotificationTriggerVariableResponseType$outboundSchema:
112
- z.ZodNativeEnum<typeof NotificationTriggerVariableResponseType> =
113
- NotificationTriggerVariableResponseType$inboundSchema;
114
-
115
- /**
116
- * @internal
117
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
118
- */
119
- export namespace NotificationTriggerVariableResponseType$ {
120
- /** @deprecated use `NotificationTriggerVariableResponseType$inboundSchema` instead. */
121
- export const inboundSchema =
122
- NotificationTriggerVariableResponseType$inboundSchema;
123
- /** @deprecated use `NotificationTriggerVariableResponseType$outboundSchema` instead. */
124
- export const outboundSchema =
125
- NotificationTriggerVariableResponseType$outboundSchema;
126
- }
127
-
128
- /** @internal */
129
- export const NotificationTriggerVariableResponse$inboundSchema: z.ZodType<
130
- NotificationTriggerVariableResponse,
131
- z.ZodTypeDef,
132
- unknown
133
- > = z.object({
134
- name: z.string(),
135
- value: z.lazy(() => NotificationTriggerVariableResponseValue$inboundSchema)
136
- .optional(),
137
- type: NotificationTriggerVariableResponseType$inboundSchema.optional(),
138
- });
139
-
140
- /** @internal */
141
- export type NotificationTriggerVariableResponse$Outbound = {
142
- name: string;
143
- value?: NotificationTriggerVariableResponseValue$Outbound | undefined;
144
- type?: string | undefined;
145
- };
146
-
147
- /** @internal */
148
- export const NotificationTriggerVariableResponse$outboundSchema: z.ZodType<
149
- NotificationTriggerVariableResponse$Outbound,
150
- z.ZodTypeDef,
151
- NotificationTriggerVariableResponse
152
- > = z.object({
153
- name: z.string(),
154
- value: z.lazy(() => NotificationTriggerVariableResponseValue$outboundSchema)
155
- .optional(),
156
- type: NotificationTriggerVariableResponseType$outboundSchema.optional(),
157
- });
158
-
159
- /**
160
- * @internal
161
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
162
- */
163
- export namespace NotificationTriggerVariableResponse$ {
164
- /** @deprecated use `NotificationTriggerVariableResponse$inboundSchema` instead. */
165
- export const inboundSchema =
166
- NotificationTriggerVariableResponse$inboundSchema;
167
- /** @deprecated use `NotificationTriggerVariableResponse$outboundSchema` instead. */
168
- export const outboundSchema =
169
- NotificationTriggerVariableResponse$outboundSchema;
170
- /** @deprecated use `NotificationTriggerVariableResponse$Outbound` instead. */
171
- export type Outbound = NotificationTriggerVariableResponse$Outbound;
172
- }
173
-
174
- export function notificationTriggerVariableResponseToJSON(
175
- notificationTriggerVariableResponse: NotificationTriggerVariableResponse,
176
- ): string {
177
- return JSON.stringify(
178
- NotificationTriggerVariableResponse$outboundSchema.parse(
179
- notificationTriggerVariableResponse,
180
- ),
181
- );
182
- }
183
-
184
- export function notificationTriggerVariableResponseFromJSON(
185
- jsonString: string,
186
- ): SafeParseResult<NotificationTriggerVariableResponse, SDKValidationError> {
187
- return safeParse(
188
- jsonString,
189
- (x) =>
190
- NotificationTriggerVariableResponse$inboundSchema.parse(JSON.parse(x)),
191
- `Failed to parse 'NotificationTriggerVariableResponse' from JSON`,
192
- );
193
- }
@@ -1,78 +0,0 @@
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
- PreferenceChannels,
11
- PreferenceChannels$inboundSchema,
12
- PreferenceChannels$Outbound,
13
- PreferenceChannels$outboundSchema,
14
- } from "./preferencechannels.js";
15
-
16
- export type Preference = {
17
- /**
18
- * Sets if the workflow is fully enabled for all channels or not for the subscriber.
19
- */
20
- enabled: boolean;
21
- /**
22
- * Subscriber preferences for the different channels regarding this workflow
23
- */
24
- channels: PreferenceChannels;
25
- };
26
-
27
- /** @internal */
28
- export const Preference$inboundSchema: z.ZodType<
29
- Preference,
30
- z.ZodTypeDef,
31
- unknown
32
- > = z.object({
33
- enabled: z.boolean(),
34
- channels: PreferenceChannels$inboundSchema,
35
- });
36
-
37
- /** @internal */
38
- export type Preference$Outbound = {
39
- enabled: boolean;
40
- channels: PreferenceChannels$Outbound;
41
- };
42
-
43
- /** @internal */
44
- export const Preference$outboundSchema: z.ZodType<
45
- Preference$Outbound,
46
- z.ZodTypeDef,
47
- Preference
48
- > = z.object({
49
- enabled: z.boolean(),
50
- channels: PreferenceChannels$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 Preference$ {
58
- /** @deprecated use `Preference$inboundSchema` instead. */
59
- export const inboundSchema = Preference$inboundSchema;
60
- /** @deprecated use `Preference$outboundSchema` instead. */
61
- export const outboundSchema = Preference$outboundSchema;
62
- /** @deprecated use `Preference$Outbound` instead. */
63
- export type Outbound = Preference$Outbound;
64
- }
65
-
66
- export function preferenceToJSON(preference: Preference): string {
67
- return JSON.stringify(Preference$outboundSchema.parse(preference));
68
- }
69
-
70
- export function preferenceFromJSON(
71
- jsonString: string,
72
- ): SafeParseResult<Preference, SDKValidationError> {
73
- return safeParse(
74
- jsonString,
75
- (x) => Preference$inboundSchema.parse(JSON.parse(x)),
76
- `Failed to parse 'Preference' from JSON`,
77
- );
78
- }
@@ -1,105 +0,0 @@
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
- import {
11
- NotificationTriggerResponse,
12
- NotificationTriggerResponse$inboundSchema,
13
- NotificationTriggerResponse$Outbound,
14
- NotificationTriggerResponse$outboundSchema,
15
- } from "./notificationtriggerresponse.js";
16
-
17
- export type TemplateResponse = {
18
- /**
19
- * Unique identifier of the workflow
20
- */
21
- id: string;
22
- /**
23
- * Name of the workflow
24
- */
25
- name: string;
26
- /**
27
- * Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen
28
- */
29
- critical: boolean;
30
- /**
31
- * Triggers are the events that will trigger the workflow.
32
- */
33
- triggers: Array<NotificationTriggerResponse>;
34
- };
35
-
36
- /** @internal */
37
- export const TemplateResponse$inboundSchema: z.ZodType<
38
- TemplateResponse,
39
- z.ZodTypeDef,
40
- unknown
41
- > = z.object({
42
- _id: z.string(),
43
- name: z.string(),
44
- critical: z.boolean(),
45
- triggers: z.array(NotificationTriggerResponse$inboundSchema),
46
- }).transform((v) => {
47
- return remap$(v, {
48
- "_id": "id",
49
- });
50
- });
51
-
52
- /** @internal */
53
- export type TemplateResponse$Outbound = {
54
- _id: string;
55
- name: string;
56
- critical: boolean;
57
- triggers: Array<NotificationTriggerResponse$Outbound>;
58
- };
59
-
60
- /** @internal */
61
- export const TemplateResponse$outboundSchema: z.ZodType<
62
- TemplateResponse$Outbound,
63
- z.ZodTypeDef,
64
- TemplateResponse
65
- > = z.object({
66
- id: z.string(),
67
- name: z.string(),
68
- critical: z.boolean(),
69
- triggers: z.array(NotificationTriggerResponse$outboundSchema),
70
- }).transform((v) => {
71
- return remap$(v, {
72
- id: "_id",
73
- });
74
- });
75
-
76
- /**
77
- * @internal
78
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
79
- */
80
- export namespace TemplateResponse$ {
81
- /** @deprecated use `TemplateResponse$inboundSchema` instead. */
82
- export const inboundSchema = TemplateResponse$inboundSchema;
83
- /** @deprecated use `TemplateResponse$outboundSchema` instead. */
84
- export const outboundSchema = TemplateResponse$outboundSchema;
85
- /** @deprecated use `TemplateResponse$Outbound` instead. */
86
- export type Outbound = TemplateResponse$Outbound;
87
- }
88
-
89
- export function templateResponseToJSON(
90
- templateResponse: TemplateResponse,
91
- ): string {
92
- return JSON.stringify(
93
- TemplateResponse$outboundSchema.parse(templateResponse),
94
- );
95
- }
96
-
97
- export function templateResponseFromJSON(
98
- jsonString: string,
99
- ): SafeParseResult<TemplateResponse, SDKValidationError> {
100
- return safeParse(
101
- jsonString,
102
- (x) => TemplateResponse$inboundSchema.parse(JSON.parse(x)),
103
- `Failed to parse 'TemplateResponse' from JSON`,
104
- );
105
- }
@@ -1,116 +0,0 @@
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 { ClosedEnum } from "../../types/enums.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
-
11
- /**
12
- * The type of the reserved variable
13
- */
14
- export const TriggerReservedVariableResponseType = {
15
- Tenant: "tenant",
16
- Actor: "actor",
17
- } as const;
18
- /**
19
- * The type of the reserved variable
20
- */
21
- export type TriggerReservedVariableResponseType = ClosedEnum<
22
- typeof TriggerReservedVariableResponseType
23
- >;
24
-
25
- export type TriggerReservedVariableResponse = {
26
- /**
27
- * The type of the reserved variable
28
- */
29
- type: TriggerReservedVariableResponseType;
30
- /**
31
- * The reserved variables of the trigger
32
- */
33
- variables: Array<string>;
34
- };
35
-
36
- /** @internal */
37
- export const TriggerReservedVariableResponseType$inboundSchema: z.ZodNativeEnum<
38
- typeof TriggerReservedVariableResponseType
39
- > = z.nativeEnum(TriggerReservedVariableResponseType);
40
-
41
- /** @internal */
42
- export const TriggerReservedVariableResponseType$outboundSchema:
43
- z.ZodNativeEnum<typeof TriggerReservedVariableResponseType> =
44
- TriggerReservedVariableResponseType$inboundSchema;
45
-
46
- /**
47
- * @internal
48
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
49
- */
50
- export namespace TriggerReservedVariableResponseType$ {
51
- /** @deprecated use `TriggerReservedVariableResponseType$inboundSchema` instead. */
52
- export const inboundSchema =
53
- TriggerReservedVariableResponseType$inboundSchema;
54
- /** @deprecated use `TriggerReservedVariableResponseType$outboundSchema` instead. */
55
- export const outboundSchema =
56
- TriggerReservedVariableResponseType$outboundSchema;
57
- }
58
-
59
- /** @internal */
60
- export const TriggerReservedVariableResponse$inboundSchema: z.ZodType<
61
- TriggerReservedVariableResponse,
62
- z.ZodTypeDef,
63
- unknown
64
- > = z.object({
65
- type: TriggerReservedVariableResponseType$inboundSchema,
66
- variables: z.array(z.string()),
67
- });
68
-
69
- /** @internal */
70
- export type TriggerReservedVariableResponse$Outbound = {
71
- type: string;
72
- variables: Array<string>;
73
- };
74
-
75
- /** @internal */
76
- export const TriggerReservedVariableResponse$outboundSchema: z.ZodType<
77
- TriggerReservedVariableResponse$Outbound,
78
- z.ZodTypeDef,
79
- TriggerReservedVariableResponse
80
- > = z.object({
81
- type: TriggerReservedVariableResponseType$outboundSchema,
82
- variables: z.array(z.string()),
83
- });
84
-
85
- /**
86
- * @internal
87
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
88
- */
89
- export namespace TriggerReservedVariableResponse$ {
90
- /** @deprecated use `TriggerReservedVariableResponse$inboundSchema` instead. */
91
- export const inboundSchema = TriggerReservedVariableResponse$inboundSchema;
92
- /** @deprecated use `TriggerReservedVariableResponse$outboundSchema` instead. */
93
- export const outboundSchema = TriggerReservedVariableResponse$outboundSchema;
94
- /** @deprecated use `TriggerReservedVariableResponse$Outbound` instead. */
95
- export type Outbound = TriggerReservedVariableResponse$Outbound;
96
- }
97
-
98
- export function triggerReservedVariableResponseToJSON(
99
- triggerReservedVariableResponse: TriggerReservedVariableResponse,
100
- ): string {
101
- return JSON.stringify(
102
- TriggerReservedVariableResponse$outboundSchema.parse(
103
- triggerReservedVariableResponse,
104
- ),
105
- );
106
- }
107
-
108
- export function triggerReservedVariableResponseFromJSON(
109
- jsonString: string,
110
- ): SafeParseResult<TriggerReservedVariableResponse, SDKValidationError> {
111
- return safeParse(
112
- jsonString,
113
- (x) => TriggerReservedVariableResponse$inboundSchema.parse(JSON.parse(x)),
114
- `Failed to parse 'TriggerReservedVariableResponse' from JSON`,
115
- );
116
- }
@@ -1,38 +0,0 @@
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 type of the trigger
10
- */
11
- export const TriggerTypeEnum = {
12
- Event: "event",
13
- } as const;
14
- /**
15
- * The type of the trigger
16
- */
17
- export type TriggerTypeEnum = ClosedEnum<typeof TriggerTypeEnum>;
18
-
19
- /** @internal */
20
- export const TriggerTypeEnum$inboundSchema: z.ZodNativeEnum<
21
- typeof TriggerTypeEnum
22
- > = z.nativeEnum(TriggerTypeEnum);
23
-
24
- /** @internal */
25
- export const TriggerTypeEnum$outboundSchema: z.ZodNativeEnum<
26
- typeof TriggerTypeEnum
27
- > = TriggerTypeEnum$inboundSchema;
28
-
29
- /**
30
- * @internal
31
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
32
- */
33
- export namespace TriggerTypeEnum$ {
34
- /** @deprecated use `TriggerTypeEnum$inboundSchema` instead. */
35
- export const inboundSchema = TriggerTypeEnum$inboundSchema;
36
- /** @deprecated use `TriggerTypeEnum$outboundSchema` instead. */
37
- export const outboundSchema = TriggerTypeEnum$outboundSchema;
38
- }