@novu/api 0.1.5 → 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 (208) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/README.md +12 -26
  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 +5 -331
  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/subscribersPreferencesList.d.ts +4 -1
  23. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  24. package/funcs/subscribersPreferencesList.js +8 -10
  25. package/funcs/subscribersPreferencesList.js.map +1 -1
  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 -17
  47. package/sdk/preferences.d.ts.map +1 -1
  48. package/sdk/preferences.js +2 -30
  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 +2321 -6117
  55. package/src/funcs/subscribersCreate.ts +9 -9
  56. package/src/funcs/subscribersPreferencesList.ts +12 -16
  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 +2 -81
  63. package/src/sdk/subscribers.ts +24 -90
  64. package/funcs/subscribersDeleteLegacy.d.ts +0 -18
  65. package/funcs/subscribersDeleteLegacy.d.ts.map +0 -1
  66. package/funcs/subscribersDeleteLegacy.js +0 -141
  67. package/funcs/subscribersDeleteLegacy.js.map +0 -1
  68. package/funcs/subscribersPreferencesRetrieve.d.ts +0 -16
  69. package/funcs/subscribersPreferencesRetrieve.d.ts.map +0 -1
  70. package/funcs/subscribersPreferencesRetrieve.js +0 -141
  71. package/funcs/subscribersPreferencesRetrieve.js.map +0 -1
  72. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +0 -13
  73. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +0 -1
  74. package/funcs/subscribersPreferencesRetrieveByLevel.js +0 -142
  75. package/funcs/subscribersPreferencesRetrieveByLevel.js.map +0 -1
  76. package/funcs/subscribersPreferencesUpdateGlobal.d.ts +0 -14
  77. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +0 -1
  78. package/funcs/subscribersPreferencesUpdateGlobal.js +0 -140
  79. package/funcs/subscribersPreferencesUpdateGlobal.js.map +0 -1
  80. package/funcs/subscribersPreferencesUpdateLegacy.d.ts +0 -13
  81. package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +0 -1
  82. package/funcs/subscribersPreferencesUpdateLegacy.js +0 -139
  83. package/funcs/subscribersPreferencesUpdateLegacy.js.map +0 -1
  84. package/funcs/subscribersRetrieveLegacy.d.ts +0 -16
  85. package/funcs/subscribersRetrieveLegacy.d.ts.map +0 -1
  86. package/funcs/subscribersRetrieveLegacy.js +0 -144
  87. package/funcs/subscribersRetrieveLegacy.js.map +0 -1
  88. package/funcs/subscribersUpdate.d.ts +0 -17
  89. package/funcs/subscribersUpdate.d.ts.map +0 -1
  90. package/funcs/subscribersUpdate.js +0 -143
  91. package/funcs/subscribersUpdate.js.map +0 -1
  92. package/models/components/channelpreference.d.ts +0 -38
  93. package/models/components/channelpreference.d.ts.map +0 -1
  94. package/models/components/channelpreference.js +0 -62
  95. package/models/components/channelpreference.js.map +0 -1
  96. package/models/components/deletesubscriberresponsedto.d.ts +0 -66
  97. package/models/components/deletesubscriberresponsedto.d.ts.map +0 -1
  98. package/models/components/deletesubscriberresponsedto.js +0 -82
  99. package/models/components/deletesubscriberresponsedto.js.map +0 -1
  100. package/models/components/getsubscriberpreferencesresponsedto.d.ts +0 -39
  101. package/models/components/getsubscriberpreferencesresponsedto.d.ts.map +0 -1
  102. package/models/components/getsubscriberpreferencesresponsedto.js +0 -63
  103. package/models/components/getsubscriberpreferencesresponsedto.js.map +0 -1
  104. package/models/components/notificationtriggerresponse.d.ts +0 -55
  105. package/models/components/notificationtriggerresponse.d.ts.map +0 -1
  106. package/models/components/notificationtriggerresponse.js +0 -72
  107. package/models/components/notificationtriggerresponse.js.map +0 -1
  108. package/models/components/notificationtriggervariableresponse.d.ts +0 -101
  109. package/models/components/notificationtriggervariableresponse.d.ts.map +0 -1
  110. package/models/components/notificationtriggervariableresponse.js +0 -112
  111. package/models/components/notificationtriggervariableresponse.js.map +0 -1
  112. package/models/components/preference.d.ts +0 -38
  113. package/models/components/preference.d.ts.map +0 -1
  114. package/models/components/preference.js +0 -62
  115. package/models/components/preference.js.map +0 -1
  116. package/models/components/templateresponse.d.ts +0 -48
  117. package/models/components/templateresponse.d.ts.map +0 -1
  118. package/models/components/templateresponse.js +0 -75
  119. package/models/components/templateresponse.js.map +0 -1
  120. package/models/components/triggerreservedvariableresponse.d.ts +0 -69
  121. package/models/components/triggerreservedvariableresponse.d.ts.map +0 -1
  122. package/models/components/triggerreservedvariableresponse.js +0 -83
  123. package/models/components/triggerreservedvariableresponse.js.map +0 -1
  124. package/models/components/triggertypeenum.d.ts +0 -31
  125. package/models/components/triggertypeenum.d.ts.map +0 -1
  126. package/models/components/triggertypeenum.js +0 -52
  127. package/models/components/triggertypeenum.js.map +0 -1
  128. package/models/components/updatesubscriberglobalpreferencesrequestdto.d.ts +0 -38
  129. package/models/components/updatesubscriberglobalpreferencesrequestdto.d.ts.map +0 -1
  130. package/models/components/updatesubscriberglobalpreferencesrequestdto.js +0 -62
  131. package/models/components/updatesubscriberglobalpreferencesrequestdto.js.map +0 -1
  132. package/models/components/updatesubscriberpreferenceglobalresponsedto.d.ts +0 -33
  133. package/models/components/updatesubscriberpreferenceglobalresponsedto.d.ts.map +0 -1
  134. package/models/components/updatesubscriberpreferenceglobalresponsedto.js +0 -60
  135. package/models/components/updatesubscriberpreferenceglobalresponsedto.js.map +0 -1
  136. package/models/components/updatesubscriberpreferencerequestdto.d.ts +0 -38
  137. package/models/components/updatesubscriberpreferencerequestdto.d.ts.map +0 -1
  138. package/models/components/updatesubscriberpreferencerequestdto.js +0 -62
  139. package/models/components/updatesubscriberpreferencerequestdto.js.map +0 -1
  140. package/models/components/updatesubscriberpreferenceresponsedto.d.ts +0 -39
  141. package/models/components/updatesubscriberpreferenceresponsedto.d.ts.map +0 -1
  142. package/models/components/updatesubscriberpreferenceresponsedto.js +0 -63
  143. package/models/components/updatesubscriberpreferenceresponsedto.js.map +0 -1
  144. package/models/components/updatesubscriberrequestdto.d.ts +0 -72
  145. package/models/components/updatesubscriberrequestdto.d.ts.map +0 -1
  146. package/models/components/updatesubscriberrequestdto.js +0 -74
  147. package/models/components/updatesubscriberrequestdto.js.map +0 -1
  148. package/models/operations/subscribersv1controllercreatesubscriber.d.ts +0 -66
  149. package/models/operations/subscribersv1controllercreatesubscriber.d.ts.map +0 -1
  150. package/models/operations/subscribersv1controllercreatesubscriber.js +0 -112
  151. package/models/operations/subscribersv1controllercreatesubscriber.js.map +0 -1
  152. package/models/operations/subscribersv1controllergetsubscriber.d.ts +0 -71
  153. package/models/operations/subscribersv1controllergetsubscriber.d.ts.map +0 -1
  154. package/models/operations/subscribersv1controllergetsubscriber.js +0 -112
  155. package/models/operations/subscribersv1controllergetsubscriber.js.map +0 -1
  156. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts +0 -108
  157. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.d.ts.map +0 -1
  158. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js +0 -141
  159. package/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.js.map +0 -1
  160. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts +0 -71
  161. package/models/operations/subscribersv1controllerlistsubscriberpreferences.d.ts.map +0 -1
  162. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js +0 -116
  163. package/models/operations/subscribersv1controllerlistsubscriberpreferences.js.map +0 -1
  164. package/models/operations/subscribersv1controllerremovesubscriber.d.ts +0 -66
  165. package/models/operations/subscribersv1controllerremovesubscriber.d.ts.map +0 -1
  166. package/models/operations/subscribersv1controllerremovesubscriber.js +0 -110
  167. package/models/operations/subscribersv1controllerremovesubscriber.js.map +0 -1
  168. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts +0 -68
  169. package/models/operations/subscribersv1controllerupdatesubscriber.d.ts.map +0 -1
  170. package/models/operations/subscribersv1controllerupdatesubscriber.js +0 -114
  171. package/models/operations/subscribersv1controllerupdatesubscriber.js.map +0 -1
  172. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts +0 -68
  173. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.d.ts.map +0 -1
  174. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js +0 -118
  175. package/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.js.map +0 -1
  176. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts +0 -70
  177. package/models/operations/subscribersv1controllerupdatesubscriberpreference.d.ts.map +0 -1
  178. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js +0 -120
  179. package/models/operations/subscribersv1controllerupdatesubscriberpreference.js.map +0 -1
  180. package/src/funcs/subscribersDeleteLegacy.ts +0 -200
  181. package/src/funcs/subscribersPreferencesRetrieve.ts +0 -203
  182. package/src/funcs/subscribersPreferencesRetrieveByLevel.ts +0 -203
  183. package/src/funcs/subscribersPreferencesUpdateGlobal.ts +0 -211
  184. package/src/funcs/subscribersPreferencesUpdateLegacy.ts +0 -202
  185. package/src/funcs/subscribersRetrieveLegacy.ts +0 -205
  186. package/src/funcs/subscribersUpdate.ts +0 -204
  187. package/src/models/components/channelpreference.ts +0 -81
  188. package/src/models/components/deletesubscriberresponsedto.ts +0 -114
  189. package/src/models/components/getsubscriberpreferencesresponsedto.ts +0 -93
  190. package/src/models/components/notificationtriggerresponse.ts +0 -126
  191. package/src/models/components/notificationtriggervariableresponse.ts +0 -193
  192. package/src/models/components/preference.ts +0 -78
  193. package/src/models/components/templateresponse.ts +0 -105
  194. package/src/models/components/triggerreservedvariableresponse.ts +0 -116
  195. package/src/models/components/triggertypeenum.ts +0 -38
  196. package/src/models/components/updatesubscriberglobalpreferencesrequestdto.ts +0 -95
  197. package/src/models/components/updatesubscriberpreferenceglobalresponsedto.ts +0 -88
  198. package/src/models/components/updatesubscriberpreferencerequestdto.ts +0 -87
  199. package/src/models/components/updatesubscriberpreferenceresponsedto.ts +0 -93
  200. package/src/models/components/updatesubscriberrequestdto.ts +0 -124
  201. package/src/models/operations/subscribersv1controllercreatesubscriber.ts +0 -187
  202. package/src/models/operations/subscribersv1controllergetsubscriber.ts +0 -188
  203. package/src/models/operations/subscribersv1controllergetsubscriberpreferencebylevel.ts +0 -231
  204. package/src/models/operations/subscribersv1controllerlistsubscriberpreferences.ts +0 -191
  205. package/src/models/operations/subscribersv1controllerremovesubscriber.ts +0 -183
  206. package/src/models/operations/subscribersv1controllerupdatesubscriber.ts +0 -191
  207. package/src/models/operations/subscribersv1controllerupdatesubscriberglobalpreferences.ts +0 -195
  208. package/src/models/operations/subscribersv1controllerupdatesubscriberpreference.ts +0 -197
