@novu/api 3.14.4 → 3.15.1-rc.1

package/src/models/components/listdomainroutesresponsedto.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 {
+  DomainRouteResponseDto,
+  DomainRouteResponseDto$inboundSchema,
+} from "./domainrouteresponsedto.js";
+
+export type ListDomainRoutesResponseDto = {
+  /**
+   * List of returned domain routes
+   */
+  data: Array<DomainRouteResponseDto>;
+  /**
+   * The cursor for the next page of results, or null if there are no more pages.
+   */
+  next: string | null;
+  /**
+   * 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 */
+export const ListDomainRoutesResponseDto$inboundSchema: z.ZodType<
+  ListDomainRoutesResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(DomainRouteResponseDto$inboundSchema),
+  next: z.nullable(z.string()),
+  previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
+});
+
+export function listDomainRoutesResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDomainRoutesResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDomainRoutesResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDomainRoutesResponseDto' from JSON`,
+  );
+}

package/src/models/components/listdomainsresponsedto.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 {
+  DomainResponseDto,
+  DomainResponseDto$inboundSchema,
+} from "./domainresponsedto.js";
+
+export type ListDomainsResponseDto = {
+  /**
+   * List of returned domains
+   */
+  data: Array<DomainResponseDto>;
+  /**
+   * The cursor for the next page of results, or null if there are no more pages.
+   */
+  next: string | null;
+  /**
+   * 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 */
+export const ListDomainsResponseDto$inboundSchema: z.ZodType<
+  ListDomainsResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(DomainResponseDto$inboundSchema),
+  next: z.nullable(z.string()),
+  previous: z.nullable(z.string()),
+  totalCount: z.number(),
+  totalCountCapped: z.boolean(),
+});
+
+export function listDomainsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDomainsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDomainsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDomainsResponseDto' from JSON`,
+  );
+}

package/src/models/components/marksubscribernotificationsasseendto.ts

@@ -4,15 +4,20 @@
 
 import * as z from "zod/v3";
 
+/**
+ * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
+ */
+export type MarkSubscriberNotificationsAsSeenDtoTags = {};
+
 export type MarkSubscriberNotificationsAsSeenDto = {
   /**
    * Specific notification IDs to mark as seen
    */
   notificationIds?: Array<string> | undefined;
   /**
-   * Filter notifications by workflow tags
+   * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
    */
-  tags?: Array<string> | undefined;
+  tags?: MarkSubscriberNotificationsAsSeenDtoTags | undefined;
   /**
    * Filter notifications by data attributes (JSON string)
    */
@@ -23,10 +28,31 @@ export type MarkSubscriberNotificationsAsSeenDto = {
   contextKeys?: Array<string> | undefined;
 };
 
+/** @internal */
+export type MarkSubscriberNotificationsAsSeenDtoTags$Outbound = {};
+
+/** @internal */
+export const MarkSubscriberNotificationsAsSeenDtoTags$outboundSchema: z.ZodType<
+  MarkSubscriberNotificationsAsSeenDtoTags$Outbound,
+  z.ZodTypeDef,
+  MarkSubscriberNotificationsAsSeenDtoTags
+> = z.object({});
+
+export function markSubscriberNotificationsAsSeenDtoTagsToJSON(
+  markSubscriberNotificationsAsSeenDtoTags:
+    MarkSubscriberNotificationsAsSeenDtoTags,
+): string {
+  return JSON.stringify(
+    MarkSubscriberNotificationsAsSeenDtoTags$outboundSchema.parse(
+      markSubscriberNotificationsAsSeenDtoTags,
+    ),
+  );
+}
+
 /** @internal */
 export type MarkSubscriberNotificationsAsSeenDto$Outbound = {
   notificationIds?: Array<string> | undefined;
-  tags?: Array<string> | undefined;
+  tags?: MarkSubscriberNotificationsAsSeenDtoTags$Outbound | undefined;
   data?: string | undefined;
   contextKeys?: Array<string> | undefined;
 };
@@ -38,7 +64,8 @@ export const MarkSubscriberNotificationsAsSeenDto$outboundSchema: z.ZodType<
   MarkSubscriberNotificationsAsSeenDto
 > = z.object({
   notificationIds: z.array(z.string()).optional(),
-  tags: z.array(z.string()).optional(),
+  tags: z.lazy(() => MarkSubscriberNotificationsAsSeenDtoTags$outboundSchema)
+    .optional(),
   data: z.string().optional(),
   contextKeys: z.array(z.string()).optional(),
 });

package/src/models/components/providersidenum.ts

@@ -30,6 +30,7 @@ export const ProvidersIdEnum = {
   Sparkpost: "sparkpost",
   EmailWebhook: "email-webhook",
   Braze: "braze",
+  NovuEmailAgent: "novu-email-agent",
   Nexmo: "nexmo",
   Plivo: "plivo",
   Sms77: "sms77",

package/src/models/components/testdomainrouteagentresultdto.ts

@@ -0,0 +1,62 @@
+/*
+ * 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";
+
+/**
+ * Parsed JSON body from the agent webhook response when JSON.
+ */
+export type AgentReply = {};
+
+export type TestDomainRouteAgentResultDto = {
+  agentId: string;
+  httpStatus: number;
+  /**
+   * Parsed JSON body from the agent webhook response when JSON.
+   */
+  agentReply?: AgentReply | undefined;
+  latencyMs: number;
+};
+
+/** @internal */
+export const AgentReply$inboundSchema: z.ZodType<
+  AgentReply,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function agentReplyFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentReply, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentReply$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentReply' from JSON`,
+  );
+}
+
+/** @internal */
+export const TestDomainRouteAgentResultDto$inboundSchema: z.ZodType<
+  TestDomainRouteAgentResultDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agentId: z.string(),
+  httpStatus: z.number(),
+  agentReply: z.lazy(() => AgentReply$inboundSchema).optional(),
+  latencyMs: z.number(),
+});
+
+export function testDomainRouteAgentResultDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TestDomainRouteAgentResultDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TestDomainRouteAgentResultDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TestDomainRouteAgentResultDto' from JSON`,
+  );
+}

