@novu/api 3.14.0 → 3.14.2

package/src/models/components/runtimeissuedto.ts

@@ -4,39 +4,17 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const IssueType = {
-  MissingValue: "MISSING_VALUE",
-  MaxLengthAccessed: "MAX_LENGTH_ACCESSED",
-  WorkflowIdAlreadyExists: "WORKFLOW_ID_ALREADY_EXISTS",
-  DuplicatedValue: "DUPLICATED_VALUE",
-  LimitReached: "LIMIT_REACHED",
-} as const;
-export type IssueType = ClosedEnum<typeof IssueType>;
-
-export type RuntimeIssueDto = {
-  issueType: IssueType;
-  variableName?: string | undefined;
-  message: string;
-};
-
-/** @internal */
-export const IssueType$inboundSchema: z.ZodNativeEnum<typeof IssueType> = z
-  .nativeEnum(IssueType);
+export type RuntimeIssueDto = {};
 
 /** @internal */
 export const RuntimeIssueDto$inboundSchema: z.ZodType<
   RuntimeIssueDto,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  issueType: IssueType$inboundSchema,
-  variableName: z.string().optional(),
-  message: z.string(),
-});
+> = z.object({});
 
 export function runtimeIssueDtoFromJSON(
   jsonString: string,

package/src/models/components/skippedworkflowdto.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+} from "./resourcetypeenum.js";
+
+export type SkippedWorkflowDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Resource ID
+   */
+  resourceId: string;
+  /**
+   * Resource name
+   */
+  resourceName: string;
+  /**
+   * Reason for skipping
+   */
+  reason: string;
+};
+
+/** @internal */
+export const SkippedWorkflowDto$inboundSchema: z.ZodType<
+  SkippedWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceType: ResourceTypeEnum$inboundSchema,
+  resourceId: z.string(),
+  resourceName: z.string(),
+  reason: z.string(),
+});
+
+export function skippedWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SkippedWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SkippedWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SkippedWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/smsstepresponsedto.ts

@@ -84,6 +84,10 @@ export type SmsStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -129,6 +133,7 @@ export const SmsStepResponseDto$inboundSchema: z.ZodType<
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
+  stepResolverHash: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",

package/src/models/components/stepresponsedto.ts

@@ -66,6 +66,10 @@ export type StepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -86,6 +90,7 @@ export const StepResponseDto$inboundSchema: z.ZodType<
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
+  stepResolverHash: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",

package/src/models/components/subscriberresponsedto.ts

