@novu/api 0.6.2 → 1.0.0

package/src/models/components/subscriptionsdeleteerrordto.ts

@@ -0,0 +1,85 @@
+/*
+ * 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 SubscriptionsDeleteErrorDto = {
+  /**
+   * The subscriber ID that failed
+   */
+  subscriberId: string;
+  /**
+   * The error code
+   */
+  code: string;
+  /**
+   * The error message
+   */
+  message: string;
+};
+
+/** @internal */
+export const SubscriptionsDeleteErrorDto$inboundSchema: z.ZodType<
+  SubscriptionsDeleteErrorDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscriberId: z.string(),
+  code: z.string(),
+  message: z.string(),
+});
+
+/** @internal */
+export type SubscriptionsDeleteErrorDto$Outbound = {
+  subscriberId: string;
+  code: string;
+  message: string;
+};
+
+/** @internal */
+export const SubscriptionsDeleteErrorDto$outboundSchema: z.ZodType<
+  SubscriptionsDeleteErrorDto$Outbound,
+  z.ZodTypeDef,
+  SubscriptionsDeleteErrorDto
+> = 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 SubscriptionsDeleteErrorDto$ {
+  /** @deprecated use `SubscriptionsDeleteErrorDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionsDeleteErrorDto$inboundSchema;
+  /** @deprecated use `SubscriptionsDeleteErrorDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionsDeleteErrorDto$outboundSchema;
+  /** @deprecated use `SubscriptionsDeleteErrorDto$Outbound` instead. */
+  export type Outbound = SubscriptionsDeleteErrorDto$Outbound;
+}
+
+export function subscriptionsDeleteErrorDtoToJSON(
+  subscriptionsDeleteErrorDto: SubscriptionsDeleteErrorDto,
+): string {
+  return JSON.stringify(
+    SubscriptionsDeleteErrorDto$outboundSchema.parse(
+      subscriptionsDeleteErrorDto,
+    ),
+  );
+}
+
+export function subscriptionsDeleteErrorDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionsDeleteErrorDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionsDeleteErrorDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionsDeleteErrorDto' from JSON`,
+  );
+}