package/src/models/components/testdomainroutedto.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  TestDomainRouteFromDto,
+  TestDomainRouteFromDto$Outbound,
+  TestDomainRouteFromDto$outboundSchema,
+} from "./testdomainroutefromdto.js";
+
+export type TestDomainRouteDto = {
+  from: TestDomainRouteFromDto;
+  subject: string;
+  text?: string | undefined;
+  html?: string | undefined;
+  /**
+   * When true, returns the payload that would be delivered without invoking outbound webhooks or the agent HTTP endpoint.
+   */
+  dryRun?: boolean | undefined;
+};
+
+/** @internal */
+export type TestDomainRouteDto$Outbound = {
+  from: TestDomainRouteFromDto$Outbound;
+  subject: string;
+  text?: string | undefined;
+  html?: string | undefined;
+  dryRun?: boolean | undefined;
+};
+
+/** @internal */
+export const TestDomainRouteDto$outboundSchema: z.ZodType<
+  TestDomainRouteDto$Outbound,
+  z.ZodTypeDef,
+  TestDomainRouteDto
+> = z.object({
+  from: TestDomainRouteFromDto$outboundSchema,
+  subject: z.string(),
+  text: z.string().optional(),
+  html: z.string().optional(),
+  dryRun: z.boolean().optional(),
+});
+
+export function testDomainRouteDtoToJSON(
+  testDomainRouteDto: TestDomainRouteDto,
+): string {
+  return JSON.stringify(
+    TestDomainRouteDto$outboundSchema.parse(testDomainRouteDto),
+  );
+}

