@novu/api 1.3.0 → 1.5.0

package/src/models/components/workflowresponsedtosortfield.ts

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

package/src/models/components/workflowstatusenum.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Status of the workflow
+ */
+export const WorkflowStatusEnum = {
+  Active: "ACTIVE",
+  Inactive: "INACTIVE",
+  Error: "ERROR",
+} as const;
+/**
+ * Status of the workflow
+ */
+export type WorkflowStatusEnum = ClosedEnum<typeof WorkflowStatusEnum>;
+
+/** @internal */
+export const WorkflowStatusEnum$inboundSchema: z.ZodNativeEnum<
+  typeof WorkflowStatusEnum
+> = z.nativeEnum(WorkflowStatusEnum);
+
+/** @internal */
+export const WorkflowStatusEnum$outboundSchema: z.ZodNativeEnum<
+  typeof WorkflowStatusEnum
+> = WorkflowStatusEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WorkflowStatusEnum$ {
+  /** @deprecated use `WorkflowStatusEnum$inboundSchema` instead. */
+  export const inboundSchema = WorkflowStatusEnum$inboundSchema;
+  /** @deprecated use `WorkflowStatusEnum$outboundSchema` instead. */
+  export const outboundSchema = WorkflowStatusEnum$outboundSchema;
+}

package/src/models/errors/errordto.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { NovuError } from "./novuerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 export type Five = string | number | boolean | { [k: string]: any };
@@ -58,11 +59,7 @@ export type ErrorDtoData = {
   errorId?: string | undefined;
 };
 
