@novu/api 0.0.1-alpha.99 → 0.0.2

package/src/models/errors/validationerrordto.ts

@@ -0,0 +1,299 @@
+/*
+ * 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 "./sdkvalidationerror.js";
+
+export type Value =
+  | string
+  | number
+  | boolean
+  | { [k: string]: any }
+  | Array<{ [k: string]: any }>;
+
+export type Errors = {
+  messages: Array<string>;
+  value:
+    | string
+    | number
+    | boolean
+    | { [k: string]: any }
+    | Array<{ [k: string]: any }>
+    | null;
+};
+
+export type ValidationErrorDtoData = {
+  /**
+   * HTTP status code of the error response.
+   */
+  statusCode: number;
+  /**
+   * Timestamp of when the error occurred.
+   */
+  timestamp: string;
+  /**
+   * The path where the error occurred.
+   */
+  path: string;
+  /**
+   * A detailed error message.
+   */
+  message: string;
+  /**
+   * Optional context object for additional error details.
+   */
+  ctx?: { [k: string]: any } | undefined;
+  /**
+   * Optional unique identifier for the error, useful for tracking using Sentry and
+   *
+   * @remarks
+   *       New Relic, only available for 500.
+   */
+  errorId?: string | undefined;
+  /**
+   * A record of validation errors keyed by field name
+   */
+  errors: { [k: string]: Errors };
+};
+
+export class ValidationErrorDto extends Error {
+  /**
+   * HTTP status code of the error response.
+   */
+  statusCode: number;
+  /**
+   * Timestamp of when the error occurred.
+   */
+  timestamp: string;
+  /**
+   * The path where the error occurred.
+   */
+  path: string;
+  /**
+   * Optional context object for additional error details.
+   */
+  ctx?: { [k: string]: any } | undefined;
+  /**
+   * Optional unique identifier for the error, useful for tracking using Sentry and
+   *
+   * @remarks
+   *       New Relic, only available for 500.
+   */
+  errorId?: string | undefined;
+  /**
+   * A record of validation errors keyed by field name
+   */
+  errors: { [k: string]: Errors };
+
+  /** The original data that was passed to this error instance. */
+  data$: ValidationErrorDtoData;
+
+  constructor(err: ValidationErrorDtoData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.statusCode = err.statusCode;
+    this.timestamp = err.timestamp;
+    this.path = err.path;
+    if (err.ctx != null) this.ctx = err.ctx;
+    if (err.errorId != null) this.errorId = err.errorId;
+    this.errors = err.errors;
+
+    this.name = "ValidationErrorDto";
+  }
+}
+
+/** @internal */
+export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
+  .union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.record(z.any()),
+    z.array(z.record(z.any())),
+  ]);
+
+/** @internal */
+export type Value$Outbound =
+  | string
+  | number
+  | boolean
+  | { [k: string]: any }
+  | Array<{ [k: string]: any }>;
+
+/** @internal */
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
+  z.ZodTypeDef,
+  Value
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.record(z.any()),
+  z.array(z.record(z.any())),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Value$ {
+  /** @deprecated use `Value$inboundSchema` instead. */
+  export const inboundSchema = Value$inboundSchema;
+  /** @deprecated use `Value$outboundSchema` instead. */
+  export const outboundSchema = Value$outboundSchema;
+  /** @deprecated use `Value$Outbound` instead. */
+  export type Outbound = Value$Outbound;
+}
+
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
+}
+
+export function valueFromJSON(
+  jsonString: string,
+): SafeParseResult<Value, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Value$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Value' from JSON`,
+  );
+}
+
+/** @internal */
+export const Errors$inboundSchema: z.ZodType<Errors, z.ZodTypeDef, unknown> = z
+  .object({
+    messages: z.array(z.string()),
+    value: z.nullable(
+      z.union([
+        z.string(),
+        z.number(),
+        z.boolean(),
+        z.record(z.any()),
+        z.array(z.record(z.any())),
+      ]),
+    ),
+  });
+
+/** @internal */
+export type Errors$Outbound = {
+  messages: Array<string>;
+  value:
+    | string
+    | number
+    | boolean
+    | { [k: string]: any }
+    | Array<{ [k: string]: any }>
+    | null;
+};
+
+/** @internal */
+export const Errors$outboundSchema: z.ZodType<
+  Errors$Outbound,
+  z.ZodTypeDef,
+  Errors
+> = z.object({
+  messages: z.array(z.string()),
+  value: z.nullable(
+    z.union([
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.record(z.any()),
+      z.array(z.record(z.any())),
+    ]),
+  ),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Errors$ {
+  /** @deprecated use `Errors$inboundSchema` instead. */
+  export const inboundSchema = Errors$inboundSchema;
+  /** @deprecated use `Errors$outboundSchema` instead. */
+  export const outboundSchema = Errors$outboundSchema;
+  /** @deprecated use `Errors$Outbound` instead. */
+  export type Outbound = Errors$Outbound;
+}
+
+export function errorsToJSON(errors: Errors): string {
+  return JSON.stringify(Errors$outboundSchema.parse(errors));
+}
+
+export function errorsFromJSON(
+  jsonString: string,
+): SafeParseResult<Errors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Errors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Errors' from JSON`,
+  );
+}
+
+/** @internal */
+export const ValidationErrorDto$inboundSchema: z.ZodType<
+  ValidationErrorDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  statusCode: z.number(),
+  timestamp: z.string(),
+  path: z.string(),
+  message: z.string(),
+  ctx: z.record(z.any()).optional(),
+  errorId: z.string().optional(),
+  errors: z.record(z.lazy(() => Errors$inboundSchema)),
+})
+  .transform((v) => {
+    return new ValidationErrorDto(v);
+  });
+
+/** @internal */
+export type ValidationErrorDto$Outbound = {
+  statusCode: number;
+  timestamp: string;
+  path: string;
+  message: string;
+  ctx?: { [k: string]: any } | undefined;
+  errorId?: string | undefined;
+  errors: { [k: string]: Errors$Outbound };
+};
+
+/** @internal */
+export const ValidationErrorDto$outboundSchema: z.ZodType<
+  ValidationErrorDto$Outbound,
+  z.ZodTypeDef,
+  ValidationErrorDto
+> = z.instanceof(ValidationErrorDto)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    statusCode: z.number(),
+    timestamp: z.string(),
+    path: z.string(),
+    message: z.string(),
+    ctx: z.record(z.any()).optional(),
+    errorId: z.string().optional(),
+    errors: z.record(z.lazy(() => Errors$outboundSchema)),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ValidationErrorDto$ {
+  /** @deprecated use `ValidationErrorDto$inboundSchema` instead. */
+  export const inboundSchema = ValidationErrorDto$inboundSchema;
+  /** @deprecated use `ValidationErrorDto$outboundSchema` instead. */
+  export const outboundSchema = ValidationErrorDto$outboundSchema;
+  /** @deprecated use `ValidationErrorDto$Outbound` instead. */
+  export type Outbound = ValidationErrorDto$Outbound;
+}

