@novu/api 1.3.0 → 1.5.0

package/src/models/components/resourceoriginenum.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Origin of the workflow
+ */
+export const ResourceOriginEnum = {
+  NovuCloud: "novu-cloud",
+  NovuCloudV1: "novu-cloud-v1",
+  External: "external",
+} as const;
+/**
+ * Origin of the workflow
+ */
+export type ResourceOriginEnum = ClosedEnum<typeof ResourceOriginEnum>;
+
+/** @internal */
+export const ResourceOriginEnum$inboundSchema: z.ZodNativeEnum<
+  typeof ResourceOriginEnum
+> = z.nativeEnum(ResourceOriginEnum);
+
+/** @internal */
+export const ResourceOriginEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ResourceOriginEnum
+> = ResourceOriginEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ResourceOriginEnum$ {
+  /** @deprecated use `ResourceOriginEnum$inboundSchema` instead. */
+  export const inboundSchema = ResourceOriginEnum$inboundSchema;
+  /** @deprecated use `ResourceOriginEnum$outboundSchema` instead. */
+  export const outboundSchema = ResourceOriginEnum$outboundSchema;
+}

package/src/models/components/runtimeissuedto.ts

@@ -0,0 +1,101 @@
+/*
+ * 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";
+
+export const IssueType = {
+  MissingValue: "MISSING_VALUE",
+  MaxLengthAccessed: "MAX_LENGTH_ACCESSED",
+  WorkflowIdAlreadyExists: "WORKFLOW_ID_ALREADY_EXISTS",
+  DuplicatedValue: "DUPLICATED_VALUE",
+  LimitReached: "LIMIT_REACHED",
+} as const;
+export type IssueType = ClosedEnum<typeof IssueType>;
+
+export type RuntimeIssueDto = {
+  issueType: IssueType;
+  variableName?: string | undefined;
+  message: string;
+};
+
+/** @internal */
+export const IssueType$inboundSchema: z.ZodNativeEnum<typeof IssueType> = z
+  .nativeEnum(IssueType);
+
+/** @internal */
+export const IssueType$outboundSchema: z.ZodNativeEnum<typeof IssueType> =
+  IssueType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace IssueType$ {
+  /** @deprecated use `IssueType$inboundSchema` instead. */
+  export const inboundSchema = IssueType$inboundSchema;
+  /** @deprecated use `IssueType$outboundSchema` instead. */
+  export const outboundSchema = IssueType$outboundSchema;
+}
+
+/** @internal */
+export const RuntimeIssueDto$inboundSchema: z.ZodType<
+  RuntimeIssueDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  issueType: IssueType$inboundSchema,
+  variableName: z.string().optional(),
+  message: z.string(),
+});
+
+/** @internal */
+export type RuntimeIssueDto$Outbound = {
+  issueType: string;
+  variableName?: string | undefined;
+  message: string;
+};
+
+/** @internal */
+export const RuntimeIssueDto$outboundSchema: z.ZodType<
+  RuntimeIssueDto$Outbound,
+  z.ZodTypeDef,
+  RuntimeIssueDto
+> = z.object({
+  issueType: IssueType$outboundSchema,
+  variableName: z.string().optional(),
+  message: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RuntimeIssueDto$ {
+  /** @deprecated use `RuntimeIssueDto$inboundSchema` instead. */
+  export const inboundSchema = RuntimeIssueDto$inboundSchema;
+  /** @deprecated use `RuntimeIssueDto$outboundSchema` instead. */
+  export const outboundSchema = RuntimeIssueDto$outboundSchema;
+  /** @deprecated use `RuntimeIssueDto$Outbound` instead. */
+  export type Outbound = RuntimeIssueDto$Outbound;
+}
+
+export function runtimeIssueDtoToJSON(
+  runtimeIssueDto: RuntimeIssueDto,
+): string {
+  return JSON.stringify(RuntimeIssueDto$outboundSchema.parse(runtimeIssueDto));
+}
+
+export function runtimeIssueDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<RuntimeIssueDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RuntimeIssueDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RuntimeIssueDto' from JSON`,
+  );
+}

package/src/models/components/smscontroldto.ts

@@ -0,0 +1,72 @@
+/*
+ * 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";
+
+export type SmsControlDto = {
+  /**
+   * 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;
+  /**
+   * Content of the SMS message.
+   */
+  body?: string | undefined;
+};
+
+/** @internal */
+export const SmsControlDto$inboundSchema: z.ZodType<
+  SmsControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+});
+
+/** @internal */
+export type SmsControlDto$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+};
+
+/** @internal */
+export const SmsControlDto$outboundSchema: z.ZodType<
+  SmsControlDto$Outbound,
+  z.ZodTypeDef,
+  SmsControlDto
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SmsControlDto$ {
+  /** @deprecated use `SmsControlDto$inboundSchema` instead. */
+  export const inboundSchema = SmsControlDto$inboundSchema;
+  /** @deprecated use `SmsControlDto$outboundSchema` instead. */
+  export const outboundSchema = SmsControlDto$outboundSchema;
+  /** @deprecated use `SmsControlDto$Outbound` instead. */
+  export type Outbound = SmsControlDto$Outbound;
+}
+
+export function smsControlDtoToJSON(smsControlDto: SmsControlDto): string {
+  return JSON.stringify(SmsControlDto$outboundSchema.parse(smsControlDto));
+}
+
+export function smsControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsControlDto' from JSON`,
+  );
+}

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