@@ -20,11 +20,11 @@ export type SubscriberResponseDto = {
   /**
    * The first name of the subscriber.
    */
-  firstName?: string | null | undefined;
+  firstName: string | null;
   /**
    * The last name of the subscriber.
    */
-  lastName?: string | null | undefined;
+  lastName: string | null;
   /**
    * The email address of the subscriber.
    */
@@ -54,11 +54,11 @@ export type SubscriberResponseDto = {
   /**
    * Indicates whether the subscriber is currently online.
    */
-  isOnline?: boolean | null | undefined;
+  isOnline: boolean | null;
   /**
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
-  lastOnlineAt?: string | null | undefined;
+  lastOnlineAt: string | null;
   /**
    * The version of the subscriber document.
    */
@@ -104,16 +104,16 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  firstName: z.nullable(z.string()).optional(),
-  lastName: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()),
+  lastName: z.nullable(z.string()),
   email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   locale: z.nullable(z.string()).optional(),
   channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.nullable(z.boolean()).optional(),
-  lastOnlineAt: z.nullable(z.string()).optional(),
+  isOnline: z.nullable(z.boolean()),
+  lastOnlineAt: z.nullable(z.string()),
   __v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
   timezone: z.nullable(z.string()).optional(),

package/src/models/components/subscriberresponsedtooptional.ts

@@ -22,11 +22,11 @@ export type SubscriberResponseDtoOptional = {
   /**
    * The first name of the subscriber.
    */
-  firstName?: string | null | undefined;
+  firstName: string | null;
   /**
    * The last name of the subscriber.
    */
-  lastName?: string | null | undefined;
+  lastName: string | null;
   /**
    * The email address of the subscriber.
    */
@@ -56,11 +56,11 @@ export type SubscriberResponseDtoOptional = {
   /**
    * Indicates whether the subscriber is currently online.
    */
-  isOnline?: boolean | null | undefined;
+  isOnline: boolean | null;
   /**
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
-  lastOnlineAt?: string | null | undefined;
+  lastOnlineAt: string | null;
   /**
    * The version of the subscriber document.
    */
@@ -82,16 +82,16 @@ export const SubscriberResponseDtoOptional$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  firstName: z.nullable(z.string()).optional(),
-  lastName: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()),
+  lastName: z.nullable(z.string()),
   email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   locale: z.nullable(z.string()).optional(),
   channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.nullable(z.boolean()).optional(),
-  lastOnlineAt: z.nullable(z.string()).optional(),
+  isOnline: z.nullable(z.boolean()),
+  lastOnlineAt: z.nullable(z.string()),
   __v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
   timezone: z.nullable(z.string()).optional(),
@@ -104,16 +104,16 @@ export const SubscriberResponseDtoOptional$inboundSchema: z.ZodType<
 /** @internal */
 export type SubscriberResponseDtoOptional$Outbound = {
   _id?: string | undefined;
-  firstName?: string | null | undefined;
-  lastName?: string | null | undefined;
+  firstName: string | null;
+  lastName: string | null;
   email?: string | null | undefined;
   phone?: string | null | undefined;
   avatar?: string | null | undefined;
   locale?: string | null | undefined;
   channels?: Array<ChannelSettingsDto$Outbound> | undefined;
   topics?: Array<string> | undefined;
-  isOnline?: boolean | null | undefined;
-  lastOnlineAt?: string | null | undefined;
+  isOnline: boolean | null;
+  lastOnlineAt: string | null;
   __v?: number | undefined;
   data?: { [k: string]: any } | null | undefined;
   timezone?: string | null | undefined;
@@ -126,16 +126,16 @@ export const SubscriberResponseDtoOptional$outboundSchema: z.ZodType<
   SubscriberResponseDtoOptional
 > = z.object({
   id: z.string().optional(),
-  firstName: z.nullable(z.string()).optional(),
-  lastName: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()),
+  lastName: z.nullable(z.string()),
   email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   locale: z.nullable(z.string()).optional(),
   channels: z.array(ChannelSettingsDto$outboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.nullable(z.boolean()).optional(),
-  lastOnlineAt: z.nullable(z.string()).optional(),
+  isOnline: z.nullable(z.boolean()),
+  lastOnlineAt: z.nullable(z.string()),
   v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
   timezone: z.nullable(z.string()).optional(),

package/src/models/components/syncactionenum.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Sync action performed
+ */
+export const SyncActionEnum = {
+  Created: "created",
+  Updated: "updated",
+  Skipped: "skipped",
+  Deleted: "deleted",
+} as const;
+/**
+ * Sync action performed
+ */
+export type SyncActionEnum = ClosedEnum<typeof SyncActionEnum>;
+
+/** @internal */
+export const SyncActionEnum$inboundSchema: z.ZodNativeEnum<
+  typeof SyncActionEnum
+> = z.nativeEnum(SyncActionEnum);

package/src/models/components/syncedworkflowdto.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+} from "./resourcetypeenum.js";
+import {
+  SyncActionEnum,
+  SyncActionEnum$inboundSchema,
+} from "./syncactionenum.js";
+
+export type SyncedWorkflowDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Resource ID
+   */
+  resourceId: string;
+  /**
+   * Resource name
+   */
+  resourceName: string;
+  /**
+   * Sync action performed
+   */
+  action: SyncActionEnum;
+};
+
+/** @internal */
+export const SyncedWorkflowDto$inboundSchema: z.ZodType<
+  SyncedWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceType: ResourceTypeEnum$inboundSchema,
+  resourceId: z.string(),
+  resourceName: z.string(),
+  action: SyncActionEnum$inboundSchema,
+});
+
+export function syncedWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SyncedWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SyncedWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SyncedWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/syncresultdto.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  FailedWorkflowDto,
+  FailedWorkflowDto$inboundSchema,
+} from "./failedworkflowdto.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+} from "./resourcetypeenum.js";
+import {
+  SkippedWorkflowDto,
+  SkippedWorkflowDto$inboundSchema,
+} from "./skippedworkflowdto.js";
+import {
+  SyncedWorkflowDto,
+  SyncedWorkflowDto$inboundSchema,
+} from "./syncedworkflowdto.js";
+
+export type SyncResultDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Successfully synced resources
+   */
+  successful: Array<SyncedWorkflowDto>;
+  /**
+   * Failed resource syncs
+   */
+  failed: Array<FailedWorkflowDto>;
+  /**
+   * Skipped resources
+   */
+  skipped: Array<SkippedWorkflowDto>;
+  /**
+   * Total number of resources processed
+   */
+  totalProcessed: number;
+};
+
+/** @internal */
+export const SyncResultDto$inboundSchema: z.ZodType<
+  SyncResultDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceType: ResourceTypeEnum$inboundSchema,
+  successful: z.array(SyncedWorkflowDto$inboundSchema),
+  failed: z.array(FailedWorkflowDto$inboundSchema),
+  skipped: z.array(SkippedWorkflowDto$inboundSchema),
+  totalProcessed: z.number(),
+});
+
+export function syncResultDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SyncResultDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SyncResultDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SyncResultDto' from JSON`,
+  );
+}