@@ -1,95 +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
- ChannelPreference,
11
- ChannelPreference$inboundSchema,
12
- ChannelPreference$Outbound,
13
- ChannelPreference$outboundSchema,
14
- } from "./channelpreference.js";
15
-
16
- export type UpdateSubscriberGlobalPreferencesRequestDto = {
17
- /**
18
- * Enable or disable the subscriber global preferences.
19
- */
20
- enabled?: boolean | undefined;
21
- /**
22
- * The subscriber global preferences for every ChannelTypeEnum.
23
- */
24
- preferences?: Array<ChannelPreference> | undefined;
25
- };
26
-
27
- /** @internal */
28
- export const UpdateSubscriberGlobalPreferencesRequestDto$inboundSchema:
29
- z.ZodType<
30
- UpdateSubscriberGlobalPreferencesRequestDto,
31
- z.ZodTypeDef,
32
- unknown
33
- > = z.object({
34
- enabled: z.boolean().optional(),
35
- preferences: z.array(ChannelPreference$inboundSchema).optional(),
36
- });
37
-
38
- /** @internal */
39
- export type UpdateSubscriberGlobalPreferencesRequestDto$Outbound = {
40
- enabled?: boolean | undefined;
41
- preferences?: Array<ChannelPreference$Outbound> | undefined;
42
- };
43
-
44
- /** @internal */
45
- export const UpdateSubscriberGlobalPreferencesRequestDto$outboundSchema:
46
- z.ZodType<
47
- UpdateSubscriberGlobalPreferencesRequestDto$Outbound,
48
- z.ZodTypeDef,
49
- UpdateSubscriberGlobalPreferencesRequestDto
50
- > = z.object({
51
- enabled: z.boolean().optional(),
52
- preferences: z.array(ChannelPreference$outboundSchema).optional(),
53
- });
54
-
55
- /**
56
- * @internal
57
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
58
- */
59
- export namespace UpdateSubscriberGlobalPreferencesRequestDto$ {
60
- /** @deprecated use `UpdateSubscriberGlobalPreferencesRequestDto$inboundSchema` instead. */
61
- export const inboundSchema =
62
- UpdateSubscriberGlobalPreferencesRequestDto$inboundSchema;
63
- /** @deprecated use `UpdateSubscriberGlobalPreferencesRequestDto$outboundSchema` instead. */
64
- export const outboundSchema =
65
- UpdateSubscriberGlobalPreferencesRequestDto$outboundSchema;
66
- /** @deprecated use `UpdateSubscriberGlobalPreferencesRequestDto$Outbound` instead. */
67
- export type Outbound = UpdateSubscriberGlobalPreferencesRequestDto$Outbound;
68
- }
69
-
70
- export function updateSubscriberGlobalPreferencesRequestDtoToJSON(
71
- updateSubscriberGlobalPreferencesRequestDto:
72
- UpdateSubscriberGlobalPreferencesRequestDto,
73
- ): string {
74
- return JSON.stringify(
75
- UpdateSubscriberGlobalPreferencesRequestDto$outboundSchema.parse(
76
- updateSubscriberGlobalPreferencesRequestDto,
77
- ),
78
- );
79
- }
80
-
81
- export function updateSubscriberGlobalPreferencesRequestDtoFromJSON(
82
- jsonString: string,
83
- ): SafeParseResult<
84
- UpdateSubscriberGlobalPreferencesRequestDto,
85
- SDKValidationError
86
- > {
87
- return safeParse(
88
- jsonString,
89
- (x) =>
90
- UpdateSubscriberGlobalPreferencesRequestDto$inboundSchema.parse(
91
- JSON.parse(x),
92
- ),
93
- `Failed to parse 'UpdateSubscriberGlobalPreferencesRequestDto' from JSON`,
94
- );
95
- }
@@ -1,88 +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
- Preference,
11
- Preference$inboundSchema,
12
- Preference$Outbound,
13
- Preference$outboundSchema,
14
- } from "./preference.js";
15
-
16
- export type UpdateSubscriberPreferenceGlobalResponseDto = {
17
- /**
18
- * The preferences of the subscriber regarding the related workflow
19
- */
20
- preference: Preference;
21
- };
22
-
23
- /** @internal */
24
- export const UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema:
25
- z.ZodType<
26
- UpdateSubscriberPreferenceGlobalResponseDto,
27
- z.ZodTypeDef,
28
- unknown
29
- > = z.object({
30
- preference: Preference$inboundSchema,
31
- });
32
-
33
- /** @internal */
34
- export type UpdateSubscriberPreferenceGlobalResponseDto$Outbound = {
35
- preference: Preference$Outbound;
36
- };
37
-
38
- /** @internal */
39
- export const UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema:
40
- z.ZodType<
41
- UpdateSubscriberPreferenceGlobalResponseDto$Outbound,
42
- z.ZodTypeDef,
43
- UpdateSubscriberPreferenceGlobalResponseDto
44
- > = z.object({
45
- preference: Preference$outboundSchema,
46
- });
47
-
48
- /**
49
- * @internal
50
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
51
- */
52
- export namespace UpdateSubscriberPreferenceGlobalResponseDto$ {
53
- /** @deprecated use `UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema` instead. */
54
- export const inboundSchema =
55
- UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema;
56
- /** @deprecated use `UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema` instead. */
57
- export const outboundSchema =
58
- UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema;
59
- /** @deprecated use `UpdateSubscriberPreferenceGlobalResponseDto$Outbound` instead. */
60
- export type Outbound = UpdateSubscriberPreferenceGlobalResponseDto$Outbound;
61
- }
62
-
63
- export function updateSubscriberPreferenceGlobalResponseDtoToJSON(
64
- updateSubscriberPreferenceGlobalResponseDto:
65
- UpdateSubscriberPreferenceGlobalResponseDto,
66
- ): string {
67
- return JSON.stringify(
68
- UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema.parse(
69
- updateSubscriberPreferenceGlobalResponseDto,
70
- ),
71
- );
72
- }
73
-
74
- export function updateSubscriberPreferenceGlobalResponseDtoFromJSON(
75
- jsonString: string,
76
- ): SafeParseResult<
77
- UpdateSubscriberPreferenceGlobalResponseDto,
78
- SDKValidationError
79
- > {
80
- return safeParse(
81
- jsonString,
82
- (x) =>
83
- UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema.parse(
84
- JSON.parse(x),
85
- ),
86
- `Failed to parse 'UpdateSubscriberPreferenceGlobalResponseDto' from JSON`,
87
- );
88
- }
@@ -1,87 +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
- ChannelPreference,
11
- ChannelPreference$inboundSchema,
12
- ChannelPreference$Outbound,
13
- ChannelPreference$outboundSchema,
14
- } from "./channelpreference.js";
15
-
16
- export type UpdateSubscriberPreferenceRequestDto = {
17
- /**
18
- * Optional preferences for each channel type in the assigned workflow.
19
- */
20
- channel?: ChannelPreference | undefined;
21
- /**
22
- * Indicates whether the workflow is fully enabled for all channels for the subscriber.
23
- */
24
- enabled?: boolean | undefined;
25
- };
26
-
27
- /** @internal */
28
- export const UpdateSubscriberPreferenceRequestDto$inboundSchema: z.ZodType<
29
- UpdateSubscriberPreferenceRequestDto,
30
- z.ZodTypeDef,
31
- unknown
32
- > = z.object({
33
- channel: ChannelPreference$inboundSchema.optional(),
34
- enabled: z.boolean().optional(),
35
- });
36
-
37
- /** @internal */
38
- export type UpdateSubscriberPreferenceRequestDto$Outbound = {
39
- channel?: ChannelPreference$Outbound | undefined;
40
- enabled?: boolean | undefined;
41
- };
42
-
43
- /** @internal */
44
- export const UpdateSubscriberPreferenceRequestDto$outboundSchema: z.ZodType<
45
- UpdateSubscriberPreferenceRequestDto$Outbound,
46
- z.ZodTypeDef,
47
- UpdateSubscriberPreferenceRequestDto
48
- > = z.object({
49
- channel: ChannelPreference$outboundSchema.optional(),
50
- enabled: z.boolean().optional(),
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 UpdateSubscriberPreferenceRequestDto$ {
58
- /** @deprecated use `UpdateSubscriberPreferenceRequestDto$inboundSchema` instead. */
59
- export const inboundSchema =
60
- UpdateSubscriberPreferenceRequestDto$inboundSchema;
61
- /** @deprecated use `UpdateSubscriberPreferenceRequestDto$outboundSchema` instead. */
62
- export const outboundSchema =
63
- UpdateSubscriberPreferenceRequestDto$outboundSchema;
64
- /** @deprecated use `UpdateSubscriberPreferenceRequestDto$Outbound` instead. */
65
- export type Outbound = UpdateSubscriberPreferenceRequestDto$Outbound;
66
- }
67
-
68
- export function updateSubscriberPreferenceRequestDtoToJSON(
69
- updateSubscriberPreferenceRequestDto: UpdateSubscriberPreferenceRequestDto,
70
- ): string {
71
- return JSON.stringify(
72
- UpdateSubscriberPreferenceRequestDto$outboundSchema.parse(
73
- updateSubscriberPreferenceRequestDto,
74
- ),
75
- );
76
- }
77
-
78
- export function updateSubscriberPreferenceRequestDtoFromJSON(
79
- jsonString: string,
80
- ): SafeParseResult<UpdateSubscriberPreferenceRequestDto, SDKValidationError> {
81
- return safeParse(
82
- jsonString,
83
- (x) =>
84
- UpdateSubscriberPreferenceRequestDto$inboundSchema.parse(JSON.parse(x)),
85
- `Failed to parse 'UpdateSubscriberPreferenceRequestDto' from JSON`,
86
- );
87
- }
@@ -1,93 +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
- Preference,
11
- Preference$inboundSchema,
12
- Preference$Outbound,
13
- Preference$outboundSchema,
14
- } from "./preference.js";
15
- import {
16
- TemplateResponse,
17
- TemplateResponse$inboundSchema,
18
- TemplateResponse$Outbound,
19
- TemplateResponse$outboundSchema,
20
- } from "./templateresponse.js";
21
-
22
- export type UpdateSubscriberPreferenceResponseDto = {
23
- /**
24
- * The workflow information and if it is critical or not
25
- */
26
- template: TemplateResponse;
27
- /**
28
- * The preferences of the subscriber regarding the related workflow
29
- */
30
- preference: Preference;
31
- };
32
-
33
- /** @internal */
34
- export const UpdateSubscriberPreferenceResponseDto$inboundSchema: z.ZodType<
35
- UpdateSubscriberPreferenceResponseDto,
36
- z.ZodTypeDef,
37
- unknown
38
- > = z.object({
39
- template: TemplateResponse$inboundSchema,
40
- preference: Preference$inboundSchema,
41
- });
42
-
43
- /** @internal */
44
- export type UpdateSubscriberPreferenceResponseDto$Outbound = {
45
- template: TemplateResponse$Outbound;
46
- preference: Preference$Outbound;
47
- };
48
-
49
- /** @internal */
50
- export const UpdateSubscriberPreferenceResponseDto$outboundSchema: z.ZodType<
51
- UpdateSubscriberPreferenceResponseDto$Outbound,
52
- z.ZodTypeDef,
53
- UpdateSubscriberPreferenceResponseDto
54
- > = z.object({
55
- template: TemplateResponse$outboundSchema,
56
- preference: Preference$outboundSchema,
57
- });
58
-
59
- /**
60
- * @internal
61
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
62
- */
63
- export namespace UpdateSubscriberPreferenceResponseDto$ {
64
- /** @deprecated use `UpdateSubscriberPreferenceResponseDto$inboundSchema` instead. */
65
- export const inboundSchema =
66
- UpdateSubscriberPreferenceResponseDto$inboundSchema;
67
- /** @deprecated use `UpdateSubscriberPreferenceResponseDto$outboundSchema` instead. */
68
- export const outboundSchema =
69
- UpdateSubscriberPreferenceResponseDto$outboundSchema;
70
- /** @deprecated use `UpdateSubscriberPreferenceResponseDto$Outbound` instead. */
71
- export type Outbound = UpdateSubscriberPreferenceResponseDto$Outbound;
72
- }
73
-
74
- export function updateSubscriberPreferenceResponseDtoToJSON(
75
- updateSubscriberPreferenceResponseDto: UpdateSubscriberPreferenceResponseDto,
76
- ): string {
77
- return JSON.stringify(
78
- UpdateSubscriberPreferenceResponseDto$outboundSchema.parse(
79
- updateSubscriberPreferenceResponseDto,
80
- ),
81
- );
82
- }
83
-
84
- export function updateSubscriberPreferenceResponseDtoFromJSON(
85
- jsonString: string,
86
- ): SafeParseResult<UpdateSubscriberPreferenceResponseDto, SDKValidationError> {
87
- return safeParse(
88
- jsonString,
89
- (x) =>
90
- UpdateSubscriberPreferenceResponseDto$inboundSchema.parse(JSON.parse(x)),
91
- `Failed to parse 'UpdateSubscriberPreferenceResponseDto' from JSON`,
92
- );
93
- }
@@ -1,124 +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
- SubscriberChannelDto,
11
- SubscriberChannelDto$inboundSchema,
12
- SubscriberChannelDto$Outbound,
13
- SubscriberChannelDto$outboundSchema,
14
- } from "./subscriberchanneldto.js";
15
-
16
- export type UpdateSubscriberRequestDto = {
17
- /**
18
- * The email address of the subscriber.
19
- */
20
- email?: string | undefined;
21
- /**
22
- * The first name of the subscriber.
23
- */
24
- firstName?: string | undefined;
25
- /**
26
- * The last name of the subscriber.
27
- */
28
- lastName?: string | undefined;
29
- /**
30
- * The phone number of the subscriber.
31
- */
32
- phone?: string | undefined;
33
- /**
34
- * The avatar URL of the subscriber.
35
- */
36
- avatar?: string | undefined;
37
- /**
38
- * The locale of the subscriber, for example "en-US".
39
- */
40
- locale?: string | undefined;
41
- /**
42
- * Custom data associated with the subscriber. Can contain any additional properties.
43
- */
44
- data?: { [k: string]: any } | undefined;
45
- /**
46
- * An array of communication channels for the subscriber.
47
- */
48
- channels?: Array<SubscriberChannelDto> | undefined;
49
- };
50
-
51
- /** @internal */
52
- export const UpdateSubscriberRequestDto$inboundSchema: z.ZodType<
53
- UpdateSubscriberRequestDto,
54
- z.ZodTypeDef,
55
- unknown
56
- > = z.object({
57
- email: z.string().optional(),
58
- firstName: z.string().optional(),
59
- lastName: z.string().optional(),
60
- phone: z.string().optional(),
61
- avatar: z.string().optional(),
62
- locale: z.string().optional(),
63
- data: z.record(z.any()).optional(),
64
- channels: z.array(SubscriberChannelDto$inboundSchema).optional(),
65
- });
66
-
67
- /** @internal */
68
- export type UpdateSubscriberRequestDto$Outbound = {
69
- email?: string | undefined;
70
- firstName?: string | undefined;
71
- lastName?: string | undefined;
72
- phone?: string | undefined;
73
- avatar?: string | undefined;
74
- locale?: string | undefined;
75
- data?: { [k: string]: any } | undefined;
76
- channels?: Array<SubscriberChannelDto$Outbound> | undefined;
77
- };
78
-
79
- /** @internal */
80
- export const UpdateSubscriberRequestDto$outboundSchema: z.ZodType<
81
- UpdateSubscriberRequestDto$Outbound,
82
- z.ZodTypeDef,
83
- UpdateSubscriberRequestDto
84
- > = z.object({
85
- email: z.string().optional(),
86
- firstName: z.string().optional(),
87
- lastName: z.string().optional(),
88
- phone: z.string().optional(),
89
- avatar: z.string().optional(),
90
- locale: z.string().optional(),
91
- data: z.record(z.any()).optional(),
92
- channels: z.array(SubscriberChannelDto$outboundSchema).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 UpdateSubscriberRequestDto$ {
100
- /** @deprecated use `UpdateSubscriberRequestDto$inboundSchema` instead. */
101
- export const inboundSchema = UpdateSubscriberRequestDto$inboundSchema;
102
- /** @deprecated use `UpdateSubscriberRequestDto$outboundSchema` instead. */
103
- export const outboundSchema = UpdateSubscriberRequestDto$outboundSchema;
104
- /** @deprecated use `UpdateSubscriberRequestDto$Outbound` instead. */
105
- export type Outbound = UpdateSubscriberRequestDto$Outbound;
106
- }
107
-
108
- export function updateSubscriberRequestDtoToJSON(
109
- updateSubscriberRequestDto: UpdateSubscriberRequestDto,
110
- ): string {
111
- return JSON.stringify(
112
- UpdateSubscriberRequestDto$outboundSchema.parse(updateSubscriberRequestDto),
113
- );
114
- }
115
-
116
- export function updateSubscriberRequestDtoFromJSON(
117
- jsonString: string,
118
- ): SafeParseResult<UpdateSubscriberRequestDto, SDKValidationError> {
119
- return safeParse(
120
- jsonString,
121
- (x) => UpdateSubscriberRequestDto$inboundSchema.parse(JSON.parse(x)),
122
- `Failed to parse 'UpdateSubscriberRequestDto' from JSON`,
123
- );
124
- }
@@ -1,187 +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 * as components from "../components/index.js";
10
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
-
12
- export type SubscribersV1ControllerCreateSubscriberRequest = {
13
- /**
14
- * A header for idempotency purposes
15
- */
16
- idempotencyKey?: string | undefined;
17
- createSubscriberRequestDto: components.CreateSubscriberRequestDto;
18
- };
19
-
20
- export type SubscribersV1ControllerCreateSubscriberResponse = {
21
- headers: { [k: string]: Array<string> };
22
- result: components.SubscriberResponseDto;
23
- };
24
-
25
- /** @internal */
26
- export const SubscribersV1ControllerCreateSubscriberRequest$inboundSchema:
27
- z.ZodType<
28
- SubscribersV1ControllerCreateSubscriberRequest,
29
- z.ZodTypeDef,
30
- unknown
31
- > = z.object({
32
- "idempotency-key": z.string().optional(),
33
- CreateSubscriberRequestDto:
34
- components.CreateSubscriberRequestDto$inboundSchema,
35
- }).transform((v) => {
36
- return remap$(v, {
37
- "idempotency-key": "idempotencyKey",
38
- "CreateSubscriberRequestDto": "createSubscriberRequestDto",
39
- });
40
- });
41
-
42
- /** @internal */
43
- export type SubscribersV1ControllerCreateSubscriberRequest$Outbound = {
44
- "idempotency-key"?: string | undefined;
45
- CreateSubscriberRequestDto: components.CreateSubscriberRequestDto$Outbound;
46
- };
47
-
48
- /** @internal */
49
- export const SubscribersV1ControllerCreateSubscriberRequest$outboundSchema:
50
- z.ZodType<
51
- SubscribersV1ControllerCreateSubscriberRequest$Outbound,
52
- z.ZodTypeDef,
53
- SubscribersV1ControllerCreateSubscriberRequest
54
- > = z.object({
55
- idempotencyKey: z.string().optional(),
56
- createSubscriberRequestDto:
57
- components.CreateSubscriberRequestDto$outboundSchema,
58
- }).transform((v) => {
59
- return remap$(v, {
60
- idempotencyKey: "idempotency-key",
61
- createSubscriberRequestDto: "CreateSubscriberRequestDto",
62
- });
63
- });
64
-
65
- /**
66
- * @internal
67
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
68
- */
69
- export namespace SubscribersV1ControllerCreateSubscriberRequest$ {
70
- /** @deprecated use `SubscribersV1ControllerCreateSubscriberRequest$inboundSchema` instead. */
71
- export const inboundSchema =
72
- SubscribersV1ControllerCreateSubscriberRequest$inboundSchema;
73
- /** @deprecated use `SubscribersV1ControllerCreateSubscriberRequest$outboundSchema` instead. */
74
- export const outboundSchema =
75
- SubscribersV1ControllerCreateSubscriberRequest$outboundSchema;
76
- /** @deprecated use `SubscribersV1ControllerCreateSubscriberRequest$Outbound` instead. */
77
- export type Outbound =
78
- SubscribersV1ControllerCreateSubscriberRequest$Outbound;
79
- }
80
-
81
- export function subscribersV1ControllerCreateSubscriberRequestToJSON(
82
- subscribersV1ControllerCreateSubscriberRequest:
83
- SubscribersV1ControllerCreateSubscriberRequest,
84
- ): string {
85
- return JSON.stringify(
86
- SubscribersV1ControllerCreateSubscriberRequest$outboundSchema.parse(
87
- subscribersV1ControllerCreateSubscriberRequest,
88
- ),
89
- );
90
- }
91
-
92
- export function subscribersV1ControllerCreateSubscriberRequestFromJSON(
93
- jsonString: string,
94
- ): SafeParseResult<
95
- SubscribersV1ControllerCreateSubscriberRequest,
96
- SDKValidationError
97
- > {
98
- return safeParse(
99
- jsonString,
100
- (x) =>
101
- SubscribersV1ControllerCreateSubscriberRequest$inboundSchema.parse(
102
- JSON.parse(x),
103
- ),
104
- `Failed to parse 'SubscribersV1ControllerCreateSubscriberRequest' from JSON`,
105
- );
106
- }
107
-
108
- /** @internal */
109
- export const SubscribersV1ControllerCreateSubscriberResponse$inboundSchema:
110
- z.ZodType<
111
- SubscribersV1ControllerCreateSubscriberResponse,
112
- z.ZodTypeDef,
113
- unknown
114
- > = z.object({
115
- Headers: z.record(z.array(z.string())),
116
- Result: components.SubscriberResponseDto$inboundSchema,
117
- }).transform((v) => {
118
- return remap$(v, {
119
- "Headers": "headers",
120
- "Result": "result",
121
- });
122
- });
123
-
124
- /** @internal */
125
- export type SubscribersV1ControllerCreateSubscriberResponse$Outbound = {
126
- Headers: { [k: string]: Array<string> };
127
- Result: components.SubscriberResponseDto$Outbound;
128
- };
129
-
130
- /** @internal */
131
- export const SubscribersV1ControllerCreateSubscriberResponse$outboundSchema:
132
- z.ZodType<
133
- SubscribersV1ControllerCreateSubscriberResponse$Outbound,
134
- z.ZodTypeDef,
135
- SubscribersV1ControllerCreateSubscriberResponse
136
- > = z.object({
137
- headers: z.record(z.array(z.string())),
138
- result: components.SubscriberResponseDto$outboundSchema,
139
- }).transform((v) => {
140
- return remap$(v, {
141
- headers: "Headers",
142
- result: "Result",
143
- });
144
- });
145
-
146
- /**
147
- * @internal
148
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
149
- */
150
- export namespace SubscribersV1ControllerCreateSubscriberResponse$ {
151
- /** @deprecated use `SubscribersV1ControllerCreateSubscriberResponse$inboundSchema` instead. */
152
- export const inboundSchema =
153
- SubscribersV1ControllerCreateSubscriberResponse$inboundSchema;
154
- /** @deprecated use `SubscribersV1ControllerCreateSubscriberResponse$outboundSchema` instead. */
155
- export const outboundSchema =
156
- SubscribersV1ControllerCreateSubscriberResponse$outboundSchema;
157
- /** @deprecated use `SubscribersV1ControllerCreateSubscriberResponse$Outbound` instead. */
158
- export type Outbound =
159
- SubscribersV1ControllerCreateSubscriberResponse$Outbound;
160
- }
161
-
162
- export function subscribersV1ControllerCreateSubscriberResponseToJSON(
163
- subscribersV1ControllerCreateSubscriberResponse:
164
- SubscribersV1ControllerCreateSubscriberResponse,
165
- ): string {
166
- return JSON.stringify(
167
- SubscribersV1ControllerCreateSubscriberResponse$outboundSchema.parse(
168
- subscribersV1ControllerCreateSubscriberResponse,
169
- ),
170
- );
171
- }
172
-
173
- export function subscribersV1ControllerCreateSubscriberResponseFromJSON(
174
- jsonString: string,
175
- ): SafeParseResult<
176
- SubscribersV1ControllerCreateSubscriberResponse,
177
- SDKValidationError
178
- > {
179
- return safeParse(
180
- jsonString,
181
- (x) =>
182
- SubscribersV1ControllerCreateSubscriberResponse$inboundSchema.parse(
183
- JSON.parse(x),
184
- ),
185
- `Failed to parse 'SubscribersV1ControllerCreateSubscriberResponse' from JSON`,
186
- );
187
- }