@novu/api 1.2.0 → 1.4.0

package/src/models/components/customstepresponsedto.ts

@@ -0,0 +1,317 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomControlsMetadataResponseDto,
+  CustomControlsMetadataResponseDto$inboundSchema,
+  CustomControlsMetadataResponseDto$Outbound,
+  CustomControlsMetadataResponseDto$outboundSchema,
+} from "./customcontrolsmetadataresponsedto.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";
+
+/**
+ * Control values for the custom step
+ */
+export type CustomStepResponseDtoControlValues = {
+  /**
+   * Custom control values for the step.
+   */
+  custom?: { [k: string]: any } | undefined;
+  additionalProperties?: { [k: string]: any };
+};
+
+/**
+ * Slug of the step
+ */
+export type CustomStepResponseDtoSlug = {};
+
+export type CustomStepResponseDto = {
+  /**
+   * Controls metadata for the custom step
+   */
+  controls: CustomControlsMetadataResponseDto;
+  /**
+   * Control values for the custom step
+   */
+  controlValues?: CustomStepResponseDtoControlValues | 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: CustomStepResponseDtoSlug;
+  /**
+   * 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 CustomStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  CustomStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    custom: z.record(z.any()).optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+/** @internal */
+export type CustomStepResponseDtoControlValues$Outbound = {
+  custom?: { [k: string]: any } | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const CustomStepResponseDtoControlValues$outboundSchema: z.ZodType<
+  CustomStepResponseDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  CustomStepResponseDtoControlValues
+> = z.object({
+  custom: z.record(z.any()).optional(),
+  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 CustomStepResponseDtoControlValues$ {
+  /** @deprecated use `CustomStepResponseDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = CustomStepResponseDtoControlValues$inboundSchema;
+  /** @deprecated use `CustomStepResponseDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema =
+    CustomStepResponseDtoControlValues$outboundSchema;
+  /** @deprecated use `CustomStepResponseDtoControlValues$Outbound` instead. */
+  export type Outbound = CustomStepResponseDtoControlValues$Outbound;
+}
+
+export function customStepResponseDtoControlValuesToJSON(
+  customStepResponseDtoControlValues: CustomStepResponseDtoControlValues,
+): string {
+  return JSON.stringify(
+    CustomStepResponseDtoControlValues$outboundSchema.parse(
+      customStepResponseDtoControlValues,
+    ),
+  );
+}
+
+export function customStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomStepResponseDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CustomStepResponseDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomStepResponseDtoSlug$inboundSchema: z.ZodType<
+  CustomStepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type CustomStepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const CustomStepResponseDtoSlug$outboundSchema: z.ZodType<
+  CustomStepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  CustomStepResponseDtoSlug
+> = 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 CustomStepResponseDtoSlug$ {
+  /** @deprecated use `CustomStepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = CustomStepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `CustomStepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = CustomStepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `CustomStepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = CustomStepResponseDtoSlug$Outbound;
+}
+
+export function customStepResponseDtoSlugToJSON(
+  customStepResponseDtoSlug: CustomStepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    CustomStepResponseDtoSlug$outboundSchema.parse(customStepResponseDtoSlug),
+  );
+}
+
+export function customStepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomStepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomStepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomStepResponseDto$inboundSchema: z.ZodType<
+  CustomStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: CustomControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() => CustomStepResponseDtoControlValues$inboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => CustomStepResponseDtoSlug$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 CustomStepResponseDto$Outbound = {
+  controls: CustomControlsMetadataResponseDto$Outbound;
+  controlValues?: CustomStepResponseDtoControlValues$Outbound | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: CustomStepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const CustomStepResponseDto$outboundSchema: z.ZodType<
+  CustomStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  CustomStepResponseDto
+> = z.object({
+  controls: CustomControlsMetadataResponseDto$outboundSchema,
+  controlValues: z.lazy(() => CustomStepResponseDtoControlValues$outboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => CustomStepResponseDtoSlug$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 CustomStepResponseDto$ {
+  /** @deprecated use `CustomStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = CustomStepResponseDto$inboundSchema;
+  /** @deprecated use `CustomStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = CustomStepResponseDto$outboundSchema;
+  /** @deprecated use `CustomStepResponseDto$Outbound` instead. */
+  export type Outbound = CustomStepResponseDto$Outbound;
+}
+
+export function customStepResponseDtoToJSON(
+  customStepResponseDto: CustomStepResponseDto,
+): string {
+  return JSON.stringify(
+    CustomStepResponseDto$outboundSchema.parse(customStepResponseDto),
+  );
+}
+
+export function customStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomStepResponseDto' from JSON`,
+  );
+}

package/src/models/components/customstepupsertdto.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+/**
+ * Control values for the Custom step
+ */
+export type CustomStepUpsertDtoControlValues = {
+  /**
+   * Custom control values for the step.
+   */
+  custom?: { [k: string]: any } | undefined;
+};
+
+export type CustomStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the Custom step
+   */
+  controlValues?: CustomStepUpsertDtoControlValues | null | undefined;
+};
+
+/** @internal */
+export const CustomStepUpsertDtoControlValues$inboundSchema: z.ZodType<
+  CustomStepUpsertDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  custom: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type CustomStepUpsertDtoControlValues$Outbound = {
+  custom?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CustomStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  CustomStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  CustomStepUpsertDtoControlValues
+> = z.object({
+  custom: z.record(z.any()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomStepUpsertDtoControlValues$ {
+  /** @deprecated use `CustomStepUpsertDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = CustomStepUpsertDtoControlValues$inboundSchema;
+  /** @deprecated use `CustomStepUpsertDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = CustomStepUpsertDtoControlValues$outboundSchema;
+  /** @deprecated use `CustomStepUpsertDtoControlValues$Outbound` instead. */
+  export type Outbound = CustomStepUpsertDtoControlValues$Outbound;
+}
+
+export function customStepUpsertDtoControlValuesToJSON(
+  customStepUpsertDtoControlValues: CustomStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    CustomStepUpsertDtoControlValues$outboundSchema.parse(
+      customStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+export function customStepUpsertDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomStepUpsertDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomStepUpsertDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomStepUpsertDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomStepUpsertDto$inboundSchema: z.ZodType<
+  CustomStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.nullable(
+    z.lazy(() => CustomStepUpsertDtoControlValues$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type CustomStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?: CustomStepUpsertDtoControlValues$Outbound | null | undefined;
+};
+
+/** @internal */
+export const CustomStepUpsertDto$outboundSchema: z.ZodType<
+  CustomStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  CustomStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.nullable(
+    z.lazy(() => CustomStepUpsertDtoControlValues$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 CustomStepUpsertDto$ {
+  /** @deprecated use `CustomStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = CustomStepUpsertDto$inboundSchema;
+  /** @deprecated use `CustomStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = CustomStepUpsertDto$outboundSchema;
+  /** @deprecated use `CustomStepUpsertDto$Outbound` instead. */
+  export type Outbound = CustomStepUpsertDto$Outbound;
+}
+
+export function customStepUpsertDtoToJSON(
+  customStepUpsertDto: CustomStepUpsertDto,
+): string {
+  return JSON.stringify(
+    CustomStepUpsertDto$outboundSchema.parse(customStepUpsertDto),
+  );
+}
+
+export function customStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomStepUpsertDto' from JSON`,
+  );
+}

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`,
+  );
+}