@novu/api 1.3.0 → 1.5.0

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

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsCreate } from "../../funcs/workflowsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  createWorkflowDto: components.CreateWorkflowDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsCreate: ToolDefinition<typeof args> = {
+  name: "workflows-create",
+  description: `Create a workflow
+
+Creates a new workflow in the Novu Cloud environment`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsCreate(
+      client,
+      args.createWorkflowDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsDelete } from "../../funcs/workflowsDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  workflowId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsDelete: ToolDefinition<typeof args> = {
+  name: "workflows-delete",
+  description: `Delete a workflow
+
+Removes a specific workflow by its unique identifier **workflowId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsDelete(
+      client,
+      args.workflowId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsGet } from "../../funcs/workflowsGet.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  workflowId: z.string(),
+  environmentId: z.string().optional(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsGet: ToolDefinition<typeof args> = {
+  name: "workflows-get",
+  description: `Retrieve a workflow
+
+Fetches details of a specific workflow by its unique identifier **workflowId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsGet(
+      client,
+      args.workflowId,
+      args.environmentId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { workflowsList } from "../../funcs/workflowsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.WorkflowControllerSearchWorkflowsRequest$inboundSchema,
+};
+
+export const tool$workflowsList: ToolDefinition<typeof args> = {
+  name: "workflows-list",
+  description: `List all workflows
+
+Retrieves a list of workflows with optional filtering and pagination`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsList(
+      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.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsPatch } from "../../funcs/workflowsPatch.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  patchWorkflowDto: components.PatchWorkflowDto$inboundSchema,
+  workflowId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsPatch: ToolDefinition<typeof args> = {
+  name: "workflows-patch",
+  description: `Update a workflow
+
+Partially updates a workflow by its unique identifier **workflowId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsPatch(
+      client,
+      args.patchWorkflowDto,
+      args.workflowId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsStepsRetrieve } from "../../funcs/workflowsStepsRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  workflowId: z.string(),
+  stepId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsStepsRetrieve: ToolDefinition<typeof args> = {
+  name: "workflows-steps-retrieve",
+  description: `Retrieve workflow step
+
+Retrieves data for a specific step in a workflow`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsStepsRetrieve(
+      client,
+      args.workflowId,
+      args.stepId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsSync } from "../../funcs/workflowsSync.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  syncWorkflowDto: components.SyncWorkflowDto$inboundSchema,
+  workflowId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsSync: ToolDefinition<typeof args> = {
+  name: "workflows-sync",
+  description: `Sync a workflow
+
+Synchronizes a workflow to the target environment`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsSync(
+      client,
+      args.syncWorkflowDto,
+      args.workflowId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { workflowsUpdate } from "../../funcs/workflowsUpdate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  updateWorkflowDto: components.UpdateWorkflowDto$inboundSchema,
+  workflowId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$workflowsUpdate: ToolDefinition<typeof args> = {
+  name: "workflows-update",
+  description: `Update a workflow
+
+Updates the details of an existing workflow, here **workflowId** is the identifier of the workflow`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await workflowsUpdate(
+      client,
+      args.updateWorkflowDto,
+      args.workflowId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/actiondto.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 {
+  RedirectDto,
+  RedirectDto$inboundSchema,
+  RedirectDto$Outbound,
+  RedirectDto$outboundSchema,
+} from "./redirectdto.js";
+
+export type ActionDto = {
+  /**
+   * Label for the action button.
+   */
+  label?: string | undefined;
+  /**
+   * Redirect configuration for the action.
+   */
+  redirect?: RedirectDto | undefined;
+};
+
+/** @internal */
+export const ActionDto$inboundSchema: z.ZodType<
+  ActionDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  label: z.string().optional(),
+  redirect: RedirectDto$inboundSchema.optional(),
+});
+
+/** @internal */
+export type ActionDto$Outbound = {
+  label?: string | undefined;
+  redirect?: RedirectDto$Outbound | undefined;
+};
+
+/** @internal */
+export const ActionDto$outboundSchema: z.ZodType<
+  ActionDto$Outbound,
+  z.ZodTypeDef,
+  ActionDto
+> = z.object({
+  label: z.string().optional(),
+  redirect: RedirectDto$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 ActionDto$ {
+  /** @deprecated use `ActionDto$inboundSchema` instead. */
+  export const inboundSchema = ActionDto$inboundSchema;
+  /** @deprecated use `ActionDto$outboundSchema` instead. */
+  export const outboundSchema = ActionDto$outboundSchema;
+  /** @deprecated use `ActionDto$Outbound` instead. */
+  export type Outbound = ActionDto$Outbound;
+}
+
+export function actionDtoToJSON(actionDto: ActionDto): string {
+  return JSON.stringify(ActionDto$outboundSchema.parse(actionDto));
+}
+
+export function actionDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ActionDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActionDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActionDto' from JSON`,
+  );
+}

package/src/models/components/activitynotificationtemplateresponsedto.ts

