@novu/api 3.11.0 → 3.11.2

package/src/lib/encodings.ts

@@ -102,8 +102,9 @@ export function encodeLabel(
       });
       encValue = mapped?.join("").slice(1);
     } else {
-      const k =
-        options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
@@ -426,6 +427,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 type QueryEncoderOptions = {
   explode?: boolean;
   charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
 };
 
 type QueryEncoder = (
@@ -440,7 +442,7 @@ type BulkQueryEncoder = (
 ) => string;
 
 export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
-  const bulkEncode = function (
+  const bulkEncode = function(
     values: Record<string, unknown>,
     options?: QueryEncoderOptions,
   ): string {
@@ -450,7 +452,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
       charEncoding: options?.charEncoding ?? "percent",
     };
 
+    const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
+
     const encoded = Object.entries(values).map(([key, value]) => {
+      if (allowEmptySet.has(key)) {
+        if (
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
+        ) {
+          return `${encodeURIComponent(key)}=`;
+        }
+      }
       return f(key, value, opts);
     });
     return queryJoin(...encoded);

package/src/models/components/activitynotificationresponsedto.ts

@@ -27,7 +27,6 @@ import {
   SeverityLevelEnum,
   SeverityLevelEnum$inboundSchema,
 } from "./severitylevelenum.js";
-import { StepTypeEnum, StepTypeEnum$inboundSchema } from "./steptypeenum.js";
 
 export type ActivityNotificationResponseDto = {
   /**
@@ -66,7 +65,7 @@ export type ActivityNotificationResponseDto = {
    * Last updated time of the notification
    */
   updatedAt?: string | undefined;
-  channels?: Array<StepTypeEnum> | undefined;
+  channels?: Array<string> | undefined;
   /**
    * Subscriber of the notification
    */
@@ -128,7 +127,7 @@ export const ActivityNotificationResponseDto$inboundSchema: z.ZodType<
   _digestedNotificationId: z.string().optional(),
   createdAt: z.string().optional(),
   updatedAt: z.string().optional(),
-  channels: z.array(StepTypeEnum$inboundSchema).optional(),
+  channels: z.array(z.string()).optional(),
   subscriber: ActivityNotificationSubscriberResponseDto$inboundSchema
     .optional(),
   template: ActivityNotificationTemplateResponseDto$inboundSchema.optional(),

package/src/models/components/authdto.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 AuthDto = {
+  accessToken: string;
+};
+
+/** @internal */
+export const AuthDto$inboundSchema: z.ZodType<AuthDto, z.ZodTypeDef, unknown> =
+  z.object({
+    accessToken: z.string(),
+  });
+/** @internal */
+export type AuthDto$Outbound = {
+  accessToken: string;
+};
+
+/** @internal */
+export const AuthDto$outboundSchema: z.ZodType<
+  AuthDto$Outbound,
+  z.ZodTypeDef,
+  AuthDto
+> = z.object({
+  accessToken: z.string(),
+});
+
+export function authDtoToJSON(authDto: AuthDto): string {
+  return JSON.stringify(AuthDto$outboundSchema.parse(authDto));
+}
+export function authDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthDto' from JSON`,
+  );
+}

package/src/models/components/chatstepresponsedto.ts

@@ -19,7 +19,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 chat step
@@ -68,7 +67,7 @@ export type ChatStepResponseDto = {
   /**
    * Type of the step
    */
-  type: StepTypeEnum;
+  type: "chat";
   /**
    * Origin of the layout
    */
@@ -125,7 +124,7 @@ export const ChatStepResponseDto$inboundSchema: z.ZodType<
   _id: z.string(),
   name: z.string(),
   slug: z.string(),
-  type: StepTypeEnum$inboundSchema,
+  type: z.literal("chat"),
   origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),

package/src/models/components/chatstepupsertdto.ts

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

package/src/models/components/createchannelconnectionrequestdto.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AuthDto,
+  AuthDto$Outbound,
+  AuthDto$outboundSchema,
+} from "./authdto.js";
+import {
+  WorkspaceDto,
+  WorkspaceDto$Outbound,
+  WorkspaceDto$outboundSchema,
+} from "./workspacedto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type Two = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type Context = Two | string;
+
+export type CreateChannelConnectionRequestDto = {
+  /**
+   * The unique identifier for the channel connection. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to link the channel connection to
+   */
+  subscriberId?: string | undefined;
+  context?: { [k: string]: Two | string } | undefined;
+  /**
+   * The identifier of the integration to use for this channel connection.
+   */
+  integrationIdentifier: string;
+  workspace: WorkspaceDto;
+  auth: AuthDto;
+};
+
+/** @internal */
+export type Two$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
+  .object({
+    id: z.string(),
+    data: z.record(z.any()).optional(),
+  });
+
+export function twoToJSON(two: Two): string {
+  return JSON.stringify(Two$outboundSchema.parse(two));
+}
+
+/** @internal */
+export type Context$Outbound = Two$Outbound | string;
+
+/** @internal */
+export const Context$outboundSchema: z.ZodType<
+  Context$Outbound,
+  z.ZodTypeDef,
+  Context
+> = z.union([z.lazy(() => Two$outboundSchema), z.string()]);
+
+export function contextToJSON(context: Context): string {
+  return JSON.stringify(Context$outboundSchema.parse(context));
+}
+
+/** @internal */
+export type CreateChannelConnectionRequestDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId?: string | undefined;
+  context?: { [k: string]: Two$Outbound | string } | undefined;
+  integrationIdentifier: string;
+  workspace: WorkspaceDto$Outbound;
+  auth: AuthDto$Outbound;
+};
+
+/** @internal */
+export const CreateChannelConnectionRequestDto$outboundSchema: z.ZodType<
+  CreateChannelConnectionRequestDto$Outbound,
+  z.ZodTypeDef,
+  CreateChannelConnectionRequestDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string().optional(),
+  context: z.record(z.union([z.lazy(() => Two$outboundSchema), z.string()]))
+    .optional(),
+  integrationIdentifier: z.string(),
+  workspace: WorkspaceDto$outboundSchema,
+  auth: AuthDto$outboundSchema,
+});
+
+export function createChannelConnectionRequestDtoToJSON(
+  createChannelConnectionRequestDto: CreateChannelConnectionRequestDto,
+): string {
+  return JSON.stringify(
+    CreateChannelConnectionRequestDto$outboundSchema.parse(
+      createChannelConnectionRequestDto,
+    ),
+  );
+}

