@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
@@ -28,7 +28,7 @@ import { Result } from "../types/fp.js";
28
28
  * Create subscriber
29
29
  *
30
30
  * @remarks
31
- * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
31
+ * Create subscriber with the given data
32
32
  */
33
33
  export async function subscribersCreate(
34
34
  client: NovuCore,
@@ -37,7 +37,7 @@ export async function subscribersCreate(
37
37
  options?: RequestOptions,
38
38
  ): Promise<
39
39
  Result<
40
- operations.SubscribersV1ControllerCreateSubscriberResponse,
40
+ operations.SubscribersControllerCreateSubscriberResponse,
41
41
  | errors.ErrorDto
42
42
  | errors.ErrorDto
43
43
  | errors.ValidationErrorDto
@@ -51,7 +51,7 @@ export async function subscribersCreate(
51
51
  | ConnectionError
52
52
  >
53
53
  > {
54
- const input: operations.SubscribersV1ControllerCreateSubscriberRequest = {
54
+ const input: operations.SubscribersControllerCreateSubscriberRequest = {
55
55
  createSubscriberRequestDto: createSubscriberRequestDto,
56
56
  idempotencyKey: idempotencyKey,
57
57
  };
@@ -59,7 +59,7 @@ export async function subscribersCreate(
59
59
  const parsed = safeParse(
60
60
  input,
61
61
  (value) =>
62
- operations.SubscribersV1ControllerCreateSubscriberRequest$outboundSchema
62
+ operations.SubscribersControllerCreateSubscriberRequest$outboundSchema
63
63
  .parse(value),
64
64
  "Input validation failed",
65
65
  );
@@ -71,7 +71,7 @@ export async function subscribersCreate(
71
71
  explode: true,
72
72
  });
73
73
 
74
- const path = pathToFunc("/v1/subscribers")();
74
+ const path = pathToFunc("/v2/subscribers")();
75
75
 
76
76
  const headers = new Headers(compactMap({
77
77
  "Content-Type": "application/json",
@@ -88,7 +88,7 @@ export async function subscribersCreate(
88
88
  const requestSecurity = resolveGlobalSecurity(securityInput);
89
89
 
90
90
  const context = {
91
- operationID: "SubscribersV1Controller_createSubscriber",
91
+ operationID: "SubscribersController_createSubscriber",
92
92
  oAuth2Scopes: [],
93
93
 
94
94
  resolvedSecurity: requestSecurity,
@@ -156,7 +156,7 @@ export async function subscribersCreate(
156
156
  };
157
157
 
158
158
  const [result] = await M.match<
159
- operations.SubscribersV1ControllerCreateSubscriberResponse,
159
+ operations.SubscribersControllerCreateSubscriberResponse,
160
160
  | errors.ErrorDto
161
161
  | errors.ErrorDto
162
162
  | errors.ValidationErrorDto
@@ -170,8 +170,8 @@ export async function subscribersCreate(
170
170
  | ConnectionError
171
171
  >(
172
172
  M.json(
173
- 201,
174
- operations.SubscribersV1ControllerCreateSubscriberResponse$inboundSchema,
173
+ 200,
174
+ operations.SubscribersControllerCreateSubscriberResponse$inboundSchema,
175
175
  { hdrs: true, key: "Result" },
176
176
  ),
177
177
  M.jsonErr(414, errors.ErrorDto$inboundSchema),
@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
29
29
  * @remarks
30
30
  * Get subscriber global and workflow specific preferences
31
31
  */
32
- export async function subscribersPreferencesRetrieve(
32
+ export async function subscribersPreferencesList(
33
33
  client: NovuCore,
34
34
  subscriberId: string,
35
35
  idempotencyKey?: string | undefined,
package/src/lib/config.ts CHANGED
@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
55
55
  export const SDK_METADATA = {
56
56
  language: "typescript",
57
57
  openapiDocVersion: "1.0",
58
- sdkVersion: "0.1.6",
59
- genVersion: "2.503.2",
60
- userAgent: "speakeasy-sdk/typescript 0.1.6 2.503.2 1.0 @novu/api",
58
+ sdkVersion: "0.2.0",
59
+ genVersion: "2.506.0",
60
+ userAgent: "speakeasy-sdk/typescript 0.2.0 2.506.0 1.0 @novu/api",
61
61
  } as const;
@@ -23,7 +23,6 @@ export * from "./buttontypeenum.js";
23
23
  export * from "./channelcredentials.js";
24
24
  export * from "./channelcredentialsdto.js";
25
25
  export * from "./channelctatypeenum.js";
26
- export * from "./channelpreference.js";
27
26
  export * from "./channelsettingsdto.js";
28
27
  export * from "./channeltypeenum.js";
29
28
  export * from "./createdsubscriberdto.js";
@@ -36,7 +35,6 @@ export * from "./databooleandto.js";
36
35
  export * from "./delayregularmetadata.js";
37
36
  export * from "./delayscheduledmetadata.js";
38
37
  export * from "./deletemessageresponsedto.js";
39
- export * from "./deletesubscriberresponsedto.js";
40
38
  export * from "./digestmetadatadto.js";
41
39
  export * from "./digestregularmetadata.js";
42
40
  export * from "./digesttimedconfigdto.js";
@@ -54,7 +52,6 @@ export * from "./feedresponsedto.js";
54
52
  export * from "./fieldfilterpartdto.js";
55
53
  export * from "./filtertopicsresponsedto.js";
56
54
  export * from "./getsubscriberpreferencesdto.js";
57
- export * from "./getsubscriberpreferencesresponsedto.js";
58
55
  export * from "./gettopicresponsedto.js";
59
56
  export * from "./globalpreferencedto.js";
60
57
  export * from "./integrationresponsedto.js";
@@ -79,16 +76,13 @@ export * from "./notificationstepdata.js";
79
76
  export * from "./notificationstepdto.js";
80
77
  export * from "./notificationtrigger.js";
81
78
  export * from "./notificationtriggerdto.js";
82
- export * from "./notificationtriggerresponse.js";
83
79
  export * from "./notificationtriggervariable.js";
84
- export * from "./notificationtriggervariableresponse.js";
85
80
  export * from "./ordinalenum.js";
86
81
  export * from "./ordinalvalueenum.js";
87
82
  export * from "./overrides.js";
88
83
  export * from "./patchpreferencechannelsdto.js";
89
84
  export * from "./patchsubscriberpreferencesdto.js";
90
85
  export * from "./patchsubscriberrequestdto.js";
91
- export * from "./preference.js";
92
86
  export * from "./preferencechannels.js";
93
87
  export * from "./providersidenum.js";
94
88
  export * from "./removesubscriberresponsedto.js";
@@ -103,7 +97,6 @@ export * from "./subscriberchanneldto.js";
103
97
  export * from "./subscriberfeedresponsedto.js";
104
98
  export * from "./subscriberpayloaddto.js";
105
99
  export * from "./subscriberresponsedto.js";
106
- export * from "./templateresponse.js";
107
100
  export * from "./tenantpayloaddto.js";
108
101
  export * from "./textalignenum.js";
109
102
  export * from "./timedconfig.js";
@@ -114,18 +107,11 @@ export * from "./triggereventrequestdto.js";
114
107
  export * from "./triggereventresponsedto.js";
115
108
  export * from "./triggereventtoallrequestdto.js";
116
109
  export * from "./triggerrecipientstypeenum.js";
117
- export * from "./triggerreservedvariableresponse.js";
118
- export * from "./triggertypeenum.js";
119
110
  export * from "./unseencountresponse.js";
120
111
  export * from "./updatedsubscriberdto.js";
121
112
  export * from "./updateintegrationrequestdto.js";
122
113
  export * from "./updatesubscriberchannelrequestdto.js";
123
- export * from "./updatesubscriberglobalpreferencesrequestdto.js";
124
114
  export * from "./updatesubscriberonlineflagrequestdto.js";
125
- export * from "./updatesubscriberpreferenceglobalresponsedto.js";
126
- export * from "./updatesubscriberpreferencerequestdto.js";
127
- export * from "./updatesubscriberpreferenceresponsedto.js";
128
- export * from "./updatesubscriberrequestdto.js";
129
115
  export * from "./workflowinfodto.js";
130
116
  export * from "./workflowpreferencedto.js";
131
117
  export * from "./workflowresponse.js";
@@ -93,6 +93,10 @@ export type SubscriberResponseDto = {
93
93
  * Additional custom data for the subscriber
94
94
  */
95
95
  data?: { [k: string]: any } | null | undefined;
96
+ /**
97
+ * Timezone of the subscriber
98
+ */
99
+ timezone?: string | undefined;
96
100
  };
97
101
 
98
102
  /** @internal */
@@ -120,6 +124,7 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
120
124
  updatedAt: z.string(),
121
125
  __v: z.number().optional(),
122
126
  data: z.nullable(z.record(z.any())).optional(),
127
+ timezone: z.string().optional(),
123
128
  }).transform((v) => {
124
129
  return remap$(v, {
125
130
  "_id": "id",
@@ -150,6 +155,7 @@ export type SubscriberResponseDto$Outbound = {
150
155
  updatedAt: string;
151
156
  __v?: number | undefined;
152
157
  data?: { [k: string]: any } | null | undefined;
158
+ timezone?: string | undefined;
153
159
  };
154
160
 
155
161
  /** @internal */
@@ -177,6 +183,7 @@ export const SubscriberResponseDto$outboundSchema: z.ZodType<
177
183
  updatedAt: z.string(),
178
184
  v: z.number().optional(),
179
185
  data: z.nullable(z.record(z.any())).optional(),
186
+ timezone: z.string().optional(),
180
187
  }).transform((v) => {
181
188
  return remap$(v, {
182
189
  id: "_id",
@@ -20,6 +20,7 @@ export * from "./notificationscontrollergetactivitygraphstats.js";
20
20
  export * from "./notificationscontrollergetactivitystats.js";
21
21
  export * from "./notificationscontrollergetnotification.js";
22
22
  export * from "./notificationscontrollerlistnotifications.js";
23
+ export * from "./subscriberscontrollercreatesubscriber.js";
23
24
  export * from "./subscriberscontrollergetsubscriber.js";
24
25
  export * from "./subscriberscontrollergetsubscriberpreferences.js";
25
26
  export * from "./subscriberscontrollerpatchsubscriber.js";
@@ -29,24 +30,16 @@ export * from "./subscriberscontrollerupdatesubscriberpreferences.js";
29
30
  export * from "./subscribersv1controllerbulkcreatesubscribers.js";
30
31
  export * from "./subscribersv1controllerchataccessoauth.js";
31
32
  export * from "./subscribersv1controllerchatoauthcallback.js";
32
- export * from "./subscribersv1controllercreatesubscriber.js";
33
33
  export * from "./subscribersv1controllerdeletesubscribercredentials.js";
34
34
  export * from "./subscribersv1controllergetnotificationsfeed.js";
35
- export * from "./subscribersv1controllergetsubscriber.js";
36
- export * from "./subscribersv1controllergetsubscriberpreferencebylevel.js";
37
35
  export * from "./subscribersv1controllergetunseencount.js";
38
- export * from "./subscribersv1controllerlistsubscriberpreferences.js";
39
36
  export * from "./subscribersv1controllerlistsubscribers.js";
40
37
  export * from "./subscribersv1controllermarkactionasseen.js";
41
38
  export * from "./subscribersv1controllermarkallunreadasread.js";
42
39
  export * from "./subscribersv1controllermarkmessagesas.js";
43
40
  export * from "./subscribersv1controllermodifysubscriberchannel.js";
44
- export * from "./subscribersv1controllerremovesubscriber.js";
45
- export * from "./subscribersv1controllerupdatesubscriber.js";
46
41
  export * from "./subscribersv1controllerupdatesubscriberchannel.js";
47
- export * from "./subscribersv1controllerupdatesubscriberglobalpreferences.js";
48
42
  export * from "./subscribersv1controllerupdatesubscriberonlineflag.js";
49
- export * from "./subscribersv1controllerupdatesubscriberpreference.js";
50
43
  export * from "./topicscontrollerassign.js";
51
44
  export * from "./topicscontrollercreatetopic.js";
52
45
  export * from "./topicscontrollerdeletetopic.js";
@@ -0,0 +1,185 @@
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 SubscribersControllerCreateSubscriberRequest = {
13
+ /**
14
+ * A header for idempotency purposes
15
+ */
16
+ idempotencyKey?: string | undefined;
17
+ createSubscriberRequestDto: components.CreateSubscriberRequestDto;
18
+ };
19
+
20
+ export type SubscribersControllerCreateSubscriberResponse = {
21
+ headers: { [k: string]: Array<string> };
22
+ result: components.SubscriberResponseDto;
23
+ };
24
+
25
+ /** @internal */
26
+ export const SubscribersControllerCreateSubscriberRequest$inboundSchema:
27
+ z.ZodType<
28
+ SubscribersControllerCreateSubscriberRequest,
29
+ z.ZodTypeDef,
30
+ unknown
31
+ > = z.object({
32
+ "idempotency-key": z.string().optional(),
33
+ CreateSubscriberRequestDto:
34
+ components.CreateSubscriberRequestDto$inboundSchema,
35
+ }).transform((v) => {
36
+ return remap$(v, {
37
+ "idempotency-key": "idempotencyKey",
38
+ "CreateSubscriberRequestDto": "createSubscriberRequestDto",
39
+ });
40
+ });
41
+
42
+ /** @internal */
43
+ export type SubscribersControllerCreateSubscriberRequest$Outbound = {
44
+ "idempotency-key"?: string | undefined;
45
+ CreateSubscriberRequestDto: components.CreateSubscriberRequestDto$Outbound;
46
+ };
47
+
48
+ /** @internal */
49
+ export const SubscribersControllerCreateSubscriberRequest$outboundSchema:
50
+ z.ZodType<
51
+ SubscribersControllerCreateSubscriberRequest$Outbound,
52
+ z.ZodTypeDef,
53
+ SubscribersControllerCreateSubscriberRequest
54
+ > = z.object({
55
+ idempotencyKey: z.string().optional(),
56
+ createSubscriberRequestDto:
57
+ components.CreateSubscriberRequestDto$outboundSchema,
58
+ }).transform((v) => {
59
+ return remap$(v, {
60
+ idempotencyKey: "idempotency-key",
61
+ createSubscriberRequestDto: "CreateSubscriberRequestDto",
62
+ });
63
+ });
64
+
65
+ /**
66
+ * @internal
67
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
68
+ */
69
+ export namespace SubscribersControllerCreateSubscriberRequest$ {
70
+ /** @deprecated use `SubscribersControllerCreateSubscriberRequest$inboundSchema` instead. */
71
+ export const inboundSchema =
72
+ SubscribersControllerCreateSubscriberRequest$inboundSchema;
73
+ /** @deprecated use `SubscribersControllerCreateSubscriberRequest$outboundSchema` instead. */
74
+ export const outboundSchema =
75
+ SubscribersControllerCreateSubscriberRequest$outboundSchema;
76
+ /** @deprecated use `SubscribersControllerCreateSubscriberRequest$Outbound` instead. */
77
+ export type Outbound = SubscribersControllerCreateSubscriberRequest$Outbound;
78
+ }
79
+
80
+ export function subscribersControllerCreateSubscriberRequestToJSON(
81
+ subscribersControllerCreateSubscriberRequest:
82
+ SubscribersControllerCreateSubscriberRequest,
83
+ ): string {
84
+ return JSON.stringify(
85
+ SubscribersControllerCreateSubscriberRequest$outboundSchema.parse(
86
+ subscribersControllerCreateSubscriberRequest,
87
+ ),
88
+ );
89
+ }
90
+
91
+ export function subscribersControllerCreateSubscriberRequestFromJSON(
92
+ jsonString: string,
93
+ ): SafeParseResult<
94
+ SubscribersControllerCreateSubscriberRequest,
95
+ SDKValidationError
96
+ > {
97
+ return safeParse(
98
+ jsonString,
99
+ (x) =>
100
+ SubscribersControllerCreateSubscriberRequest$inboundSchema.parse(
101
+ JSON.parse(x),
102
+ ),
103
+ `Failed to parse 'SubscribersControllerCreateSubscriberRequest' from JSON`,
104
+ );
105
+ }
106
+
107
+ /** @internal */
108
+ export const SubscribersControllerCreateSubscriberResponse$inboundSchema:
109
+ z.ZodType<
110
+ SubscribersControllerCreateSubscriberResponse,
111
+ z.ZodTypeDef,
112
+ unknown
113
+ > = z.object({
114
+ Headers: z.record(z.array(z.string())),
115
+ Result: components.SubscriberResponseDto$inboundSchema,
116
+ }).transform((v) => {
117
+ return remap$(v, {
118
+ "Headers": "headers",
119
+ "Result": "result",
120
+ });
121
+ });
122
+
123
+ /** @internal */
124
+ export type SubscribersControllerCreateSubscriberResponse$Outbound = {
125
+ Headers: { [k: string]: Array<string> };
126
+ Result: components.SubscriberResponseDto$Outbound;
127
+ };
128
+
129
+ /** @internal */
130
+ export const SubscribersControllerCreateSubscriberResponse$outboundSchema:
131
+ z.ZodType<
132
+ SubscribersControllerCreateSubscriberResponse$Outbound,
133
+ z.ZodTypeDef,
134
+ SubscribersControllerCreateSubscriberResponse
135
+ > = z.object({
136
+ headers: z.record(z.array(z.string())),
137
+ result: components.SubscriberResponseDto$outboundSchema,
138
+ }).transform((v) => {
139
+ return remap$(v, {
140
+ headers: "Headers",
141
+ result: "Result",
142
+ });
143
+ });
144
+
145
+ /**
146
+ * @internal
147
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
148
+ */
149
+ export namespace SubscribersControllerCreateSubscriberResponse$ {
150
+ /** @deprecated use `SubscribersControllerCreateSubscriberResponse$inboundSchema` instead. */
151
+ export const inboundSchema =
152
+ SubscribersControllerCreateSubscriberResponse$inboundSchema;
153
+ /** @deprecated use `SubscribersControllerCreateSubscriberResponse$outboundSchema` instead. */
154
+ export const outboundSchema =
155
+ SubscribersControllerCreateSubscriberResponse$outboundSchema;
156
+ /** @deprecated use `SubscribersControllerCreateSubscriberResponse$Outbound` instead. */
157
+ export type Outbound = SubscribersControllerCreateSubscriberResponse$Outbound;
158
+ }
159
+
160
+ export function subscribersControllerCreateSubscriberResponseToJSON(
161
+ subscribersControllerCreateSubscriberResponse:
162
+ SubscribersControllerCreateSubscriberResponse,
163
+ ): string {
164
+ return JSON.stringify(
165
+ SubscribersControllerCreateSubscriberResponse$outboundSchema.parse(
166
+ subscribersControllerCreateSubscriberResponse,
167
+ ),
168
+ );
169
+ }
170
+
171
+ export function subscribersControllerCreateSubscriberResponseFromJSON(
172
+ jsonString: string,
173
+ ): SafeParseResult<
174
+ SubscribersControllerCreateSubscriberResponse,
175
+ SDKValidationError
176
+ > {
177
+ return safeParse(
178
+ jsonString,
179
+ (x) =>
180
+ SubscribersControllerCreateSubscriberResponse$inboundSchema.parse(
181
+ JSON.parse(x),
182
+ ),
183
+ `Failed to parse 'SubscribersControllerCreateSubscriberResponse' from JSON`,
184
+ );
185
+ }
@@ -2,93 +2,26 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { subscribersPreferencesListLegacy } from "../funcs/subscribersPreferencesListLegacy.js";
6
- import { subscribersPreferencesRetrieve } from "../funcs/subscribersPreferencesRetrieve.js";
7
- import { subscribersPreferencesRetrieveByLevelLegacy } from "../funcs/subscribersPreferencesRetrieveByLevelLegacy.js";
5
+ import { subscribersPreferencesList } from "../funcs/subscribersPreferencesList.js";
8
6
  import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
9
- import { subscribersPreferencesUpdateLegacy } from "../funcs/subscribersPreferencesUpdateLegacy.js";
10
7
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
11
8
  import * as components from "../models/components/index.js";
12
9
  import * as operations from "../models/operations/index.js";
13
10
  import { unwrapAsync } from "../types/fp.js";
14
- import { Legacy } from "./legacy.js";
15
11
 
16
12
  export class Preferences extends ClientSDK {
17
- private _legacy?: Legacy;
18
- get legacy(): Legacy {
19
- return (this._legacy ??= new Legacy(this._options));
20
- }
21
-
22
- /**
23
- * Get subscriber preferences
24
- *
25
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
26
- */
27
- async listLegacy(
28
- subscriberId: string,
29
- includeInactiveChannels?: boolean | undefined,
30
- idempotencyKey?: string | undefined,
31
- options?: RequestOptions,
32
- ): Promise<
33
- operations.SubscribersV1ControllerListSubscriberPreferencesResponse
34
- > {
35
- return unwrapAsync(subscribersPreferencesListLegacy(
36
- this,
37
- subscriberId,
38
- includeInactiveChannels,
39
- idempotencyKey,
40
- options,
41
- ));
42
- }
43
-
44
- /**
45
- * Get subscriber preferences by level
46
- *
47
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
48
- */
49
- async retrieveByLevelLegacy(
50
- request:
51
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
52
- options?: RequestOptions,
53
- ): Promise<
54
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse
55
- > {
56
- return unwrapAsync(subscribersPreferencesRetrieveByLevelLegacy(
57
- this,
58
- request,
59
- options,
60
- ));
61
- }
62
-
63
- /**
64
- * Update subscriber preference
65
- */
66
- async updateLegacy(
67
- request:
68
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
69
- options?: RequestOptions,
70
- ): Promise<
71
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse
72
- > {
73
- return unwrapAsync(subscribersPreferencesUpdateLegacy(
74
- this,
75
- request,
76
- options,
77
- ));
78
- }
79
-
80
13
  /**
81
14
  * Get subscriber preferences
82
15
  *
83
16
  * @remarks
84
17
  * Get subscriber global and workflow specific preferences
85
18
  */
86
- async retrieve(
19
+ async list(
87
20
  subscriberId: string,
88
21
  idempotencyKey?: string | undefined,
89
22
  options?: RequestOptions,
90
23
  ): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse> {
91
- return unwrapAsync(subscribersPreferencesRetrieve(
24
+ return unwrapAsync(subscribersPreferencesList(
92
25
  this,
93
26
  subscriberId,
94
27
  idempotencyKey,
@@ -5,13 +5,10 @@
5
5
  import { subscribersCreate } from "../funcs/subscribersCreate.js";
6
6
  import { subscribersCreateBulk } from "../funcs/subscribersCreateBulk.js";
7
7
  import { subscribersDelete } from "../funcs/subscribersDelete.js";
8
- import { subscribersDeleteLegacy } from "../funcs/subscribersDeleteLegacy.js";
9
8
  import { subscribersList } from "../funcs/subscribersList.js";
10
9
  import { subscribersPatch } from "../funcs/subscribersPatch.js";
11
10
  import { subscribersRetrieve } from "../funcs/subscribersRetrieve.js";
12
- import { subscribersRetrieveLegacy } from "../funcs/subscribersRetrieveLegacy.js";
13
11
  import { subscribersSearch } from "../funcs/subscribersSearch.js";
14
- import { subscribersUpdateLegacy } from "../funcs/subscribersUpdateLegacy.js";
15
12
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
16
13
  import * as components from "../models/components/index.js";
17
14
  import * as operations from "../models/operations/index.js";
@@ -35,11 +32,6 @@ export class Subscribers extends ClientSDK {
35
32
  return (this._properties ??= new Properties(this._options));
36
33
  }
37
34
 
38
- private _preferences?: Preferences;
39
- get preferences(): Preferences {
40
- return (this._preferences ??= new Preferences(this._options));
41
- }
42
-
43
35
  private _notifications?: NovuNotifications;
44
36
  get notifications(): NovuNotifications {
45
37
  return (this._notifications ??= new NovuNotifications(this._options));
@@ -55,6 +47,11 @@ export class Subscribers extends ClientSDK {
55
47
  return (this._authentication ??= new Authentication(this._options));
56
48
  }
57
49
 
50
+ private _preferences?: Preferences;
51
+ get preferences(): Preferences {
52
+ return (this._preferences ??= new Preferences(this._options));
53
+ }
54
+
58
55
  /**
59
56
  * Get subscribers
60
57
  *
@@ -81,88 +78,6 @@ export class Subscribers extends ClientSDK {
81
78
  ));
82
79
  }
83
80
 
84
- /**
85
- * Create subscriber
86
- *
87
- * @remarks
88
- * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
89
- */
90
- async create(
91
- createSubscriberRequestDto: components.CreateSubscriberRequestDto,
92
- idempotencyKey?: string | undefined,
93
- options?: RequestOptions,
94
- ): Promise<operations.SubscribersV1ControllerCreateSubscriberResponse> {
95
- return unwrapAsync(subscribersCreate(
96
- this,
97
- createSubscriberRequestDto,
98
- idempotencyKey,
99
- options,
100
- ));
101
- }
102
-
103
- /**
104
- * Get subscriber
105
- *
106
- * @remarks
107
- * Get subscriber by your internal id used to identify the subscriber
108
- */
109
- async retrieveLegacy(
110
- subscriberId: string,
111
- includeTopics?: boolean | undefined,
112
- idempotencyKey?: string | undefined,
113
- options?: RequestOptions,
114
- ): Promise<operations.SubscribersV1ControllerGetSubscriberResponse> {
115
- return unwrapAsync(subscribersRetrieveLegacy(
116
- this,
117
- subscriberId,
118
- includeTopics,
119
- idempotencyKey,
120
- options,
121
- ));
122
- }
123
-
124
- /**
125
- * Update subscriber
126
- *
127
- * @remarks
128
- * Used to update the subscriber entity with new information
129
- */
130
- async updateLegacy(
131
- updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
132
- subscriberId: string,
133
- idempotencyKey?: string | undefined,
134
- options?: RequestOptions,
135
- ): Promise<operations.SubscribersV1ControllerUpdateSubscriberResponse> {
136
- return unwrapAsync(subscribersUpdateLegacy(
137
- this,
138
- updateSubscriberRequestDto,
139
- subscriberId,
140
- idempotencyKey,
141
- options,
142
- ));
143
- }
144
-
145
- /**
146
- * Delete subscriber
147
- *
148
- * @remarks
149
- * Deletes a subscriber entity from the Novu platform
150
- *
151
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
152
- */
153
- async deleteLegacy(
154
- subscriberId: string,
155
- idempotencyKey?: string | undefined,
156
- options?: RequestOptions,
157
- ): Promise<operations.SubscribersV1ControllerRemoveSubscriberResponse> {
158
- return unwrapAsync(subscribersDeleteLegacy(
159
- this,
160
- subscriberId,
161
- idempotencyKey,
162
- options,
163
- ));
164
- }
165
-
166
81
  /**
167
82
  * Bulk create subscribers
168
83
  *
@@ -198,6 +113,25 @@ export class Subscribers extends ClientSDK {
198
113
  ));
199
114
  }
200
115
 
116
+ /**
117
+ * Create subscriber
118
+ *
119
+ * @remarks
120
+ * Create subscriber with the given data
121
+ */
122
+ async create(
123
+ createSubscriberRequestDto: components.CreateSubscriberRequestDto,
124
+ idempotencyKey?: string | undefined,
125
+ options?: RequestOptions,
126
+ ): Promise<operations.SubscribersControllerCreateSubscriberResponse> {
127
+ return unwrapAsync(subscribersCreate(
128
+ this,
129
+ createSubscriberRequestDto,
130
+ idempotencyKey,
131
+ options,
132
+ ));
133
+ }
134
+
201
135
  /**
202
136
  * Get subscriber
203
137
  *