@novu/api 1.2.0 → 1.4.0

package/src/models/components/inappstepresponsedto.ts

@@ -0,0 +1,384 @@
+/*
+ * 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 {
+  ActionDto,
+  ActionDto$inboundSchema,
+  ActionDto$Outbound,
+  ActionDto$outboundSchema,
+} from "./actiondto.js";
+import {
+  InAppControlsMetadataResponseDto,
+  InAppControlsMetadataResponseDto$inboundSchema,
+  InAppControlsMetadataResponseDto$Outbound,
+  InAppControlsMetadataResponseDto$outboundSchema,
+} from "./inappcontrolsmetadataresponsedto.js";
+import {
+  RedirectDto,
+  RedirectDto$inboundSchema,
+  RedirectDto$Outbound,
+  RedirectDto$outboundSchema,
+} from "./redirectdto.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 in-app step
+ */
+export type InAppStepResponseDtoControlValues = {
+  /**
+   * 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/body of the in-app message. Required if subject is empty.
+   */
+  body?: string | undefined;
+  /**
+   * Subject/title of the in-app message. Required if body is empty.
+   */
+  subject?: string | undefined;
+  /**
+   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   */
+  avatar?: string | undefined;
+  /**
+   * Primary action button details.
+   */
+  primaryAction?: ActionDto | undefined;
+  /**
+   * Secondary action button details.
+   */
+  secondaryAction?: ActionDto | undefined;
+  /**
+   * Redirection URL configuration for the main content click (if no actions defined/clicked)..
+   */
+  redirect?: RedirectDto | undefined;
+  /**
+   * Disable sanitization of the output.
+   */
+  disableOutputSanitization?: boolean | undefined;
+  /**
+   * Additional data payload for the step.
+   */
+  data?: { [k: string]: any } | undefined;
+  additionalProperties?: { [k: string]: any };
+};
+
+/**
+ * Slug of the step
+ */
+export type InAppStepResponseDtoSlug = {};
+
+export type InAppStepResponseDto = {
+  /**
+   * Controls metadata for the in-app step
+   */
+  controls: InAppControlsMetadataResponseDto;
+  /**
+   * Control values for the in-app step
+   */
+  controlValues?: InAppStepResponseDtoControlValues | 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: InAppStepResponseDtoSlug;
+  /**
+   * 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 InAppStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  InAppStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    skip: z.record(z.any()).optional(),
+    body: z.string().optional(),
+    subject: z.string().optional(),
+    avatar: z.string().optional(),
+    primaryAction: ActionDto$inboundSchema.optional(),
+    secondaryAction: ActionDto$inboundSchema.optional(),
+    redirect: RedirectDto$inboundSchema.optional(),
+    disableOutputSanitization: z.boolean().default(false),
+    data: z.record(z.any()).optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+/** @internal */
+export type InAppStepResponseDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+  subject?: string | undefined;
+  avatar?: string | undefined;
+  primaryAction?: ActionDto$Outbound | undefined;
+  secondaryAction?: ActionDto$Outbound | undefined;
+  redirect?: RedirectDto$Outbound | undefined;
+  disableOutputSanitization: boolean;
+  data?: { [k: string]: any } | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const InAppStepResponseDtoControlValues$outboundSchema: z.ZodType<
+  InAppStepResponseDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  InAppStepResponseDtoControlValues
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+  subject: z.string().optional(),
+  avatar: z.string().optional(),
+  primaryAction: ActionDto$outboundSchema.optional(),
+  secondaryAction: ActionDto$outboundSchema.optional(),
+  redirect: RedirectDto$outboundSchema.optional(),
+  disableOutputSanitization: z.boolean().default(false),
+  data: 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 InAppStepResponseDtoControlValues$ {
+  /** @deprecated use `InAppStepResponseDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = InAppStepResponseDtoControlValues$inboundSchema;
+  /** @deprecated use `InAppStepResponseDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema =
+    InAppStepResponseDtoControlValues$outboundSchema;
+  /** @deprecated use `InAppStepResponseDtoControlValues$Outbound` instead. */
+  export type Outbound = InAppStepResponseDtoControlValues$Outbound;
+}
+
+export function inAppStepResponseDtoControlValuesToJSON(
+  inAppStepResponseDtoControlValues: InAppStepResponseDtoControlValues,
+): string {
+  return JSON.stringify(
+    InAppStepResponseDtoControlValues$outboundSchema.parse(
+      inAppStepResponseDtoControlValues,
+    ),
+  );
+}
+
+export function inAppStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppStepResponseDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppStepResponseDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const InAppStepResponseDtoSlug$inboundSchema: z.ZodType<
+  InAppStepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type InAppStepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const InAppStepResponseDtoSlug$outboundSchema: z.ZodType<
+  InAppStepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  InAppStepResponseDtoSlug
+> = 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 InAppStepResponseDtoSlug$ {
+  /** @deprecated use `InAppStepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = InAppStepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `InAppStepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = InAppStepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `InAppStepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = InAppStepResponseDtoSlug$Outbound;
+}
+
+export function inAppStepResponseDtoSlugToJSON(
+  inAppStepResponseDtoSlug: InAppStepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    InAppStepResponseDtoSlug$outboundSchema.parse(inAppStepResponseDtoSlug),
+  );
+}
+
+export function inAppStepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppStepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppStepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const InAppStepResponseDto$inboundSchema: z.ZodType<
+  InAppStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: InAppControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() => InAppStepResponseDtoControlValues$inboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => InAppStepResponseDtoSlug$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 InAppStepResponseDto$Outbound = {
+  controls: InAppControlsMetadataResponseDto$Outbound;
+  controlValues?: InAppStepResponseDtoControlValues$Outbound | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: InAppStepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const InAppStepResponseDto$outboundSchema: z.ZodType<
+  InAppStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  InAppStepResponseDto
+> = z.object({
+  controls: InAppControlsMetadataResponseDto$outboundSchema,
+  controlValues: z.lazy(() => InAppStepResponseDtoControlValues$outboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => InAppStepResponseDtoSlug$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 InAppStepResponseDto$ {
+  /** @deprecated use `InAppStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = InAppStepResponseDto$inboundSchema;
+  /** @deprecated use `InAppStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = InAppStepResponseDto$outboundSchema;
+  /** @deprecated use `InAppStepResponseDto$Outbound` instead. */
+  export type Outbound = InAppStepResponseDto$Outbound;
+}
+
+export function inAppStepResponseDtoToJSON(
+  inAppStepResponseDto: InAppStepResponseDto,
+): string {
+  return JSON.stringify(
+    InAppStepResponseDto$outboundSchema.parse(inAppStepResponseDto),
+  );
+}
+
+export function inAppStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppStepResponseDto' from JSON`,
+  );
+}

