@novu/api 3.13.0 → 3.14.1

package/src/models/components/resourcedependencydto.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 {
+  DependencyReasonEnum,
+  DependencyReasonEnum$inboundSchema,
+} from "./dependencyreasonenum.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+} from "./resourcetypeenum.js";
+
+export type ResourceDependencyDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * ID of the dependent resource
+   */
+  resourceId: string;
+  /**
+   * Name of the dependent resource
+   */
+  resourceName: string;
+  /**
+   * Whether this dependency blocks the operation
+   */
+  isBlocking: boolean;
+  /**
+   * Reason for the dependency
+   */
+  reason: DependencyReasonEnum;
+};
+
+/** @internal */
+export const ResourceDependencyDto$inboundSchema: z.ZodType<
+  ResourceDependencyDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceType: ResourceTypeEnum$inboundSchema,
+  resourceId: z.string(),
+  resourceName: z.string(),
+  isBlocking: z.boolean(),
+  reason: DependencyReasonEnum$inboundSchema,
+});
+
+export function resourceDependencyDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDependencyDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDependencyDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDependencyDto' from JSON`,
+  );
+}

package/src/models/components/resourcediffdto.ts

@@ -0,0 +1,305 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DiffActionEnum,
+  DiffActionEnum$inboundSchema,
+} from "./diffactionenum.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+} from "./resourcetypeenum.js";
+
+/**
+ * User who last updated the resource
+ */
+export type ResourceDiffDtoUpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName: string;
+  /**
+   * User last name
+   */
+  lastName?: string | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | undefined;
+};
+
+/**
+ * Source resource information
+ */
+export type ResourceDiffDtoSourceResource = {
+  /**
+   * Resource ID (workflow ID or step ID)
+   */
+  id?: string | null | undefined;
+  /**
+   * Resource name (workflow name or step name)
+   */
+  name?: string | null | undefined;
+  /**
+   * User who last updated the resource
+   */
+  updatedBy?: ResourceDiffDtoUpdatedBy | null | undefined;
+  /**
+   * When the resource was last updated
+   */
+  updatedAt?: Date | null | undefined;
+};
+
+/**
+ * User who last updated the resource
+ */
+export type ResourceDiffDtoTargetResourceUpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName: string;
+  /**
+   * User last name
+   */
+  lastName?: string | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | undefined;
+};
+
+/**
+ * Target resource information
+ */
+export type ResourceDiffDtoTargetResource = {
+  /**
+   * Resource ID (workflow ID or step ID)
+   */
+  id?: string | null | undefined;
+  /**
+   * Resource name (workflow name or step name)
+   */
+  name?: string | null | undefined;
+  /**
+   * User who last updated the resource
+   */
+  updatedBy?: ResourceDiffDtoTargetResourceUpdatedBy | null | undefined;
+  /**
+   * When the resource was last updated
+   */
+  updatedAt?: Date | null | undefined;
+};
+
+/**
+ * Detailed changes (only for modified resources)
+ */
+export type Diffs = {
+  /**
+   * Previous state of the resource (null for added resources)
+   */
+  previous?: { [k: string]: any } | null | undefined;
+  /**
+   * New state of the resource (null for deleted resources)
+   */
+  new?: { [k: string]: any } | null | undefined;
+};
+
+export type ResourceDiffDto = {
+  /**
+   * Source resource information
+   */
+  sourceResource?: ResourceDiffDtoSourceResource | null | undefined;
+  /**
+   * Target resource information
+   */
+  targetResource?: ResourceDiffDtoTargetResource | null | undefined;
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Type of change
+   */
+  action: DiffActionEnum;
+  /**
+   * Detailed changes (only for modified resources)
+   */
+  diffs?: Diffs | undefined;
+  /**
+   * Step type (only for step resources)
+   */
+  stepType?: string | undefined;
+  /**
+   * Previous index in steps array (for moved/deleted steps)
+   */
+  previousIndex?: number | undefined;
+  /**
+   * New index in steps array (for moved/added steps)
+   */
+  newIndex?: number | undefined;
+};
+
+/** @internal */
+export const ResourceDiffDtoUpdatedBy$inboundSchema: z.ZodType<
+  ResourceDiffDtoUpdatedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.string(),
+  lastName: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function resourceDiffDtoUpdatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffDtoUpdatedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDiffDtoUpdatedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffDtoUpdatedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResourceDiffDtoSourceResource$inboundSchema: z.ZodType<
+  ResourceDiffDtoSourceResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  updatedBy: z.nullable(z.lazy(() => ResourceDiffDtoUpdatedBy$inboundSchema))
+    .optional(),
+  updatedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function resourceDiffDtoSourceResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffDtoSourceResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDiffDtoSourceResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffDtoSourceResource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResourceDiffDtoTargetResourceUpdatedBy$inboundSchema: z.ZodType<
+  ResourceDiffDtoTargetResourceUpdatedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.string(),
+  lastName: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function resourceDiffDtoTargetResourceUpdatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffDtoTargetResourceUpdatedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResourceDiffDtoTargetResourceUpdatedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffDtoTargetResourceUpdatedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResourceDiffDtoTargetResource$inboundSchema: z.ZodType<
+  ResourceDiffDtoTargetResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  updatedBy: z.nullable(
+    z.lazy(() => ResourceDiffDtoTargetResourceUpdatedBy$inboundSchema),
+  ).optional(),
+  updatedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function resourceDiffDtoTargetResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffDtoTargetResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDiffDtoTargetResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffDtoTargetResource' from JSON`,
+  );
+}
+
+/** @internal */
+export const Diffs$inboundSchema: z.ZodType<Diffs, z.ZodTypeDef, unknown> = z
+  .object({
+    previous: z.nullable(z.record(z.any())).optional(),
+    new: z.nullable(z.record(z.any())).optional(),
+  });
+
+export function diffsFromJSON(
+  jsonString: string,
+): SafeParseResult<Diffs, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Diffs$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Diffs' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResourceDiffDto$inboundSchema: z.ZodType<
+  ResourceDiffDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sourceResource: z.nullable(
+    z.lazy(() => ResourceDiffDtoSourceResource$inboundSchema),
+  ).optional(),
+  targetResource: z.nullable(
+    z.lazy(() => ResourceDiffDtoTargetResource$inboundSchema),
+  ).optional(),
+  resourceType: ResourceTypeEnum$inboundSchema,
+  action: DiffActionEnum$inboundSchema,
+  diffs: z.lazy(() => Diffs$inboundSchema).optional(),
+  stepType: z.string().optional(),
+  previousIndex: z.number().optional(),
+  newIndex: z.number().optional(),
+});
+
+export function resourceDiffDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDiffDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffDto' from JSON`,
+  );
+}

