@novu/api 1.6.0 → 1.7.0

package/src/models/components/smsstepresponsedto.ts

@@ -48,11 +48,6 @@ export type SmsStepResponseDtoControlValues = {
   additionalProperties?: { [k: string]: any };
 };
 
-/**
- * Slug of the step
- */
-export type SmsStepResponseDtoSlug = {};
-
 export type SmsStepResponseDto = {
   /**
    * Controls metadata for the SMS step
@@ -81,13 +76,13 @@ export type SmsStepResponseDto = {
   /**
    * Slug of the step
    */
-  slug: SmsStepResponseDtoSlug;
+  slug: string;
   /**
    * Type of the step
    */
   type: StepTypeEnum;
   /**
-   * Origin of the workflow
+   * Origin of the layout
    */
   origin: ResourceOriginEnum;
   /**
@@ -176,54 +171,6 @@ export function smsStepResponseDtoControlValuesFromJSON(
   );
 }
 
-/** @internal */
-export const SmsStepResponseDtoSlug$inboundSchema: z.ZodType<
-  SmsStepResponseDtoSlug,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type SmsStepResponseDtoSlug$Outbound = {};
-
-/** @internal */
-export const SmsStepResponseDtoSlug$outboundSchema: z.ZodType<
-  SmsStepResponseDtoSlug$Outbound,
-  z.ZodTypeDef,
-  SmsStepResponseDtoSlug
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SmsStepResponseDtoSlug$ {
-  /** @deprecated use `SmsStepResponseDtoSlug$inboundSchema` instead. */
-  export const inboundSchema = SmsStepResponseDtoSlug$inboundSchema;
-  /** @deprecated use `SmsStepResponseDtoSlug$outboundSchema` instead. */
-  export const outboundSchema = SmsStepResponseDtoSlug$outboundSchema;
-  /** @deprecated use `SmsStepResponseDtoSlug$Outbound` instead. */
-  export type Outbound = SmsStepResponseDtoSlug$Outbound;
-}
-
-export function smsStepResponseDtoSlugToJSON(
-  smsStepResponseDtoSlug: SmsStepResponseDtoSlug,
-): string {
-  return JSON.stringify(
-    SmsStepResponseDtoSlug$outboundSchema.parse(smsStepResponseDtoSlug),
-  );
-}
-
-export function smsStepResponseDtoSlugFromJSON(
-  jsonString: string,
-): SafeParseResult<SmsStepResponseDtoSlug, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => SmsStepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SmsStepResponseDtoSlug' from JSON`,
-  );
-}
-
 /** @internal */
 export const SmsStepResponseDto$inboundSchema: z.ZodType<
   SmsStepResponseDto,
@@ -237,7 +184,7 @@ export const SmsStepResponseDto$inboundSchema: z.ZodType<
   stepId: z.string(),
   _id: z.string(),
   name: z.string(),
-  slug: z.lazy(() => SmsStepResponseDtoSlug$inboundSchema),
+  slug: z.string(),
   type: StepTypeEnum$inboundSchema,
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
@@ -257,7 +204,7 @@ export type SmsStepResponseDto$Outbound = {
   stepId: string;
   _id: string;
   name: string;
-  slug: SmsStepResponseDtoSlug$Outbound;
+  slug: string;
   type: string;
   origin: string;
   workflowId: string;
@@ -278,7 +225,7 @@ export const SmsStepResponseDto$outboundSchema: z.ZodType<
   stepId: z.string(),
   id: z.string(),
   name: z.string(),
-  slug: z.lazy(() => SmsStepResponseDtoSlug$outboundSchema),
+  slug: z.string(),
   type: StepTypeEnum$outboundSchema,
   origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),

package/src/models/components/steplistresponsedto.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 {
+  StepIssuesDto,
+  StepIssuesDto$inboundSchema,
+  StepIssuesDto$Outbound,
+  StepIssuesDto$outboundSchema,
+} from "./stepissuesdto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+export type StepListResponseDto = {
+  /**
+   * Slug of the step
+   */
+  slug: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Issues associated with the step
+   */
+  issues?: StepIssuesDto | undefined;
+};
+
+/** @internal */
+export const StepListResponseDto$inboundSchema: z.ZodType<
+  StepListResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  slug: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  issues: StepIssuesDto$inboundSchema.optional(),
+});
+
+/** @internal */
+export type StepListResponseDto$Outbound = {
+  slug: string;
+  type: string;
+  issues?: StepIssuesDto$Outbound | undefined;
+};
+
+/** @internal */
+export const StepListResponseDto$outboundSchema: z.ZodType<
+  StepListResponseDto$Outbound,
+  z.ZodTypeDef,
+  StepListResponseDto
+> = z.object({
+  slug: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  issues: StepIssuesDto$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 StepListResponseDto$ {
+  /** @deprecated use `StepListResponseDto$inboundSchema` instead. */
+  export const inboundSchema = StepListResponseDto$inboundSchema;
+  /** @deprecated use `StepListResponseDto$outboundSchema` instead. */
+  export const outboundSchema = StepListResponseDto$outboundSchema;
+  /** @deprecated use `StepListResponseDto$Outbound` instead. */
+  export type Outbound = StepListResponseDto$Outbound;
+}
+
+export function stepListResponseDtoToJSON(
+  stepListResponseDto: StepListResponseDto,
+): string {
+  return JSON.stringify(
+    StepListResponseDto$outboundSchema.parse(stepListResponseDto),
+  );
+}
+
+export function stepListResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<StepListResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepListResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepListResponseDto' from JSON`,
+  );
+}

