@novu/api 0.1.2 → 0.1.5
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.
- package/README.md +7 -3
- package/docs/sdks/messages/README.md +2 -8
- package/docs/sdks/notifications/README.md +2 -6
- package/docs/sdks/novunotifications/README.md +0 -6
- package/docs/sdks/preferences/README.md +166 -5
- package/docs/sdks/subscribers/README.md +2 -2
- package/docs/sdks/topics/README.md +0 -4
- package/funcs/subscribersPreferencesRetrieve.d.ts +16 -0
- package/funcs/subscribersPreferencesRetrieve.d.ts.map +1 -0
- package/funcs/subscribersPreferencesRetrieve.js +141 -0
- package/funcs/subscribersPreferencesRetrieve.js.map +1 -0
- package/funcs/subscribersPreferencesUpdate.d.ts +6 -2
- package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
- package/funcs/subscribersPreferencesUpdate.js +18 -12
- package/funcs/subscribersPreferencesUpdate.js.map +1 -1
- package/funcs/subscribersPreferencesUpdateLegacy.d.ts +13 -0
- package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +1 -0
- package/funcs/subscribersPreferencesUpdateLegacy.js +139 -0
- package/funcs/subscribersPreferencesUpdateLegacy.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/components/getsubscriberpreferencesdto.d.ts +39 -0
- package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -0
- package/models/components/getsubscriberpreferencesdto.js +63 -0
- package/models/components/getsubscriberpreferencesdto.js.map +1 -0
- package/models/components/globalpreferencedto.d.ts +38 -0
- package/models/components/globalpreferencedto.d.ts.map +1 -0
- package/models/components/globalpreferencedto.js +62 -0
- package/models/components/globalpreferencedto.js.map +1 -0
- package/models/components/index.d.ts +7 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +7 -0
- package/models/components/index.js.map +1 -1
- package/models/components/overrides.d.ts +112 -0
- package/models/components/overrides.d.ts.map +1 -0
- package/models/components/overrides.js +110 -0
- package/models/components/overrides.js.map +1 -0
- package/models/components/patchpreferencechannelsdto.d.ts +52 -0
- package/models/components/patchpreferencechannelsdto.d.ts.map +1 -0
- package/models/components/patchpreferencechannelsdto.js +76 -0
- package/models/components/patchpreferencechannelsdto.js.map +1 -0
- package/models/components/patchsubscriberpreferencesdto.d.ts +38 -0
- package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -0
- package/models/components/patchsubscriberpreferencesdto.js +62 -0
- package/models/components/patchsubscriberpreferencesdto.js.map +1 -0
- package/models/components/triggereventtoallrequestdto.d.ts +15 -15
- package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
- package/models/components/triggereventtoallrequestdto.js +20 -18
- package/models/components/triggereventtoallrequestdto.js.map +1 -1
- package/models/components/workflowinfodto.d.ts +42 -0
- package/models/components/workflowinfodto.d.ts.map +1 -0
- package/models/components/workflowinfodto.js +63 -0
- package/models/components/workflowinfodto.js.map +1 -0
- package/models/components/workflowpreferencedto.d.ts +50 -0
- package/models/components/workflowpreferencedto.d.ts.map +1 -0
- package/models/components/workflowpreferencedto.js +68 -0
- package/models/components/workflowpreferencedto.js.map +1 -0
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts +66 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.js +110 -0
- package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts +68 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts.map +1 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js +118 -0
- package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js.map +1 -0
- package/package.json +1 -1
- package/sdk/preferences.d.ts +15 -1
- package/sdk/preferences.d.ts.map +1 -1
- package/sdk/preferences.js +22 -2
- package/sdk/preferences.js.map +1 -1
- package/sources/json-development.json +1165 -0
- package/src/funcs/subscribersPreferencesRetrieve.ts +203 -0
- package/src/funcs/subscribersPreferencesUpdate.ts +27 -20
- package/src/funcs/subscribersPreferencesUpdateLegacy.ts +202 -0
- package/src/lib/config.ts +3 -3
- package/src/models/components/getsubscriberpreferencesdto.ts +90 -0
- package/src/models/components/globalpreferencedto.ts +82 -0
- package/src/models/components/index.ts +7 -0
- package/src/models/components/overrides.ts +141 -0
- package/src/models/components/patchpreferencechannelsdto.ts +106 -0
- package/src/models/components/patchsubscriberpreferencesdto.ts +84 -0
- package/src/models/components/triggereventtoallrequestdto.ts +35 -24
- package/src/models/components/workflowinfodto.ts +81 -0
- package/src/models/components/workflowpreferencedto.ts +108 -0
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +183 -0
- package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts +189 -0
- package/src/sdk/preferences.ts +46 -2
|
@@ -53,8 +53,10 @@ export * from "./failedoperationdto.js";
|
|
|
53
53
|
export * from "./feedresponsedto.js";
|
|
54
54
|
export * from "./fieldfilterpartdto.js";
|
|
55
55
|
export * from "./filtertopicsresponsedto.js";
|
|
56
|
+
export * from "./getsubscriberpreferencesdto.js";
|
|
56
57
|
export * from "./getsubscriberpreferencesresponsedto.js";
|
|
57
58
|
export * from "./gettopicresponsedto.js";
|
|
59
|
+
export * from "./globalpreferencedto.js";
|
|
58
60
|
export * from "./integrationresponsedto.js";
|
|
59
61
|
export * from "./listsubscribersresponsedto.js";
|
|
60
62
|
export * from "./markallmessageasrequestdto.js";
|
|
@@ -82,6 +84,9 @@ export * from "./notificationtriggervariable.js";
|
|
|
82
84
|
export * from "./notificationtriggervariableresponse.js";
|
|
83
85
|
export * from "./ordinalenum.js";
|
|
84
86
|
export * from "./ordinalvalueenum.js";
|
|
87
|
+
export * from "./overrides.js";
|
|
88
|
+
export * from "./patchpreferencechannelsdto.js";
|
|
89
|
+
export * from "./patchsubscriberpreferencesdto.js";
|
|
85
90
|
export * from "./patchsubscriberrequestdto.js";
|
|
86
91
|
export * from "./preference.js";
|
|
87
92
|
export * from "./preferencechannels.js";
|
|
@@ -121,4 +126,6 @@ export * from "./updatesubscriberpreferenceglobalresponsedto.js";
|
|
|
121
126
|
export * from "./updatesubscriberpreferencerequestdto.js";
|
|
122
127
|
export * from "./updatesubscriberpreferenceresponsedto.js";
|
|
123
128
|
export * from "./updatesubscriberrequestdto.js";
|
|
129
|
+
export * from "./workflowinfodto.js";
|
|
130
|
+
export * from "./workflowpreferencedto.js";
|
|
124
131
|
export * from "./workflowresponse.js";
|
|
@@ -0,0 +1,141 @@
|
|
|
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 { ClosedEnum } from "../../types/enums.js";
|
|
8
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
9
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* The channel type which is overridden
|
|
13
|
+
*/
|
|
14
|
+
export const OverridesChannel = {
|
|
15
|
+
InApp: "in_app",
|
|
16
|
+
Email: "email",
|
|
17
|
+
Sms: "sms",
|
|
18
|
+
Chat: "chat",
|
|
19
|
+
Push: "push",
|
|
20
|
+
} as const;
|
|
21
|
+
/**
|
|
22
|
+
* The channel type which is overridden
|
|
23
|
+
*/
|
|
24
|
+
export type OverridesChannel = ClosedEnum<typeof OverridesChannel>;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* The source of overrides
|
|
28
|
+
*/
|
|
29
|
+
export const Source = {
|
|
30
|
+
Subscriber: "subscriber",
|
|
31
|
+
Template: "template",
|
|
32
|
+
WorkflowOverride: "workflowOverride",
|
|
33
|
+
} as const;
|
|
34
|
+
/**
|
|
35
|
+
* The source of overrides
|
|
36
|
+
*/
|
|
37
|
+
export type Source = ClosedEnum<typeof Source>;
|
|
38
|
+
|
|
39
|
+
export type Overrides = {
|
|
40
|
+
/**
|
|
41
|
+
* The channel type which is overridden
|
|
42
|
+
*/
|
|
43
|
+
channel: OverridesChannel;
|
|
44
|
+
/**
|
|
45
|
+
* The source of overrides
|
|
46
|
+
*/
|
|
47
|
+
source: Source;
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
/** @internal */
|
|
51
|
+
export const OverridesChannel$inboundSchema: z.ZodNativeEnum<
|
|
52
|
+
typeof OverridesChannel
|
|
53
|
+
> = z.nativeEnum(OverridesChannel);
|
|
54
|
+
|
|
55
|
+
/** @internal */
|
|
56
|
+
export const OverridesChannel$outboundSchema: z.ZodNativeEnum<
|
|
57
|
+
typeof OverridesChannel
|
|
58
|
+
> = OverridesChannel$inboundSchema;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* @internal
|
|
62
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
63
|
+
*/
|
|
64
|
+
export namespace OverridesChannel$ {
|
|
65
|
+
/** @deprecated use `OverridesChannel$inboundSchema` instead. */
|
|
66
|
+
export const inboundSchema = OverridesChannel$inboundSchema;
|
|
67
|
+
/** @deprecated use `OverridesChannel$outboundSchema` instead. */
|
|
68
|
+
export const outboundSchema = OverridesChannel$outboundSchema;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/** @internal */
|
|
72
|
+
export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
|
|
73
|
+
.nativeEnum(Source);
|
|
74
|
+
|
|
75
|
+
/** @internal */
|
|
76
|
+
export const Source$outboundSchema: z.ZodNativeEnum<typeof Source> =
|
|
77
|
+
Source$inboundSchema;
|
|
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 Source$ {
|
|
84
|
+
/** @deprecated use `Source$inboundSchema` instead. */
|
|
85
|
+
export const inboundSchema = Source$inboundSchema;
|
|
86
|
+
/** @deprecated use `Source$outboundSchema` instead. */
|
|
87
|
+
export const outboundSchema = Source$outboundSchema;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/** @internal */
|
|
91
|
+
export const Overrides$inboundSchema: z.ZodType<
|
|
92
|
+
Overrides,
|
|
93
|
+
z.ZodTypeDef,
|
|
94
|
+
unknown
|
|
95
|
+
> = z.object({
|
|
96
|
+
channel: OverridesChannel$inboundSchema,
|
|
97
|
+
source: Source$inboundSchema,
|
|
98
|
+
});
|
|
99
|
+
|
|
100
|
+
/** @internal */
|
|
101
|
+
export type Overrides$Outbound = {
|
|
102
|
+
channel: string;
|
|
103
|
+
source: string;
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
/** @internal */
|
|
107
|
+
export const Overrides$outboundSchema: z.ZodType<
|
|
108
|
+
Overrides$Outbound,
|
|
109
|
+
z.ZodTypeDef,
|
|
110
|
+
Overrides
|
|
111
|
+
> = z.object({
|
|
112
|
+
channel: OverridesChannel$outboundSchema,
|
|
113
|
+
source: Source$outboundSchema,
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* @internal
|
|
118
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
119
|
+
*/
|
|
120
|
+
export namespace Overrides$ {
|
|
121
|
+
/** @deprecated use `Overrides$inboundSchema` instead. */
|
|
122
|
+
export const inboundSchema = Overrides$inboundSchema;
|
|
123
|
+
/** @deprecated use `Overrides$outboundSchema` instead. */
|
|
124
|
+
export const outboundSchema = Overrides$outboundSchema;
|
|
125
|
+
/** @deprecated use `Overrides$Outbound` instead. */
|
|
126
|
+
export type Outbound = Overrides$Outbound;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export function overridesToJSON(overrides: Overrides): string {
|
|
130
|
+
return JSON.stringify(Overrides$outboundSchema.parse(overrides));
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
export function overridesFromJSON(
|
|
134
|
+
jsonString: string,
|
|
135
|
+
): SafeParseResult<Overrides, SDKValidationError> {
|
|
136
|
+
return safeParse(
|
|
137
|
+
jsonString,
|
|
138
|
+
(x) => Overrides$inboundSchema.parse(JSON.parse(x)),
|
|
139
|
+
`Failed to parse 'Overrides' from JSON`,
|
|
140
|
+
);
|
|
141
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
10
|
+
|
|
11
|
+
export type PatchPreferenceChannelsDto = {
|
|
12
|
+
/**
|
|
13
|
+
* Email channel preference
|
|
14
|
+
*/
|
|
15
|
+
email?: boolean | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* SMS channel preference
|
|
18
|
+
*/
|
|
19
|
+
sms?: boolean | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* In-app channel preference
|
|
22
|
+
*/
|
|
23
|
+
inApp?: boolean | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* Push channel preference
|
|
26
|
+
*/
|
|
27
|
+
push?: boolean | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* Chat channel preference
|
|
30
|
+
*/
|
|
31
|
+
chat?: boolean | undefined;
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
/** @internal */
|
|
35
|
+
export const PatchPreferenceChannelsDto$inboundSchema: z.ZodType<
|
|
36
|
+
PatchPreferenceChannelsDto,
|
|
37
|
+
z.ZodTypeDef,
|
|
38
|
+
unknown
|
|
39
|
+
> = z.object({
|
|
40
|
+
email: z.boolean().optional(),
|
|
41
|
+
sms: z.boolean().optional(),
|
|
42
|
+
in_app: z.boolean().optional(),
|
|
43
|
+
push: z.boolean().optional(),
|
|
44
|
+
chat: z.boolean().optional(),
|
|
45
|
+
}).transform((v) => {
|
|
46
|
+
return remap$(v, {
|
|
47
|
+
"in_app": "inApp",
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
/** @internal */
|
|
52
|
+
export type PatchPreferenceChannelsDto$Outbound = {
|
|
53
|
+
email?: boolean | undefined;
|
|
54
|
+
sms?: boolean | undefined;
|
|
55
|
+
in_app?: boolean | undefined;
|
|
56
|
+
push?: boolean | undefined;
|
|
57
|
+
chat?: boolean | undefined;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
/** @internal */
|
|
61
|
+
export const PatchPreferenceChannelsDto$outboundSchema: z.ZodType<
|
|
62
|
+
PatchPreferenceChannelsDto$Outbound,
|
|
63
|
+
z.ZodTypeDef,
|
|
64
|
+
PatchPreferenceChannelsDto
|
|
65
|
+
> = z.object({
|
|
66
|
+
email: z.boolean().optional(),
|
|
67
|
+
sms: z.boolean().optional(),
|
|
68
|
+
inApp: z.boolean().optional(),
|
|
69
|
+
push: z.boolean().optional(),
|
|
70
|
+
chat: z.boolean().optional(),
|
|
71
|
+
}).transform((v) => {
|
|
72
|
+
return remap$(v, {
|
|
73
|
+
inApp: "in_app",
|
|
74
|
+
});
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
80
|
+
*/
|
|
81
|
+
export namespace PatchPreferenceChannelsDto$ {
|
|
82
|
+
/** @deprecated use `PatchPreferenceChannelsDto$inboundSchema` instead. */
|
|
83
|
+
export const inboundSchema = PatchPreferenceChannelsDto$inboundSchema;
|
|
84
|
+
/** @deprecated use `PatchPreferenceChannelsDto$outboundSchema` instead. */
|
|
85
|
+
export const outboundSchema = PatchPreferenceChannelsDto$outboundSchema;
|
|
86
|
+
/** @deprecated use `PatchPreferenceChannelsDto$Outbound` instead. */
|
|
87
|
+
export type Outbound = PatchPreferenceChannelsDto$Outbound;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function patchPreferenceChannelsDtoToJSON(
|
|
91
|
+
patchPreferenceChannelsDto: PatchPreferenceChannelsDto,
|
|
92
|
+
): string {
|
|
93
|
+
return JSON.stringify(
|
|
94
|
+
PatchPreferenceChannelsDto$outboundSchema.parse(patchPreferenceChannelsDto),
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export function patchPreferenceChannelsDtoFromJSON(
|
|
99
|
+
jsonString: string,
|
|
100
|
+
): SafeParseResult<PatchPreferenceChannelsDto, SDKValidationError> {
|
|
101
|
+
return safeParse(
|
|
102
|
+
jsonString,
|
|
103
|
+
(x) => PatchPreferenceChannelsDto$inboundSchema.parse(JSON.parse(x)),
|
|
104
|
+
`Failed to parse 'PatchPreferenceChannelsDto' from JSON`,
|
|
105
|
+
);
|
|
106
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
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
|
+
PatchPreferenceChannelsDto,
|
|
11
|
+
PatchPreferenceChannelsDto$inboundSchema,
|
|
12
|
+
PatchPreferenceChannelsDto$Outbound,
|
|
13
|
+
PatchPreferenceChannelsDto$outboundSchema,
|
|
14
|
+
} from "./patchpreferencechannelsdto.js";
|
|
15
|
+
|
|
16
|
+
export type PatchSubscriberPreferencesDto = {
|
|
17
|
+
/**
|
|
18
|
+
* Channel-specific preference settings
|
|
19
|
+
*/
|
|
20
|
+
channels: PatchPreferenceChannelsDto;
|
|
21
|
+
/**
|
|
22
|
+
* If provided, update workflow specific preferences, otherwise update global preferences
|
|
23
|
+
*/
|
|
24
|
+
workflowId?: string | undefined;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
/** @internal */
|
|
28
|
+
export const PatchSubscriberPreferencesDto$inboundSchema: z.ZodType<
|
|
29
|
+
PatchSubscriberPreferencesDto,
|
|
30
|
+
z.ZodTypeDef,
|
|
31
|
+
unknown
|
|
32
|
+
> = z.object({
|
|
33
|
+
channels: PatchPreferenceChannelsDto$inboundSchema,
|
|
34
|
+
workflowId: z.string().optional(),
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
/** @internal */
|
|
38
|
+
export type PatchSubscriberPreferencesDto$Outbound = {
|
|
39
|
+
channels: PatchPreferenceChannelsDto$Outbound;
|
|
40
|
+
workflowId?: string | undefined;
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
/** @internal */
|
|
44
|
+
export const PatchSubscriberPreferencesDto$outboundSchema: z.ZodType<
|
|
45
|
+
PatchSubscriberPreferencesDto$Outbound,
|
|
46
|
+
z.ZodTypeDef,
|
|
47
|
+
PatchSubscriberPreferencesDto
|
|
48
|
+
> = z.object({
|
|
49
|
+
channels: PatchPreferenceChannelsDto$outboundSchema,
|
|
50
|
+
workflowId: z.string().optional(),
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
56
|
+
*/
|
|
57
|
+
export namespace PatchSubscriberPreferencesDto$ {
|
|
58
|
+
/** @deprecated use `PatchSubscriberPreferencesDto$inboundSchema` instead. */
|
|
59
|
+
export const inboundSchema = PatchSubscriberPreferencesDto$inboundSchema;
|
|
60
|
+
/** @deprecated use `PatchSubscriberPreferencesDto$outboundSchema` instead. */
|
|
61
|
+
export const outboundSchema = PatchSubscriberPreferencesDto$outboundSchema;
|
|
62
|
+
/** @deprecated use `PatchSubscriberPreferencesDto$Outbound` instead. */
|
|
63
|
+
export type Outbound = PatchSubscriberPreferencesDto$Outbound;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function patchSubscriberPreferencesDtoToJSON(
|
|
67
|
+
patchSubscriberPreferencesDto: PatchSubscriberPreferencesDto,
|
|
68
|
+
): string {
|
|
69
|
+
return JSON.stringify(
|
|
70
|
+
PatchSubscriberPreferencesDto$outboundSchema.parse(
|
|
71
|
+
patchSubscriberPreferencesDto,
|
|
72
|
+
),
|
|
73
|
+
);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function patchSubscriberPreferencesDtoFromJSON(
|
|
77
|
+
jsonString: string,
|
|
78
|
+
): SafeParseResult<PatchSubscriberPreferencesDto, SDKValidationError> {
|
|
79
|
+
return safeParse(
|
|
80
|
+
jsonString,
|
|
81
|
+
(x) => PatchSubscriberPreferencesDto$inboundSchema.parse(JSON.parse(x)),
|
|
82
|
+
`Failed to parse 'PatchSubscriberPreferencesDto' from JSON`,
|
|
83
|
+
);
|
|
84
|
+
}
|
|
@@ -22,7 +22,7 @@ import {
|
|
|
22
22
|
/**
|
|
23
23
|
* This could be used to override provider specific configurations
|
|
24
24
|
*/
|
|
25
|
-
export type
|
|
25
|
+
export type TriggerEventToAllRequestDtoOverrides = {};
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
28
|
* It is used to display the Avatar of the provided actor's subscriber id or actor object.
|
|
@@ -56,7 +56,7 @@ export type TriggerEventToAllRequestDto = {
|
|
|
56
56
|
/**
|
|
57
57
|
* This could be used to override provider specific configurations
|
|
58
58
|
*/
|
|
59
|
-
overrides?:
|
|
59
|
+
overrides?: TriggerEventToAllRequestDtoOverrides | undefined;
|
|
60
60
|
/**
|
|
61
61
|
* A unique identifier for this transaction, we will generated a UUID if not provided.
|
|
62
62
|
*/
|
|
@@ -78,46 +78,55 @@ export type TriggerEventToAllRequestDto = {
|
|
|
78
78
|
};
|
|
79
79
|
|
|
80
80
|
/** @internal */
|
|
81
|
-
export const
|
|
82
|
-
|
|
81
|
+
export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
|
|
82
|
+
TriggerEventToAllRequestDtoOverrides,
|
|
83
83
|
z.ZodTypeDef,
|
|
84
84
|
unknown
|
|
85
85
|
> = z.object({});
|
|
86
86
|
|
|
87
87
|
/** @internal */
|
|
88
|
-
export type
|
|
88
|
+
export type TriggerEventToAllRequestDtoOverrides$Outbound = {};
|
|
89
89
|
|
|
90
90
|
/** @internal */
|
|
91
|
-
export const
|
|
92
|
-
|
|
91
|
+
export const TriggerEventToAllRequestDtoOverrides$outboundSchema: z.ZodType<
|
|
92
|
+
TriggerEventToAllRequestDtoOverrides$Outbound,
|
|
93
93
|
z.ZodTypeDef,
|
|
94
|
-
|
|
94
|
+
TriggerEventToAllRequestDtoOverrides
|
|
95
95
|
> = z.object({});
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
98
|
* @internal
|
|
99
99
|
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
100
100
|
*/
|
|
101
|
-
export namespace
|
|
102
|
-
/** @deprecated use `
|
|
103
|
-
export const inboundSchema =
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
101
|
+
export namespace TriggerEventToAllRequestDtoOverrides$ {
|
|
102
|
+
/** @deprecated use `TriggerEventToAllRequestDtoOverrides$inboundSchema` instead. */
|
|
103
|
+
export const inboundSchema =
|
|
104
|
+
TriggerEventToAllRequestDtoOverrides$inboundSchema;
|
|
105
|
+
/** @deprecated use `TriggerEventToAllRequestDtoOverrides$outboundSchema` instead. */
|
|
106
|
+
export const outboundSchema =
|
|
107
|
+
TriggerEventToAllRequestDtoOverrides$outboundSchema;
|
|
108
|
+
/** @deprecated use `TriggerEventToAllRequestDtoOverrides$Outbound` instead. */
|
|
109
|
+
export type Outbound = TriggerEventToAllRequestDtoOverrides$Outbound;
|
|
108
110
|
}
|
|
109
111
|
|
|
110
|
-
export function
|
|
111
|
-
|
|
112
|
+
export function triggerEventToAllRequestDtoOverridesToJSON(
|
|
113
|
+
triggerEventToAllRequestDtoOverrides: TriggerEventToAllRequestDtoOverrides,
|
|
114
|
+
): string {
|
|
115
|
+
return JSON.stringify(
|
|
116
|
+
TriggerEventToAllRequestDtoOverrides$outboundSchema.parse(
|
|
117
|
+
triggerEventToAllRequestDtoOverrides,
|
|
118
|
+
),
|
|
119
|
+
);
|
|
112
120
|
}
|
|
113
121
|
|
|
114
|
-
export function
|
|
122
|
+
export function triggerEventToAllRequestDtoOverridesFromJSON(
|
|
115
123
|
jsonString: string,
|
|
116
|
-
): SafeParseResult<
|
|
124
|
+
): SafeParseResult<TriggerEventToAllRequestDtoOverrides, SDKValidationError> {
|
|
117
125
|
return safeParse(
|
|
118
126
|
jsonString,
|
|
119
|
-
(x) =>
|
|
120
|
-
|
|
127
|
+
(x) =>
|
|
128
|
+
TriggerEventToAllRequestDtoOverrides$inboundSchema.parse(JSON.parse(x)),
|
|
129
|
+
`Failed to parse 'TriggerEventToAllRequestDtoOverrides' from JSON`,
|
|
121
130
|
);
|
|
122
131
|
}
|
|
123
132
|
|
|
@@ -234,7 +243,8 @@ export const TriggerEventToAllRequestDto$inboundSchema: z.ZodType<
|
|
|
234
243
|
> = z.object({
|
|
235
244
|
name: z.string(),
|
|
236
245
|
payload: z.record(z.any()),
|
|
237
|
-
overrides: z.lazy(() =>
|
|
246
|
+
overrides: z.lazy(() => TriggerEventToAllRequestDtoOverrides$inboundSchema)
|
|
247
|
+
.optional(),
|
|
238
248
|
transactionId: z.string().optional(),
|
|
239
249
|
actor: z.union([SubscriberPayloadDto$inboundSchema, z.string()]).optional(),
|
|
240
250
|
tenant: z.union([TenantPayloadDto$inboundSchema, z.string()]).optional(),
|
|
@@ -244,7 +254,7 @@ export const TriggerEventToAllRequestDto$inboundSchema: z.ZodType<
|
|
|
244
254
|
export type TriggerEventToAllRequestDto$Outbound = {
|
|
245
255
|
name: string;
|
|
246
256
|
payload: { [k: string]: any };
|
|
247
|
-
overrides?:
|
|
257
|
+
overrides?: TriggerEventToAllRequestDtoOverrides$Outbound | undefined;
|
|
248
258
|
transactionId?: string | undefined;
|
|
249
259
|
actor?: SubscriberPayloadDto$Outbound | string | undefined;
|
|
250
260
|
tenant?: TenantPayloadDto$Outbound | string | undefined;
|
|
@@ -258,7 +268,8 @@ export const TriggerEventToAllRequestDto$outboundSchema: z.ZodType<
|
|
|
258
268
|
> = z.object({
|
|
259
269
|
name: z.string(),
|
|
260
270
|
payload: z.record(z.any()),
|
|
261
|
-
overrides: z.lazy(() =>
|
|
271
|
+
overrides: z.lazy(() => TriggerEventToAllRequestDtoOverrides$outboundSchema)
|
|
272
|
+
.optional(),
|
|
262
273
|
transactionId: z.string().optional(),
|
|
263
274
|
actor: z.union([SubscriberPayloadDto$outboundSchema, z.string()]).optional(),
|
|
264
275
|
tenant: z.union([TenantPayloadDto$outboundSchema, z.string()]).optional(),
|
|
@@ -0,0 +1,81 @@
|
|
|
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
|
+
|
|
10
|
+
export type WorkflowInfoDto = {
|
|
11
|
+
/**
|
|
12
|
+
* Workflow slug
|
|
13
|
+
*/
|
|
14
|
+
slug: string;
|
|
15
|
+
/**
|
|
16
|
+
* Unique identifier of the workflow
|
|
17
|
+
*/
|
|
18
|
+
identifier: string;
|
|
19
|
+
/**
|
|
20
|
+
* Display name of the workflow
|
|
21
|
+
*/
|
|
22
|
+
name: string;
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
/** @internal */
|
|
26
|
+
export const WorkflowInfoDto$inboundSchema: z.ZodType<
|
|
27
|
+
WorkflowInfoDto,
|
|
28
|
+
z.ZodTypeDef,
|
|
29
|
+
unknown
|
|
30
|
+
> = z.object({
|
|
31
|
+
slug: z.string(),
|
|
32
|
+
identifier: z.string(),
|
|
33
|
+
name: z.string(),
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
/** @internal */
|
|
37
|
+
export type WorkflowInfoDto$Outbound = {
|
|
38
|
+
slug: string;
|
|
39
|
+
identifier: string;
|
|
40
|
+
name: string;
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
/** @internal */
|
|
44
|
+
export const WorkflowInfoDto$outboundSchema: z.ZodType<
|
|
45
|
+
WorkflowInfoDto$Outbound,
|
|
46
|
+
z.ZodTypeDef,
|
|
47
|
+
WorkflowInfoDto
|
|
48
|
+
> = z.object({
|
|
49
|
+
slug: z.string(),
|
|
50
|
+
identifier: z.string(),
|
|
51
|
+
name: z.string(),
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* @internal
|
|
56
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
57
|
+
*/
|
|
58
|
+
export namespace WorkflowInfoDto$ {
|
|
59
|
+
/** @deprecated use `WorkflowInfoDto$inboundSchema` instead. */
|
|
60
|
+
export const inboundSchema = WorkflowInfoDto$inboundSchema;
|
|
61
|
+
/** @deprecated use `WorkflowInfoDto$outboundSchema` instead. */
|
|
62
|
+
export const outboundSchema = WorkflowInfoDto$outboundSchema;
|
|
63
|
+
/** @deprecated use `WorkflowInfoDto$Outbound` instead. */
|
|
64
|
+
export type Outbound = WorkflowInfoDto$Outbound;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function workflowInfoDtoToJSON(
|
|
68
|
+
workflowInfoDto: WorkflowInfoDto,
|
|
69
|
+
): string {
|
|
70
|
+
return JSON.stringify(WorkflowInfoDto$outboundSchema.parse(workflowInfoDto));
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function workflowInfoDtoFromJSON(
|
|
74
|
+
jsonString: string,
|
|
75
|
+
): SafeParseResult<WorkflowInfoDto, SDKValidationError> {
|
|
76
|
+
return safeParse(
|
|
77
|
+
jsonString,
|
|
78
|
+
(x) => WorkflowInfoDto$inboundSchema.parse(JSON.parse(x)),
|
|
79
|
+
`Failed to parse 'WorkflowInfoDto' from JSON`,
|
|
80
|
+
);
|
|
81
|
+
}
|
|
@@ -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";
|