package/src/models/components/throttlestepresponsedto.ts

@@ -134,6 +134,10 @@ export type ThrottleStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -196,6 +200,7 @@ export const ThrottleStepResponseDto$inboundSchema: z.ZodType<
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
+  stepResolverHash: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",

package/src/models/components/uicomponentenum.ts

@@ -3,7 +3,8 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 
 /**
  * Component type for the UI Schema Property
@@ -46,13 +47,23 @@ export const UiComponentEnum = {
   QueryEditor: "QUERY_EDITOR",
   Data: "DATA",
   LayoutEmail: "LAYOUT_EMAIL",
+  DestinationMethod: "DESTINATION_METHOD",
+  DestinationUrl: "DESTINATION_URL",
+  DestinationHeaders: "DESTINATION_HEADERS",
+  DestinationBody: "DESTINATION_BODY",
+  DestinationResponseBodySchema: "DESTINATION_RESPONSE_BODY_SCHEMA",
+  DestinationEnforceSchemaValidation: "DESTINATION_ENFORCE_SCHEMA_VALIDATION",
+  DestinationContinueOnFailure: "DESTINATION_CONTINUE_ON_FAILURE",
+  DestinationTimeout: "DESTINATION_TIMEOUT",
 } as const;
 /**
  * Component type for the UI Schema Property
  */
-export type UiComponentEnum = ClosedEnum<typeof UiComponentEnum>;
+export type UiComponentEnum = OpenEnum<typeof UiComponentEnum>;
 
 /** @internal */
-export const UiComponentEnum$inboundSchema: z.ZodNativeEnum<
-  typeof UiComponentEnum
-> = z.nativeEnum(UiComponentEnum);
+export const UiComponentEnum$inboundSchema: z.ZodType<
+  UiComponentEnum,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(UiComponentEnum);

package/src/models/components/uischemagroupenum.ts

@@ -19,6 +19,7 @@ export const UiSchemaGroupEnum = {
   Push: "PUSH",
   Skip: "SKIP",
   Layout: "LAYOUT",
+  HttpRequest: "HTTP_REQUEST",
 } as const;
 /**
  * Group of the UI Schema

package/src/models/components/updatelayoutdto.ts

@@ -4,20 +4,10 @@
 
 import * as z from "zod/v3";
 import {
-  EmailControlsDto,
-  EmailControlsDto$Outbound,
-  EmailControlsDto$outboundSchema,
-} from "./emailcontrolsdto.js";
-
-/**
- * Control values for the layout
- */
-export type ControlValues = {
-  /**
-   * Email layout controls
-   */
-  email?: EmailControlsDto | undefined;
-};
+  LayoutControlValuesDto,
+  LayoutControlValuesDto$Outbound,
+  LayoutControlValuesDto$outboundSchema,
+} from "./layoutcontrolvaluesdto.js";
 
 export type UpdateLayoutDto = {
   /**
@@ -31,32 +21,14 @@ export type UpdateLayoutDto = {
   /**
    * Control values for the layout
    */
-  controlValues?: ControlValues | null | undefined;
-};
-
-/** @internal */
-export type ControlValues$Outbound = {
-  email?: EmailControlsDto$Outbound | undefined;
+  controlValues: LayoutControlValuesDto;
 };
 
-/** @internal */
-export const ControlValues$outboundSchema: z.ZodType<
-  ControlValues$Outbound,
-  z.ZodTypeDef,
-  ControlValues
-> = z.object({
-  email: EmailControlsDto$outboundSchema.optional(),
-});
-
-export function controlValuesToJSON(controlValues: ControlValues): string {
-  return JSON.stringify(ControlValues$outboundSchema.parse(controlValues));
-}
-
 /** @internal */
 export type UpdateLayoutDto$Outbound = {
   name: string;
   isTranslationEnabled: boolean;
-  controlValues?: ControlValues$Outbound | null | undefined;
+  controlValues: LayoutControlValuesDto$Outbound;
 };
 
 /** @internal */
