@novu/api 1.5.0 → 1.6.1-rc.0

package/src/mcp-server/tools/translationsMasterUpload.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsMasterUpload } from "../../funcs/translationsMasterUpload.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsMasterUpload: ToolDefinition<typeof args> = {
+  name: "translations-master-upload",
+  description: `Upload master translations JSON file
+
+Upload a master JSON file containing translations. Locale is automatically detected from filename (e.g., en_US.json)`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsMasterUpload(
+      client,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/translationsRetrieve.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { translationsRetrieve } from "../../funcs/translationsRetrieve.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.TranslationControllerGetSingleTranslationRequest$inboundSchema,
+};
+
+export const tool$translationsRetrieve: ToolDefinition<typeof args> = {
+  name: "translations-retrieve",
+  description: `Get single translation
+
+Get a specific translation by resource type, resource ID and locale`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsRetrieve(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/translationsUpload.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsUpload } from "../../funcs/translationsUpload.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  uploadTranslationsRequestDto:
+    components.UploadTranslationsRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsUpload: ToolDefinition<typeof args> = {
+  name: "translations-upload",
+  description: `Upload translation files
+
+Upload one or more JSON translation files for a specific workflow. The file name must be the locale, e.g. en_US.json`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsUpload(
+      client,
+      args.uploadTranslationsRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/trigger.ts

@@ -17,10 +17,8 @@ export const tool$trigger: ToolDefinition<typeof args> = {
   description: `Trigger event
 
 
-    Trigger event is the main (and only) way to send notifications to subscribers. 
-    The trigger identifier is used to match the particular workflow associated with it. 
-    Additional information can be passed according the body interface below.
-    `,
+    Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
+    To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await trigger(

package/src/models/components/activitynotificationexecutiondetailresponsedto.ts

@@ -51,7 +51,7 @@ export type ActivityNotificationExecutionDetailResponseDto = {
   /**
    * Provider ID of the job
    */
-  providerId: ProvidersIdEnum;
+  providerId?: ProvidersIdEnum | undefined;
   /**
    * Raw data of the execution
    */
@@ -75,7 +75,7 @@ export const ActivityNotificationExecutionDetailResponseDto$inboundSchema:
     detail: z.string(),
     isRetry: z.boolean(),
     isTest: z.boolean(),
-    providerId: ProvidersIdEnum$inboundSchema,
+    providerId: ProvidersIdEnum$inboundSchema.optional(),
     raw: z.nullable(z.string()).optional(),
     source: ExecutionDetailsSourceEnum$inboundSchema,
   }).transform((v) => {
@@ -92,7 +92,7 @@ export type ActivityNotificationExecutionDetailResponseDto$Outbound = {
   detail: string;
   isRetry: boolean;
   isTest: boolean;
-  providerId: string;
+  providerId?: string | undefined;
   raw?: string | null | undefined;
   source: string;
 };
@@ -110,7 +110,7 @@ export const ActivityNotificationExecutionDetailResponseDto$outboundSchema:
     detail: z.string(),
     isRetry: z.boolean(),
     isTest: z.boolean(),
-    providerId: ProvidersIdEnum$outboundSchema,
+    providerId: ProvidersIdEnum$outboundSchema.optional(),
     raw: z.nullable(z.string()).optional(),
     source: ExecutionDetailsSourceEnum$outboundSchema,
   }).transform((v) => {

package/src/models/components/activitynotificationresponsedto.ts

@@ -31,6 +31,11 @@ import {
   ActivityTopicDto$Outbound,
   ActivityTopicDto$outboundSchema,
 } from "./activitytopicdto.js";
+import {
+  SeverityLevelEnum,
+  SeverityLevelEnum$inboundSchema,
+  SeverityLevelEnum$outboundSchema,
+} from "./severitylevelenum.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -122,6 +127,14 @@ export type ActivityNotificationResponseDto = {
    * Topics of the notification
    */
   topics?: Array<ActivityTopicDto> | undefined;
+  /**
+   * Severity of the workflow
+   */
+  severity?: SeverityLevelEnum | undefined;
+  /**
+   * Criticality of the notification
+   */
+  critical?: boolean | undefined;
 };
 
 /** @internal */
@@ -299,6 +312,8 @@ export const ActivityNotificationResponseDto$inboundSchema: z.ZodType<
   controls: z.lazy(() => Controls$inboundSchema).optional(),
   to: z.lazy(() => ActivityNotificationResponseDtoTo$inboundSchema).optional(),
   topics: z.array(ActivityTopicDto$inboundSchema).optional(),
+  severity: SeverityLevelEnum$inboundSchema.optional(),
+  critical: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -330,6 +345,8 @@ export type ActivityNotificationResponseDto$Outbound = {
   controls?: Controls$Outbound | undefined;
   to?: ActivityNotificationResponseDtoTo$Outbound | undefined;
   topics?: Array<ActivityTopicDto$Outbound> | undefined;
+  severity?: string | undefined;
+  critical?: boolean | undefined;
 };
 
 /** @internal */
@@ -358,6 +375,8 @@ export const ActivityNotificationResponseDto$outboundSchema: z.ZodType<
   controls: z.lazy(() => Controls$outboundSchema).optional(),
   to: z.lazy(() => ActivityNotificationResponseDtoTo$outboundSchema).optional(),
   topics: z.array(ActivityTopicDto$outboundSchema).optional(),
+  severity: SeverityLevelEnum$outboundSchema.optional(),
+  critical: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/activitynotificationtemplateresponsedto.ts

@@ -29,7 +29,7 @@ export type ActivityNotificationTemplateResponseDto = {
    */
   name: string;
   /**
-   * Origin of the workflow
+   * Origin of the layout
    */
   origin?: ResourceOriginEnum | undefined;
   /**

package/src/models/components/autoconfigureintegrationresponsedto.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The updated configurations after auto-configuration
+ */
+export type Integration = {};
+
+export type AutoConfigureIntegrationResponseDto = {
+  /**
+   * Indicates whether the auto-configuration was successful
+   */
+  success: boolean;
+  /**
+   * Optional message describing the result or any errors that occurred
+   */
+  message?: string | undefined;
+  /**
+   * The updated configurations after auto-configuration
+   */
+  integration?: Integration | undefined;
+};
+
+/** @internal */
+export const Integration$inboundSchema: z.ZodType<
+  Integration,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type Integration$Outbound = {};
+
+/** @internal */
+export const Integration$outboundSchema: z.ZodType<
+  Integration$Outbound,
+  z.ZodTypeDef,
+  Integration
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Integration$ {
+  /** @deprecated use `Integration$inboundSchema` instead. */
+  export const inboundSchema = Integration$inboundSchema;
+  /** @deprecated use `Integration$outboundSchema` instead. */
+  export const outboundSchema = Integration$outboundSchema;
+  /** @deprecated use `Integration$Outbound` instead. */
+  export type Outbound = Integration$Outbound;
+}
+
+export function integrationToJSON(integration: Integration): string {
+  return JSON.stringify(Integration$outboundSchema.parse(integration));
+}
+
+export function integrationFromJSON(
+  jsonString: string,
+): SafeParseResult<Integration, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Integration$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Integration' from JSON`,
+  );
+}
+
+/** @internal */
+export const AutoConfigureIntegrationResponseDto$inboundSchema: z.ZodType<
+  AutoConfigureIntegrationResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean(),
+  message: z.string().optional(),
+  integration: z.lazy(() => Integration$inboundSchema).optional(),
+});
+
+/** @internal */
+export type AutoConfigureIntegrationResponseDto$Outbound = {
+  success: boolean;
+  message?: string | undefined;
+  integration?: Integration$Outbound | undefined;
+};
+
+/** @internal */
+export const AutoConfigureIntegrationResponseDto$outboundSchema: z.ZodType<
+  AutoConfigureIntegrationResponseDto$Outbound,
+  z.ZodTypeDef,
+  AutoConfigureIntegrationResponseDto
+> = z.object({
+  success: z.boolean(),
+  message: z.string().optional(),
+  integration: z.lazy(() => Integration$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AutoConfigureIntegrationResponseDto$ {
+  /** @deprecated use `AutoConfigureIntegrationResponseDto$inboundSchema` instead. */
+  export const inboundSchema =
+    AutoConfigureIntegrationResponseDto$inboundSchema;
+  /** @deprecated use `AutoConfigureIntegrationResponseDto$outboundSchema` instead. */
+  export const outboundSchema =
+    AutoConfigureIntegrationResponseDto$outboundSchema;
+  /** @deprecated use `AutoConfigureIntegrationResponseDto$Outbound` instead. */
+  export type Outbound = AutoConfigureIntegrationResponseDto$Outbound;
+}
+
+export function autoConfigureIntegrationResponseDtoToJSON(
+  autoConfigureIntegrationResponseDto: AutoConfigureIntegrationResponseDto,
+): string {
+  return JSON.stringify(
+    AutoConfigureIntegrationResponseDto$outboundSchema.parse(
+      autoConfigureIntegrationResponseDto,
+    ),
+  );
+}
+
+export function autoConfigureIntegrationResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AutoConfigureIntegrationResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AutoConfigureIntegrationResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AutoConfigureIntegrationResponseDto' from JSON`,
+  );
+}

package/src/models/components/bulkupdatesubscriberpreferenceitemdto.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PatchPreferenceChannelsDto,
+  PatchPreferenceChannelsDto$inboundSchema,
+  PatchPreferenceChannelsDto$Outbound,
+  PatchPreferenceChannelsDto$outboundSchema,
+} from "./patchpreferencechannelsdto.js";
+
+export type BulkUpdateSubscriberPreferenceItemDto = {
+  /**
+   * Channel-specific preference settings
+   */
+  channels: PatchPreferenceChannelsDto;
+  /**
+   * Workflow internal _id, identifier or slug
+   */
+  workflowId: string;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferenceItemDto$inboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferenceItemDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channels: PatchPreferenceChannelsDto$inboundSchema,
+  workflowId: z.string(),
+});
+
+/** @internal */
+export type BulkUpdateSubscriberPreferenceItemDto$Outbound = {
+  channels: PatchPreferenceChannelsDto$Outbound;
+  workflowId: string;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferenceItemDto$outboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferenceItemDto$Outbound,
+  z.ZodTypeDef,
+  BulkUpdateSubscriberPreferenceItemDto
+> = z.object({
+  channels: PatchPreferenceChannelsDto$outboundSchema,
+  workflowId: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BulkUpdateSubscriberPreferenceItemDto$ {
+  /** @deprecated use `BulkUpdateSubscriberPreferenceItemDto$inboundSchema` instead. */
+  export const inboundSchema =
+    BulkUpdateSubscriberPreferenceItemDto$inboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferenceItemDto$outboundSchema` instead. */
+  export const outboundSchema =
+    BulkUpdateSubscriberPreferenceItemDto$outboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferenceItemDto$Outbound` instead. */
+  export type Outbound = BulkUpdateSubscriberPreferenceItemDto$Outbound;
+}
+
+export function bulkUpdateSubscriberPreferenceItemDtoToJSON(
+  bulkUpdateSubscriberPreferenceItemDto: BulkUpdateSubscriberPreferenceItemDto,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferenceItemDto$outboundSchema.parse(
+      bulkUpdateSubscriberPreferenceItemDto,
+    ),
+  );
+}
+
+export function bulkUpdateSubscriberPreferenceItemDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BulkUpdateSubscriberPreferenceItemDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BulkUpdateSubscriberPreferenceItemDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BulkUpdateSubscriberPreferenceItemDto' from JSON`,
+  );
+}

package/src/models/components/bulkupdatesubscriberpreferencesdto.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BulkUpdateSubscriberPreferenceItemDto,
+  BulkUpdateSubscriberPreferenceItemDto$inboundSchema,
+  BulkUpdateSubscriberPreferenceItemDto$Outbound,
+  BulkUpdateSubscriberPreferenceItemDto$outboundSchema,
+} from "./bulkupdatesubscriberpreferenceitemdto.js";
+
+export type BulkUpdateSubscriberPreferencesDto = {
+  /**
+   * Array of workflow preferences to update (maximum 100 items)
+   */
+  preferences: Array<BulkUpdateSubscriberPreferenceItemDto>;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDto$inboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferencesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$inboundSchema),
+});
+
+/** @internal */
+export type BulkUpdateSubscriberPreferencesDto$Outbound = {
+  preferences: Array<BulkUpdateSubscriberPreferenceItemDto$Outbound>;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDto$outboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferencesDto$Outbound,
+  z.ZodTypeDef,
+  BulkUpdateSubscriberPreferencesDto
+> = z.object({
+  preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BulkUpdateSubscriberPreferencesDto$ {
+  /** @deprecated use `BulkUpdateSubscriberPreferencesDto$inboundSchema` instead. */
+  export const inboundSchema = BulkUpdateSubscriberPreferencesDto$inboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferencesDto$outboundSchema` instead. */
+  export const outboundSchema =
+    BulkUpdateSubscriberPreferencesDto$outboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferencesDto$Outbound` instead. */
+  export type Outbound = BulkUpdateSubscriberPreferencesDto$Outbound;
+}
+
+export function bulkUpdateSubscriberPreferencesDtoToJSON(
+  bulkUpdateSubscriberPreferencesDto: BulkUpdateSubscriberPreferencesDto,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferencesDto$outboundSchema.parse(
+      bulkUpdateSubscriberPreferencesDto,
+    ),
+  );
+}
+
+export function bulkUpdateSubscriberPreferencesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BulkUpdateSubscriberPreferencesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BulkUpdateSubscriberPreferencesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BulkUpdateSubscriberPreferencesDto' from JSON`,
+  );
+}

