@novu/api 2.6.5 → 2.6.6

package/src/models/components/createsubscriberrequestdto.ts

@@ -6,112 +6,46 @@ 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 {
-  SubscriberChannelDto,
-  SubscriberChannelDto$inboundSchema,
-  SubscriberChannelDto$Outbound,
-  SubscriberChannelDto$outboundSchema,
-} from "./subscriberchanneldto.js";
-
-export type CreateSubscriberRequestDtoData =
-  | string
-  | Array<string>
-  | boolean
-  | number;
 
 export type CreateSubscriberRequestDto = {
   /**
-   * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
+   * Unique identifier of the subscriber
    */
   subscriberId: string;
   /**
-   * The email address of the subscriber.
+   * First name of the subscriber
    */
-  email?: string | undefined;
+  firstName?: string | null | undefined;
   /**
-   * The first name of the subscriber.
+   * Last name of the subscriber
    */
-  firstName?: string | undefined;
+  lastName?: string | null | undefined;
   /**
-   * The last name of the subscriber.
+   * Email address of the subscriber
    */
-  lastName?: string | undefined;
+  email?: string | null | undefined;
   /**
-   * The phone number of the subscriber.
+   * Phone number of the subscriber
    */
-  phone?: string | undefined;
+  phone?: string | null | undefined;
   /**
-   * An HTTP URL to the profile image of your subscriber.
+   * Avatar URL or identifier
    */
-  avatar?: string | undefined;
+  avatar?: string | null | undefined;
   /**
-   * The locale of the subscriber.
+   * Timezone of the subscriber
    */
-  locale?: string | undefined;
+  timezone?: string | null | undefined;
   /**
-   * An optional payload object that can contain any properties.
+   * Locale of the subscriber
    */
-  data?: { [k: string]: string | Array<string> | boolean | number } | undefined;
+  locale?: string | null | undefined;
   /**
-   * An optional array of subscriber channels.
+   * Additional custom data for the subscriber
    */
-  channels?: Array<SubscriberChannelDto> | undefined;
+  data?: { [k: string]: any } | null | undefined;
 };
 
-/** @internal */
-export const CreateSubscriberRequestDtoData$inboundSchema: z.ZodType<
-  CreateSubscriberRequestDtoData,
-  z.ZodTypeDef,
-  unknown
-> = z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]);
-
-/** @internal */
-export type CreateSubscriberRequestDtoData$Outbound =
-  | string
-  | Array<string>
-  | boolean
-  | number;
-
-/** @internal */
-export const CreateSubscriberRequestDtoData$outboundSchema: z.ZodType<
-  CreateSubscriberRequestDtoData$Outbound,
-  z.ZodTypeDef,
-  CreateSubscriberRequestDtoData
-> = z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]);
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateSubscriberRequestDtoData$ {
-  /** @deprecated use `CreateSubscriberRequestDtoData$inboundSchema` instead. */
-  export const inboundSchema = CreateSubscriberRequestDtoData$inboundSchema;
-  /** @deprecated use `CreateSubscriberRequestDtoData$outboundSchema` instead. */
-  export const outboundSchema = CreateSubscriberRequestDtoData$outboundSchema;
-  /** @deprecated use `CreateSubscriberRequestDtoData$Outbound` instead. */
-  export type Outbound = CreateSubscriberRequestDtoData$Outbound;
-}
-
-export function createSubscriberRequestDtoDataToJSON(
-  createSubscriberRequestDtoData: CreateSubscriberRequestDtoData,
-): string {
-  return JSON.stringify(
-    CreateSubscriberRequestDtoData$outboundSchema.parse(
-      createSubscriberRequestDtoData,
-    ),
-  );
-}
-
-export function createSubscriberRequestDtoDataFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateSubscriberRequestDtoData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateSubscriberRequestDtoData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateSubscriberRequestDtoData' from JSON`,
-  );
-}
-
 /** @internal */
 export const CreateSubscriberRequestDto$inboundSchema: z.ZodType<
   CreateSubscriberRequestDto,
