@novu/api 3.13.0 → 3.14.1

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/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
@@ -11,6 +12,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const UiComponentEnum = {
   EmailEditorSelect: "EMAIL_EDITOR_SELECT",
   LayoutSelect: "LAYOUT_SELECT",
+  EmailRendererSelect: "EMAIL_RENDERER_SELECT",
   BlockEditor: "BLOCK_EDITOR",
   EmailBody: "EMAIL_BODY",
   TextFullLine: "TEXT_FULL_LINE",
@@ -50,9 +52,11 @@ export const UiComponentEnum = {
 /**
  * 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/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

package/src/models/operations/environmentscontrollerdiffenvironment.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EnvironmentsControllerDiffEnvironmentRequest = {
+  /**
+   * Target environment ID (MongoDB ObjectId) to compare against
+   */
+  targetEnvironmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Diff request configuration
+   */
+  diffEnvironmentRequestDto: components.DiffEnvironmentRequestDto;
+};
+
+export type EnvironmentsControllerDiffEnvironmentResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.DiffEnvironmentResponseDto;
+};
+
+/** @internal */
+export type EnvironmentsControllerDiffEnvironmentRequest$Outbound = {
+  targetEnvironmentId: string;
+  "idempotency-key"?: string | undefined;
+  DiffEnvironmentRequestDto: components.DiffEnvironmentRequestDto$Outbound;
+};
+
+/** @internal */
+export const EnvironmentsControllerDiffEnvironmentRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerDiffEnvironmentRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerDiffEnvironmentRequest
+  > = z.object({
+    targetEnvironmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+    diffEnvironmentRequestDto:
+      components.DiffEnvironmentRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      diffEnvironmentRequestDto: "DiffEnvironmentRequestDto",
+    });
+  });
+
+export function environmentsControllerDiffEnvironmentRequestToJSON(
+  environmentsControllerDiffEnvironmentRequest:
+    EnvironmentsControllerDiffEnvironmentRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerDiffEnvironmentRequest$outboundSchema.parse(
+      environmentsControllerDiffEnvironmentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerDiffEnvironmentResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerDiffEnvironmentResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.DiffEnvironmentResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function environmentsControllerDiffEnvironmentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerDiffEnvironmentResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerDiffEnvironmentResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerDiffEnvironmentResponse' from JSON`,
+  );
+}

