@novu/api 3.14.4 → 3.15.1-rc.1

package/src/models/components/credentialsdto.ts

@@ -57,6 +57,8 @@ export type CredentialsDto = {
   senderId?: string | undefined;
   tenantId?: string | undefined;
   appIOBaseUrl?: string | undefined;
+  signingSecret?: string | undefined;
+  outboundIntegrationId?: string | undefined;
 };
 
 /** @internal */
@@ -140,6 +142,8 @@ export const CredentialsDto$inboundSchema: z.ZodType<
   senderId: z.string().optional(),
   tenantId: z.string().optional(),
   AppIOBaseUrl: z.string().optional(),
+  signingSecret: z.string().optional(),
+  outboundIntegrationId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "AppIOBaseUrl": "appIOBaseUrl",
@@ -193,6 +197,8 @@ export type CredentialsDto$Outbound = {
   senderId?: string | undefined;
   tenantId?: string | undefined;
   AppIOBaseUrl?: string | undefined;
+  signingSecret?: string | undefined;
+  outboundIntegrationId?: string | undefined;
 };
 
 /** @internal */
@@ -247,6 +253,8 @@ export const CredentialsDto$outboundSchema: z.ZodType<
   senderId: z.string().optional(),
   tenantId: z.string().optional(),
   appIOBaseUrl: z.string().optional(),
+  signingSecret: z.string().optional(),
+  outboundIntegrationId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     appIOBaseUrl: "AppIOBaseUrl",

package/src/models/components/diagnosedomainresponsedto.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 {
+  DomainDiagnosticCheckDto,
+  DomainDiagnosticCheckDto$inboundSchema,
+} from "./domaindiagnosticcheckdto.js";
+import {
+  DomainDiagnosticIssueDto,
+  DomainDiagnosticIssueDto$inboundSchema,
+} from "./domaindiagnosticissuedto.js";
+
+export type DiagnoseDomainResponseDto = {
+  /**
+   * True when there are no error-severity issues
+   */
+  ok: boolean;
+  /**
+   * ISO timestamp when the diagnostic run finished
+   */
+  runAt: string;
+  checks: Array<DomainDiagnosticCheckDto>;
+  issues: Array<DomainDiagnosticIssueDto>;
+};
+
+/** @internal */
+export const DiagnoseDomainResponseDto$inboundSchema: z.ZodType<
+  DiagnoseDomainResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ok: z.boolean(),
+  runAt: z.string(),
+  checks: z.array(DomainDiagnosticCheckDto$inboundSchema),
+  issues: z.array(DomainDiagnosticIssueDto$inboundSchema),
+});
+
+export function diagnoseDomainResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DiagnoseDomainResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiagnoseDomainResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiagnoseDomainResponseDto' from JSON`,
+  );
+}

package/src/models/components/domainconnectapplyurlresponsedto.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 DomainConnectApplyUrlResponseDto = {
+  applyUrl: string;
+  providerName: string;
+  redirectUri: string;
+};
+
+/** @internal */
+export const DomainConnectApplyUrlResponseDto$inboundSchema: z.ZodType<
+  DomainConnectApplyUrlResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applyUrl: z.string(),
+  providerName: z.string(),
+  redirectUri: z.string(),
+});
+
+export function domainConnectApplyUrlResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DomainConnectApplyUrlResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DomainConnectApplyUrlResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DomainConnectApplyUrlResponseDto' from JSON`,
+  );
+}

package/src/models/components/domainconnectstatusresponsedto.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 {
+  ExpectedDnsRecordDto,
+  ExpectedDnsRecordDto$inboundSchema,
+} from "./expecteddnsrecorddto.js";
+
+export const ReasonCode = {
+  Disabled: "disabled",
+  DiscoveryNotConfigured: "discovery_not_configured",
+  UnsupportedProvider: "unsupported_provider",
+  IncompleteConfiguration: "incomplete_configuration",
+  ProviderSettingsUnavailable: "provider_settings_unavailable",
+  UntrustedProviderFlow: "untrusted_provider_flow",
+  TemplateNotOnboarded: "template_not_onboarded",
+} as const;
+export type ReasonCode = ClosedEnum<typeof ReasonCode>;
+
+export type DomainConnectStatusResponseDto = {
+  available: boolean;
+  providerName?: string | undefined;
+  providerId?: string | undefined;
+  reason?: string | undefined;
+  reasonCode?: ReasonCode | undefined;
+  manualRecords: Array<ExpectedDnsRecordDto>;
+};
+
+/** @internal */
+export const ReasonCode$inboundSchema: z.ZodNativeEnum<typeof ReasonCode> = z
+  .nativeEnum(ReasonCode);
+
+/** @internal */
+export const DomainConnectStatusResponseDto$inboundSchema: z.ZodType<
+  DomainConnectStatusResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  available: z.boolean(),
+  providerName: z.string().optional(),
+  providerId: z.string().optional(),
+  reason: z.string().optional(),
+  reasonCode: ReasonCode$inboundSchema.optional(),
+  manualRecords: z.array(ExpectedDnsRecordDto$inboundSchema),
+});
+
+export function domainConnectStatusResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DomainConnectStatusResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DomainConnectStatusResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DomainConnectStatusResponseDto' from JSON`,
+  );
+}

