@novu/api 0.1.2 → 0.1.6

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

@@ -53,8 +53,10 @@ 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";
@@ -82,6 +84,9 @@ export * from "./notificationtriggervariable.js";
 export * from "./notificationtriggervariableresponse.js";
 export * from "./ordinalenum.js";
 export * from "./ordinalvalueenum.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";
@@ -121,4 +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";

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`,
+  );
+}

package/src/models/components/patchpreferencechannelsdto.ts

@@ -0,0 +1,106 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PatchPreferenceChannelsDto = {
+  /**
+   * Email channel preference
+   */
+  email?: boolean | undefined;
+  /**
+   * SMS channel preference
+   */
+  sms?: boolean | undefined;
+  /**
+   * In-app channel preference
+   */
+  inApp?: boolean | undefined;
+  /**
+   * Push channel preference
+   */
+  push?: boolean | undefined;
+  /**
+   * Chat channel preference
+   */
+  chat?: boolean | undefined;
+};
+
+/** @internal */
+export const PatchPreferenceChannelsDto$inboundSchema: z.ZodType<
+  PatchPreferenceChannelsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.boolean().optional(),
+  sms: z.boolean().optional(),
+  in_app: z.boolean().optional(),
+  push: z.boolean().optional(),
+  chat: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "in_app": "inApp",
+  });
+});
+
+/** @internal */
+export type PatchPreferenceChannelsDto$Outbound = {
+  email?: boolean | undefined;
+  sms?: boolean | undefined;
+  in_app?: boolean | undefined;
+  push?: boolean | undefined;
+  chat?: boolean | undefined;
+};
+
+/** @internal */
+export const PatchPreferenceChannelsDto$outboundSchema: z.ZodType<
+  PatchPreferenceChannelsDto$Outbound,
+  z.ZodTypeDef,
+  PatchPreferenceChannelsDto
+> = z.object({
+  email: z.boolean().optional(),
+  sms: z.boolean().optional(),
+  inApp: z.boolean().optional(),
+  push: z.boolean().optional(),
+  chat: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    inApp: "in_app",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PatchPreferenceChannelsDto$ {
+  /** @deprecated use `PatchPreferenceChannelsDto$inboundSchema` instead. */
+  export const inboundSchema = PatchPreferenceChannelsDto$inboundSchema;
+  /** @deprecated use `PatchPreferenceChannelsDto$outboundSchema` instead. */
+  export const outboundSchema = PatchPreferenceChannelsDto$outboundSchema;
+  /** @deprecated use `PatchPreferenceChannelsDto$Outbound` instead. */
+  export type Outbound = PatchPreferenceChannelsDto$Outbound;
+}
+
+export function patchPreferenceChannelsDtoToJSON(
+  patchPreferenceChannelsDto: PatchPreferenceChannelsDto,
+): string {
+  return JSON.stringify(
+    PatchPreferenceChannelsDto$outboundSchema.parse(patchPreferenceChannelsDto),
+  );
+}
+
+export function patchPreferenceChannelsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchPreferenceChannelsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchPreferenceChannelsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchPreferenceChannelsDto' from JSON`,
+  );
+}