package/src/models/components/inappstepupsertdto.ts

@@ -0,0 +1,234 @@
+/*
+ * 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 {
+  ActionDto,
+  ActionDto$inboundSchema,
+  ActionDto$Outbound,
+  ActionDto$outboundSchema,
+} from "./actiondto.js";
+import {
+  RedirectDto,
+  RedirectDto$inboundSchema,
+  RedirectDto$Outbound,
+  RedirectDto$outboundSchema,
+} from "./redirectdto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+/**
+ * Control values for the In-App step
+ */
+export type ControlValues = {
+  /**
+   * 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/body of the in-app message. Required if subject is empty.
+   */
+  body?: string | undefined;
+  /**
+   * Subject/title of the in-app message. Required if body is empty.
+   */
+  subject?: string | undefined;
+  /**
+   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   */
+  avatar?: string | undefined;
+  /**
+   * Primary action button details.
+   */
+  primaryAction?: ActionDto | undefined;
+  /**
+   * Secondary action button details.
+   */
+  secondaryAction?: ActionDto | undefined;
+  /**
+   * Redirection URL configuration for the main content click (if no actions defined/clicked)..
+   */
+  redirect?: RedirectDto | undefined;
+  /**
+   * Disable sanitization of the output.
+   */
+  disableOutputSanitization?: boolean | undefined;
+  /**
+   * Additional data payload for the step.
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type InAppStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the In-App step
+   */
+  controlValues?: ControlValues | null | undefined;
+};
+
+/** @internal */
+export const ControlValues$inboundSchema: z.ZodType<
+  ControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+  subject: z.string().optional(),
+  avatar: z.string().optional(),
+  primaryAction: ActionDto$inboundSchema.optional(),
+  secondaryAction: ActionDto$inboundSchema.optional(),
+  redirect: RedirectDto$inboundSchema.optional(),
+  disableOutputSanitization: z.boolean().default(false),
+  data: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type ControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+  subject?: string | undefined;
+  avatar?: string | undefined;
+  primaryAction?: ActionDto$Outbound | undefined;
+  secondaryAction?: ActionDto$Outbound | undefined;
+  redirect?: RedirectDto$Outbound | undefined;
+  disableOutputSanitization: boolean;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ControlValues$outboundSchema: z.ZodType<
+  ControlValues$Outbound,
+  z.ZodTypeDef,
+  ControlValues
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+  subject: z.string().optional(),
+  avatar: z.string().optional(),
+  primaryAction: ActionDto$outboundSchema.optional(),
+  secondaryAction: ActionDto$outboundSchema.optional(),
+  redirect: RedirectDto$outboundSchema.optional(),
+  disableOutputSanitization: z.boolean().default(false),
+  data: 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 ControlValues$ {
+  /** @deprecated use `ControlValues$inboundSchema` instead. */
+  export const inboundSchema = ControlValues$inboundSchema;
+  /** @deprecated use `ControlValues$outboundSchema` instead. */
+  export const outboundSchema = ControlValues$outboundSchema;
+  /** @deprecated use `ControlValues$Outbound` instead. */
+  export type Outbound = ControlValues$Outbound;
+}
+
+export function controlValuesToJSON(controlValues: ControlValues): string {
+  return JSON.stringify(ControlValues$outboundSchema.parse(controlValues));
+}
+
+export function controlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<ControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const InAppStepUpsertDto$inboundSchema: z.ZodType<
+  InAppStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.nullable(z.lazy(() => ControlValues$inboundSchema))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type InAppStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?: ControlValues$Outbound | null | undefined;
+};
+
+/** @internal */
+export const InAppStepUpsertDto$outboundSchema: z.ZodType<
+  InAppStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  InAppStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.nullable(z.lazy(() => ControlValues$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 InAppStepUpsertDto$ {
+  /** @deprecated use `InAppStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = InAppStepUpsertDto$inboundSchema;
+  /** @deprecated use `InAppStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = InAppStepUpsertDto$outboundSchema;
+  /** @deprecated use `InAppStepUpsertDto$Outbound` instead. */
+  export type Outbound = InAppStepUpsertDto$Outbound;
+}
+
+export function inAppStepUpsertDtoToJSON(
+  inAppStepUpsertDto: InAppStepUpsertDto,
+): string {
+  return JSON.stringify(
+    InAppStepUpsertDto$outboundSchema.parse(inAppStepUpsertDto),
+  );
+}
+
+export function inAppStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppStepUpsertDto' from JSON`,
+  );
+}

