@novu/api 1.3.0 → 1.5.0

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

package/src/models/components/pushstepresponsedto.ts

@@ -0,0 +1,329 @@
+/*
+ * 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 {
+  PushControlsMetadataResponseDto,
+  PushControlsMetadataResponseDto$inboundSchema,
+  PushControlsMetadataResponseDto$Outbound,
+  PushControlsMetadataResponseDto$outboundSchema,
+} from "./pushcontrolsmetadataresponsedto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.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 push step
+ */
+export type PushStepResponseDtoControlValues = {
+  /**
+   * 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;
+  /**
+   * Subject/title of the push notification.
+   */
+  subject?: string | undefined;
+  /**
+   * Body content of the push notification.
+   */
+  body?: string | undefined;
+  additionalProperties?: { [k: string]: any };
+};
+
+/**
+ * Slug of the step
+ */
+export type PushStepResponseDtoSlug = {};
+
+export type PushStepResponseDto = {
+  /**
+   * Controls metadata for the push step
+   */
+  controls: PushControlsMetadataResponseDto;
+  /**
+   * Control values for the push step
+   */
+  controlValues?: PushStepResponseDtoControlValues | 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: PushStepResponseDtoSlug;
+  /**
+   * 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 PushStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  PushStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    skip: z.record(z.any()).optional(),
+    subject: z.string().optional(),
+    body: z.string().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+/** @internal */
+export type PushStepResponseDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  subject?: string | undefined;
+  body?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const PushStepResponseDtoControlValues$outboundSchema: z.ZodType<
+  PushStepResponseDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  PushStepResponseDtoControlValues
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  subject: z.string().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 PushStepResponseDtoControlValues$ {
+  /** @deprecated use `PushStepResponseDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = PushStepResponseDtoControlValues$inboundSchema;
+  /** @deprecated use `PushStepResponseDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = PushStepResponseDtoControlValues$outboundSchema;
+  /** @deprecated use `PushStepResponseDtoControlValues$Outbound` instead. */
+  export type Outbound = PushStepResponseDtoControlValues$Outbound;
+}
+
+export function pushStepResponseDtoControlValuesToJSON(
+  pushStepResponseDtoControlValues: PushStepResponseDtoControlValues,
+): string {
+  return JSON.stringify(
+    PushStepResponseDtoControlValues$outboundSchema.parse(
+      pushStepResponseDtoControlValues,
+    ),
+  );
+}
+
+export function pushStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<PushStepResponseDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushStepResponseDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const PushStepResponseDtoSlug$inboundSchema: z.ZodType<
+  PushStepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type PushStepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const PushStepResponseDtoSlug$outboundSchema: z.ZodType<
+  PushStepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  PushStepResponseDtoSlug
+> = 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 PushStepResponseDtoSlug$ {
+  /** @deprecated use `PushStepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = PushStepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `PushStepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = PushStepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `PushStepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = PushStepResponseDtoSlug$Outbound;
+}
+
+export function pushStepResponseDtoSlugToJSON(
+  pushStepResponseDtoSlug: PushStepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    PushStepResponseDtoSlug$outboundSchema.parse(pushStepResponseDtoSlug),
+  );
+}
+
+export function pushStepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<PushStepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushStepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const PushStepResponseDto$inboundSchema: z.ZodType<
+  PushStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: PushControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() => PushStepResponseDtoControlValues$inboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => PushStepResponseDtoSlug$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 PushStepResponseDto$Outbound = {
+  controls: PushControlsMetadataResponseDto$Outbound;
+  controlValues?: PushStepResponseDtoControlValues$Outbound | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: PushStepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const PushStepResponseDto$outboundSchema: z.ZodType<
+  PushStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  PushStepResponseDto
+> = z.object({
+  controls: PushControlsMetadataResponseDto$outboundSchema,
+  controlValues: z.lazy(() => PushStepResponseDtoControlValues$outboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => PushStepResponseDtoSlug$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 PushStepResponseDto$ {
+  /** @deprecated use `PushStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = PushStepResponseDto$inboundSchema;
+  /** @deprecated use `PushStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = PushStepResponseDto$outboundSchema;
+  /** @deprecated use `PushStepResponseDto$Outbound` instead. */
+  export type Outbound = PushStepResponseDto$Outbound;
+}
+
+export function pushStepResponseDtoToJSON(
+  pushStepResponseDto: PushStepResponseDto,
+): string {
+  return JSON.stringify(
+    PushStepResponseDto$outboundSchema.parse(pushStepResponseDto),
+  );
+}
+
+export function pushStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PushStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushStepResponseDto' from JSON`,
+  );
+}