@@ -119,29 +53,27 @@ export const CreateSubscriberRequestDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   subscriberId: z.string(),
-  email: z.string().optional(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  phone: z.string().optional(),
-  avatar: z.string().optional(),
-  locale: z.string().optional(),
-  data: z.record(
-    z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
-  ).optional(),
-  channels: z.array(SubscriberChannelDto$inboundSchema).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(),
+  timezone: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  data: z.nullable(z.record(z.any())).optional(),
 });
 
 /** @internal */
 export type CreateSubscriberRequestDto$Outbound = {
   subscriberId: string;
-  email?: string | undefined;
-  firstName?: string | undefined;
-  lastName?: string | undefined;
-  phone?: string | undefined;
-  avatar?: string | undefined;
-  locale?: string | undefined;
-  data?: { [k: string]: string | Array<string> | boolean | number } | undefined;
-  channels?: Array<SubscriberChannelDto$Outbound> | undefined;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email?: string | null | undefined;
+  phone?: string | null | undefined;
+  avatar?: string | null | undefined;
+  timezone?: string | null | undefined;
+  locale?: string | null | undefined;
+  data?: { [k: string]: any } | null | undefined;
 };
 
 /** @internal */
@@ -151,16 +83,14 @@ export const CreateSubscriberRequestDto$outboundSchema: z.ZodType<
   CreateSubscriberRequestDto
 > = z.object({
   subscriberId: z.string(),
-  email: z.string().optional(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  phone: z.string().optional(),
-  avatar: z.string().optional(),
-  locale: z.string().optional(),
-  data: z.record(
-    z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
-  ).optional(),
-  channels: z.array(SubscriberChannelDto$outboundSchema).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(),
+  timezone: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  data: z.nullable(z.record(z.any())).optional(),
 });
 
 /**

package/src/models/components/index.ts

@@ -114,5 +114,6 @@ export * from "./updateintegrationrequestdto.js";
 export * from "./updatesubscriberchannelrequestdto.js";
 export * from "./updatesubscriberonlineflagrequestdto.js";
 export * from "./workflowinfodto.js";
+export * from "./workfloworiginenum.js";
 export * from "./workflowpreferencedto.js";
 export * from "./workflowresponse.js";

package/src/models/components/patchsubscriberrequestdto.ts

@@ -13,10 +13,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type PatchSubscriberRequestDtoData = {};
 
 export type PatchSubscriberRequestDto = {
-  /**
-   * Unique identifier of the subscriber
-   */
-  subscriberId?: string | null | undefined;
   /**
    * First name of the subscriber
    */
@@ -107,7 +103,6 @@ export const PatchSubscriberRequestDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  subscriberId: z.nullable(z.string()).optional(),
   firstName: z.nullable(z.string()).optional(),
   lastName: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),
@@ -121,7 +116,6 @@ export const PatchSubscriberRequestDto$inboundSchema: z.ZodType<
 
 /** @internal */
 export type PatchSubscriberRequestDto$Outbound = {
-  subscriberId?: string | null | undefined;
   firstName?: string | null | undefined;
   lastName?: string | null | undefined;
   email?: string | null | undefined;
@@ -138,7 +132,6 @@ export const PatchSubscriberRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PatchSubscriberRequestDto
 > = z.object({
-  subscriberId: z.nullable(z.string()).optional(),
   firstName: z.nullable(z.string()).optional(),
   lastName: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),

package/src/models/components/subscriberpayloaddto.ts

@@ -52,6 +52,10 @@ export type SubscriberPayloadDto = {
    * An optional array of subscriber channels.
    */
   channels?: Array<SubscriberChannelDto> | undefined;
+  /**
+   * The timezone of the subscriber.
+   */
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -109,6 +113,7 @@ export const SubscriberPayloadDto$inboundSchema: z.ZodType<
     z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
   ).optional(),
   channels: z.array(SubscriberChannelDto$inboundSchema).optional(),
+  timezone: z.string().optional(),
 });
 
 /** @internal */
@@ -122,6 +127,7 @@ export type SubscriberPayloadDto$Outbound = {
   locale?: string | undefined;
   data?: { [k: string]: string | Array<string> | boolean | number } | undefined;
   channels?: Array<SubscriberChannelDto$Outbound> | undefined;
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -141,6 +147,7 @@ export const SubscriberPayloadDto$outboundSchema: z.ZodType<
     z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
   ).optional(),
   channels: z.array(SubscriberChannelDto$outboundSchema).optional(),
