@novu/api 3.14.0 → 3.14.2

package/src/models/components/customstepresponsedto.ts

@@ -80,6 +80,10 @@ export type CustomStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -125,6 +129,7 @@ export const CustomStepResponseDto$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/delaystepresponsedto.ts

@@ -129,6 +129,10 @@ export type DelayStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -187,6 +191,7 @@ export const DelayStepResponseDto$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/dependencyreasonenum.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Reason for the dependency
+ */
+export const DependencyReasonEnum = {
+  LayoutRequiredForWorkflow: "LAYOUT_REQUIRED_FOR_WORKFLOW",
+  LayoutExistsInTarget: "LAYOUT_EXISTS_IN_TARGET",
+} as const;
+/**
+ * Reason for the dependency
+ */
+export type DependencyReasonEnum = ClosedEnum<typeof DependencyReasonEnum>;
+
+/** @internal */
+export const DependencyReasonEnum$inboundSchema: z.ZodNativeEnum<
+  typeof DependencyReasonEnum
+> = z.nativeEnum(DependencyReasonEnum);

package/src/models/components/diffactionenum.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of change
+ */
+export const DiffActionEnum = {
+  Added: "added",
+  Modified: "modified",
+  Deleted: "deleted",
+  Unchanged: "unchanged",
+  Moved: "moved",
+} as const;
+/**
+ * Type of change
+ */
+export type DiffActionEnum = ClosedEnum<typeof DiffActionEnum>;
+
+/** @internal */
+export const DiffActionEnum$inboundSchema: z.ZodNativeEnum<
+  typeof DiffActionEnum
+> = z.nativeEnum(DiffActionEnum);

package/src/models/components/diffenvironmentrequestdto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DiffEnvironmentRequestDto = {
+  /**
+   * Source environment ID to compare from. Defaults to the Development environment if not provided.
+   */
+  sourceEnvironmentId?: string | undefined;
+};
+
+/** @internal */
+export type DiffEnvironmentRequestDto$Outbound = {
+  sourceEnvironmentId?: string | undefined;
+};
+
+/** @internal */
+export const DiffEnvironmentRequestDto$outboundSchema: z.ZodType<
+  DiffEnvironmentRequestDto$Outbound,
+  z.ZodTypeDef,
+  DiffEnvironmentRequestDto
+> = z.object({
+  sourceEnvironmentId: z.string().optional(),
+});
+
+export function diffEnvironmentRequestDtoToJSON(
+  diffEnvironmentRequestDto: DiffEnvironmentRequestDto,
+): string {
+  return JSON.stringify(
+    DiffEnvironmentRequestDto$outboundSchema.parse(diffEnvironmentRequestDto),
+  );
+}

package/src/models/components/diffenvironmentresponsedto.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 {
+  EnvironmentDiffSummaryDto,
+  EnvironmentDiffSummaryDto$inboundSchema,
+} from "./environmentdiffsummarydto.js";
+import {
+  ResourceDiffResultDto,
+  ResourceDiffResultDto$inboundSchema,
+} from "./resourcediffresultdto.js";
+
+export type DiffEnvironmentResponseDto = {
+  /**
+   * Source environment ID
+   */
+  sourceEnvironmentId: string;
+  /**
+   * Target environment ID
+   */
+  targetEnvironmentId: string;
+  /**
+   * Diff resources by resource type
+   */
+  resources: Array<ResourceDiffResultDto>;
+  /**
+   * Overall summary
+   */
+  summary: EnvironmentDiffSummaryDto;
+};
+
+/** @internal */
+export const DiffEnvironmentResponseDto$inboundSchema: z.ZodType<
+  DiffEnvironmentResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sourceEnvironmentId: z.string(),
+  targetEnvironmentId: z.string(),
+  resources: z.array(ResourceDiffResultDto$inboundSchema),
+  summary: EnvironmentDiffSummaryDto$inboundSchema,
+});
+
+export function diffEnvironmentResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DiffEnvironmentResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiffEnvironmentResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiffEnvironmentResponseDto' from JSON`,
+  );
+}

package/src/models/components/diffsummarydto.ts