package/src/models/components/pushstepupsertdto.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 {
+  PushControlDto,
+  PushControlDto$inboundSchema,
+  PushControlDto$Outbound,
+  PushControlDto$outboundSchema,
+} from "./pushcontroldto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+/**
+ * Control values for the Push step.
+ */
+export type PushStepUpsertDtoControlValues = PushControlDto | {
+  [k: string]: any;
+};
+
+export type PushStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the Push step.
+   */
+  controlValues?: PushControlDto | { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PushStepUpsertDtoControlValues$inboundSchema: z.ZodType<
+  PushStepUpsertDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.union([PushControlDto$inboundSchema, z.record(z.any())]);
+
+/** @internal */
+export type PushStepUpsertDtoControlValues$Outbound =
+  | PushControlDto$Outbound
+  | { [k: string]: any };
+
+/** @internal */
+export const PushStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  PushStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  PushStepUpsertDtoControlValues
+> = z.union([PushControlDto$outboundSchema, z.record(z.any())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PushStepUpsertDtoControlValues$ {
+  /** @deprecated use `PushStepUpsertDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = PushStepUpsertDtoControlValues$inboundSchema;
+  /** @deprecated use `PushStepUpsertDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = PushStepUpsertDtoControlValues$outboundSchema;
+  /** @deprecated use `PushStepUpsertDtoControlValues$Outbound` instead. */
+  export type Outbound = PushStepUpsertDtoControlValues$Outbound;
+}
+
+export function pushStepUpsertDtoControlValuesToJSON(
+  pushStepUpsertDtoControlValues: PushStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    PushStepUpsertDtoControlValues$outboundSchema.parse(
+      pushStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+export function pushStepUpsertDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<PushStepUpsertDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushStepUpsertDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushStepUpsertDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const PushStepUpsertDto$inboundSchema: z.ZodType<
+  PushStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.union([PushControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type PushStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?: PushControlDto$Outbound | { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PushStepUpsertDto$outboundSchema: z.ZodType<
+  PushStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  PushStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.union([PushControlDto$outboundSchema, z.record(z.any())])
+    .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 PushStepUpsertDto$ {
+  /** @deprecated use `PushStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = PushStepUpsertDto$inboundSchema;
+  /** @deprecated use `PushStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = PushStepUpsertDto$outboundSchema;
+  /** @deprecated use `PushStepUpsertDto$Outbound` instead. */
+  export type Outbound = PushStepUpsertDto$Outbound;
+}
+
+export function pushStepUpsertDtoToJSON(
+  pushStepUpsertDto: PushStepUpsertDto,
+): string {
+  return JSON.stringify(
+    PushStepUpsertDto$outboundSchema.parse(pushStepUpsertDto),
+  );
+}
+
+export function pushStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PushStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushStepUpsertDto' from JSON`,
+  );
+}

package/src/models/components/redirectdto.ts

@@ -0,0 +1,107 @@
+/*
+ * 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";
+
+/**
+ * Target window for the redirection.
+ */
+export const Target = {
+  Self: "_self",
+  Blank: "_blank",
+  Parent: "_parent",
+  Top: "_top",
+  UnfencedTop: "_unfencedTop",
+} as const;
+/**
+ * Target window for the redirection.
+ */
+export type Target = ClosedEnum<typeof Target>;
+
+export type RedirectDto = {
+  /**
+   * URL for redirection. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   */
+  url?: string | undefined;
+  /**
+   * Target window for the redirection.
+   */
+  target?: Target | undefined;
+};
+
+/** @internal */
+export const Target$inboundSchema: z.ZodNativeEnum<typeof Target> = z
+  .nativeEnum(Target);
+
+/** @internal */
+export const Target$outboundSchema: z.ZodNativeEnum<typeof Target> =
+  Target$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Target$ {
+  /** @deprecated use `Target$inboundSchema` instead. */
+  export const inboundSchema = Target$inboundSchema;
+  /** @deprecated use `Target$outboundSchema` instead. */
+  export const outboundSchema = Target$outboundSchema;
+}
+
+/** @internal */
+export const RedirectDto$inboundSchema: z.ZodType<
+  RedirectDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string().optional(),
+  target: Target$inboundSchema.default("_self"),
+});
+
+/** @internal */
+export type RedirectDto$Outbound = {
+  url?: string | undefined;
+  target: string;
+};
+
+/** @internal */
+export const RedirectDto$outboundSchema: z.ZodType<
+  RedirectDto$Outbound,
+  z.ZodTypeDef,
+  RedirectDto
+> = z.object({
+  url: z.string().optional(),
+  target: Target$outboundSchema.default("_self"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RedirectDto$ {
+  /** @deprecated use `RedirectDto$inboundSchema` instead. */
+  export const inboundSchema = RedirectDto$inboundSchema;
+  /** @deprecated use `RedirectDto$outboundSchema` instead. */
+  export const outboundSchema = RedirectDto$outboundSchema;
+  /** @deprecated use `RedirectDto$Outbound` instead. */
+  export type Outbound = RedirectDto$Outbound;
+}
+
+export function redirectDtoToJSON(redirectDto: RedirectDto): string {
+  return JSON.stringify(RedirectDto$outboundSchema.parse(redirectDto));
+}
+
+export function redirectDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<RedirectDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RedirectDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RedirectDto' from JSON`,
+  );
+}