package/src/models/operations/eventscontrollerbroadcasteventtoall.ts

@@ -9,11 +9,98 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type EventsControllerBroadcastEventToAllRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto;
+};
+
 export type EventsControllerBroadcastEventToAllResponse = {
   headers: { [k: string]: Array<string> };
   result: components.TriggerEventResponseDto;
 };
 
+/** @internal */
+export const EventsControllerBroadcastEventToAllRequest$inboundSchema:
+  z.ZodType<EventsControllerBroadcastEventToAllRequest, z.ZodTypeDef, unknown> =
+    z.object({
+      "idempotency-key": z.string().optional(),
+      TriggerEventToAllRequestDto:
+        components.TriggerEventToAllRequestDto$inboundSchema,
+    }).transform((v) => {
+      return remap$(v, {
+        "idempotency-key": "idempotencyKey",
+        "TriggerEventToAllRequestDto": "triggerEventToAllRequestDto",
+      });
+    });
+
+/** @internal */
+export type EventsControllerBroadcastEventToAllRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  TriggerEventToAllRequestDto: components.TriggerEventToAllRequestDto$Outbound;
+};
+
+/** @internal */
+export const EventsControllerBroadcastEventToAllRequest$outboundSchema:
+  z.ZodType<
+    EventsControllerBroadcastEventToAllRequest$Outbound,
+    z.ZodTypeDef,
+    EventsControllerBroadcastEventToAllRequest
+  > = z.object({
+    idempotencyKey: z.string().optional(),
+    triggerEventToAllRequestDto:
+      components.TriggerEventToAllRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      triggerEventToAllRequestDto: "TriggerEventToAllRequestDto",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventsControllerBroadcastEventToAllRequest$ {
+  /** @deprecated use `EventsControllerBroadcastEventToAllRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    EventsControllerBroadcastEventToAllRequest$inboundSchema;
+  /** @deprecated use `EventsControllerBroadcastEventToAllRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    EventsControllerBroadcastEventToAllRequest$outboundSchema;
+  /** @deprecated use `EventsControllerBroadcastEventToAllRequest$Outbound` instead. */
+  export type Outbound = EventsControllerBroadcastEventToAllRequest$Outbound;
+}
+
+export function eventsControllerBroadcastEventToAllRequestToJSON(
+  eventsControllerBroadcastEventToAllRequest:
+    EventsControllerBroadcastEventToAllRequest,
+): string {
+  return JSON.stringify(
+    EventsControllerBroadcastEventToAllRequest$outboundSchema.parse(
+      eventsControllerBroadcastEventToAllRequest,
+    ),
+  );
+}
+
+export function eventsControllerBroadcastEventToAllRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EventsControllerBroadcastEventToAllRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EventsControllerBroadcastEventToAllRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EventsControllerBroadcastEventToAllRequest' from JSON`,
+  );
+}
+
 /** @internal */
 export const EventsControllerBroadcastEventToAllResponse$inboundSchema:
   z.ZodType<

