@novu/api 1.6.0 → 1.7.0

package/src/models/components/layoutpreviewrequestdto.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  LayoutPreviewPayloadDto,
+  LayoutPreviewPayloadDto$inboundSchema,
+  LayoutPreviewPayloadDto$Outbound,
+  LayoutPreviewPayloadDto$outboundSchema,
+} from "./layoutpreviewpayloaddto.js";
+
+export type LayoutPreviewRequestDto = {
+  /**
+   * Optional control values for layout preview
+   */
+  controlValues?: { [k: string]: any } | undefined;
+  /**
+   * Optional payload for layout preview
+   */
+  previewPayload?: LayoutPreviewPayloadDto | undefined;
+};
+
+/** @internal */
+export const LayoutPreviewRequestDto$inboundSchema: z.ZodType<
+  LayoutPreviewRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controlValues: z.record(z.any()).optional(),
+  previewPayload: LayoutPreviewPayloadDto$inboundSchema.optional(),
+});
+
+/** @internal */
+export type LayoutPreviewRequestDto$Outbound = {
+  controlValues?: { [k: string]: any } | undefined;
+  previewPayload?: LayoutPreviewPayloadDto$Outbound | undefined;
+};
+
+/** @internal */
+export const LayoutPreviewRequestDto$outboundSchema: z.ZodType<
+  LayoutPreviewRequestDto$Outbound,
+  z.ZodTypeDef,
+  LayoutPreviewRequestDto
+> = z.object({
+  controlValues: z.record(z.any()).optional(),
+  previewPayload: LayoutPreviewPayloadDto$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 LayoutPreviewRequestDto$ {
+  /** @deprecated use `LayoutPreviewRequestDto$inboundSchema` instead. */
+  export const inboundSchema = LayoutPreviewRequestDto$inboundSchema;
+  /** @deprecated use `LayoutPreviewRequestDto$outboundSchema` instead. */
+  export const outboundSchema = LayoutPreviewRequestDto$outboundSchema;
+  /** @deprecated use `LayoutPreviewRequestDto$Outbound` instead. */
+  export type Outbound = LayoutPreviewRequestDto$Outbound;
+}
+
+export function layoutPreviewRequestDtoToJSON(
+  layoutPreviewRequestDto: LayoutPreviewRequestDto,
+): string {
+  return JSON.stringify(
+    LayoutPreviewRequestDto$outboundSchema.parse(layoutPreviewRequestDto),
+  );
+}
+
+export function layoutPreviewRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<LayoutPreviewRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LayoutPreviewRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LayoutPreviewRequestDto' from JSON`,
+  );
+}

package/src/models/components/layoutresponsedto.ts

