@novu/api 3.11.0 → 3.11.2

package/src/models/components/digeststepupsertdto.ts

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

package/src/models/components/emailstepresponsedto.ts

@@ -20,7 +20,6 @@ import {
   ResourceOriginEnum$inboundSchema,
 } from "./resourceoriginenum.js";
 import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 
 /**
  * Type of editor to use for the body.
@@ -51,15 +50,15 @@ export type EmailStepResponseDtoControlValues = {
   /**
    * Body content of the email, either a valid Maily JSON object, or html string.
    */
-  body?: string | undefined;
+  body: string;
   /**
    * Type of editor to use for the body.
    */
-  editorType?: EmailStepResponseDtoEditorType | undefined;
+  editorType: EmailStepResponseDtoEditorType;
   /**
    * Disable sanitization of the output.
    */
-  disableOutputSanitization?: boolean | undefined;
+  disableOutputSanitization: boolean;
   /**
    * Layout ID to use for the email. Null means no layout, undefined means default layout.
    */
@@ -99,7 +98,7 @@ export type EmailStepResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "email";
   /**
    * Origin of the layout
    */
@@ -165,7 +164,7 @@ export const EmailStepResponseDto$inboundSchema: z.ZodType<
   _id: z.string(),
   name: z.string(),
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.literal("email"),
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),

package/src/models/components/emailstepupsertdto.ts

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

