@novu/api 1.2.0 → 1.4.0

package/src/models/components/createworkflowdto.ts

@@ -0,0 +1,433 @@
+/*
+ * 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";
+import {
+  ChatStepUpsertDto,
+  ChatStepUpsertDto$inboundSchema,
+  ChatStepUpsertDto$Outbound,
+  ChatStepUpsertDto$outboundSchema,
+} from "./chatstepupsertdto.js";
+import {
+  CustomStepUpsertDto,
+  CustomStepUpsertDto$inboundSchema,
+  CustomStepUpsertDto$Outbound,
+  CustomStepUpsertDto$outboundSchema,
+} from "./customstepupsertdto.js";
+import {
+  DelayStepUpsertDto,
+  DelayStepUpsertDto$inboundSchema,
+  DelayStepUpsertDto$Outbound,
+  DelayStepUpsertDto$outboundSchema,
+} from "./delaystepupsertdto.js";
+import {
+  DigestStepUpsertDto,
+  DigestStepUpsertDto$inboundSchema,
+  DigestStepUpsertDto$Outbound,
+  DigestStepUpsertDto$outboundSchema,
+} from "./digeststepupsertdto.js";
+import {
+  EmailStepUpsertDto,
+  EmailStepUpsertDto$inboundSchema,
+  EmailStepUpsertDto$Outbound,
+  EmailStepUpsertDto$outboundSchema,
+} from "./emailstepupsertdto.js";
+import {
+  InAppStepUpsertDto,
+  InAppStepUpsertDto$inboundSchema,
+  InAppStepUpsertDto$Outbound,
+  InAppStepUpsertDto$outboundSchema,
+} from "./inappstepupsertdto.js";
+import {
+  PreferencesRequestDto,
+  PreferencesRequestDto$inboundSchema,
+  PreferencesRequestDto$Outbound,
+  PreferencesRequestDto$outboundSchema,
+} from "./preferencesrequestdto.js";
+import {
+  PushStepUpsertDto,
+  PushStepUpsertDto$inboundSchema,
+  PushStepUpsertDto$Outbound,
+  PushStepUpsertDto$outboundSchema,
+} from "./pushstepupsertdto.js";
+import {
+  SmsStepUpsertDto,
+  SmsStepUpsertDto$inboundSchema,
+  SmsStepUpsertDto$Outbound,
+  SmsStepUpsertDto$outboundSchema,
+} from "./smsstepupsertdto.js";
+import {
+  WorkflowCreationSourceEnum,
+  WorkflowCreationSourceEnum$inboundSchema,
+  WorkflowCreationSourceEnum$outboundSchema,
+} from "./workflowcreationsourceenum.js";
+
+export type Steps =
+  | (InAppStepUpsertDto & { type: "in_app" })
+  | (EmailStepUpsertDto & { type: "email" })
+  | (SmsStepUpsertDto & { type: "sms" })
+  | (PushStepUpsertDto & { type: "push" })
+  | (ChatStepUpsertDto & { type: "chat" })
+  | (DelayStepUpsertDto & { type: "delay" })
+  | (DigestStepUpsertDto & { type: "digest" })
+  | (CustomStepUpsertDto & { type: "custom" });
+
+export type CreateWorkflowDto = {
+  /**
+   * Name of the workflow
+   */
+  name: string;
+  /**
+   * Description of the workflow
+   */
+  description?: string | undefined;
+  /**
+   * Tags associated with the workflow
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Whether the workflow is active
+   */
+  active?: boolean | undefined;
+  /**
+   * Unique identifier for the workflow
+   */
+  workflowId: string;
+  /**
+   * Steps of the workflow
+   */
+  steps: Array<
+    | (InAppStepUpsertDto & { type: "in_app" })
+    | (EmailStepUpsertDto & { type: "email" })
+    | (SmsStepUpsertDto & { type: "sms" })
+    | (PushStepUpsertDto & { type: "push" })
+    | (ChatStepUpsertDto & { type: "chat" })
+    | (DelayStepUpsertDto & { type: "delay" })
+    | (DigestStepUpsertDto & { type: "digest" })
+    | (CustomStepUpsertDto & { type: "custom" })
+  >;
+  /**
+   * Source of workflow creation
+   */
+  source?: WorkflowCreationSourceEnum | undefined;
+  /**
+   * Workflow preferences
+   */
+  preferences?: PreferencesRequestDto | undefined;
+  /**
+   * The payload JSON Schema for the workflow
+   */
+  payloadSchema?: { [k: string]: any } | undefined;
+  /**
+   * Enable or disable payload schema validation
+   */
+  validatePayload?: boolean | undefined;
+};
+
+/** @internal */
+export const Steps$inboundSchema: z.ZodType<Steps, z.ZodTypeDef, unknown> = z
+  .union([
+    InAppStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("in_app") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    EmailStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("email") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    SmsStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("sms") }).transform((v) => ({ type: v.type })),
+    ),
+    PushStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("push") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    ChatStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("chat") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    DelayStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("delay") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    DigestStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("digest") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    CustomStepUpsertDto$inboundSchema.and(
+      z.object({ type: z.literal("custom") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]);
+
+/** @internal */
+export type Steps$Outbound =
+  | (InAppStepUpsertDto$Outbound & { type: "in_app" })
+  | (EmailStepUpsertDto$Outbound & { type: "email" })
+  | (SmsStepUpsertDto$Outbound & { type: "sms" })
+  | (PushStepUpsertDto$Outbound & { type: "push" })
+  | (ChatStepUpsertDto$Outbound & { type: "chat" })
+  | (DelayStepUpsertDto$Outbound & { type: "delay" })
+  | (DigestStepUpsertDto$Outbound & { type: "digest" })
+  | (CustomStepUpsertDto$Outbound & { type: "custom" });
+
+/** @internal */
+export const Steps$outboundSchema: z.ZodType<
+  Steps$Outbound,
+  z.ZodTypeDef,
+  Steps
+> = z.union([
+  InAppStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("in_app") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  EmailStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("email") }).transform((v) => ({ type: v.type })),
+  ),
+  SmsStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("sms") }).transform((v) => ({ type: v.type })),
+  ),
+  PushStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("push") }).transform((v) => ({ type: v.type })),
+  ),
+  ChatStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("chat") }).transform((v) => ({ type: v.type })),
+  ),
+  DelayStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("delay") }).transform((v) => ({ type: v.type })),
+  ),
+  DigestStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("digest") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  CustomStepUpsertDto$outboundSchema.and(
+    z.object({ type: z.literal("custom") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Steps$ {
+  /** @deprecated use `Steps$inboundSchema` instead. */
+  export const inboundSchema = Steps$inboundSchema;
+  /** @deprecated use `Steps$outboundSchema` instead. */
+  export const outboundSchema = Steps$outboundSchema;
+  /** @deprecated use `Steps$Outbound` instead. */
+  export type Outbound = Steps$Outbound;
+}
+
+export function stepsToJSON(steps: Steps): string {
+  return JSON.stringify(Steps$outboundSchema.parse(steps));
+}
+
+export function stepsFromJSON(
+  jsonString: string,
+): SafeParseResult<Steps, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Steps$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Steps' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateWorkflowDto$inboundSchema: z.ZodType<
+  CreateWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  active: z.boolean().default(false),
+  workflowId: z.string(),
+  steps: z.array(
+    z.union([
+      InAppStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("in_app") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      EmailStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("email") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      SmsStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("sms") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      PushStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("push") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      ChatStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("chat") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      DelayStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("delay") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      DigestStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("digest") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      CustomStepUpsertDto$inboundSchema.and(
+        z.object({ type: z.literal("custom") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+    ]),
+  ),
+  __source: WorkflowCreationSourceEnum$inboundSchema.default("editor"),
+  preferences: PreferencesRequestDto$inboundSchema.optional(),
+  payloadSchema: z.record(z.any()).optional(),
+  validatePayload: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "__source": "source",
+  });
+});
+
+/** @internal */
+export type CreateWorkflowDto$Outbound = {
+  name: string;
+  description?: string | undefined;
+  tags?: Array<string> | undefined;
+  active: boolean;
+  workflowId: string;
+  steps: Array<
+    | (InAppStepUpsertDto$Outbound & { type: "in_app" })
+    | (EmailStepUpsertDto$Outbound & { type: "email" })
+    | (SmsStepUpsertDto$Outbound & { type: "sms" })
+    | (PushStepUpsertDto$Outbound & { type: "push" })
+    | (ChatStepUpsertDto$Outbound & { type: "chat" })
+    | (DelayStepUpsertDto$Outbound & { type: "delay" })
+    | (DigestStepUpsertDto$Outbound & { type: "digest" })
+    | (CustomStepUpsertDto$Outbound & { type: "custom" })
+  >;
+  __source: string;
+  preferences?: PreferencesRequestDto$Outbound | undefined;
+  payloadSchema?: { [k: string]: any } | undefined;
+  validatePayload?: boolean | undefined;
+};
+
+/** @internal */
+export const CreateWorkflowDto$outboundSchema: z.ZodType<
+  CreateWorkflowDto$Outbound,
+  z.ZodTypeDef,
+  CreateWorkflowDto
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  active: z.boolean().default(false),
+  workflowId: z.string(),
+  steps: z.array(
+    z.union([
+      InAppStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("in_app") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      EmailStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("email") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      SmsStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("sms") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      PushStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("push") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      ChatStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("chat") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      DelayStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("delay") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      DigestStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("digest") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+      CustomStepUpsertDto$outboundSchema.and(
+        z.object({ type: z.literal("custom") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+    ]),
+  ),
+  source: WorkflowCreationSourceEnum$outboundSchema.default("editor"),
+  preferences: PreferencesRequestDto$outboundSchema.optional(),
+  payloadSchema: z.record(z.any()).optional(),
+  validatePayload: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    source: "__source",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateWorkflowDto$ {
+  /** @deprecated use `CreateWorkflowDto$inboundSchema` instead. */
+  export const inboundSchema = CreateWorkflowDto$inboundSchema;
+  /** @deprecated use `CreateWorkflowDto$outboundSchema` instead. */
+  export const outboundSchema = CreateWorkflowDto$outboundSchema;
+  /** @deprecated use `CreateWorkflowDto$Outbound` instead. */
+  export type Outbound = CreateWorkflowDto$Outbound;
+}
+
+export function createWorkflowDtoToJSON(
+  createWorkflowDto: CreateWorkflowDto,
+): string {
+  return JSON.stringify(
+    CreateWorkflowDto$outboundSchema.parse(createWorkflowDto),
+  );
+}
+
+export function createWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/customcontroldto.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 CustomControlDto = {
+  /**
+   * Custom control values for the step.
+   */
+  custom?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CustomControlDto$inboundSchema: z.ZodType<
+  CustomControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  custom: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type CustomControlDto$Outbound = {
+  custom?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CustomControlDto$outboundSchema: z.ZodType<
+  CustomControlDto$Outbound,
+  z.ZodTypeDef,
+  CustomControlDto
+> = z.object({
+  custom: z.record(z.any()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomControlDto$ {
+  /** @deprecated use `CustomControlDto$inboundSchema` instead. */
+  export const inboundSchema = CustomControlDto$inboundSchema;
+  /** @deprecated use `CustomControlDto$outboundSchema` instead. */
+  export const outboundSchema = CustomControlDto$outboundSchema;
+  /** @deprecated use `CustomControlDto$Outbound` instead. */
+  export type Outbound = CustomControlDto$Outbound;
+}
+
+export function customControlDtoToJSON(
+  customControlDto: CustomControlDto,
+): string {
+  return JSON.stringify(
+    CustomControlDto$outboundSchema.parse(customControlDto),
+  );
+}
+
+export function customControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomControlDto' from JSON`,
+  );
+}

package/src/models/components/customcontrolsmetadataresponsedto.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 {
+  CustomControlDto,
+  CustomControlDto$inboundSchema,
+  CustomControlDto$Outbound,
+  CustomControlDto$outboundSchema,
+} from "./customcontroldto.js";
+import {
+  UiSchema,
+  UiSchema$inboundSchema,
+  UiSchema$Outbound,
+  UiSchema$outboundSchema,
+} from "./uischema.js";
+
+export type CustomControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to Custom step
+   */
+  values: CustomControlDto;
+};
+
+/** @internal */
+export const CustomControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  CustomControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: CustomControlDto$inboundSchema,
+});
+
+/** @internal */
+export type CustomControlsMetadataResponseDto$Outbound = {
+  dataSchema?: { [k: string]: any } | undefined;
+  uiSchema?: UiSchema$Outbound | undefined;
+  values: CustomControlDto$Outbound;
+};
+
+/** @internal */
+export const CustomControlsMetadataResponseDto$outboundSchema: z.ZodType<
+  CustomControlsMetadataResponseDto$Outbound,
+  z.ZodTypeDef,
+  CustomControlsMetadataResponseDto
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$outboundSchema.optional(),
+  values: CustomControlDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomControlsMetadataResponseDto$ {
+  /** @deprecated use `CustomControlsMetadataResponseDto$inboundSchema` instead. */
+  export const inboundSchema = CustomControlsMetadataResponseDto$inboundSchema;
+  /** @deprecated use `CustomControlsMetadataResponseDto$outboundSchema` instead. */
+  export const outboundSchema =
+    CustomControlsMetadataResponseDto$outboundSchema;
+  /** @deprecated use `CustomControlsMetadataResponseDto$Outbound` instead. */
+  export type Outbound = CustomControlsMetadataResponseDto$Outbound;
+}
+
+export function customControlsMetadataResponseDtoToJSON(
+  customControlsMetadataResponseDto: CustomControlsMetadataResponseDto,
+): string {
+  return JSON.stringify(
+    CustomControlsMetadataResponseDto$outboundSchema.parse(
+      customControlsMetadataResponseDto,
+    ),
+  );
+}
+
+export function customControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomControlsMetadataResponseDto' from JSON`,
+  );
+}