package/src/models/components/chatorpushproviderenum.ts

@@ -20,6 +20,7 @@ export const ChatOrPushProviderEnum = {
   RocketChat: "rocket-chat",
   WhatsappBusiness: "whatsapp-business",
   ChatWebhook: "chat-webhook",
+  NovuSlack: "novu-slack",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/chatstepresponsedto.ts

@@ -87,7 +87,7 @@ export type ChatStepResponseDto = {
    */
   type: StepTypeEnum;
   /**
-   * Origin of the workflow
+   * Origin of the layout
    */
   origin: ResourceOriginEnum;
   /**

package/src/models/components/configurationsdto.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ConfigurationsDto = {
+  inboundWebhookEnabled?: boolean | undefined;
+  inboundWebhookSigningKey?: string | undefined;
+};
+
+/** @internal */
+export const ConfigurationsDto$inboundSchema: z.ZodType<
+  ConfigurationsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inboundWebhookEnabled: z.boolean().optional(),
+  inboundWebhookSigningKey: z.string().optional(),
+});
+
+/** @internal */
+export type ConfigurationsDto$Outbound = {
+  inboundWebhookEnabled?: boolean | undefined;
+  inboundWebhookSigningKey?: string | undefined;
+};
+
+/** @internal */
+export const ConfigurationsDto$outboundSchema: z.ZodType<
+  ConfigurationsDto$Outbound,
+  z.ZodTypeDef,
+  ConfigurationsDto
+> = z.object({
+  inboundWebhookEnabled: z.boolean().optional(),
+  inboundWebhookSigningKey: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConfigurationsDto$ {
+  /** @deprecated use `ConfigurationsDto$inboundSchema` instead. */
+  export const inboundSchema = ConfigurationsDto$inboundSchema;
+  /** @deprecated use `ConfigurationsDto$outboundSchema` instead. */
+  export const outboundSchema = ConfigurationsDto$outboundSchema;
+  /** @deprecated use `ConfigurationsDto$Outbound` instead. */
+  export type Outbound = ConfigurationsDto$Outbound;
+}
+
+export function configurationsDtoToJSON(
+  configurationsDto: ConfigurationsDto,
+): string {
+  return JSON.stringify(
+    ConfigurationsDto$outboundSchema.parse(configurationsDto),
+  );
+}
+
+export function configurationsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ConfigurationsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConfigurationsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConfigurationsDto' from JSON`,
+  );
+}