package/src/models/components/timedconfig.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const TimedConfigWeekDays = {
+export const WeekDays = {
   Monday: "monday",
   Tuesday: "tuesday",
   Wednesday: "wednesday",
@@ -17,7 +17,7 @@ export const TimedConfigWeekDays = {
   Saturday: "saturday",
   Sunday: "sunday",
 } as const;
-export type TimedConfigWeekDays = ClosedEnum<typeof TimedConfigWeekDays>;
+export type WeekDays = ClosedEnum<typeof WeekDays>;
 
 export const Ordinal = {
   One: "1",
@@ -51,7 +51,7 @@ export type MonthlyType = ClosedEnum<typeof MonthlyType>;
 
 export type TimedConfig = {
   atTime?: string | undefined;
-  weekDays?: Array<TimedConfigWeekDays> | undefined;
+  weekDays?: Array<WeekDays> | undefined;
   monthDays?: Array<string> | undefined;
   ordinal?: Ordinal | undefined;
   ordinalValue?: OrdinalValue | undefined;
@@ -59,24 +59,22 @@ export type TimedConfig = {
 };
 
 /** @internal */
-export const TimedConfigWeekDays$inboundSchema: z.ZodNativeEnum<
-  typeof TimedConfigWeekDays
-> = z.nativeEnum(TimedConfigWeekDays);
+export const WeekDays$inboundSchema: z.ZodNativeEnum<typeof WeekDays> = z
+  .nativeEnum(WeekDays);
 
 /** @internal */
-export const TimedConfigWeekDays$outboundSchema: z.ZodNativeEnum<
-  typeof TimedConfigWeekDays
-> = TimedConfigWeekDays$inboundSchema;
+export const WeekDays$outboundSchema: z.ZodNativeEnum<typeof WeekDays> =
+  WeekDays$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace TimedConfigWeekDays$ {
-  /** @deprecated use `TimedConfigWeekDays$inboundSchema` instead. */
-  export const inboundSchema = TimedConfigWeekDays$inboundSchema;
-  /** @deprecated use `TimedConfigWeekDays$outboundSchema` instead. */
-  export const outboundSchema = TimedConfigWeekDays$outboundSchema;
+export namespace WeekDays$ {
+  /** @deprecated use `WeekDays$inboundSchema` instead. */
+  export const inboundSchema = WeekDays$inboundSchema;
+  /** @deprecated use `WeekDays$outboundSchema` instead. */
+  export const outboundSchema = WeekDays$outboundSchema;
 }
 
 /** @internal */
@@ -143,7 +141,7 @@ export const TimedConfig$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   atTime: z.string().optional(),
-  weekDays: z.array(TimedConfigWeekDays$inboundSchema).optional(),
+  weekDays: z.array(WeekDays$inboundSchema).optional(),
   monthDays: z.array(z.string()).optional(),
   ordinal: Ordinal$inboundSchema.optional(),
   ordinalValue: OrdinalValue$inboundSchema.optional(),
@@ -167,7 +165,7 @@ export const TimedConfig$outboundSchema: z.ZodType<
   TimedConfig
 > = z.object({
   atTime: z.string().optional(),
-  weekDays: z.array(TimedConfigWeekDays$outboundSchema).optional(),
+  weekDays: z.array(WeekDays$outboundSchema).optional(),
   monthDays: z.array(z.string()).optional(),
   ordinal: Ordinal$outboundSchema.optional(),
   ordinalValue: OrdinalValue$outboundSchema.optional(),

package/src/models/components/topicdto.ts

@@ -9,12 +9,18 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicDto = {
-  id?: string | undefined;
-  organizationId: string;
-  environmentId: string;
+  /**
+   * The internal unique identifier of the topic
+   */
+  id: string;
+  /**
+   * The key identifier of the topic used in your application. Should be unique on the environment level.
+   */
   key: string;
-  name: string;
-  subscribers: Array<string>;
+  /**
+   * The name of the topic
+   */
+  name?: string | undefined;
 };
 
 /** @internal */
@@ -23,28 +29,20 @@ export const TopicDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().optional(),
-  _organizationId: z.string(),
-  _environmentId: z.string(),
+  _id: z.string(),
   key: z.string(),
-  name: z.string(),
-  subscribers: z.array(z.string()),
+  name: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
-    "_organizationId": "organizationId",
-    "_environmentId": "environmentId",
   });
 });
 
 /** @internal */
 export type TopicDto$Outbound = {
-  _id?: string | undefined;
-  _organizationId: string;
-  _environmentId: string;
+  _id: string;
   key: string;
-  name: string;
-  subscribers: Array<string>;
+  name?: string | undefined;
 };
 
 /** @internal */
@@ -53,17 +51,12 @@ export const TopicDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TopicDto
 > = z.object({
-  id: z.string().optional(),
-  organizationId: z.string(),
-  environmentId: z.string(),
+  id: z.string(),
   key: z.string(),
-  name: z.string(),
-  subscribers: z.array(z.string()),
+  name: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",
-    organizationId: "_organizationId",
-    environmentId: "_environmentId",
   });
 });
 

package/src/models/components/topicresponsedto.ts

@@ -0,0 +1,106 @@
+/*
+ * 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 TopicResponseDto = {
+  /**
+   * The identifier of the topic
+   */
+  id: string;
+  /**
+   * The unique key of the topic
+   */
+  key: string;
+  /**
+   * The name of the topic
+   */
+  name?: string | undefined;
+  /**
+   * The date the topic was created
+   */
+  createdAt?: string | undefined;
+  /**
+   * The date the topic was last updated
+   */
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const TopicResponseDto$inboundSchema: z.ZodType<
+  TopicResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  key: z.string(),
+  name: z.string().optional(),
+  createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type TopicResponseDto$Outbound = {
+  _id: string;
+  key: string;
+  name?: string | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const TopicResponseDto$outboundSchema: z.ZodType<
+  TopicResponseDto$Outbound,
+  z.ZodTypeDef,
+  TopicResponseDto
+> = z.object({
+  id: z.string(),
+  key: z.string(),
+  name: z.string().optional(),
+  createdAt: z.string().optional(),
+  updatedAt: 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 TopicResponseDto$ {
+  /** @deprecated use `TopicResponseDto$inboundSchema` instead. */
+  export const inboundSchema = TopicResponseDto$inboundSchema;
+  /** @deprecated use `TopicResponseDto$outboundSchema` instead. */
+  export const outboundSchema = TopicResponseDto$outboundSchema;
+  /** @deprecated use `TopicResponseDto$Outbound` instead. */
+  export type Outbound = TopicResponseDto$Outbound;
+}
+
+export function topicResponseDtoToJSON(
+  topicResponseDto: TopicResponseDto,
+): string {
+  return JSON.stringify(
+    TopicResponseDto$outboundSchema.parse(topicResponseDto),
+  );
+}
+
+export function topicResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TopicResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicResponseDto' from JSON`,
+  );
+}

package/src/models/components/topicsubscriptionresponsedto.ts

@@ -0,0 +1,113 @@
+/*
+ * 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 {
+  SubscriberDto,
+  SubscriberDto$inboundSchema,
+  SubscriberDto$Outbound,
+  SubscriberDto$outboundSchema,
+} from "./subscriberdto.js";
+import {
+  TopicResponseDto,
+  TopicResponseDto$inboundSchema,
+  TopicResponseDto$Outbound,
+  TopicResponseDto$outboundSchema,
+} from "./topicresponsedto.js";
+
+export type TopicSubscriptionResponseDto = {
+  /**
+   * The identifier of the subscription
+   */
+  id: string;
+  /**
+   * The date and time the subscription was created
+   */
+  createdAt: string;
+  /**
+   * Topic information
+   */
+  topic: TopicResponseDto;
+  /**
+   * Subscriber information
+   */
+  subscriber: SubscriberDto;
+};
+
+/** @internal */
+export const TopicSubscriptionResponseDto$inboundSchema: z.ZodType<
+  TopicSubscriptionResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  createdAt: z.string(),
+  topic: TopicResponseDto$inboundSchema,
+  subscriber: SubscriberDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type TopicSubscriptionResponseDto$Outbound = {
+  _id: string;
+  createdAt: string;
+  topic: TopicResponseDto$Outbound;
+  subscriber: SubscriberDto$Outbound;
+};
+
+/** @internal */
+export const TopicSubscriptionResponseDto$outboundSchema: z.ZodType<
+  TopicSubscriptionResponseDto$Outbound,
+  z.ZodTypeDef,
+  TopicSubscriptionResponseDto
+> = z.object({
+  id: z.string(),
+  createdAt: z.string(),
+  topic: TopicResponseDto$outboundSchema,
+  subscriber: SubscriberDto$outboundSchema,
+}).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 TopicSubscriptionResponseDto$ {
+  /** @deprecated use `TopicSubscriptionResponseDto$inboundSchema` instead. */
+  export const inboundSchema = TopicSubscriptionResponseDto$inboundSchema;
+  /** @deprecated use `TopicSubscriptionResponseDto$outboundSchema` instead. */
+  export const outboundSchema = TopicSubscriptionResponseDto$outboundSchema;
+  /** @deprecated use `TopicSubscriptionResponseDto$Outbound` instead. */
+  export type Outbound = TopicSubscriptionResponseDto$Outbound;
+}
+
+export function topicSubscriptionResponseDtoToJSON(
+  topicSubscriptionResponseDto: TopicSubscriptionResponseDto,
+): string {
+  return JSON.stringify(
+    TopicSubscriptionResponseDto$outboundSchema.parse(
+      topicSubscriptionResponseDto,
+    ),
+  );
+}
+
+export function topicSubscriptionResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicSubscriptionResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TopicSubscriptionResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicSubscriptionResponseDto' from JSON`,
+  );
+}

