@novu/api 0.1.1 → 0.1.5

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/getsubscriberpreferencesdto.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 {
+  GlobalPreferenceDto,
+  GlobalPreferenceDto$inboundSchema,
+  GlobalPreferenceDto$Outbound,
+  GlobalPreferenceDto$outboundSchema,
+} from "./globalpreferencedto.js";
+import {
+  WorkflowPreferenceDto,
+  WorkflowPreferenceDto$inboundSchema,
+  WorkflowPreferenceDto$Outbound,
+  WorkflowPreferenceDto$outboundSchema,
+} from "./workflowpreferencedto.js";
+
+export type GetSubscriberPreferencesDto = {
+  /**
+   * Global preference settings
+   */
+  global: GlobalPreferenceDto;
+  /**
+   * Workflow-specific preference settings
+   */
+  workflows: Array<WorkflowPreferenceDto>;
+};
+
+/** @internal */
+export const GetSubscriberPreferencesDto$inboundSchema: z.ZodType<
+  GetSubscriberPreferencesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  global: GlobalPreferenceDto$inboundSchema,
+  workflows: z.array(WorkflowPreferenceDto$inboundSchema),
+});
+
+/** @internal */
+export type GetSubscriberPreferencesDto$Outbound = {
+  global: GlobalPreferenceDto$Outbound;
+  workflows: Array<WorkflowPreferenceDto$Outbound>;
+};
+
+/** @internal */
+export const GetSubscriberPreferencesDto$outboundSchema: z.ZodType<
+  GetSubscriberPreferencesDto$Outbound,
+  z.ZodTypeDef,
+  GetSubscriberPreferencesDto
+> = z.object({
+  global: GlobalPreferenceDto$outboundSchema,
+  workflows: z.array(WorkflowPreferenceDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSubscriberPreferencesDto$ {
+  /** @deprecated use `GetSubscriberPreferencesDto$inboundSchema` instead. */
+  export const inboundSchema = GetSubscriberPreferencesDto$inboundSchema;
+  /** @deprecated use `GetSubscriberPreferencesDto$outboundSchema` instead. */
+  export const outboundSchema = GetSubscriberPreferencesDto$outboundSchema;
+  /** @deprecated use `GetSubscriberPreferencesDto$Outbound` instead. */
+  export type Outbound = GetSubscriberPreferencesDto$Outbound;
+}
+
+export function getSubscriberPreferencesDtoToJSON(
+  getSubscriberPreferencesDto: GetSubscriberPreferencesDto,
+): string {
+  return JSON.stringify(
+    GetSubscriberPreferencesDto$outboundSchema.parse(
+      getSubscriberPreferencesDto,
+    ),
+  );
+}
+
+export function getSubscriberPreferencesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubscriberPreferencesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubscriberPreferencesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubscriberPreferencesDto' from JSON`,
+  );
+}

package/src/models/components/globalpreferencedto.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  PreferenceChannels,
+  PreferenceChannels$inboundSchema,
+  PreferenceChannels$Outbound,
+  PreferenceChannels$outboundSchema,
+} from "./preferencechannels.js";
+
+export type GlobalPreferenceDto = {
+  /**
+   * Whether notifications are enabled globally
+   */
+  enabled: boolean;
+  /**
+   * Channel-specific preference settings
+   */
+  channels: PreferenceChannels;
+};
+
+/** @internal */
+export const GlobalPreferenceDto$inboundSchema: z.ZodType<
+  GlobalPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean(),
+  channels: PreferenceChannels$inboundSchema,
+});
+
+/** @internal */
+export type GlobalPreferenceDto$Outbound = {
+  enabled: boolean;
+  channels: PreferenceChannels$Outbound;
+};
+
+/** @internal */
+export const GlobalPreferenceDto$outboundSchema: z.ZodType<
+  GlobalPreferenceDto$Outbound,
+  z.ZodTypeDef,
+  GlobalPreferenceDto
+> = z.object({
+  enabled: z.boolean(),
+  channels: PreferenceChannels$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GlobalPreferenceDto$ {
+  /** @deprecated use `GlobalPreferenceDto$inboundSchema` instead. */
+  export const inboundSchema = GlobalPreferenceDto$inboundSchema;
+  /** @deprecated use `GlobalPreferenceDto$outboundSchema` instead. */
+  export const outboundSchema = GlobalPreferenceDto$outboundSchema;
+  /** @deprecated use `GlobalPreferenceDto$Outbound` instead. */
+  export type Outbound = GlobalPreferenceDto$Outbound;
+}
+
+export function globalPreferenceDtoToJSON(
+  globalPreferenceDto: GlobalPreferenceDto,
+): string {
+  return JSON.stringify(
+    GlobalPreferenceDto$outboundSchema.parse(globalPreferenceDto),
+  );
+}
+
+export function globalPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GlobalPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GlobalPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GlobalPreferenceDto' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -24,12 +24,11 @@ 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";
 export * from "./createsubscriberrequestdto.js";
-export * from "./createsupportthreaddto.js";
 export * from "./createtopicrequestdto.js";
 export * from "./createtopicresponsedto.js";
 export * from "./credentialsdto.js";
@@ -54,9 +53,12 @@ export * from "./failedoperationdto.js";
 export * from "./feedresponsedto.js";
 export * from "./fieldfilterpartdto.js";
 export * from "./filtertopicsresponsedto.js";
+export * from "./getsubscriberpreferencesdto.js";
 export * from "./getsubscriberpreferencesresponsedto.js";
 export * from "./gettopicresponsedto.js";
+export * from "./globalpreferencedto.js";
 export * from "./integrationresponsedto.js";
+export * from "./listsubscribersresponsedto.js";
 export * from "./markallmessageasrequestdto.js";
 export * from "./markmessageactionasseendto.js";
 export * from "./messageaction.js";
@@ -82,10 +84,14 @@ export * from "./notificationtriggervariable.js";
 export * from "./notificationtriggervariableresponse.js";
 export * from "./ordinalenum.js";
 export * from "./ordinalvalueenum.js";
-export * from "./plaincardrequestdto.js";
+export * from "./overrides.js";
+export * from "./patchpreferencechannelsdto.js";
+export * from "./patchsubscriberpreferencesdto.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";
@@ -120,5 +126,6 @@ export * from "./updatesubscriberpreferenceglobalresponsedto.js";
 export * from "./updatesubscriberpreferencerequestdto.js";
 export * from "./updatesubscriberpreferenceresponsedto.js";
 export * from "./updatesubscriberrequestdto.js";
+export * from "./workflowinfodto.js";
+export * from "./workflowpreferencedto.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/overrides.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The channel type which is overridden
+ */
+export const OverridesChannel = {
+  InApp: "in_app",
+  Email: "email",
+  Sms: "sms",
+  Chat: "chat",
+  Push: "push",
+} as const;
+/**
+ * The channel type which is overridden
+ */
+export type OverridesChannel = ClosedEnum<typeof OverridesChannel>;
+
+/**
+ * The source of overrides
+ */
+export const Source = {
+  Subscriber: "subscriber",
+  Template: "template",
+  WorkflowOverride: "workflowOverride",
+} as const;
+/**
+ * The source of overrides
+ */
+export type Source = ClosedEnum<typeof Source>;
+
+export type Overrides = {
+  /**
+   * The channel type which is overridden
+   */
+  channel: OverridesChannel;
+  /**
+   * The source of overrides
+   */
+  source: Source;
+};
+
+/** @internal */
+export const OverridesChannel$inboundSchema: z.ZodNativeEnum<
+  typeof OverridesChannel
+> = z.nativeEnum(OverridesChannel);
+
+/** @internal */
+export const OverridesChannel$outboundSchema: z.ZodNativeEnum<
+  typeof OverridesChannel
+> = OverridesChannel$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OverridesChannel$ {
+  /** @deprecated use `OverridesChannel$inboundSchema` instead. */
+  export const inboundSchema = OverridesChannel$inboundSchema;
+  /** @deprecated use `OverridesChannel$outboundSchema` instead. */
+  export const outboundSchema = OverridesChannel$outboundSchema;
+}
+
+/** @internal */
+export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
+  .nativeEnum(Source);
+
+/** @internal */
+export const Source$outboundSchema: z.ZodNativeEnum<typeof Source> =
+  Source$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Source$ {
+  /** @deprecated use `Source$inboundSchema` instead. */
+  export const inboundSchema = Source$inboundSchema;
+  /** @deprecated use `Source$outboundSchema` instead. */
+  export const outboundSchema = Source$outboundSchema;
+}
+
+/** @internal */
+export const Overrides$inboundSchema: z.ZodType<
+  Overrides,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channel: OverridesChannel$inboundSchema,
+  source: Source$inboundSchema,
+});
+
+/** @internal */
+export type Overrides$Outbound = {
+  channel: string;
+  source: string;
+};
+
+/** @internal */
+export const Overrides$outboundSchema: z.ZodType<
+  Overrides$Outbound,
+  z.ZodTypeDef,
+  Overrides
+> = z.object({
+  channel: OverridesChannel$outboundSchema,
+  source: Source$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Overrides$ {
+  /** @deprecated use `Overrides$inboundSchema` instead. */
+  export const inboundSchema = Overrides$inboundSchema;
+  /** @deprecated use `Overrides$outboundSchema` instead. */
+  export const outboundSchema = Overrides$outboundSchema;
+  /** @deprecated use `Overrides$Outbound` instead. */
+  export type Outbound = Overrides$Outbound;
+}
+
+export function overridesToJSON(overrides: Overrides): string {
+  return JSON.stringify(Overrides$outboundSchema.parse(overrides));
+}
+
+export function overridesFromJSON(
+  jsonString: string,
+): SafeParseResult<Overrides, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Overrides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Overrides' from JSON`,
+  );
+}