@novu/api 1.3.0 → 1.5.0

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,64 @@
+/*
+ * 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",
+  LayoutSelect: "LAYOUT_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",
+  LayoutEmail: "LAYOUT_EMAIL",
+} 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,46 @@
+/*
+ * 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",
+  Layout: "LAYOUT",
+} 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;
+}

package/src/models/components/uischemaproperty.ts

@@ -0,0 +1,239 @@
+/*
+ * 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 {
+  UiComponentEnum,
+  UiComponentEnum$inboundSchema,
+  UiComponentEnum$outboundSchema,
+} from "./uicomponentenum.js";
+
+export type Placeholder5 = string | number | boolean | { [k: string]: any };
+
+/**
+ * Placeholder for the UI Schema Property
+ */
+export type Placeholder =
+  | string
+  | number
+  | boolean
+  | { [k: string]: any }
+  | Array<string | number | boolean | { [k: string]: any }>;
+
+export type UiSchemaProperty = {
+  /**
+   * Placeholder for the UI Schema Property
+   */
+  placeholder?:
+    | string
+    | number
+    | boolean
+    | { [k: string]: any }
+    | Array<string | number | boolean | { [k: string]: any }>
+    | null
+    | undefined;
+  /**
+   * Component type for the UI Schema Property
+   */
+  component: UiComponentEnum;
+  /**
+   * Properties of the UI Schema
+   */
+  properties?: { [k: string]: UiSchemaProperty } | undefined;
+};
+
+/** @internal */
+export const Placeholder5$inboundSchema: z.ZodType<
+  Placeholder5,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]);
+
+/** @internal */
+export type Placeholder5$Outbound = string | number | boolean | {
+  [k: string]: any;
+};
+
+/** @internal */
+export const Placeholder5$outboundSchema: z.ZodType<
+  Placeholder5$Outbound,
+  z.ZodTypeDef,
+  Placeholder5
+> = z.union([z.string(), z.number(), z.boolean(), 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 Placeholder5$ {
+  /** @deprecated use `Placeholder5$inboundSchema` instead. */
+  export const inboundSchema = Placeholder5$inboundSchema;
+  /** @deprecated use `Placeholder5$outboundSchema` instead. */
+  export const outboundSchema = Placeholder5$outboundSchema;
+  /** @deprecated use `Placeholder5$Outbound` instead. */
+  export type Outbound = Placeholder5$Outbound;
+}
+
+export function placeholder5ToJSON(placeholder5: Placeholder5): string {
+  return JSON.stringify(Placeholder5$outboundSchema.parse(placeholder5));
+}
+
+export function placeholder5FromJSON(
+  jsonString: string,
+): SafeParseResult<Placeholder5, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Placeholder5$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Placeholder5' from JSON`,
+  );
+}
+
+/** @internal */
+export const Placeholder$inboundSchema: z.ZodType<
+  Placeholder,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.record(z.any()),
+  z.array(z.union([z.string(), z.number(), z.boolean(), z.record(z.any())])),
+]);
+
+/** @internal */
+export type Placeholder$Outbound = string | number | boolean | {
+  [k: string]: any;
+} | Array<string | number | boolean | { [k: string]: any }>;
+
+/** @internal */
+export const Placeholder$outboundSchema: z.ZodType<
+  Placeholder$Outbound,
+  z.ZodTypeDef,
+  Placeholder
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.record(z.any()),
+  z.array(z.union([z.string(), z.number(), z.boolean(), 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 Placeholder$ {
+  /** @deprecated use `Placeholder$inboundSchema` instead. */
+  export const inboundSchema = Placeholder$inboundSchema;
+  /** @deprecated use `Placeholder$outboundSchema` instead. */
+  export const outboundSchema = Placeholder$outboundSchema;
+  /** @deprecated use `Placeholder$Outbound` instead. */
+  export type Outbound = Placeholder$Outbound;
+}
+
+export function placeholderToJSON(placeholder: Placeholder): string {
+  return JSON.stringify(Placeholder$outboundSchema.parse(placeholder));
+}
+
+export function placeholderFromJSON(
+  jsonString: string,
+): SafeParseResult<Placeholder, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Placeholder$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Placeholder' from JSON`,
+  );
+}
+
+/** @internal */
+export const UiSchemaProperty$inboundSchema: z.ZodType<
+  UiSchemaProperty,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  placeholder: z.nullable(
+    z.union([
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.record(z.any()),
+      z.array(
+        z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+      ),
+    ]),
+  ).optional(),
+  component: UiComponentEnum$inboundSchema,
+  properties: z.record(z.lazy(() => UiSchemaProperty$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type UiSchemaProperty$Outbound = {
+  placeholder?:
+    | string
+    | number
+    | boolean
+    | { [k: string]: any }
+    | Array<string | number | boolean | { [k: string]: any }>
+    | null
+    | undefined;
+  component: string;
+  properties?: { [k: string]: UiSchemaProperty$Outbound } | undefined;
+};
+
+/** @internal */
+export const UiSchemaProperty$outboundSchema: z.ZodType<
+  UiSchemaProperty$Outbound,
+  z.ZodTypeDef,
+  UiSchemaProperty
+> = z.object({
+  placeholder: z.nullable(
+    z.union([
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.record(z.any()),
+      z.array(
+        z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+      ),
+    ]),
+  ).optional(),
+  component: UiComponentEnum$outboundSchema,
+  properties: z.record(z.lazy(() => 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 UiSchemaProperty$ {
+  /** @deprecated use `UiSchemaProperty$inboundSchema` instead. */
+  export const inboundSchema = UiSchemaProperty$inboundSchema;
+  /** @deprecated use `UiSchemaProperty$outboundSchema` instead. */
+  export const outboundSchema = UiSchemaProperty$outboundSchema;
+  /** @deprecated use `UiSchemaProperty$Outbound` instead. */
+  export type Outbound = UiSchemaProperty$Outbound;
+}
+
+export function uiSchemaPropertyToJSON(
+  uiSchemaProperty: UiSchemaProperty,
+): string {
+  return JSON.stringify(
+    UiSchemaProperty$outboundSchema.parse(uiSchemaProperty),
+  );
+}
+
+export function uiSchemaPropertyFromJSON(
+  jsonString: string,
+): SafeParseResult<UiSchemaProperty, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UiSchemaProperty$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UiSchemaProperty' from JSON`,
+  );
+}