package/src/models/components/domaindiagnosticcheckdto.ts

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+export const Code = {
+  MxMissing: "mx_missing",
+  MxWrongTarget: "mx_wrong_target",
+  MxLowPriority: "mx_low_priority",
+  ApexCnameCollision: "apex_cname_collision",
+  DnsblListed: "dnsbl_listed",
+} as const;
+export type Code = ClosedEnum<typeof Code>;
+
+export const DomainDiagnosticCheckDtoStatus = {
+  Pass: "pass",
+  Fail: "fail",
+  Skipped: "skipped",
+} as const;
+export type DomainDiagnosticCheckDtoStatus = ClosedEnum<
+  typeof DomainDiagnosticCheckDtoStatus
+>;
+
+export type DomainDiagnosticCheckDto = {
+  code: Code;
+  status: DomainDiagnosticCheckDtoStatus;
+  /**
+   * Round-trip time for this check in milliseconds
+   */
+  latencyMs: number;
+};
+
+/** @internal */
+export const Code$inboundSchema: z.ZodNativeEnum<typeof Code> = z.nativeEnum(
+  Code,
+);
+
+/** @internal */
+export const DomainDiagnosticCheckDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof DomainDiagnosticCheckDtoStatus
+> = z.nativeEnum(DomainDiagnosticCheckDtoStatus);
+
+/** @internal */
+export const DomainDiagnosticCheckDto$inboundSchema: z.ZodType<
+  DomainDiagnosticCheckDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: Code$inboundSchema,
+  status: DomainDiagnosticCheckDtoStatus$inboundSchema,
+  latencyMs: z.number(),
+});
+
+export function domainDiagnosticCheckDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DomainDiagnosticCheckDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DomainDiagnosticCheckDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DomainDiagnosticCheckDto' from JSON`,
+  );
+}

package/src/models/components/domaindiagnosticissuedto.ts

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+export const DomainDiagnosticIssueDtoCode = {
+  MxMissing: "mx_missing",
+  MxWrongTarget: "mx_wrong_target",
+  MxLowPriority: "mx_low_priority",
+  ApexCnameCollision: "apex_cname_collision",
+  DnsblListed: "dnsbl_listed",
+} as const;
+export type DomainDiagnosticIssueDtoCode = ClosedEnum<
+  typeof DomainDiagnosticIssueDtoCode
+>;
+
+export const Severity = {
+  Warn: "warn",
+  Error: "error",
+} as const;
+export type Severity = ClosedEnum<typeof Severity>;
+
+export type DomainDiagnosticIssueDto = {
+  code: DomainDiagnosticIssueDtoCode;
+  severity: Severity;
+  message: string;
+  /**
+   * Plain-language remediation guidance
+   */
+  fix: string;
+};
+
+/** @internal */
+export const DomainDiagnosticIssueDtoCode$inboundSchema: z.ZodNativeEnum<
+  typeof DomainDiagnosticIssueDtoCode
+> = z.nativeEnum(DomainDiagnosticIssueDtoCode);
+
+/** @internal */
+export const Severity$inboundSchema: z.ZodNativeEnum<typeof Severity> = z
+  .nativeEnum(Severity);
+
+/** @internal */
+export const DomainDiagnosticIssueDto$inboundSchema: z.ZodType<
+  DomainDiagnosticIssueDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: DomainDiagnosticIssueDtoCode$inboundSchema,
+  severity: Severity$inboundSchema,
+  message: z.string(),
+  fix: z.string(),
+});
+
+export function domainDiagnosticIssueDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DomainDiagnosticIssueDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DomainDiagnosticIssueDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DomainDiagnosticIssueDto' from JSON`,
+  );
+}

package/src/models/components/domainresponsedto.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+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 {
+  ExpectedDnsRecordDto,
+  ExpectedDnsRecordDto$inboundSchema,
+} from "./expecteddnsrecorddto.js";
+
+export const DomainResponseDtoStatus = {
+  Pending: "pending",
+  Verified: "verified",
+} as const;
+export type DomainResponseDtoStatus = ClosedEnum<
+  typeof DomainResponseDtoStatus
+>;
+
+export type DomainResponseDto = {
+  id: string;
+  name: string;
+  status: DomainResponseDtoStatus;
+  mxRecordConfigured: boolean;
+  dnsProvider?: string | undefined;
+  environmentId: string;
+  organizationId: string;
+  createdAt: string;
+  updatedAt: string;
+  expectedDnsRecords?: Array<ExpectedDnsRecordDto> | undefined;
+  /**
+   * String key-value metadata (max 10 keys, 500 characters total when set via API).
+   */
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const DomainResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof DomainResponseDtoStatus
+> = z.nativeEnum(DomainResponseDtoStatus);
+
+/** @internal */
+export const DomainResponseDto$inboundSchema: z.ZodType<
+  DomainResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  name: z.string(),
+  status: DomainResponseDtoStatus$inboundSchema,
+  mxRecordConfigured: z.boolean(),
+  dnsProvider: z.string().optional(),
+  _environmentId: z.string(),
+  _organizationId: z.string(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  expectedDnsRecords: z.array(ExpectedDnsRecordDto$inboundSchema).optional(),
+  data: z.record(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_environmentId": "environmentId",
+    "_organizationId": "organizationId",
+  });
+});
+
+export function domainResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DomainResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DomainResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DomainResponseDto' from JSON`,
+  );
+}

