@novu/api 3.11.0 → 3.11.2

package/src/models/components/getchannelendpointresponsedto.ts

@@ -0,0 +1,282 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+import {
+  PhoneEndpointDto,
+  PhoneEndpointDto$inboundSchema,
+} from "./phoneendpointdto.js";
+import {
+  SlackChannelEndpointDto,
+  SlackChannelEndpointDto$inboundSchema,
+} from "./slackchannelendpointdto.js";
+import {
+  SlackUserEndpointDto,
+  SlackUserEndpointDto$inboundSchema,
+} from "./slackuserendpointdto.js";
+import {
+  WebhookEndpointDto,
+  WebhookEndpointDto$inboundSchema,
+} from "./webhookendpointdto.js";
+
+/**
+ * The channel type (email, sms, push, chat, etc.).
+ */
+export const GetChannelEndpointResponseDtoChannel = {
+  InApp: "in_app",
+  Email: "email",
+  Sms: "sms",
+  Chat: "chat",
+  Push: "push",
+} as const;
+/**
+ * The channel type (email, sms, push, chat, etc.).
+ */
+export type GetChannelEndpointResponseDtoChannel = ClosedEnum<
+  typeof GetChannelEndpointResponseDtoChannel
+>;
+
+/**
+ * The provider identifier (e.g., sendgrid, twilio, slack, etc.).
+ */
+export const GetChannelEndpointResponseDtoProviderId = {
+  Emailjs: "emailjs",
+  Mailgun: "mailgun",
+  Mailjet: "mailjet",
+  Mandrill: "mandrill",
+  Nodemailer: "nodemailer",
+  Postmark: "postmark",
+  Sendgrid: "sendgrid",
+  Sendinblue: "sendinblue",
+  Ses: "ses",
+  Netcore: "netcore",
+  InfobipEmail: "infobip-email",
+  Resend: "resend",
+  Plunk: "plunk",
+  Mailersend: "mailersend",
+  Mailtrap: "mailtrap",
+  Clickatell: "clickatell",
+  Outlook365: "outlook365",
+  NovuEmail: "novu-email",
+  Sparkpost: "sparkpost",
+  EmailWebhook: "email-webhook",
+  Braze: "braze",
+  Nexmo: "nexmo",
+  Plivo: "plivo",
+  Sms77: "sms77",
+  SmsCentral: "sms-central",
+  Sns: "sns",
+  Telnyx: "telnyx",
+  Twilio: "twilio",
+  Gupshup: "gupshup",
+  Firetext: "firetext",
+  InfobipSms: "infobip-sms",
+  BurstSms: "burst-sms",
+  BulkSms: "bulk-sms",
+  IsendSms: "isend-sms",
+  FortySixElks: "forty-six-elks",
+  Kannel: "kannel",
+  Maqsam: "maqsam",
+  Termii: "termii",
+  AfricasTalking: "africas-talking",
+  NovuSms: "novu-sms",
+  Sendchamp: "sendchamp",
+  GenericSms: "generic-sms",
+  Clicksend: "clicksend",
+  Bandwidth: "bandwidth",
+  Messagebird: "messagebird",
+  Simpletexting: "simpletexting",
+  AzureSms: "azure-sms",
+  RingCentral: "ring-central",
+  BrevoSms: "brevo-sms",
+  EazySms: "eazy-sms",
+  Mobishastra: "mobishastra",
+  AfroMessage: "afro-message",
+  Unifonic: "unifonic",
+  Smsmode: "smsmode",
+  Imedia: "imedia",
+  Sinch: "sinch",
+  IsendproSms: "isendpro-sms",
+  Fcm: "fcm",
+  Apns: "apns",
+  Expo: "expo",
+  OneSignal: "one-signal",
+  Pushpad: "pushpad",
+  PushWebhook: "push-webhook",
+  PusherBeams: "pusher-beams",
+  Appio: "appio",
+  Novu: "novu",
+  Slack: "slack",
+  Discord: "discord",
+  Msteams: "msteams",
+  Mattermost: "mattermost",
+  Ryver: "ryver",
+  Zulip: "zulip",
+  GrafanaOnCall: "grafana-on-call",
+  Getstream: "getstream",
+  RocketChat: "rocket-chat",
+  WhatsappBusiness: "whatsapp-business",
+  ChatWebhook: "chat-webhook",
+  NovuSlack: "novu-slack",
+} as const;
+/**
+ * The provider identifier (e.g., sendgrid, twilio, slack, etc.).
+ */
+export type GetChannelEndpointResponseDtoProviderId = ClosedEnum<
+  typeof GetChannelEndpointResponseDtoProviderId
+>;
+
+/**
+ * Type of channel endpoint
+ */
+export const GetChannelEndpointResponseDtoType = {
+  SlackChannel: "slack_channel",
+  SlackUser: "slack_user",
+  Webhook: "webhook",
+  Phone: "phone",
+  MsTeamsChannel: "ms_teams_channel",
+  MsTeamsUser: "ms_teams_user",
+} as const;
+/**
+ * Type of channel endpoint
+ */
+export type GetChannelEndpointResponseDtoType = ClosedEnum<
+  typeof GetChannelEndpointResponseDtoType
+>;
+
+/**
+ * Endpoint data specific to the channel type
+ */
+export type Endpoint =
+  | SlackChannelEndpointDto
+  | SlackUserEndpointDto
+  | WebhookEndpointDto
+  | PhoneEndpointDto;
+
+export type GetChannelEndpointResponseDto = {
+  /**
+   * The unique identifier of the channel endpoint.
+   */
+  identifier: string;
+  /**
+   * The channel type (email, sms, push, chat, etc.).
+   */
+  channel: GetChannelEndpointResponseDtoChannel | null;
+  /**
+   * The provider identifier (e.g., sendgrid, twilio, slack, etc.).
+   */
+  providerId: GetChannelEndpointResponseDtoProviderId | null;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string | null;
+  /**
+   * The identifier of the channel connection used for this endpoint.
+   */
+  connectionIdentifier: string | null;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string | null;
+  /**
+   * The context of the channel connection
+   */
+  contextKeys: Array<string>;
+  /**
+   * Type of channel endpoint
+   */
+  type: GetChannelEndpointResponseDtoType;
+  /**
+   * Endpoint data specific to the channel type
+   */
+  endpoint:
+    | SlackChannelEndpointDto
+    | SlackUserEndpointDto
+    | WebhookEndpointDto
+    | PhoneEndpointDto;
+  /**
+   * The timestamp indicating when the channel endpoint was created, in ISO 8601 format.
+   */
+  createdAt: string;
+  /**
+   * The timestamp indicating when the channel endpoint was last updated, in ISO 8601 format.
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const GetChannelEndpointResponseDtoChannel$inboundSchema:
+  z.ZodNativeEnum<typeof GetChannelEndpointResponseDtoChannel> = z.nativeEnum(
+    GetChannelEndpointResponseDtoChannel,
+  );
+
+/** @internal */
+export const GetChannelEndpointResponseDtoProviderId$inboundSchema:
+  z.ZodNativeEnum<typeof GetChannelEndpointResponseDtoProviderId> = z
+    .nativeEnum(GetChannelEndpointResponseDtoProviderId);
+
+/** @internal */
+export const GetChannelEndpointResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof GetChannelEndpointResponseDtoType
+> = z.nativeEnum(GetChannelEndpointResponseDtoType);
+
+/** @internal */
+export const Endpoint$inboundSchema: z.ZodType<
+  Endpoint,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  SlackChannelEndpointDto$inboundSchema,
+  SlackUserEndpointDto$inboundSchema,
+  WebhookEndpointDto$inboundSchema,
+  PhoneEndpointDto$inboundSchema,
+]);
+
+export function endpointFromJSON(
+  jsonString: string,
+): SafeParseResult<Endpoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Endpoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Endpoint' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChannelEndpointResponseDto$inboundSchema: z.ZodType<
+  GetChannelEndpointResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identifier: z.string(),
+  channel: z.nullable(GetChannelEndpointResponseDtoChannel$inboundSchema),
+  providerId: z.nullable(GetChannelEndpointResponseDtoProviderId$inboundSchema),
+  integrationIdentifier: z.nullable(z.string()),
+  connectionIdentifier: z.nullable(z.string()),
+  subscriberId: z.nullable(z.string()),
+  contextKeys: z.array(z.string()),
+  type: GetChannelEndpointResponseDtoType$inboundSchema,
+  endpoint: z.union([
+    SlackChannelEndpointDto$inboundSchema,
+    SlackUserEndpointDto$inboundSchema,
+    WebhookEndpointDto$inboundSchema,
+    PhoneEndpointDto$inboundSchema,
+  ]),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+export function getChannelEndpointResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChannelEndpointResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChannelEndpointResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChannelEndpointResponseDto' from JSON`,
+  );
+}