package/src/models/components/resourcediffresultdto.ts

@@ -0,0 +1,277 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DiffSummaryDto,
+  DiffSummaryDto$inboundSchema,
+} from "./diffsummarydto.js";
+import {
+  ResourceDependencyDto,
+  ResourceDependencyDto$inboundSchema,
+} from "./resourcedependencydto.js";
+import {
+  ResourceDiffDto,
+  ResourceDiffDto$inboundSchema,
+} from "./resourcediffdto.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+} from "./resourcetypeenum.js";
+
+/**
+ * User who last updated the resource
+ */
+export type ResourceDiffResultDtoSourceResourceUpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName: string;
+  /**
+   * User last name
+   */
+  lastName?: string | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | undefined;
+};
+
+/**
+ * Source resource information
+ */
+export type SourceResource = {
+  /**
+   * Resource ID (workflow ID or step ID)
+   */
+  id?: string | null | undefined;
+  /**
+   * Resource name (workflow name or step name)
+   */
+  name?: string | null | undefined;
+  /**
+   * User who last updated the resource
+   */
+  updatedBy?: ResourceDiffResultDtoSourceResourceUpdatedBy | null | undefined;
+  /**
+   * When the resource was last updated
+   */
+  updatedAt?: Date | null | undefined;
+};
+
+/**
+ * User who last updated the resource
+ */
+export type ResourceDiffResultDtoUpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName: string;
+  /**
+   * User last name
+   */
+  lastName?: string | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | undefined;
+};
+
+/**
+ * Target resource information
+ */
+export type TargetResource = {
+  /**
+   * Resource ID (workflow ID or step ID)
+   */
+  id?: string | null | undefined;
+  /**
+   * Resource name (workflow name or step name)
+   */
+  name?: string | null | undefined;
+  /**
+   * User who last updated the resource
+   */
+  updatedBy?: ResourceDiffResultDtoUpdatedBy | null | undefined;
+  /**
+   * When the resource was last updated
+   */
+  updatedAt?: Date | null | undefined;
+};
+
+export type ResourceDiffResultDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Source resource information
+   */
+  sourceResource?: SourceResource | null | undefined;
+  /**
+   * Target resource information
+   */
+  targetResource?: TargetResource | null | undefined;
+  /**
+   * List of specific changes for this resource
+   */
+  changes: Array<ResourceDiffDto>;
+  /**
+   * Summary of changes for this resource
+   */
+  summary: DiffSummaryDto;
+  /**
+   * Dependencies that affect this resource
+   */
+  dependencies?: Array<ResourceDependencyDto> | undefined;
+};
+
+/** @internal */
+export const ResourceDiffResultDtoSourceResourceUpdatedBy$inboundSchema:
+  z.ZodType<
+    ResourceDiffResultDtoSourceResourceUpdatedBy,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    _id: z.string(),
+    firstName: z.string(),
+    lastName: z.nullable(z.string()).optional(),
+    externalId: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "_id": "id",
+    });
+  });
+
+export function resourceDiffResultDtoSourceResourceUpdatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ResourceDiffResultDtoSourceResourceUpdatedBy,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ResourceDiffResultDtoSourceResourceUpdatedBy$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ResourceDiffResultDtoSourceResourceUpdatedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const SourceResource$inboundSchema: z.ZodType<
+  SourceResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  updatedBy: z.nullable(
+    z.lazy(() => ResourceDiffResultDtoSourceResourceUpdatedBy$inboundSchema),
+  ).optional(),
+  updatedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function sourceResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<SourceResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SourceResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SourceResource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResourceDiffResultDtoUpdatedBy$inboundSchema: z.ZodType<
+  ResourceDiffResultDtoUpdatedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.string(),
+  lastName: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function resourceDiffResultDtoUpdatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffResultDtoUpdatedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDiffResultDtoUpdatedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffResultDtoUpdatedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const TargetResource$inboundSchema: z.ZodType<
+  TargetResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  updatedBy: z.nullable(
+    z.lazy(() => ResourceDiffResultDtoUpdatedBy$inboundSchema),
+  ).optional(),
+  updatedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function targetResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<TargetResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TargetResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TargetResource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ResourceDiffResultDto$inboundSchema: z.ZodType<
+  ResourceDiffResultDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceType: ResourceTypeEnum$inboundSchema,
+  sourceResource: z.nullable(z.lazy(() => SourceResource$inboundSchema))
+    .optional(),
+  targetResource: z.nullable(z.lazy(() => TargetResource$inboundSchema))
+    .optional(),
+  changes: z.array(ResourceDiffDto$inboundSchema),
+  summary: DiffSummaryDto$inboundSchema,
+  dependencies: z.array(ResourceDependencyDto$inboundSchema).optional(),
+});
+
+export function resourceDiffResultDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ResourceDiffResultDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResourceDiffResultDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResourceDiffResultDto' from JSON`,
+  );
+}

