@novu/api 1.2.0 → 1.4.0

package/src/models/components/stepresponsedto.ts

@@ -0,0 +1,228 @@
+/*
+ * 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 {
+  ControlsMetadataDto,
+  ControlsMetadataDto$inboundSchema,
+  ControlsMetadataDto$Outbound,
+  ControlsMetadataDto$outboundSchema,
+} from "./controlsmetadatadto.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";
+
+/**
+ * Slug of the step
+ */
+export type StepResponseDtoSlug = {};
+
+export type StepResponseDto = {
+  /**
+   * Controls metadata for the step
+   */
+  controls: ControlsMetadataDto;
+  /**
+   * Control values for the step (alias for controls.values)
+   */
+  controlValues?: { [k: string]: any } | 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: StepResponseDtoSlug;
+  /**
+   * 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 StepResponseDtoSlug$inboundSchema: z.ZodType<
+  StepResponseDtoSlug,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type StepResponseDtoSlug$Outbound = {};
+
+/** @internal */
+export const StepResponseDtoSlug$outboundSchema: z.ZodType<
+  StepResponseDtoSlug$Outbound,
+  z.ZodTypeDef,
+  StepResponseDtoSlug
+> = 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 StepResponseDtoSlug$ {
+  /** @deprecated use `StepResponseDtoSlug$inboundSchema` instead. */
+  export const inboundSchema = StepResponseDtoSlug$inboundSchema;
+  /** @deprecated use `StepResponseDtoSlug$outboundSchema` instead. */
+  export const outboundSchema = StepResponseDtoSlug$outboundSchema;
+  /** @deprecated use `StepResponseDtoSlug$Outbound` instead. */
+  export type Outbound = StepResponseDtoSlug$Outbound;
+}
+
+export function stepResponseDtoSlugToJSON(
+  stepResponseDtoSlug: StepResponseDtoSlug,
+): string {
+  return JSON.stringify(
+    StepResponseDtoSlug$outboundSchema.parse(stepResponseDtoSlug),
+  );
+}
+
+export function stepResponseDtoSlugFromJSON(
+  jsonString: string,
+): SafeParseResult<StepResponseDtoSlug, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepResponseDtoSlug' from JSON`,
+  );
+}
+
+/** @internal */
+export const StepResponseDto$inboundSchema: z.ZodType<
+  StepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: ControlsMetadataDto$inboundSchema,
+  controlValues: z.record(z.any()).optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => StepResponseDtoSlug$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 StepResponseDto$Outbound = {
+  controls: ControlsMetadataDto$Outbound;
+  controlValues?: { [k: string]: any } | undefined;
+  variables: { [k: string]: any };
+  stepId: string;
+  _id: string;
+  name: string;
+  slug: StepResponseDtoSlug$Outbound;
+  type: string;
+  origin: string;
+  workflowId: string;
+  workflowDatabaseId: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const StepResponseDto$outboundSchema: z.ZodType<
+  StepResponseDto$Outbound,
+  z.ZodTypeDef,
+  StepResponseDto
+> = z.object({
+  controls: ControlsMetadataDto$outboundSchema,
+  controlValues: z.record(z.any()).optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  slug: z.lazy(() => StepResponseDtoSlug$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 StepResponseDto$ {
+  /** @deprecated use `StepResponseDto$inboundSchema` instead. */
+  export const inboundSchema = StepResponseDto$inboundSchema;
+  /** @deprecated use `StepResponseDto$outboundSchema` instead. */
+  export const outboundSchema = StepResponseDto$outboundSchema;
+  /** @deprecated use `StepResponseDto$Outbound` instead. */
+  export type Outbound = StepResponseDto$Outbound;
+}
+
+export function stepResponseDtoToJSON(
+  stepResponseDto: StepResponseDto,
+): string {
+  return JSON.stringify(StepResponseDto$outboundSchema.parse(stepResponseDto));
+}
+
+export function stepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<StepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepResponseDto' from JSON`,
+  );
+}

package/src/models/components/subscriberresponsedto.ts

@@ -22,27 +22,27 @@ export type SubscriberResponseDto = {
   /**
    * The first name of the subscriber.
    */
-  firstName?: string | undefined;
+  firstName?: string | null | undefined;
   /**
    * The last name of the subscriber.
    */
-  lastName?: string | undefined;
+  lastName?: string | null | undefined;
   /**
    * The email address of the subscriber.
    */
-  email?: string | undefined;
+  email?: string | null | undefined;
   /**
    * The phone number of the subscriber.
    */
-  phone?: string | undefined;
+  phone?: string | null | undefined;
   /**
    * The URL of the subscriber's avatar image.
    */
-  avatar?: string | undefined;
+  avatar?: string | null | undefined;
   /**
    * The locale setting of the subscriber, indicating their preferred language or region.
    */
-  locale?: string | undefined;
+  locale?: string | null | undefined;
   /**
    * An array of channel settings associated with the subscriber.
    */
@@ -56,11 +56,11 @@ export type SubscriberResponseDto = {
   /**
    * Indicates whether the subscriber is currently online.
    */
-  isOnline?: boolean | undefined;
+  isOnline?: boolean | null | undefined;
   /**
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
-  lastOnlineAt?: string | undefined;
+  lastOnlineAt?: string | null | undefined;
   /**
    * The version of the subscriber document.
    */
@@ -72,7 +72,7 @@ export type SubscriberResponseDto = {
   /**
    * Timezone of the subscriber
    */
-  timezone?: string | undefined;
+  timezone?: string | null | undefined;
   /**
    * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
    */
@@ -106,19 +106,19 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  email: z.string().optional(),
-  phone: z.string().optional(),
-  avatar: z.string().optional(),
-  locale: z.string().optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
   channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.boolean().optional(),
-  lastOnlineAt: z.string().optional(),
+  isOnline: z.nullable(z.boolean()).optional(),
+  lastOnlineAt: z.nullable(z.string()).optional(),
   __v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
-  timezone: z.string().optional(),
+  timezone: z.nullable(z.string()).optional(),
   subscriberId: z.string(),
   _organizationId: z.string(),
   _environmentId: z.string(),
@@ -137,19 +137,19 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
 /** @internal */
 export type SubscriberResponseDto$Outbound = {
   _id?: string | undefined;
-  firstName?: string | undefined;
-  lastName?: string | undefined;
-  email?: string | undefined;
-  phone?: string | undefined;
-  avatar?: string | undefined;
-  locale?: string | undefined;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email?: string | null | undefined;
+  phone?: string | null | undefined;
+  avatar?: string | null | undefined;
+  locale?: string | null | undefined;
   channels?: Array<ChannelSettingsDto$Outbound> | undefined;
   topics?: Array<string> | undefined;
-  isOnline?: boolean | undefined;
-  lastOnlineAt?: string | undefined;
+  isOnline?: boolean | null | undefined;
+  lastOnlineAt?: string | null | undefined;
   __v?: number | undefined;
   data?: { [k: string]: any } | null | undefined;
-  timezone?: string | undefined;
+  timezone?: string | null | undefined;
   subscriberId: string;
   _organizationId: string;
   _environmentId: string;
@@ -165,19 +165,19 @@ export const SubscriberResponseDto$outboundSchema: z.ZodType<
   SubscriberResponseDto
 > = z.object({
   id: z.string().optional(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  email: z.string().optional(),
-  phone: z.string().optional(),
-  avatar: z.string().optional(),
-  locale: z.string().optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
   channels: z.array(ChannelSettingsDto$outboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.boolean().optional(),
-  lastOnlineAt: z.string().optional(),
+  isOnline: z.nullable(z.boolean()).optional(),
+  lastOnlineAt: z.nullable(z.string()).optional(),
   v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
-  timezone: z.string().optional(),
+  timezone: z.nullable(z.string()).optional(),
   subscriberId: z.string(),
   organizationId: z.string(),
   environmentId: z.string(),

package/src/models/components/syncworkflowdto.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 SyncWorkflowDto = {
+  /**
+   * Target environment identifier to sync the workflow to
+   */
+  targetEnvironmentId: string;
+};
+
+/** @internal */
+export const SyncWorkflowDto$inboundSchema: z.ZodType<
+  SyncWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  targetEnvironmentId: z.string(),
+});
+
+/** @internal */
+export type SyncWorkflowDto$Outbound = {
+  targetEnvironmentId: string;
+};
+
+/** @internal */
+export const SyncWorkflowDto$outboundSchema: z.ZodType<
+  SyncWorkflowDto$Outbound,
+  z.ZodTypeDef,
+  SyncWorkflowDto
+> = z.object({
+  targetEnvironmentId: 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 SyncWorkflowDto$ {
+  /** @deprecated use `SyncWorkflowDto$inboundSchema` instead. */
+  export const inboundSchema = SyncWorkflowDto$inboundSchema;
+  /** @deprecated use `SyncWorkflowDto$outboundSchema` instead. */
+  export const outboundSchema = SyncWorkflowDto$outboundSchema;
+  /** @deprecated use `SyncWorkflowDto$Outbound` instead. */
+  export type Outbound = SyncWorkflowDto$Outbound;
+}
+
+export function syncWorkflowDtoToJSON(
+  syncWorkflowDto: SyncWorkflowDto,
+): string {
+  return JSON.stringify(SyncWorkflowDto$outboundSchema.parse(syncWorkflowDto));
+}
+
+export function syncWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SyncWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SyncWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SyncWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/uicomponentenum.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Component type for the UI Schema Property
+ */
+export const UiComponentEnum = {
+  EmailEditorSelect: "EMAIL_EDITOR_SELECT",
+  BlockEditor: "BLOCK_EDITOR",
+  EmailBody: "EMAIL_BODY",
+  TextFullLine: "TEXT_FULL_LINE",
+  TextInlineLabel: "TEXT_INLINE_LABEL",
+  InAppBody: "IN_APP_BODY",
+  InAppAvatar: "IN_APP_AVATAR",
+  InAppPrimarySubject: "IN_APP_PRIMARY_SUBJECT",
+  InAppButtonDropdown: "IN_APP_BUTTON_DROPDOWN",
+  InAppDisableSanitizationSwitch: "IN_APP_DISABLE_SANITIZATION_SWITCH",
+  DisableSanitizationSwitch: "DISABLE_SANITIZATION_SWITCH",
+  UrlTextBox: "URL_TEXT_BOX",
+  DigestAmount: "DIGEST_AMOUNT",
+  DigestUnit: "DIGEST_UNIT",
+  DigestKey: "DIGEST_KEY",
+  DigestCron: "DIGEST_CRON",
+  DelayType: "DELAY_TYPE",
+  DelayAmount: "DELAY_AMOUNT",
+  DelayUnit: "DELAY_UNIT",
+  SmsBody: "SMS_BODY",
+  ChatBody: "CHAT_BODY",
+  PushBody: "PUSH_BODY",
+  PushSubject: "PUSH_SUBJECT",
+  QueryEditor: "QUERY_EDITOR",
+  Data: "DATA",
+} as const;
+/**
+ * Component type for the UI Schema Property
+ */
+export type UiComponentEnum = ClosedEnum<typeof UiComponentEnum>;
+
+/** @internal */
+export const UiComponentEnum$inboundSchema: z.ZodNativeEnum<
+  typeof UiComponentEnum
+> = z.nativeEnum(UiComponentEnum);
+
+/** @internal */
+export const UiComponentEnum$outboundSchema: z.ZodNativeEnum<
+  typeof UiComponentEnum
+> = UiComponentEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UiComponentEnum$ {
+  /** @deprecated use `UiComponentEnum$inboundSchema` instead. */
+  export const inboundSchema = UiComponentEnum$inboundSchema;
+  /** @deprecated use `UiComponentEnum$outboundSchema` instead. */
+  export const outboundSchema = UiComponentEnum$outboundSchema;
+}

package/src/models/components/uischema.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 {
+  UiSchemaGroupEnum,
+  UiSchemaGroupEnum$inboundSchema,
+  UiSchemaGroupEnum$outboundSchema,
+} from "./uischemagroupenum.js";
+import {
+  UiSchemaProperty,
+  UiSchemaProperty$inboundSchema,
+  UiSchemaProperty$Outbound,
+  UiSchemaProperty$outboundSchema,
+} from "./uischemaproperty.js";
+
+export type UiSchema = {
+  /**
+   * Group of the UI Schema
+   */
+  group?: UiSchemaGroupEnum | undefined;
+  /**
+   * Properties of the UI Schema
+   */
+  properties?: { [k: string]: UiSchemaProperty } | undefined;
+};
+
+/** @internal */
+export const UiSchema$inboundSchema: z.ZodType<
+  UiSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  group: UiSchemaGroupEnum$inboundSchema.optional(),
+  properties: z.record(UiSchemaProperty$inboundSchema).optional(),
+});
+
+/** @internal */
+export type UiSchema$Outbound = {
+  group?: string | undefined;
+  properties?: { [k: string]: UiSchemaProperty$Outbound } | undefined;
+};
+
+/** @internal */
+export const UiSchema$outboundSchema: z.ZodType<
+  UiSchema$Outbound,
+  z.ZodTypeDef,
+  UiSchema
+> = z.object({
+  group: UiSchemaGroupEnum$outboundSchema.optional(),
+  properties: z.record(UiSchemaProperty$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 UiSchema$ {
+  /** @deprecated use `UiSchema$inboundSchema` instead. */
+  export const inboundSchema = UiSchema$inboundSchema;
+  /** @deprecated use `UiSchema$outboundSchema` instead. */
+  export const outboundSchema = UiSchema$outboundSchema;
+  /** @deprecated use `UiSchema$Outbound` instead. */
+  export type Outbound = UiSchema$Outbound;
+}
+
+export function uiSchemaToJSON(uiSchema: UiSchema): string {
+  return JSON.stringify(UiSchema$outboundSchema.parse(uiSchema));
+}
+
+export function uiSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<UiSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UiSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UiSchema' from JSON`,
+  );
+}

package/src/models/components/uischemagroupenum.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Group of the UI Schema
+ */
+export const UiSchemaGroupEnum = {
+  InApp: "IN_APP",
+  Email: "EMAIL",
+  Digest: "DIGEST",
+  Delay: "DELAY",
+  Sms: "SMS",
+  Chat: "CHAT",
+  Push: "PUSH",
+  Skip: "SKIP",
+} as const;
+/**
+ * Group of the UI Schema
+ */
+export type UiSchemaGroupEnum = ClosedEnum<typeof UiSchemaGroupEnum>;
+
+/** @internal */
+export const UiSchemaGroupEnum$inboundSchema: z.ZodNativeEnum<
+  typeof UiSchemaGroupEnum
+> = z.nativeEnum(UiSchemaGroupEnum);
+
+/** @internal */
+export const UiSchemaGroupEnum$outboundSchema: z.ZodNativeEnum<
+  typeof UiSchemaGroupEnum
+> = UiSchemaGroupEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UiSchemaGroupEnum$ {
+  /** @deprecated use `UiSchemaGroupEnum$inboundSchema` instead. */
+  export const inboundSchema = UiSchemaGroupEnum$inboundSchema;
+  /** @deprecated use `UiSchemaGroupEnum$outboundSchema` instead. */
+  export const outboundSchema = UiSchemaGroupEnum$outboundSchema;
+}