package/src/models/components/triggereventrequestdto.ts

@@ -7,6 +7,12 @@ 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 {
+  StepsOverrides,
+  StepsOverrides$inboundSchema,
+  StepsOverrides$Outbound,
+  StepsOverrides$outboundSchema,
+} from "./stepsoverrides.js";
 import {
   SubscriberPayloadDto,
   SubscriberPayloadDto$inboundSchema,
@@ -26,6 +32,50 @@ import {
   TopicPayloadDto$outboundSchema,
 } from "./topicpayloaddto.js";
 
+/**
+ * This could be used to override provider specific configurations
+ */
+export type Overrides = {
+  /**
+   * This could be used to override provider specific configurations
+   */
+  steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Overrides the provider configuration for the entire workflow and all steps
+   */
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  /**
+   * Override the email provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  email?: { [k: string]: any } | undefined;
+  /**
+   * Override the push provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  push?: { [k: string]: any } | undefined;
+  /**
+   * Override the sms provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  sms?: { [k: string]: any } | undefined;
+  /**
+   * Override the chat provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  chat?: { [k: string]: any } | undefined;
+  /**
+   * Override the layout identifier for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  layoutIdentifier?: string | undefined;
+};
+
 export type One = TopicPayloadDto | SubscriberPayloadDto | string;
 
 /**
@@ -69,7 +119,7 @@ export type TriggerEventRequestDto = {
   /**
    * This could be used to override provider specific configurations
    */
-  overrides?: { [k: string]: { [k: string]: any } } | undefined;
+  overrides?: Overrides | undefined;
   /**
    * The recipients list of people who will receive the notification.
    */
@@ -98,6 +148,74 @@ export type TriggerEventRequestDto = {
   tenant?: TenantPayloadDto | string | undefined;
 };
 
+/** @internal */
+export const Overrides$inboundSchema: z.ZodType<
+  Overrides,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  steps: z.record(StepsOverrides$inboundSchema).optional(),
+  providers: z.record(z.record(z.any())).optional(),
+  email: z.record(z.any()).optional(),
+  push: z.record(z.any()).optional(),
+  sms: z.record(z.any()).optional(),
+  chat: z.record(z.any()).optional(),
+  layoutIdentifier: z.string().optional(),
+});
+
+/** @internal */
+export type Overrides$Outbound = {
+  steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  email?: { [k: string]: any } | undefined;
+  push?: { [k: string]: any } | undefined;
+  sms?: { [k: string]: any } | undefined;
+  chat?: { [k: string]: any } | undefined;
+  layoutIdentifier?: string | undefined;
+};
+
+/** @internal */
+export const Overrides$outboundSchema: z.ZodType<
+  Overrides$Outbound,
+  z.ZodTypeDef,
+  Overrides
+> = z.object({
+  steps: z.record(StepsOverrides$outboundSchema).optional(),
+  providers: z.record(z.record(z.any())).optional(),
+  email: z.record(z.any()).optional(),
+  push: z.record(z.any()).optional(),
+  sms: z.record(z.any()).optional(),
+  chat: z.record(z.any()).optional(),
+  layoutIdentifier: 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 Overrides$ {
+  /** @deprecated use `Overrides$inboundSchema` instead. */
+  export const inboundSchema = Overrides$inboundSchema;
+  /** @deprecated use `Overrides$outboundSchema` instead. */
+  export const outboundSchema = Overrides$outboundSchema;
+  /** @deprecated use `Overrides$Outbound` instead. */
+  export type Outbound = Overrides$Outbound;
+}
+
+export function overridesToJSON(overrides: Overrides): string {
+  return JSON.stringify(Overrides$outboundSchema.parse(overrides));
+}
+
+export function overridesFromJSON(
+  jsonString: string,
+): SafeParseResult<Overrides, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Overrides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Overrides' from JSON`,
+  );
+}
+
 /** @internal */
 export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z.union(
   [
@@ -301,7 +419,7 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   payload: z.record(z.any()).optional(),
-  overrides: z.record(z.record(z.any())).optional(),
+  overrides: z.lazy(() => Overrides$inboundSchema).optional(),
   to: z.union([
     TopicPayloadDto$inboundSchema,
     SubscriberPayloadDto$inboundSchema,
@@ -327,7 +445,7 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
 export type TriggerEventRequestDto$Outbound = {
   name: string;
   payload?: { [k: string]: any } | undefined;
-  overrides?: { [k: string]: { [k: string]: any } } | undefined;
+  overrides?: Overrides$Outbound | undefined;
   to:
     | TopicPayloadDto$Outbound
     | SubscriberPayloadDto$Outbound
@@ -346,7 +464,7 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   workflowId: z.string(),
   payload: z.record(z.any()).optional(),
-  overrides: z.record(z.record(z.any())).optional(),
+  overrides: z.lazy(() => Overrides$outboundSchema).optional(),
   to: z.union([
     TopicPayloadDto$outboundSchema,
     SubscriberPayloadDto$outboundSchema,