@novu/api 1.3.0 → 1.5.0

package/src/models/components/updateenvironmentrequestdto.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 {
+  BridgeConfigurationDto,
+  BridgeConfigurationDto$inboundSchema,
+  BridgeConfigurationDto$Outbound,
+  BridgeConfigurationDto$outboundSchema,
+} from "./bridgeconfigurationdto.js";
+import {
+  InBoundParseDomainDto,
+  InBoundParseDomainDto$inboundSchema,
+  InBoundParseDomainDto$Outbound,
+  InBoundParseDomainDto$outboundSchema,
+} from "./inboundparsedomaindto.js";
+
+export type UpdateEnvironmentRequestDto = {
+  name?: string | undefined;
+  identifier?: string | undefined;
+  parentId?: string | undefined;
+  color?: string | undefined;
+  dns?: InBoundParseDomainDto | undefined;
+  bridge?: BridgeConfigurationDto | undefined;
+};
+
+/** @internal */
+export const UpdateEnvironmentRequestDto$inboundSchema: z.ZodType<
+  UpdateEnvironmentRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  identifier: z.string().optional(),
+  parentId: z.string().optional(),
+  color: z.string().optional(),
+  dns: InBoundParseDomainDto$inboundSchema.optional(),
+  bridge: BridgeConfigurationDto$inboundSchema.optional(),
+});
+
+/** @internal */
+export type UpdateEnvironmentRequestDto$Outbound = {
+  name?: string | undefined;
+  identifier?: string | undefined;
+  parentId?: string | undefined;
+  color?: string | undefined;
+  dns?: InBoundParseDomainDto$Outbound | undefined;
+  bridge?: BridgeConfigurationDto$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateEnvironmentRequestDto$outboundSchema: z.ZodType<
+  UpdateEnvironmentRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateEnvironmentRequestDto
+> = z.object({
+  name: z.string().optional(),
+  identifier: z.string().optional(),
+  parentId: z.string().optional(),
+  color: z.string().optional(),
+  dns: InBoundParseDomainDto$outboundSchema.optional(),
+  bridge: BridgeConfigurationDto$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 UpdateEnvironmentRequestDto$ {
+  /** @deprecated use `UpdateEnvironmentRequestDto$inboundSchema` instead. */
+  export const inboundSchema = UpdateEnvironmentRequestDto$inboundSchema;
+  /** @deprecated use `UpdateEnvironmentRequestDto$outboundSchema` instead. */
+  export const outboundSchema = UpdateEnvironmentRequestDto$outboundSchema;
+  /** @deprecated use `UpdateEnvironmentRequestDto$Outbound` instead. */
+  export type Outbound = UpdateEnvironmentRequestDto$Outbound;
+}
+
+export function updateEnvironmentRequestDtoToJSON(
+  updateEnvironmentRequestDto: UpdateEnvironmentRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateEnvironmentRequestDto$outboundSchema.parse(
+      updateEnvironmentRequestDto,
+    ),
+  );
+}
+
+export function updateEnvironmentRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateEnvironmentRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateEnvironmentRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateEnvironmentRequestDto' from JSON`,
+  );
+}

package/src/models/components/updateworkflowdto.ts

