@novu/api 0.6.1 → 0.7.0

package/src/models/components/subscriberchanneldto.ts

@@ -17,7 +17,7 @@ import {
 /**
  * The ID of the chat or push provider.
  */
-export const SubscriberChannelDtoProviderId = {
+export const ProviderId = {
   Slack: "slack",
   Discord: "discord",
   Msteams: "msteams",
@@ -39,15 +39,13 @@ export const SubscriberChannelDtoProviderId = {
 /**
  * The ID of the chat or push provider.
  */
-export type SubscriberChannelDtoProviderId = ClosedEnum<
-  typeof SubscriberChannelDtoProviderId
->;
+export type ProviderId = ClosedEnum<typeof ProviderId>;
 
 export type SubscriberChannelDto = {
   /**
    * The ID of the chat or push provider.
    */
-  providerId: SubscriberChannelDtoProviderId;
+  providerId: ProviderId;
   /**
    * An optional identifier for the integration.
    */
@@ -59,24 +57,22 @@ export type SubscriberChannelDto = {
 };
 
 /** @internal */
-export const SubscriberChannelDtoProviderId$inboundSchema: z.ZodNativeEnum<
-  typeof SubscriberChannelDtoProviderId
-> = z.nativeEnum(SubscriberChannelDtoProviderId);
+export const ProviderId$inboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
+  .nativeEnum(ProviderId);
 
 /** @internal */
-export const SubscriberChannelDtoProviderId$outboundSchema: z.ZodNativeEnum<
-  typeof SubscriberChannelDtoProviderId
-> = SubscriberChannelDtoProviderId$inboundSchema;
+export const ProviderId$outboundSchema: z.ZodNativeEnum<typeof ProviderId> =
+  ProviderId$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace SubscriberChannelDtoProviderId$ {
-  /** @deprecated use `SubscriberChannelDtoProviderId$inboundSchema` instead. */
-  export const inboundSchema = SubscriberChannelDtoProviderId$inboundSchema;
-  /** @deprecated use `SubscriberChannelDtoProviderId$outboundSchema` instead. */
-  export const outboundSchema = SubscriberChannelDtoProviderId$outboundSchema;
+export namespace ProviderId$ {
+  /** @deprecated use `ProviderId$inboundSchema` instead. */
+  export const inboundSchema = ProviderId$inboundSchema;
+  /** @deprecated use `ProviderId$outboundSchema` instead. */
+  export const outboundSchema = ProviderId$outboundSchema;
 }
 
 /** @internal */
@@ -85,7 +81,7 @@ export const SubscriberChannelDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  providerId: SubscriberChannelDtoProviderId$inboundSchema,
+  providerId: ProviderId$inboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentialsDto$inboundSchema,
 });
@@ -103,7 +99,7 @@ export const SubscriberChannelDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SubscriberChannelDto
 > = z.object({
-  providerId: SubscriberChannelDtoProviderId$outboundSchema,
+  providerId: ProviderId$outboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentialsDto$outboundSchema,
 });

package/src/models/components/subscriberglobalpreferencedto.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 {
+  SubscriberPreferenceChannels,
+  SubscriberPreferenceChannels$inboundSchema,
+  SubscriberPreferenceChannels$Outbound,
+  SubscriberPreferenceChannels$outboundSchema,
+} from "./subscriberpreferencechannels.js";
+
+export type SubscriberGlobalPreferenceDto = {
+  /**
+   * Whether notifications are enabled globally
+   */
+  enabled: boolean;
+  /**
+   * Channel-specific preference settings
+   */
+  channels: SubscriberPreferenceChannels;
+};
+
+/** @internal */
+export const SubscriberGlobalPreferenceDto$inboundSchema: z.ZodType<
+  SubscriberGlobalPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$inboundSchema,
+});
+
+/** @internal */
+export type SubscriberGlobalPreferenceDto$Outbound = {
+  enabled: boolean;
+  channels: SubscriberPreferenceChannels$Outbound;
+};
+
+/** @internal */
+export const SubscriberGlobalPreferenceDto$outboundSchema: z.ZodType<
+  SubscriberGlobalPreferenceDto$Outbound,
+  z.ZodTypeDef,
+  SubscriberGlobalPreferenceDto
+> = z.object({
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberGlobalPreferenceDto$ {
+  /** @deprecated use `SubscriberGlobalPreferenceDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriberGlobalPreferenceDto$inboundSchema;
+  /** @deprecated use `SubscriberGlobalPreferenceDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriberGlobalPreferenceDto$outboundSchema;
+  /** @deprecated use `SubscriberGlobalPreferenceDto$Outbound` instead. */
+  export type Outbound = SubscriberGlobalPreferenceDto$Outbound;
+}
+
+export function subscriberGlobalPreferenceDtoToJSON(
+  subscriberGlobalPreferenceDto: SubscriberGlobalPreferenceDto,
+): string {
+  return JSON.stringify(
+    SubscriberGlobalPreferenceDto$outboundSchema.parse(
+      subscriberGlobalPreferenceDto,
+    ),
+  );
+}
+
+export function subscriberGlobalPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberGlobalPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriberGlobalPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberGlobalPreferenceDto' from JSON`,
+  );
+}

package/src/models/components/subscriberpreferencechannels.ts

@@ -0,0 +1,108 @@
+/*
+ * 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";
+
+export type SubscriberPreferenceChannels = {
+  /**
+   * Email channel preference
+   */
+  email?: boolean | undefined;
+  /**
+   * SMS channel preference
+   */
+  sms?: boolean | undefined;
+  /**
+   * In-app channel preference
+   */
+  inApp?: boolean | undefined;
+  /**
+   * Chat channel preference
+   */
+  chat?: boolean | undefined;
+  /**
+   * Push notification channel preference
+   */
+  push?: boolean | undefined;
+};
+
+/** @internal */
+export const SubscriberPreferenceChannels$inboundSchema: z.ZodType<
+  SubscriberPreferenceChannels,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.boolean().optional(),
+  sms: z.boolean().optional(),
+  in_app: z.boolean().optional(),
+  chat: z.boolean().optional(),
+  push: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "in_app": "inApp",
+  });
+});
+
+/** @internal */
+export type SubscriberPreferenceChannels$Outbound = {
+  email?: boolean | undefined;
+  sms?: boolean | undefined;
+  in_app?: boolean | undefined;
+  chat?: boolean | undefined;
+  push?: boolean | undefined;
+};
+
+/** @internal */
+export const SubscriberPreferenceChannels$outboundSchema: z.ZodType<
+  SubscriberPreferenceChannels$Outbound,
+  z.ZodTypeDef,
+  SubscriberPreferenceChannels
+> = z.object({
+  email: z.boolean().optional(),
+  sms: z.boolean().optional(),
+  inApp: z.boolean().optional(),
+  chat: z.boolean().optional(),
+  push: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    inApp: "in_app",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberPreferenceChannels$ {
+  /** @deprecated use `SubscriberPreferenceChannels$inboundSchema` instead. */
+  export const inboundSchema = SubscriberPreferenceChannels$inboundSchema;
+  /** @deprecated use `SubscriberPreferenceChannels$outboundSchema` instead. */
+  export const outboundSchema = SubscriberPreferenceChannels$outboundSchema;
+  /** @deprecated use `SubscriberPreferenceChannels$Outbound` instead. */
+  export type Outbound = SubscriberPreferenceChannels$Outbound;
+}
+
+export function subscriberPreferenceChannelsToJSON(
+  subscriberPreferenceChannels: SubscriberPreferenceChannels,
+): string {
+  return JSON.stringify(
+    SubscriberPreferenceChannels$outboundSchema.parse(
+      subscriberPreferenceChannels,
+    ),
+  );
+}
+
+export function subscriberPreferenceChannelsFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberPreferenceChannels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriberPreferenceChannels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberPreferenceChannels' from JSON`,
+  );
+}

