@novu/api 0.1.0 → 0.1.2

package/src/models/components/subscriberresponsedto.ts

@@ -8,11 +8,11 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  ChannelSettings,
-  ChannelSettings$inboundSchema,
-  ChannelSettings$Outbound,
-  ChannelSettings$outboundSchema,
-} from "./channelsettings.js";
+  ChannelSettingsDto,
+  ChannelSettingsDto$inboundSchema,
+  ChannelSettingsDto$Outbound,
+  ChannelSettingsDto$outboundSchema,
+} from "./channelsettingsdto.js";
 
 export type SubscriberResponseDto = {
   /**
@@ -50,9 +50,11 @@ export type SubscriberResponseDto = {
   /**
    * An array of channel settings associated with the subscriber.
    */
-  channels?: Array<ChannelSettings> | undefined;
+  channels?: Array<ChannelSettingsDto> | undefined;
   /**
    * An array of topics that the subscriber is subscribed to.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   topics?: Array<string> | undefined;
   /**
@@ -87,6 +89,10 @@ export type SubscriberResponseDto = {
    * The version of the subscriber document.
    */
   v?: number | undefined;
+  /**
+   * Additional custom data for the subscriber
+   */
+  data?: { [k: string]: any } | null | undefined;
 };
 
 /** @internal */
@@ -103,7 +109,7 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   avatar: z.string().optional(),
   locale: z.string().optional(),
   subscriberId: z.string(),
-  channels: z.array(ChannelSettings$inboundSchema).optional(),
+  channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
   isOnline: z.boolean().optional(),
   lastOnlineAt: z.string().optional(),
