@novu/api 0.1.2 → 0.1.6

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 (134) hide show
  1. package/README.md +18 -11
  2. package/docs/sdks/legacy/README.md +86 -0
  3. package/docs/sdks/messages/README.md +2 -8
  4. package/docs/sdks/notifications/README.md +2 -6
  5. package/docs/sdks/novunotifications/README.md +0 -6
  6. package/docs/sdks/preferences/README.md +123 -37
  7. package/docs/sdks/subscribers/README.md +7 -7
  8. package/docs/sdks/topics/README.md +0 -4
  9. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts +14 -0
  10. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts.map +1 -0
  11. package/funcs/{subscribersPreferencesUpdateGlobal.js → subscribersPreferencesLegacyUpdateGlobal.js} +4 -4
  12. package/funcs/subscribersPreferencesLegacyUpdateGlobal.js.map +1 -0
  13. package/funcs/{subscribersPreferencesUpdateGlobal.d.ts → subscribersPreferencesListLegacy.d.ts} +5 -4
  14. package/funcs/subscribersPreferencesListLegacy.d.ts.map +1 -0
  15. package/funcs/{subscribersPreferencesList.js → subscribersPreferencesListLegacy.js} +6 -4
  16. package/funcs/subscribersPreferencesListLegacy.js.map +1 -0
  17. package/funcs/subscribersPreferencesRetrieve.d.ts +16 -0
  18. package/funcs/subscribersPreferencesRetrieve.d.ts.map +1 -0
  19. package/funcs/subscribersPreferencesRetrieve.js +141 -0
  20. package/funcs/subscribersPreferencesRetrieve.js.map +1 -0
  21. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts +15 -0
  22. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts.map +1 -0
  23. package/funcs/{subscribersPreferencesRetrieveByLevel.js → subscribersPreferencesRetrieveByLevelLegacy.js} +6 -4
  24. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.js.map +1 -0
  25. package/funcs/subscribersPreferencesUpdate.d.ts +6 -2
  26. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  27. package/funcs/subscribersPreferencesUpdate.js +18 -12
  28. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  29. package/funcs/subscribersPreferencesUpdateLegacy.d.ts +13 -0
  30. package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +1 -0
  31. package/funcs/subscribersPreferencesUpdateLegacy.js +139 -0
  32. package/funcs/subscribersPreferencesUpdateLegacy.js.map +1 -0
  33. package/funcs/{subscribersUpdate.d.ts → subscribersUpdateLegacy.d.ts} +2 -2
  34. package/funcs/subscribersUpdateLegacy.d.ts.map +1 -0
  35. package/funcs/{subscribersUpdate.js → subscribersUpdateLegacy.js} +4 -4
  36. package/funcs/subscribersUpdateLegacy.js.map +1 -0
  37. package/jsr.json +1 -1
  38. package/lib/config.d.ts +3 -3
  39. package/lib/config.js +3 -3
  40. package/models/components/getsubscriberpreferencesdto.d.ts +39 -0
  41. package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -0
  42. package/models/components/getsubscriberpreferencesdto.js +63 -0
  43. package/models/components/getsubscriberpreferencesdto.js.map +1 -0
  44. package/models/components/globalpreferencedto.d.ts +38 -0
  45. package/models/components/globalpreferencedto.d.ts.map +1 -0
  46. package/models/components/globalpreferencedto.js +62 -0
  47. package/models/components/globalpreferencedto.js.map +1 -0
  48. package/models/components/index.d.ts +7 -0
  49. package/models/components/index.d.ts.map +1 -1
  50. package/models/components/index.js +7 -0
  51. package/models/components/index.js.map +1 -1
  52. package/models/components/overrides.d.ts +112 -0
  53. package/models/components/overrides.d.ts.map +1 -0
  54. package/models/components/overrides.js +110 -0
  55. package/models/components/overrides.js.map +1 -0
  56. package/models/components/patchpreferencechannelsdto.d.ts +52 -0
  57. package/models/components/patchpreferencechannelsdto.d.ts.map +1 -0
  58. package/models/components/patchpreferencechannelsdto.js +76 -0
  59. package/models/components/patchpreferencechannelsdto.js.map +1 -0
  60. package/models/components/patchsubscriberpreferencesdto.d.ts +38 -0
  61. package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -0
  62. package/models/components/patchsubscriberpreferencesdto.js +62 -0
  63. package/models/components/patchsubscriberpreferencesdto.js.map +1 -0
  64. package/models/components/triggereventtoallrequestdto.d.ts +15 -15
  65. package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
  66. package/models/components/triggereventtoallrequestdto.js +20 -18
  67. package/models/components/triggereventtoallrequestdto.js.map +1 -1
  68. package/models/components/workflowinfodto.d.ts +42 -0
  69. package/models/components/workflowinfodto.d.ts.map +1 -0
  70. package/models/components/workflowinfodto.js +63 -0
  71. package/models/components/workflowinfodto.js.map +1 -0
  72. package/models/components/workflowpreferencedto.d.ts +50 -0
  73. package/models/components/workflowpreferencedto.d.ts.map +1 -0
  74. package/models/components/workflowpreferencedto.js +68 -0
  75. package/models/components/workflowpreferencedto.js.map +1 -0
  76. package/models/operations/index.d.ts +2 -0
  77. package/models/operations/index.d.ts.map +1 -1
  78. package/models/operations/index.js +2 -0
  79. package/models/operations/index.js.map +1 -1
  80. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts +66 -0
  81. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -0
  82. package/models/operations/subscriberscontrollergetsubscriberpreferences.js +110 -0
  83. package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -0
  84. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts +68 -0
  85. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts.map +1 -0
  86. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js +118 -0
  87. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js.map +1 -0
  88. package/package.json +1 -1
  89. package/sdk/legacy.d.ts +10 -0
  90. package/sdk/legacy.d.ts.map +1 -0
  91. package/sdk/legacy.js +19 -0
  92. package/sdk/legacy.js.map +1 -0
  93. package/sdk/preferences.d.ts +24 -7
  94. package/sdk/preferences.d.ts.map +1 -1
  95. package/sdk/preferences.js +35 -14
  96. package/sdk/preferences.js.map +1 -1
  97. package/sdk/subscribers.d.ts +1 -1
  98. package/sdk/subscribers.d.ts.map +1 -1
  99. package/sdk/subscribers.js +3 -3
  100. package/sdk/subscribers.js.map +1 -1
  101. package/sources/json-development.json +1225 -57
  102. package/src/funcs/{subscribersPreferencesUpdateGlobal.ts → subscribersPreferencesLegacyUpdateGlobal.ts} +1 -1
  103. package/src/funcs/{subscribersPreferencesList.ts → subscribersPreferencesListLegacy.ts} +3 -1
  104. package/src/funcs/subscribersPreferencesRetrieve.ts +203 -0
  105. package/src/funcs/{subscribersPreferencesRetrieveByLevel.ts → subscribersPreferencesRetrieveByLevelLegacy.ts} +3 -1
  106. package/src/funcs/subscribersPreferencesUpdate.ts +27 -20
  107. package/src/funcs/subscribersPreferencesUpdateLegacy.ts +202 -0
  108. package/src/funcs/{subscribersUpdate.ts → subscribersUpdateLegacy.ts} +1 -1
  109. package/src/lib/config.ts +3 -3
  110. package/src/models/components/getsubscriberpreferencesdto.ts +90 -0
  111. package/src/models/components/globalpreferencedto.ts +82 -0
  112. package/src/models/components/index.ts +7 -0
  113. package/src/models/components/overrides.ts +141 -0
  114. package/src/models/components/patchpreferencechannelsdto.ts +106 -0
  115. package/src/models/components/patchsubscriberpreferencesdto.ts +84 -0
  116. package/src/models/components/triggereventtoallrequestdto.ts +35 -24
  117. package/src/models/components/workflowinfodto.ts +81 -0
  118. package/src/models/components/workflowpreferencedto.ts +108 -0
  119. package/src/models/operations/index.ts +2 -0
  120. package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +183 -0
  121. package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts +189 -0
  122. package/src/sdk/legacy.ts +32 -0
  123. package/src/sdk/preferences.ts +58 -26
  124. package/src/sdk/subscribers.ts +3 -3
  125. package/funcs/subscribersPreferencesList.d.ts +0 -13
  126. package/funcs/subscribersPreferencesList.d.ts.map +0 -1
  127. package/funcs/subscribersPreferencesList.js.map +0 -1
  128. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +0 -13
  129. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +0 -1
  130. package/funcs/subscribersPreferencesRetrieveByLevel.js.map +0 -1
  131. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +0 -1
  132. package/funcs/subscribersPreferencesUpdateGlobal.js.map +0 -1
  133. package/funcs/subscribersUpdate.d.ts.map +0 -1
  134. package/funcs/subscribersUpdate.js.map +0 -1