package/src/models/operations/eventscontrollercancel.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EventsControllerCancelRequest = {
   transactionId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type EventsControllerCancelResponse = {
@@ -25,11 +29,17 @@ export const EventsControllerCancelRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   transactionId: z.string(),
+  "idempotency-key": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+  });
 });
 
 /** @internal */
 export type EventsControllerCancelRequest$Outbound = {
   transactionId: string;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -39,6 +49,11 @@ export const EventsControllerCancelRequest$outboundSchema: z.ZodType<
   EventsControllerCancelRequest
 > = z.object({
   transactionId: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
 });
 
 /**

package/src/models/operations/eventscontrollertrigger.ts

@@ -9,11 +9,88 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type EventsControllerTriggerRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  triggerEventRequestDto: components.TriggerEventRequestDto;
+};
+
 export type EventsControllerTriggerResponse = {
   headers: { [k: string]: Array<string> };
   result: components.TriggerEventResponseDto;
 };
 
+/** @internal */
+export const EventsControllerTriggerRequest$inboundSchema: z.ZodType<
+  EventsControllerTriggerRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "idempotency-key": z.string().optional(),
+  TriggerEventRequestDto: components.TriggerEventRequestDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+    "TriggerEventRequestDto": "triggerEventRequestDto",
+  });
+});
+
+/** @internal */
+export type EventsControllerTriggerRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  TriggerEventRequestDto: components.TriggerEventRequestDto$Outbound;
+};
+
+/** @internal */
+export const EventsControllerTriggerRequest$outboundSchema: z.ZodType<
+  EventsControllerTriggerRequest$Outbound,
+  z.ZodTypeDef,
+  EventsControllerTriggerRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  triggerEventRequestDto: components.TriggerEventRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    triggerEventRequestDto: "TriggerEventRequestDto",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventsControllerTriggerRequest$ {
+  /** @deprecated use `EventsControllerTriggerRequest$inboundSchema` instead. */
+  export const inboundSchema = EventsControllerTriggerRequest$inboundSchema;
+  /** @deprecated use `EventsControllerTriggerRequest$outboundSchema` instead. */
+  export const outboundSchema = EventsControllerTriggerRequest$outboundSchema;
+  /** @deprecated use `EventsControllerTriggerRequest$Outbound` instead. */
+  export type Outbound = EventsControllerTriggerRequest$Outbound;
+}
+
+export function eventsControllerTriggerRequestToJSON(
+  eventsControllerTriggerRequest: EventsControllerTriggerRequest,
+): string {
+  return JSON.stringify(
+    EventsControllerTriggerRequest$outboundSchema.parse(
+      eventsControllerTriggerRequest,
+    ),
+  );
+}
+
+export function eventsControllerTriggerRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<EventsControllerTriggerRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventsControllerTriggerRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventsControllerTriggerRequest' from JSON`,
+  );
+}
+
 /** @internal */
 export const EventsControllerTriggerResponse$inboundSchema: z.ZodType<
   EventsControllerTriggerResponse,