package/src/models/components/getcontextresponsedto.ts

@@ -7,33 +7,29 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type GetContextResponseDtoData = {};
-
 export type GetContextResponseDto = {
+  /**
+   * Context type (e.g., tenant, app, workspace)
+   */
   type: string;
+  /**
+   * Unique identifier for this context
+   */
   id: string;
-  data: GetContextResponseDtoData;
+  /**
+   * Custom data associated with this context
+   */
+  data: { [k: string]: any };
+  /**
+   * Creation timestamp
+   */
   createdAt: string;
+  /**
+   * Last update timestamp
+   */
   updatedAt: string;
 };
 
-/** @internal */
-export const GetContextResponseDtoData$inboundSchema: z.ZodType<
-  GetContextResponseDtoData,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-export function getContextResponseDtoDataFromJSON(
-  jsonString: string,
-): SafeParseResult<GetContextResponseDtoData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetContextResponseDtoData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetContextResponseDtoData' from JSON`,
-  );
-}
-
 /** @internal */
 export const GetContextResponseDto$inboundSchema: z.ZodType<
   GetContextResponseDto,
@@ -42,7 +38,7 @@ export const GetContextResponseDto$inboundSchema: z.ZodType<
 > = z.object({
   type: z.string(),
   id: z.string(),
-  data: z.lazy(() => GetContextResponseDtoData$inboundSchema),
+  data: z.record(z.any()),
   createdAt: z.string(),
   updatedAt: z.string(),
 });

