@novu/api 0.7.0 → 1.0.0

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

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/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`,
+  );
+}