@@ -0,0 +1,49 @@
+/*
+ * 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";
+
+export type DiffSummaryDto = {
+  /**
+   * Number of added resources (workflows and steps)
+   */
+  added: number;
+  /**
+   * Number of modified resources (workflows and steps)
+   */
+  modified: number;
+  /**
+   * Number of deleted resources (workflows and steps)
+   */
+  deleted: number;
+  /**
+   * Number of unchanged resources (workflows and steps)
+   */
+  unchanged: number;
+};
+
+/** @internal */
+export const DiffSummaryDto$inboundSchema: z.ZodType<
+  DiffSummaryDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  added: z.number(),
+  modified: z.number(),
+  deleted: z.number(),
+  unchanged: z.number(),
+});
+
+export function diffSummaryDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DiffSummaryDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiffSummaryDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiffSummaryDto' from JSON`,
+  );
+}

package/src/models/components/digeststepresponsedto.ts

@@ -141,6 +141,10 @@ export type DigestStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -202,6 +206,7 @@ export const DigestStepResponseDto$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/emailstepresponsedto.ts

@@ -115,6 +115,10 @@ export type EmailStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -169,6 +173,7 @@ export const EmailStepResponseDto$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/environmentdiffsummarydto.ts

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type EnvironmentDiffSummaryDto = {
+  /**
+   * Total number of entities compared
+   */
+  totalEntities: number;
+  /**
+   * Total number of changes detected
+   */
+  totalChanges: number;
+  /**
+   * Whether any changes were detected
+   */
+  hasChanges: boolean;
+};
+
+/** @internal */
+export const EnvironmentDiffSummaryDto$inboundSchema: z.ZodType<
+  EnvironmentDiffSummaryDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  totalEntities: z.number(),
+  totalChanges: z.number(),
+  hasChanges: z.boolean(),
+});
+
+export function environmentDiffSummaryDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentDiffSummaryDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EnvironmentDiffSummaryDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentDiffSummaryDto' from JSON`,
+  );
+}

package/src/models/components/failedworkflowdto.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 FailedWorkflowDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Resource ID
+   */
+  resourceId: string;
+  /**
+   * Resource name
+   */
+  resourceName: string;
+  /**
+   * Error message
+   */
+  error: string;
+  /**
+   * Error stack trace
+   */
+  stack?: string | undefined;
+};
+
+/** @internal */
+export const FailedWorkflowDto$inboundSchema: z.ZodType<
+  FailedWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceType: ResourceTypeEnum$inboundSchema,
+  resourceId: z.string(),
+  resourceName: z.string(),
+  error: z.string(),
+  stack: z.string().optional(),
+});
+
+export function failedWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<FailedWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FailedWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FailedWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/httpmethodenum.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * HTTP method
+ */
+export const HttpMethodEnum = {
+  Get: "GET",
+  Post: "POST",
+  Put: "PUT",
+  Delete: "DELETE",
+  Patch: "PATCH",
+} as const;
+/**
+ * HTTP method
+ */
+export type HttpMethodEnum = ClosedEnum<typeof HttpMethodEnum>;
+
+/** @internal */
+export const HttpMethodEnum$inboundSchema: z.ZodNativeEnum<
+  typeof HttpMethodEnum
+> = z.nativeEnum(HttpMethodEnum);
+/** @internal */
+export const HttpMethodEnum$outboundSchema: z.ZodNativeEnum<
+  typeof HttpMethodEnum
+> = HttpMethodEnum$inboundSchema;

package/src/models/components/httprequestcontroldto.ts