package/src/models/components/getmasterjsonresponsedto.ts

@@ -7,66 +7,25 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * All translations for given locale organized by workflow identifier
- */
-export type Workflows = {};
-
-/**
- * All translations for given locale organized by layout identifier
- */
-export type Layouts = {};
-
 export type GetMasterJsonResponseDto = {
   /**
    * All translations for given locale organized by workflow identifier
    */
-  workflows: Workflows;
+  workflows: { [k: string]: any };
   /**
    * All translations for given locale organized by layout identifier
    */
-  layouts: Layouts;
+  layouts: { [k: string]: any };
 };
 
-/** @internal */
-export const Workflows$inboundSchema: z.ZodType<
-  Workflows,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-export function workflowsFromJSON(
-  jsonString: string,
-): SafeParseResult<Workflows, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Workflows$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Workflows' from JSON`,
-  );
-}
-
-/** @internal */
-export const Layouts$inboundSchema: z.ZodType<Layouts, z.ZodTypeDef, unknown> =
-  z.object({});
-
-export function layoutsFromJSON(
-  jsonString: string,
-): SafeParseResult<Layouts, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Layouts$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Layouts' from JSON`,
-  );
-}
-
 /** @internal */
 export const GetMasterJsonResponseDto$inboundSchema: z.ZodType<
   GetMasterJsonResponseDto,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  workflows: z.lazy(() => Workflows$inboundSchema),
-  layouts: z.lazy(() => Layouts$inboundSchema),
+  workflows: z.record(z.any()),
+  layouts: z.record(z.any()),
 });
 
 export function getMasterJsonResponseDtoFromJSON(

package/src/models/components/getpreferencesresponsedto.ts

@@ -58,6 +58,11 @@ export type Workflow = {
   severity: SeverityLevelEnum;
 };
 
+/**
+ * Condition using JSON Logic rules
+ */
+export type Condition = {};
+
 export type GetPreferencesResponseDto = {
   /**
    * The level of the preference (global or template)
@@ -75,6 +80,10 @@ export type GetPreferencesResponseDto = {
    * Channel-specific preference settings
    */
   channels: SubscriberPreferenceChannels;
+  /**
+   * Condition using JSON Logic rules
+   */
+  condition?: Condition | null | undefined;
 };
 
 /** @internal */
@@ -119,6 +128,23 @@ export function workflowFromJSON(
   );
 }
 
