@novu/api 3.11.0 → 3.11.2

package/src/models/components/smsstepresponsedto.ts

@@ -19,7 +19,6 @@ import {
   SmsControlsMetadataResponseDto$inboundSchema,
 } from "./smscontrolsmetadataresponsedto.js";
 import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 
 /**
  * Control values for the SMS step
@@ -68,7 +67,7 @@ export type SmsStepResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "sms";
   /**
    * Origin of the layout
    */
@@ -125,7 +124,7 @@ export const SmsStepResponseDto$inboundSchema: z.ZodType<
   _id: z.string(),
   name: z.string(),
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.literal("sms"),
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),

package/src/models/components/smsstepupsertdto.ts

@@ -9,7 +9,6 @@ import {
   SmsControlDto$Outbound,
   SmsControlDto$outboundSchema,
 } from "./smscontroldto.js";
-import { StepTypeEnum, StepTypeEnum$outboundSchema } from "./steptypeenum.js";
 
 /**
  * Control values for the SMS step.
@@ -34,7 +33,7 @@ export type SmsStepUpsertDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "sms";
   /**
    * Control values for the SMS step.
    */
@@ -68,7 +67,7 @@ export type SmsStepUpsertDto$Outbound = {
   _id?: string | undefined;
   stepId?: string | undefined;
   name: string;
-  type: string;
+  type: "sms";
   controlValues?: SmsControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
@@ -81,7 +80,7 @@ export const SmsStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   stepId: z.string().optional(),
   name: z.string(),
-  type: StepTypeEnum$outboundSchema,
+  type: z.literal("sms"),
   controlValues: z.union([SmsControlDto$outboundSchema, z.record(z.any())])
     .optional(),
 }).transform((v) => {

package/src/models/components/steplistresponsedto.ts

@@ -7,7 +7,6 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 
 export type StepListResponseDto = {
   /**
@@ -17,7 +16,7 @@ export type StepListResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: string;
   /**
    * Issues associated with the step
    */
@@ -31,7 +30,7 @@ export const StepListResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
 });
 

package/src/models/components/stepresponsedto.ts

@@ -16,7 +16,6 @@ import {
   ResourceOriginEnum$inboundSchema,
 } from "./resourceoriginenum.js";
 import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 
 export type StepResponseDto = {
   /**
@@ -50,7 +49,7 @@ export type StepResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: string;
   /**
    * Origin of the layout
    */
@@ -82,7 +81,7 @@ export const StepResponseDto$inboundSchema: z.ZodType<
   _id: z.string(),
   name: z.string(),
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.string(),
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),

package/src/models/components/subscriberchanneldto.ts

@@ -13,7 +13,7 @@ import {
 /**
  * The ID of the chat or push provider.
  */
-export const ProviderId = {
+export const SubscriberChannelDtoProviderId = {
   Slack: "slack",
   Discord: "discord",
   Msteams: "msteams",
@@ -38,13 +38,15 @@ export const ProviderId = {
 /**
  * The ID of the chat or push provider.
  */
-export type ProviderId = ClosedEnum<typeof ProviderId>;
+export type SubscriberChannelDtoProviderId = ClosedEnum<
+  typeof SubscriberChannelDtoProviderId
+>;
 
 export type SubscriberChannelDto = {
   /**
    * The ID of the chat or push provider.
    */
-  providerId: ProviderId;
+  providerId: SubscriberChannelDtoProviderId;
   /**
    * An optional identifier for the integration.
    */
@@ -56,8 +58,9 @@ export type SubscriberChannelDto = {
 };
 
 /** @internal */
-export const ProviderId$outboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
-  .nativeEnum(ProviderId);
+export const SubscriberChannelDtoProviderId$outboundSchema: z.ZodNativeEnum<
+  typeof SubscriberChannelDtoProviderId
+> = z.nativeEnum(SubscriberChannelDtoProviderId);
 
 /** @internal */
 export type SubscriberChannelDto$Outbound = {
@@ -72,7 +75,7 @@ export const SubscriberChannelDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SubscriberChannelDto
 > = z.object({
-  providerId: ProviderId$outboundSchema,
+  providerId: SubscriberChannelDtoProviderId$outboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentialsDto$outboundSchema,
 });

package/src/models/components/subscriptiondto.ts

@@ -12,7 +12,7 @@ import { TopicDto, TopicDto$inboundSchema } from "./topicdto.js";
 /**
  * The subscriber information
  */
-export type Subscriber = {
+export type SubscriptionDtoSubscriber = {
   /**
    * The identifier of the subscriber
    */
@@ -44,6 +44,10 @@ export type SubscriptionDto = {
    * The unique identifier of the subscription
    */
   id: string;
+  /**
+   * The identifier of the subscription
+   */
+  identifier?: string | undefined;
   /**
    * The topic information
    */
@@ -51,7 +55,7 @@ export type SubscriptionDto = {
   /**
    * The subscriber information
    */
-  subscriber: Subscriber | null;
+  subscriber: SubscriptionDtoSubscriber | null;
   /**
    * The creation date of the subscription
    */
@@ -63,8 +67,8 @@ export type SubscriptionDto = {
 };
 
 /** @internal */
-export const Subscriber$inboundSchema: z.ZodType<
-  Subscriber,
+export const SubscriptionDtoSubscriber$inboundSchema: z.ZodType<
+  SubscriptionDtoSubscriber,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -80,13 +84,13 @@ export const Subscriber$inboundSchema: z.ZodType<
   });
 });
 
-export function subscriberFromJSON(
+export function subscriptionDtoSubscriberFromJSON(
   jsonString: string,
-): SafeParseResult<Subscriber, SDKValidationError> {
+): SafeParseResult<SubscriptionDtoSubscriber, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Subscriber$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Subscriber' from JSON`,
+    (x) => SubscriptionDtoSubscriber$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionDtoSubscriber' from JSON`,
   );
 }
 
@@ -97,8 +101,9 @@ export const SubscriptionDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string(),
+  identifier: z.string().optional(),
   topic: TopicDto$inboundSchema,
-  subscriber: z.nullable(z.lazy(() => Subscriber$inboundSchema)),
+  subscriber: z.nullable(z.lazy(() => SubscriptionDtoSubscriber$inboundSchema)),
   createdAt: z.string(),
   updatedAt: z.string(),
 }).transform((v) => {

package/src/models/components/subscriptionpreferencedto.ts

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SeverityLevelEnum,
+  SeverityLevelEnum$inboundSchema,
+} from "./severitylevelenum.js";
+
+/**
+ * Custom data associated with the workflow
+ */
+export type SubscriptionPreferenceDtoData = {};
+
+/**
+ * Workflow information if this is a template-level preference
+ */
+export type SubscriptionPreferenceDtoWorkflow = {
+  /**
+   * Unique identifier of the workflow
+   */
+  id: string;
+  /**
+   * Workflow identifier used for triggering
+   */
+  identifier: string;
+  /**
+   * Human-readable name of the workflow
+   */
+  name: string;
+  /**
+   * Whether this workflow is marked as critical
+   */
+  critical: boolean;
+  /**
+   * Tags associated with the workflow
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Custom data associated with the workflow
+   */
+  data?: SubscriptionPreferenceDtoData | undefined;
+  /**
+   * Severity of the workflow
+   */
+  severity: SeverityLevelEnum;
+};
+
+export type SubscriptionPreferenceDto = {
+  /**
+   * The unique identifier of the subscription
+   */
+  subscriptionId: string;
+  /**
+   * Workflow information if this is a template-level preference
+   */
+  workflow?: SubscriptionPreferenceDtoWorkflow | null | undefined;
+  /**
+   * Whether the preference is enabled
+   */
+  enabled: boolean;
+  /**
+   * Optional condition using JSON Logic rules
+   */
+  condition?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const SubscriptionPreferenceDtoData$inboundSchema: z.ZodType<
+  SubscriptionPreferenceDtoData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function subscriptionPreferenceDtoDataFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionPreferenceDtoData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionPreferenceDtoData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionPreferenceDtoData' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscriptionPreferenceDtoWorkflow$inboundSchema: z.ZodType<
+  SubscriptionPreferenceDtoWorkflow,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  critical: z.boolean(),
+  tags: z.array(z.string()).optional(),
+  data: z.lazy(() => SubscriptionPreferenceDtoData$inboundSchema).optional(),
+  severity: SeverityLevelEnum$inboundSchema,
+});
+
+export function subscriptionPreferenceDtoWorkflowFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionPreferenceDtoWorkflow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionPreferenceDtoWorkflow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionPreferenceDtoWorkflow' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscriptionPreferenceDto$inboundSchema: z.ZodType<
+  SubscriptionPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscriptionId: z.string(),
+  workflow: z.nullable(
+    z.lazy(() => SubscriptionPreferenceDtoWorkflow$inboundSchema),
+  ).optional(),
+  enabled: z.boolean(),
+  condition: z.record(z.any()).optional(),
+});
+
+export function subscriptionPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionPreferenceDto' from JSON`,
+  );
+}

