@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,188 +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 SubscribersV1ControllerGetSubscriberRequest = {
13
- subscriberId: string;
14
- /**
15
- * Includes the topics associated with the subscriber
16
- */
17
- includeTopics?: boolean | undefined;
18
- /**
19
- * A header for idempotency purposes
20
- */
21
- idempotencyKey?: string | undefined;
22
- };
23
-
24
- export type SubscribersV1ControllerGetSubscriberResponse = {
25
- headers: { [k: string]: Array<string> };
26
- result: components.SubscriberResponseDto;
27
- };
28
-
29
- /** @internal */
30
- export const SubscribersV1ControllerGetSubscriberRequest$inboundSchema:
31
- z.ZodType<
32
- SubscribersV1ControllerGetSubscriberRequest,
33
- z.ZodTypeDef,
34
- unknown
35
- > = z.object({
36
- subscriberId: z.string(),
37
- includeTopics: z.boolean().optional(),
38
- "idempotency-key": z.string().optional(),
39
- }).transform((v) => {
40
- return remap$(v, {
41
- "idempotency-key": "idempotencyKey",
42
- });
43
- });
44
-
45
- /** @internal */
46
- export type SubscribersV1ControllerGetSubscriberRequest$Outbound = {
47
- subscriberId: string;
48
- includeTopics?: boolean | undefined;
49
- "idempotency-key"?: string | undefined;
50
- };
51
-
52
- /** @internal */
53
- export const SubscribersV1ControllerGetSubscriberRequest$outboundSchema:
54
- z.ZodType<
55
- SubscribersV1ControllerGetSubscriberRequest$Outbound,
56
- z.ZodTypeDef,
57
- SubscribersV1ControllerGetSubscriberRequest
58
- > = z.object({
59
- subscriberId: z.string(),
60
- includeTopics: z.boolean().optional(),
61
- idempotencyKey: z.string().optional(),
62
- }).transform((v) => {
63
- return remap$(v, {
64
- idempotencyKey: "idempotency-key",
65
- });
66
- });
67
-
68
- /**
69
- * @internal
70
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
71
- */
72
- export namespace SubscribersV1ControllerGetSubscriberRequest$ {
73
- /** @deprecated use `SubscribersV1ControllerGetSubscriberRequest$inboundSchema` instead. */
74
- export const inboundSchema =
75
- SubscribersV1ControllerGetSubscriberRequest$inboundSchema;
76
- /** @deprecated use `SubscribersV1ControllerGetSubscriberRequest$outboundSchema` instead. */
77
- export const outboundSchema =
78
- SubscribersV1ControllerGetSubscriberRequest$outboundSchema;
79
- /** @deprecated use `SubscribersV1ControllerGetSubscriberRequest$Outbound` instead. */
80
- export type Outbound = SubscribersV1ControllerGetSubscriberRequest$Outbound;
81
- }
82
-
83
- export function subscribersV1ControllerGetSubscriberRequestToJSON(
84
- subscribersV1ControllerGetSubscriberRequest:
85
- SubscribersV1ControllerGetSubscriberRequest,
86
- ): string {
87
- return JSON.stringify(
88
- SubscribersV1ControllerGetSubscriberRequest$outboundSchema.parse(
89
- subscribersV1ControllerGetSubscriberRequest,
90
- ),
91
- );
92
- }
93
-
94
- export function subscribersV1ControllerGetSubscriberRequestFromJSON(
95
- jsonString: string,
96
- ): SafeParseResult<
97
- SubscribersV1ControllerGetSubscriberRequest,
98
- SDKValidationError
99
- > {
100
- return safeParse(
101
- jsonString,
102
- (x) =>
103
- SubscribersV1ControllerGetSubscriberRequest$inboundSchema.parse(
104
- JSON.parse(x),
105
- ),
106
- `Failed to parse 'SubscribersV1ControllerGetSubscriberRequest' from JSON`,
107
- );
108
- }
109
-
110
- /** @internal */
111
- export const SubscribersV1ControllerGetSubscriberResponse$inboundSchema:
112
- z.ZodType<
113
- SubscribersV1ControllerGetSubscriberResponse,
114
- z.ZodTypeDef,
115
- unknown
116
- > = z.object({
117
- Headers: z.record(z.array(z.string())),
118
- Result: components.SubscriberResponseDto$inboundSchema,
119
- }).transform((v) => {
120
- return remap$(v, {
121
- "Headers": "headers",
122
- "Result": "result",
123
- });
124
- });
125
-
126
- /** @internal */
127
- export type SubscribersV1ControllerGetSubscriberResponse$Outbound = {
128
- Headers: { [k: string]: Array<string> };
129
- Result: components.SubscriberResponseDto$Outbound;
130
- };
131
-
132
- /** @internal */
133
- export const SubscribersV1ControllerGetSubscriberResponse$outboundSchema:
134
- z.ZodType<
135
- SubscribersV1ControllerGetSubscriberResponse$Outbound,
136
- z.ZodTypeDef,
137
- SubscribersV1ControllerGetSubscriberResponse
138
- > = z.object({
139
- headers: z.record(z.array(z.string())),
140
- result: components.SubscriberResponseDto$outboundSchema,
141
- }).transform((v) => {
142
- return remap$(v, {
143
- headers: "Headers",
144
- result: "Result",
145
- });
146
- });
147
-
148
- /**
149
- * @internal
150
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
151
- */
152
- export namespace SubscribersV1ControllerGetSubscriberResponse$ {
153
- /** @deprecated use `SubscribersV1ControllerGetSubscriberResponse$inboundSchema` instead. */
154
- export const inboundSchema =
155
- SubscribersV1ControllerGetSubscriberResponse$inboundSchema;
156
- /** @deprecated use `SubscribersV1ControllerGetSubscriberResponse$outboundSchema` instead. */
157
- export const outboundSchema =
158
- SubscribersV1ControllerGetSubscriberResponse$outboundSchema;
159
- /** @deprecated use `SubscribersV1ControllerGetSubscriberResponse$Outbound` instead. */
160
- export type Outbound = SubscribersV1ControllerGetSubscriberResponse$Outbound;
161
- }
162
-
163
- export function subscribersV1ControllerGetSubscriberResponseToJSON(
164
- subscribersV1ControllerGetSubscriberResponse:
165
- SubscribersV1ControllerGetSubscriberResponse,
166
- ): string {
167
- return JSON.stringify(
168
- SubscribersV1ControllerGetSubscriberResponse$outboundSchema.parse(
169
- subscribersV1ControllerGetSubscriberResponse,
170
- ),
171
- );
172
- }
173
-
174
- export function subscribersV1ControllerGetSubscriberResponseFromJSON(
175
- jsonString: string,
176
- ): SafeParseResult<
177
- SubscribersV1ControllerGetSubscriberResponse,
178
- SDKValidationError
179
- > {
180
- return safeParse(
181
- jsonString,
182
- (x) =>
183
- SubscribersV1ControllerGetSubscriberResponse$inboundSchema.parse(
184
- JSON.parse(x),
185
- ),
186
- `Failed to parse 'SubscribersV1ControllerGetSubscriberResponse' from JSON`,
187
- );
188
- }
@@ -1,231 +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 { ClosedEnum } from "../../types/enums.js";
9
- import { Result as SafeParseResult } from "../../types/fp.js";
10
- import * as components from "../components/index.js";
11
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
12
-
13
- /**
14
- * the preferences level to be retrieved (template / global)
15
- */
16
- export const Parameter = {
17
- Global: "global",
18
- Template: "template",
19
- } as const;
20
- /**
21
- * the preferences level to be retrieved (template / global)
22
- */
23
- export type Parameter = ClosedEnum<typeof Parameter>;
24
-
25
- export type SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest = {
26
- /**
27
- * A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true
28
- */
29
- includeInactiveChannels?: boolean | undefined;
30
- /**
31
- * the preferences level to be retrieved (template / global)
32
- */
33
- preferenceLevel: Parameter;
34
- subscriberId: string;
35
- /**
36
- * A header for idempotency purposes
37
- */
38
- idempotencyKey?: string | undefined;
39
- };
40
-
41
- export type SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse = {
42
- headers: { [k: string]: Array<string> };
43
- result: Array<components.GetSubscriberPreferencesResponseDto>;
44
- };
45
-
46
- /** @internal */
47
- export const Parameter$inboundSchema: z.ZodNativeEnum<typeof Parameter> = z
48
- .nativeEnum(Parameter);
49
-
50
- /** @internal */
51
- export const Parameter$outboundSchema: z.ZodNativeEnum<typeof Parameter> =
52
- Parameter$inboundSchema;
53
-
54
- /**
55
- * @internal
56
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
57
- */
58
- export namespace Parameter$ {
59
- /** @deprecated use `Parameter$inboundSchema` instead. */
60
- export const inboundSchema = Parameter$inboundSchema;
61
- /** @deprecated use `Parameter$outboundSchema` instead. */
62
- export const outboundSchema = Parameter$outboundSchema;
63
- }
64
-
65
- /** @internal */
66
- export const SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$inboundSchema:
67
- z.ZodType<
68
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
69
- z.ZodTypeDef,
70
- unknown
71
- > = z.object({
72
- includeInactiveChannels: z.boolean().optional(),
73
- preferenceLevel: Parameter$inboundSchema,
74
- subscriberId: z.string(),
75
- "idempotency-key": z.string().optional(),
76
- }).transform((v) => {
77
- return remap$(v, {
78
- "idempotency-key": "idempotencyKey",
79
- });
80
- });
81
-
82
- /** @internal */
83
- export type SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$Outbound =
84
- {
85
- includeInactiveChannels?: boolean | undefined;
86
- preferenceLevel: string;
87
- subscriberId: string;
88
- "idempotency-key"?: string | undefined;
89
- };
90
-
91
- /** @internal */
92
- export const SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$outboundSchema:
93
- z.ZodType<
94
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$Outbound,
95
- z.ZodTypeDef,
96
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest
97
- > = z.object({
98
- includeInactiveChannels: z.boolean().optional(),
99
- preferenceLevel: Parameter$outboundSchema,
100
- subscriberId: z.string(),
101
- idempotencyKey: z.string().optional(),
102
- }).transform((v) => {
103
- return remap$(v, {
104
- idempotencyKey: "idempotency-key",
105
- });
106
- });
107
-
108
- /**
109
- * @internal
110
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
111
- */
112
- export namespace SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$ {
113
- /** @deprecated use `SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$inboundSchema` instead. */
114
- export const inboundSchema =
115
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$inboundSchema;
116
- /** @deprecated use `SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$outboundSchema` instead. */
117
- export const outboundSchema =
118
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$outboundSchema;
119
- /** @deprecated use `SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$Outbound` instead. */
120
- export type Outbound =
121
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$Outbound;
122
- }
123
-
124
- export function subscribersV1ControllerGetSubscriberPreferenceByLevelRequestToJSON(
125
- subscribersV1ControllerGetSubscriberPreferenceByLevelRequest:
126
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
127
- ): string {
128
- return JSON.stringify(
129
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$outboundSchema
130
- .parse(subscribersV1ControllerGetSubscriberPreferenceByLevelRequest),
131
- );
132
- }
133
-
134
- export function subscribersV1ControllerGetSubscriberPreferenceByLevelRequestFromJSON(
135
- jsonString: string,
136
- ): SafeParseResult<
137
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
138
- SDKValidationError
139
- > {
140
- return safeParse(
141
- jsonString,
142
- (x) =>
143
- SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$inboundSchema
144
- .parse(JSON.parse(x)),
145
- `Failed to parse 'SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest' from JSON`,
146
- );
147
- }
148
-
149
- /** @internal */
150
- export const SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$inboundSchema:
151
- z.ZodType<
152
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse,
153
- z.ZodTypeDef,
154
- unknown
155
- > = z.object({
156
- Headers: z.record(z.array(z.string())),
157
- Result: z.array(
158
- components.GetSubscriberPreferencesResponseDto$inboundSchema,
159
- ),
160
- }).transform((v) => {
161
- return remap$(v, {
162
- "Headers": "headers",
163
- "Result": "result",
164
- });
165
- });
166
-
167
- /** @internal */
168
- export type SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$Outbound =
169
- {
170
- Headers: { [k: string]: Array<string> };
171
- Result: Array<components.GetSubscriberPreferencesResponseDto$Outbound>;
172
- };
173
-
174
- /** @internal */
175
- export const SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$outboundSchema:
176
- z.ZodType<
177
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$Outbound,
178
- z.ZodTypeDef,
179
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse
180
- > = z.object({
181
- headers: z.record(z.array(z.string())),
182
- result: z.array(
183
- components.GetSubscriberPreferencesResponseDto$outboundSchema,
184
- ),
185
- }).transform((v) => {
186
- return remap$(v, {
187
- headers: "Headers",
188
- result: "Result",
189
- });
190
- });
191
-
192
- /**
193
- * @internal
194
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
195
- */
196
- export namespace SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$ {
197
- /** @deprecated use `SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$inboundSchema` instead. */
198
- export const inboundSchema =
199
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$inboundSchema;
200
- /** @deprecated use `SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$outboundSchema` instead. */
201
- export const outboundSchema =
202
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$outboundSchema;
203
- /** @deprecated use `SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$Outbound` instead. */
204
- export type Outbound =
205
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$Outbound;
206
- }
207
-
208
- export function subscribersV1ControllerGetSubscriberPreferenceByLevelResponseToJSON(
209
- subscribersV1ControllerGetSubscriberPreferenceByLevelResponse:
210
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse,
211
- ): string {
212
- return JSON.stringify(
213
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$outboundSchema
214
- .parse(subscribersV1ControllerGetSubscriberPreferenceByLevelResponse),
215
- );
216
- }
217
-
218
- export function subscribersV1ControllerGetSubscriberPreferenceByLevelResponseFromJSON(
219
- jsonString: string,
220
- ): SafeParseResult<
221
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse,
222
- SDKValidationError
223
- > {
224
- return safeParse(
225
- jsonString,
226
- (x) =>
227
- SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$inboundSchema
228
- .parse(JSON.parse(x)),
229
- `Failed to parse 'SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse' from JSON`,
230
- );
231
- }
@@ -1,191 +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 SubscribersV1ControllerListSubscriberPreferencesRequest = {
13
- subscriberId: string;
14
- /**
15
- * A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true
16
- */
17
- includeInactiveChannels?: boolean | undefined;
18
- /**
19
- * A header for idempotency purposes
20
- */
21
- idempotencyKey?: string | undefined;
22
- };
23
-
24
- export type SubscribersV1ControllerListSubscriberPreferencesResponse = {
25
- headers: { [k: string]: Array<string> };
26
- result: Array<components.UpdateSubscriberPreferenceResponseDto>;
27
- };
28
-
29
- /** @internal */
30
- export const SubscribersV1ControllerListSubscriberPreferencesRequest$inboundSchema:
31
- z.ZodType<
32
- SubscribersV1ControllerListSubscriberPreferencesRequest,
33
- z.ZodTypeDef,
34
- unknown
35
- > = z.object({
36
- subscriberId: z.string(),
37
- includeInactiveChannels: z.boolean().optional(),
38
- "idempotency-key": z.string().optional(),
39
- }).transform((v) => {
40
- return remap$(v, {
41
- "idempotency-key": "idempotencyKey",
42
- });
43
- });
44
-
45
- /** @internal */
46
- export type SubscribersV1ControllerListSubscriberPreferencesRequest$Outbound = {
47
- subscriberId: string;
48
- includeInactiveChannels?: boolean | undefined;
49
- "idempotency-key"?: string | undefined;
50
- };
51
-
52
- /** @internal */
53
- export const SubscribersV1ControllerListSubscriberPreferencesRequest$outboundSchema:
54
- z.ZodType<
55
- SubscribersV1ControllerListSubscriberPreferencesRequest$Outbound,
56
- z.ZodTypeDef,
57
- SubscribersV1ControllerListSubscriberPreferencesRequest
58
- > = z.object({
59
- subscriberId: z.string(),
60
- includeInactiveChannels: z.boolean().optional(),
61
- idempotencyKey: z.string().optional(),
62
- }).transform((v) => {
63
- return remap$(v, {
64
- idempotencyKey: "idempotency-key",
65
- });
66
- });
67
-
68
- /**
69
- * @internal
70
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
71
- */
72
- export namespace SubscribersV1ControllerListSubscriberPreferencesRequest$ {
73
- /** @deprecated use `SubscribersV1ControllerListSubscriberPreferencesRequest$inboundSchema` instead. */
74
- export const inboundSchema =
75
- SubscribersV1ControllerListSubscriberPreferencesRequest$inboundSchema;
76
- /** @deprecated use `SubscribersV1ControllerListSubscriberPreferencesRequest$outboundSchema` instead. */
77
- export const outboundSchema =
78
- SubscribersV1ControllerListSubscriberPreferencesRequest$outboundSchema;
79
- /** @deprecated use `SubscribersV1ControllerListSubscriberPreferencesRequest$Outbound` instead. */
80
- export type Outbound =
81
- SubscribersV1ControllerListSubscriberPreferencesRequest$Outbound;
82
- }
83
-
84
- export function subscribersV1ControllerListSubscriberPreferencesRequestToJSON(
85
- subscribersV1ControllerListSubscriberPreferencesRequest:
86
- SubscribersV1ControllerListSubscriberPreferencesRequest,
87
- ): string {
88
- return JSON.stringify(
89
- SubscribersV1ControllerListSubscriberPreferencesRequest$outboundSchema
90
- .parse(subscribersV1ControllerListSubscriberPreferencesRequest),
91
- );
92
- }
93
-
94
- export function subscribersV1ControllerListSubscriberPreferencesRequestFromJSON(
95
- jsonString: string,
96
- ): SafeParseResult<
97
- SubscribersV1ControllerListSubscriberPreferencesRequest,
98
- SDKValidationError
99
- > {
100
- return safeParse(
101
- jsonString,
102
- (x) =>
103
- SubscribersV1ControllerListSubscriberPreferencesRequest$inboundSchema
104
- .parse(JSON.parse(x)),
105
- `Failed to parse 'SubscribersV1ControllerListSubscriberPreferencesRequest' from JSON`,
106
- );
107
- }
108
-
109
- /** @internal */
110
- export const SubscribersV1ControllerListSubscriberPreferencesResponse$inboundSchema:
111
- z.ZodType<
112
- SubscribersV1ControllerListSubscriberPreferencesResponse,
113
- z.ZodTypeDef,
114
- unknown
115
- > = z.object({
116
- Headers: z.record(z.array(z.string())),
117
- Result: z.array(
118
- components.UpdateSubscriberPreferenceResponseDto$inboundSchema,
119
- ),
120
- }).transform((v) => {
121
- return remap$(v, {
122
- "Headers": "headers",
123
- "Result": "result",
124
- });
125
- });
126
-
127
- /** @internal */
128
- export type SubscribersV1ControllerListSubscriberPreferencesResponse$Outbound =
129
- {
130
- Headers: { [k: string]: Array<string> };
131
- Result: Array<components.UpdateSubscriberPreferenceResponseDto$Outbound>;
132
- };
133
-
134
- /** @internal */
135
- export const SubscribersV1ControllerListSubscriberPreferencesResponse$outboundSchema:
136
- z.ZodType<
137
- SubscribersV1ControllerListSubscriberPreferencesResponse$Outbound,
138
- z.ZodTypeDef,
139
- SubscribersV1ControllerListSubscriberPreferencesResponse
140
- > = z.object({
141
- headers: z.record(z.array(z.string())),
142
- result: z.array(
143
- components.UpdateSubscriberPreferenceResponseDto$outboundSchema,
144
- ),
145
- }).transform((v) => {
146
- return remap$(v, {
147
- headers: "Headers",
148
- result: "Result",
149
- });
150
- });
151
-
152
- /**
153
- * @internal
154
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
155
- */
156
- export namespace SubscribersV1ControllerListSubscriberPreferencesResponse$ {
157
- /** @deprecated use `SubscribersV1ControllerListSubscriberPreferencesResponse$inboundSchema` instead. */
158
- export const inboundSchema =
159
- SubscribersV1ControllerListSubscriberPreferencesResponse$inboundSchema;
160
- /** @deprecated use `SubscribersV1ControllerListSubscriberPreferencesResponse$outboundSchema` instead. */
161
- export const outboundSchema =
162
- SubscribersV1ControllerListSubscriberPreferencesResponse$outboundSchema;
163
- /** @deprecated use `SubscribersV1ControllerListSubscriberPreferencesResponse$Outbound` instead. */
164
- export type Outbound =
165
- SubscribersV1ControllerListSubscriberPreferencesResponse$Outbound;
166
- }
167
-
168
- export function subscribersV1ControllerListSubscriberPreferencesResponseToJSON(
169
- subscribersV1ControllerListSubscriberPreferencesResponse:
170
- SubscribersV1ControllerListSubscriberPreferencesResponse,
171
- ): string {
172
- return JSON.stringify(
173
- SubscribersV1ControllerListSubscriberPreferencesResponse$outboundSchema
174
- .parse(subscribersV1ControllerListSubscriberPreferencesResponse),
175
- );
176
- }
177
-
178
- export function subscribersV1ControllerListSubscriberPreferencesResponseFromJSON(
179
- jsonString: string,
180
- ): SafeParseResult<
181
- SubscribersV1ControllerListSubscriberPreferencesResponse,
182
- SDKValidationError
183
- > {
184
- return safeParse(
185
- jsonString,
186
- (x) =>
187
- SubscribersV1ControllerListSubscriberPreferencesResponse$inboundSchema
188
- .parse(JSON.parse(x)),
189
- `Failed to parse 'SubscribersV1ControllerListSubscriberPreferencesResponse' from JSON`,
190
- );
191
- }