package/src/models/operations/eventscontrollertriggerbulk.ts

@@ -9,11 +9,90 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type EventsControllerTriggerBulkRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  bulkTriggerEventDto: components.BulkTriggerEventDto;
+};
+
 export type EventsControllerTriggerBulkResponse = {
   headers: { [k: string]: Array<string> };
   result: Array<components.TriggerEventResponseDto>;
 };
 
+/** @internal */
+export const EventsControllerTriggerBulkRequest$inboundSchema: z.ZodType<
+  EventsControllerTriggerBulkRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "idempotency-key": z.string().optional(),
+  BulkTriggerEventDto: components.BulkTriggerEventDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+    "BulkTriggerEventDto": "bulkTriggerEventDto",
+  });
+});
+
+/** @internal */
+export type EventsControllerTriggerBulkRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  BulkTriggerEventDto: components.BulkTriggerEventDto$Outbound;
+};
+
+/** @internal */
+export const EventsControllerTriggerBulkRequest$outboundSchema: z.ZodType<
+  EventsControllerTriggerBulkRequest$Outbound,
+  z.ZodTypeDef,
+  EventsControllerTriggerBulkRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  bulkTriggerEventDto: components.BulkTriggerEventDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    bulkTriggerEventDto: "BulkTriggerEventDto",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventsControllerTriggerBulkRequest$ {
+  /** @deprecated use `EventsControllerTriggerBulkRequest$inboundSchema` instead. */
+  export const inboundSchema = EventsControllerTriggerBulkRequest$inboundSchema;
+  /** @deprecated use `EventsControllerTriggerBulkRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    EventsControllerTriggerBulkRequest$outboundSchema;
+  /** @deprecated use `EventsControllerTriggerBulkRequest$Outbound` instead. */
+  export type Outbound = EventsControllerTriggerBulkRequest$Outbound;
+}
+
+export function eventsControllerTriggerBulkRequestToJSON(
+  eventsControllerTriggerBulkRequest: EventsControllerTriggerBulkRequest,
+): string {
+  return JSON.stringify(
+    EventsControllerTriggerBulkRequest$outboundSchema.parse(
+      eventsControllerTriggerBulkRequest,
+    ),
+  );
+}
+
+export function eventsControllerTriggerBulkRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<EventsControllerTriggerBulkRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EventsControllerTriggerBulkRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventsControllerTriggerBulkRequest' from JSON`,
+  );
+}
+
 /** @internal */
 export const EventsControllerTriggerBulkResponse$inboundSchema: z.ZodType<
   EventsControllerTriggerBulkResponse,