@@ -113,6 +119,7 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   createdAt: z.string(),
   updatedAt: z.string(),
   __v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -132,7 +139,7 @@ export type SubscriberResponseDto$Outbound = {
   avatar?: string | undefined;
   locale?: string | undefined;
   subscriberId: string;
-  channels?: Array<ChannelSettings$Outbound> | undefined;
+  channels?: Array<ChannelSettingsDto$Outbound> | undefined;
   topics?: Array<string> | undefined;
   isOnline?: boolean | undefined;
   lastOnlineAt?: string | undefined;
@@ -142,6 +149,7 @@ export type SubscriberResponseDto$Outbound = {
   createdAt: string;
   updatedAt: string;
   __v?: number | undefined;
+  data?: { [k: string]: any } | null | undefined;
 };
 
 /** @internal */
@@ -158,7 +166,7 @@ export const SubscriberResponseDto$outboundSchema: z.ZodType<
   avatar: z.string().optional(),
   locale: z.string().optional(),
   subscriberId: z.string(),
-  channels: z.array(ChannelSettings$outboundSchema).optional(),
+  channels: z.array(ChannelSettingsDto$outboundSchema).optional(),
   topics: z.array(z.string()).optional(),
   isOnline: z.boolean().optional(),
   lastOnlineAt: z.string().optional(),
@@ -168,6 +176,7 @@ export const SubscriberResponseDto$outboundSchema: z.ZodType<
   createdAt: z.string(),
   updatedAt: z.string(),
   v: z.number().optional(),
+  data: z.nullable(z.record(z.any())).optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/triggereventrequestdto.ts

@@ -3,6 +3,7 @@
  */
 
 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -24,12 +25,6 @@ import {
   TopicPayloadDto$Outbound,
   TopicPayloadDto$outboundSchema,
 } from "./topicpayloaddto.js";
-import {
-  WorkflowToStepControlValuesDto,
-  WorkflowToStepControlValuesDto$inboundSchema,
-  WorkflowToStepControlValuesDto$Outbound,
-  WorkflowToStepControlValuesDto$outboundSchema,
-} from "./workflowtostepcontrolvaluesdto.js";
 
 export type One = TopicPayloadDto | SubscriberPayloadDto | string;
 
@@ -62,7 +57,7 @@ export type TriggerEventRequestDto = {
   /**
    * The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.
    */
-  name: string;
+  workflowId: string;
   /**
    * The payload object is used to pass additional custom information that could be
    *
@@ -71,10 +66,6 @@ export type TriggerEventRequestDto = {
    *       This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
    */
   payload?: { [k: string]: any } | undefined;
-  /**
-   * A URL to bridge for additional processing.
-   */
-  bridgeUrl?: string | undefined;
   /**
    * This could be used to override provider specific configurations
    */
@@ -105,10 +96,6 @@ export type TriggerEventRequestDto = {
    *     Existing tenants will be updated with the provided details.
    */
   tenant?: TenantPayloadDto | string | undefined;
-  /**
-   * Additional control configurations.
-   */
-  controls?: WorkflowToStepControlValuesDto | undefined;
 };
 
 /** @internal */
@@ -314,7 +301,6 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   payload: z.record(z.any()).optional(),
-  bridgeUrl: z.string().optional(),
   overrides: z.record(z.record(z.any())).optional(),
   to: z.union([
     TopicPayloadDto$inboundSchema,
@@ -331,14 +317,16 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
   transactionId: z.string().optional(),
   actor: z.union([SubscriberPayloadDto$inboundSchema, z.string()]).optional(),
   tenant: z.union([TenantPayloadDto$inboundSchema, z.string()]).optional(),
-  controls: WorkflowToStepControlValuesDto$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "name": "workflowId",
+  });
 });
 
 /** @internal */
 export type TriggerEventRequestDto$Outbound = {
   name: string;
   payload?: { [k: string]: any } | undefined;
-  bridgeUrl?: string | undefined;
   overrides?: { [k: string]: { [k: string]: any } } | undefined;
   to:
     | TopicPayloadDto$Outbound
@@ -348,7 +336,6 @@ export type TriggerEventRequestDto$Outbound = {
   transactionId?: string | undefined;
   actor?: SubscriberPayloadDto$Outbound | string | undefined;
   tenant?: TenantPayloadDto$Outbound | string | undefined;
-  controls?: WorkflowToStepControlValuesDto$Outbound | undefined;
 };
 
 /** @internal */
@@ -357,9 +344,8 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TriggerEventRequestDto
 > = z.object({
-  name: z.string(),
+  workflowId: z.string(),
   payload: z.record(z.any()).optional(),
-  bridgeUrl: z.string().optional(),
   overrides: z.record(z.record(z.any())).optional(),
   to: z.union([
     TopicPayloadDto$outboundSchema,
@@ -376,7 +362,10 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
   transactionId: z.string().optional(),
   actor: z.union([SubscriberPayloadDto$outboundSchema, z.string()]).optional(),
   tenant: z.union([TenantPayloadDto$outboundSchema, z.string()]).optional(),
-  controls: WorkflowToStepControlValuesDto$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    workflowId: "name",
+  });
 });
 
 /**

package/src/models/operations/index.ts

@@ -20,27 +20,31 @@ export * from "./notificationscontrollergetactivitygraphstats.js";
 export * from "./notificationscontrollergetactivitystats.js";
 export * from "./notificationscontrollergetnotification.js";
 export * from "./notificationscontrollerlistnotifications.js";
-export * from "./subscriberscontrollerbulkcreatesubscribers.js";
-export * from "./subscriberscontrollerchataccessoauth.js";
-export * from "./subscriberscontrollerchatoauthcallback.js";
-export * from "./subscriberscontrollercreatesubscriber.js";
-export * from "./subscriberscontrollerdeletesubscribercredentials.js";
-export * from "./subscriberscontrollergetnotificationsfeed.js";
 export * from "./subscriberscontrollergetsubscriber.js";
-export * from "./subscriberscontrollergetsubscriberpreferencebylevel.js";
-export * from "./subscriberscontrollergetunseencount.js";
-export * from "./subscriberscontrollerlistsubscriberpreferences.js";
-export * from "./subscriberscontrollerlistsubscribers.js";
-export * from "./subscriberscontrollermarkactionasseen.js";
-export * from "./subscriberscontrollermarkallunreadasread.js";
-export * from "./subscriberscontrollermarkmessagesas.js";
-export * from "./subscriberscontrollermodifysubscriberchannel.js";
+export * from "./subscriberscontrollerpatchsubscriber.js";
 export * from "./subscriberscontrollerremovesubscriber.js";
-export * from "./subscriberscontrollerupdatesubscriber.js";
-export * from "./subscriberscontrollerupdatesubscriberchannel.js";
-export * from "./subscriberscontrollerupdatesubscriberglobalpreferences.js";
-export * from "./subscriberscontrollerupdatesubscriberonlineflag.js";
-export * from "./subscriberscontrollerupdatesubscriberpreference.js";
+export * from "./subscriberscontrollersearchsubscribers.js";
+export * from "./subscribersv1controllerbulkcreatesubscribers.js";
+export * from "./subscribersv1controllerchataccessoauth.js";
+export * from "./subscribersv1controllerchatoauthcallback.js";
+export * from "./subscribersv1controllercreatesubscriber.js";
+export * from "./subscribersv1controllerdeletesubscribercredentials.js";
+export * from "./subscribersv1controllergetnotificationsfeed.js";
+export * from "./subscribersv1controllergetsubscriber.js";
+export * from "./subscribersv1controllergetsubscriberpreferencebylevel.js";
+export * from "./subscribersv1controllergetunseencount.js";
+export * from "./subscribersv1controllerlistsubscriberpreferences.js";
+export * from "./subscribersv1controllerlistsubscribers.js";
+export * from "./subscribersv1controllermarkactionasseen.js";
+export * from "./subscribersv1controllermarkallunreadasread.js";
+export * from "./subscribersv1controllermarkmessagesas.js";
+export * from "./subscribersv1controllermodifysubscriberchannel.js";
+export * from "./subscribersv1controllerremovesubscriber.js";
+export * from "./subscribersv1controllerupdatesubscriber.js";
+export * from "./subscribersv1controllerupdatesubscriberchannel.js";
+export * from "./subscribersv1controllerupdatesubscriberglobalpreferences.js";
+export * from "./subscribersv1controllerupdatesubscriberonlineflag.js";
+export * from "./subscribersv1controllerupdatesubscriberpreference.js";
 export * from "./topicscontrollerassign.js";
 export * from "./topicscontrollercreatetopic.js";
 export * from "./topicscontrollerdeletetopic.js";

package/src/models/operations/subscriberscontrollergetsubscriber.ts

@@ -11,10 +11,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerGetSubscriberRequest = {
   subscriberId: string;
-  /**
-   * Includes the topics associated with the subscriber
-   */
-  includeTopics?: boolean | undefined;
   /**
    * A header for idempotency purposes
    */
@@ -33,7 +29,6 @@ export const SubscribersControllerGetSubscriberRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   subscriberId: z.string(),
-  includeTopics: z.boolean().optional(),
   "idempotency-key": z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -44,7 +39,6 @@ export const SubscribersControllerGetSubscriberRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type SubscribersControllerGetSubscriberRequest$Outbound = {
   subscriberId: string;
-  includeTopics?: boolean | undefined;
   "idempotency-key"?: string | undefined;
 };
 
@@ -56,7 +50,6 @@ export const SubscribersControllerGetSubscriberRequest$outboundSchema:
     SubscribersControllerGetSubscriberRequest
   > = z.object({
     subscriberId: z.string(),
-    includeTopics: z.boolean().optional(),
     idempotencyKey: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {

package/src/models/operations/subscriberscontrollerpatchsubscriber.ts

@@ -0,0 +1,189 @@
+/*
+ * 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 SubscribersControllerPatchSubscriberRequest = {
+  subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  patchSubscriberRequestDto: components.PatchSubscriberRequestDto;
+};
+
+export type SubscribersControllerPatchSubscriberResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.SubscriberResponseDto;
+};
+
+/** @internal */
+export const SubscribersControllerPatchSubscriberRequest$inboundSchema:
+  z.ZodType<
+    SubscribersControllerPatchSubscriberRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
+    PatchSubscriberRequestDto:
+      components.PatchSubscriberRequestDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+      "PatchSubscriberRequestDto": "patchSubscriberRequestDto",
+    });
+  });
+
+/** @internal */
+export type SubscribersControllerPatchSubscriberRequest$Outbound = {
+  subscriberId: string;
+  "idempotency-key"?: string | undefined;
+  PatchSubscriberRequestDto: components.PatchSubscriberRequestDto$Outbound;
+};
+
+/** @internal */
+export const SubscribersControllerPatchSubscriberRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerPatchSubscriberRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerPatchSubscriberRequest
+  > = z.object({
+    subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
+    patchSubscriberRequestDto:
+      components.PatchSubscriberRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      patchSubscriberRequestDto: "PatchSubscriberRequestDto",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscribersControllerPatchSubscriberRequest$ {
+  /** @deprecated use `SubscribersControllerPatchSubscriberRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscribersControllerPatchSubscriberRequest$inboundSchema;
+  /** @deprecated use `SubscribersControllerPatchSubscriberRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscribersControllerPatchSubscriberRequest$outboundSchema;
+  /** @deprecated use `SubscribersControllerPatchSubscriberRequest$Outbound` instead. */
+  export type Outbound = SubscribersControllerPatchSubscriberRequest$Outbound;
+}
+
+export function subscribersControllerPatchSubscriberRequestToJSON(
+  subscribersControllerPatchSubscriberRequest:
+    SubscribersControllerPatchSubscriberRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerPatchSubscriberRequest$outboundSchema.parse(
+      subscribersControllerPatchSubscriberRequest,
+    ),
+  );
+}
+
+export function subscribersControllerPatchSubscriberRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerPatchSubscriberRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerPatchSubscriberRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerPatchSubscriberRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscribersControllerPatchSubscriberResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerPatchSubscriberResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: components.SubscriberResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type SubscribersControllerPatchSubscriberResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.SubscriberResponseDto$Outbound;
+};
+
+/** @internal */
+export const SubscribersControllerPatchSubscriberResponse$outboundSchema:
+  z.ZodType<
+    SubscribersControllerPatchSubscriberResponse$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerPatchSubscriberResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: components.SubscriberResponseDto$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 SubscribersControllerPatchSubscriberResponse$ {
+  /** @deprecated use `SubscribersControllerPatchSubscriberResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscribersControllerPatchSubscriberResponse$inboundSchema;
+  /** @deprecated use `SubscribersControllerPatchSubscriberResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscribersControllerPatchSubscriberResponse$outboundSchema;
+  /** @deprecated use `SubscribersControllerPatchSubscriberResponse$Outbound` instead. */
+  export type Outbound = SubscribersControllerPatchSubscriberResponse$Outbound;
+}
+
+export function subscribersControllerPatchSubscriberResponseToJSON(
+  subscribersControllerPatchSubscriberResponse:
+    SubscribersControllerPatchSubscriberResponse,
+): string {
+  return JSON.stringify(
+    SubscribersControllerPatchSubscriberResponse$outboundSchema.parse(
+      subscribersControllerPatchSubscriberResponse,
+    ),
+  );
+}
+
+export function subscribersControllerPatchSubscriberResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerPatchSubscriberResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerPatchSubscriberResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerPatchSubscriberResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerremovesubscriber.ts

