@novu/api 0.6.2 → 1.0.0

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",
   });
 });
 

package/src/models/components/subscriberworkflowpreferencedto.ts

@@ -0,0 +1,110 @@
+/*
+ * 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";
+import {
+  SubscriberPreferenceOverrideDto,
+  SubscriberPreferenceOverrideDto$inboundSchema,
+  SubscriberPreferenceOverrideDto$Outbound,
+  SubscriberPreferenceOverrideDto$outboundSchema,
+} from "./subscriberpreferenceoverridedto.js";
+import {
+  SubscriberPreferencesWorkflowInfoDto,
+  SubscriberPreferencesWorkflowInfoDto$inboundSchema,
+  SubscriberPreferencesWorkflowInfoDto$Outbound,
+  SubscriberPreferencesWorkflowInfoDto$outboundSchema,
+} from "./subscriberpreferencesworkflowinfodto.js";
+
+export type SubscriberWorkflowPreferenceDto = {
+  /**
+   * Whether notifications are enabled for this workflow
+   */
+  enabled: boolean;
+  /**
+   * Channel-specific preference settings for this workflow
+   */
+  channels: SubscriberPreferenceChannels;
+  /**
+   * List of preference overrides
+   */
+  overrides: Array<SubscriberPreferenceOverrideDto>;
+  /**
+   * Workflow information
+   */
+  workflow: SubscriberPreferencesWorkflowInfoDto;
+};
+
+/** @internal */
+export const SubscriberWorkflowPreferenceDto$inboundSchema: z.ZodType<
+  SubscriberWorkflowPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$inboundSchema,
+  overrides: z.array(SubscriberPreferenceOverrideDto$inboundSchema),
+  workflow: SubscriberPreferencesWorkflowInfoDto$inboundSchema,
+});
+
+/** @internal */
+export type SubscriberWorkflowPreferenceDto$Outbound = {
+  enabled: boolean;
+  channels: SubscriberPreferenceChannels$Outbound;
+  overrides: Array<SubscriberPreferenceOverrideDto$Outbound>;
+  workflow: SubscriberPreferencesWorkflowInfoDto$Outbound;
+};
+
+/** @internal */
+export const SubscriberWorkflowPreferenceDto$outboundSchema: z.ZodType<
+  SubscriberWorkflowPreferenceDto$Outbound,
+  z.ZodTypeDef,
+  SubscriberWorkflowPreferenceDto
+> = z.object({
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$outboundSchema,
+  overrides: z.array(SubscriberPreferenceOverrideDto$outboundSchema),
+  workflow: SubscriberPreferencesWorkflowInfoDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberWorkflowPreferenceDto$ {
+  /** @deprecated use `SubscriberWorkflowPreferenceDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriberWorkflowPreferenceDto$inboundSchema;
+  /** @deprecated use `SubscriberWorkflowPreferenceDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriberWorkflowPreferenceDto$outboundSchema;
+  /** @deprecated use `SubscriberWorkflowPreferenceDto$Outbound` instead. */
+  export type Outbound = SubscriberWorkflowPreferenceDto$Outbound;
+}
+
+export function subscriberWorkflowPreferenceDtoToJSON(
+  subscriberWorkflowPreferenceDto: SubscriberWorkflowPreferenceDto,
+): string {
+  return JSON.stringify(
+    SubscriberWorkflowPreferenceDto$outboundSchema.parse(
+      subscriberWorkflowPreferenceDto,
+    ),
+  );
+}
+
+export function subscriberWorkflowPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberWorkflowPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriberWorkflowPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberWorkflowPreferenceDto' from JSON`,
+  );
+}

package/src/models/components/subscriptiondto.ts