@@ -0,0 +1,430 @@
+/*
+ * 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 {
+  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 {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
+import {
+  SmsStepUpsertDto,
+  SmsStepUpsertDto$inboundSchema,
+  SmsStepUpsertDto$Outbound,
+  SmsStepUpsertDto$outboundSchema,
+} from "./smsstepupsertdto.js";
+
+export type UpdateWorkflowDtoSteps =
+  | (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 UpdateWorkflowDto = {
+  /**
+   * 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;
+  /**
+   * Enable or disable payload schema validation
+   */
+  validatePayload?: boolean | undefined;
+  /**
+   * The payload JSON Schema for the workflow
+   */
+  payloadSchema?: { [k: string]: any } | null | undefined;
+  /**
+   * Enable or disable translations for this workflow
+   */
+  isTranslationEnabled?: boolean | undefined;
+  /**
+   * Workflow ID (allowed only for code-first workflows)
+   */
+  workflowId?: string | undefined;
+  /**
+   * 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" })
+  >;
+  /**
+   * Workflow preferences
+   */
+  preferences: PreferencesRequestDto;
+  /**
+   * Origin of the workflow
+   */
+  origin: ResourceOriginEnum;
+};
+
+/** @internal */
+export const UpdateWorkflowDtoSteps$inboundSchema: z.ZodType<
+  UpdateWorkflowDtoSteps,
+  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 UpdateWorkflowDtoSteps$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 UpdateWorkflowDtoSteps$outboundSchema: z.ZodType<
+  UpdateWorkflowDtoSteps$Outbound,
+  z.ZodTypeDef,
+  UpdateWorkflowDtoSteps
+> = 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 UpdateWorkflowDtoSteps$ {
+  /** @deprecated use `UpdateWorkflowDtoSteps$inboundSchema` instead. */
+  export const inboundSchema = UpdateWorkflowDtoSteps$inboundSchema;
+  /** @deprecated use `UpdateWorkflowDtoSteps$outboundSchema` instead. */
+  export const outboundSchema = UpdateWorkflowDtoSteps$outboundSchema;
+  /** @deprecated use `UpdateWorkflowDtoSteps$Outbound` instead. */
+  export type Outbound = UpdateWorkflowDtoSteps$Outbound;
+}
+
+export function updateWorkflowDtoStepsToJSON(
+  updateWorkflowDtoSteps: UpdateWorkflowDtoSteps,
+): string {
+  return JSON.stringify(
+    UpdateWorkflowDtoSteps$outboundSchema.parse(updateWorkflowDtoSteps),
+  );
+}
+
+export function updateWorkflowDtoStepsFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateWorkflowDtoSteps, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateWorkflowDtoSteps$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateWorkflowDtoSteps' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateWorkflowDto$inboundSchema: z.ZodType<
+  UpdateWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  active: z.boolean().default(false),
+  validatePayload: z.boolean().optional(),
+  payloadSchema: z.nullable(z.record(z.any())).optional(),
+  isTranslationEnabled: z.boolean().default(false),
+  workflowId: z.string().optional(),
+  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,
+        })),
+      ),
+    ]),
+  ),
+  preferences: PreferencesRequestDto$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
+});
+
+/** @internal */
+export type UpdateWorkflowDto$Outbound = {
+  name: string;
+  description?: string | undefined;
+  tags?: Array<string> | undefined;
+  active: boolean;
+  validatePayload?: boolean | undefined;
+  payloadSchema?: { [k: string]: any } | null | undefined;
+  isTranslationEnabled: boolean;
+  workflowId?: string | undefined;
+  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" })
+  >;
+  preferences: PreferencesRequestDto$Outbound;
+  origin: string;
+};
+
+/** @internal */
+export const UpdateWorkflowDto$outboundSchema: z.ZodType<
+  UpdateWorkflowDto$Outbound,
+  z.ZodTypeDef,
+  UpdateWorkflowDto
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  active: z.boolean().default(false),
+  validatePayload: z.boolean().optional(),
+  payloadSchema: z.nullable(z.record(z.any())).optional(),
+  isTranslationEnabled: z.boolean().default(false),
+  workflowId: z.string().optional(),
+  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,
+        })),
+      ),
+    ]),
+  ),
+  preferences: PreferencesRequestDto$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateWorkflowDto$ {
+  /** @deprecated use `UpdateWorkflowDto$inboundSchema` instead. */
+  export const inboundSchema = UpdateWorkflowDto$inboundSchema;
+  /** @deprecated use `UpdateWorkflowDto$outboundSchema` instead. */
+  export const outboundSchema = UpdateWorkflowDto$outboundSchema;
+  /** @deprecated use `UpdateWorkflowDto$Outbound` instead. */
+  export type Outbound = UpdateWorkflowDto$Outbound;
+}
+
+export function updateWorkflowDtoToJSON(
+  updateWorkflowDto: UpdateWorkflowDto,
+): string {
+  return JSON.stringify(
+    UpdateWorkflowDto$outboundSchema.parse(updateWorkflowDto),
+  );
+}
+
+export function updateWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/workflowcreationsourceenum.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Source of workflow creation
+ */
+export const WorkflowCreationSourceEnum = {
+  TemplateStore: "template_store",
+  Editor: "editor",
+  NotificationDirectory: "notification_directory",
+  OnboardingDigestDemo: "onboarding_digest_demo",
+  OnboardingInApp: "onboarding_in_app",
+  EmptyState: "empty_state",
+  Dropdown: "dropdown",
+  OnboardingGetStarted: "onboarding_get_started",
+  Bridge: "bridge",
+  Dashboard: "dashboard",
+} as const;
+/**
+ * Source of workflow creation
+ */
+export type WorkflowCreationSourceEnum = ClosedEnum<
+  typeof WorkflowCreationSourceEnum
+>;
+
+/** @internal */
+export const WorkflowCreationSourceEnum$inboundSchema: z.ZodNativeEnum<
+  typeof WorkflowCreationSourceEnum
+> = z.nativeEnum(WorkflowCreationSourceEnum);
+
+/** @internal */
+export const WorkflowCreationSourceEnum$outboundSchema: z.ZodNativeEnum<
+  typeof WorkflowCreationSourceEnum
+> = WorkflowCreationSourceEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WorkflowCreationSourceEnum$ {
+  /** @deprecated use `WorkflowCreationSourceEnum$inboundSchema` instead. */
+  export const inboundSchema = WorkflowCreationSourceEnum$inboundSchema;
+  /** @deprecated use `WorkflowCreationSourceEnum$outboundSchema` instead. */
+  export const outboundSchema = WorkflowCreationSourceEnum$outboundSchema;
+}