@novu/api 1.3.0 → 1.4.0

package/src/models/components/smsstepupsertdto.ts

@@ -0,0 +1,181 @@
+/*
+ * 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 SMS step
+ */
+export type SmsStepUpsertDtoControlValues = {
+  /**
+   * 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;
+};
+
+export type SmsStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the SMS step
+   */
+  controlValues?: SmsStepUpsertDtoControlValues | null | undefined;
+};
+
+/** @internal */
+export const SmsStepUpsertDtoControlValues$inboundSchema: z.ZodType<
+  SmsStepUpsertDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+});
+
+/** @internal */
+export type SmsStepUpsertDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+};
+
+/** @internal */
+export const SmsStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  SmsStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  SmsStepUpsertDtoControlValues
+> = 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 SmsStepUpsertDtoControlValues$ {
+  /** @deprecated use `SmsStepUpsertDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = SmsStepUpsertDtoControlValues$inboundSchema;
+  /** @deprecated use `SmsStepUpsertDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = SmsStepUpsertDtoControlValues$outboundSchema;
+  /** @deprecated use `SmsStepUpsertDtoControlValues$Outbound` instead. */
+  export type Outbound = SmsStepUpsertDtoControlValues$Outbound;
+}
+
+export function smsStepUpsertDtoControlValuesToJSON(
+  smsStepUpsertDtoControlValues: SmsStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    SmsStepUpsertDtoControlValues$outboundSchema.parse(
+      smsStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+export function smsStepUpsertDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsStepUpsertDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsStepUpsertDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsStepUpsertDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const SmsStepUpsertDto$inboundSchema: z.ZodType<
+  SmsStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.nullable(
+    z.lazy(() => SmsStepUpsertDtoControlValues$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type SmsStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?: SmsStepUpsertDtoControlValues$Outbound | null | undefined;
+};
+
+/** @internal */
+export const SmsStepUpsertDto$outboundSchema: z.ZodType<
+  SmsStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  SmsStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.nullable(
+    z.lazy(() => SmsStepUpsertDtoControlValues$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 SmsStepUpsertDto$ {
+  /** @deprecated use `SmsStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = SmsStepUpsertDto$inboundSchema;
+  /** @deprecated use `SmsStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = SmsStepUpsertDto$outboundSchema;
+  /** @deprecated use `SmsStepUpsertDto$Outbound` instead. */
+  export type Outbound = SmsStepUpsertDto$Outbound;
+}
+
+export function smsStepUpsertDtoToJSON(
+  smsStepUpsertDto: SmsStepUpsertDto,
+): string {
+  return JSON.stringify(
+    SmsStepUpsertDto$outboundSchema.parse(smsStepUpsertDto),
+  );
+}
+
+export function smsStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsStepUpsertDto' from JSON`,
+  );
+}

package/src/models/components/stepcontentissuedto.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  StepContentIssueEnum,
+  StepContentIssueEnum$inboundSchema,
+  StepContentIssueEnum$outboundSchema,
+} from "./stepcontentissueenum.js";
+
+export type StepContentIssueDto = {
+  /**
+   * Type of step content issue
+   */
+  issueType: StepContentIssueEnum;
+  /**
+   * Name of the variable related to the issue
+   */
+  variableName?: string | undefined;
+  /**
+   * Detailed message describing the issue
+   */
+  message: string;
+};
+
+/** @internal */
+export const StepContentIssueDto$inboundSchema: z.ZodType<
+  StepContentIssueDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  issueType: StepContentIssueEnum$inboundSchema,
+  variableName: z.string().optional(),
+  message: z.string(),
+});
+
+/** @internal */
+export type StepContentIssueDto$Outbound = {
+  issueType: string;
+  variableName?: string | undefined;
+  message: string;
+};
+
+/** @internal */
+export const StepContentIssueDto$outboundSchema: z.ZodType<
+  StepContentIssueDto$Outbound,
+  z.ZodTypeDef,
+  StepContentIssueDto
+> = z.object({
+  issueType: StepContentIssueEnum$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 StepContentIssueDto$ {
+  /** @deprecated use `StepContentIssueDto$inboundSchema` instead. */
+  export const inboundSchema = StepContentIssueDto$inboundSchema;
+  /** @deprecated use `StepContentIssueDto$outboundSchema` instead. */
+  export const outboundSchema = StepContentIssueDto$outboundSchema;
+  /** @deprecated use `StepContentIssueDto$Outbound` instead. */
+  export type Outbound = StepContentIssueDto$Outbound;
+}
+
+export function stepContentIssueDtoToJSON(
+  stepContentIssueDto: StepContentIssueDto,
+): string {
+  return JSON.stringify(
+    StepContentIssueDto$outboundSchema.parse(stepContentIssueDto),
+  );
+}
+
+export function stepContentIssueDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<StepContentIssueDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepContentIssueDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepContentIssueDto' from JSON`,
+  );
+}