package/src/models/components/resourcetopublishdto.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$outboundSchema,
+} from "./resourcetypeenum.js";
+
+export type ResourceToPublishDto = {
+  /**
+   * Type of the layout
+   */
+  resourceType: ResourceTypeEnum;
+  /**
+   * Unique identifier of the resource to publish
+   */
+  resourceId: string;
+};
+
+/** @internal */
+export type ResourceToPublishDto$Outbound = {
+  resourceType: string;
+  resourceId: string;
+};
+
+/** @internal */
+export const ResourceToPublishDto$outboundSchema: z.ZodType<
+  ResourceToPublishDto$Outbound,
+  z.ZodTypeDef,
+  ResourceToPublishDto
+> = z.object({
+  resourceType: ResourceTypeEnum$outboundSchema,
+  resourceId: z.string(),
+});
+
+export function resourceToPublishDtoToJSON(
+  resourceToPublishDto: ResourceToPublishDto,
+): string {
+  return JSON.stringify(
+    ResourceToPublishDto$outboundSchema.parse(resourceToPublishDto),
+  );
+}

package/src/models/components/resourcetypeenum.ts

@@ -22,3 +22,7 @@ export type ResourceTypeEnum = ClosedEnum<typeof ResourceTypeEnum>;
 export const ResourceTypeEnum$inboundSchema: z.ZodNativeEnum<
   typeof ResourceTypeEnum
 > = z.nativeEnum(ResourceTypeEnum);
+/** @internal */
+export const ResourceTypeEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ResourceTypeEnum
+> = ResourceTypeEnum$inboundSchema;