@@ -0,0 +1,260 @@
+/*
+ * 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 {
+  LayoutControlsDto,
+  LayoutControlsDto$inboundSchema,
+  LayoutControlsDto$Outbound,
+  LayoutControlsDto$outboundSchema,
+} from "./layoutcontrolsdto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
+import {
+  ResourceTypeEnum,
+  ResourceTypeEnum$inboundSchema,
+  ResourceTypeEnum$outboundSchema,
+} from "./resourcetypeenum.js";
+
+/**
+ * User who last updated the layout
+ */
+export type UpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName?: string | null | undefined;
+  /**
+   * User last name
+   */
+  lastName?: string | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | null | undefined;
+};
+
+export type LayoutResponseDto = {
+  /**
+   * Unique internal identifier of the layout
+   */
+  id: string;
+  /**
+   * Unique identifier for the layout
+   */
+  layoutId: string;
+  /**
+   * Slug of the layout
+   */
+  slug: string;
+  /**
+   * Name of the layout
+   */
+  name: string;
+  /**
+   * Whether the layout is the default layout
+   */
+  isDefault: boolean;
+  /**
+   * Last updated timestamp
+   */
+  updatedAt: string;
+  /**
+   * User who last updated the layout
+   */
+  updatedBy?: UpdatedBy | null | undefined;
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Origin of the layout
+   */
+  origin: ResourceOriginEnum;
+  /**
+   * Type of the layout
+   */
+  type: ResourceTypeEnum;
+  /**
+   * The variables JSON Schema for the layout
+   */
+  variables?: { [k: string]: any } | null | undefined;
+  /**
+   * Controls metadata for the layout
+   */
+  controls: LayoutControlsDto;
+};
+
+/** @internal */
+export const UpdatedBy$inboundSchema: z.ZodType<
+  UpdatedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  externalId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type UpdatedBy$Outbound = {
+  _id: string;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  externalId?: string | null | undefined;
+};
+
+/** @internal */
+export const UpdatedBy$outboundSchema: z.ZodType<
+  UpdatedBy$Outbound,
+  z.ZodTypeDef,
+  UpdatedBy
+> = z.object({
+  id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  externalId: 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 UpdatedBy$ {
+  /** @deprecated use `UpdatedBy$inboundSchema` instead. */
+  export const inboundSchema = UpdatedBy$inboundSchema;
+  /** @deprecated use `UpdatedBy$outboundSchema` instead. */
+  export const outboundSchema = UpdatedBy$outboundSchema;
+  /** @deprecated use `UpdatedBy$Outbound` instead. */
+  export type Outbound = UpdatedBy$Outbound;
+}
+
+export function updatedByToJSON(updatedBy: UpdatedBy): string {
+  return JSON.stringify(UpdatedBy$outboundSchema.parse(updatedBy));
+}
+
+export function updatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdatedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdatedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdatedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const LayoutResponseDto$inboundSchema: z.ZodType<
+  LayoutResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  layoutId: z.string(),
+  slug: z.string(),
+  name: z.string(),
+  isDefault: z.boolean(),
+  updatedAt: z.string(),
+  updatedBy: z.nullable(z.lazy(() => UpdatedBy$inboundSchema)).optional(),
+  createdAt: z.string(),
+  origin: ResourceOriginEnum$inboundSchema,
+  type: ResourceTypeEnum$inboundSchema,
+  variables: z.nullable(z.record(z.any())).optional(),
+  controls: LayoutControlsDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type LayoutResponseDto$Outbound = {
+  _id: string;
+  layoutId: string;
+  slug: string;
+  name: string;
+  isDefault: boolean;
+  updatedAt: string;
+  updatedBy?: UpdatedBy$Outbound | null | undefined;
+  createdAt: string;
+  origin: string;
+  type: string;
+  variables?: { [k: string]: any } | null | undefined;
+  controls: LayoutControlsDto$Outbound;
+};
+
+/** @internal */
+export const LayoutResponseDto$outboundSchema: z.ZodType<
+  LayoutResponseDto$Outbound,
+  z.ZodTypeDef,
+  LayoutResponseDto
+> = z.object({
+  id: z.string(),
+  layoutId: z.string(),
+  slug: z.string(),
+  name: z.string(),
+  isDefault: z.boolean(),
+  updatedAt: z.string(),
+  updatedBy: z.nullable(z.lazy(() => UpdatedBy$outboundSchema)).optional(),
+  createdAt: z.string(),
+  origin: ResourceOriginEnum$outboundSchema,
+  type: ResourceTypeEnum$outboundSchema,
+  variables: z.nullable(z.record(z.any())).optional(),
+  controls: LayoutControlsDto$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 LayoutResponseDto$ {
+  /** @deprecated use `LayoutResponseDto$inboundSchema` instead. */
+  export const inboundSchema = LayoutResponseDto$inboundSchema;
+  /** @deprecated use `LayoutResponseDto$outboundSchema` instead. */
+  export const outboundSchema = LayoutResponseDto$outboundSchema;
+  /** @deprecated use `LayoutResponseDto$Outbound` instead. */
+  export type Outbound = LayoutResponseDto$Outbound;
+}
+
+export function layoutResponseDtoToJSON(
+  layoutResponseDto: LayoutResponseDto,
+): string {
+  return JSON.stringify(
+    LayoutResponseDto$outboundSchema.parse(layoutResponseDto),
+  );
+}
+
+export function layoutResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<LayoutResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LayoutResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LayoutResponseDto' from JSON`,
+  );
+}

package/src/models/components/layoutresponsedtosortfield.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const LayoutResponseDtoSortField = {
+  CreatedAt: "createdAt",
+  UpdatedAt: "updatedAt",
+  Name: "name",
+} as const;
+export type LayoutResponseDtoSortField = ClosedEnum<
+  typeof LayoutResponseDtoSortField
+>;
+
+/** @internal */
+export const LayoutResponseDtoSortField$inboundSchema: z.ZodNativeEnum<
+  typeof LayoutResponseDtoSortField
+> = z.nativeEnum(LayoutResponseDtoSortField);
+
+/** @internal */
+export const LayoutResponseDtoSortField$outboundSchema: z.ZodNativeEnum<
+  typeof LayoutResponseDtoSortField
+> = LayoutResponseDtoSortField$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LayoutResponseDtoSortField$ {
+  /** @deprecated use `LayoutResponseDtoSortField$inboundSchema` instead. */
+  export const inboundSchema = LayoutResponseDtoSortField$inboundSchema;
+  /** @deprecated use `LayoutResponseDtoSortField$outboundSchema` instead. */
+  export const outboundSchema = LayoutResponseDtoSortField$outboundSchema;
+}

package/src/models/components/listlayoutresponsedto.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  LayoutResponseDto,
+  LayoutResponseDto$inboundSchema,
+  LayoutResponseDto$Outbound,
+  LayoutResponseDto$outboundSchema,
+} from "./layoutresponsedto.js";
+
+export type ListLayoutResponseDto = {
+  /**
+   * List of layouts
+   */
+  layouts: Array<LayoutResponseDto>;
+  /**
+   * Total number of layouts
+   */
+  totalCount: number;
+};
+
+/** @internal */
+export const ListLayoutResponseDto$inboundSchema: z.ZodType<
+  ListLayoutResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  layouts: z.array(LayoutResponseDto$inboundSchema),
+  totalCount: z.number(),
+});
+
+/** @internal */
+export type ListLayoutResponseDto$Outbound = {
+  layouts: Array<LayoutResponseDto$Outbound>;
+  totalCount: number;
+};
+
+/** @internal */
+export const ListLayoutResponseDto$outboundSchema: z.ZodType<
+  ListLayoutResponseDto$Outbound,
+  z.ZodTypeDef,
+  ListLayoutResponseDto
+> = z.object({
+  layouts: z.array(LayoutResponseDto$outboundSchema),
+  totalCount: 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 ListLayoutResponseDto$ {
+  /** @deprecated use `ListLayoutResponseDto$inboundSchema` instead. */
+  export const inboundSchema = ListLayoutResponseDto$inboundSchema;
+  /** @deprecated use `ListLayoutResponseDto$outboundSchema` instead. */
+  export const outboundSchema = ListLayoutResponseDto$outboundSchema;
+  /** @deprecated use `ListLayoutResponseDto$Outbound` instead. */
+  export type Outbound = ListLayoutResponseDto$Outbound;
+}
+
+export function listLayoutResponseDtoToJSON(
+  listLayoutResponseDto: ListLayoutResponseDto,
+): string {
+  return JSON.stringify(
+    ListLayoutResponseDto$outboundSchema.parse(listLayoutResponseDto),
+  );
+}
+
+export function listLayoutResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ListLayoutResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListLayoutResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListLayoutResponseDto' from JSON`,
+  );
+}

