@novu/api 1.3.0 → 1.4.0

package/src/models/components/delaycontroldto.ts

@@ -0,0 +1,157 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+/**
+ * Type of the delay. Currently only 'regular' is supported by the schema.
+ */
+export const Type = {
+  Regular: "regular",
+} as const;
+/**
+ * Type of the delay. Currently only 'regular' is supported by the schema.
+ */
+export type Type = ClosedEnum<typeof Type>;
+
+/**
+ * Unit of time for the delay amount.
+ */
+export const DelayControlDtoUnit = {
+  Seconds: "seconds",
+  Minutes: "minutes",
+  Hours: "hours",
+  Days: "days",
+  Weeks: "weeks",
+  Months: "months",
+} as const;
+/**
+ * Unit of time for the delay amount.
+ */
+export type DelayControlDtoUnit = ClosedEnum<typeof DelayControlDtoUnit>;
+
+export type DelayControlDto = {
+  /**
+   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
+   */
+  skip?: { [k: string]: any } | undefined;
+  /**
+   * Type of the delay. Currently only 'regular' is supported by the schema.
+   */
+  type?: Type | undefined;
+  /**
+   * Amount of time to delay.
+   */
+  amount: number;
+  /**
+   * Unit of time for the delay amount.
+   */
+  unit: DelayControlDtoUnit;
+};
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
+}
+
+/** @internal */
+export const DelayControlDtoUnit$inboundSchema: z.ZodNativeEnum<
+  typeof DelayControlDtoUnit
+> = z.nativeEnum(DelayControlDtoUnit);
+
+/** @internal */
+export const DelayControlDtoUnit$outboundSchema: z.ZodNativeEnum<
+  typeof DelayControlDtoUnit
+> = DelayControlDtoUnit$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayControlDtoUnit$ {
+  /** @deprecated use `DelayControlDtoUnit$inboundSchema` instead. */
+  export const inboundSchema = DelayControlDtoUnit$inboundSchema;
+  /** @deprecated use `DelayControlDtoUnit$outboundSchema` instead. */
+  export const outboundSchema = DelayControlDtoUnit$outboundSchema;
+}
+
+/** @internal */
+export const DelayControlDto$inboundSchema: z.ZodType<
+  DelayControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  type: Type$inboundSchema.default("regular"),
+  amount: z.number(),
+  unit: DelayControlDtoUnit$inboundSchema,
+});
+
+/** @internal */
+export type DelayControlDto$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  type: string;
+  amount: number;
+  unit: string;
+};
+
+/** @internal */
+export const DelayControlDto$outboundSchema: z.ZodType<
+  DelayControlDto$Outbound,
+  z.ZodTypeDef,
+  DelayControlDto
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  type: Type$outboundSchema.default("regular"),
+  amount: z.number(),
+  unit: DelayControlDtoUnit$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayControlDto$ {
+  /** @deprecated use `DelayControlDto$inboundSchema` instead. */
+  export const inboundSchema = DelayControlDto$inboundSchema;
+  /** @deprecated use `DelayControlDto$outboundSchema` instead. */
+  export const outboundSchema = DelayControlDto$outboundSchema;
+  /** @deprecated use `DelayControlDto$Outbound` instead. */
+  export type Outbound = DelayControlDto$Outbound;
+}
+
+export function delayControlDtoToJSON(
+  delayControlDto: DelayControlDto,
+): string {
+  return JSON.stringify(DelayControlDto$outboundSchema.parse(delayControlDto));
+}
+
+export function delayControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayControlDto' from JSON`,
+  );
+}

package/src/models/components/delaycontrolsmetadataresponsedto.ts

@@ -0,0 +1,97 @@
+/*
+ * 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 {
+  DelayControlDto,
+  DelayControlDto$inboundSchema,
+  DelayControlDto$Outbound,
+  DelayControlDto$outboundSchema,
+} from "./delaycontroldto.js";
+import {
+  UiSchema,
+  UiSchema$inboundSchema,
+  UiSchema$Outbound,
+  UiSchema$outboundSchema,
+} from "./uischema.js";
+
+export type DelayControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to Delay
+   */
+  values: DelayControlDto;
+};
+
+/** @internal */
+export const DelayControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  DelayControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: DelayControlDto$inboundSchema,
+});
+
+/** @internal */
+export type DelayControlsMetadataResponseDto$Outbound = {
+  dataSchema?: { [k: string]: any } | undefined;
+  uiSchema?: UiSchema$Outbound | undefined;
+  values: DelayControlDto$Outbound;
+};
+
+/** @internal */
+export const DelayControlsMetadataResponseDto$outboundSchema: z.ZodType<
+  DelayControlsMetadataResponseDto$Outbound,
+  z.ZodTypeDef,
+  DelayControlsMetadataResponseDto
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$outboundSchema.optional(),
+  values: DelayControlDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayControlsMetadataResponseDto$ {
+  /** @deprecated use `DelayControlsMetadataResponseDto$inboundSchema` instead. */
+  export const inboundSchema = DelayControlsMetadataResponseDto$inboundSchema;
+  /** @deprecated use `DelayControlsMetadataResponseDto$outboundSchema` instead. */
+  export const outboundSchema = DelayControlsMetadataResponseDto$outboundSchema;
+  /** @deprecated use `DelayControlsMetadataResponseDto$Outbound` instead. */
+  export type Outbound = DelayControlsMetadataResponseDto$Outbound;
+}
+
+export function delayControlsMetadataResponseDtoToJSON(
+  delayControlsMetadataResponseDto: DelayControlsMetadataResponseDto,
+): string {
+  return JSON.stringify(
+    DelayControlsMetadataResponseDto$outboundSchema.parse(
+      delayControlsMetadataResponseDto,
+    ),
+  );
+}
+
+export function delayControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayControlsMetadataResponseDto' from JSON`,
+  );
+}