@@ -0,0 +1,108 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import {
10
+ Overrides,
11
+ Overrides$inboundSchema,
12
+ Overrides$Outbound,
13
+ Overrides$outboundSchema,
14
+ } from "./overrides.js";
15
+ import {
16
+ PreferenceChannels,
17
+ PreferenceChannels$inboundSchema,
18
+ PreferenceChannels$Outbound,
19
+ PreferenceChannels$outboundSchema,
20
+ } from "./preferencechannels.js";
21
+ import {
22
+ WorkflowInfoDto,
23
+ WorkflowInfoDto$inboundSchema,
24
+ WorkflowInfoDto$Outbound,
25
+ WorkflowInfoDto$outboundSchema,
26
+ } from "./workflowinfodto.js";
27
+
28
+ export type WorkflowPreferenceDto = {
29
+ /**
30
+ * Whether notifications are enabled for this workflow
31
+ */
32
+ enabled: boolean;
33
+ /**
34
+ * Channel-specific preference settings for this workflow
35
+ */
36
+ channels: PreferenceChannels;
37
+ /**
38
+ * List of preference overrides
39
+ */
40
+ overrides: Array<Overrides>;
41
+ /**
42
+ * Workflow information
43
+ */
44
+ workflow: WorkflowInfoDto;
45
+ };
46
+
47
+ /** @internal */
48
+ export const WorkflowPreferenceDto$inboundSchema: z.ZodType<
49
+ WorkflowPreferenceDto,
50
+ z.ZodTypeDef,
51
+ unknown
52
+ > = z.object({
53
+ enabled: z.boolean(),
54
+ channels: PreferenceChannels$inboundSchema,
55
+ overrides: z.array(Overrides$inboundSchema),
56
+ workflow: WorkflowInfoDto$inboundSchema,
57
+ });
58
+
59
+ /** @internal */
60
+ export type WorkflowPreferenceDto$Outbound = {
61
+ enabled: boolean;
62
+ channels: PreferenceChannels$Outbound;
63
+ overrides: Array<Overrides$Outbound>;
64
+ workflow: WorkflowInfoDto$Outbound;
65
+ };
66
+
67
+ /** @internal */
68
+ export const WorkflowPreferenceDto$outboundSchema: z.ZodType<
69
+ WorkflowPreferenceDto$Outbound,
70
+ z.ZodTypeDef,
71
+ WorkflowPreferenceDto
72
+ > = z.object({
73
+ enabled: z.boolean(),
74
+ channels: PreferenceChannels$outboundSchema,
75
+ overrides: z.array(Overrides$outboundSchema),
76
+ workflow: WorkflowInfoDto$outboundSchema,
77
+ });
78
+
79
+ /**
80
+ * @internal
81
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
82
+ */
83
+ export namespace WorkflowPreferenceDto$ {
84
+ /** @deprecated use `WorkflowPreferenceDto$inboundSchema` instead. */
85
+ export const inboundSchema = WorkflowPreferenceDto$inboundSchema;
86
+ /** @deprecated use `WorkflowPreferenceDto$outboundSchema` instead. */
87
+ export const outboundSchema = WorkflowPreferenceDto$outboundSchema;
88
+ /** @deprecated use `WorkflowPreferenceDto$Outbound` instead. */
89
+ export type Outbound = WorkflowPreferenceDto$Outbound;
90
+ }
91
+
92
+ export function workflowPreferenceDtoToJSON(
93
+ workflowPreferenceDto: WorkflowPreferenceDto,
94
+ ): string {
95
+ return JSON.stringify(
96
+ WorkflowPreferenceDto$outboundSchema.parse(workflowPreferenceDto),
97
+ );
98
+ }
99
+
100
+ export function workflowPreferenceDtoFromJSON(
101
+ jsonString: string,
102
+ ): SafeParseResult<WorkflowPreferenceDto, SDKValidationError> {
103
+ return safeParse(
104
+ jsonString,
105
+ (x) => WorkflowPreferenceDto$inboundSchema.parse(JSON.parse(x)),
106
+ `Failed to parse 'WorkflowPreferenceDto' from JSON`,
107
+ );
108
+ }
@@ -21,9 +21,11 @@ export * from "./notificationscontrollergetactivitystats.js";
21
21
  export * from "./notificationscontrollergetnotification.js";
