@novu/api 0.5.0 → 0.6.1
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 +124 -68
- package/bin/mcp-server.js +223 -173
- package/bin/mcp-server.js.map +65 -64
- package/docs/sdks/authentication/README.md +17 -17
- package/docs/sdks/integrations/README.md +55 -55
- package/docs/sdks/novu/README.md +146 -146
- package/docs/sdks/novumessages/README.md +34 -34
- package/docs/sdks/stats/README.md +14 -14
- package/docs/sdks/subscribers/README.md +82 -82
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +2 -8
- package/lib/sdks.js.map +1 -1
- package/lib/security.d.ts +4 -3
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +6 -1
- package/lib/security.js.map +1 -1
- package/mcp-server/extensions.d.ts +11 -0
- package/mcp-server/extensions.d.ts.map +1 -0
- package/mcp-server/extensions.js +6 -0
- package/mcp-server/extensions.js.map +1 -0
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/prompts.d.ts +26 -0
- package/mcp-server/prompts.d.ts.map +1 -0
- package/mcp-server/prompts.js +48 -0
- package/mcp-server/prompts.js.map +1 -0
- package/mcp-server/resources.d.ts +9 -4
- package/mcp-server/resources.d.ts.map +1 -1
- package/mcp-server/resources.js +38 -10
- package/mcp-server/resources.js.map +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +31 -24
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/integrationsCreate.js +1 -1
- package/mcp-server/tools/integrationsDelete.js +1 -1
- package/mcp-server/tools/integrationsList.js +1 -1
- package/mcp-server/tools/integrationsListActive.js +1 -1
- package/mcp-server/tools/integrationsSetAsPrimary.js +1 -1
- package/mcp-server/tools/integrationsUpdate.js +1 -1
- package/mcp-server/tools/integrationsWebhooksRetrieve.js +1 -1
- package/mcp-server/tools/messagesDelete.js +1 -1
- package/mcp-server/tools/messagesDeleteByTransactionId.js +1 -1
- package/mcp-server/tools/messagesRetrieve.js +1 -1
- package/mcp-server/tools/notificationsList.js +1 -1
- package/mcp-server/tools/notificationsRetrieve.js +1 -1
- package/mcp-server/tools/notificationsStatsGraph.js +1 -1
- package/mcp-server/tools/notificationsStatsRetrieve.js +1 -1
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauth.js +1 -1
- package/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.js +1 -1
- package/mcp-server/tools/subscribersCreate.js +1 -1
- package/mcp-server/tools/subscribersCreateBulk.js +1 -1
- package/mcp-server/tools/subscribersCredentialsAppend.js +1 -1
- package/mcp-server/tools/subscribersCredentialsDelete.js +1 -1
- package/mcp-server/tools/subscribersCredentialsUpdate.js +1 -1
- package/mcp-server/tools/subscribersDelete.js +1 -1
- package/mcp-server/tools/subscribersList.js +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAll.js +1 -1
- package/mcp-server/tools/subscribersMessagesMarkAllAs.js +1 -1
- package/mcp-server/tools/subscribersMessagesUpdateAsSeen.js +1 -1
- package/mcp-server/tools/subscribersNotificationsFeed.js +1 -1
- package/mcp-server/tools/subscribersNotificationsUnseenCount.js +1 -1
- package/mcp-server/tools/subscribersPatch.js +1 -1
- package/mcp-server/tools/subscribersPreferencesList.js +1 -1
- package/mcp-server/tools/subscribersPreferencesUpdate.js +1 -1
- package/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.js +1 -1
- package/mcp-server/tools/subscribersRetrieve.js +1 -1
- package/mcp-server/tools/subscribersSearch.js +1 -1
- package/mcp-server/tools/topicsCreate.js +1 -1
- package/mcp-server/tools/topicsDelete.js +1 -1
- package/mcp-server/tools/topicsList.js +1 -1
- package/mcp-server/tools/topicsRename.js +1 -1
- package/mcp-server/tools/topicsRetrieve.js +1 -1
- package/mcp-server/tools/topicsSubscribersAssign.js +1 -1
- package/mcp-server/tools/topicsSubscribersRemove.js +1 -1
- package/mcp-server/tools/topicsSubscribersRetrieve.js +1 -1
- package/mcp-server/tools.d.ts.map +1 -1
- package/mcp-server/tools.js +4 -0
- package/mcp-server/tools.js.map +1 -1
- package/models/components/activitynotificationjobresponsedto.d.ts +9 -0
- package/models/components/activitynotificationjobresponsedto.d.ts.map +1 -1
- package/models/components/activitynotificationjobresponsedto.js +2 -0
- package/models/components/activitynotificationjobresponsedto.js.map +1 -1
- package/models/components/channelsettingsdto.d.ts +8 -8
- package/models/components/channelsettingsdto.d.ts.map +1 -1
- package/models/components/channelsettingsdto.js +14 -13
- package/models/components/channelsettingsdto.js.map +1 -1
- package/models/components/index.d.ts +0 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +0 -1
- package/models/components/index.js.map +1 -1
- package/models/components/integrationresponsedto.d.ts +8 -8
- package/models/components/integrationresponsedto.d.ts.map +1 -1
- package/models/components/integrationresponsedto.js +13 -14
- package/models/components/integrationresponsedto.js.map +1 -1
- package/models/components/markallmessageasrequestdto.d.ts +8 -8
- package/models/components/markallmessageasrequestdto.d.ts.map +1 -1
- package/models/components/markallmessageasrequestdto.js +14 -13
- package/models/components/markallmessageasrequestdto.js.map +1 -1
- package/models/components/messagemarkasrequestdto.d.ts +8 -8
- package/models/components/messagemarkasrequestdto.d.ts.map +1 -1
- package/models/components/messagemarkasrequestdto.js +13 -14
- package/models/components/messagemarkasrequestdto.js.map +1 -1
- package/models/components/overrides.d.ts +8 -8
- package/models/components/overrides.d.ts.map +1 -1
- package/models/components/overrides.js +14 -13
- package/models/components/overrides.js.map +1 -1
- package/models/components/patchsubscriberrequestdto.d.ts +15 -15
- package/models/components/patchsubscriberrequestdto.d.ts.map +1 -1
- package/models/components/patchsubscriberrequestdto.js +19 -20
- package/models/components/patchsubscriberrequestdto.js.map +1 -1
- package/models/components/subscriberchanneldto.d.ts +8 -8
- package/models/components/subscriberchanneldto.d.ts.map +1 -1
- package/models/components/subscriberchanneldto.js +13 -14
- package/models/components/subscriberchanneldto.js.map +1 -1
- package/models/components/subscriberpayloaddto.d.ts +13 -13
- package/models/components/subscriberpayloaddto.d.ts.map +1 -1
- package/models/components/subscriberpayloaddto.js +16 -17
- package/models/components/subscriberpayloaddto.js.map +1 -1
- package/models/operations/eventscontrollercancel.d.ts +2 -3
- package/models/operations/eventscontrollercancel.d.ts.map +1 -1
- package/models/operations/eventscontrollercancel.js +2 -3
- package/models/operations/eventscontrollercancel.js.map +1 -1
- package/models/operations/notificationscontrollerlistnotifications.d.ts +2 -2
- package/package.json +2 -2
- package/sdk/authentication.d.ts +4 -4
- package/sdk/authentication.d.ts.map +1 -1
- package/sdk/authentication.js +6 -6
- package/sdk/authentication.js.map +1 -1
- package/sdk/integrations.d.ts +7 -7
- package/sdk/integrations.d.ts.map +1 -1
- package/sdk/integrations.js +9 -9
- package/sdk/integrations.js.map +1 -1
- package/sdk/novumessages.d.ts +4 -4
- package/sdk/novumessages.d.ts.map +1 -1
- package/sdk/novumessages.js +6 -6
- package/sdk/novumessages.js.map +1 -1
- package/sdk/sdk.d.ts +12 -12
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +15 -15
- package/sdk/sdk.js.map +1 -1
- package/sdk/stats.d.ts +4 -4
- package/sdk/stats.d.ts.map +1 -1
- package/sdk/stats.js +6 -6
- package/sdk/stats.js.map +1 -1
- package/sdk/subscribers.d.ts +26 -26
- package/sdk/subscribers.d.ts.map +1 -1
- package/sdk/subscribers.js +29 -29
- package/sdk/subscribers.js.map +1 -1
- package/sources/json-development.json +1146 -1148
- package/src/lib/config.ts +3 -3
- package/src/lib/sdks.ts +2 -7
- package/src/lib/security.ts +11 -3
- package/src/mcp-server/extensions.ts +17 -0
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/prompts.ts +110 -0
- package/src/mcp-server/resources.ts +76 -14
- package/src/mcp-server/server.ts +41 -24
- package/src/mcp-server/tools/integrationsCreate.ts +1 -1
- package/src/mcp-server/tools/integrationsDelete.ts +1 -1
- package/src/mcp-server/tools/integrationsList.ts +1 -1
- package/src/mcp-server/tools/integrationsListActive.ts +1 -1
- package/src/mcp-server/tools/integrationsSetAsPrimary.ts +1 -1
- package/src/mcp-server/tools/integrationsUpdate.ts +1 -1
- package/src/mcp-server/tools/integrationsWebhooksRetrieve.ts +1 -1
- package/src/mcp-server/tools/messagesDelete.ts +1 -1
- package/src/mcp-server/tools/messagesDeleteByTransactionId.ts +1 -1
- package/src/mcp-server/tools/messagesRetrieve.ts +1 -1
- package/src/mcp-server/tools/notificationsList.ts +1 -1
- package/src/mcp-server/tools/notificationsRetrieve.ts +1 -1
- package/src/mcp-server/tools/notificationsStatsGraph.ts +1 -1
- package/src/mcp-server/tools/notificationsStatsRetrieve.ts +1 -1
- package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauth.ts +1 -1
- package/src/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.ts +1 -1
- package/src/mcp-server/tools/subscribersCreate.ts +1 -1
- package/src/mcp-server/tools/subscribersCreateBulk.ts +1 -1
- package/src/mcp-server/tools/subscribersCredentialsAppend.ts +1 -1
- package/src/mcp-server/tools/subscribersCredentialsDelete.ts +1 -1
- package/src/mcp-server/tools/subscribersCredentialsUpdate.ts +1 -1
- package/src/mcp-server/tools/subscribersDelete.ts +1 -1
- package/src/mcp-server/tools/subscribersList.ts +1 -1
- package/src/mcp-server/tools/subscribersMessagesMarkAll.ts +1 -1
- package/src/mcp-server/tools/subscribersMessagesMarkAllAs.ts +1 -1
- package/src/mcp-server/tools/subscribersMessagesUpdateAsSeen.ts +1 -1
- package/src/mcp-server/tools/subscribersNotificationsFeed.ts +1 -1
- package/src/mcp-server/tools/subscribersNotificationsUnseenCount.ts +1 -1
- package/src/mcp-server/tools/subscribersPatch.ts +1 -1
- package/src/mcp-server/tools/subscribersPreferencesList.ts +1 -1
- package/src/mcp-server/tools/subscribersPreferencesUpdate.ts +1 -1
- package/src/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.ts +1 -1
- package/src/mcp-server/tools/subscribersRetrieve.ts +1 -1
- package/src/mcp-server/tools/subscribersSearch.ts +1 -1
- package/src/mcp-server/tools/topicsCreate.ts +1 -1
- package/src/mcp-server/tools/topicsDelete.ts +1 -1
- package/src/mcp-server/tools/topicsList.ts +1 -1
- package/src/mcp-server/tools/topicsRename.ts +1 -1
- package/src/mcp-server/tools/topicsRetrieve.ts +1 -1
- package/src/mcp-server/tools/topicsSubscribersAssign.ts +1 -1
- package/src/mcp-server/tools/topicsSubscribersRemove.ts +1 -1
- package/src/mcp-server/tools/topicsSubscribersRetrieve.ts +1 -1
- package/src/mcp-server/tools.ts +5 -0
- package/src/models/components/activitynotificationjobresponsedto.ts +7 -0
- package/src/models/components/channelsettingsdto.ts +14 -18
- package/src/models/components/index.ts +0 -1
- package/src/models/components/integrationresponsedto.ts +18 -14
- package/src/models/components/markallmessageasrequestdto.ts +14 -18
- package/src/models/components/messagemarkasrequestdto.ts +18 -14
- package/src/models/components/overrides.ts +14 -16
- package/src/models/components/patchsubscriberrequestdto.ts +23 -37
- package/src/models/components/subscriberchanneldto.ts +18 -14
- package/src/models/components/subscriberpayloaddto.ts +37 -19
- package/src/models/operations/eventscontrollercancel.ts +4 -5
- package/src/models/operations/notificationscontrollerlistnotifications.ts +2 -2
- package/src/sdk/authentication.ts +16 -16
- package/src/sdk/integrations.ts +17 -17
- package/src/sdk/novumessages.ts +16 -16
- package/src/sdk/sdk.ts +24 -24
- package/src/sdk/stats.ts +10 -10
- package/src/sdk/subscribers.ts +61 -61
- package/models/components/databooleandto.d.ts +0 -29
- package/models/components/databooleandto.d.ts.map +0 -1
- package/models/components/databooleandto.js +0 -59
- package/models/components/databooleandto.js.map +0 -1
- package/src/models/components/databooleandto.ts +0 -62
|
@@ -13,7 +13,7 @@ const args = {
|
|
|
13
13
|
};
|
|
14
14
|
|
|
15
15
|
export const tool$subscribersCredentialsDelete: ToolDefinition<typeof args> = {
|
|
16
|
-
name: "subscribers-
|
|
16
|
+
name: "subscribers-credentials-delete",
|
|
17
17
|
description: `Delete subscriber credentials by providerId
|
|
18
18
|
|
|
19
19
|
Delete subscriber credentials such as slack and expo tokens.`,
|
|
@@ -15,7 +15,7 @@ const args = {
|
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
export const tool$subscribersCredentialsUpdate: ToolDefinition<typeof args> = {
|
|
18
|
-
name: "subscribers-
|
|
18
|
+
name: "subscribers-credentials-update",
|
|
19
19
|
description: `Update subscriber credentials
|
|
20
20
|
|
|
21
21
|
Subscriber credentials associated to the delivery methods such as slack and push tokens.`,
|
|
@@ -13,7 +13,7 @@ const args = {
|
|
|
13
13
|
};
|
|
14
14
|
|
|
15
15
|
export const tool$subscribersList: ToolDefinition<typeof args> = {
|
|
16
|
-
name: "
|
|
16
|
+
name: "subscribers-list",
|
|
17
17
|
description: `Get subscribers
|
|
18
18
|
|
|
19
19
|
Returns a list of subscribers, could paginated using the \`page\` and \`limit\` query parameter`,
|
|
@@ -15,7 +15,7 @@ const args = {
|
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
export const tool$subscribersMessagesMarkAll: ToolDefinition<typeof args> = {
|
|
18
|
-
name: "subscribers-
|
|
18
|
+
name: "subscribers-messages-mark-all",
|
|
19
19
|
description:
|
|
20
20
|
`Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.`,
|
|
21
21
|
args,
|
|
@@ -14,7 +14,7 @@ const args = {
|
|
|
14
14
|
};
|
|
15
15
|
|
|
16
16
|
export const tool$subscribersMessagesMarkAllAs: ToolDefinition<typeof args> = {
|
|
17
|
-
name: "subscribers-
|
|
17
|
+
name: "subscribers-messages-mark-all-as",
|
|
18
18
|
description: `Mark a subscriber messages as seen, read, unseen or unread`,
|
|
19
19
|
args,
|
|
20
20
|
tool: async (client, args, ctx) => {
|
|
@@ -13,7 +13,7 @@ const args = {
|
|
|
13
13
|
|
|
14
14
|
export const tool$subscribersMessagesUpdateAsSeen: ToolDefinition<typeof args> =
|
|
15
15
|
{
|
|
16
|
-
name: "subscribers-
|
|
16
|
+
name: "subscribers-messages-update-as-seen",
|
|
17
17
|
description: `Mark message action as seen`,
|
|
18
18
|
args,
|
|
19
19
|
tool: async (client, args, ctx) => {
|
|
@@ -12,7 +12,7 @@ const args = {
|
|
|
12
12
|
};
|
|
13
13
|
|
|
14
14
|
export const tool$subscribersNotificationsFeed: ToolDefinition<typeof args> = {
|
|
15
|
-
name: "subscribers-
|
|
15
|
+
name: "subscribers-notifications-feed",
|
|
16
16
|
description: `Get in-app notification feed for a particular subscriber`,
|
|
17
17
|
args,
|
|
18
18
|
tool: async (client, args, ctx) => {
|
|
@@ -14,7 +14,7 @@ const args = {
|
|
|
14
14
|
export const tool$subscribersNotificationsUnseenCount: ToolDefinition<
|
|
15
15
|
typeof args
|
|
16
16
|
> = {
|
|
17
|
-
name: "subscribers-
|
|
17
|
+
name: "subscribers-notifications-unseen-count",
|
|
18
18
|
description: `Get the unseen in-app notifications count for subscribers feed`,
|
|
19
19
|
args,
|
|
20
20
|
tool: async (client, args, ctx) => {
|
|
@@ -14,7 +14,7 @@ const args = {
|
|
|
14
14
|
};
|
|
15
15
|
|
|
16
16
|
export const tool$subscribersPatch: ToolDefinition<typeof args> = {
|
|
17
|
-
name: "
|
|
17
|
+
name: "subscribers-patch",
|
|
18
18
|
description: `Patch subscriber
|
|
19
19
|
|
|
20
20
|
Patch subscriber by your internal id used to identify the subscriber`,
|
|
@@ -12,7 +12,7 @@ const args = {
|
|
|
12
12
|
};
|
|
13
13
|
|
|
14
14
|
export const tool$subscribersPreferencesList: ToolDefinition<typeof args> = {
|
|
15
|
-
name: "subscribers-
|
|
15
|
+
name: "subscribers-preferences-list",
|
|
16
16
|
description: `Get subscriber preferences
|
|
17
17
|
|
|
18
18
|
Get subscriber global and workflow specific preferences`,
|
|
@@ -15,7 +15,7 @@ const args = {
|
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
export const tool$subscribersPreferencesUpdate: ToolDefinition<typeof args> = {
|
|
18
|
-
name: "subscribers-
|
|
18
|
+
name: "subscribers-preferences-update",
|
|
19
19
|
description: `Update subscriber global or workflow specific preferences
|
|
20
20
|
|
|
21
21
|
Update subscriber global or workflow specific preferences`,
|
|
@@ -17,7 +17,7 @@ const args = {
|
|
|
17
17
|
export const tool$subscribersPropertiesUpdateOnlineFlag: ToolDefinition<
|
|
18
18
|
typeof args
|
|
19
19
|
> = {
|
|
20
|
-
name: "subscribers-
|
|
20
|
+
name: "subscribers-properties-update-online-flag",
|
|
21
21
|
description: `Update subscriber online status
|
|
22
22
|
|
|
23
23
|
Used to update the subscriber isOnline flag.`,
|
|
@@ -12,7 +12,7 @@ const args = {
|
|
|
12
12
|
};
|
|
13
13
|
|
|
14
14
|
export const tool$subscribersRetrieve: ToolDefinition<typeof args> = {
|
|
15
|
-
name: "
|
|
15
|
+
name: "subscribers-retrieve",
|
|
16
16
|
description: `Get subscriber
|
|
17
17
|
|
|
18
18
|
Get subscriber by your internal id used to identify the subscriber`,
|
|
@@ -11,7 +11,7 @@ const args = {
|
|
|
11
11
|
};
|
|
12
12
|
|
|
13
13
|
export const tool$topicsList: ToolDefinition<typeof args> = {
|
|
14
|
-
name: "
|
|
14
|
+
name: "topics-list",
|
|
15
15
|
description: `Get topic list filtered
|
|
16
16
|
|
|
17
17
|
Returns a list of topics that can be paginated using the \`page\` query parameter and filtered by the topic key with the \`key\` query parameter`,
|
|
@@ -13,7 +13,7 @@ const args = {
|
|
|
13
13
|
};
|
|
14
14
|
|
|
15
15
|
export const tool$topicsSubscribersRetrieve: ToolDefinition<typeof args> = {
|
|
16
|
-
name: "topics-
|
|
16
|
+
name: "topics-subscribers-retrieve",
|
|
17
17
|
description: `Check topic subscriber
|
|
18
18
|
|
|
19
19
|
Check if a subscriber belongs to a certain topic`,
|
package/src/mcp-server/tools.ts
CHANGED
|
@@ -34,6 +34,7 @@ export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
|
|
|
34
34
|
) => CallToolResult | Promise<CallToolResult>;
|
|
35
35
|
};
|
|
36
36
|
|
|
37
|
+
// Optional function to assist with formatting tool results
|
|
37
38
|
export async function formatResult(
|
|
38
39
|
value: unknown,
|
|
39
40
|
init: { response?: Response | undefined },
|
|
@@ -102,6 +103,10 @@ export function createRegisterTool(
|
|
|
102
103
|
}
|
|
103
104
|
|
|
104
105
|
const toolScopes = tool.scopes ?? [];
|
|
106
|
+
if (allowedScopes.size > 0 && toolScopes.length === 0) {
|
|
107
|
+
return;
|
|
108
|
+
}
|
|
109
|
+
|
|
105
110
|
if (!toolScopes.every((s) => allowedScopes.has(s))) {
|
|
106
111
|
return;
|
|
107
112
|
}
|
|
@@ -79,6 +79,10 @@ export type ActivityNotificationJobResponseDto = {
|
|
|
79
79
|
* Step details of the job
|
|
80
80
|
*/
|
|
81
81
|
step: ActivityNotificationStepResponseDto;
|
|
82
|
+
/**
|
|
83
|
+
* Optional context object for additional error details.
|
|
84
|
+
*/
|
|
85
|
+
overrides?: { [k: string]: any } | undefined;
|
|
82
86
|
/**
|
|
83
87
|
* Optional payload for the job
|
|
84
88
|
*/
|
|
@@ -175,6 +179,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
|
|
|
175
179
|
ActivityNotificationExecutionDetailResponseDto$inboundSchema,
|
|
176
180
|
),
|
|
177
181
|
step: ActivityNotificationStepResponseDto$inboundSchema,
|
|
182
|
+
overrides: z.record(z.any()).optional(),
|
|
178
183
|
payload: z.lazy(() => Payload$inboundSchema).optional(),
|
|
179
184
|
providerId: ProvidersIdEnum$inboundSchema,
|
|
180
185
|
status: z.string(),
|
|
@@ -194,6 +199,7 @@ export type ActivityNotificationJobResponseDto$Outbound = {
|
|
|
194
199
|
ActivityNotificationExecutionDetailResponseDto$Outbound
|
|
195
200
|
>;
|
|
196
201
|
step: ActivityNotificationStepResponseDto$Outbound;
|
|
202
|
+
overrides?: { [k: string]: any } | undefined;
|
|
197
203
|
payload?: Payload$Outbound | undefined;
|
|
198
204
|
providerId: string;
|
|
199
205
|
status: string;
|
|
@@ -213,6 +219,7 @@ export const ActivityNotificationJobResponseDto$outboundSchema: z.ZodType<
|
|
|
213
219
|
ActivityNotificationExecutionDetailResponseDto$outboundSchema,
|
|
214
220
|
),
|
|
215
221
|
step: ActivityNotificationStepResponseDto$outboundSchema,
|
|
222
|
+
overrides: z.record(z.any()).optional(),
|
|
216
223
|
payload: z.lazy(() => Payload$outboundSchema).optional(),
|
|
217
224
|
providerId: ProvidersIdEnum$outboundSchema,
|
|
218
225
|
status: z.string(),
|
|
@@ -18,7 +18,7 @@ import {
|
|
|
18
18
|
/**
|
|
19
19
|
* The provider identifier for the credentials
|
|
20
20
|
*/
|
|
21
|
-
export const
|
|
21
|
+
export const ProviderId = {
|
|
22
22
|
Slack: "slack",
|
|
23
23
|
Discord: "discord",
|
|
24
24
|
Msteams: "msteams",
|
|
@@ -40,15 +40,13 @@ export const ChannelSettingsDtoProviderId = {
|
|
|
40
40
|
/**
|
|
41
41
|
* The provider identifier for the credentials
|
|
42
42
|
*/
|
|
43
|
-
export type
|
|
44
|
-
typeof ChannelSettingsDtoProviderId
|
|
45
|
-
>;
|
|
43
|
+
export type ProviderId = ClosedEnum<typeof ProviderId>;
|
|
46
44
|
|
|
47
45
|
export type ChannelSettingsDto = {
|
|
48
46
|
/**
|
|
49
47
|
* The provider identifier for the credentials
|
|
50
48
|
*/
|
|
51
|
-
providerId:
|
|
49
|
+
providerId: ProviderId;
|
|
52
50
|
/**
|
|
53
51
|
* The integration identifier
|
|
54
52
|
*/
|
|
@@ -64,24 +62,22 @@ export type ChannelSettingsDto = {
|
|
|
64
62
|
};
|
|
65
63
|
|
|
66
64
|
/** @internal */
|
|
67
|
-
export const
|
|
68
|
-
|
|
69
|
-
> = z.nativeEnum(ChannelSettingsDtoProviderId);
|
|
65
|
+
export const ProviderId$inboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
|
|
66
|
+
.nativeEnum(ProviderId);
|
|
70
67
|
|
|
71
68
|
/** @internal */
|
|
72
|
-
export const
|
|
73
|
-
|
|
74
|
-
> = ChannelSettingsDtoProviderId$inboundSchema;
|
|
69
|
+
export const ProviderId$outboundSchema: z.ZodNativeEnum<typeof ProviderId> =
|
|
70
|
+
ProviderId$inboundSchema;
|
|
75
71
|
|
|
76
72
|
/**
|
|
77
73
|
* @internal
|
|
78
74
|
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
79
75
|
*/
|
|
80
|
-
export namespace
|
|
81
|
-
/** @deprecated use `
|
|
82
|
-
export const inboundSchema =
|
|
83
|
-
/** @deprecated use `
|
|
84
|
-
export const outboundSchema =
|
|
76
|
+
export namespace ProviderId$ {
|
|
77
|
+
/** @deprecated use `ProviderId$inboundSchema` instead. */
|
|
78
|
+
export const inboundSchema = ProviderId$inboundSchema;
|
|
79
|
+
/** @deprecated use `ProviderId$outboundSchema` instead. */
|
|
80
|
+
export const outboundSchema = ProviderId$outboundSchema;
|
|
85
81
|
}
|
|
86
82
|
|
|
87
83
|
/** @internal */
|
|
@@ -90,7 +86,7 @@ export const ChannelSettingsDto$inboundSchema: z.ZodType<
|
|
|
90
86
|
z.ZodTypeDef,
|
|
91
87
|
unknown
|
|
92
88
|
> = z.object({
|
|
93
|
-
providerId:
|
|
89
|
+
providerId: ProviderId$inboundSchema,
|
|
94
90
|
integrationIdentifier: z.string().optional(),
|
|
95
91
|
credentials: ChannelCredentials$inboundSchema,
|
|
96
92
|
_integrationId: z.string(),
|
|
@@ -114,7 +110,7 @@ export const ChannelSettingsDto$outboundSchema: z.ZodType<
|
|
|
114
110
|
z.ZodTypeDef,
|
|
115
111
|
ChannelSettingsDto
|
|
116
112
|
> = z.object({
|
|
117
|
-
providerId:
|
|
113
|
+
providerId: ProviderId$outboundSchema,
|
|
118
114
|
integrationIdentifier: z.string().optional(),
|
|
119
115
|
credentials: ChannelCredentials$outboundSchema,
|
|
120
116
|
integrationId: z.string(),
|
|
@@ -31,7 +31,6 @@ export * from "./createsubscriberrequestdto.js";
|
|
|
31
31
|
export * from "./createtopicrequestdto.js";
|
|
32
32
|
export * from "./createtopicresponsedto.js";
|
|
33
33
|
export * from "./credentialsdto.js";
|
|
34
|
-
export * from "./databooleandto.js";
|
|
35
34
|
export * from "./delayregularmetadata.js";
|
|
36
35
|
export * from "./delayscheduledmetadata.js";
|
|
37
36
|
export * from "./deletemessageresponsedto.js";
|
|
@@ -24,7 +24,7 @@ import {
|
|
|
24
24
|
/**
|
|
25
25
|
* The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
|
|
26
26
|
*/
|
|
27
|
-
export const
|
|
27
|
+
export const IntegrationResponseDtoChannel = {
|
|
28
28
|
InApp: "in_app",
|
|
29
29
|
Email: "email",
|
|
30
30
|
Sms: "sms",
|
|
@@ -34,7 +34,9 @@ export const Channel = {
|
|
|
34
34
|
/**
|
|
35
35
|
* The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
|
|
36
36
|
*/
|
|
37
|
-
export type
|
|
37
|
+
export type IntegrationResponseDtoChannel = ClosedEnum<
|
|
38
|
+
typeof IntegrationResponseDtoChannel
|
|
39
|
+
>;
|
|
38
40
|
|
|
39
41
|
export type IntegrationResponseDto = {
|
|
40
42
|
/**
|
|
@@ -64,7 +66,7 @@ export type IntegrationResponseDto = {
|
|
|
64
66
|
/**
|
|
65
67
|
* The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
|
|
66
68
|
*/
|
|
67
|
-
channel:
|
|
69
|
+
channel: IntegrationResponseDtoChannel;
|
|
68
70
|
/**
|
|
69
71
|
* The credentials required for the integration to function, including API keys and other sensitive information.
|
|
70
72
|
*/
|
|
@@ -96,22 +98,24 @@ export type IntegrationResponseDto = {
|
|
|
96
98
|
};
|
|
97
99
|
|
|
98
100
|
/** @internal */
|
|
99
|
-
export const
|
|
100
|
-
|
|
101
|
+
export const IntegrationResponseDtoChannel$inboundSchema: z.ZodNativeEnum<
|
|
102
|
+
typeof IntegrationResponseDtoChannel
|
|
103
|
+
> = z.nativeEnum(IntegrationResponseDtoChannel);
|
|
101
104
|
|
|
102
105
|
/** @internal */
|
|
103
|
-
export const
|
|
104
|
-
|
|
106
|
+
export const IntegrationResponseDtoChannel$outboundSchema: z.ZodNativeEnum<
|
|
107
|
+
typeof IntegrationResponseDtoChannel
|
|
108
|
+
> = IntegrationResponseDtoChannel$inboundSchema;
|
|
105
109
|
|
|
106
110
|
/**
|
|
107
111
|
* @internal
|
|
108
112
|
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
109
113
|
*/
|
|
110
|
-
export namespace
|
|
111
|
-
/** @deprecated use `
|
|
112
|
-
export const inboundSchema =
|
|
113
|
-
/** @deprecated use `
|
|
114
|
-
export const outboundSchema =
|
|
114
|
+
export namespace IntegrationResponseDtoChannel$ {
|
|
115
|
+
/** @deprecated use `IntegrationResponseDtoChannel$inboundSchema` instead. */
|
|
116
|
+
export const inboundSchema = IntegrationResponseDtoChannel$inboundSchema;
|
|
117
|
+
/** @deprecated use `IntegrationResponseDtoChannel$outboundSchema` instead. */
|
|
118
|
+
export const outboundSchema = IntegrationResponseDtoChannel$outboundSchema;
|
|
115
119
|
}
|
|
116
120
|
|
|
117
121
|
/** @internal */
|
|
@@ -126,7 +130,7 @@ export const IntegrationResponseDto$inboundSchema: z.ZodType<
|
|
|
126
130
|
name: z.string(),
|
|
127
131
|
identifier: z.string(),
|
|
128
132
|
providerId: z.string(),
|
|
129
|
-
channel:
|
|
133
|
+
channel: IntegrationResponseDtoChannel$inboundSchema,
|
|
130
134
|
credentials: CredentialsDto$inboundSchema,
|
|
131
135
|
active: z.boolean(),
|
|
132
136
|
deleted: z.boolean(),
|
|
@@ -172,7 +176,7 @@ export const IntegrationResponseDto$outboundSchema: z.ZodType<
|
|
|
172
176
|
name: z.string(),
|
|
173
177
|
identifier: z.string(),
|
|
174
178
|
providerId: z.string(),
|
|
175
|
-
channel:
|
|
179
|
+
channel: IntegrationResponseDtoChannel$outboundSchema,
|
|
176
180
|
credentials: CredentialsDto$outboundSchema,
|
|
177
181
|
active: z.boolean(),
|
|
178
182
|
deleted: z.boolean(),
|
|
@@ -16,7 +16,7 @@ export type FeedIdentifier = string | Array<string>;
|
|
|
16
16
|
/**
|
|
17
17
|
* Mark all subscriber messages as read, unread, seen or unseen
|
|
18
18
|
*/
|
|
19
|
-
export const
|
|
19
|
+
export const MarkAs = {
|
|
20
20
|
Read: "read",
|
|
21
21
|
Seen: "seen",
|
|
22
22
|
Unread: "unread",
|
|
@@ -25,9 +25,7 @@ export const MarkAllMessageAsRequestDtoMarkAs = {
|
|
|
25
25
|
/**
|
|
26
26
|
* Mark all subscriber messages as read, unread, seen or unseen
|
|
27
27
|
*/
|
|
28
|
-
export type
|
|
29
|
-
typeof MarkAllMessageAsRequestDtoMarkAs
|
|
30
|
-
>;
|
|
28
|
+
export type MarkAs = ClosedEnum<typeof MarkAs>;
|
|
31
29
|
|
|
32
30
|
export type MarkAllMessageAsRequestDto = {
|
|
33
31
|
/**
|
|
@@ -37,7 +35,7 @@ export type MarkAllMessageAsRequestDto = {
|
|
|
37
35
|
/**
|
|
38
36
|
* Mark all subscriber messages as read, unread, seen or unseen
|
|
39
37
|
*/
|
|
40
|
-
markAs:
|
|
38
|
+
markAs: MarkAs;
|
|
41
39
|
};
|
|
42
40
|
|
|
43
41
|
/** @internal */
|
|
@@ -85,24 +83,22 @@ export function feedIdentifierFromJSON(
|
|
|
85
83
|
}
|
|
86
84
|
|
|
87
85
|
/** @internal */
|
|
88
|
-
export const
|
|
89
|
-
|
|
90
|
-
> = z.nativeEnum(MarkAllMessageAsRequestDtoMarkAs);
|
|
86
|
+
export const MarkAs$inboundSchema: z.ZodNativeEnum<typeof MarkAs> = z
|
|
87
|
+
.nativeEnum(MarkAs);
|
|
91
88
|
|
|
92
89
|
/** @internal */
|
|
93
|
-
export const
|
|
94
|
-
|
|
95
|
-
> = MarkAllMessageAsRequestDtoMarkAs$inboundSchema;
|
|
90
|
+
export const MarkAs$outboundSchema: z.ZodNativeEnum<typeof MarkAs> =
|
|
91
|
+
MarkAs$inboundSchema;
|
|
96
92
|
|
|
97
93
|
/**
|
|
98
94
|
* @internal
|
|
99
95
|
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
100
96
|
*/
|
|
101
|
-
export namespace
|
|
102
|
-
/** @deprecated use `
|
|
103
|
-
export const inboundSchema =
|
|
104
|
-
/** @deprecated use `
|
|
105
|
-
export const outboundSchema =
|
|
97
|
+
export namespace MarkAs$ {
|
|
98
|
+
/** @deprecated use `MarkAs$inboundSchema` instead. */
|
|
99
|
+
export const inboundSchema = MarkAs$inboundSchema;
|
|
100
|
+
/** @deprecated use `MarkAs$outboundSchema` instead. */
|
|
101
|
+
export const outboundSchema = MarkAs$outboundSchema;
|
|
106
102
|
}
|
|
107
103
|
|
|
108
104
|
/** @internal */
|
|
@@ -112,7 +108,7 @@ export const MarkAllMessageAsRequestDto$inboundSchema: z.ZodType<
|
|
|
112
108
|
unknown
|
|
113
109
|
> = z.object({
|
|
114
110
|
feedIdentifier: z.union([z.string(), z.array(z.string())]).optional(),
|
|
115
|
-
markAs:
|
|
111
|
+
markAs: MarkAs$inboundSchema,
|
|
116
112
|
});
|
|
117
113
|
|
|
118
114
|
/** @internal */
|
|
@@ -128,7 +124,7 @@ export const MarkAllMessageAsRequestDto$outboundSchema: z.ZodType<
|
|
|
128
124
|
MarkAllMessageAsRequestDto
|
|
129
125
|
> = z.object({
|
|
130
126
|
feedIdentifier: z.union([z.string(), z.array(z.string())]).optional(),
|
|
131
|
-
markAs:
|
|
127
|
+
markAs: MarkAs$outboundSchema,
|
|
132
128
|
});
|
|
133
129
|
|
|
134
130
|
/**
|
|
@@ -10,17 +10,19 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
|
10
10
|
|
|
11
11
|
export type MessageId = string | Array<string>;
|
|
12
12
|
|
|
13
|
-
export const
|
|
13
|
+
export const MessageMarkAsRequestDtoMarkAs = {
|
|
14
14
|
Read: "read",
|
|
15
15
|
Seen: "seen",
|
|
16
16
|
Unread: "unread",
|
|
17
17
|
Unseen: "unseen",
|
|
18
18
|
} as const;
|
|
19
|
-
export type
|
|
19
|
+
export type MessageMarkAsRequestDtoMarkAs = ClosedEnum<
|
|
20
|
+
typeof MessageMarkAsRequestDtoMarkAs
|
|
21
|
+
>;
|
|
20
22
|
|
|
21
23
|
export type MessageMarkAsRequestDto = {
|
|
22
24
|
messageId: string | Array<string>;
|
|
23
|
-
markAs:
|
|
25
|
+
markAs: MessageMarkAsRequestDtoMarkAs;
|
|
24
26
|
};
|
|
25
27
|
|
|
26
28
|
/** @internal */
|
|
@@ -68,22 +70,24 @@ export function messageIdFromJSON(
|
|
|
68
70
|
}
|
|
69
71
|
|
|
70
72
|
/** @internal */
|
|
71
|
-
export const
|
|
72
|
-
|
|
73
|
+
export const MessageMarkAsRequestDtoMarkAs$inboundSchema: z.ZodNativeEnum<
|
|
74
|
+
typeof MessageMarkAsRequestDtoMarkAs
|
|
75
|
+
> = z.nativeEnum(MessageMarkAsRequestDtoMarkAs);
|
|
73
76
|
|
|
74
77
|
/** @internal */
|
|
75
|
-
export const
|
|
76
|
-
|
|
78
|
+
export const MessageMarkAsRequestDtoMarkAs$outboundSchema: z.ZodNativeEnum<
|
|
79
|
+
typeof MessageMarkAsRequestDtoMarkAs
|
|
80
|
+
> = MessageMarkAsRequestDtoMarkAs$inboundSchema;
|
|
77
81
|
|
|
78
82
|
/**
|
|
79
83
|
* @internal
|
|
80
84
|
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
81
85
|
*/
|
|
82
|
-
export namespace
|
|
83
|
-
/** @deprecated use `
|
|
84
|
-
export const inboundSchema =
|
|
85
|
-
/** @deprecated use `
|
|
86
|
-
export const outboundSchema =
|
|
86
|
+
export namespace MessageMarkAsRequestDtoMarkAs$ {
|
|
87
|
+
/** @deprecated use `MessageMarkAsRequestDtoMarkAs$inboundSchema` instead. */
|
|
88
|
+
export const inboundSchema = MessageMarkAsRequestDtoMarkAs$inboundSchema;
|
|
89
|
+
/** @deprecated use `MessageMarkAsRequestDtoMarkAs$outboundSchema` instead. */
|
|
90
|
+
export const outboundSchema = MessageMarkAsRequestDtoMarkAs$outboundSchema;
|
|
87
91
|
}
|
|
88
92
|
|
|
89
93
|
/** @internal */
|
|
@@ -93,7 +97,7 @@ export const MessageMarkAsRequestDto$inboundSchema: z.ZodType<
|
|
|
93
97
|
unknown
|
|
94
98
|
> = z.object({
|
|
95
99
|
messageId: z.union([z.string(), z.array(z.string())]),
|
|
96
|
-
markAs:
|
|
100
|
+
markAs: MessageMarkAsRequestDtoMarkAs$inboundSchema,
|
|
97
101
|
});
|
|
98
102
|
|
|
99
103
|
/** @internal */
|
|
@@ -109,7 +113,7 @@ export const MessageMarkAsRequestDto$outboundSchema: z.ZodType<
|
|
|
109
113
|
MessageMarkAsRequestDto
|
|
110
114
|
> = z.object({
|
|
111
115
|
messageId: z.union([z.string(), z.array(z.string())]),
|
|
112
|
-
markAs:
|
|
116
|
+
markAs: MessageMarkAsRequestDtoMarkAs$outboundSchema,
|
|
113
117
|
});
|
|
114
118
|
|
|
115
119
|
/**
|