@novu/api 0.0.1-alpha.99 → 0.0.2

package/src/models/components/updatesubscriberpreferenceglobalresponsedto.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  Preference,
+  Preference$inboundSchema,
+  Preference$Outbound,
+  Preference$outboundSchema,
+} from "./preference.js";
+
+export type UpdateSubscriberPreferenceGlobalResponseDto = {
+  /**
+   * The preferences of the subscriber regarding the related workflow
+   */
+  preference: Preference;
+};
+
+/** @internal */
+export const UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema:
+  z.ZodType<
+    UpdateSubscriberPreferenceGlobalResponseDto,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    preference: Preference$inboundSchema,
+  });
+
+/** @internal */
+export type UpdateSubscriberPreferenceGlobalResponseDto$Outbound = {
+  preference: Preference$Outbound;
+};
+
+/** @internal */
+export const UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema:
+  z.ZodType<
+    UpdateSubscriberPreferenceGlobalResponseDto$Outbound,
+    z.ZodTypeDef,
+    UpdateSubscriberPreferenceGlobalResponseDto
+  > = z.object({
+    preference: Preference$outboundSchema,
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateSubscriberPreferenceGlobalResponseDto$ {
+  /** @deprecated use `UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema` instead. */
+  export const inboundSchema =
+    UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema;
+  /** @deprecated use `UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema` instead. */
+  export const outboundSchema =
+    UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema;
+  /** @deprecated use `UpdateSubscriberPreferenceGlobalResponseDto$Outbound` instead. */
+  export type Outbound = UpdateSubscriberPreferenceGlobalResponseDto$Outbound;
+}
+
+export function updateSubscriberPreferenceGlobalResponseDtoToJSON(
+  updateSubscriberPreferenceGlobalResponseDto:
+    UpdateSubscriberPreferenceGlobalResponseDto,
+): string {
+  return JSON.stringify(
+    UpdateSubscriberPreferenceGlobalResponseDto$outboundSchema.parse(
+      updateSubscriberPreferenceGlobalResponseDto,
+    ),
+  );
+}
+
+export function updateSubscriberPreferenceGlobalResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UpdateSubscriberPreferenceGlobalResponseDto,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UpdateSubscriberPreferenceGlobalResponseDto$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'UpdateSubscriberPreferenceGlobalResponseDto' from JSON`,
+  );
+}

package/src/models/components/updatesubscriberpreferencerequestdto.ts

@@ -15,11 +15,11 @@ import {
 
 export type UpdateSubscriberPreferenceRequestDto = {
   /**
-   * The subscriber preferences for every ChannelTypeEnum for the workflow assigned.
+   * Optional preferences for each channel type in the assigned workflow.
    */
   channel?: ChannelPreference | undefined;
   /**
-   * Sets if the workflow is fully enabled for all channels or not for the subscriber.
+   * Indicates whether the workflow is fully enabled for all channels for the subscriber.
    */
   enabled?: boolean | undefined;
 };

package/src/models/components/updatesubscriberrequestdto.ts

@@ -6,70 +6,48 @@ 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";
-
-export type UpdateSubscriberRequestDtoData = {};
+import {
+  SubscriberChannelDto,
+  SubscriberChannelDto$inboundSchema,
+  SubscriberChannelDto$Outbound,
+  SubscriberChannelDto$outboundSchema,
+} from "./subscriberchanneldto.js";
 
 export type UpdateSubscriberRequestDto = {
+  /**
+   * The email address of the subscriber.
+   */
   email?: string | undefined;
+  /**
+   * The first name of the subscriber.
+   */
   firstName?: string | undefined;
+  /**
+   * The last name of the subscriber.
+   */
   lastName?: string | undefined;
+  /**
+   * The phone number of the subscriber.
+   */
   phone?: string | undefined;
+  /**
+   * The avatar URL of the subscriber.
+   */
   avatar?: string | undefined;
+  /**
+   * The locale of the subscriber, for example "en-US".
+   */
   locale?: string | undefined;
-  data?: UpdateSubscriberRequestDtoData | undefined;
-  channels?: Array<string> | undefined;
+  /**
+   * Custom data associated with the subscriber. Can contain any additional properties.
+   */
+  data?: { [k: string]: any } | undefined;
+  /**
+   * An array of communication channels for the subscriber.
+   */
+  channels?: Array<SubscriberChannelDto> | undefined;
 };
 
-/** @internal */
-export const UpdateSubscriberRequestDtoData$inboundSchema: z.ZodType<
-  UpdateSubscriberRequestDtoData,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type UpdateSubscriberRequestDtoData$Outbound = {};
-
-/** @internal */
-export const UpdateSubscriberRequestDtoData$outboundSchema: z.ZodType<
-  UpdateSubscriberRequestDtoData$Outbound,
-  z.ZodTypeDef,
-  UpdateSubscriberRequestDtoData
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace UpdateSubscriberRequestDtoData$ {
-  /** @deprecated use `UpdateSubscriberRequestDtoData$inboundSchema` instead. */
-  export const inboundSchema = UpdateSubscriberRequestDtoData$inboundSchema;
-  /** @deprecated use `UpdateSubscriberRequestDtoData$outboundSchema` instead. */
-  export const outboundSchema = UpdateSubscriberRequestDtoData$outboundSchema;
-  /** @deprecated use `UpdateSubscriberRequestDtoData$Outbound` instead. */
-  export type Outbound = UpdateSubscriberRequestDtoData$Outbound;
-}
-
-export function updateSubscriberRequestDtoDataToJSON(
-  updateSubscriberRequestDtoData: UpdateSubscriberRequestDtoData,
-): string {
-  return JSON.stringify(
-    UpdateSubscriberRequestDtoData$outboundSchema.parse(
-      updateSubscriberRequestDtoData,
-    ),
-  );
-}
-
-export function updateSubscriberRequestDtoDataFromJSON(
-  jsonString: string,
-): SafeParseResult<UpdateSubscriberRequestDtoData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => UpdateSubscriberRequestDtoData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UpdateSubscriberRequestDtoData' from JSON`,
-  );
-}
-
 /** @internal */
 export const UpdateSubscriberRequestDto$inboundSchema: z.ZodType<
   UpdateSubscriberRequestDto,