package/src/models/components/domainroutedto.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 DomainRouteDtoType = {
+  Agent: "agent",
+  Webhook: "webhook",
+} as const;
+export type DomainRouteDtoType = ClosedEnum<typeof DomainRouteDtoType>;
+
+export type DomainRouteDto = {
+  /**
+   * Inbox address local part (e.g. "support", "*")
+   */
+  address: string;
+  /**
+   * Agent identifier; required when type is agent, unused for webhook
+   */
+  agentId?: string | undefined;
+  type: DomainRouteDtoType;
+  /**
+   * Optional string key-value metadata (max 10 keys, 500 characters total for keys+values).
+   */
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const DomainRouteDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof DomainRouteDtoType
+> = z.nativeEnum(DomainRouteDtoType);
+
+/** @internal */
+export type DomainRouteDto$Outbound = {
+  address: string;
+  agentId?: string | undefined;
+  type: string;
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const DomainRouteDto$outboundSchema: z.ZodType<
+  DomainRouteDto$Outbound,
+  z.ZodTypeDef,
+  DomainRouteDto
+> = z.object({
+  address: z.string(),
+  agentId: z.string().optional(),
+  type: DomainRouteDtoType$outboundSchema,
+  data: z.record(z.string()).optional(),
+});
+
+export function domainRouteDtoToJSON(domainRouteDto: DomainRouteDto): string {
+  return JSON.stringify(DomainRouteDto$outboundSchema.parse(domainRouteDto));
+}

package/src/models/components/domainrouteresponsedto.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+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";
+
+export const DomainRouteResponseDtoType = {
+  Agent: "agent",
+  Webhook: "webhook",
+} as const;
+export type DomainRouteResponseDtoType = ClosedEnum<
+  typeof DomainRouteResponseDtoType
+>;
+
+export type DomainRouteResponseDto = {
+  id: string;
+  domainId: string;
+  address: string;
+  /**
+   * Internal id of the destination agent. Only present for agent routes.
+   */
+  agentId?: string | undefined;
+  type: DomainRouteResponseDtoType;
+  environmentId: string;
+  organizationId: string;
+  createdAt: string;
+  updatedAt: string;
+  /**
+   * String key-value metadata (max 10 keys, 500 characters total when set via API).
+   */
+  data?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const DomainRouteResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof DomainRouteResponseDtoType
+> = z.nativeEnum(DomainRouteResponseDtoType);
+
+/** @internal */
+export const DomainRouteResponseDto$inboundSchema: z.ZodType<
+  DomainRouteResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  _domainId: z.string(),
+  address: z.string(),
+  agentId: z.string().optional(),
+  type: DomainRouteResponseDtoType$inboundSchema,
+  _environmentId: z.string(),
+  _organizationId: z.string(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  data: z.record(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_domainId": "domainId",
+    "_environmentId": "environmentId",
+    "_organizationId": "organizationId",
+  });
+});
+
+export function domainRouteResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DomainRouteResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DomainRouteResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DomainRouteResponseDto' from JSON`,
+  );
+}

package/src/models/components/duplicatelayoutdto.ts

@@ -9,6 +9,10 @@ export type DuplicateLayoutDto = {
    * Name of the layout
    */
   name: string;
+  /**
+   * Identifier for the duplicated layout. When omitted, it is derived from the name.
+   */
+  layoutId?: string | undefined;
   /**
    * Enable or disable translations for this layout
    */
@@ -18,6 +22,7 @@ export type DuplicateLayoutDto = {
 /** @internal */
 export type DuplicateLayoutDto$Outbound = {
   name: string;
+  layoutId?: string | undefined;
   isTranslationEnabled: boolean;
 };
 
@@ -28,6 +33,7 @@ export const DuplicateLayoutDto$outboundSchema: z.ZodType<
   DuplicateLayoutDto
 > = z.object({
   name: z.string(),
+  layoutId: z.string().optional(),
   isTranslationEnabled: z.boolean().default(false),
 });
 

package/src/models/components/expecteddnsrecorddto.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 ExpectedDnsRecordDto = {
+  type: string;
+  name: string;
+  content: string;
+  ttl: string;
+  priority?: number | undefined;
+};
+
+/** @internal */
+export const ExpectedDnsRecordDto$inboundSchema: z.ZodType<
+  ExpectedDnsRecordDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.string(),
+  name: z.string(),
+  content: z.string(),
+  ttl: z.string(),
+  priority: z.number().optional(),
+});
+
+export function expectedDnsRecordDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ExpectedDnsRecordDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExpectedDnsRecordDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExpectedDnsRecordDto' from JSON`,
+  );
+}