@@ -0,0 +1,107 @@
+/*
+ * 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 {
+  HttpMethodEnum,
+  HttpMethodEnum$inboundSchema,
+  HttpMethodEnum$outboundSchema,
+} from "./httpmethodenum.js";
+import {
+  HttpRequestKeyValuePairDto,
+  HttpRequestKeyValuePairDto$inboundSchema,
+  HttpRequestKeyValuePairDto$Outbound,
+  HttpRequestKeyValuePairDto$outboundSchema,
+} from "./httprequestkeyvaluepairdto.js";
+
+export type HttpRequestControlDto = {
+  /**
+   * HTTP method
+   */
+  method: HttpMethodEnum;
+  /**
+   * Target URL for the HTTP request
+   */
+  url: string;
+  /**
+   * Request headers as key-value pairs
+   */
+  headers?: Array<HttpRequestKeyValuePairDto> | undefined;
+  /**
+   * Request body as key-value pairs
+   */
+  body?: Array<HttpRequestKeyValuePairDto> | undefined;
+  /**
+   * JSON schema to validate response body against
+   */
+  responseBodySchema?: { [k: string]: any } | undefined;
+  /**
+   * Whether to enforce response body schema validation
+   */
+  enforceSchemaValidation?: boolean | undefined;
+  /**
+   * Whether to continue workflow execution on failure
+   */
+  continueOnFailure?: boolean | undefined;
+};
+
+/** @internal */
+export const HttpRequestControlDto$inboundSchema: z.ZodType<
+  HttpRequestControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  method: HttpMethodEnum$inboundSchema,
+  url: z.string(),
+  headers: z.array(HttpRequestKeyValuePairDto$inboundSchema).optional(),
+  body: z.array(HttpRequestKeyValuePairDto$inboundSchema).optional(),
+  responseBodySchema: z.record(z.any()).optional(),
+  enforceSchemaValidation: z.boolean().optional(),
+  continueOnFailure: z.boolean().optional(),
+});
+/** @internal */
+export type HttpRequestControlDto$Outbound = {
+  method: string;
+  url: string;
+  headers?: Array<HttpRequestKeyValuePairDto$Outbound> | undefined;
+  body?: Array<HttpRequestKeyValuePairDto$Outbound> | undefined;
+  responseBodySchema?: { [k: string]: any } | undefined;
+  enforceSchemaValidation?: boolean | undefined;
+  continueOnFailure?: boolean | undefined;
+};
+
+/** @internal */
+export const HttpRequestControlDto$outboundSchema: z.ZodType<
+  HttpRequestControlDto$Outbound,
+  z.ZodTypeDef,
+  HttpRequestControlDto
+> = z.object({
+  method: HttpMethodEnum$outboundSchema,
+  url: z.string(),
+  headers: z.array(HttpRequestKeyValuePairDto$outboundSchema).optional(),
+  body: z.array(HttpRequestKeyValuePairDto$outboundSchema).optional(),
+  responseBodySchema: z.record(z.any()).optional(),
+  enforceSchemaValidation: z.boolean().optional(),
+  continueOnFailure: z.boolean().optional(),
+});
+
+export function httpRequestControlDtoToJSON(
+  httpRequestControlDto: HttpRequestControlDto,
+): string {
+  return JSON.stringify(
+    HttpRequestControlDto$outboundSchema.parse(httpRequestControlDto),
+  );
+}
+export function httpRequestControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HttpRequestControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestControlDto' from JSON`,
+  );
+}

package/src/models/components/httprequestcontrolsmetadataresponsedto.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 {
+  HttpRequestControlDto,
+  HttpRequestControlDto$inboundSchema,
+} from "./httprequestcontroldto.js";
+import { UiSchema, UiSchema$inboundSchema } from "./uischema.js";
+
+export type HttpRequestControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to HTTP Request step
+   */
+  values: HttpRequestControlDto;
+};
+
+/** @internal */
+export const HttpRequestControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  HttpRequestControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: HttpRequestControlDto$inboundSchema,
+});
+
+export function httpRequestControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      HttpRequestControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestControlsMetadataResponseDto' from JSON`,
+  );
+}

package/src/models/components/httprequestkeyvaluepairdto.ts

@@ -0,0 +1,61 @@
+/*
+ * 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";
+
+export type HttpRequestKeyValuePairDto = {
+  /**
+   * Key of the key-value pair
+   */
+  key: string;
+  /**
+   * Value of the key-value pair
+   */
+  value: string;
+};
+
+/** @internal */
+export const HttpRequestKeyValuePairDto$inboundSchema: z.ZodType<
+  HttpRequestKeyValuePairDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type HttpRequestKeyValuePairDto$Outbound = {
+  key: string;
+  value: string;
+};
+
+/** @internal */
+export const HttpRequestKeyValuePairDto$outboundSchema: z.ZodType<
+  HttpRequestKeyValuePairDto$Outbound,
+  z.ZodTypeDef,
+  HttpRequestKeyValuePairDto
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+});
+
+export function httpRequestKeyValuePairDtoToJSON(
+  httpRequestKeyValuePairDto: HttpRequestKeyValuePairDto,
+): string {
+  return JSON.stringify(
+    HttpRequestKeyValuePairDto$outboundSchema.parse(httpRequestKeyValuePairDto),
+  );
+}
+export function httpRequestKeyValuePairDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestKeyValuePairDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HttpRequestKeyValuePairDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestKeyValuePairDto' from JSON`,
+  );
+}