package/src/models/components/stepcontentissueenum.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of step content issue
+ */
+export const StepContentIssueEnum = {
+  IllegalVariableInControlValue: "ILLEGAL_VARIABLE_IN_CONTROL_VALUE",
+  InvalidFilterArgInVariable: "INVALID_FILTER_ARG_IN_VARIABLE",
+  MissingValue: "MISSING_VALUE",
+  TierLimitExceeded: "TIER_LIMIT_EXCEEDED",
+} as const;
+/**
+ * Type of step content issue
+ */
+export type StepContentIssueEnum = ClosedEnum<typeof StepContentIssueEnum>;
+
+/** @internal */
+export const StepContentIssueEnum$inboundSchema: z.ZodNativeEnum<
+  typeof StepContentIssueEnum
+> = z.nativeEnum(StepContentIssueEnum);
+
+/** @internal */
+export const StepContentIssueEnum$outboundSchema: z.ZodNativeEnum<
+  typeof StepContentIssueEnum
+> = StepContentIssueEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StepContentIssueEnum$ {
+  /** @deprecated use `StepContentIssueEnum$inboundSchema` instead. */
+  export const inboundSchema = StepContentIssueEnum$inboundSchema;
+  /** @deprecated use `StepContentIssueEnum$outboundSchema` instead. */
+  export const outboundSchema = StepContentIssueEnum$outboundSchema;
+}

package/src/models/components/stepintegrationissue.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  StepIntegrationIssueEnum,
+  StepIntegrationIssueEnum$inboundSchema,
+  StepIntegrationIssueEnum$outboundSchema,
+} from "./stepintegrationissueenum.js";
+
+export type StepIntegrationIssue = {
+  /**
+   * Type of integration issue
+   */
+  issueType: StepIntegrationIssueEnum;
+  /**
+   * Name of the variable related to the issue
+   */
+  variableName?: string | undefined;
+  /**
+   * Detailed message describing the issue
+   */
+  message: string;
+};
+
+/** @internal */
+export const StepIntegrationIssue$inboundSchema: z.ZodType<
+  StepIntegrationIssue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  issueType: StepIntegrationIssueEnum$inboundSchema,
+  variableName: z.string().optional(),
+  message: z.string(),
+});
+
+/** @internal */
+export type StepIntegrationIssue$Outbound = {
+  issueType: string;
+  variableName?: string | undefined;
+  message: string;
+};
+
+/** @internal */
+export const StepIntegrationIssue$outboundSchema: z.ZodType<
+  StepIntegrationIssue$Outbound,
+  z.ZodTypeDef,
+  StepIntegrationIssue
+> = z.object({
+  issueType: StepIntegrationIssueEnum$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 StepIntegrationIssue$ {
+  /** @deprecated use `StepIntegrationIssue$inboundSchema` instead. */
+  export const inboundSchema = StepIntegrationIssue$inboundSchema;
+  /** @deprecated use `StepIntegrationIssue$outboundSchema` instead. */
+  export const outboundSchema = StepIntegrationIssue$outboundSchema;
+  /** @deprecated use `StepIntegrationIssue$Outbound` instead. */
+  export type Outbound = StepIntegrationIssue$Outbound;
+}
+
+export function stepIntegrationIssueToJSON(
+  stepIntegrationIssue: StepIntegrationIssue,
+): string {
+  return JSON.stringify(
+    StepIntegrationIssue$outboundSchema.parse(stepIntegrationIssue),
+  );
+}
+
+export function stepIntegrationIssueFromJSON(
+  jsonString: string,
+): SafeParseResult<StepIntegrationIssue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepIntegrationIssue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepIntegrationIssue' from JSON`,
+  );
+}

