@novu/api 0.1.0 → 0.1.2

package/src/lib/schemas.ts

@@ -57,6 +57,7 @@ export function collectExtraKeys<
 >(
   obj: ZodObject<Shape, "strip", Catchall>,
   extrasKey: K,
+  optional: boolean,
 ): ZodEffects<
   typeof obj,
   & output<ZodObject<Shape, "strict">>
@@ -81,6 +82,10 @@ export function collectExtraKeys<
       delete val[key];
     }
 
+    if (optional && Object.keys(extras).length === 0) {
+      return val;
+    }
+
     return { ...val, [extrasKey]: extras };
   });
 }

package/src/lib/security.ts

@@ -236,7 +236,7 @@ export function resolveGlobalSecurity(
       {
         fieldName: "Authorization",
         type: "apiKey:header",
-        value: security?.apiKey,
+        value: security?.secretKey,
       },
     ],
   );

package/src/models/components/{channelsettings.ts → channelsettingsdto.ts}

@@ -18,7 +18,7 @@ import {
 /**
  * The provider identifier for the credentials
  */
-export const ChannelSettingsProviderId = {
+export const ChannelSettingsDtoProviderId = {
   Slack: "slack",
   Discord: "discord",
   Msteams: "msteams",
@@ -40,15 +40,15 @@ export const ChannelSettingsProviderId = {
 /**
  * The provider identifier for the credentials
  */
-export type ChannelSettingsProviderId = ClosedEnum<
-  typeof ChannelSettingsProviderId
+export type ChannelSettingsDtoProviderId = ClosedEnum<
+  typeof ChannelSettingsDtoProviderId
 >;
 
-export type ChannelSettings = {
+export type ChannelSettingsDto = {
   /**
    * The provider identifier for the credentials
    */
-  providerId: ChannelSettingsProviderId;
+  providerId: ChannelSettingsDtoProviderId;
   /**
    * The integration identifier
    */
@@ -64,33 +64,33 @@ export type ChannelSettings = {
 };
 
 /** @internal */
-export const ChannelSettingsProviderId$inboundSchema: z.ZodNativeEnum<
-  typeof ChannelSettingsProviderId
-> = z.nativeEnum(ChannelSettingsProviderId);
+export const ChannelSettingsDtoProviderId$inboundSchema: z.ZodNativeEnum<
+  typeof ChannelSettingsDtoProviderId
+> = z.nativeEnum(ChannelSettingsDtoProviderId);
 
 /** @internal */
-export const ChannelSettingsProviderId$outboundSchema: z.ZodNativeEnum<
-  typeof ChannelSettingsProviderId
-> = ChannelSettingsProviderId$inboundSchema;
+export const ChannelSettingsDtoProviderId$outboundSchema: z.ZodNativeEnum<
+  typeof ChannelSettingsDtoProviderId
+> = ChannelSettingsDtoProviderId$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ChannelSettingsProviderId$ {
-  /** @deprecated use `ChannelSettingsProviderId$inboundSchema` instead. */
-  export const inboundSchema = ChannelSettingsProviderId$inboundSchema;
-  /** @deprecated use `ChannelSettingsProviderId$outboundSchema` instead. */
-  export const outboundSchema = ChannelSettingsProviderId$outboundSchema;
+export namespace ChannelSettingsDtoProviderId$ {
+  /** @deprecated use `ChannelSettingsDtoProviderId$inboundSchema` instead. */
+  export const inboundSchema = ChannelSettingsDtoProviderId$inboundSchema;
+  /** @deprecated use `ChannelSettingsDtoProviderId$outboundSchema` instead. */
+  export const outboundSchema = ChannelSettingsDtoProviderId$outboundSchema;
 }
 
 /** @internal */
-export const ChannelSettings$inboundSchema: z.ZodType<
-  ChannelSettings,
+export const ChannelSettingsDto$inboundSchema: z.ZodType<
+  ChannelSettingsDto,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  providerId: ChannelSettingsProviderId$inboundSchema,
+  providerId: ChannelSettingsDtoProviderId$inboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentials$inboundSchema,
   _integrationId: z.string(),
@@ -101,7 +101,7 @@ export const ChannelSettings$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type ChannelSettings$Outbound = {
+export type ChannelSettingsDto$Outbound = {
   providerId: string;
   integrationIdentifier?: string | undefined;
   credentials: ChannelCredentials$Outbound;
@@ -109,12 +109,12 @@ export type ChannelSettings$Outbound = {
 };
 
 /** @internal */
-export const ChannelSettings$outboundSchema: z.ZodType<
-  ChannelSettings$Outbound,
+export const ChannelSettingsDto$outboundSchema: z.ZodType<
+  ChannelSettingsDto$Outbound,
   z.ZodTypeDef,
-  ChannelSettings
+  ChannelSettingsDto
 > = z.object({
-  providerId: ChannelSettingsProviderId$outboundSchema,
+  providerId: ChannelSettingsDtoProviderId$outboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentials$outboundSchema,
   integrationId: z.string(),
@@ -128,27 +128,29 @@ export const ChannelSettings$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ChannelSettings$ {
-  /** @deprecated use `ChannelSettings$inboundSchema` instead. */
-  export const inboundSchema = ChannelSettings$inboundSchema;
-  /** @deprecated use `ChannelSettings$outboundSchema` instead. */
-  export const outboundSchema = ChannelSettings$outboundSchema;
-  /** @deprecated use `ChannelSettings$Outbound` instead. */
-  export type Outbound = ChannelSettings$Outbound;
+export namespace ChannelSettingsDto$ {
+  /** @deprecated use `ChannelSettingsDto$inboundSchema` instead. */
+  export const inboundSchema = ChannelSettingsDto$inboundSchema;
+  /** @deprecated use `ChannelSettingsDto$outboundSchema` instead. */
+  export const outboundSchema = ChannelSettingsDto$outboundSchema;
+  /** @deprecated use `ChannelSettingsDto$Outbound` instead. */
+  export type Outbound = ChannelSettingsDto$Outbound;
 }
 
-export function channelSettingsToJSON(
-  channelSettings: ChannelSettings,
+export function channelSettingsDtoToJSON(
+  channelSettingsDto: ChannelSettingsDto,
 ): string {
-  return JSON.stringify(ChannelSettings$outboundSchema.parse(channelSettings));
+  return JSON.stringify(
+    ChannelSettingsDto$outboundSchema.parse(channelSettingsDto),
+  );
 }
 
-export function channelSettingsFromJSON(
+export function channelSettingsDtoFromJSON(
   jsonString: string,
-): SafeParseResult<ChannelSettings, SDKValidationError> {
+): SafeParseResult<ChannelSettingsDto, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ChannelSettings$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ChannelSettings' from JSON`,
+    (x) => ChannelSettingsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChannelSettingsDto' from JSON`,
   );
 }

package/src/models/components/index.ts

@@ -24,7 +24,7 @@ export * from "./channelcredentials.js";
 export * from "./channelcredentialsdto.js";
 export * from "./channelctatypeenum.js";
 export * from "./channelpreference.js";
-export * from "./channelsettings.js";
+export * from "./channelsettingsdto.js";
 export * from "./channeltypeenum.js";
 export * from "./createdsubscriberdto.js";
 export * from "./createintegrationrequestdto.js";
@@ -56,6 +56,7 @@ export * from "./filtertopicsresponsedto.js";
 export * from "./getsubscriberpreferencesresponsedto.js";
 export * from "./gettopicresponsedto.js";
 export * from "./integrationresponsedto.js";
+export * from "./listsubscribersresponsedto.js";
 export * from "./markallmessageasrequestdto.js";
 export * from "./markmessageactionasseendto.js";
 export * from "./messageaction.js";
@@ -81,9 +82,11 @@ export * from "./notificationtriggervariable.js";
 export * from "./notificationtriggervariableresponse.js";
 export * from "./ordinalenum.js";
 export * from "./ordinalvalueenum.js";
+export * from "./patchsubscriberrequestdto.js";
 export * from "./preference.js";
 export * from "./preferencechannels.js";
 export * from "./providersidenum.js";
+export * from "./removesubscriberresponsedto.js";
 export * from "./removesubscribersrequestdto.js";
 export * from "./renametopicrequestdto.js";
 export * from "./renametopicresponsedto.js";
@@ -119,4 +122,3 @@ export * from "./updatesubscriberpreferencerequestdto.js";
 export * from "./updatesubscriberpreferenceresponsedto.js";
 export * from "./updatesubscriberrequestdto.js";
 export * from "./workflowresponse.js";
-export * from "./workflowtostepcontrolvaluesdto.js";

package/src/models/components/listsubscribersresponsedto.ts

@@ -0,0 +1,89 @@
+/*
+ * 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 {
+  SubscriberResponseDto,
+  SubscriberResponseDto$inboundSchema,
+  SubscriberResponseDto$Outbound,
+  SubscriberResponseDto$outboundSchema,
+} from "./subscriberresponsedto.js";
+
+export type ListSubscribersResponseDto = {
+  /**
+   * List of returned Subscribers
+   */
+  data: Array<SubscriberResponseDto>;
+  /**
+   * The cursor for the next page of results, or null if there are no more pages.
+   */
+  next: string | null;
+  /**
+   * The cursor for the previous page of results, or null if this is the first page.
+   */
+  previous: string | null;
+};
+
+/** @internal */
+export const ListSubscribersResponseDto$inboundSchema: z.ZodType<
+  ListSubscribersResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(SubscriberResponseDto$inboundSchema),
+  next: z.nullable(z.string()),
+  previous: z.nullable(z.string()),
+});
+
+/** @internal */
+export type ListSubscribersResponseDto$Outbound = {
+  data: Array<SubscriberResponseDto$Outbound>;
+  next: string | null;
+  previous: string | null;
+};
+
+/** @internal */
+export const ListSubscribersResponseDto$outboundSchema: z.ZodType<
+  ListSubscribersResponseDto$Outbound,
+  z.ZodTypeDef,
+  ListSubscribersResponseDto
+> = z.object({
+  data: z.array(SubscriberResponseDto$outboundSchema),
+  next: z.nullable(z.string()),
+  previous: z.nullable(z.string()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListSubscribersResponseDto$ {
+  /** @deprecated use `ListSubscribersResponseDto$inboundSchema` instead. */
+  export const inboundSchema = ListSubscribersResponseDto$inboundSchema;
+  /** @deprecated use `ListSubscribersResponseDto$outboundSchema` instead. */
+  export const outboundSchema = ListSubscribersResponseDto$outboundSchema;
+  /** @deprecated use `ListSubscribersResponseDto$Outbound` instead. */
+  export type Outbound = ListSubscribersResponseDto$Outbound;
+}
+
+export function listSubscribersResponseDtoToJSON(
+  listSubscribersResponseDto: ListSubscribersResponseDto,
+): string {
+  return JSON.stringify(
+    ListSubscribersResponseDto$outboundSchema.parse(listSubscribersResponseDto),
+  );
+}
+
+export function listSubscribersResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSubscribersResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSubscribersResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSubscribersResponseDto' from JSON`,
+  );
+}

package/src/models/components/patchsubscriberrequestdto.ts

@@ -0,0 +1,182 @@
+/*
+ * 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";
+
+/**
+ * Additional custom data for the subscriber
+ */
+export type PatchSubscriberRequestDtoData = {};
+
+export type PatchSubscriberRequestDto = {
+  /**
+   * Unique identifier of the subscriber
+   */
+  subscriberId?: string | null | undefined;
+  /**
+   * First name of the subscriber
+   */
+  firstName?: string | null | undefined;
+  /**
+   * Last name of the subscriber
+   */
+  lastName?: string | null | undefined;
+  /**
+   * Email address of the subscriber
+   */
+  email?: string | null | undefined;
+  /**
+   * Phone number of the subscriber
+   */
+  phone?: string | null | undefined;
+  /**
+   * Avatar URL or identifier
+   */
+  avatar?: string | null | undefined;
+  /**
+   * Timezone of the subscriber
+   */
+  timezone?: string | null | undefined;
+  /**
+   * Locale of the subscriber
+   */
+  locale?: string | null | undefined;
+  /**
+   * Additional custom data for the subscriber
+   */
+  data?: PatchSubscriberRequestDtoData | null | undefined;
+};
+
+/** @internal */
+export const PatchSubscriberRequestDtoData$inboundSchema: z.ZodType<
+  PatchSubscriberRequestDtoData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type PatchSubscriberRequestDtoData$Outbound = {};
+
+/** @internal */
+export const PatchSubscriberRequestDtoData$outboundSchema: z.ZodType<
+  PatchSubscriberRequestDtoData$Outbound,
+  z.ZodTypeDef,
+  PatchSubscriberRequestDtoData
+> = 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 PatchSubscriberRequestDtoData$ {
+  /** @deprecated use `PatchSubscriberRequestDtoData$inboundSchema` instead. */
+  export const inboundSchema = PatchSubscriberRequestDtoData$inboundSchema;
+  /** @deprecated use `PatchSubscriberRequestDtoData$outboundSchema` instead. */
+  export const outboundSchema = PatchSubscriberRequestDtoData$outboundSchema;
+  /** @deprecated use `PatchSubscriberRequestDtoData$Outbound` instead. */
+  export type Outbound = PatchSubscriberRequestDtoData$Outbound;
+}
+
+export function patchSubscriberRequestDtoDataToJSON(
+  patchSubscriberRequestDtoData: PatchSubscriberRequestDtoData,
+): string {
+  return JSON.stringify(
+    PatchSubscriberRequestDtoData$outboundSchema.parse(
+      patchSubscriberRequestDtoData,
+    ),
+  );
+}
+
+export function patchSubscriberRequestDtoDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchSubscriberRequestDtoData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchSubscriberRequestDtoData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchSubscriberRequestDtoData' from JSON`,
+  );
+}
+
+/** @internal */
+export const PatchSubscriberRequestDto$inboundSchema: z.ZodType<
+  PatchSubscriberRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscriberId: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  timezone: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  data: z.nullable(z.lazy(() => PatchSubscriberRequestDtoData$inboundSchema))
+    .optional(),
+});
+
+/** @internal */
+export type PatchSubscriberRequestDto$Outbound = {
+  subscriberId?: string | null | undefined;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email?: string | null | undefined;
+  phone?: string | null | undefined;
+  avatar?: string | null | undefined;
+  timezone?: string | null | undefined;
+  locale?: string | null | undefined;
+  data?: PatchSubscriberRequestDtoData$Outbound | null | undefined;
+};
+
+/** @internal */
+export const PatchSubscriberRequestDto$outboundSchema: z.ZodType<
+  PatchSubscriberRequestDto$Outbound,
+  z.ZodTypeDef,
+  PatchSubscriberRequestDto
+> = z.object({
+  subscriberId: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  timezone: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  data: z.nullable(z.lazy(() => PatchSubscriberRequestDtoData$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 PatchSubscriberRequestDto$ {
+  /** @deprecated use `PatchSubscriberRequestDto$inboundSchema` instead. */
+  export const inboundSchema = PatchSubscriberRequestDto$inboundSchema;
+  /** @deprecated use `PatchSubscriberRequestDto$outboundSchema` instead. */
+  export const outboundSchema = PatchSubscriberRequestDto$outboundSchema;
+  /** @deprecated use `PatchSubscriberRequestDto$Outbound` instead. */
+  export type Outbound = PatchSubscriberRequestDto$Outbound;
+}
+
+export function patchSubscriberRequestDtoToJSON(
+  patchSubscriberRequestDto: PatchSubscriberRequestDto,
+): string {
+  return JSON.stringify(
+    PatchSubscriberRequestDto$outboundSchema.parse(patchSubscriberRequestDto),
+  );
+}
+
+export function patchSubscriberRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchSubscriberRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchSubscriberRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchSubscriberRequestDto' from JSON`,
+  );
+}

package/src/models/components/removesubscriberresponsedto.ts

@@ -0,0 +1,78 @@
+/*
+ * 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";
+
+export type RemoveSubscriberResponseDto = {
+  /**
+   * Indicates whether the operation was acknowledged by the server
+   */
+  acknowledged: boolean;
+  /**
+   * Status of the subscriber removal operation
+   */
+  status: string;
+};
+
+/** @internal */
+export const RemoveSubscriberResponseDto$inboundSchema: z.ZodType<
+  RemoveSubscriberResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  acknowledged: z.boolean(),
+  status: z.string(),
+});
+
+/** @internal */
+export type RemoveSubscriberResponseDto$Outbound = {
+  acknowledged: boolean;
+  status: string;
+};
+
+/** @internal */
+export const RemoveSubscriberResponseDto$outboundSchema: z.ZodType<
+  RemoveSubscriberResponseDto$Outbound,
+  z.ZodTypeDef,
+  RemoveSubscriberResponseDto
+> = z.object({
+  acknowledged: z.boolean(),
+  status: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RemoveSubscriberResponseDto$ {
+  /** @deprecated use `RemoveSubscriberResponseDto$inboundSchema` instead. */
+  export const inboundSchema = RemoveSubscriberResponseDto$inboundSchema;
+  /** @deprecated use `RemoveSubscriberResponseDto$outboundSchema` instead. */
+  export const outboundSchema = RemoveSubscriberResponseDto$outboundSchema;
+  /** @deprecated use `RemoveSubscriberResponseDto$Outbound` instead. */
+  export type Outbound = RemoveSubscriberResponseDto$Outbound;
+}
+
+export function removeSubscriberResponseDtoToJSON(
+  removeSubscriberResponseDto: RemoveSubscriberResponseDto,
+): string {
+  return JSON.stringify(
+    RemoveSubscriberResponseDto$outboundSchema.parse(
+      removeSubscriberResponseDto,
+    ),
+  );
+}
+
+export function removeSubscriberResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveSubscriberResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveSubscriberResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveSubscriberResponseDto' from JSON`,
+  );
+}

package/src/models/components/security.ts

@@ -3,13 +3,12 @@
  */
 
 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";
 
 export type Security = {
-  apiKey: string;
+  secretKey: string;
 };
 
 /** @internal */
@@ -18,16 +17,12 @@ export const Security$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  "api-key": z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "api-key": "apiKey",
-  });
+  secretKey: z.string(),
 });
 
 /** @internal */
 export type Security$Outbound = {
-  "api-key": string;
+  secretKey: string;
 };
 
 /** @internal */
@@ -36,11 +31,7 @@ export const Security$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Security
 > = z.object({
-  apiKey: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    apiKey: "api-key",
-  });
+  secretKey: z.string(),
 });
 
 /**