package/src/models/components/generatechatoauthurlrequestdto.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type GenerateChatOauthUrlRequestDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type GenerateChatOauthUrlRequestDtoContext =
+  | GenerateChatOauthUrlRequestDtoContext2
+  | string;
+
+export type GenerateChatOauthUrlRequestDto = {
+  /**
+   * The subscriber ID to link the channel connection to. For Slack: Required for incoming webhook endpoints, optional for workspace connections. For MS Teams: Optional. Admin consent is tenant-wide and can be associated with a subscriber for organizational purposes.
+   */
+  subscriberId?: string | undefined;
+  /**
+   * Integration identifier
+   */
+  integrationIdentifier: string;
+  /**
+   * Identifier of the channel connection that will be created
+   */
+  connectionIdentifier?: string | undefined;
+  context?:
+    | { [k: string]: GenerateChatOauthUrlRequestDtoContext2 | string }
+    | undefined;
+  /**
+   * **Slack only**: OAuth scopes to request during authorization. These define the permissions your Slack integration will have. If not specified, default scopes will be used: chat:write, chat:write.public, channels:read, groups:read, users:read, users:read.email. **MS Teams**: This parameter is ignored. MS Teams uses admin consent with pre-configured permissions in Azure AD. Note: The generated OAuth URL expires after 5 minutes.
+   */
+  scope?: Array<string> | undefined;
+};
+
+/** @internal */
+export type GenerateChatOauthUrlRequestDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const GenerateChatOauthUrlRequestDtoContext2$outboundSchema: z.ZodType<
+  GenerateChatOauthUrlRequestDtoContext2$Outbound,
+  z.ZodTypeDef,
+  GenerateChatOauthUrlRequestDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function generateChatOauthUrlRequestDtoContext2ToJSON(
+  generateChatOauthUrlRequestDtoContext2:
+    GenerateChatOauthUrlRequestDtoContext2,
+): string {
+  return JSON.stringify(
+    GenerateChatOauthUrlRequestDtoContext2$outboundSchema.parse(
+      generateChatOauthUrlRequestDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type GenerateChatOauthUrlRequestDtoContext$Outbound =
+  | GenerateChatOauthUrlRequestDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const GenerateChatOauthUrlRequestDtoContext$outboundSchema: z.ZodType<
+  GenerateChatOauthUrlRequestDtoContext$Outbound,
+  z.ZodTypeDef,
+  GenerateChatOauthUrlRequestDtoContext
+> = z.union([
+  z.lazy(() => GenerateChatOauthUrlRequestDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function generateChatOauthUrlRequestDtoContextToJSON(
+  generateChatOauthUrlRequestDtoContext: GenerateChatOauthUrlRequestDtoContext,
+): string {
+  return JSON.stringify(
+    GenerateChatOauthUrlRequestDtoContext$outboundSchema.parse(
+      generateChatOauthUrlRequestDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type GenerateChatOauthUrlRequestDto$Outbound = {
+  subscriberId?: string | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  context?: {
+    [k: string]: GenerateChatOauthUrlRequestDtoContext2$Outbound | string;
+  } | undefined;
+  scope?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GenerateChatOauthUrlRequestDto$outboundSchema: z.ZodType<
+  GenerateChatOauthUrlRequestDto$Outbound,
+  z.ZodTypeDef,
+  GenerateChatOauthUrlRequestDto
+> = z.object({
+  subscriberId: z.string().optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => GenerateChatOauthUrlRequestDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  scope: z.array(z.string()).optional(),
+});
+
+export function generateChatOauthUrlRequestDtoToJSON(
+  generateChatOauthUrlRequestDto: GenerateChatOauthUrlRequestDto,
+): string {
+  return JSON.stringify(
+    GenerateChatOauthUrlRequestDto$outboundSchema.parse(
+      generateChatOauthUrlRequestDto,
+    ),
+  );
+}

package/src/models/components/generatechatoauthurlresponsedto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GenerateChatOAuthUrlResponseDto = {
+  /**
+   * The OAuth authorization URL for the chat provider. For Slack: https://slack.com/oauth/v2/authorize?... For MS Teams: https://login.microsoftonline.com/.../adminconsent?... This URL should be presented to the user to authorize the integration. Expires after 5 minutes.
+   */
+  url: string;
+};
+
+/** @internal */
+export const GenerateChatOAuthUrlResponseDto$inboundSchema: z.ZodType<
+  GenerateChatOAuthUrlResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+});
+
+export function generateChatOAuthUrlResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GenerateChatOAuthUrlResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GenerateChatOAuthUrlResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GenerateChatOAuthUrlResponseDto' from JSON`,
+  );
+}

package/src/models/components/getchannelconnectionresponsedto.ts

@@ -0,0 +1,187 @@
+/*
+ * 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 { AuthDto, AuthDto$inboundSchema } from "./authdto.js";
+import { WorkspaceDto, WorkspaceDto$inboundSchema } from "./workspacedto.js";
+
+/**
+ * The channel type (email, sms, push, chat, etc.).
+ */
+export const Channel = {
+  InApp: "in_app",
+  Email: "email",
+  Sms: "sms",
+  Chat: "chat",
+  Push: "push",
+} as const;
+/**
+ * The channel type (email, sms, push, chat, etc.).
+ */
+export type Channel = ClosedEnum<typeof Channel>;
+
+/**
+ * The provider identifier (e.g., sendgrid, twilio, slack, etc.).
+ */
+export const ProviderId = {
+  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 ProviderId = ClosedEnum<typeof ProviderId>;
+
+export type GetChannelConnectionResponseDto = {
+  /**
+   * The unique identifier of the channel endpoint.
+   */
+  identifier: string;
+  /**
+   * The channel type (email, sms, push, chat, etc.).
+   */
+  channel: Channel | null;
+  /**
+   * The provider identifier (e.g., sendgrid, twilio, slack, etc.).
+   */
+  providerId: ProviderId | null;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string | null;
+  /**
+   * The subscriber ID to which the channel connection is linked
+   */
+  subscriberId: string | null;
+  /**
+   * The context of the channel connection
+   */
+  contextKeys: Array<string>;
+  workspace: WorkspaceDto;
+  auth: AuthDto;
+  /**
+   * 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 Channel$inboundSchema: z.ZodNativeEnum<typeof Channel> = z
+  .nativeEnum(Channel);
+
+/** @internal */
+export const ProviderId$inboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
+  .nativeEnum(ProviderId);
+
+/** @internal */
+export const GetChannelConnectionResponseDto$inboundSchema: z.ZodType<
+  GetChannelConnectionResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identifier: z.string(),
+  channel: z.nullable(Channel$inboundSchema),
+  providerId: z.nullable(ProviderId$inboundSchema),
+  integrationIdentifier: z.nullable(z.string()),
+  subscriberId: z.nullable(z.string()),
+  contextKeys: z.array(z.string()),
+  workspace: WorkspaceDto$inboundSchema,
+  auth: AuthDto$inboundSchema,
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+export function getChannelConnectionResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChannelConnectionResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChannelConnectionResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChannelConnectionResponseDto' from JSON`,
+  );
+}