@@ -14,10 +14,10 @@ import {
   NotificationTriggerDto$outboundSchema,
 } from "./notificationtriggerdto.js";
 import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 
 export type ActivityNotificationTemplateResponseDto = {
   /**
@@ -31,7 +31,7 @@ export type ActivityNotificationTemplateResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin?: WorkflowOriginEnum | undefined;
+  origin?: ResourceOriginEnum | undefined;
   /**
    * Triggers of the template
    */
@@ -46,7 +46,7 @@ export const ActivityNotificationTemplateResponseDto$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string().optional(),
   name: z.string(),
-  origin: WorkflowOriginEnum$inboundSchema.optional(),
+  origin: ResourceOriginEnum$inboundSchema.optional(),
   triggers: z.array(NotificationTriggerDto$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
@@ -70,7 +70,7 @@ export const ActivityNotificationTemplateResponseDto$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string().optional(),
   name: z.string(),
-  origin: WorkflowOriginEnum$outboundSchema.optional(),
+  origin: ResourceOriginEnum$outboundSchema.optional(),
   triggers: z.array(NotificationTriggerDto$outboundSchema),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/apikeydto.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ApiKeyDto = {
+  /**
+   * API key
+   */
+  key: string;
+  /**
+   * User ID associated with the API key
+   */
+  userId: string;
+  /**
+   * Hashed representation of the API key
+   */
+  hash?: string | undefined;
+};
+
+/** @internal */
+export const ApiKeyDto$inboundSchema: z.ZodType<
+  ApiKeyDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  _userId: z.string(),
+  hash: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_userId": "userId",
+  });
+});
+
+/** @internal */
+export type ApiKeyDto$Outbound = {
+  key: string;
+  _userId: string;
+  hash?: string | undefined;
+};
+
+/** @internal */
+export const ApiKeyDto$outboundSchema: z.ZodType<
+  ApiKeyDto$Outbound,
+  z.ZodTypeDef,
+  ApiKeyDto
+> = z.object({
+  key: z.string(),
+  userId: z.string(),
+  hash: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    userId: "_userId",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ApiKeyDto$ {
+  /** @deprecated use `ApiKeyDto$inboundSchema` instead. */
+  export const inboundSchema = ApiKeyDto$inboundSchema;
+  /** @deprecated use `ApiKeyDto$outboundSchema` instead. */
+  export const outboundSchema = ApiKeyDto$outboundSchema;
+  /** @deprecated use `ApiKeyDto$Outbound` instead. */
+  export type Outbound = ApiKeyDto$Outbound;
+}
+
+export function apiKeyDtoToJSON(apiKeyDto: ApiKeyDto): string {
+  return JSON.stringify(ApiKeyDto$outboundSchema.parse(apiKeyDto));
+}
+
+export function apiKeyDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKeyDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKeyDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKeyDto' from JSON`,
+  );
+}

package/src/models/components/bridgeconfigurationdto.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 BridgeConfigurationDto = {
+  url?: string | undefined;
+};
+
+/** @internal */
+export const BridgeConfigurationDto$inboundSchema: z.ZodType<
+  BridgeConfigurationDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string().optional(),
+});
+
+/** @internal */
+export type BridgeConfigurationDto$Outbound = {
+  url?: string | undefined;
+};
+
+/** @internal */
+export const BridgeConfigurationDto$outboundSchema: z.ZodType<
+  BridgeConfigurationDto$Outbound,
+  z.ZodTypeDef,
+  BridgeConfigurationDto
+> = z.object({
+  url: 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 BridgeConfigurationDto$ {
+  /** @deprecated use `BridgeConfigurationDto$inboundSchema` instead. */
+  export const inboundSchema = BridgeConfigurationDto$inboundSchema;
+  /** @deprecated use `BridgeConfigurationDto$outboundSchema` instead. */
+  export const outboundSchema = BridgeConfigurationDto$outboundSchema;
+  /** @deprecated use `BridgeConfigurationDto$Outbound` instead. */
+  export type Outbound = BridgeConfigurationDto$Outbound;
+}
+
+export function bridgeConfigurationDtoToJSON(
+  bridgeConfigurationDto: BridgeConfigurationDto,
+): string {
+  return JSON.stringify(
+    BridgeConfigurationDto$outboundSchema.parse(bridgeConfigurationDto),
+  );
+}
+
+export function bridgeConfigurationDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BridgeConfigurationDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BridgeConfigurationDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BridgeConfigurationDto' from JSON`,
+  );
+}

package/src/models/components/channelpreferencedto.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 ChannelPreferenceDto = {
+  /**
+   * A flag specifying if notification delivery is enabled for the channel. If true, notification delivery is enabled.
+   */
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export const ChannelPreferenceDto$inboundSchema: z.ZodType<
+  ChannelPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean().default(true),
+});
+
+/** @internal */
+export type ChannelPreferenceDto$Outbound = {
+  enabled: boolean;
+};
+
+/** @internal */
+export const ChannelPreferenceDto$outboundSchema: z.ZodType<
+  ChannelPreferenceDto$Outbound,
+  z.ZodTypeDef,
+  ChannelPreferenceDto
+> = z.object({
+  enabled: z.boolean().default(true),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelPreferenceDto$ {
+  /** @deprecated use `ChannelPreferenceDto$inboundSchema` instead. */
+  export const inboundSchema = ChannelPreferenceDto$inboundSchema;
+  /** @deprecated use `ChannelPreferenceDto$outboundSchema` instead. */
+  export const outboundSchema = ChannelPreferenceDto$outboundSchema;
+  /** @deprecated use `ChannelPreferenceDto$Outbound` instead. */
+  export type Outbound = ChannelPreferenceDto$Outbound;
+}
+
+export function channelPreferenceDtoToJSON(
+  channelPreferenceDto: ChannelPreferenceDto,
+): string {
+  return JSON.stringify(
+    ChannelPreferenceDto$outboundSchema.parse(channelPreferenceDto),
+  );
+}
+
+export function channelPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ChannelPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChannelPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChannelPreferenceDto' from JSON`,
+  );
+}