package/src/models/components/patchsubscriberpreferencesdto.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 {
+  PatchPreferenceChannelsDto,
+  PatchPreferenceChannelsDto$inboundSchema,
+  PatchPreferenceChannelsDto$Outbound,
+  PatchPreferenceChannelsDto$outboundSchema,
+} from "./patchpreferencechannelsdto.js";
+
+export type PatchSubscriberPreferencesDto = {
+  /**
+   * Channel-specific preference settings
+   */
+  channels: PatchPreferenceChannelsDto;
+  /**
+   * If provided, update workflow specific preferences, otherwise update global preferences
+   */
+  workflowId?: string | undefined;
+};
+
+/** @internal */
+export const PatchSubscriberPreferencesDto$inboundSchema: z.ZodType<
+  PatchSubscriberPreferencesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channels: PatchPreferenceChannelsDto$inboundSchema,
+  workflowId: z.string().optional(),
+});
+
+/** @internal */
+export type PatchSubscriberPreferencesDto$Outbound = {
+  channels: PatchPreferenceChannelsDto$Outbound;
+  workflowId?: string | undefined;
+};
+
+/** @internal */
+export const PatchSubscriberPreferencesDto$outboundSchema: z.ZodType<
+  PatchSubscriberPreferencesDto$Outbound,
+  z.ZodTypeDef,
+  PatchSubscriberPreferencesDto
+> = z.object({
+  channels: PatchPreferenceChannelsDto$outboundSchema,
+  workflowId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PatchSubscriberPreferencesDto$ {
+  /** @deprecated use `PatchSubscriberPreferencesDto$inboundSchema` instead. */
+  export const inboundSchema = PatchSubscriberPreferencesDto$inboundSchema;
+  /** @deprecated use `PatchSubscriberPreferencesDto$outboundSchema` instead. */
+  export const outboundSchema = PatchSubscriberPreferencesDto$outboundSchema;
+  /** @deprecated use `PatchSubscriberPreferencesDto$Outbound` instead. */
+  export type Outbound = PatchSubscriberPreferencesDto$Outbound;
+}
+
+export function patchSubscriberPreferencesDtoToJSON(
+  patchSubscriberPreferencesDto: PatchSubscriberPreferencesDto,
+): string {
+  return JSON.stringify(
+    PatchSubscriberPreferencesDto$outboundSchema.parse(
+      patchSubscriberPreferencesDto,
+    ),
+  );
+}
+
+export function patchSubscriberPreferencesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchSubscriberPreferencesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchSubscriberPreferencesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchSubscriberPreferencesDto' from JSON`,
+  );
+}

package/src/models/components/triggereventtoallrequestdto.ts