@@ -0,0 +1,213 @@
+/*
+ * 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 {
+  TopicDto,
+  TopicDto$inboundSchema,
+  TopicDto$Outbound,
+  TopicDto$outboundSchema,
+} from "./topicdto.js";
+
+/**
+ * The subscriber information
+ */
+export type Subscriber = {
+  /**
+   * The identifier of the subscriber
+   */
+  id: string;
+  /**
+   * The external identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The avatar URL of the subscriber
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The first name of the subscriber
+   */
+  firstName?: string | null | undefined;
+  /**
+   * The last name of the subscriber
+   */
+  lastName?: string | null | undefined;
+  /**
+   * The email of the subscriber
+   */
+  email?: string | null | undefined;
+};
+
+export type SubscriptionDto = {
+  /**
+   * The unique identifier of the subscription
+   */
+  id: string;
+  /**
+   * The topic information
+   */
+  topic: TopicDto;
+  /**
+   * The subscriber information
+   */
+  subscriber: Subscriber | null;
+  /**
+   * The creation date of the subscription
+   */
+  createdAt: string;
+  /**
+   * The last update date of the subscription
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const Subscriber$inboundSchema: z.ZodType<
+  Subscriber,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  subscriberId: z.string(),
+  avatar: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type Subscriber$Outbound = {
+  _id: string;
+  subscriberId: string;
+  avatar?: string | null | undefined;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email?: string | null | undefined;
+};
+
+/** @internal */
+export const Subscriber$outboundSchema: z.ZodType<
+  Subscriber$Outbound,
+  z.ZodTypeDef,
+  Subscriber
+> = z.object({
+  id: z.string(),
+  subscriberId: z.string(),
+  avatar: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).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 Subscriber$ {
+  /** @deprecated use `Subscriber$inboundSchema` instead. */
+  export const inboundSchema = Subscriber$inboundSchema;
+  /** @deprecated use `Subscriber$outboundSchema` instead. */
+  export const outboundSchema = Subscriber$outboundSchema;
+  /** @deprecated use `Subscriber$Outbound` instead. */
+  export type Outbound = Subscriber$Outbound;
+}
+
+export function subscriberToJSON(subscriber: Subscriber): string {
+  return JSON.stringify(Subscriber$outboundSchema.parse(subscriber));
+}
+
+export function subscriberFromJSON(
+  jsonString: string,
+): SafeParseResult<Subscriber, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Subscriber$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Subscriber' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscriptionDto$inboundSchema: z.ZodType<
+  SubscriptionDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  topic: TopicDto$inboundSchema,
+  subscriber: z.nullable(z.lazy(() => Subscriber$inboundSchema)),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type SubscriptionDto$Outbound = {
+  _id: string;
+  topic: TopicDto$Outbound;
+  subscriber: Subscriber$Outbound | null;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** @internal */
+export const SubscriptionDto$outboundSchema: z.ZodType<
+  SubscriptionDto$Outbound,
+  z.ZodTypeDef,
+  SubscriptionDto
+> = z.object({
+  id: z.string(),
+  topic: TopicDto$outboundSchema,
+  subscriber: z.nullable(z.lazy(() => Subscriber$outboundSchema)),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+}).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 SubscriptionDto$ {
+  /** @deprecated use `SubscriptionDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionDto$inboundSchema;
+  /** @deprecated use `SubscriptionDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionDto$outboundSchema;
+  /** @deprecated use `SubscriptionDto$Outbound` instead. */
+  export type Outbound = SubscriptionDto$Outbound;
+}
+
+export function subscriptionDtoToJSON(
+  subscriptionDto: SubscriptionDto,
+): string {
+  return JSON.stringify(SubscriptionDto$outboundSchema.parse(subscriptionDto));
+}
+
+export function subscriptionDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionDto' from JSON`,
+  );
+}

package/src/models/components/subscriptionerrordto.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";
+
+export type SubscriptionErrorDto = {
+  /**
+   * The subscriber ID that failed
+   */
+  subscriberId: string;
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * The error message
+   */
+  message: string;
+};
+
+/** @internal */
+export const SubscriptionErrorDto$inboundSchema: z.ZodType<
+  SubscriptionErrorDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscriberId: z.string(),
+  code: z.string(),
+  message: z.string(),
+});
+
+/** @internal */
+export type SubscriptionErrorDto$Outbound = {
+  subscriberId: string;
+  code: string;
+  message: string;
+};
+
+/** @internal */
+export const SubscriptionErrorDto$outboundSchema: z.ZodType<
+  SubscriptionErrorDto$Outbound,
+  z.ZodTypeDef,
+  SubscriptionErrorDto
+> = z.object({
+  subscriberId: z.string(),
+  code: z.string(),
+  message: 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 SubscriptionErrorDto$ {
+  /** @deprecated use `SubscriptionErrorDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionErrorDto$inboundSchema;
+  /** @deprecated use `SubscriptionErrorDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionErrorDto$outboundSchema;
+  /** @deprecated use `SubscriptionErrorDto$Outbound` instead. */
+  export type Outbound = SubscriptionErrorDto$Outbound;
+}
+
+export function subscriptionErrorDtoToJSON(
+  subscriptionErrorDto: SubscriptionErrorDto,
+): string {
+  return JSON.stringify(
+    SubscriptionErrorDto$outboundSchema.parse(subscriptionErrorDto),
+  );
+}
+
+export function subscriptionErrorDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionErrorDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionErrorDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionErrorDto' from JSON`,
+  );
+}