package/src/models/operations/environmentscontrollerpublishenvironment.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EnvironmentsControllerPublishEnvironmentRequest = {
+  /**
+   * Target environment ID (MongoDB ObjectId) to publish resources to
+   */
+  targetEnvironmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Publish request configuration
+   */
+  publishEnvironmentRequestDto: components.PublishEnvironmentRequestDto;
+};
+
+export type EnvironmentsControllerPublishEnvironmentResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.PublishEnvironmentResponseDto;
+};
+
+/** @internal */
+export type EnvironmentsControllerPublishEnvironmentRequest$Outbound = {
+  targetEnvironmentId: string;
+  "idempotency-key"?: string | undefined;
+  PublishEnvironmentRequestDto:
+    components.PublishEnvironmentRequestDto$Outbound;
+};
+
+/** @internal */
+export const EnvironmentsControllerPublishEnvironmentRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerPublishEnvironmentRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerPublishEnvironmentRequest
+  > = z.object({
+    targetEnvironmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+    publishEnvironmentRequestDto:
+      components.PublishEnvironmentRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      publishEnvironmentRequestDto: "PublishEnvironmentRequestDto",
+    });
+  });
+
+export function environmentsControllerPublishEnvironmentRequestToJSON(
+  environmentsControllerPublishEnvironmentRequest:
+    EnvironmentsControllerPublishEnvironmentRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerPublishEnvironmentRequest$outboundSchema.parse(
+      environmentsControllerPublishEnvironmentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerPublishEnvironmentResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerPublishEnvironmentResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.PublishEnvironmentResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function environmentsControllerPublishEnvironmentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerPublishEnvironmentResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerPublishEnvironmentResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerPublishEnvironmentResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -17,7 +17,9 @@ export * from "./contextscontrollerdeletecontext.js";
 export * from "./contextscontrollergetcontext.js";
 export * from "./contextscontrollerlistcontexts.js";
 export * from "./contextscontrollerupdatecontext.js";
+export * from "./environmentscontrollerdiffenvironment.js";
 export * from "./environmentscontrollergetenvironmenttags.js";
+export * from "./environmentscontrollerpublishenvironment.js";
 export * from "./environmentscontrollerv1createenvironment.js";
 export * from "./environmentscontrollerv1deleteenvironment.js";
 export * from "./environmentscontrollerv1listmyenvironments.js";

package/src/sdk/environments.ts

@@ -4,8 +4,10 @@
 
 import { environmentsCreate } from "../funcs/environmentsCreate.js";
 import { environmentsDelete } from "../funcs/environmentsDelete.js";
+import { environmentsDiff } from "../funcs/environmentsDiff.js";
 import { environmentsGetTags } from "../funcs/environmentsGetTags.js";
 import { environmentsList } from "../funcs/environmentsList.js";
+import { environmentsPublish } from "../funcs/environmentsPublish.js";
 import { environmentsUpdate } from "../funcs/environmentsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -14,7 +16,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Environments extends ClientSDK {
   /**
-   * Get environment tags
+   * List environment tags
    *
    * @remarks
    * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.
@@ -32,6 +34,48 @@ export class Environments extends ClientSDK {
     ));
   }
 
+  /**
+   * Compare resources between environments
+   *
+   * @remarks
+   * Compares workflows and other resources between the source and target environments, returning detailed diff information including additions, modifications, and deletions.
+   */
+  async diff(
+    diffEnvironmentRequestDto: components.DiffEnvironmentRequestDto,
+    targetEnvironmentId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.EnvironmentsControllerDiffEnvironmentResponse> {
+    return unwrapAsync(environmentsDiff(
+      this,
+      diffEnvironmentRequestDto,
+      targetEnvironmentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Publish resources to target environment
+   *
+   * @remarks
+   * Publishes all workflows and resources from the source environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes.
+   */
+  async publish(
+    publishEnvironmentRequestDto: components.PublishEnvironmentRequestDto,
+    targetEnvironmentId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.EnvironmentsControllerPublishEnvironmentResponse> {
+    return unwrapAsync(environmentsPublish(
+      this,
+      publishEnvironmentRequestDto,
+      targetEnvironmentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Create an environment
    *

package/src/sdk/subscriptions.ts

@@ -77,10 +77,10 @@ export class Subscriptions extends ClientSDK {
   }
 
   /**
-   * Get a topic subscription
+   * Retrieve a topic subscription
    *
    * @remarks
-   * Get a subscription by its unique identifier for a topic.
+   * Retrieve a subscription by its unique identifier for a topic.
    */
   async getSubscription(
     topicKey: string,

package/_speakeasy/.github/action-inputs-config.json

@@ -1,53 +0,0 @@
-[
-  {
-    "name": "mode",
-    "validation_regex": "/^(direct|pr)$/.source",
-    "validation_message": "Must be `direct` or `pr`"
-  },
-  {
-    "name": "speakeasy_version",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "openapi_doc_location",
-    "validation_regex": "/^((https?):\\/\\/([\\w\\-]+\\.)+\\w+(\\/.*)?|[\\w.\\-\\/]+)$/i.source",
-    "validation_message": "Must be a valid server URL or file path containing letters, numbers, or .-_/ only"
-  },
-  {
-    "name": "openapi_doc_auth_header",
-    "validation_regex": "/^[A-Za-z\\-]+$/.source",
-    "validation_message": "Letters or - only"
-  },
-  {
-    "name": "create_release"
-  },
-  {
-    "name": "publish_python",
-    "language": "python"
-  },
-  {
-    "name": "publish_typescript",
-    "language": "typescript"
-  },
-  {
-    "name": "publish_java",
-    "language": "java"
-  },
-  {
-    "name": "publish_php",
-    "language": "php"
-  },
-  {
-    "name": "publish_ruby",
-    "language": "ruby"
-  },
-  {
-    "name": "publish_csharp",
-    "language": "csharp"
-  },
-  {
-    "name": "publish_terraform",
-    "language": "terraform"
-  }
-]