@novu/api 1.2.0 → 1.4.0

package/src/models/components/bridgeconfigurationdto.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 BridgeConfigurationDto = {
+  url?: string | undefined;
+};
+
+/** @internal */
+export const BridgeConfigurationDto$inboundSchema: z.ZodType<
+  BridgeConfigurationDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string().optional(),
+});
+
+/** @internal */
+export type BridgeConfigurationDto$Outbound = {
+  url?: string | undefined;
+};
+
+/** @internal */
+export const BridgeConfigurationDto$outboundSchema: z.ZodType<
+  BridgeConfigurationDto$Outbound,
+  z.ZodTypeDef,
+  BridgeConfigurationDto
+> = z.object({
+  url: 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 BridgeConfigurationDto$ {
+  /** @deprecated use `BridgeConfigurationDto$inboundSchema` instead. */
+  export const inboundSchema = BridgeConfigurationDto$inboundSchema;
+  /** @deprecated use `BridgeConfigurationDto$outboundSchema` instead. */
+  export const outboundSchema = BridgeConfigurationDto$outboundSchema;
+  /** @deprecated use `BridgeConfigurationDto$Outbound` instead. */
+  export type Outbound = BridgeConfigurationDto$Outbound;
+}
+
+export function bridgeConfigurationDtoToJSON(
+  bridgeConfigurationDto: BridgeConfigurationDto,
+): string {
+  return JSON.stringify(
+    BridgeConfigurationDto$outboundSchema.parse(bridgeConfigurationDto),
+  );
+}
+
+export function bridgeConfigurationDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BridgeConfigurationDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BridgeConfigurationDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BridgeConfigurationDto' from JSON`,
+  );
+}

package/src/models/components/channelpreferencedto.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 ChannelPreferenceDto = {
+  /**
+   * A flag specifying if notification delivery is enabled for the channel. If true, notification delivery is enabled.
+   */
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export const ChannelPreferenceDto$inboundSchema: z.ZodType<
+  ChannelPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean().default(true),
+});
+
+/** @internal */
+export type ChannelPreferenceDto$Outbound = {
+  enabled: boolean;
+};
+
+/** @internal */
+export const ChannelPreferenceDto$outboundSchema: z.ZodType<
+  ChannelPreferenceDto$Outbound,
+  z.ZodTypeDef,
+  ChannelPreferenceDto
+> = z.object({
+  enabled: z.boolean().default(true),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelPreferenceDto$ {
+  /** @deprecated use `ChannelPreferenceDto$inboundSchema` instead. */
+  export const inboundSchema = ChannelPreferenceDto$inboundSchema;
+  /** @deprecated use `ChannelPreferenceDto$outboundSchema` instead. */
+  export const outboundSchema = ChannelPreferenceDto$outboundSchema;
+  /** @deprecated use `ChannelPreferenceDto$Outbound` instead. */
+  export type Outbound = ChannelPreferenceDto$Outbound;
+}
+
+export function channelPreferenceDtoToJSON(
+  channelPreferenceDto: ChannelPreferenceDto,
+): string {
+  return JSON.stringify(
+    ChannelPreferenceDto$outboundSchema.parse(channelPreferenceDto),
+  );
+}
+
+export function channelPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ChannelPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChannelPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChannelPreferenceDto' from JSON`,
+  );
+}

package/src/models/components/chatcontroldto.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 ChatControlDto = {
+  /**
+   * 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 chat message.
+   */
+  body?: string | undefined;
+};
+
+/** @internal */
+export const ChatControlDto$inboundSchema: z.ZodType<
+  ChatControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+});
+
+/** @internal */
+export type ChatControlDto$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+};
+
+/** @internal */
+export const ChatControlDto$outboundSchema: z.ZodType<
+  ChatControlDto$Outbound,
+  z.ZodTypeDef,
+  ChatControlDto
+> = 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 ChatControlDto$ {
+  /** @deprecated use `ChatControlDto$inboundSchema` instead. */
+  export const inboundSchema = ChatControlDto$inboundSchema;
+  /** @deprecated use `ChatControlDto$outboundSchema` instead. */
+  export const outboundSchema = ChatControlDto$outboundSchema;
+  /** @deprecated use `ChatControlDto$Outbound` instead. */
+  export type Outbound = ChatControlDto$Outbound;
+}
+
+export function chatControlDtoToJSON(chatControlDto: ChatControlDto): string {
+  return JSON.stringify(ChatControlDto$outboundSchema.parse(chatControlDto));
+}
+
+export function chatControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatControlDto' from JSON`,
+  );
+}

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