@@ -67,8 +39,7 @@ export const UpdateLayoutDto$outboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   isTranslationEnabled: z.boolean().default(false),
-  controlValues: z.nullable(z.lazy(() => ControlValues$outboundSchema))
-    .optional(),
+  controlValues: LayoutControlValuesDto$outboundSchema,
 });
 
 export function updateLayoutDtoToJSON(

package/src/models/components/updatesubscriberchannelrequestdto.ts

@@ -21,7 +21,7 @@ export type UpdateSubscriberChannelRequestDto = {
   /**
    * The integration identifier
    */
-  integrationIdentifier?: string | undefined;
+  integrationIdentifier: string;
   /**
    * Credentials payload for the specified provider
    */
@@ -31,7 +31,7 @@ export type UpdateSubscriberChannelRequestDto = {
 /** @internal */
 export type UpdateSubscriberChannelRequestDto$Outbound = {
   providerId: string;
-  integrationIdentifier?: string | undefined;
+  integrationIdentifier: string;
   credentials: ChannelCredentials$Outbound;
 };
 
@@ -42,7 +42,7 @@ export const UpdateSubscriberChannelRequestDto$outboundSchema: z.ZodType<
   UpdateSubscriberChannelRequestDto
 > = z.object({
   providerId: ChatOrPushProviderEnum$outboundSchema,
-  integrationIdentifier: z.string().optional(),
+  integrationIdentifier: z.string(),
   credentials: ChannelCredentials$outboundSchema,
 });
 

package/src/models/components/updateworkflowdto.ts

@@ -28,6 +28,11 @@ import {
   EmailStepUpsertDto$Outbound,
   EmailStepUpsertDto$outboundSchema,
 } from "./emailstepupsertdto.js";
+import {
+  HttpRequestStepUpsertDto,
+  HttpRequestStepUpsertDto$Outbound,
+  HttpRequestStepUpsertDto$outboundSchema,
+} from "./httprequeststepupsertdto.js";
 import {
   InAppStepUpsertDto,
   InAppStepUpsertDto$Outbound,
@@ -65,7 +70,8 @@ export type UpdateWorkflowDtoSteps =
   | ChatStepUpsertDto
   | DelayStepUpsertDto
   | DigestStepUpsertDto
-  | CustomStepUpsertDto;
+  | CustomStepUpsertDto
+  | HttpRequestStepUpsertDto;
 
 export type UpdateWorkflowDto = {
   /**
@@ -112,6 +118,7 @@ export type UpdateWorkflowDto = {
     | DelayStepUpsertDto
     | DigestStepUpsertDto
     | CustomStepUpsertDto
+    | HttpRequestStepUpsertDto
   >;
   /**
    * Workflow preferences
@@ -136,7 +143,8 @@ export type UpdateWorkflowDtoSteps$Outbound =
   | ChatStepUpsertDto$Outbound
   | DelayStepUpsertDto$Outbound
   | DigestStepUpsertDto$Outbound
-  | CustomStepUpsertDto$Outbound;
+  | CustomStepUpsertDto$Outbound
+  | HttpRequestStepUpsertDto$Outbound;
 
 /** @internal */
 export const UpdateWorkflowDtoSteps$outboundSchema: z.ZodType<
@@ -152,6 +160,7 @@ export const UpdateWorkflowDtoSteps$outboundSchema: z.ZodType<
   DelayStepUpsertDto$outboundSchema,
   DigestStepUpsertDto$outboundSchema,
   CustomStepUpsertDto$outboundSchema,
+  HttpRequestStepUpsertDto$outboundSchema,
 ]);
 
 export function updateWorkflowDtoStepsToJSON(
@@ -181,6 +190,7 @@ export type UpdateWorkflowDto$Outbound = {
     | DelayStepUpsertDto$Outbound
     | DigestStepUpsertDto$Outbound
     | CustomStepUpsertDto$Outbound
+    | HttpRequestStepUpsertDto$Outbound
   >;
   preferences: PreferencesRequestDto$Outbound;
   origin: string;
@@ -211,6 +221,7 @@ export const UpdateWorkflowDto$outboundSchema: z.ZodType<
       DelayStepUpsertDto$outboundSchema,
       DigestStepUpsertDto$outboundSchema,
       CustomStepUpsertDto$outboundSchema,
+      HttpRequestStepUpsertDto$outboundSchema,
     ]),
   ),
   preferences: PreferencesRequestDto$outboundSchema,

package/src/models/components/workflowcreationsourceenum.ts

@@ -19,6 +19,7 @@ export const WorkflowCreationSourceEnum = {
   OnboardingGetStarted: "onboarding_get_started",
   Bridge: "bridge",
   Dashboard: "dashboard",
+  Ai: "ai",
 } as const;
 /**
  * Source of workflow creation