package/src/models/components/createcontextrequestdto.ts

@@ -4,11 +4,6 @@
 
 import * as z from "zod/v3";
 
-/**
- * Optional custom data to associate with this context.
- */
-export type Data = {};
-
 export type CreateContextRequestDto = {
   /**
    * Context type (e.g., tenant, app, workspace). Must be lowercase alphanumeric with optional separators.
@@ -21,25 +16,14 @@ export type CreateContextRequestDto = {
   /**
    * Optional custom data to associate with this context.
    */
-  data?: Data | undefined;
+  data?: { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export type Data$Outbound = {};
-
-/** @internal */
-export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
-  z.object({});
-
-export function dataToJSON(data: Data): string {
-  return JSON.stringify(Data$outboundSchema.parse(data));
-}
-
 /** @internal */
 export type CreateContextRequestDto$Outbound = {
   type: string;
   id: string;
-  data?: Data$Outbound | undefined;
+  data?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -50,7 +34,7 @@ export const CreateContextRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   type: z.string(),
   id: z.string(),
-  data: z.lazy(() => Data$outboundSchema).optional(),
+  data: z.record(z.any()).optional(),
 });
 
 export function createContextRequestDtoToJSON(

package/src/models/components/createmsteamschannelendpointdto.ts

@@ -0,0 +1,151 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  MsTeamsChannelEndpointDto,
+  MsTeamsChannelEndpointDto$Outbound,
+  MsTeamsChannelEndpointDto$outboundSchema,
+} from "./msteamschannelendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateMsTeamsChannelEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateMsTeamsChannelEndpointDtoContext =
+  | CreateMsTeamsChannelEndpointDtoContext2
+  | string;
+
+export type CreateMsTeamsChannelEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateMsTeamsChannelEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this channel endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "ms_teams_channel";
+  /**
+   * MS Teams channel endpoint data
+   */
+  endpoint: MsTeamsChannelEndpointDto;
+};
+
+/** @internal */
+export type CreateMsTeamsChannelEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateMsTeamsChannelEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateMsTeamsChannelEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreateMsTeamsChannelEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createMsTeamsChannelEndpointDtoContext2ToJSON(
+  createMsTeamsChannelEndpointDtoContext2:
+    CreateMsTeamsChannelEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateMsTeamsChannelEndpointDtoContext2$outboundSchema.parse(
+      createMsTeamsChannelEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateMsTeamsChannelEndpointDtoContext$Outbound =
+  | CreateMsTeamsChannelEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateMsTeamsChannelEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateMsTeamsChannelEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateMsTeamsChannelEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreateMsTeamsChannelEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createMsTeamsChannelEndpointDtoContextToJSON(
+  createMsTeamsChannelEndpointDtoContext:
+    CreateMsTeamsChannelEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateMsTeamsChannelEndpointDtoContext$outboundSchema.parse(
+      createMsTeamsChannelEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateMsTeamsChannelEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?: {
+    [k: string]: CreateMsTeamsChannelEndpointDtoContext2$Outbound | string;
+  } | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "ms_teams_channel";
+  endpoint: MsTeamsChannelEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateMsTeamsChannelEndpointDto$outboundSchema: z.ZodType<
+  CreateMsTeamsChannelEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateMsTeamsChannelEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateMsTeamsChannelEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("ms_teams_channel"),
+  endpoint: MsTeamsChannelEndpointDto$outboundSchema,
+});
+
+export function createMsTeamsChannelEndpointDtoToJSON(
+  createMsTeamsChannelEndpointDto: CreateMsTeamsChannelEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateMsTeamsChannelEndpointDto$outboundSchema.parse(
+      createMsTeamsChannelEndpointDto,
+    ),
+  );
+}

package/src/models/components/createmsteamsuserendpointdto.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  MsTeamsUserEndpointDto,
+  MsTeamsUserEndpointDto$Outbound,
+  MsTeamsUserEndpointDto$outboundSchema,
+} from "./msteamsuserendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateMsTeamsUserEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateMsTeamsUserEndpointDtoContext =
+  | CreateMsTeamsUserEndpointDtoContext2
+  | string;
+
+export type CreateMsTeamsUserEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateMsTeamsUserEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this channel endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "ms_teams_user";
+  /**
+   * MS Teams user endpoint data
+   */
+  endpoint: MsTeamsUserEndpointDto;
+};
+
+/** @internal */
+export type CreateMsTeamsUserEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateMsTeamsUserEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateMsTeamsUserEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreateMsTeamsUserEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createMsTeamsUserEndpointDtoContext2ToJSON(
+  createMsTeamsUserEndpointDtoContext2: CreateMsTeamsUserEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateMsTeamsUserEndpointDtoContext2$outboundSchema.parse(
+      createMsTeamsUserEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateMsTeamsUserEndpointDtoContext$Outbound =
+  | CreateMsTeamsUserEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateMsTeamsUserEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateMsTeamsUserEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateMsTeamsUserEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreateMsTeamsUserEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createMsTeamsUserEndpointDtoContextToJSON(
+  createMsTeamsUserEndpointDtoContext: CreateMsTeamsUserEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateMsTeamsUserEndpointDtoContext$outboundSchema.parse(
+      createMsTeamsUserEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateMsTeamsUserEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?: {
+    [k: string]: CreateMsTeamsUserEndpointDtoContext2$Outbound | string;
+  } | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "ms_teams_user";
+  endpoint: MsTeamsUserEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateMsTeamsUserEndpointDto$outboundSchema: z.ZodType<
+  CreateMsTeamsUserEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateMsTeamsUserEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateMsTeamsUserEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("ms_teams_user"),
+  endpoint: MsTeamsUserEndpointDto$outboundSchema,
+});
+
+export function createMsTeamsUserEndpointDtoToJSON(
+  createMsTeamsUserEndpointDto: CreateMsTeamsUserEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateMsTeamsUserEndpointDto$outboundSchema.parse(
+      createMsTeamsUserEndpointDto,
+    ),
+  );
+}