package/src/models/components/chatstepresponsedto.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 {
+  ChatControlsMetadataResponseDto,
+  ChatControlsMetadataResponseDto$inboundSchema,
+  ChatControlsMetadataResponseDto$Outbound,
+  ChatControlsMetadataResponseDto$outboundSchema,
+} from "./chatcontrolsmetadataresponsedto.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 chat step
+ */
+export type ChatStepResponseDtoControlValues = {
+  /**
+   * 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 chat message.
+   */
+  body?: string | undefined;
+  additionalProperties?: { [k: string]: any };
+};
+
+/**
+ * Slug of the step
+ */
+export type ChatStepResponseDtoSlug = {};
+
+export type ChatStepResponseDto = {
+  /**
+   * Controls metadata for the chat step
+   */
+  controls: ChatControlsMetadataResponseDto;
+  /**
+   * Control values for the chat step
+   */
+  controlValues?: ChatStepResponseDtoControlValues | 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: ChatStepResponseDtoSlug;
+  /**
+   * 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 ChatStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  ChatStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    skip: z.record(z.any()).optional(),
+    body: z.string().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+/** @internal */
+export type ChatStepResponseDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const ChatStepResponseDtoControlValues$outboundSchema: z.ZodType<
+  ChatStepResponseDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  ChatStepResponseDtoControlValues
+> = 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 ChatStepResponseDtoControlValues$ {
+  /** @deprecated use `ChatStepResponseDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = ChatStepResponseDtoControlValues$inboundSchema;
+  /** @deprecated use `ChatStepResponseDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = ChatStepResponseDtoControlValues$outboundSchema;
+  /** @deprecated use `ChatStepResponseDtoControlValues$Outbound` instead. */
+  export type Outbound = ChatStepResponseDtoControlValues$Outbound;
+}
+
+export function chatStepResponseDtoControlValuesToJSON(
+  chatStepResponseDtoControlValues: ChatStepResponseDtoControlValues,
+): string {
+  return JSON.stringify(
+    ChatStepResponseDtoControlValues$outboundSchema.parse(
+      chatStepResponseDtoControlValues,
+    ),
+  );
+}
+
+export function chatStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatStepResponseDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatStepResponseDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const ChatStepResponseDtoSlug$inboundSchema: z.ZodType<
+  ChatStepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type ChatStepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const ChatStepResponseDtoSlug$outboundSchema: z.ZodType<
+  ChatStepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  ChatStepResponseDtoSlug
+> = 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 ChatStepResponseDtoSlug$ {
+  /** @deprecated use `ChatStepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = ChatStepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `ChatStepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = ChatStepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `ChatStepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = ChatStepResponseDtoSlug$Outbound;
+}
+
+export function chatStepResponseDtoSlugToJSON(
+  chatStepResponseDtoSlug: ChatStepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    ChatStepResponseDtoSlug$outboundSchema.parse(chatStepResponseDtoSlug),
+  );
+}
+
+export function chatStepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatStepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatStepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const ChatStepResponseDto$inboundSchema: z.ZodType<
+  ChatStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: ChatControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() => ChatStepResponseDtoControlValues$inboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => ChatStepResponseDtoSlug$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 ChatStepResponseDto$Outbound = {
+  controls: ChatControlsMetadataResponseDto$Outbound;
+  controlValues?: ChatStepResponseDtoControlValues$Outbound | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: ChatStepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const ChatStepResponseDto$outboundSchema: z.ZodType<
+  ChatStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  ChatStepResponseDto
+> = z.object({
+  controls: ChatControlsMetadataResponseDto$outboundSchema,
+  controlValues: z.lazy(() => ChatStepResponseDtoControlValues$outboundSchema)
+    .optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => ChatStepResponseDtoSlug$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 ChatStepResponseDto$ {
+  /** @deprecated use `ChatStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = ChatStepResponseDto$inboundSchema;
+  /** @deprecated use `ChatStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = ChatStepResponseDto$outboundSchema;
+  /** @deprecated use `ChatStepResponseDto$Outbound` instead. */
+  export type Outbound = ChatStepResponseDto$Outbound;
+}
+
+export function chatStepResponseDtoToJSON(
+  chatStepResponseDto: ChatStepResponseDto,
+): string {
+  return JSON.stringify(
+    ChatStepResponseDto$outboundSchema.parse(chatStepResponseDto),
+  );
+}
+
+export function chatStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatStepResponseDto' from JSON`,
+  );
+}