@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,203 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { NovuCore } from "../core.js";
6
- import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { compactMap } from "../lib/primitives.js";
9
- import { safeParse } from "../lib/schemas.js";
10
- import { RequestOptions } from "../lib/sdks.js";
11
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
- import { pathToFunc } from "../lib/url.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKError } from "../models/errors/sdkerror.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import * as operations from "../models/operations/index.js";
24
- import { Result } from "../types/fp.js";
25
-
26
- /**
27
- * Get subscriber preferences by level
28
- */
29
- export async function subscribersPreferencesRetrieveByLevel(
30
- client: NovuCore,
31
- request:
32
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
33
- options?: RequestOptions,
34
- ): Promise<
35
- Result<
36
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse,
37
- | errors.ErrorDto
38
- | errors.ErrorDto
39
- | errors.ValidationErrorDto
40
- | errors.ErrorDto
41
- | SDKError
42
- | SDKValidationError
43
- | UnexpectedClientError
44
- | InvalidRequestError
45
- | RequestAbortedError
46
- | RequestTimeoutError
47
- | ConnectionError
48
- >
49
- > {
50
- const parsed = safeParse(
51
- request,
52
- (value) =>
53
- operations
54
- .SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest$outboundSchema
55
- .parse(value),
56
- "Input validation failed",
57
- );
58
- if (!parsed.ok) {
59
- return parsed;
60
- }
61
- const payload = parsed.value;
62
- const body = null;
63
-
64
- const pathParams = {
65
- parameter: encodeSimple("parameter", payload.preferenceLevel, {
66
- explode: false,
67
- charEncoding: "percent",
68
- }),
69
- subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
70
- explode: false,
71
- charEncoding: "percent",
72
- }),
73
- };
74
-
75
- const path = pathToFunc(
76
- "/v1/subscribers/{subscriberId}/preferences/{parameter}",
77
- )(pathParams);
78
-
79
- const query = encodeFormQuery({
80
- "includeInactiveChannels": payload.includeInactiveChannels,
81
- });
82
-
83
- const headers = new Headers(compactMap({
84
- Accept: "application/json",
85
- "idempotency-key": encodeSimple(
86
- "idempotency-key",
87
- payload["idempotency-key"],
88
- { explode: false, charEncoding: "none" },
89
- ),
90
- }));
91
-
92
- const secConfig = await extractSecurity(client._options.secretKey);
93
- const securityInput = secConfig == null ? {} : { secretKey: secConfig };
94
- const requestSecurity = resolveGlobalSecurity(securityInput);
95
-
96
- const context = {
97
- operationID: "SubscribersV1Controller_getSubscriberPreferenceByLevel",
98
- oAuth2Scopes: [],
99
-
100
- resolvedSecurity: requestSecurity,
101
-
102
- securitySource: client._options.secretKey,
103
- retryConfig: options?.retries
104
- || client._options.retryConfig
105
- || {
106
- strategy: "backoff",
107
- backoff: {
108
- initialInterval: 1000,
109
- maxInterval: 30000,
110
- exponent: 1.5,
111
- maxElapsedTime: 3600000,
112
- },
113
- retryConnectionErrors: true,
114
- }
115
- || { strategy: "none" },
116
- retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
117
- };
118
-
119
- const requestRes = client._createRequest(context, {
120
- security: requestSecurity,
121
- method: "GET",
122
- baseURL: options?.serverURL,
123
- path: path,
124
- headers: headers,
125
- query: query,
126
- body: body,
127
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
128
- }, options);
129
- if (!requestRes.ok) {
130
- return requestRes;
131
- }
132
- const req = requestRes.value;
133
-
134
- const doResult = await client._do(req, {
135
- context,
136
- errorCodes: [
137
- "400",
138
- "401",
139
- "403",
140
- "404",
141
- "405",
142
- "409",
143
- "413",
144
- "414",
145
- "415",
146
- "422",
147
- "429",
148
- "4XX",
149
- "500",
150
- "503",
151
- "5XX",
152
- ],
153
- retryConfig: context.retryConfig,
154
- retryCodes: context.retryCodes,
155
- });
156
- if (!doResult.ok) {
157
- return doResult;
158
- }
159
- const response = doResult.value;
160
-
161
- const responseFields = {
162
- HttpMeta: { Response: response, Request: req },
163
- };
164
-
165
- const [result] = await M.match<
166
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse,
167
- | errors.ErrorDto
168
- | errors.ErrorDto
169
- | errors.ValidationErrorDto
170
- | errors.ErrorDto
171
- | SDKError
172
- | SDKValidationError
173
- | UnexpectedClientError
174
- | InvalidRequestError
175
- | RequestAbortedError
176
- | RequestTimeoutError
177
- | ConnectionError
178
- >(
179
- M.json(
180
- 200,
181
- operations
182
- .SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse$inboundSchema,
183
- { hdrs: true, key: "Result" },
184
- ),
185
- M.jsonErr(414, errors.ErrorDto$inboundSchema),
186
- M.jsonErr(
187
- [400, 401, 403, 404, 405, 409, 413, 415],
188
- errors.ErrorDto$inboundSchema,
189
- { hdrs: true },
190
- ),
191
- M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
192
- M.fail(429),
193
- M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
194
- M.fail(503),
195
- M.fail("4XX"),
196
- M.fail("5XX"),
197
- )(response, { extraFields: responseFields });
198
- if (!result.ok) {
199
- return result;
200
- }
201
-
202
- return result;
203
- }
@@ -1,211 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { NovuCore } from "../core.js";
6
- import { encodeJSON, encodeSimple } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { compactMap } from "../lib/primitives.js";
9
- import { safeParse } from "../lib/schemas.js";
10
- import { RequestOptions } from "../lib/sdks.js";
11
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
- import { pathToFunc } from "../lib/url.js";
13
- import * as components from "../models/components/index.js";
14
- import {
15
- ConnectionError,
16
- InvalidRequestError,
17
- RequestAbortedError,
18
- RequestTimeoutError,
19
- UnexpectedClientError,
20
- } from "../models/errors/httpclienterrors.js";
21
- import * as errors from "../models/errors/index.js";
22
- import { SDKError } from "../models/errors/sdkerror.js";
23
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
24
- import * as operations from "../models/operations/index.js";
25
- import { Result } from "../types/fp.js";
26
-
27
- /**
28
- * Update subscriber global preferences
29
- */
30
- export async function subscribersPreferencesUpdateGlobal(
31
- client: NovuCore,
32
- updateSubscriberGlobalPreferencesRequestDto:
33
- components.UpdateSubscriberGlobalPreferencesRequestDto,
34
- subscriberId: string,
35
- idempotencyKey?: string | undefined,
36
- options?: RequestOptions,
37
- ): Promise<
38
- Result<
39
- operations.SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse,
40
- | errors.ErrorDto
41
- | errors.ErrorDto
42
- | errors.ValidationErrorDto
43
- | errors.ErrorDto
44
- | SDKError
45
- | SDKValidationError
46
- | UnexpectedClientError
47
- | InvalidRequestError
48
- | RequestAbortedError
49
- | RequestTimeoutError
50
- | ConnectionError
51
- >
52
- > {
53
- const input:
54
- operations.SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest =
55
- {
56
- updateSubscriberGlobalPreferencesRequestDto:
57
- updateSubscriberGlobalPreferencesRequestDto,
58
- subscriberId: subscriberId,
59
- idempotencyKey: idempotencyKey,
60
- };
61
-
62
- const parsed = safeParse(
63
- input,
64
- (value) =>
65
- operations
66
- .SubscribersV1ControllerUpdateSubscriberGlobalPreferencesRequest$outboundSchema
67
- .parse(value),
68
- "Input validation failed",
69
- );
70
- if (!parsed.ok) {
71
- return parsed;
72
- }
73
- const payload = parsed.value;
74
- const body = encodeJSON(
75
- "body",
76
- payload.UpdateSubscriberGlobalPreferencesRequestDto,
77
- { explode: true },
78
- );
79
-
80
- const pathParams = {
81
- subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
82
- explode: false,
83
- charEncoding: "percent",
84
- }),
85
- };
86
-
87
- const path = pathToFunc("/v1/subscribers/{subscriberId}/preferences")(
88
- pathParams,
89
- );
90
-
91
- const headers = new Headers(compactMap({
92
- "Content-Type": "application/json",
93
- Accept: "application/json",
94
- "idempotency-key": encodeSimple(
95
- "idempotency-key",
96
- payload["idempotency-key"],
97
- { explode: false, charEncoding: "none" },
98
- ),
99
- }));
100
-
101
- const secConfig = await extractSecurity(client._options.secretKey);
102
- const securityInput = secConfig == null ? {} : { secretKey: secConfig };
103
- const requestSecurity = resolveGlobalSecurity(securityInput);
104
-
105
- const context = {
106
- operationID: "SubscribersV1Controller_updateSubscriberGlobalPreferences",
107
- oAuth2Scopes: [],
108
-
109
- resolvedSecurity: requestSecurity,
110
-
111
- securitySource: client._options.secretKey,
112
- retryConfig: options?.retries
113
- || client._options.retryConfig
114
- || {
115
- strategy: "backoff",
116
- backoff: {
117
- initialInterval: 1000,
118
- maxInterval: 30000,
119
- exponent: 1.5,
120
- maxElapsedTime: 3600000,
121
- },
122
- retryConnectionErrors: true,
123
- }
124
- || { strategy: "none" },
125
- retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
126
- };
127
-
128
- const requestRes = client._createRequest(context, {
129
- security: requestSecurity,
130
- method: "PATCH",
131
- baseURL: options?.serverURL,
132
- path: path,
133
- headers: headers,
134
- body: body,
135
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
136
- }, options);
137
- if (!requestRes.ok) {
138
- return requestRes;
139
- }
140
- const req = requestRes.value;
141
-
142
- const doResult = await client._do(req, {
143
- context,
144
- errorCodes: [
145
- "400",
146
- "401",
147
- "403",
148
- "404",
149
- "405",
150
- "409",
151
- "413",
152
- "414",
153
- "415",
154
- "422",
155
- "429",
156
- "4XX",
157
- "500",
158
- "503",
159
- "5XX",
160
- ],
161
- retryConfig: context.retryConfig,
162
- retryCodes: context.retryCodes,
163
- });
164
- if (!doResult.ok) {
165
- return doResult;
166
- }
167
- const response = doResult.value;
168
-
169
- const responseFields = {
170
- HttpMeta: { Response: response, Request: req },
171
- };
172
-
173
- const [result] = await M.match<
174
- operations.SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse,
175
- | errors.ErrorDto
176
- | errors.ErrorDto
177
- | errors.ValidationErrorDto
178
- | errors.ErrorDto
179
- | SDKError
180
- | SDKValidationError
181
- | UnexpectedClientError
182
- | InvalidRequestError
183
- | RequestAbortedError
184
- | RequestTimeoutError
185
- | ConnectionError
186
- >(
187
- M.json(
188
- 200,
189
- operations
190
- .SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse$inboundSchema,
191
- { hdrs: true, key: "Result" },
192
- ),
193
- M.jsonErr(414, errors.ErrorDto$inboundSchema),
194
- M.jsonErr(
195
- [400, 401, 403, 404, 405, 409, 413, 415],
196
- errors.ErrorDto$inboundSchema,
197
- { hdrs: true },
198
- ),
199
- M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
200
- M.fail(429),
201
- M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
202
- M.fail(503),
203
- M.fail("4XX"),
204
- M.fail("5XX"),
205
- )(response, { extraFields: responseFields });
206
- if (!result.ok) {
207
- return result;
208
- }
209
-
210
- return result;
211
- }
@@ -1,202 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import { NovuCore } from "../core.js";
6
- import { encodeJSON, encodeSimple } from "../lib/encodings.js";
7
- import * as M from "../lib/matchers.js";
8
- import { compactMap } from "../lib/primitives.js";
9
- import { safeParse } from "../lib/schemas.js";
10
- import { RequestOptions } from "../lib/sdks.js";
11
- import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
- import { pathToFunc } from "../lib/url.js";
13
- import {
14
- ConnectionError,
15
- InvalidRequestError,
16
- RequestAbortedError,
17
- RequestTimeoutError,
18
- UnexpectedClientError,
19
- } from "../models/errors/httpclienterrors.js";
20
- import * as errors from "../models/errors/index.js";
21
- import { SDKError } from "../models/errors/sdkerror.js";
22
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
23
- import * as operations from "../models/operations/index.js";
24
- import { Result } from "../types/fp.js";
25
-
26
- /**
27
- * Update subscriber preference
28
- */
29
- export async function subscribersPreferencesUpdateLegacy(
30
- client: NovuCore,
31
- request: operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
32
- options?: RequestOptions,
33
- ): Promise<
34
- Result<
35
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse,
36
- | errors.ErrorDto
37
- | errors.ErrorDto
38
- | errors.ValidationErrorDto
39
- | errors.ErrorDto
40
- | SDKError
41
- | SDKValidationError
42
- | UnexpectedClientError
43
- | InvalidRequestError
44
- | RequestAbortedError
45
- | RequestTimeoutError
46
- | ConnectionError
47
- >
48
- > {
49
- const parsed = safeParse(
50
- request,
51
- (value) =>
52
- operations
53
- .SubscribersV1ControllerUpdateSubscriberPreferenceRequest$outboundSchema
54
- .parse(value),
55
- "Input validation failed",
56
- );
57
- if (!parsed.ok) {
58
- return parsed;
59
- }
60
- const payload = parsed.value;
61
- const body = encodeJSON(
62
- "body",
63
- payload.UpdateSubscriberPreferenceRequestDto,
64
- { explode: true },
65
- );
66
-
67
- const pathParams = {
68
- subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
69
- explode: false,
70
- charEncoding: "percent",
71
- }),
72
- parameter: encodeSimple("parameter", payload.workflowId, {
73
- explode: false,
74
- charEncoding: "percent",
75
- }),
76
- };
77
-
78
- const path = pathToFunc(
79
- "/v1/subscribers/{subscriberId}/preferences/{parameter}",
80
- )(pathParams);
81
-
82
- const headers = new Headers(compactMap({
83
- "Content-Type": "application/json",
84
- Accept: "application/json",
85
- "idempotency-key": encodeSimple(
86
- "idempotency-key",
87
- payload["idempotency-key"],
88
- { explode: false, charEncoding: "none" },
89
- ),
90
- }));
91
-
92
- const secConfig = await extractSecurity(client._options.secretKey);
93
- const securityInput = secConfig == null ? {} : { secretKey: secConfig };
94
- const requestSecurity = resolveGlobalSecurity(securityInput);
95
-
96
- const context = {
97
- operationID: "SubscribersV1Controller_updateSubscriberPreference",
98
- oAuth2Scopes: [],
99
-
100
- resolvedSecurity: requestSecurity,
101
-
102
- securitySource: client._options.secretKey,
103
- retryConfig: options?.retries
104
- || client._options.retryConfig
105
- || {
106
- strategy: "backoff",
107
- backoff: {
108
- initialInterval: 1000,
109
- maxInterval: 30000,
110
- exponent: 1.5,
111
- maxElapsedTime: 3600000,
112
- },
113
- retryConnectionErrors: true,
114
- }
115
- || { strategy: "none" },
116
- retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
117
- };
118
-
119
- const requestRes = client._createRequest(context, {
120
- security: requestSecurity,
121
- method: "PATCH",
122
- baseURL: options?.serverURL,
123
- path: path,
124
- headers: headers,
125
- body: body,
126
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
127
- }, options);
128
- if (!requestRes.ok) {
129
- return requestRes;
130
- }
131
- const req = requestRes.value;
132
-
133
- const doResult = await client._do(req, {
134
- context,
135
- errorCodes: [
136
- "400",
137
- "401",
138
- "403",
139
- "404",
140
- "405",
141
- "409",
142
- "413",
143
- "414",
144
- "415",
145
- "422",
146
- "429",
147
- "4XX",
148
- "500",
149
- "503",
150
- "5XX",
151
- ],
152
- retryConfig: context.retryConfig,
153
- retryCodes: context.retryCodes,
154
- });
155
- if (!doResult.ok) {
156
- return doResult;
157
- }
158
- const response = doResult.value;
159
-
160
- const responseFields = {
161
- HttpMeta: { Response: response, Request: req },
162
- };
163
-
164
- const [result] = await M.match<
165
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse,
166
- | errors.ErrorDto
167
- | errors.ErrorDto
168
- | errors.ValidationErrorDto
169
- | errors.ErrorDto
170
- | SDKError
171
- | SDKValidationError
172
- | UnexpectedClientError
173
- | InvalidRequestError
174
- | RequestAbortedError
175
- | RequestTimeoutError
176
- | ConnectionError
177
- >(
178
- M.json(
179
- 200,
180
- operations
181
- .SubscribersV1ControllerUpdateSubscriberPreferenceResponse$inboundSchema,
182
- { hdrs: true, key: "Result" },
183
- ),
184
- M.jsonErr(414, errors.ErrorDto$inboundSchema),
185
- M.jsonErr(
186
- [400, 401, 403, 404, 405, 409, 413, 415],
187
- errors.ErrorDto$inboundSchema,
188
- { hdrs: true },
189
- ),
190
- M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
191
- M.fail(429),
192
- M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
193
- M.fail(503),
194
- M.fail("4XX"),
195
- M.fail("5XX"),
196
- )(response, { extraFields: responseFields });
197
- if (!result.ok) {
198
- return result;
199
- }
200
-
201
- return result;
202
- }