@@ -82,8 +60,8 @@ export const UpdateSubscriberRequestDto$inboundSchema: z.ZodType<
   phone: z.string().optional(),
   avatar: z.string().optional(),
   locale: z.string().optional(),
-  data: z.lazy(() => UpdateSubscriberRequestDtoData$inboundSchema).optional(),
-  channels: z.array(z.string()).optional(),
+  data: z.record(z.any()).optional(),
+  channels: z.array(SubscriberChannelDto$inboundSchema).optional(),
 });
 
 /** @internal */
@@ -94,8 +72,8 @@ export type UpdateSubscriberRequestDto$Outbound = {
   phone?: string | undefined;
   avatar?: string | undefined;
   locale?: string | undefined;
-  data?: UpdateSubscriberRequestDtoData$Outbound | undefined;
-  channels?: Array<string> | undefined;
+  data?: { [k: string]: any } | undefined;
+  channels?: Array<SubscriberChannelDto$Outbound> | undefined;
 };
 
 /** @internal */
@@ -110,8 +88,8 @@ export const UpdateSubscriberRequestDto$outboundSchema: z.ZodType<
   phone: z.string().optional(),
   avatar: z.string().optional(),
   locale: z.string().optional(),
-  data: z.lazy(() => UpdateSubscriberRequestDtoData$outboundSchema).optional(),
-  channels: z.array(z.string()).optional(),
+  data: z.record(z.any()).optional(),
+  channels: z.array(SubscriberChannelDto$outboundSchema).optional(),
 });
 
 /**

package/src/models/components/workflowresponse.ts

@@ -14,11 +14,11 @@ import {
   NotificationGroup$outboundSchema,
 } from "./notificationgroup.js";
 import {
-  NotificationStep,
-  NotificationStep$inboundSchema,
-  NotificationStep$Outbound,
-  NotificationStep$outboundSchema,
-} from "./notificationstep.js";
+  NotificationStepDto,
+  NotificationStepDto$inboundSchema,
+  NotificationStepDto$Outbound,
+  NotificationStepDto$outboundSchema,
+} from "./notificationstepdto.js";
 import {
   NotificationTrigger,
   NotificationTrigger$inboundSchema,
@@ -45,7 +45,7 @@ export type WorkflowResponse = {
   preferenceSettings: PreferenceChannels;
   critical: boolean;
   tags: Array<string>;
-  steps: Array<NotificationStep>;
+  steps: Array<NotificationStepDto>;
   organizationId: string;
   creatorId: string;
   environmentId: string;
@@ -170,7 +170,7 @@ export const WorkflowResponse$inboundSchema: z.ZodType<
   preferenceSettings: PreferenceChannels$inboundSchema,
   critical: z.boolean(),
   tags: z.array(z.string()),
-  steps: z.array(NotificationStep$inboundSchema),
+  steps: z.array(NotificationStepDto$inboundSchema),
   _organizationId: z.string(),
   _creatorId: z.string(),
   _environmentId: z.string(),
@@ -206,7 +206,7 @@ export type WorkflowResponse$Outbound = {
   preferenceSettings: PreferenceChannels$Outbound;
   critical: boolean;
   tags: Array<string>;
-  steps: Array<NotificationStep$Outbound>;
+  steps: Array<NotificationStepDto$Outbound>;
   _organizationId: string;
   _creatorId: string;
   _environmentId: string;
@@ -235,7 +235,7 @@ export const WorkflowResponse$outboundSchema: z.ZodType<
   preferenceSettings: PreferenceChannels$outboundSchema,
   critical: z.boolean(),
   tags: z.array(z.string()),
-  steps: z.array(NotificationStep$outboundSchema),
+  steps: z.array(NotificationStepDto$outboundSchema),
   organizationId: z.string(),
   creatorId: z.string(),
   environmentId: z.string(),

package/src/models/errors/healthcontrollerhealthcheck.ts

@@ -0,0 +1,291 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+export type Info = {
+  status: string;
+  additionalProperties: { [k: string]: any };
+};
+
+export type ErrorT = {
+  status: string;
+  additionalProperties: { [k: string]: any };
+};
+
+export type Details = {
+  status: string;
+  additionalProperties: { [k: string]: any };
+};
+
+/**
+ * The Health Check is not successful
+ */
+export type HealthControllerHealthCheckResponseBodyData = {
+  status?: string | undefined;
+  info?: { [k: string]: Info } | null | undefined;
+  error?: { [k: string]: ErrorT } | null | undefined;
+  details?: { [k: string]: Details } | undefined;
+};
+
+/**
+ * The Health Check is not successful
+ */
+export class HealthControllerHealthCheckResponseBody extends Error {
+  status?: string | undefined;
+  info?: { [k: string]: Info } | null | undefined;
+  error?: { [k: string]: ErrorT } | null | undefined;
+  details?: { [k: string]: Details } | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: HealthControllerHealthCheckResponseBodyData;
+
+  constructor(err: HealthControllerHealthCheckResponseBodyData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.status != null) this.status = err.status;
+    if (err.info != null) this.info = err.info;
+    if (err.error != null) this.error = err.error;
+    if (err.details != null) this.details = err.details;
+
+    this.name = "HealthControllerHealthCheckResponseBody";
+  }
+}
+
+/** @internal */
+export const Info$inboundSchema: z.ZodType<Info, z.ZodTypeDef, unknown> =
+  collectExtraKeys$(
+    z.object({
+      status: z.string(),
+    }).catchall(z.any()),
+    "additionalProperties",
+  );
+
+/** @internal */
+export type Info$Outbound = {
+  status: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const Info$outboundSchema: z.ZodType<Info$Outbound, z.ZodTypeDef, Info> =
+  z.object({
+    status: z.string(),
+    additionalProperties: z.record(z.any()),
+  }).transform((v) => {
+    return {
+      ...v.additionalProperties,
+      ...remap$(v, {
+        additionalProperties: null,
+      }),
+    };
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Info$ {
+  /** @deprecated use `Info$inboundSchema` instead. */
+  export const inboundSchema = Info$inboundSchema;
+  /** @deprecated use `Info$outboundSchema` instead. */
+  export const outboundSchema = Info$outboundSchema;
+  /** @deprecated use `Info$Outbound` instead. */
+  export type Outbound = Info$Outbound;
+}
+
+export function infoToJSON(info: Info): string {
+  return JSON.stringify(Info$outboundSchema.parse(info));
+}
+
+export function infoFromJSON(
+  jsonString: string,
+): SafeParseResult<Info, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Info$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Info' from JSON`,
+  );
+}
+
+/** @internal */
+export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> =
+  collectExtraKeys$(
+    z.object({
+      status: z.string(),
+    }).catchall(z.any()),
+    "additionalProperties",
+  );
+
+/** @internal */
+export type ErrorT$Outbound = {
+  status: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const ErrorT$outboundSchema: z.ZodType<
+  ErrorT$Outbound,
+  z.ZodTypeDef,
+  ErrorT
+> = z.object({
+  status: z.string(),
+  additionalProperties: z.record(z.any()),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ErrorT$ {
+  /** @deprecated use `ErrorT$inboundSchema` instead. */
+  export const inboundSchema = ErrorT$inboundSchema;
+  /** @deprecated use `ErrorT$outboundSchema` instead. */
+  export const outboundSchema = ErrorT$outboundSchema;
+  /** @deprecated use `ErrorT$Outbound` instead. */
+  export type Outbound = ErrorT$Outbound;
+}
+
+export function errorToJSON(errorT: ErrorT): string {
+  return JSON.stringify(ErrorT$outboundSchema.parse(errorT));
+}
+
+export function errorFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorT, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorT$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorT' from JSON`,
+  );
+}
+
+/** @internal */
+export const Details$inboundSchema: z.ZodType<Details, z.ZodTypeDef, unknown> =
+  collectExtraKeys$(
+    z.object({
+      status: z.string(),
+    }).catchall(z.any()),
+    "additionalProperties",
+  );
+
+/** @internal */
+export type Details$Outbound = {
+  status: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const Details$outboundSchema: z.ZodType<
+  Details$Outbound,
+  z.ZodTypeDef,
+  Details
+> = z.object({
+  status: z.string(),
+  additionalProperties: z.record(z.any()),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Details$ {
+  /** @deprecated use `Details$inboundSchema` instead. */
+  export const inboundSchema = Details$inboundSchema;
+  /** @deprecated use `Details$outboundSchema` instead. */
+  export const outboundSchema = Details$outboundSchema;
+  /** @deprecated use `Details$Outbound` instead. */
+  export type Outbound = Details$Outbound;
+}
+
+export function detailsToJSON(details: Details): string {
+  return JSON.stringify(Details$outboundSchema.parse(details));
+}
+
+export function detailsFromJSON(
+  jsonString: string,
+): SafeParseResult<Details, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Details$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Details' from JSON`,
+  );
+}
+
+/** @internal */
+export const HealthControllerHealthCheckResponseBody$inboundSchema: z.ZodType<
+  HealthControllerHealthCheckResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string().optional(),
+  info: z.nullable(z.record(z.lazy(() => Info$inboundSchema))).optional(),
+  error: z.nullable(z.record(z.lazy(() => ErrorT$inboundSchema))).optional(),
+  details: z.record(z.lazy(() => Details$inboundSchema)).optional(),
+})
+  .transform((v) => {
+    return new HealthControllerHealthCheckResponseBody(v);
+  });
+
+/** @internal */
+export type HealthControllerHealthCheckResponseBody$Outbound = {
+  status?: string | undefined;
+  info?: { [k: string]: Info$Outbound } | null | undefined;
+  error?: { [k: string]: ErrorT$Outbound } | null | undefined;
+  details?: { [k: string]: Details$Outbound } | undefined;
+};
+
+/** @internal */
+export const HealthControllerHealthCheckResponseBody$outboundSchema: z.ZodType<
+  HealthControllerHealthCheckResponseBody$Outbound,
+  z.ZodTypeDef,
+  HealthControllerHealthCheckResponseBody
+> = z.instanceof(HealthControllerHealthCheckResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    status: z.string().optional(),
+    info: z.nullable(z.record(z.lazy(() => Info$outboundSchema))).optional(),
+    error: z.nullable(z.record(z.lazy(() => ErrorT$outboundSchema))).optional(),
+    details: z.record(z.lazy(() => Details$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 HealthControllerHealthCheckResponseBody$ {
+  /** @deprecated use `HealthControllerHealthCheckResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    HealthControllerHealthCheckResponseBody$inboundSchema;
+  /** @deprecated use `HealthControllerHealthCheckResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    HealthControllerHealthCheckResponseBody$outboundSchema;
+  /** @deprecated use `HealthControllerHealthCheckResponseBody$Outbound` instead. */
+  export type Outbound = HealthControllerHealthCheckResponseBody$Outbound;
+}

package/src/models/errors/index.ts

@@ -3,6 +3,8 @@
  */
 
 export * from "./errordto.js";
+export * from "./healthcontrollerhealthcheck.js";
 export * from "./httpclienterrors.js";
 export * from "./sdkerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./validationerrordto.js";