+  timezone: z.string().optional(),
 });
 
 /**

package/src/models/components/triggereventresponsedto.ts

@@ -18,6 +18,7 @@ export const Status = {
   NoWorkflowStepsDefined: "no_workflow_steps_defined",
   Processed: "processed",
   NoTenantFound: "no_tenant_found",
+  InvalidRecipients: "invalid_recipients",
 } as const;
 /**
  * Status of the trigger

package/src/models/components/workfloworiginenum.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Origin of the workflow
+ */
+export const WorkflowOriginEnum = {
+  NovuCloud: "novu-cloud",
+  NovuCloudV1: "novu-cloud-v1",
+  External: "external",
+} as const;
+/**
+ * Origin of the workflow
+ */
+export type WorkflowOriginEnum = ClosedEnum<typeof WorkflowOriginEnum>;
+
+/** @internal */
+export const WorkflowOriginEnum$inboundSchema: z.ZodNativeEnum<
+  typeof WorkflowOriginEnum
+> = z.nativeEnum(WorkflowOriginEnum);
+
+/** @internal */
+export const WorkflowOriginEnum$outboundSchema: z.ZodNativeEnum<
+  typeof WorkflowOriginEnum
+> = WorkflowOriginEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WorkflowOriginEnum$ {
+  /** @deprecated use `WorkflowOriginEnum$inboundSchema` instead. */
+  export const inboundSchema = WorkflowOriginEnum$inboundSchema;
+  /** @deprecated use `WorkflowOriginEnum$outboundSchema` instead. */
+  export const outboundSchema = WorkflowOriginEnum$outboundSchema;
+}

package/src/models/operations/notificationscontrollerlistnotifications.ts

@@ -36,6 +36,10 @@ export type NotificationsControllerListNotificationsRequest = {
    * Page number for pagination
    */
   page?: number | undefined;
+  /**
+   * Limit for pagination
+   */
+  limit?: number | undefined;
   /**
    * Transaction ID for filtering
    */
@@ -72,6 +76,7 @@ export const NotificationsControllerListNotificationsRequest$inboundSchema:
     search: z.string().optional(),
     subscriberIds: z.array(z.string()).optional(),
     page: z.number().default(0),
+    limit: z.number().default(10),
     transactionId: z.string().optional(),
     after: z.string().optional(),
     before: z.string().optional(),
@@ -90,6 +95,7 @@ export type NotificationsControllerListNotificationsRequest$Outbound = {
   search?: string | undefined;
   subscriberIds?: Array<string> | undefined;
   page: number;
+  limit: number;
   transactionId?: string | undefined;
   after?: string | undefined;
   before?: string | undefined;
@@ -109,6 +115,7 @@ export const NotificationsControllerListNotificationsRequest$outboundSchema:
     search: z.string().optional(),
     subscriberIds: z.array(z.string()).optional(),
     page: z.number().default(0),
+    limit: z.number().default(10),
     transactionId: z.string().optional(),
     after: z.string().optional(),
     before: z.string().optional(),

package/src/react-query/notificationsList.ts

@@ -88,6 +88,7 @@ export function setNotificationsListData(
       search?: string | undefined;
       subscriberIds?: Array<string> | undefined;
       page?: number | undefined;
+      limit?: number | undefined;
       transactionId?: string | undefined;
       after?: string | undefined;
       before?: string | undefined;
@@ -111,6 +112,7 @@ export function invalidateNotificationsList(
       search?: string | undefined;
       subscriberIds?: Array<string> | undefined;
       page?: number | undefined;
+      limit?: number | undefined;
       transactionId?: string | undefined;
       after?: string | undefined;
       before?: string | undefined;
@@ -153,6 +155,7 @@ export function buildNotificationsListQuery(
       search: request.search,
       subscriberIds: request.subscriberIds,
       page: request.page,
+      limit: request.limit,
       transactionId: request.transactionId,
       after: request.after,
       before: request.before,
@@ -184,6 +187,7 @@ export function queryKeyNotificationsList(
     search?: string | undefined;
     subscriberIds?: Array<string> | undefined;
     page?: number | undefined;
+    limit?: number | undefined;
     transactionId?: string | undefined;
     after?: string | undefined;
     before?: string | undefined;