-export class ErrorDto extends Error {
-  /**
-   * HTTP status code of the error response.
-   */
-  statusCode: number;
+export class ErrorDto extends NovuError {
   /**
    * Timestamp of when the error occurred.
    */
@@ -86,14 +83,15 @@ export class ErrorDto extends Error {
   /** The original data that was passed to this error instance. */
   data$: ErrorDtoData;
 
-  constructor(err: ErrorDtoData) {
+  constructor(
+    err: ErrorDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
-    this.statusCode = err.statusCode;
     this.timestamp = err.timestamp;
     this.path = err.path;
     if (err.ctx != null) this.ctx = err.ctx;
@@ -269,9 +267,16 @@ export const ErrorDto$inboundSchema: z.ZodType<
   ).optional(),
   ctx: z.record(z.any()).optional(),
   errorId: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new ErrorDto(v);
+    return new ErrorDto(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/index.ts

@@ -5,6 +5,7 @@
 export * from "./errordto.js";
 export * from "./httpclienterrors.js";
 export * from "./payloadvalidationexceptiondto.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./validationerrordto.js";

package/src/models/errors/novuerror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class NovuError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "NovuError";
+  }
+}

package/src/models/errors/payloadvalidationexceptiondto.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
+import { NovuError } from "./novuerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 export type MessagePayloadValidationExceptionDto5 =
@@ -80,11 +81,7 @@ export type PayloadValidationExceptionDtoData = {
   schema?: Schema | undefined;
 };
 
-export class PayloadValidationExceptionDto extends Error {
-  /**
-   * HTTP status code of the error response.
-   */
-  statusCode: number;
+export class PayloadValidationExceptionDto extends NovuError {
   /**
    * Timestamp of when the error occurred.
    */
@@ -120,14 +117,15 @@ export class PayloadValidationExceptionDto extends Error {
   /** The original data that was passed to this error instance. */
   data$: PayloadValidationExceptionDtoData;
 
-  constructor(err: PayloadValidationExceptionDtoData) {
+  constructor(
+    err: PayloadValidationExceptionDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
-    this.statusCode = err.statusCode;
     this.timestamp = err.timestamp;
     this.path = err.path;
     if (err.ctx != null) this.ctx = err.ctx;
@@ -396,9 +394,16 @@ export const PayloadValidationExceptionDto$inboundSchema: z.ZodType<
   type: z.string(),
   errors: z.array(components.PayloadValidationErrorDto$inboundSchema),
   schema: z.lazy(() => Schema$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new PayloadValidationExceptionDto(v);
+    return new PayloadValidationExceptionDto(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { NovuError } from "./novuerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends NovuError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkerror.ts

@@ -2,41 +2,39 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class SDKError extends Error {
-  /**
-   * HTTP status code
-   */
-  public readonly statusCode: number;
-  /**
-   * HTTP content type
-   */
-  public readonly contentType: string;
-  /**
-   * HTTP body
-   */
-  public readonly body: string;
-  /**
-   * Raw response
-   */
-  public readonly rawResponse: Response;
+import { NovuError } from "./novuerror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class SDKError extends NovuError {
   constructor(
     message: string,
-    rawResponse: Response,
-    body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-    super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
-    );
-
-    this.body = body;
-    this.rawResponse = rawResponse;
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "SDKError";
   }
 }

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/validationerrordto.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
+import { NovuError } from "./novuerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 export type Message5 = string | number | boolean | { [k: string]: any };
@@ -63,11 +64,7 @@ export type ValidationErrorDtoData = {
   errors: { [k: string]: components.ConstraintValidation };
 };
 
-export class ValidationErrorDto extends Error {
-  /**
-   * HTTP status code of the error response.
-   */
-  statusCode: number;
+export class ValidationErrorDto extends NovuError {
   /**
    * Timestamp of when the error occurred.
    */
@@ -95,14 +92,15 @@ export class ValidationErrorDto extends Error {
   /** The original data that was passed to this error instance. */
   data$: ValidationErrorDtoData;
 
-  constructor(err: ValidationErrorDtoData) {
+  constructor(
+    err: ValidationErrorDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
-    this.statusCode = err.statusCode;
     this.timestamp = err.timestamp;
     this.path = err.path;
     if (err.ctx != null) this.ctx = err.ctx;
@@ -301,9 +299,16 @@ export const ValidationErrorDto$inboundSchema: z.ZodType<
   ctx: z.record(z.any()).optional(),
   errorId: z.string().optional(),
   errors: z.record(components.ConstraintValidation$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new ValidationErrorDto(v);
+    return new ValidationErrorDto(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/operations/environmentscontrollergetenvironmenttags.ts

@@ -0,0 +1,186 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EnvironmentsControllerGetEnvironmentTagsRequest = {
+  /**
+   * Environment internal ID (MongoDB ObjectId) or identifier
+   */
+  environmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type EnvironmentsControllerGetEnvironmentTagsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.GetEnvironmentTagsDto>;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    environmentId: z.string(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
+  });
+
+/** @internal */
+export type EnvironmentsControllerGetEnvironmentTagsRequest$Outbound = {
+  environmentId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerGetEnvironmentTagsRequest
+  > = z.object({
+    environmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EnvironmentsControllerGetEnvironmentTagsRequest$ {
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsRequest$Outbound` instead. */
+  export type Outbound =
+    EnvironmentsControllerGetEnvironmentTagsRequest$Outbound;
+}
+
+export function environmentsControllerGetEnvironmentTagsRequestToJSON(
+  environmentsControllerGetEnvironmentTagsRequest:
+    EnvironmentsControllerGetEnvironmentTagsRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema.parse(
+      environmentsControllerGetEnvironmentTagsRequest,
+    ),
+  );
+}
+
+export function environmentsControllerGetEnvironmentTagsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerGetEnvironmentTagsRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerGetEnvironmentTagsRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerGetEnvironmentTagsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: z.array(components.GetEnvironmentTagsDto$inboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type EnvironmentsControllerGetEnvironmentTagsResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.GetEnvironmentTagsDto$Outbound>;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsResponse$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerGetEnvironmentTagsResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: z.array(components.GetEnvironmentTagsDto$outboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      headers: "Headers",
+      result: "Result",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EnvironmentsControllerGetEnvironmentTagsResponse$ {
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema;
+  /** @deprecated use `EnvironmentsControllerGetEnvironmentTagsResponse$Outbound` instead. */
+  export type Outbound =
+    EnvironmentsControllerGetEnvironmentTagsResponse$Outbound;
+}
+
+export function environmentsControllerGetEnvironmentTagsResponseToJSON(
+  environmentsControllerGetEnvironmentTagsResponse:
+    EnvironmentsControllerGetEnvironmentTagsResponse,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerGetEnvironmentTagsResponse$outboundSchema.parse(
+      environmentsControllerGetEnvironmentTagsResponse,
+    ),
+  );
+}
+
+export function environmentsControllerGetEnvironmentTagsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerGetEnvironmentTagsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerGetEnvironmentTagsResponse' from JSON`,
+  );
+}