package/src/models/components/stepresponsedto.ts

@@ -30,11 +30,6 @@ import {
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
 
-/**
- * Slug of the step
- */
-export type StepResponseDtoSlug = {};
-
 export type StepResponseDto = {
   /**
    * Controls metadata for the step
@@ -63,13 +58,13 @@ export type StepResponseDto = {
   /**
    * Slug of the step
    */
-  slug: StepResponseDtoSlug;
+  slug: string;
   /**
    * Type of the step
    */
   type: StepTypeEnum;
   /**
-   * Origin of the workflow
+   * Origin of the layout
    */
   origin: ResourceOriginEnum;
   /**
@@ -86,54 +81,6 @@ export type StepResponseDto = {
   issues?: StepIssuesDto | undefined;
 };
 
-/** @internal */
-export const StepResponseDtoSlug$inboundSchema: z.ZodType<
-  StepResponseDtoSlug,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type StepResponseDtoSlug$Outbound = {};
-
-/** @internal */
-export const StepResponseDtoSlug$outboundSchema: z.ZodType<
-  StepResponseDtoSlug$Outbound,
-  z.ZodTypeDef,
-  StepResponseDtoSlug
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace StepResponseDtoSlug$ {
-  /** @deprecated use `StepResponseDtoSlug$inboundSchema` instead. */
-  export const inboundSchema = StepResponseDtoSlug$inboundSchema;
-  /** @deprecated use `StepResponseDtoSlug$outboundSchema` instead. */
-  export const outboundSchema = StepResponseDtoSlug$outboundSchema;
-  /** @deprecated use `StepResponseDtoSlug$Outbound` instead. */
-  export type Outbound = StepResponseDtoSlug$Outbound;
-}
-
-export function stepResponseDtoSlugToJSON(
-  stepResponseDtoSlug: StepResponseDtoSlug,
-): string {
-  return JSON.stringify(
-    StepResponseDtoSlug$outboundSchema.parse(stepResponseDtoSlug),
-  );
-}
-
-export function stepResponseDtoSlugFromJSON(
-  jsonString: string,
-): SafeParseResult<StepResponseDtoSlug, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => StepResponseDtoSlug$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'StepResponseDtoSlug' from JSON`,
-  );
-}
-
 /** @internal */
 export const StepResponseDto$inboundSchema: z.ZodType<
   StepResponseDto,
@@ -146,7 +93,7 @@ export const StepResponseDto$inboundSchema: z.ZodType<
   stepId: z.string(),
   _id: z.string(),
   name: z.string(),
-  slug: z.lazy(() => StepResponseDtoSlug$inboundSchema),
+  slug: z.string(),
   type: StepTypeEnum$inboundSchema,
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
@@ -166,7 +113,7 @@ export type StepResponseDto$Outbound = {
   stepId: string;
   _id: string;
   name: string;
-  slug: StepResponseDtoSlug$Outbound;
+  slug: string;
   type: string;
   origin: string;
   workflowId: string;
@@ -186,7 +133,7 @@ export const StepResponseDto$outboundSchema: z.ZodType<
   stepId: z.string(),
   id: z.string(),
   name: z.string(),
-  slug: z.lazy(() => StepResponseDtoSlug$outboundSchema),
+  slug: z.string(),
   type: StepTypeEnum$outboundSchema,
   origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),

package/src/models/components/steptypeenum.ts

@@ -17,6 +17,7 @@ export const StepTypeEnum = {
   Digest: "digest",
   Trigger: "trigger",
   Delay: "delay",
+  Throttle: "throttle",
   Custom: "custom",
 } as const;
 /**

package/src/models/components/subscriberchanneldto.ts

@@ -29,6 +29,7 @@ export const ProviderId = {
   RocketChat: "rocket-chat",
   WhatsappBusiness: "whatsapp-business",
   ChatWebhook: "chat-webhook",
+  NovuSlack: "novu-slack",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/subscriberglobalpreferencedto.ts

@@ -6,6 +6,12 @@ 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 {
+  ScheduleDto,
+  ScheduleDto$inboundSchema,
+  ScheduleDto$Outbound,
+  ScheduleDto$outboundSchema,
+} from "./scheduledto.js";
 import {
   SubscriberPreferenceChannels,
   SubscriberPreferenceChannels$inboundSchema,
@@ -22,6 +28,10 @@ export type SubscriberGlobalPreferenceDto = {
    * Channel-specific preference settings
    */
   channels: SubscriberPreferenceChannels;
+  /**
+   * Subscriber schedule
+   */
+  schedule?: ScheduleDto | undefined;
 };
 
 /** @internal */
@@ -32,12 +42,14 @@ export const SubscriberGlobalPreferenceDto$inboundSchema: z.ZodType<
 > = z.object({
   enabled: z.boolean(),
   channels: SubscriberPreferenceChannels$inboundSchema,
+  schedule: ScheduleDto$inboundSchema.optional(),
 });
 
 /** @internal */
 export type SubscriberGlobalPreferenceDto$Outbound = {
   enabled: boolean;
   channels: SubscriberPreferenceChannels$Outbound;
+  schedule?: ScheduleDto$Outbound | undefined;
 };
 
 /** @internal */
@@ -48,6 +60,7 @@ export const SubscriberGlobalPreferenceDto$outboundSchema: z.ZodType<
 > = z.object({
   enabled: z.boolean(),
   channels: SubscriberPreferenceChannels$outboundSchema,
+  schedule: ScheduleDto$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/subscriberresponsedtooptional.ts

@@ -0,0 +1,181 @@
+/*
+ * 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 {
+  ChannelSettingsDto,
+  ChannelSettingsDto$inboundSchema,
+  ChannelSettingsDto$Outbound,
+  ChannelSettingsDto$outboundSchema,
+} from "./channelsettingsdto.js";
+
+export type SubscriberResponseDtoOptional = {
+  /**
+   * The internal ID generated by Novu for your subscriber. This ID does not match the `subscriberId` used in your queries. Refer to `subscriberId` for that identifier.
+   */
+  id?: string | undefined;
+  /**
+   * The first name of the subscriber.
+   */
+  firstName?: string | null | undefined;
+  /**
+   * The last name of the subscriber.
+   */
+  lastName?: string | null | undefined;
+  /**
+   * The email address of the subscriber.
+   */
+  email?: string | null | undefined;
+  /**
+   * The phone number of the subscriber.
+   */
+  phone?: string | null | undefined;
+  /**
+   * The URL of the subscriber's avatar image.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The locale setting of the subscriber, indicating their preferred language or region.
+   */
+  locale?: string | null | undefined;
+  /**
+   * An array of channel settings associated with the subscriber.
+   */
+  channels?: Array<ChannelSettingsDto> | undefined;
+  /**
+   * An array of topics that the subscriber is subscribed to.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  topics?: Array<string> | undefined;
+  /**
+   * Indicates whether the subscriber is currently online.
+   */
+  isOnline?: boolean | null | undefined;
+  /**
+   * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
+   */
+  lastOnlineAt?: string | null | 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 | null | undefined;
+};
+
+/** @internal */
+export const SubscriberResponseDtoOptional$inboundSchema: z.ZodType<
+  SubscriberResponseDtoOptional,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: 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.nullable(z.boolean()).optional(),
+  lastOnlineAt: z.nullable(z.string()).optional(),
+  __v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
+  timezone: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "__v": "v",
+  });
+});
+
+/** @internal */
+export type SubscriberResponseDtoOptional$Outbound = {
+  _id?: 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 | null | undefined;
+  lastOnlineAt?: string | null | undefined;
+  __v?: number | undefined;
+  data?: { [k: string]: any } | null | undefined;
+  timezone?: string | null | undefined;
+};
+
+/** @internal */
+export const SubscriberResponseDtoOptional$outboundSchema: z.ZodType<
+  SubscriberResponseDtoOptional$Outbound,
+  z.ZodTypeDef,
+  SubscriberResponseDtoOptional
+> = z.object({
+  id: 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.nullable(z.boolean()).optional(),
+  lastOnlineAt: z.nullable(z.string()).optional(),
+  v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
+  timezone: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    v: "__v",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberResponseDtoOptional$ {
+  /** @deprecated use `SubscriberResponseDtoOptional$inboundSchema` instead. */
+  export const inboundSchema = SubscriberResponseDtoOptional$inboundSchema;
+  /** @deprecated use `SubscriberResponseDtoOptional$outboundSchema` instead. */
+  export const outboundSchema = SubscriberResponseDtoOptional$outboundSchema;
+  /** @deprecated use `SubscriberResponseDtoOptional$Outbound` instead. */
+  export type Outbound = SubscriberResponseDtoOptional$Outbound;
+}
+
+export function subscriberResponseDtoOptionalToJSON(
+  subscriberResponseDtoOptional: SubscriberResponseDtoOptional,
+): string {
+  return JSON.stringify(
+    SubscriberResponseDtoOptional$outboundSchema.parse(
+      subscriberResponseDtoOptional,
+    ),
+  );
+}
+
+export function subscriberResponseDtoOptionalFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberResponseDtoOptional, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriberResponseDtoOptional$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberResponseDtoOptional' from JSON`,
+  );
+}