package/src/models/components/subscriptionresponsedto.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  SubscriptionPreferenceDto,
+  SubscriptionPreferenceDto$inboundSchema,
+} from "./subscriptionpreferencedto.js";
+import { TopicDto, TopicDto$inboundSchema } 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 SubscriptionResponseDto = {
+  /**
+   * The unique identifier of the subscription
+   */
+  id: string;
+  /**
+   * The identifier of the subscription
+   */
+  identifier?: string | undefined;
+  /**
+   * The name of the subscription
+   */
+  name?: string | undefined;
+  /**
+   * The topic information
+   */
+  topic: TopicDto;
+  /**
+   * The subscriber information
+   */
+  subscriber: Subscriber | null;
+  /**
+   * The preferences for workflows in this subscription
+   */
+  preferences?: Array<SubscriptionPreferenceDto> | undefined;
+  /**
+   * 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",
+  });
+});
+
+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 SubscriptionResponseDto$inboundSchema: z.ZodType<
+  SubscriptionResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  identifier: z.string().optional(),
+  name: z.string().optional(),
+  topic: TopicDto$inboundSchema,
+  subscriber: z.nullable(z.lazy(() => Subscriber$inboundSchema)),
+  preferences: z.array(SubscriptionPreferenceDto$inboundSchema).optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function subscriptionResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionResponseDto' from JSON`,
+  );
+}

package/src/models/components/tenantpayloaddto.ts

@@ -4,37 +4,30 @@
 
 import * as z from "zod/v3";
 
-export type TenantPayloadDtoData = {};
+export type Data = {};
 
 export type TenantPayloadDto = {
   identifier?: string | undefined;
   name?: string | undefined;
-  data?: TenantPayloadDtoData | undefined;
+  data?: Data | undefined;
 };
 
 /** @internal */
-export type TenantPayloadDtoData$Outbound = {};
+export type Data$Outbound = {};
 
 /** @internal */
-export const TenantPayloadDtoData$outboundSchema: z.ZodType<
-  TenantPayloadDtoData$Outbound,
-  z.ZodTypeDef,
-  TenantPayloadDtoData
-> = z.object({});
+export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
+  z.object({});
 
-export function tenantPayloadDtoDataToJSON(
-  tenantPayloadDtoData: TenantPayloadDtoData,
-): string {
-  return JSON.stringify(
-    TenantPayloadDtoData$outboundSchema.parse(tenantPayloadDtoData),
-  );
+export function dataToJSON(data: Data): string {
+  return JSON.stringify(Data$outboundSchema.parse(data));
 }
 
 /** @internal */
 export type TenantPayloadDto$Outbound = {
   identifier?: string | undefined;
   name?: string | undefined;
-  data?: TenantPayloadDtoData$Outbound | undefined;
+  data?: Data$Outbound | undefined;
 };
 
 /** @internal */
@@ -45,7 +38,7 @@ export const TenantPayloadDto$outboundSchema: z.ZodType<
 > = z.object({
   identifier: z.string().optional(),
   name: z.string().optional(),
-  data: z.lazy(() => TenantPayloadDtoData$outboundSchema).optional(),
+  data: z.lazy(() => Data$outboundSchema).optional(),
 });
 
 export function tenantPayloadDtoToJSON(

package/src/models/components/throttlestepresponsedto.ts

@@ -16,7 +16,6 @@ import {
   ResourceOriginEnum$inboundSchema,
 } from "./resourceoriginenum.js";
 import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 import {
   ThrottleControlsMetadataResponseDto,
   ThrottleControlsMetadataResponseDto$inboundSchema,
@@ -62,7 +61,7 @@ export type ThrottleStepResponseDtoControlValues = {
   /**
    * The type of throttle window.
    */
-  type?: ThrottleStepResponseDtoType | undefined;
+  type: ThrottleStepResponseDtoType;
   /**
    * The amount of time for the throttle window (required for fixed type).
    */
@@ -78,7 +77,7 @@ export type ThrottleStepResponseDtoControlValues = {
   /**
    * The maximum number of executions allowed within the window. Defaults to 1.
    */
-  threshold?: number | undefined;
+  threshold: number;
   /**
    * Optional key for grouping throttle rules. If not provided, defaults to workflow and subscriber combination.
    */
@@ -118,7 +117,7 @@ export type ThrottleStepResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "throttle";
   /**
    * Origin of the layout
    */
@@ -192,7 +191,7 @@ export const ThrottleStepResponseDto$inboundSchema: z.ZodType<
   _id: z.string(),
   name: z.string(),
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.literal("throttle"),
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),

package/src/models/components/throttlestepupsertdto.ts

@@ -4,7 +4,6 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { StepTypeEnum, StepTypeEnum$outboundSchema } from "./steptypeenum.js";
 import {
   ThrottleControlDto,
   ThrottleControlDto$Outbound,
@@ -34,7 +33,7 @@ export type ThrottleStepUpsertDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "throttle";
   /**
    * Control values for the Throttle step.
    */
@@ -68,7 +67,7 @@ export type ThrottleStepUpsertDto$Outbound = {
   _id?: string | undefined;
   stepId?: string | undefined;
   name: string;
-  type: string;
+  type: "throttle";
   controlValues?:
     | ThrottleControlDto$Outbound
     | { [k: string]: any }
@@ -84,7 +83,7 @@ export const ThrottleStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   stepId: z.string().optional(),
   name: z.string(),
-  type: StepTypeEnum$outboundSchema,
+  type: z.literal("throttle"),
   controlValues: z.union([ThrottleControlDto$outboundSchema, z.record(z.any())])
     .optional(),
 }).transform((v) => {

package/src/models/components/topicsubscriberidentifierdto.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type TopicSubscriberIdentifierDto = {
+  /**
+   * Unique identifier for this subscription
+   */
+  identifier: string;
+  /**
+   * The subscriber ID
+   */
+  subscriberId: string;
+  /**
+   * The name of the subscription
+   */
+  name?: string | undefined;
+};
+
+/** @internal */
+export type TopicSubscriberIdentifierDto$Outbound = {
+  identifier: string;
+  subscriberId: string;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const TopicSubscriberIdentifierDto$outboundSchema: z.ZodType<
+  TopicSubscriberIdentifierDto$Outbound,
+  z.ZodTypeDef,
+  TopicSubscriberIdentifierDto
+> = z.object({
+  identifier: z.string(),
+  subscriberId: z.string(),
+  name: z.string().optional(),
+});
+
+export function topicSubscriberIdentifierDtoToJSON(
+  topicSubscriberIdentifierDto: TopicSubscriberIdentifierDto,
+): string {
+  return JSON.stringify(
+    TopicSubscriberIdentifierDto$outboundSchema.parse(
+      topicSubscriberIdentifierDto,
+    ),
+  );
+}