package/src/models/components/subscriberpreferenceoverridedto.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  ChannelTypeEnum,
+  ChannelTypeEnum$inboundSchema,
+  ChannelTypeEnum$outboundSchema,
+} from "./channeltypeenum.js";
+import {
+  PreferenceOverrideSourceEnum,
+  PreferenceOverrideSourceEnum$inboundSchema,
+  PreferenceOverrideSourceEnum$outboundSchema,
+} from "./preferenceoverridesourceenum.js";
+
+export type SubscriberPreferenceOverrideDto = {
+  /**
+   * Channel type through which the message is sent
+   */
+  channel: ChannelTypeEnum;
+  /**
+   * The source of overrides
+   */
+  source: PreferenceOverrideSourceEnum;
+};
+
+/** @internal */
+export const SubscriberPreferenceOverrideDto$inboundSchema: z.ZodType<
+  SubscriberPreferenceOverrideDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channel: ChannelTypeEnum$inboundSchema,
+  source: PreferenceOverrideSourceEnum$inboundSchema,
+});
+
+/** @internal */
+export type SubscriberPreferenceOverrideDto$Outbound = {
+  channel: string;
+  source: string;
+};
+
+/** @internal */
+export const SubscriberPreferenceOverrideDto$outboundSchema: z.ZodType<
+  SubscriberPreferenceOverrideDto$Outbound,
+  z.ZodTypeDef,
+  SubscriberPreferenceOverrideDto
+> = z.object({
+  channel: ChannelTypeEnum$outboundSchema,
+  source: PreferenceOverrideSourceEnum$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberPreferenceOverrideDto$ {
+  /** @deprecated use `SubscriberPreferenceOverrideDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriberPreferenceOverrideDto$inboundSchema;
+  /** @deprecated use `SubscriberPreferenceOverrideDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriberPreferenceOverrideDto$outboundSchema;
+  /** @deprecated use `SubscriberPreferenceOverrideDto$Outbound` instead. */
+  export type Outbound = SubscriberPreferenceOverrideDto$Outbound;
+}
+
+export function subscriberPreferenceOverrideDtoToJSON(
+  subscriberPreferenceOverrideDto: SubscriberPreferenceOverrideDto,
+): string {
+  return JSON.stringify(
+    SubscriberPreferenceOverrideDto$outboundSchema.parse(
+      subscriberPreferenceOverrideDto,
+    ),
+  );
+}
+
+export function subscriberPreferenceOverrideDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberPreferenceOverrideDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriberPreferenceOverrideDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberPreferenceOverrideDto' from JSON`,
+  );
+}

