@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,183 +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 SubscribersV1ControllerRemoveSubscriberRequest = {
13
- subscriberId: string;
14
- /**
15
- * A header for idempotency purposes
16
- */
17
- idempotencyKey?: string | undefined;
18
- };
19
-
20
- export type SubscribersV1ControllerRemoveSubscriberResponse = {
21
- headers: { [k: string]: Array<string> };
22
- result: components.DeleteSubscriberResponseDto;
23
- };
24
-
25
- /** @internal */
26
- export const SubscribersV1ControllerRemoveSubscriberRequest$inboundSchema:
27
- z.ZodType<
28
- SubscribersV1ControllerRemoveSubscriberRequest,
29
- z.ZodTypeDef,
30
- unknown
31
- > = z.object({
32
- subscriberId: z.string(),
33
- "idempotency-key": z.string().optional(),
34
- }).transform((v) => {
35
- return remap$(v, {
36
- "idempotency-key": "idempotencyKey",
37
- });
38
- });
39
-
40
- /** @internal */
41
- export type SubscribersV1ControllerRemoveSubscriberRequest$Outbound = {
42
- subscriberId: string;
43
- "idempotency-key"?: string | undefined;
44
- };
45
-
46
- /** @internal */
47
- export const SubscribersV1ControllerRemoveSubscriberRequest$outboundSchema:
48
- z.ZodType<
49
- SubscribersV1ControllerRemoveSubscriberRequest$Outbound,
50
- z.ZodTypeDef,
51
- SubscribersV1ControllerRemoveSubscriberRequest
52
- > = z.object({
53
- subscriberId: z.string(),
54
- idempotencyKey: z.string().optional(),
55
- }).transform((v) => {
56
- return remap$(v, {
57
- idempotencyKey: "idempotency-key",
58
- });
59
- });
60
-
61
- /**
62
- * @internal
63
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
64
- */
65
- export namespace SubscribersV1ControllerRemoveSubscriberRequest$ {
66
- /** @deprecated use `SubscribersV1ControllerRemoveSubscriberRequest$inboundSchema` instead. */
67
- export const inboundSchema =
68
- SubscribersV1ControllerRemoveSubscriberRequest$inboundSchema;
69
- /** @deprecated use `SubscribersV1ControllerRemoveSubscriberRequest$outboundSchema` instead. */
70
- export const outboundSchema =
71
- SubscribersV1ControllerRemoveSubscriberRequest$outboundSchema;
72
- /** @deprecated use `SubscribersV1ControllerRemoveSubscriberRequest$Outbound` instead. */
73
- export type Outbound =
74
- SubscribersV1ControllerRemoveSubscriberRequest$Outbound;
75
- }
76
-
77
- export function subscribersV1ControllerRemoveSubscriberRequestToJSON(
78
- subscribersV1ControllerRemoveSubscriberRequest:
79
- SubscribersV1ControllerRemoveSubscriberRequest,
80
- ): string {
81
- return JSON.stringify(
82
- SubscribersV1ControllerRemoveSubscriberRequest$outboundSchema.parse(
83
- subscribersV1ControllerRemoveSubscriberRequest,
84
- ),
85
- );
86
- }
87
-
88
- export function subscribersV1ControllerRemoveSubscriberRequestFromJSON(
89
- jsonString: string,
90
- ): SafeParseResult<
91
- SubscribersV1ControllerRemoveSubscriberRequest,
92
- SDKValidationError
93
- > {
94
- return safeParse(
95
- jsonString,
96
- (x) =>
97
- SubscribersV1ControllerRemoveSubscriberRequest$inboundSchema.parse(
98
- JSON.parse(x),
99
- ),
100
- `Failed to parse 'SubscribersV1ControllerRemoveSubscriberRequest' from JSON`,
101
- );
102
- }
103
-
104
- /** @internal */
105
- export const SubscribersV1ControllerRemoveSubscriberResponse$inboundSchema:
106
- z.ZodType<
107
- SubscribersV1ControllerRemoveSubscriberResponse,
108
- z.ZodTypeDef,
109
- unknown
110
- > = z.object({
111
- Headers: z.record(z.array(z.string())),
112
- Result: components.DeleteSubscriberResponseDto$inboundSchema,
113
- }).transform((v) => {
114
- return remap$(v, {
115
- "Headers": "headers",
116
- "Result": "result",
117
- });
118
- });
119
-
120
- /** @internal */
121
- export type SubscribersV1ControllerRemoveSubscriberResponse$Outbound = {
122
- Headers: { [k: string]: Array<string> };
123
- Result: components.DeleteSubscriberResponseDto$Outbound;
124
- };
125
-
126
- /** @internal */
127
- export const SubscribersV1ControllerRemoveSubscriberResponse$outboundSchema:
128
- z.ZodType<
129
- SubscribersV1ControllerRemoveSubscriberResponse$Outbound,
130
- z.ZodTypeDef,
131
- SubscribersV1ControllerRemoveSubscriberResponse
132
- > = z.object({
133
- headers: z.record(z.array(z.string())),
134
- result: components.DeleteSubscriberResponseDto$outboundSchema,
135
- }).transform((v) => {
136
- return remap$(v, {
137
- headers: "Headers",
138
- result: "Result",
139
- });
140
- });
141
-
142
- /**
143
- * @internal
144
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
145
- */
146
- export namespace SubscribersV1ControllerRemoveSubscriberResponse$ {
147
- /** @deprecated use `SubscribersV1ControllerRemoveSubscriberResponse$inboundSchema` instead. */
148
- export const inboundSchema =
149
- SubscribersV1ControllerRemoveSubscriberResponse$inboundSchema;
150
- /** @deprecated use `SubscribersV1ControllerRemoveSubscriberResponse$outboundSchema` instead. */
151
- export const outboundSchema =
152
- SubscribersV1ControllerRemoveSubscriberResponse$outboundSchema;
153
- /** @deprecated use `SubscribersV1ControllerRemoveSubscriberResponse$Outbound` instead. */
154
- export type Outbound =
155
- SubscribersV1ControllerRemoveSubscriberResponse$Outbound;
156
- }
157
-
158
- export function subscribersV1ControllerRemoveSubscriberResponseToJSON(
159
- subscribersV1ControllerRemoveSubscriberResponse:
160
- SubscribersV1ControllerRemoveSubscriberResponse,
161
- ): string {
162
- return JSON.stringify(
163
- SubscribersV1ControllerRemoveSubscriberResponse$outboundSchema.parse(
164
- subscribersV1ControllerRemoveSubscriberResponse,
165
- ),
166
- );
167
- }
168
-
169
- export function subscribersV1ControllerRemoveSubscriberResponseFromJSON(
170
- jsonString: string,
171
- ): SafeParseResult<
172
- SubscribersV1ControllerRemoveSubscriberResponse,
173
- SDKValidationError
174
- > {
175
- return safeParse(
176
- jsonString,
177
- (x) =>
178
- SubscribersV1ControllerRemoveSubscriberResponse$inboundSchema.parse(
179
- JSON.parse(x),
180
- ),
181
- `Failed to parse 'SubscribersV1ControllerRemoveSubscriberResponse' from JSON`,
182
- );
183
- }
@@ -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 SubscribersV1ControllerUpdateSubscriberRequest = {
13
- subscriberId: string;
14
- /**
15
- * A header for idempotency purposes
16
- */
17
- idempotencyKey?: string | undefined;
18
- updateSubscriberRequestDto: components.UpdateSubscriberRequestDto;
19
- };
20
-
21
- export type SubscribersV1ControllerUpdateSubscriberResponse = {
22
- headers: { [k: string]: Array<string> };
23
- result: components.SubscriberResponseDto;
24
- };
25
-
26
- /** @internal */
27
- export const SubscribersV1ControllerUpdateSubscriberRequest$inboundSchema:
28
- z.ZodType<
29
- SubscribersV1ControllerUpdateSubscriberRequest,
30
- z.ZodTypeDef,
31
- unknown
32
- > = z.object({
33
- subscriberId: z.string(),
34
- "idempotency-key": z.string().optional(),
35
- UpdateSubscriberRequestDto:
36
- components.UpdateSubscriberRequestDto$inboundSchema,
37
- }).transform((v) => {
38
- return remap$(v, {
39
- "idempotency-key": "idempotencyKey",
40
- "UpdateSubscriberRequestDto": "updateSubscriberRequestDto",
41
- });
42
- });
43
-
44
- /** @internal */
45
- export type SubscribersV1ControllerUpdateSubscriberRequest$Outbound = {
46
- subscriberId: string;
47
- "idempotency-key"?: string | undefined;
48
- UpdateSubscriberRequestDto: components.UpdateSubscriberRequestDto$Outbound;
49
- };
50
-
51
- /** @internal */
52
- export const SubscribersV1ControllerUpdateSubscriberRequest$outboundSchema:
53
- z.ZodType<
54
- SubscribersV1ControllerUpdateSubscriberRequest$Outbound,
55
- z.ZodTypeDef,
56
- SubscribersV1ControllerUpdateSubscriberRequest
57
- > = z.object({
58
- subscriberId: z.string(),
59
- idempotencyKey: z.string().optional(),
60
- updateSubscriberRequestDto:
61
- components.UpdateSubscriberRequestDto$outboundSchema,
62
- }).transform((v) => {
63
- return remap$(v, {
64
- idempotencyKey: "idempotency-key",
65
- updateSubscriberRequestDto: "UpdateSubscriberRequestDto",
66
- });
67
- });
68
-
69
- /**
70
- * @internal
71
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
72
- */
73
- export namespace SubscribersV1ControllerUpdateSubscriberRequest$ {
74
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberRequest$inboundSchema` instead. */
75
- export const inboundSchema =
76
- SubscribersV1ControllerUpdateSubscriberRequest$inboundSchema;
77
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberRequest$outboundSchema` instead. */
78
- export const outboundSchema =
79
- SubscribersV1ControllerUpdateSubscriberRequest$outboundSchema;
80
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberRequest$Outbound` instead. */
81
- export type Outbound =
82
- SubscribersV1ControllerUpdateSubscriberRequest$Outbound;
83
- }
84
-
85
- export function subscribersV1ControllerUpdateSubscriberRequestToJSON(
86
- subscribersV1ControllerUpdateSubscriberRequest:
87
- SubscribersV1ControllerUpdateSubscriberRequest,
88
- ): string {
89
- return JSON.stringify(
90
- SubscribersV1ControllerUpdateSubscriberRequest$outboundSchema.parse(
91
- subscribersV1ControllerUpdateSubscriberRequest,
92
- ),
93
- );
94
- }
95
-
96
- export function subscribersV1ControllerUpdateSubscriberRequestFromJSON(
97
- jsonString: string,
98
- ): SafeParseResult<
99
- SubscribersV1ControllerUpdateSubscriberRequest,
100
- SDKValidationError
101
- > {
102
- return safeParse(
103
- jsonString,
104
- (x) =>
105
- SubscribersV1ControllerUpdateSubscriberRequest$inboundSchema.parse(
106
- JSON.parse(x),
107
- ),
108
- `Failed to parse 'SubscribersV1ControllerUpdateSubscriberRequest' from JSON`,
109
- );
110
- }
111
-
112
- /** @internal */
113
- export const SubscribersV1ControllerUpdateSubscriberResponse$inboundSchema:
114
- z.ZodType<
115
- SubscribersV1ControllerUpdateSubscriberResponse,
116
- z.ZodTypeDef,
117
- unknown
118
- > = z.object({
119
- Headers: z.record(z.array(z.string())),
120
- Result: components.SubscriberResponseDto$inboundSchema,
121
- }).transform((v) => {
122
- return remap$(v, {
123
- "Headers": "headers",
124
- "Result": "result",
125
- });
126
- });
127
-
128
- /** @internal */
129
- export type SubscribersV1ControllerUpdateSubscriberResponse$Outbound = {
130
- Headers: { [k: string]: Array<string> };
131
- Result: components.SubscriberResponseDto$Outbound;
132
- };
133
-
134
- /** @internal */
135
- export const SubscribersV1ControllerUpdateSubscriberResponse$outboundSchema:
136
- z.ZodType<
137
- SubscribersV1ControllerUpdateSubscriberResponse$Outbound,
138
- z.ZodTypeDef,
139
- SubscribersV1ControllerUpdateSubscriberResponse
140
- > = z.object({
141
- headers: z.record(z.array(z.string())),
142
- result: components.SubscriberResponseDto$outboundSchema,
143
- }).transform((v) => {
144
- return remap$(v, {
145
- headers: "Headers",
146
- result: "Result",
147
- });
148
- });
149
-
150
- /**
151
- * @internal
152
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
153
- */
154
- export namespace SubscribersV1ControllerUpdateSubscriberResponse$ {
155
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberResponse$inboundSchema` instead. */
156
- export const inboundSchema =
157
- SubscribersV1ControllerUpdateSubscriberResponse$inboundSchema;
158
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberResponse$outboundSchema` instead. */
159
- export const outboundSchema =
160
- SubscribersV1ControllerUpdateSubscriberResponse$outboundSchema;
161
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberResponse$Outbound` instead. */
162
- export type Outbound =
163
- SubscribersV1ControllerUpdateSubscriberResponse$Outbound;
164
- }
165
-
166
- export function subscribersV1ControllerUpdateSubscriberResponseToJSON(
167
- subscribersV1ControllerUpdateSubscriberResponse:
168
- SubscribersV1ControllerUpdateSubscriberResponse,
169
- ): string {
170
- return JSON.stringify(
171
- SubscribersV1ControllerUpdateSubscriberResponse$outboundSchema.parse(
172
- subscribersV1ControllerUpdateSubscriberResponse,
173
- ),
174
- );
175
- }
176
-
177
- export function subscribersV1ControllerUpdateSubscriberResponseFromJSON(
178
- jsonString: string,
179
- ): SafeParseResult<
180
- SubscribersV1ControllerUpdateSubscriberResponse,
181
- SDKValidationError
182
- > {
183
- return safeParse(
184
- jsonString,
185
- (x) =>
186
- SubscribersV1ControllerUpdateSubscriberResponse$inboundSchema.parse(
187
- JSON.parse(x),
188
- ),
189
- `Failed to parse 'SubscribersV1ControllerUpdateSubscriberResponse' from JSON`,
190
- );
191
- }
@@ -1,195 +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 SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest = {
13
- subscriberId: string;
14
- /**
15
- * A header for idempotency purposes
16
- */
17
- idempotencyKey?: string | undefined;
18
- updateSubscriberGlobalPreferencesRequestDto:
19
- components.UpdateSubscriberGlobalPreferencesRequestDto;
20
- };
21
-
22
- export type SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse = {
23
- headers: { [k: string]: Array<string> };
24
- result: components.UpdateSubscriberPreferenceGlobalResponseDto;
25
- };
26
-
27
- /** @internal */
28
- export const SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$inboundSchema:
29
- z.ZodType<
30
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest,
31
- z.ZodTypeDef,
32
- unknown
33
- > = z.object({
34
- subscriberId: z.string(),
35
- "idempotency-key": z.string().optional(),
36
- UpdateSubscriberGlobalPreferencesRequestDto:
37
- components.UpdateSubscriberGlobalPreferencesRequestDto$inboundSchema,
38
- }).transform((v) => {
39
- return remap$(v, {
40
- "idempotency-key": "idempotencyKey",
41
- "UpdateSubscriberGlobalPreferencesRequestDto":
42
- "updateSubscriberGlobalPreferencesRequestDto",
43
- });
44
- });
45
-
46
- /** @internal */
47
- export type SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$Outbound =
48
- {
49
- subscriberId: string;
50
- "idempotency-key"?: string | undefined;
51
- UpdateSubscriberGlobalPreferencesRequestDto:
52
- components.UpdateSubscriberGlobalPreferencesRequestDto$Outbound;
53
- };
54
-
55
- /** @internal */
56
- export const SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$outboundSchema:
57
- z.ZodType<
58
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$Outbound,
59
- z.ZodTypeDef,
60
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest
61
- > = z.object({
62
- subscriberId: z.string(),
63
- idempotencyKey: z.string().optional(),
64
- updateSubscriberGlobalPreferencesRequestDto:
65
- components.UpdateSubscriberGlobalPreferencesRequestDto$outboundSchema,
66
- }).transform((v) => {
67
- return remap$(v, {
68
- idempotencyKey: "idempotency-key",
69
- updateSubscriberGlobalPreferencesRequestDto:
70
- "UpdateSubscriberGlobalPreferencesRequestDto",
71
- });
72
- });
73
-
74
- /**
75
- * @internal
76
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
77
- */
78
- export namespace SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$ {
79
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$inboundSchema` instead. */
80
- export const inboundSchema =
81
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$inboundSchema;
82
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$outboundSchema` instead. */
83
- export const outboundSchema =
84
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$outboundSchema;
85
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$Outbound` instead. */
86
- export type Outbound =
87
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$Outbound;
88
- }
89
-
90
- export function subscribersV1ControllerUpdateSubscriberGlobalPreferencesRequestToJSON(
91
- subscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest:
92
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest,
93
- ): string {
94
- return JSON.stringify(
95
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$outboundSchema
96
- .parse(subscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest),
97
- );
98
- }
99
-
100
- export function subscribersV1ControllerUpdateSubscriberGlobalPreferencesRequestFromJSON(
101
- jsonString: string,
102
- ): SafeParseResult<
103
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest,
104
- SDKValidationError
105
- > {
106
- return safeParse(
107
- jsonString,
108
- (x) =>
109
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$inboundSchema
110
- .parse(JSON.parse(x)),
111
- `Failed to parse 'SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest' from JSON`,
112
- );
113
- }
114
-
115
- /** @internal */
116
- export const SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$inboundSchema:
117
- z.ZodType<
118
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse,
119
- z.ZodTypeDef,
120
- unknown
121
- > = z.object({
122
- Headers: z.record(z.array(z.string())),
123
- Result:
124
- components.UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema,
125
- }).transform((v) => {
126
- return remap$(v, {
127
- "Headers": "headers",
128
- "Result": "result",
129
- });
130
- });
131
-
132
- /** @internal */
133
- export type SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$Outbound =
134
- {
135
- Headers: { [k: string]: Array<string> };
136
- Result: components.UpdateSubscriberPreferenceGlobalResponseDto$Outbound;
137
- };
138
-
139
- /** @internal */
140
- export const SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$outboundSchema:
141
- z.ZodType<
142
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$Outbound,
143
- z.ZodTypeDef,
144
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse
145
- > = z.object({
146
- headers: z.record(z.array(z.string())),
147
- result:
148
- components.UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema,
149
- }).transform((v) => {
150
- return remap$(v, {
151
- headers: "Headers",
152
- result: "Result",
153
- });
154
- });
155
-
156
- /**
157
- * @internal
158
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
159
- */
160
- export namespace SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$ {
161
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$inboundSchema` instead. */
162
- export const inboundSchema =
163
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$inboundSchema;
164
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$outboundSchema` instead. */
165
- export const outboundSchema =
166
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$outboundSchema;
167
- /** @deprecated use `SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$Outbound` instead. */
168
- export type Outbound =
169
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$Outbound;
170
- }
171
-
172
- export function subscribersV1ControllerUpdateSubscriberGlobalPreferencesResponseToJSON(
173
- subscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse:
174
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse,
175
- ): string {
176
- return JSON.stringify(
177
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$outboundSchema
178
- .parse(subscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse),
179
- );
180
- }
181
-
182
- export function subscribersV1ControllerUpdateSubscriberGlobalPreferencesResponseFromJSON(
183
- jsonString: string,
184
- ): SafeParseResult<
185
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse,
186
- SDKValidationError
187
- > {
188
- return safeParse(
189
- jsonString,
190
- (x) =>
191
- SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$inboundSchema
192
- .parse(JSON.parse(x)),
193
- `Failed to parse 'SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse' from JSON`,
194
- );
195
- }