package/src/models/components/testdomainroutefromdto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type TestDomainRouteFromDto = {
+  address: string;
+  name?: string | undefined;
+};
+
+/** @internal */
+export type TestDomainRouteFromDto$Outbound = {
+  address: string;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const TestDomainRouteFromDto$outboundSchema: z.ZodType<
+  TestDomainRouteFromDto$Outbound,
+  z.ZodTypeDef,
+  TestDomainRouteFromDto
+> = z.object({
+  address: z.string(),
+  name: z.string().optional(),
+});
+
+export function testDomainRouteFromDtoToJSON(
+  testDomainRouteFromDto: TestDomainRouteFromDto,
+): string {
+  return JSON.stringify(
+    TestDomainRouteFromDto$outboundSchema.parse(testDomainRouteFromDto),
+  );
+}

package/src/models/components/testdomainrouteresponsedto.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TestDomainRouteAgentResultDto,
+  TestDomainRouteAgentResultDto$inboundSchema,
+} from "./testdomainrouteagentresultdto.js";
+import {
+  TestDomainRouteWebhookResultDto,
+  TestDomainRouteWebhookResultDto$inboundSchema,
+} from "./testdomainroutewebhookresultdto.js";
+
+export const DomainStatus = {
+  Pending: "pending",
+  Verified: "verified",
+} as const;
+export type DomainStatus = ClosedEnum<typeof DomainStatus>;
+
+export const TestDomainRouteResponseDtoType = {
+  Agent: "agent",
+  Webhook: "webhook",
+} as const;
+export type TestDomainRouteResponseDtoType = ClosedEnum<
+  typeof TestDomainRouteResponseDtoType
+>;
+
+/**
+ * The outbound payload (dry-run only).
+ */
+export type Payload = {};
+
+export type TestDomainRouteResponseDto = {
+  matched: boolean;
+  dryRun: boolean;
+  domainStatus?: DomainStatus | undefined;
+  mxRecordConfigured?: boolean | undefined;
+  type?: TestDomainRouteResponseDtoType | undefined;
+  /**
+   * Human-readable delivery target summary in dry-run mode.
+   */
+  wouldDeliverTo?: string | undefined;
+  /**
+   * The outbound payload (dry-run only).
+   */
+  payload?: Payload | undefined;
+  webhook?: TestDomainRouteWebhookResultDto | undefined;
+  agent?: TestDomainRouteAgentResultDto | undefined;
+};
+
+/** @internal */
+export const DomainStatus$inboundSchema: z.ZodNativeEnum<typeof DomainStatus> =
+  z.nativeEnum(DomainStatus);
+
+/** @internal */
+export const TestDomainRouteResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof TestDomainRouteResponseDtoType
+> = z.nativeEnum(TestDomainRouteResponseDtoType);
+
+/** @internal */
+export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
+  z.object({});
+
+export function payloadFromJSON(
+  jsonString: string,
+): SafeParseResult<Payload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payload' from JSON`,
+  );
+}
+
+/** @internal */
+export const TestDomainRouteResponseDto$inboundSchema: z.ZodType<
+  TestDomainRouteResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  matched: z.boolean(),
+  dryRun: z.boolean(),
+  domainStatus: DomainStatus$inboundSchema.optional(),
+  mxRecordConfigured: z.boolean().optional(),
+  type: TestDomainRouteResponseDtoType$inboundSchema.optional(),
+  wouldDeliverTo: z.string().optional(),
+  payload: z.lazy(() => Payload$inboundSchema).optional(),
+  webhook: TestDomainRouteWebhookResultDto$inboundSchema.optional(),
+  agent: TestDomainRouteAgentResultDto$inboundSchema.optional(),
+});
+
+export function testDomainRouteResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TestDomainRouteResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TestDomainRouteResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TestDomainRouteResponseDto' from JSON`,
+  );
+}

package/src/models/components/testdomainroutewebhookresultdto.ts

@@ -0,0 +1,36 @@
+/*
+ * 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";
+
+export type TestDomainRouteWebhookResultDto = {
+  /**
+   * True when outbound webhooks are disabled for this environment (nothing was emitted).
+   */
+  skipped?: boolean | undefined;
+  latencyMs: number;
+};
+
+/** @internal */
+export const TestDomainRouteWebhookResultDto$inboundSchema: z.ZodType<
+  TestDomainRouteWebhookResultDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skipped: z.boolean().optional(),
+  latencyMs: z.number(),
+});
+
+export function testDomainRouteWebhookResultDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TestDomainRouteWebhookResultDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TestDomainRouteWebhookResultDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TestDomainRouteWebhookResultDto' from JSON`,
+  );
+}