@@ -22,7 +22,7 @@ import {
 /**
  * This could be used to override provider specific configurations
  */
-export type Overrides = {};
+export type TriggerEventToAllRequestDtoOverrides = {};
 
 /**
  * It is used to display the Avatar of the provided actor's subscriber id or actor object.
@@ -56,7 +56,7 @@ export type TriggerEventToAllRequestDto = {
   /**
    * This could be used to override provider specific configurations
    */
-  overrides?: Overrides | undefined;
+  overrides?: TriggerEventToAllRequestDtoOverrides | undefined;
   /**
    * A unique identifier for this transaction, we will generated a UUID if not provided.
    */
@@ -78,46 +78,55 @@ export type TriggerEventToAllRequestDto = {
 };
 
 /** @internal */
-export const Overrides$inboundSchema: z.ZodType<
-  Overrides,
+export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoOverrides,
   z.ZodTypeDef,
   unknown
 > = z.object({});
 
 /** @internal */
-export type Overrides$Outbound = {};
+export type TriggerEventToAllRequestDtoOverrides$Outbound = {};
 
 /** @internal */
-export const Overrides$outboundSchema: z.ZodType<
-  Overrides$Outbound,
+export const TriggerEventToAllRequestDtoOverrides$outboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoOverrides$Outbound,
   z.ZodTypeDef,
-  Overrides
+  TriggerEventToAllRequestDtoOverrides
 > = 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 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 namespace TriggerEventToAllRequestDtoOverrides$ {
+  /** @deprecated use `TriggerEventToAllRequestDtoOverrides$inboundSchema` instead. */
+  export const inboundSchema =
+    TriggerEventToAllRequestDtoOverrides$inboundSchema;
+  /** @deprecated use `TriggerEventToAllRequestDtoOverrides$outboundSchema` instead. */
+  export const outboundSchema =
+    TriggerEventToAllRequestDtoOverrides$outboundSchema;
+  /** @deprecated use `TriggerEventToAllRequestDtoOverrides$Outbound` instead. */
+  export type Outbound = TriggerEventToAllRequestDtoOverrides$Outbound;
 }
 
-export function overridesToJSON(overrides: Overrides): string {
-  return JSON.stringify(Overrides$outboundSchema.parse(overrides));
+export function triggerEventToAllRequestDtoOverridesToJSON(
+  triggerEventToAllRequestDtoOverrides: TriggerEventToAllRequestDtoOverrides,
+): string {
+  return JSON.stringify(
+    TriggerEventToAllRequestDtoOverrides$outboundSchema.parse(
+      triggerEventToAllRequestDtoOverrides,
+    ),
+  );
 }
 
-export function overridesFromJSON(
+export function triggerEventToAllRequestDtoOverridesFromJSON(
   jsonString: string,
-): SafeParseResult<Overrides, SDKValidationError> {
+): SafeParseResult<TriggerEventToAllRequestDtoOverrides, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Overrides$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Overrides' from JSON`,
+    (x) =>
+      TriggerEventToAllRequestDtoOverrides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TriggerEventToAllRequestDtoOverrides' from JSON`,
   );
 }
 
@@ -234,7 +243,8 @@ export const TriggerEventToAllRequestDto$inboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   payload: z.record(z.any()),
-  overrides: z.lazy(() => Overrides$inboundSchema).optional(),
+  overrides: z.lazy(() => TriggerEventToAllRequestDtoOverrides$inboundSchema)
+    .optional(),
   transactionId: z.string().optional(),
   actor: z.union([SubscriberPayloadDto$inboundSchema, z.string()]).optional(),
   tenant: z.union([TenantPayloadDto$inboundSchema, z.string()]).optional(),
@@ -244,7 +254,7 @@ export const TriggerEventToAllRequestDto$inboundSchema: z.ZodType<
 export type TriggerEventToAllRequestDto$Outbound = {
   name: string;
   payload: { [k: string]: any };
-  overrides?: Overrides$Outbound | undefined;
+  overrides?: TriggerEventToAllRequestDtoOverrides$Outbound | undefined;
   transactionId?: string | undefined;
   actor?: SubscriberPayloadDto$Outbound | string | undefined;
   tenant?: TenantPayloadDto$Outbound | string | undefined;
@@ -258,7 +268,8 @@ export const TriggerEventToAllRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   payload: z.record(z.any()),
-  overrides: z.lazy(() => Overrides$outboundSchema).optional(),
+  overrides: z.lazy(() => TriggerEventToAllRequestDtoOverrides$outboundSchema)
+    .optional(),
   transactionId: z.string().optional(),
   actor: z.union([SubscriberPayloadDto$outboundSchema, z.string()]).optional(),
   tenant: z.union([TenantPayloadDto$outboundSchema, z.string()]).optional(),

package/src/models/components/workflowinfodto.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 WorkflowInfoDto = {
+  /**
+   * Workflow slug
+   */
+  slug: string;
+  /**
+   * Unique identifier of the workflow
+   */
+  identifier: string;
+  /**
+   * Display name of the workflow
+   */
+  name: string;
+};
+
+/** @internal */
+export const WorkflowInfoDto$inboundSchema: z.ZodType<
+  WorkflowInfoDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  slug: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+});
+
+/** @internal */
+export type WorkflowInfoDto$Outbound = {
+  slug: string;
+  identifier: string;
+  name: string;
+};
+
+/** @internal */
+export const WorkflowInfoDto$outboundSchema: z.ZodType<
+  WorkflowInfoDto$Outbound,
+  z.ZodTypeDef,
+  WorkflowInfoDto
+> = z.object({
+  slug: z.string(),
+  identifier: z.string(),
+  name: 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 WorkflowInfoDto$ {
+  /** @deprecated use `WorkflowInfoDto$inboundSchema` instead. */
+  export const inboundSchema = WorkflowInfoDto$inboundSchema;
+  /** @deprecated use `WorkflowInfoDto$outboundSchema` instead. */
+  export const outboundSchema = WorkflowInfoDto$outboundSchema;
+  /** @deprecated use `WorkflowInfoDto$Outbound` instead. */
+  export type Outbound = WorkflowInfoDto$Outbound;
+}
+
+export function workflowInfoDtoToJSON(
+  workflowInfoDto: WorkflowInfoDto,
+): string {
+  return JSON.stringify(WorkflowInfoDto$outboundSchema.parse(workflowInfoDto));
+}
+
+export function workflowInfoDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<WorkflowInfoDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WorkflowInfoDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WorkflowInfoDto' from JSON`,
+  );
+}