package/src/models/components/stepintegrationissueenum.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";
+
+/**
+ * Type of integration issue
+ */
+export const StepIntegrationIssueEnum = {
+  MissingIntegration: "MISSING_INTEGRATION",
+} as const;
+/**
+ * Type of integration issue
+ */
+export type StepIntegrationIssueEnum = ClosedEnum<
+  typeof StepIntegrationIssueEnum
+>;
+
+/** @internal */
+export const StepIntegrationIssueEnum$inboundSchema: z.ZodNativeEnum<
+  typeof StepIntegrationIssueEnum
+> = z.nativeEnum(StepIntegrationIssueEnum);
+
+/** @internal */
+export const StepIntegrationIssueEnum$outboundSchema: z.ZodNativeEnum<
+  typeof StepIntegrationIssueEnum
+> = StepIntegrationIssueEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StepIntegrationIssueEnum$ {
+  /** @deprecated use `StepIntegrationIssueEnum$inboundSchema` instead. */
+  export const inboundSchema = StepIntegrationIssueEnum$inboundSchema;
+  /** @deprecated use `StepIntegrationIssueEnum$outboundSchema` instead. */
+  export const outboundSchema = StepIntegrationIssueEnum$outboundSchema;
+}

package/src/models/components/stepissuesdto.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 {
+  StepContentIssueDto,
+  StepContentIssueDto$inboundSchema,
+  StepContentIssueDto$Outbound,
+  StepContentIssueDto$outboundSchema,
+} from "./stepcontentissuedto.js";
+import {
+  StepIntegrationIssue,
+  StepIntegrationIssue$inboundSchema,
+  StepIntegrationIssue$Outbound,
+  StepIntegrationIssue$outboundSchema,
+} from "./stepintegrationissue.js";
+
+export type StepIssuesDto = {
+  /**
+   * Controls-related issues
+   */
+  controls?: { [k: string]: Array<StepContentIssueDto> } | undefined;
+  /**
+   * Integration-related issues
+   */
+  integration?: { [k: string]: Array<StepIntegrationIssue> } | undefined;
+};
+
+/** @internal */
+export const StepIssuesDto$inboundSchema: z.ZodType<
+  StepIssuesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: z.record(z.array(StepContentIssueDto$inboundSchema)).optional(),
+  integration: z.record(z.array(StepIntegrationIssue$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type StepIssuesDto$Outbound = {
+  controls?: { [k: string]: Array<StepContentIssueDto$Outbound> } | undefined;
+  integration?:
+    | { [k: string]: Array<StepIntegrationIssue$Outbound> }
+    | undefined;
+};
+
+/** @internal */
+export const StepIssuesDto$outboundSchema: z.ZodType<
+  StepIssuesDto$Outbound,
+  z.ZodTypeDef,
+  StepIssuesDto
+> = z.object({
+  controls: z.record(z.array(StepContentIssueDto$outboundSchema)).optional(),
+  integration: z.record(z.array(StepIntegrationIssue$outboundSchema))
+    .optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StepIssuesDto$ {
+  /** @deprecated use `StepIssuesDto$inboundSchema` instead. */
+  export const inboundSchema = StepIssuesDto$inboundSchema;
+  /** @deprecated use `StepIssuesDto$outboundSchema` instead. */
+  export const outboundSchema = StepIssuesDto$outboundSchema;
+  /** @deprecated use `StepIssuesDto$Outbound` instead. */
+  export type Outbound = StepIssuesDto$Outbound;
+}
+
+export function stepIssuesDtoToJSON(stepIssuesDto: StepIssuesDto): string {
+  return JSON.stringify(StepIssuesDto$outboundSchema.parse(stepIssuesDto));
+}
+
+export function stepIssuesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<StepIssuesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepIssuesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepIssuesDto' from JSON`,
+  );
+}