package/src/models/components/subscriberpreferencesworkflowinfodto.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 SubscriberPreferencesWorkflowInfoDto = {
+  /**
+   * Workflow slug
+   */
+  slug: string;
+  /**
+   * Unique identifier of the workflow
+   */
+  identifier: string;
+  /**
+   * Display name of the workflow
+   */
+  name: string;
+  /**
+   * last updated date
+   */
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const SubscriberPreferencesWorkflowInfoDto$inboundSchema: z.ZodType<
+  SubscriberPreferencesWorkflowInfoDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  slug: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  updatedAt: z.string().optional(),
+});
+
+/** @internal */
+export type SubscriberPreferencesWorkflowInfoDto$Outbound = {
+  slug: string;
+  identifier: string;
+  name: string;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const SubscriberPreferencesWorkflowInfoDto$outboundSchema: z.ZodType<
+  SubscriberPreferencesWorkflowInfoDto$Outbound,
+  z.ZodTypeDef,
+  SubscriberPreferencesWorkflowInfoDto
+> = z.object({
+  slug: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  updatedAt: 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 SubscriberPreferencesWorkflowInfoDto$ {
+  /** @deprecated use `SubscriberPreferencesWorkflowInfoDto$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscriberPreferencesWorkflowInfoDto$inboundSchema;
+  /** @deprecated use `SubscriberPreferencesWorkflowInfoDto$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscriberPreferencesWorkflowInfoDto$outboundSchema;
+  /** @deprecated use `SubscriberPreferencesWorkflowInfoDto$Outbound` instead. */
+  export type Outbound = SubscriberPreferencesWorkflowInfoDto$Outbound;
+}
+
+export function subscriberPreferencesWorkflowInfoDtoToJSON(
+  subscriberPreferencesWorkflowInfoDto: SubscriberPreferencesWorkflowInfoDto,
+): string {
+  return JSON.stringify(
+    SubscriberPreferencesWorkflowInfoDto$outboundSchema.parse(
+      subscriberPreferencesWorkflowInfoDto,
+    ),
+  );
+}
+
+export function subscriberPreferencesWorkflowInfoDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberPreferencesWorkflowInfoDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscriberPreferencesWorkflowInfoDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberPreferencesWorkflowInfoDto' from JSON`,
+  );
+}

package/src/models/components/subscriberresponsedto.ts

@@ -30,7 +30,7 @@ export type SubscriberResponseDto = {
   /**
    * The email address of the subscriber.
    */
-  email?: string | null | undefined;
+  email?: string | undefined;
   /**
    * The phone number of the subscriber.
    */
@@ -43,10 +43,6 @@ export type SubscriberResponseDto = {
    * The locale setting of the subscriber, indicating their preferred language or region.
    */
   locale?: string | undefined;
-  /**
-   * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
-   */
-  subscriberId: string;
   /**
    * An array of channel settings associated with the subscriber.
    */
@@ -65,6 +61,22 @@ export type SubscriberResponseDto = {
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
   lastOnlineAt?: string | undefined;
+  /**
+   * The version of the subscriber document.
+   */
+  v?: number | undefined;
+  /**
+   * Additional custom data for the subscriber
+   */
+  data?: { [k: string]: any } | null | undefined;
+  /**
+   * Timezone of the subscriber
+   */
+  timezone?: string | undefined;
+  /**
+   * The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
+   */
+  subscriberId: string;
   /**
    * The unique identifier of the organization to which the subscriber belongs.
    */
@@ -85,18 +97,6 @@ export type SubscriberResponseDto = {
    * The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
    */
   updatedAt: string;
-  /**
-   * The version of the subscriber document.
-   */
-  v?: number | undefined;
-  /**
-   * Additional custom data for the subscriber
-   */
-  data?: { [k: string]: any } | null | undefined;
-  /**
-   * Timezone of the subscriber
-   */
-  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -108,29 +108,29 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   firstName: z.string().optional(),
   lastName: z.string().optional(),
-  email: z.nullable(z.string()).optional(),
+  email: z.string().optional(),
   phone: z.string().optional(),
   avatar: z.string().optional(),
   locale: z.string().optional(),
-  subscriberId: z.string(),
   channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
   isOnline: z.boolean().optional(),
   lastOnlineAt: z.string().optional(),
+  __v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
+  timezone: z.string().optional(),
+  subscriberId: z.string(),
   _organizationId: z.string(),
   _environmentId: z.string(),
   deleted: z.boolean(),
   createdAt: z.string(),
   updatedAt: z.string(),
-  __v: z.number().optional(),
-  data: z.nullable(z.record(z.any())).optional(),
-  timezone: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
+    "__v": "v",
     "_organizationId": "organizationId",
     "_environmentId": "environmentId",
-    "__v": "v",
   });
 });
 
@@ -139,23 +139,23 @@ export type SubscriberResponseDto$Outbound = {
   _id?: string | undefined;
   firstName?: string | undefined;
   lastName?: string | undefined;
-  email?: string | null | undefined;
+  email?: string | undefined;
   phone?: string | undefined;
   avatar?: string | undefined;
   locale?: string | undefined;
-  subscriberId: string;
   channels?: Array<ChannelSettingsDto$Outbound> | undefined;
   topics?: Array<string> | undefined;
   isOnline?: boolean | undefined;
   lastOnlineAt?: string | undefined;
+  __v?: number | undefined;
+  data?: { [k: string]: any } | null | undefined;
+  timezone?: string | undefined;
+  subscriberId: string;
   _organizationId: string;
   _environmentId: string;
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
-  __v?: number | undefined;
-  data?: { [k: string]: any } | null | undefined;
-  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -167,29 +167,29 @@ export const SubscriberResponseDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   firstName: z.string().optional(),
   lastName: z.string().optional(),
-  email: z.nullable(z.string()).optional(),
+  email: z.string().optional(),
   phone: z.string().optional(),
   avatar: z.string().optional(),
   locale: z.string().optional(),
-  subscriberId: z.string(),
   channels: z.array(ChannelSettingsDto$outboundSchema).optional(),
   topics: z.array(z.string()).optional(),
   isOnline: z.boolean().optional(),
   lastOnlineAt: z.string().optional(),
+  v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
+  timezone: z.string().optional(),
+  subscriberId: z.string(),
   organizationId: z.string(),
   environmentId: z.string(),
   deleted: z.boolean(),
   createdAt: z.string(),
   updatedAt: z.string(),
-  v: z.number().optional(),
-  data: z.nullable(z.record(z.any())).optional(),
-  timezone: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",
+    v: "__v",
     organizationId: "_organizationId",
     environmentId: "_environmentId",
-    v: "__v",
   });
 });