@@ -19,7 +19,7 @@ export type SubscribersControllerRemoveSubscriberRequest = {
 
 export type SubscribersControllerRemoveSubscriberResponse = {
   headers: { [k: string]: Array<string> };
-  result: components.DeleteSubscriberResponseDto;
+  result: components.RemoveSubscriberResponseDto;
 };
 
 /** @internal */
@@ -108,7 +108,7 @@ export const SubscribersControllerRemoveSubscriberResponse$inboundSchema:
     unknown
   > = z.object({
     Headers: z.record(z.array(z.string())),
-    Result: components.DeleteSubscriberResponseDto$inboundSchema,
+    Result: components.RemoveSubscriberResponseDto$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
       "Headers": "headers",
@@ -119,7 +119,7 @@ export const SubscribersControllerRemoveSubscriberResponse$inboundSchema:
 /** @internal */
 export type SubscribersControllerRemoveSubscriberResponse$Outbound = {
   Headers: { [k: string]: Array<string> };
-  Result: components.DeleteSubscriberResponseDto$Outbound;
+  Result: components.RemoveSubscriberResponseDto$Outbound;
 };
 
 /** @internal */
@@ -130,7 +130,7 @@ export const SubscribersControllerRemoveSubscriberResponse$outboundSchema:
     SubscribersControllerRemoveSubscriberResponse
   > = z.object({
     headers: z.record(z.array(z.string())),
-    result: components.DeleteSubscriberResponseDto$outboundSchema,
+    result: components.RemoveSubscriberResponseDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
       headers: "Headers",