package/src/models/components/listsubscribersresponsedto.ts

@@ -26,6 +26,14 @@ export type ListSubscribersResponseDto = {
    * The cursor for the previous page of results, or null if this is the first page.
    */
   previous: string | null;
+  /**
+   * The total count of items (up to 50,000)
+   */
+  totalCount: number;
+  /**
+   * Whether there are more than 50,000 results available
+   */
+  totalCountCapped: boolean;
 };
 
 /** @internal */
@@ -37,6 +45,8 @@ export const ListSubscribersResponseDto$inboundSchema: z.ZodType<
   data: z.array(SubscriberResponseDto$inboundSchema),
   next: z.nullable(z.string()),
   previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
 });
 
 /** @internal */
@@ -44,6 +54,8 @@ export type ListSubscribersResponseDto$Outbound = {
   data: Array<SubscriberResponseDto$Outbound>;
   next: string | null;
   previous: string | null;
+  totalCount: number;
+  totalCountCapped: boolean;
 };
 
 /** @internal */
@@ -55,6 +67,8 @@ export const ListSubscribersResponseDto$outboundSchema: z.ZodType<
   data: z.array(SubscriberResponseDto$outboundSchema),
   next: z.nullable(z.string()),
   previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
 });
 
 /**

package/src/models/components/listtopicsresponsedto.ts

@@ -26,6 +26,14 @@ export type ListTopicsResponseDto = {
    * The cursor for the previous page of results, or null if this is the first page.
    */
   previous: string | null;
+  /**
+   * The total count of items (up to 50,000)
+   */
+  totalCount: number;
+  /**
+   * Whether there are more than 50,000 results available
+   */
+  totalCountCapped: boolean;
 };
 
 /** @internal */
@@ -37,6 +45,8 @@ export const ListTopicsResponseDto$inboundSchema: z.ZodType<
   data: z.array(TopicResponseDto$inboundSchema),
   next: z.nullable(z.string()),
   previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
 });
 
 /** @internal */
@@ -44,6 +54,8 @@ export type ListTopicsResponseDto$Outbound = {
   data: Array<TopicResponseDto$Outbound>;
   next: string | null;
   previous: string | null;
+  totalCount: number;
+  totalCountCapped: boolean;
 };
 
 /** @internal */