22
22
  export * from "./notificationscontrollerlistnotifications.js";
23
23
  export * from "./subscriberscontrollergetsubscriber.js";
24
+ export * from "./subscriberscontrollergetsubscriberpreferences.js";
24
25
  export * from "./subscriberscontrollerpatchsubscriber.js";
25
26
  export * from "./subscriberscontrollerremovesubscriber.js";
26
27
  export * from "./subscriberscontrollersearchsubscribers.js";
28
+ export * from "./subscriberscontrollerupdatesubscriberpreferences.js";
27
29
  export * from "./subscribersv1controllerbulkcreatesubscribers.js";
28
30
  export * from "./subscribersv1controllerchataccessoauth.js";
29
31
  export * from "./subscribersv1controllerchatoauthcallback.js";
@@ -0,0 +1,183 @@
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 SubscribersControllerGetSubscriberPreferencesRequest = {
13
+ subscriberId: string;
14
+ /**
15
+ * A header for idempotency purposes
16
+ */
17
+ idempotencyKey?: string | undefined;
18
+ };
19
+
20
+ export type SubscribersControllerGetSubscriberPreferencesResponse = {
21
+ headers: { [k: string]: Array<string> };
22
+ result: components.GetSubscriberPreferencesDto;
23
+ };
24
+
25
+ /** @internal */
26
+ export const SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema:
27
+ z.ZodType<
28
+ SubscribersControllerGetSubscriberPreferencesRequest,
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 SubscribersControllerGetSubscriberPreferencesRequest$Outbound = {
42
+ subscriberId: string;
43
+ "idempotency-key"?: string | undefined;
44
+ };
45
+
46
+ /** @internal */
47
+ export const SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema:
48
+ z.ZodType<
49
+ SubscribersControllerGetSubscriberPreferencesRequest$Outbound,
50
+ z.ZodTypeDef,
51
+ SubscribersControllerGetSubscriberPreferencesRequest
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 SubscribersControllerGetSubscriberPreferencesRequest$ {
66
+ /** @deprecated use `SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema` instead. */
67
+ export const inboundSchema =
68
+ SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema;
69
+ /** @deprecated use `SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema` instead. */
70
+ export const outboundSchema =
71
+ SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema;
72
+ /** @deprecated use `SubscribersControllerGetSubscriberPreferencesRequest$Outbound` instead. */
73
+ export type Outbound =
74
+ SubscribersControllerGetSubscriberPreferencesRequest$Outbound;
75
+ }
76
+
77
+ export function subscribersControllerGetSubscriberPreferencesRequestToJSON(
78
+ subscribersControllerGetSubscriberPreferencesRequest:
79
+ SubscribersControllerGetSubscriberPreferencesRequest,
80
+ ): string {
81
+ return JSON.stringify(
82
+ SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema.parse(
83
+ subscribersControllerGetSubscriberPreferencesRequest,
84
+ ),
85
+ );
86
+ }
87
+
88
+ export function subscribersControllerGetSubscriberPreferencesRequestFromJSON(
89
+ jsonString: string,
90
+ ): SafeParseResult<
91
+ SubscribersControllerGetSubscriberPreferencesRequest,
92
+ SDKValidationError
93
+ > {
94
+ return safeParse(
95
+ jsonString,
96
+ (x) =>
97
+ SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema.parse(
98
+ JSON.parse(x),
99
+ ),
100
+ `Failed to parse 'SubscribersControllerGetSubscriberPreferencesRequest' from JSON`,
101
+ );
102
+ }
103
+
104
+ /** @internal */
105
+ export const SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema:
106
+ z.ZodType<
107
+ SubscribersControllerGetSubscriberPreferencesResponse,
108
+ z.ZodTypeDef,
109
+ unknown
110
+ > = z.object({
111
+ Headers: z.record(z.array(z.string())),
112
+ Result: components.GetSubscriberPreferencesDto$inboundSchema,
113
+ }).transform((v) => {
114
+ return remap$(v, {
115
+ "Headers": "headers",
116
+ "Result": "result",
117
+ });
118
+ });
119
+
120
+ /** @internal */
121
+ export type SubscribersControllerGetSubscriberPreferencesResponse$Outbound = {
122
+ Headers: { [k: string]: Array<string> };
123
+ Result: components.GetSubscriberPreferencesDto$Outbound;
124
+ };
125
+
126
+ /** @internal */
127
+ export const SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema:
128
+ z.ZodType<
129
+ SubscribersControllerGetSubscriberPreferencesResponse$Outbound,
130
+ z.ZodTypeDef,
131
+ SubscribersControllerGetSubscriberPreferencesResponse
132
+ > = z.object({
133
+ headers: z.record(z.array(z.string())),
134
+ result: components.GetSubscriberPreferencesDto$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 SubscribersControllerGetSubscriberPreferencesResponse$ {
147
+ /** @deprecated use `SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema` instead. */
148
+ export const inboundSchema =
149
+ SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema;
150
+ /** @deprecated use `SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema` instead. */
151
+ export const outboundSchema =
152
+ SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema;
153
+ /** @deprecated use `SubscribersControllerGetSubscriberPreferencesResponse$Outbound` instead. */
154
+ export type Outbound =
155
+ SubscribersControllerGetSubscriberPreferencesResponse$Outbound;
156
+ }
157
+
158
+ export function subscribersControllerGetSubscriberPreferencesResponseToJSON(
159
+ subscribersControllerGetSubscriberPreferencesResponse:
160
+ SubscribersControllerGetSubscriberPreferencesResponse,
161
+ ): string {
162
+ return JSON.stringify(
163
+ SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema.parse(
164
+ subscribersControllerGetSubscriberPreferencesResponse,
165
+ ),
166
+ );
167
+ }
168
+
169
+ export function subscribersControllerGetSubscriberPreferencesResponseFromJSON(
170
+ jsonString: string,
171
+ ): SafeParseResult<
172
+ SubscribersControllerGetSubscriberPreferencesResponse,
173
+ SDKValidationError
174
+ > {
175
+ return safeParse(
176
+ jsonString,
177
+ (x) =>
178
+ SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema.parse(
179
+ JSON.parse(x),
180
+ ),
181
+ `Failed to parse 'SubscribersControllerGetSubscriberPreferencesResponse' from JSON`,
182
+ );
183
+ }
@@ -0,0 +1,189 @@
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 SubscribersControllerUpdateSubscriberPreferencesRequest = {
13
+ subscriberId: string;
14
+ /**
15
+ * A header for idempotency purposes
16
+ */
17
+ idempotencyKey?: string | undefined;
18
+ patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto;
19
+ };
20
+
21
+ export type SubscribersControllerUpdateSubscriberPreferencesResponse = {
22
+ headers: { [k: string]: Array<string> };
23
+ result: components.GetSubscriberPreferencesDto;
24
+ };
25
+
26
+ /** @internal */
27
+ export const SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema:
28
+ z.ZodType<
29
+ SubscribersControllerUpdateSubscriberPreferencesRequest,
30
+ z.ZodTypeDef,
31
+ unknown
32
+ > = z.object({
33
+ subscriberId: z.string(),
34
+ "idempotency-key": z.string().optional(),
35
+ PatchSubscriberPreferencesDto:
36
+ components.PatchSubscriberPreferencesDto$inboundSchema,
37
+ }).transform((v) => {
38
+ return remap$(v, {
39
+ "idempotency-key": "idempotencyKey",
40
+ "PatchSubscriberPreferencesDto": "patchSubscriberPreferencesDto",
41
+ });
42
+ });
43
+
44
+ /** @internal */
45
+ export type SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound = {
46
+ subscriberId: string;
47
+ "idempotency-key"?: string | undefined;
48
+ PatchSubscriberPreferencesDto:
49
+ components.PatchSubscriberPreferencesDto$Outbound;
50
+ };
51
+
52
+ /** @internal */
53
+ export const SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema:
54
+ z.ZodType<
55
+ SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound,
56
+ z.ZodTypeDef,
57
+ SubscribersControllerUpdateSubscriberPreferencesRequest
58
+ > = z.object({
59
+ subscriberId: z.string(),
60
+ idempotencyKey: z.string().optional(),
61
+ patchSubscriberPreferencesDto:
62
+ components.PatchSubscriberPreferencesDto$outboundSchema,
63
+ }).transform((v) => {
64
+ return remap$(v, {
65
+ idempotencyKey: "idempotency-key",
66
+ patchSubscriberPreferencesDto: "PatchSubscriberPreferencesDto",
67
+ });
68
+ });
69
+
70
+ /**
71
+ * @internal
72
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
73
+ */
74
+ export namespace SubscribersControllerUpdateSubscriberPreferencesRequest$ {
75
+ /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema` instead. */
76
+ export const inboundSchema =
77
+ SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema;
78
+ /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema` instead. */
79
+ export const outboundSchema =
80
+ SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema;
81
+ /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound` instead. */
82
+ export type Outbound =
83
+ SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound;
84
+ }
85
+
86
+ export function subscribersControllerUpdateSubscriberPreferencesRequestToJSON(
87
+ subscribersControllerUpdateSubscriberPreferencesRequest:
88
+ SubscribersControllerUpdateSubscriberPreferencesRequest,
89
+ ): string {
90
+ return JSON.stringify(
91
+ SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema
92
+ .parse(subscribersControllerUpdateSubscriberPreferencesRequest),
93
+ );
94
+ }
95
+
96
+ export function subscribersControllerUpdateSubscriberPreferencesRequestFromJSON(
97
+ jsonString: string,
98
+ ): SafeParseResult<
99
+ SubscribersControllerUpdateSubscriberPreferencesRequest,
100
+ SDKValidationError
101
+ > {
102
+ return safeParse(
103
+ jsonString,
104
+ (x) =>
105
+ SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema
106
+ .parse(JSON.parse(x)),
107
+ `Failed to parse 'SubscribersControllerUpdateSubscriberPreferencesRequest' from JSON`,
108
+ );
109
+ }
110
+
111
+ /** @internal */
112
+ export const SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema:
113
+ z.ZodType<
114
+ SubscribersControllerUpdateSubscriberPreferencesResponse,
115
+ z.ZodTypeDef,
116
+ unknown
117
+ > = z.object({
118
+ Headers: z.record(z.array(z.string())),
119
+ Result: components.GetSubscriberPreferencesDto$inboundSchema,
120
+ }).transform((v) => {
121
+ return remap$(v, {
122
+ "Headers": "headers",
123
+ "Result": "result",
124
+ });
125
+ });
126
+
127
+ /** @internal */
128
+ export type SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound =
129
+ {
130
+ Headers: { [k: string]: Array<string> };
131
+ Result: components.GetSubscriberPreferencesDto$Outbound;
132
+ };
133
+
134
+ /** @internal */
135
+ export const SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema:
136
+ z.ZodType<
137
+ SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound,
138
+ z.ZodTypeDef,
139
+ SubscribersControllerUpdateSubscriberPreferencesResponse
140
+ > = z.object({
141
+ headers: z.record(z.array(z.string())),
142
+ result: components.GetSubscriberPreferencesDto$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 SubscribersControllerUpdateSubscriberPreferencesResponse$ {
155
+ /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema` instead. */
156
+ export const inboundSchema =
157
+ SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema;
158
+ /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema` instead. */
159
+ export const outboundSchema =
160
+ SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema;
161
+ /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound` instead. */
162
+ export type Outbound =
163
+ SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound;
164
+ }
165
+
166
+ export function subscribersControllerUpdateSubscriberPreferencesResponseToJSON(
167
+ subscribersControllerUpdateSubscriberPreferencesResponse:
168
+ SubscribersControllerUpdateSubscriberPreferencesResponse,
169
+ ): string {
170
+ return JSON.stringify(
171
+ SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema
172
+ .parse(subscribersControllerUpdateSubscriberPreferencesResponse),
173
+ );
174
+ }
175
+
176
+ export function subscribersControllerUpdateSubscriberPreferencesResponseFromJSON(
177
+ jsonString: string,
178
+ ): SafeParseResult<
179
+ SubscribersControllerUpdateSubscriberPreferencesResponse,
180
+ SDKValidationError
181
+ > {
182
+ return safeParse(
183
+ jsonString,
184
+ (x) =>
185
+ SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema
186
+ .parse(JSON.parse(x)),
187
+ `Failed to parse 'SubscribersControllerUpdateSubscriberPreferencesResponse' from JSON`,
188
+ );
189
+ }
@@ -0,0 +1,32 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { subscribersPreferencesLegacyUpdateGlobal } from "../funcs/subscribersPreferencesLegacyUpdateGlobal.js";
6
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
7
+ import * as components from "../models/components/index.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { unwrapAsync } from "../types/fp.js";
10
+
11
+ export class Legacy extends ClientSDK {
12
+ /**
13
+ * Update subscriber global preferences
14
+ */
15
+ async updateGlobal(
16
+ updateSubscriberGlobalPreferencesRequestDto:
17
+ components.UpdateSubscriberGlobalPreferencesRequestDto,
18
+ subscriberId: string,
19
+ idempotencyKey?: string | undefined,
20
+ options?: RequestOptions,
21
+ ): Promise<
22
+ operations.SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse
23
+ > {
24
+ return unwrapAsync(subscribersPreferencesLegacyUpdateGlobal(
25
+ this,
26
+ updateSubscriberGlobalPreferencesRequestDto,
27
+ subscriberId,
28
+ idempotencyKey,
29
+ options,
30
+ ));
31
+ }
32
+ }
@@ -2,20 +2,29 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { subscribersPreferencesList } from "../funcs/subscribersPreferencesList.js";
6
- import { subscribersPreferencesRetrieveByLevel } from "../funcs/subscribersPreferencesRetrieveByLevel.js";
5
+ import { subscribersPreferencesListLegacy } from "../funcs/subscribersPreferencesListLegacy.js";
6
+ import { subscribersPreferencesRetrieve } from "../funcs/subscribersPreferencesRetrieve.js";
7
+ import { subscribersPreferencesRetrieveByLevelLegacy } from "../funcs/subscribersPreferencesRetrieveByLevelLegacy.js";
7
8
  import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
8
- import { subscribersPreferencesUpdateGlobal } from "../funcs/subscribersPreferencesUpdateGlobal.js";
9
+ import { subscribersPreferencesUpdateLegacy } from "../funcs/subscribersPreferencesUpdateLegacy.js";
9
10
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
10
11
  import * as components from "../models/components/index.js";
11
12
  import * as operations from "../models/operations/index.js";
12
13
  import { unwrapAsync } from "../types/fp.js";
14
+ import { Legacy } from "./legacy.js";
13
15
 
14
16
  export class Preferences extends ClientSDK {
17
+ private _legacy?: Legacy;
18
+ get legacy(): Legacy {
19
+ return (this._legacy ??= new Legacy(this._options));
20
+ }
21
+
15
22
  /**
16
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.
17
26
  */
18
- async list(
27
+ async listLegacy(
19
28
  subscriberId: string,
20
29
  includeInactiveChannels?: boolean | undefined,
21
30
  idempotencyKey?: string | undefined,
@@ -23,7 +32,7 @@ export class Preferences extends ClientSDK {
23
32
  ): Promise<
24
33
  operations.SubscribersV1ControllerListSubscriberPreferencesResponse
25
34
  > {
26
- return unwrapAsync(subscribersPreferencesList(
35
+ return unwrapAsync(subscribersPreferencesListLegacy(
27
36
  this,
28
37
  subscriberId,
29
38
  includeInactiveChannels,
@@ -33,37 +42,35 @@ export class Preferences extends ClientSDK {
33
42
  }
34
43
 
35
44
  /**
36
- * Update subscriber global preferences
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.
37
48
  */
38
- async updateGlobal(
39
- updateSubscriberGlobalPreferencesRequestDto:
40
- components.UpdateSubscriberGlobalPreferencesRequestDto,
41
- subscriberId: string,
42
- idempotencyKey?: string | undefined,
49
+ async retrieveByLevelLegacy(
50
+ request:
51
+ operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
43
52
  options?: RequestOptions,
44
53
  ): Promise<
45
- operations.SubscribersV1ControllerUpdateSubscriberGlobalPreferencesResponse
54
+ operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse
46
55
  > {
47
- return unwrapAsync(subscribersPreferencesUpdateGlobal(
56
+ return unwrapAsync(subscribersPreferencesRetrieveByLevelLegacy(
48
57
  this,
49
- updateSubscriberGlobalPreferencesRequestDto,
50
- subscriberId,
51
- idempotencyKey,
58
+ request,
52
59
  options,
53
60
  ));
54
61
  }
55
62
 
56
63
  /**
57
- * Get subscriber preferences by level
64
+ * Update subscriber preference
58
65
  */
59
- async retrieveByLevel(
66
+ async updateLegacy(
60
67
  request:
61
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,
68
+ operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
62
69
  options?: RequestOptions,
63
70
  ): Promise<
64
- operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelResponse
71
+ operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse
65
72
  > {
66
- return unwrapAsync(subscribersPreferencesRetrieveByLevel(
73
+ return unwrapAsync(subscribersPreferencesUpdateLegacy(
67
74
  this,
68
75
  request,
69
76
  options,
@@ -71,18 +78,43 @@ export class Preferences extends ClientSDK {
71
78
  }
72
79
 
73
80
  /**
74
- * Update subscriber preference
81
+ * Get subscriber preferences
82
+ *
83
+ * @remarks
84
+ * Get subscriber global and workflow specific preferences
85
+ */
86
+ async retrieve(
87
+ subscriberId: string,
88
+ idempotencyKey?: string | undefined,
89
+ options?: RequestOptions,
90
+ ): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse> {
91
+ return unwrapAsync(subscribersPreferencesRetrieve(
92
+ this,
93
+ subscriberId,
94
+ idempotencyKey,
95
+ options,
96
+ ));
97
+ }
98
+
99
+ /**
100
+ * Update subscriber global or workflow specific preferences
101
+ *
102
+ * @remarks
103
+ * Update subscriber global or workflow specific preferences
75
104
  */
76
105
  async update(
77
- request:
78
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
106
+ patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto,
107
+ subscriberId: string,
108
+ idempotencyKey?: string | undefined,
79
109
  options?: RequestOptions,
80
110
  ): Promise<
81
- operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse
111
+ operations.SubscribersControllerUpdateSubscriberPreferencesResponse
82
112
  > {
83
113
  return unwrapAsync(subscribersPreferencesUpdate(
84
114
  this,
85
- request,
115
+ patchSubscriberPreferencesDto,
116
+ subscriberId,
117
+ idempotencyKey,
86
118
  options,
87
119
  ));
88
120
  }
@@ -11,7 +11,7 @@ import { subscribersPatch } from "../funcs/subscribersPatch.js";
11
11
  import { subscribersRetrieve } from "../funcs/subscribersRetrieve.js";
12
12
  import { subscribersRetrieveLegacy } from "../funcs/subscribersRetrieveLegacy.js";
13
13
  import { subscribersSearch } from "../funcs/subscribersSearch.js";
14
- import { subscribersUpdate } from "../funcs/subscribersUpdate.js";
14
+ import { subscribersUpdateLegacy } from "../funcs/subscribersUpdateLegacy.js";
15
15
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
16
16
  import * as components from "../models/components/index.js";
17
17
  import * as operations from "../models/operations/index.js";
@@ -127,13 +127,13 @@ export class Subscribers extends ClientSDK {
127
127
  * @remarks
128
128
  * Used to update the subscriber entity with new information
129
129
  */
130
- async update(
130
+ async updateLegacy(
131
131
  updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
132
132
  subscriberId: string,
133
133
  idempotencyKey?: string | undefined,
134
134
  options?: RequestOptions,
135
135
  ): Promise<operations.SubscribersV1ControllerUpdateSubscriberResponse> {
136
- return unwrapAsync(subscribersUpdate(
136
+ return unwrapAsync(subscribersUpdateLegacy(
137
137
  this,
138
138
  updateSubscriberRequestDto,
139
139
  subscriberId,