package/src/models/components/delaystepresponsedto.ts

@@ -0,0 +1,411 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  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";
+import {
+  DelayControlsMetadataResponseDto,
+  DelayControlsMetadataResponseDto$inboundSchema,
+  DelayControlsMetadataResponseDto$Outbound,
+  DelayControlsMetadataResponseDto$outboundSchema,
+} from "./delaycontrolsmetadataresponsedto.js";
+import {
+  StepIssuesDto,
+  StepIssuesDto$inboundSchema,
+  StepIssuesDto$Outbound,
+  StepIssuesDto$outboundSchema,
+} from "./stepissuesdto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+import {
+  WorkflowOriginEnum,
+  WorkflowOriginEnum$inboundSchema,
+  WorkflowOriginEnum$outboundSchema,
+} from "./workfloworiginenum.js";
+
+/**
+ * Type of the delay. Currently only 'regular' is supported by the schema.
+ */
+export const DelayStepResponseDtoType = {
+  Regular: "regular",
+} as const;
+/**
+ * Type of the delay. Currently only 'regular' is supported by the schema.
+ */
+export type DelayStepResponseDtoType = ClosedEnum<
+  typeof DelayStepResponseDtoType
+>;
+
+/**
+ * Unit of time for the delay amount.
+ */
+export const DelayStepResponseDtoUnit = {
+  Seconds: "seconds",
+  Minutes: "minutes",
+  Hours: "hours",
+  Days: "days",
+  Weeks: "weeks",
+  Months: "months",
+} as const;
+/**
+ * Unit of time for the delay amount.
+ */
+export type DelayStepResponseDtoUnit = ClosedEnum<
+  typeof DelayStepResponseDtoUnit
+>;
+
+/**
+ * Control values for the delay step
+ */
+export type DelayStepResponseDtoControlValues = {
+  /**
+   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
+   */
+  skip?: { [k: string]: any } | undefined;
+  /**
+   * Type of the delay. Currently only 'regular' is supported by the schema.
+   */
+  type?: DelayStepResponseDtoType | undefined;
+  /**
+   * Amount of time to delay.
+   */
+  amount: number;
+  /**
+   * Unit of time for the delay amount.
+   */
+  unit: DelayStepResponseDtoUnit;
+  additionalProperties?: { [k: string]: any };
+};
+
+/**
+ * Slug of the step
+ */
+export type DelayStepResponseDtoSlug = {};
+
+export type DelayStepResponseDto = {
+  /**
+   * Controls metadata for the delay step
+   */
+  controls: DelayControlsMetadataResponseDto;
+  /**
+   * Control values for the delay step
+   */
+  controlValues?: DelayStepResponseDtoControlValues | undefined;
+  /**
+   * JSON Schema for variables, follows the JSON Schema standard
+   */
+  variables: { [k: string]: any };
+  /**
+   * Unique identifier of the step
+   */
+  stepId: string;
+  /**
+   * Database identifier of the step
+   */
+  id: string;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Slug of the step
+   */
+  slug: DelayStepResponseDtoSlug;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Origin of the workflow
+   */
+  origin: WorkflowOriginEnum;
+  /**
+   * Workflow identifier
+   */
+  workflowId: string;
+  /**
+   * Workflow database identifier
+   */
+  workflowDatabaseId: string;
+  /**
+   * Issues associated with the step
+   */
+  issues?: StepIssuesDto | undefined;
+};
+
+/** @internal */
+export const DelayStepResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof DelayStepResponseDtoType
+> = z.nativeEnum(DelayStepResponseDtoType);
+
+/** @internal */
+export const DelayStepResponseDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof DelayStepResponseDtoType
+> = DelayStepResponseDtoType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayStepResponseDtoType$ {
+  /** @deprecated use `DelayStepResponseDtoType$inboundSchema` instead. */
+  export const inboundSchema = DelayStepResponseDtoType$inboundSchema;
+  /** @deprecated use `DelayStepResponseDtoType$outboundSchema` instead. */
+  export const outboundSchema = DelayStepResponseDtoType$outboundSchema;
+}
+
+/** @internal */
+export const DelayStepResponseDtoUnit$inboundSchema: z.ZodNativeEnum<
+  typeof DelayStepResponseDtoUnit
+> = z.nativeEnum(DelayStepResponseDtoUnit);
+
+/** @internal */
+export const DelayStepResponseDtoUnit$outboundSchema: z.ZodNativeEnum<
+  typeof DelayStepResponseDtoUnit
+> = DelayStepResponseDtoUnit$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayStepResponseDtoUnit$ {
+  /** @deprecated use `DelayStepResponseDtoUnit$inboundSchema` instead. */
+  export const inboundSchema = DelayStepResponseDtoUnit$inboundSchema;
+  /** @deprecated use `DelayStepResponseDtoUnit$outboundSchema` instead. */
+  export const outboundSchema = DelayStepResponseDtoUnit$outboundSchema;
+}
+
+/** @internal */
+export const DelayStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  DelayStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    skip: z.record(z.any()).optional(),
+    type: DelayStepResponseDtoType$inboundSchema.default("regular"),
+    amount: z.number(),
+    unit: DelayStepResponseDtoUnit$inboundSchema,
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+/** @internal */
+export type DelayStepResponseDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  type: string;
+  amount: number;
+  unit: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const DelayStepResponseDtoControlValues$outboundSchema: z.ZodType<
+  DelayStepResponseDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  DelayStepResponseDtoControlValues
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  type: DelayStepResponseDtoType$outboundSchema.default("regular"),
+  amount: z.number(),
+  unit: DelayStepResponseDtoUnit$outboundSchema,
+  additionalProperties: z.record(z.any()),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayStepResponseDtoControlValues$ {
+  /** @deprecated use `DelayStepResponseDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = DelayStepResponseDtoControlValues$inboundSchema;
+  /** @deprecated use `DelayStepResponseDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema =
+    DelayStepResponseDtoControlValues$outboundSchema;
+  /** @deprecated use `DelayStepResponseDtoControlValues$Outbound` instead. */
+  export type Outbound = DelayStepResponseDtoControlValues$Outbound;
+}
+
+export function delayStepResponseDtoControlValuesToJSON(
+  delayStepResponseDtoControlValues: DelayStepResponseDtoControlValues,
+): string {
+  return JSON.stringify(
+    DelayStepResponseDtoControlValues$outboundSchema.parse(
+      delayStepResponseDtoControlValues,
+    ),
+  );
+}
+
+export function delayStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayStepResponseDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayStepResponseDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const DelayStepResponseDtoSlug$inboundSchema: z.ZodType<
+  DelayStepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type DelayStepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const DelayStepResponseDtoSlug$outboundSchema: z.ZodType<
+  DelayStepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  DelayStepResponseDtoSlug
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayStepResponseDtoSlug$ {
+  /** @deprecated use `DelayStepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = DelayStepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `DelayStepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = DelayStepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `DelayStepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = DelayStepResponseDtoSlug$Outbound;
+}
+
+export function delayStepResponseDtoSlugToJSON(
+  delayStepResponseDtoSlug: DelayStepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    DelayStepResponseDtoSlug$outboundSchema.parse(delayStepResponseDtoSlug),
+  );
+}
+
+export function delayStepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayStepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayStepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const DelayStepResponseDto$inboundSchema: z.ZodType<
+  DelayStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: DelayControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() => DelayStepResponseDtoControlValues$inboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => DelayStepResponseDtoSlug$inboundSchema),
+  type: StepTypeEnum$inboundSchema,
+  origin: WorkflowOriginEnum$inboundSchema,
+  workflowId: z.string(),
+  workflowDatabaseId: z.string(),
+  issues: StepIssuesDto$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type DelayStepResponseDto$Outbound = {
+  controls: DelayControlsMetadataResponseDto$Outbound;
+  controlValues?: DelayStepResponseDtoControlValues$Outbound | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: DelayStepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const DelayStepResponseDto$outboundSchema: z.ZodType<
+  DelayStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  DelayStepResponseDto
+> = z.object({
+  controls: DelayControlsMetadataResponseDto$outboundSchema,
+  controlValues: z.lazy(() => DelayStepResponseDtoControlValues$outboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => DelayStepResponseDtoSlug$outboundSchema),
+  type: StepTypeEnum$outboundSchema,
+  origin: WorkflowOriginEnum$outboundSchema,
+  workflowId: z.string(),
+  workflowDatabaseId: z.string(),
+  issues: StepIssuesDto$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayStepResponseDto$ {
+  /** @deprecated use `DelayStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = DelayStepResponseDto$inboundSchema;
+  /** @deprecated use `DelayStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = DelayStepResponseDto$outboundSchema;
+  /** @deprecated use `DelayStepResponseDto$Outbound` instead. */
+  export type Outbound = DelayStepResponseDto$Outbound;
+}
+
+export function delayStepResponseDtoToJSON(
+  delayStepResponseDto: DelayStepResponseDto,
+): string {
+  return JSON.stringify(
+    DelayStepResponseDto$outboundSchema.parse(delayStepResponseDto),
+  );
+}
+
+export function delayStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayStepResponseDto' from JSON`,
+  );
+}