@novu/api 1.2.0 → 1.3.0

package/src/funcs/topicsSubscriptionsList.ts

@@ -28,7 +28,7 @@ import { Result } from "../types/fp.js";
  * List topic subscriptions
  *
  * @remarks
- * List all topics that a subscriber is subscribed to.
+ * List all subscriptions of subscribers for a topic.
  *     Checkout all available filters in the query section.
  */
 export function topicsSubscriptionsList(
@@ -39,9 +39,7 @@ export function topicsSubscriptionsList(
   Result<
     operations.TopicsControllerListTopicSubscriptionsResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -67,9 +65,7 @@ async function $do(
     Result<
       operations.TopicsControllerListTopicSubscriptionsResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -127,6 +123,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "TopicsController_listTopicSubscriptions",
     oAuth2Scopes: [],
@@ -158,6 +155,7 @@ async function $do(
     headers: headers,
     query: query,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -199,9 +197,7 @@ async function $do(
   const [result] = await M.match<
     operations.TopicsControllerListTopicSubscriptionsResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/topicsUpdate.ts

@@ -41,9 +41,7 @@ export function topicsUpdate(
   Result<
     operations.TopicsControllerUpdateTopicResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -73,9 +71,7 @@ async function $do(
     Result<
       operations.TopicsControllerUpdateTopicResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -131,6 +127,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "TopicsController_updateTopic",
     oAuth2Scopes: [],
@@ -161,6 +158,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -202,9 +200,7 @@ async function $do(
   const [result] = await M.match<
     operations.TopicsControllerUpdateTopicResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/trigger.ts

@@ -42,10 +42,9 @@ export function trigger(
 ): APIPromise<
   Result<
     operations.EventsControllerTriggerResponse,
-    | errors.ErrorDto
+    | errors.PayloadValidationExceptionDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -72,10 +71,9 @@ async function $do(
   [
     Result<
       operations.EventsControllerTriggerResponse,
-      | errors.ErrorDto
+      | errors.PayloadValidationExceptionDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -123,6 +121,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_trigger",
     oAuth2Scopes: [],
@@ -153,6 +152,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -193,10 +193,9 @@ async function $do(
 
   const [result] = await M.match<
     operations.EventsControllerTriggerResponse,
-    | errors.ErrorDto
+    | errors.PayloadValidationExceptionDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -209,9 +208,12 @@ async function $do(
       hdrs: true,
       key: "Result",
     }),
+    M.jsonErr(400, errors.PayloadValidationExceptionDto$inboundSchema, {
+      hdrs: true,
+    }),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
-      [400, 401, 403, 404, 405, 409, 413, 415],
+      [401, 403, 404, 405, 409, 413, 415],
       errors.ErrorDto$inboundSchema,
       { hdrs: true },
     ),

package/src/funcs/triggerBroadcast.ts

@@ -40,10 +40,9 @@ export function triggerBroadcast(
 ): APIPromise<
   Result<
     operations.EventsControllerBroadcastEventToAllResponse,
-    | errors.ErrorDto
+    | errors.PayloadValidationExceptionDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -70,10 +69,9 @@ async function $do(
   [
     Result<
       operations.EventsControllerBroadcastEventToAllResponse,
-      | errors.ErrorDto
+      | errors.PayloadValidationExceptionDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -122,6 +120,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_broadcastEventToAll",
     oAuth2Scopes: [],
@@ -152,6 +151,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -192,10 +192,9 @@ async function $do(
 
   const [result] = await M.match<
     operations.EventsControllerBroadcastEventToAllResponse,
-    | errors.ErrorDto
+    | errors.PayloadValidationExceptionDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -209,9 +208,12 @@ async function $do(
       operations.EventsControllerBroadcastEventToAllResponse$inboundSchema,
       { hdrs: true, key: "Result" },
     ),
+    M.jsonErr(400, errors.PayloadValidationExceptionDto$inboundSchema, {
+      hdrs: true,
+    }),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
-      [400, 401, 403, 404, 405, 409, 413, 415],
+      [401, 403, 404, 405, 409, 413, 415],
       errors.ErrorDto$inboundSchema,
       { hdrs: true },
     ),

package/src/funcs/triggerBulk.ts

@@ -41,10 +41,9 @@ export function triggerBulk(
 ): APIPromise<
   Result<
     operations.EventsControllerTriggerBulkResponse,
-    | errors.ErrorDto
+    | errors.PayloadValidationExceptionDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -71,10 +70,9 @@ async function $do(
   [
     Result<
       operations.EventsControllerTriggerBulkResponse,
-      | errors.ErrorDto
+      | errors.PayloadValidationExceptionDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -122,6 +120,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_triggerBulk",
     oAuth2Scopes: [],
@@ -152,6 +151,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -192,10 +192,9 @@ async function $do(
 
   const [result] = await M.match<
     operations.EventsControllerTriggerBulkResponse,
-    | errors.ErrorDto
+    | errors.PayloadValidationExceptionDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -208,9 +207,12 @@ async function $do(
       hdrs: true,
       key: "Result",
     }),
+    M.jsonErr(400, errors.PayloadValidationExceptionDto$inboundSchema, {
+      hdrs: true,
+    }),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
-      [400, 401, 403, 404, 405, 409, 413, 415],
+      [401, 403, 404, 405, 409, 413, 415],
       errors.ErrorDto$inboundSchema,
       { hdrs: true },
     ),

package/src/hooks/types.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { SDKOptions } from "../lib/config.js";
 import { HTTPClient, RequestInput } from "../lib/http.js";
 import { RetryConfig } from "../lib/retries.js";
 import { SecurityState } from "../lib/security.js";
@@ -13,6 +14,7 @@ export type HookContext = {
   securitySource?: any | (() => Promise<any>);
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;
+  options: SDKOptions;
 };
 
 export type Awaitable<T> = T | Promise<T>;

package/src/index.ts

@@ -4,4 +4,6 @@
 
 export * from "./lib/config.js";
 export * as files from "./lib/files.js";
+export { HTTPClient } from "./lib/http.js";
+export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
 export * from "./sdk/sdk.js";

package/src/lib/config.ts

@@ -27,6 +27,10 @@ export type SDKOptions = {
    * Allows overriding the default server URL used by the SDK
    */
   serverURL?: string | undefined;
+  /**
+   * Allows overriding the default user agent used by the SDK
+   */
+  userAgent?: string | undefined;
   /**
    * Allows overriding the default retry config used by the SDK
    */
@@ -55,7 +59,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.2.0",
-  sdkVersion: "1.2.0",
-  genVersion: "2.610.0",
-  userAgent: "speakeasy-sdk/typescript 1.2.0 2.610.0 2.2.0 @novu/api",
+  sdkVersion: "1.3.0",
+  genVersion: "2.620.2",
+  userAgent: "speakeasy-sdk/typescript 1.3.0 2.620.2 2.2.0 @novu/api",
 } as const;

package/src/lib/sdks.ts

@@ -64,6 +64,7 @@ type RequestConfig = {
   headers?: HeadersInit;
   security?: SecurityState | null;
   uaHeader?: string;
+  userAgent?: string | undefined;
   timeoutMs?: number;
 };
 
@@ -95,19 +96,21 @@ export class ClientSDK {
     } else {
       this.#hooks = new SDKHooks();
     }
-    this._options = { ...options, hooks: this.#hooks };
-
     const url = serverURLFromOptions(options);
     if (url) {
       url.pathname = url.pathname.replace(/\/+$/, "") + "/";
     }
+
     const { baseURL, client } = this.#hooks.sdkInit({
       baseURL: url,
       client: options.httpClient || new HTTPClient(),
     });
     this._baseURL = baseURL;
     this.#httpClient = client;
-    this.#logger = options.debugLogger;
+
+    this._options = { ...options, hooks: this.#hooks };
+
+    this.#logger = this._options.debugLogger;
   }
 
   public _createRequest(
@@ -180,7 +183,10 @@ export class ClientSDK {
     // Only set user agent header in non-browser-like environments since CORS
     // policy disallows setting it in browsers e.g. Chrome throws an error.
     if (!isBrowserLike) {
-      headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent);
+      headers.set(
+        conf.uaHeader ?? "user-agent",
+        conf.userAgent ?? SDK_METADATA.userAgent,
+      );
     }
 
     const fetchOptions: Omit<RequestInit, "method" | "body"> = {

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.2.0",
+    currentVersion: "1.3.0",
   },
 });
 

package/src/mcp-server/server.ts

@@ -66,7 +66,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "1.2.0",
+    version: "1.3.0",
   });
 
   const client = new NovuCore({

package/src/mcp-server/tools/subscribersDelete.ts

@@ -13,9 +13,10 @@ const args = {
 
 export const tool$subscribersDelete: ToolDefinition<typeof args> = {
   name: "subscribers-delete",
-  description: `Delete subscriber
+  description: `Delete a subscriber
 
-Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions`,
+Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions. 
+      **subscriberId** is a required field.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersDelete(

package/src/mcp-server/tools/subscribersRetrieve.ts

@@ -15,7 +15,7 @@ export const tool$subscribersRetrieve: ToolDefinition<typeof args> = {
   name: "subscribers-retrieve",
   description: `Retrieve a subscriber
 
-Retrive a subscriber by its unique key identifier **subscriberId**. 
+Retrieve a subscriber by its unique key identifier **subscriberId**. 
     **subscriberId** field is required.`,
   args,
   tool: async (client, args, ctx) => {

package/src/mcp-server/tools/topicsSubscriptionsList.ts

@@ -15,7 +15,7 @@ export const tool$topicsSubscriptionsList: ToolDefinition<typeof args> = {
   name: "topics-subscriptions-list",
   description: `List topic subscriptions
 
-List all topics that a subscriber is subscribed to.
+List all subscriptions of subscribers for a topic.
     Checkout all available filters in the query section.`,
   args,
   tool: async (client, args, ctx) => {

package/src/models/components/index.ts

@@ -84,6 +84,7 @@ export * from "./ordinalvalueenum.js";
 export * from "./patchpreferencechannelsdto.js";
 export * from "./patchsubscriberpreferencesdto.js";
 export * from "./patchsubscriberrequestdto.js";
+export * from "./payloadvalidationerrordto.js";
 export * from "./preferenceoverridesourceenum.js";
 export * from "./providersidenum.js";
 export * from "./removesubscriberresponsedto.js";

package/src/models/components/notificationfeeditemdto.ts

@@ -63,7 +63,7 @@ export type NotificationFeedItemDto = {
   /**
    * Identifier for the message template used.
    */
-  messageTemplateId: string;
+  messageTemplateId?: string | undefined;
   /**
    * Identifier for the organization sending the notification.
    */
@@ -184,7 +184,7 @@ export const NotificationFeedItemDto$inboundSchema: z.ZodType<
   _id: z.string(),
   _templateId: z.string(),
   _environmentId: z.string(),
-  _messageTemplateId: z.string(),
+  _messageTemplateId: z.string().optional(),
   _organizationId: z.string(),
   _notificationId: z.string(),
   _subscriberId: z.string(),
@@ -230,7 +230,7 @@ export type NotificationFeedItemDto$Outbound = {
   _id: string;
   _templateId: string;
   _environmentId: string;
-  _messageTemplateId: string;
+  _messageTemplateId?: string | undefined;
   _organizationId: string;
   _notificationId: string;
   _subscriberId: string;
@@ -264,7 +264,7 @@ export const NotificationFeedItemDto$outboundSchema: z.ZodType<
   id: z.string(),
   templateId: z.string(),
   environmentId: z.string(),
-  messageTemplateId: z.string(),
+  messageTemplateId: z.string().optional(),
   organizationId: z.string(),
   notificationId: z.string(),
   subscriberId: z.string(),