package/src/models/components/inboundparsedomaindto.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 InBoundParseDomainDto = {
+  inboundParseDomain?: string | undefined;
+};
+
+/** @internal */
+export const InBoundParseDomainDto$inboundSchema: z.ZodType<
+  InBoundParseDomainDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inboundParseDomain: z.string().optional(),
+});
+
+/** @internal */
+export type InBoundParseDomainDto$Outbound = {
+  inboundParseDomain?: string | undefined;
+};
+
+/** @internal */
+export const InBoundParseDomainDto$outboundSchema: z.ZodType<
+  InBoundParseDomainDto$Outbound,
+  z.ZodTypeDef,
+  InBoundParseDomainDto
+> = z.object({
+  inboundParseDomain: 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 InBoundParseDomainDto$ {
+  /** @deprecated use `InBoundParseDomainDto$inboundSchema` instead. */
+  export const inboundSchema = InBoundParseDomainDto$inboundSchema;
+  /** @deprecated use `InBoundParseDomainDto$outboundSchema` instead. */
+  export const outboundSchema = InBoundParseDomainDto$outboundSchema;
+  /** @deprecated use `InBoundParseDomainDto$Outbound` instead. */
+  export type Outbound = InBoundParseDomainDto$Outbound;
+}
+
+export function inBoundParseDomainDtoToJSON(
+  inBoundParseDomainDto: InBoundParseDomainDto,
+): string {
+  return JSON.stringify(
+    InBoundParseDomainDto$outboundSchema.parse(inBoundParseDomainDto),
+  );
+}
+
+export function inBoundParseDomainDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InBoundParseDomainDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InBoundParseDomainDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InBoundParseDomainDto' from JSON`,
+  );
+}