package/src/models/components/updateallsubscribernotificationsdto.ts

@@ -4,11 +4,16 @@
 
 import * as z from "zod/v3";
 
+/**
+ * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
+ */
+export type Tags = {};
+
 export type UpdateAllSubscriberNotificationsDto = {
   /**
-   * Filter notifications by workflow tags
+   * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
    */
-  tags?: Array<string> | undefined;
+  tags?: Tags | undefined;
   /**
    * Filter notifications by data attributes (JSON string)
    */
@@ -19,9 +24,20 @@ export type UpdateAllSubscriberNotificationsDto = {
   contextKeys?: Array<string> | undefined;
 };
 
+/** @internal */
+export type Tags$Outbound = {};
+
+/** @internal */
+export const Tags$outboundSchema: z.ZodType<Tags$Outbound, z.ZodTypeDef, Tags> =
+  z.object({});
+
+export function tagsToJSON(tags: Tags): string {
+  return JSON.stringify(Tags$outboundSchema.parse(tags));
+}
+
 /** @internal */
 export type UpdateAllSubscriberNotificationsDto$Outbound = {
-  tags?: Array<string> | undefined;
+  tags?: Tags$Outbound | undefined;
   data?: string | undefined;
   contextKeys?: Array<string> | undefined;
 };
@@ -32,7 +48,7 @@ export const UpdateAllSubscriberNotificationsDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateAllSubscriberNotificationsDto
 > = z.object({
-  tags: z.array(z.string()).optional(),
+  tags: z.lazy(() => Tags$outboundSchema).optional(),
   data: z.string().optional(),
   contextKeys: z.array(z.string()).optional(),
 });

package/src/models/components/updatedomaindto.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UpdateDomainDto = {
+  /**
+   * Replaces domain metadata when provided (max 10 keys, 500 characters total for keys+values).
+   */
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export type UpdateDomainDto$Outbound = {
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const UpdateDomainDto$outboundSchema: z.ZodType<
+  UpdateDomainDto$Outbound,
+  z.ZodTypeDef,
+  UpdateDomainDto
+> = z.object({
+  data: z.record(z.string()).optional(),
+});
+
+export function updateDomainDtoToJSON(
+  updateDomainDto: UpdateDomainDto,
+): string {
+  return JSON.stringify(UpdateDomainDto$outboundSchema.parse(updateDomainDto));
+}

package/src/models/components/updatedomainroutedto.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const UpdateDomainRouteDtoType = {
+  Agent: "agent",
+  Webhook: "webhook",
+} as const;
+export type UpdateDomainRouteDtoType = ClosedEnum<
+  typeof UpdateDomainRouteDtoType
+>;
+
+export type UpdateDomainRouteDto = {
+  /**
+   * Agent identifier; required when type is agent, ignored when type is webhook.
+   */
+  agentId?: string | undefined;
+  type?: UpdateDomainRouteDtoType | undefined;
+  /**
+   * Replaces route metadata when provided (max 10 keys, 500 characters total for keys+values).
+   */
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const UpdateDomainRouteDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateDomainRouteDtoType
+> = z.nativeEnum(UpdateDomainRouteDtoType);
+
+/** @internal */
+export type UpdateDomainRouteDto$Outbound = {
+  agentId?: string | undefined;
+  type?: string | undefined;
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const UpdateDomainRouteDto$outboundSchema: z.ZodType<
+  UpdateDomainRouteDto$Outbound,
+  z.ZodTypeDef,
+  UpdateDomainRouteDto
+> = z.object({
+  agentId: z.string().optional(),
+  type: UpdateDomainRouteDtoType$outboundSchema.optional(),
+  data: z.record(z.string()).optional(),
+});
+
+export function updateDomainRouteDtoToJSON(
+  updateDomainRouteDto: UpdateDomainRouteDto,
+): string {
+  return JSON.stringify(
+    UpdateDomainRouteDto$outboundSchema.parse(updateDomainRouteDto),
+  );
+}