package/src/models/components/smsstepresponsedto.ts

@@ -0,0 +1,322 @@
+/*
+ * 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 {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
+import {
+  SmsControlsMetadataResponseDto,
+  SmsControlsMetadataResponseDto$inboundSchema,
+  SmsControlsMetadataResponseDto$Outbound,
+  SmsControlsMetadataResponseDto$outboundSchema,
+} from "./smscontrolsmetadataresponsedto.js";
+import {
+  StepIssuesDto,
+  StepIssuesDto$inboundSchema,
+  StepIssuesDto$Outbound,
+  StepIssuesDto$outboundSchema,
+} from "./stepissuesdto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+/**
+ * Control values for the SMS step
+ */
+export type SmsStepResponseDtoControlValues = {
+  /**
+   * 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;
+  /**
+   * Content of the SMS message.
+   */
+  body?: string | undefined;
+  additionalProperties?: { [k: string]: any };
+};
+
+/**
+ * Slug of the step
+ */
+export type SmsStepResponseDtoSlug = {};
+
+export type SmsStepResponseDto = {
+  /**
+   * Controls metadata for the SMS step
+   */
+  controls: SmsControlsMetadataResponseDto;
+  /**
+   * Control values for the SMS step
+   */
+  controlValues?: SmsStepResponseDtoControlValues | 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: SmsStepResponseDtoSlug;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Origin of the workflow
+   */
+  origin: ResourceOriginEnum;
+  /**
+   * Workflow identifier
+   */
+  workflowId: string;
+  /**
+   * Workflow database identifier
+   */
+  workflowDatabaseId: string;
+  /**
+   * Issues associated with the step
+   */
+  issues?: StepIssuesDto | undefined;
+};
+
+/** @internal */
+export const SmsStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  SmsStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    skip: z.record(z.any()).optional(),
+    body: z.string().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+/** @internal */
+export type SmsStepResponseDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const SmsStepResponseDtoControlValues$outboundSchema: z.ZodType<
+  SmsStepResponseDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  SmsStepResponseDtoControlValues
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().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 SmsStepResponseDtoControlValues$ {
+  /** @deprecated use `SmsStepResponseDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = SmsStepResponseDtoControlValues$inboundSchema;
+  /** @deprecated use `SmsStepResponseDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = SmsStepResponseDtoControlValues$outboundSchema;
+  /** @deprecated use `SmsStepResponseDtoControlValues$Outbound` instead. */
+  export type Outbound = SmsStepResponseDtoControlValues$Outbound;
+}
+
+export function smsStepResponseDtoControlValuesToJSON(
+  smsStepResponseDtoControlValues: SmsStepResponseDtoControlValues,
+): string {
+  return JSON.stringify(
+    SmsStepResponseDtoControlValues$outboundSchema.parse(
+      smsStepResponseDtoControlValues,
+    ),
+  );
+}
+
+export function smsStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsStepResponseDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsStepResponseDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const SmsStepResponseDtoSlug$inboundSchema: z.ZodType<
+  SmsStepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type SmsStepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const SmsStepResponseDtoSlug$outboundSchema: z.ZodType<
+  SmsStepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  SmsStepResponseDtoSlug
+> = 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 SmsStepResponseDtoSlug$ {
+  /** @deprecated use `SmsStepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = SmsStepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `SmsStepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = SmsStepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `SmsStepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = SmsStepResponseDtoSlug$Outbound;
+}
+
+export function smsStepResponseDtoSlugToJSON(
+  smsStepResponseDtoSlug: SmsStepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    SmsStepResponseDtoSlug$outboundSchema.parse(smsStepResponseDtoSlug),
+  );
+}
+
+export function smsStepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsStepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsStepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const SmsStepResponseDto$inboundSchema: z.ZodType<
+  SmsStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: SmsControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() => SmsStepResponseDtoControlValues$inboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => SmsStepResponseDtoSlug$inboundSchema),
+  type: StepTypeEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
+  workflowId: z.string(),
+  workflowDatabaseId: z.string(),
+  issues: StepIssuesDto$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type SmsStepResponseDto$Outbound = {
+  controls: SmsControlsMetadataResponseDto$Outbound;
+  controlValues?: SmsStepResponseDtoControlValues$Outbound | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: SmsStepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const SmsStepResponseDto$outboundSchema: z.ZodType<
+  SmsStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  SmsStepResponseDto
+> = z.object({
+  controls: SmsControlsMetadataResponseDto$outboundSchema,
+  controlValues: z.lazy(() => SmsStepResponseDtoControlValues$outboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => SmsStepResponseDtoSlug$outboundSchema),
+  type: StepTypeEnum$outboundSchema,
+  origin: ResourceOriginEnum$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 SmsStepResponseDto$ {
+  /** @deprecated use `SmsStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = SmsStepResponseDto$inboundSchema;
+  /** @deprecated use `SmsStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = SmsStepResponseDto$outboundSchema;
+  /** @deprecated use `SmsStepResponseDto$Outbound` instead. */
+  export type Outbound = SmsStepResponseDto$Outbound;
+}
+
+export function smsStepResponseDtoToJSON(
+  smsStepResponseDto: SmsStepResponseDto,
+): string {
+  return JSON.stringify(
+    SmsStepResponseDto$outboundSchema.parse(smsStepResponseDto),
+  );
+}
+
+export function smsStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsStepResponseDto' from JSON`,
+  );
+}