+/** @internal */
+export const Condition$inboundSchema: z.ZodType<
+  Condition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function conditionFromJSON(
+  jsonString: string,
+): SafeParseResult<Condition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Condition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Condition' from JSON`,
+  );
+}
+
 /** @internal */
 export const GetPreferencesResponseDto$inboundSchema: z.ZodType<
   GetPreferencesResponseDto,
@@ -129,6 +155,7 @@ export const GetPreferencesResponseDto$inboundSchema: z.ZodType<
   workflow: z.nullable(z.lazy(() => Workflow$inboundSchema)).optional(),
   enabled: z.boolean(),
   channels: SubscriberPreferenceChannels$inboundSchema,
+  condition: z.nullable(z.lazy(() => Condition$inboundSchema)).optional(),
 });
 
 export function getPreferencesResponseDtoFromJSON(

package/src/models/components/grouppreferencefilterdetailsdto.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GroupPreferenceFilterDetailsDto = {
+  /**
+   * List of workflow identifiers
+   */
+  workflowIds?: Array<string> | undefined;
+  /**
+   * List of tags
+   */
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export type GroupPreferenceFilterDetailsDto$Outbound = {
+  workflowIds?: Array<string> | undefined;
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GroupPreferenceFilterDetailsDto$outboundSchema: z.ZodType<
+  GroupPreferenceFilterDetailsDto$Outbound,
+  z.ZodTypeDef,
+  GroupPreferenceFilterDetailsDto
+> = z.object({
+  workflowIds: z.array(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+});
+
+export function groupPreferenceFilterDetailsDtoToJSON(
+  groupPreferenceFilterDetailsDto: GroupPreferenceFilterDetailsDto,
+): string {
+  return JSON.stringify(
+    GroupPreferenceFilterDetailsDto$outboundSchema.parse(
+      groupPreferenceFilterDetailsDto,
+    ),
+  );
+}

package/src/models/components/grouppreferencefilterdto.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  GroupPreferenceFilterDetailsDto,
+  GroupPreferenceFilterDetailsDto$Outbound,
+  GroupPreferenceFilterDetailsDto$outboundSchema,
+} from "./grouppreferencefilterdetailsdto.js";
+
+export type GroupPreferenceFilterDto = {
+  /**
+   * Whether the preference is enabled. Used when condition is not provided.
+   */
+  enabled?: boolean | undefined;
+  /**
+   * Optional condition using JSON Logic rules
+   */
+  condition?: { [k: string]: any } | undefined;
+  /**
+   * Filter criteria for workflow IDs and tags
+   */
+  filter: GroupPreferenceFilterDetailsDto;
+};
+
+/** @internal */
+export type GroupPreferenceFilterDto$Outbound = {
+  enabled?: boolean | undefined;
+  condition?: { [k: string]: any } | undefined;
+  filter: GroupPreferenceFilterDetailsDto$Outbound;
+};
+
+/** @internal */
+export const GroupPreferenceFilterDto$outboundSchema: z.ZodType<
+  GroupPreferenceFilterDto$Outbound,
+  z.ZodTypeDef,
+  GroupPreferenceFilterDto
+> = z.object({
+  enabled: z.boolean().optional(),
+  condition: z.record(z.any()).optional(),
+  filter: GroupPreferenceFilterDetailsDto$outboundSchema,
+});
+
+export function groupPreferenceFilterDtoToJSON(
+  groupPreferenceFilterDto: GroupPreferenceFilterDto,
+): string {
+  return JSON.stringify(
+    GroupPreferenceFilterDto$outboundSchema.parse(groupPreferenceFilterDto),
+  );
+}

package/src/models/components/importmasterjsonrequestdto.ts

@@ -4,11 +4,6 @@
 
 import * as z from "zod/v3";
 
-/**
- * Master JSON object containing all translations organized by workflow identifier
- */
-export type MasterJson = {};
-
 export type ImportMasterJsonRequestDto = {
   /**
    * The locale for which translations are being imported
@@ -17,27 +12,13 @@ export type ImportMasterJsonRequestDto = {
   /**
    * Master JSON object containing all translations organized by workflow identifier
    */
-  masterJson: MasterJson;
+  masterJson: { [k: string]: any };
 };
 
-/** @internal */
-export type MasterJson$Outbound = {};
-
-/** @internal */
-export const MasterJson$outboundSchema: z.ZodType<
-  MasterJson$Outbound,
-  z.ZodTypeDef,
-  MasterJson
-> = z.object({});
-
-export function masterJsonToJSON(masterJson: MasterJson): string {
-  return JSON.stringify(MasterJson$outboundSchema.parse(masterJson));
-}
-
 /** @internal */
 export type ImportMasterJsonRequestDto$Outbound = {
   locale: string;
-  masterJson: MasterJson$Outbound;
+  masterJson: { [k: string]: any };
 };
 
 /** @internal */
@@ -47,7 +28,7 @@ export const ImportMasterJsonRequestDto$outboundSchema: z.ZodType<
   ImportMasterJsonRequestDto
 > = z.object({
   locale: z.string(),
-  masterJson: z.lazy(() => MasterJson$outboundSchema),
+  masterJson: z.record(z.any()),
 });
 
 export function importMasterJsonRequestDtoToJSON(

package/src/models/components/inappcontroldto.ts

@@ -33,7 +33,7 @@ export type InAppControlDto = {
    */
   subject?: string | undefined;
   /**
-   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   * URL for an avatar image. Must be a valid URL or start with / or {{ variable }}.
    */
   avatar?: string | undefined;
   /**

package/src/models/components/inappstepresponsedto.ts

@@ -21,7 +21,6 @@ import {
   ResourceOriginEnum$inboundSchema,
 } from "./resourceoriginenum.js";
 import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 
 /**
  * Control values for the in-app step
@@ -40,7 +39,7 @@ export type InAppStepResponseDtoControlValues = {
    */
   subject?: string | undefined;
   /**
-   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   * URL for an avatar image. Must be a valid URL or start with / or {{ variable }}.
    */
   avatar?: string | undefined;
   /**
@@ -58,7 +57,7 @@ export type InAppStepResponseDtoControlValues = {
   /**
    * Disable sanitization of the output.
    */
-  disableOutputSanitization?: boolean | undefined;
+  disableOutputSanitization: boolean;
   /**
    * Additional data payload for the step.
    */
@@ -98,7 +97,7 @@ export type InAppStepResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "in_app";
   /**
    * Origin of the layout
    */
@@ -162,7 +161,7 @@ export const InAppStepResponseDto$inboundSchema: z.ZodType<
   _id: z.string(),
   name: z.string(),
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.literal("in_app"),
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),

package/src/models/components/inappstepupsertdto.ts

@@ -9,7 +9,6 @@ import {
   InAppControlDto$Outbound,
   InAppControlDto$outboundSchema,
 } from "./inappcontroldto.js";
-import { StepTypeEnum, StepTypeEnum$outboundSchema } from "./steptypeenum.js";
 
 /**
  * Control values for the In-App step.
@@ -34,7 +33,7 @@ export type InAppStepUpsertDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "in_app";
   /**
    * Control values for the In-App step.
    */
@@ -68,7 +67,7 @@ export type InAppStepUpsertDto$Outbound = {
   _id?: string | undefined;
   stepId?: string | undefined;
   name: string;
-  type: string;
+  type: "in_app";
   controlValues?: InAppControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
@@ -81,7 +80,7 @@ export const InAppStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   stepId: z.string().optional(),
   name: z.string(),
-  type: StepTypeEnum$outboundSchema,
+  type: z.literal("in_app"),
   controlValues: z.union([InAppControlDto$outboundSchema, z.record(z.any())])
     .optional(),
 }).transform((v) => {