@@ -55,6 +67,8 @@ export const ListTopicsResponseDto$outboundSchema: z.ZodType<
   data: z.array(TopicResponseDto$outboundSchema),
   next: z.nullable(z.string()),
   previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
 });
 
 /**

package/src/models/components/listtopicsubscriptionsresponsedto.ts

@@ -26,6 +26,14 @@ export type ListTopicSubscriptionsResponseDto = {
    * The cursor for the previous page of results, or null if this is the first page.
    */
   previous: string | null;
+  /**
+   * The total count of items (up to 50,000)
+   */
+  totalCount: number;
+  /**
+   * Whether there are more than 50,000 results available
+   */
+  totalCountCapped: boolean;
 };
 
 /** @internal */
@@ -37,6 +45,8 @@ export const ListTopicSubscriptionsResponseDto$inboundSchema: z.ZodType<
   data: z.array(TopicSubscriptionResponseDto$inboundSchema),
   next: z.nullable(z.string()),
   previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
 });
 
 /** @internal */
@@ -44,6 +54,8 @@ export type ListTopicSubscriptionsResponseDto$Outbound = {
   data: Array<TopicSubscriptionResponseDto$Outbound>;
   next: string | null;
   previous: string | null;
+  totalCount: number;
+  totalCountCapped: boolean;
 };
 
 /** @internal */
@@ -55,6 +67,8 @@ export const ListTopicSubscriptionsResponseDto$outboundSchema: z.ZodType<
   data: z.array(TopicSubscriptionResponseDto$outboundSchema),
   next: z.nullable(z.string()),
   previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
 });
 
 /**

package/src/models/components/messageresponsedto.ts

@@ -45,7 +45,7 @@ import {
 /**
  * Content of the message, can be an email block or a string
  */
-export type Content = Array<EmailBlock> | string;
+export type MessageResponseDtoContent = Array<EmailBlock> | string;
 
 /**
  * The payload that was used to send the notification trigger
@@ -197,43 +197,52 @@ export type MessageResponseDto = {
 };
 
 /** @internal */
-export const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> =
-  z.union([z.array(EmailBlock$inboundSchema), z.string()]);
+export const MessageResponseDtoContent$inboundSchema: z.ZodType<
+  MessageResponseDtoContent,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.array(EmailBlock$inboundSchema), z.string()]);
 
 /** @internal */
-export type Content$Outbound = Array<EmailBlock$Outbound> | string;
+export type MessageResponseDtoContent$Outbound =
+  | Array<EmailBlock$Outbound>
+  | string;
 
 /** @internal */
-export const Content$outboundSchema: z.ZodType<
-  Content$Outbound,
+export const MessageResponseDtoContent$outboundSchema: z.ZodType<
+  MessageResponseDtoContent$Outbound,
   z.ZodTypeDef,
-  Content
+  MessageResponseDtoContent
 > = z.union([z.array(EmailBlock$outboundSchema), 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 Content$ {
-  /** @deprecated use `Content$inboundSchema` instead. */
-  export const inboundSchema = Content$inboundSchema;
-  /** @deprecated use `Content$outboundSchema` instead. */
-  export const outboundSchema = Content$outboundSchema;
-  /** @deprecated use `Content$Outbound` instead. */
-  export type Outbound = Content$Outbound;
+export namespace MessageResponseDtoContent$ {
+  /** @deprecated use `MessageResponseDtoContent$inboundSchema` instead. */
+  export const inboundSchema = MessageResponseDtoContent$inboundSchema;
+  /** @deprecated use `MessageResponseDtoContent$outboundSchema` instead. */
+  export const outboundSchema = MessageResponseDtoContent$outboundSchema;
+  /** @deprecated use `MessageResponseDtoContent$Outbound` instead. */
+  export type Outbound = MessageResponseDtoContent$Outbound;
 }
 
-export function contentToJSON(content: Content): string {
-  return JSON.stringify(Content$outboundSchema.parse(content));
+export function messageResponseDtoContentToJSON(
+  messageResponseDtoContent: MessageResponseDtoContent,
+): string {
+  return JSON.stringify(
+    MessageResponseDtoContent$outboundSchema.parse(messageResponseDtoContent),
+  );
 }
 
-export function contentFromJSON(
+export function messageResponseDtoContentFromJSON(
   jsonString: string,
-): SafeParseResult<Content, SDKValidationError> {
+): SafeParseResult<MessageResponseDtoContent, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Content$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Content' from JSON`,
+    (x) => MessageResponseDtoContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageResponseDtoContent' from JSON`,
   );
 }