@novu/api 1.4.0 → 1.5.0

package/src/funcs/environmentsGetTags.ts

@@ -0,0 +1,232 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { NovuError } from "../models/errors/novuerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get environment tags
+ *
+ * @remarks
+ * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.
+ */
+export function environmentsGetTags(
+  client: NovuCore,
+  environmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.EnvironmentsControllerGetEnvironmentTagsResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    environmentId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  environmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EnvironmentsControllerGetEnvironmentTagsResponse,
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.EnvironmentsControllerGetEnvironmentTagsRequest = {
+    environmentId: environmentId,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    environmentId: encodeSimple("environmentId", payload.environmentId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/environments/{environmentId}/tags")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "EnvironmentsController_getEnvironmentTags",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "413",
+      "414",
+      "415",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "503",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.EnvironmentsControllerGetEnvironmentTagsResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 405, 409, 413, 415],
+      errors.ErrorDto$inboundSchema,
+      { hdrs: true },
+    ),
+    M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(429),
+    M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(503),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/retrieve.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { NovuError } from "../models/errors/novuerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export function retrieve(
+  client: NovuCore,
+  request: operations.LogsControllerGetLogsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LogsControllerGetLogsResponseBody,
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  request: operations.LogsControllerGetLogsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LogsControllerGetLogsResponseBody,
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.LogsControllerGetLogsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/logs/requests")();
+
+  const query = encodeFormQuery({
+    "created": payload.created,
+    "limit": payload.limit,
+    "page": payload.page,
+    "statusCode": payload.statusCode,
+    "transactionId": payload.transactionId,
+    "url": payload.url,
+    "url_pattern": payload.url_pattern,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "LogsController_getLogs",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.LogsControllerGetLogsResponseBody,
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.LogsControllerGetLogsResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/subscribersCredentialsAppend.ts

@@ -27,11 +27,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Upsert provider credentials
+ * Create or Partially Update provider credentials
  *
  * @remarks
- * Update credentials for a provider such as **slack** and **FCM**.
- *       **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
+ * Create or Partially credentials for a provider such as **slack** and **FCM**.
+ *       **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.
  */
 export function subscribersCredentialsAppend(
   client: NovuCore,

package/src/funcs/subscribersCredentialsUpdate.ts

@@ -27,11 +27,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update provider credentials
+ * Upsert provider credentials
  *
  * @remarks
- * Update credentials for a provider such as slack and push tokens.
- *       **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
+ * Upsert credentials for a provider such as slack and push tokens.
+ *       **providerId** is required field. This API creates **deviceTokens** or appends to the existing ones.
  */
 export function subscribersCredentialsUpdate(
   client: NovuCore,

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.2.0",
-  sdkVersion: "1.4.0",
-  genVersion: "2.630.6",
-  userAgent: "speakeasy-sdk/typescript 1.4.0 2.630.6 2.2.0 @novu/api",
+  openapiDocVersion: "2.3.0",
+  sdkVersion: "1.5.0",
+  genVersion: "2.661.4",
+  userAgent: "speakeasy-sdk/typescript 1.5.0 2.661.4 2.3.0 @novu/api",
 } as const;

package/src/mcp-server/cli/start/command.ts

@@ -6,7 +6,6 @@ import { buildCommand } from "@stricli/core";
 import { numberParser } from "@stricli/core";
 import * as z from "zod";
 import { consoleLoggerLevels } from "../../console-logger.js";
-import { mcpScopes } from "../../scopes.js";
 
 export const startCommand = buildCommand({
   loader: async () => {
@@ -37,18 +36,6 @@ export const startCommand = buildCommand({
           return z.string().parse(value);
         },
       },
-      ...(mcpScopes.length
-        ? {
-          scope: {
-            kind: "enum",
-            brief:
-              "Mount tools/resources that match given scope (repeatable flag)",
-            values: mcpScopes,
-            variadic: true,
-            optional: true,
-          },
-        }
-        : {}),
       "secret-key": {
         kind: "parsed",
         brief: "Sets the secretKey auth field for the API",

package/src/mcp-server/cli/start/impl.ts

@@ -11,14 +11,12 @@ import {
   ConsoleLoggerLevel,
   createConsoleLogger,
 } from "../../console-logger.js";
-import { MCPScope } from "../../scopes.js";
 import { createMCPServer } from "../../server.js";
 
 interface StartCommandFlags {
   readonly transport: "stdio" | "sse";
   readonly port: number;
   readonly tool?: string[];
-  readonly scope?: MCPScope[];
   readonly "secret-key"?: string | undefined;
   readonly "server-url"?: string;
   readonly "server-index"?: SDKOptions["serverIdx"];
@@ -49,7 +47,6 @@ async function startStdio(flags: StartCommandFlags) {
   const server = createMCPServer({
     logger,
     allowedTools: flags.tool,
-    scopes: flags.scope,
     ...{ secretKey: flags["secret-key"] ?? "" },
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],
@@ -70,7 +67,6 @@ async function startSSE(flags: StartCommandFlags) {
   const mcpServer = createMCPServer({
     logger,
     allowedTools: flags.tool,
-    scopes: flags.scope,
     ...{ secretKey: flags["secret-key"] ?? "" },
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],

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

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

package/src/mcp-server/server.ts

@@ -16,6 +16,7 @@ import { createRegisterTool } from "./tools.js";
 import { tool$cancel } from "./tools/cancel.js";
 import { tool$environmentsCreate } from "./tools/environmentsCreate.js";
 import { tool$environmentsDelete } from "./tools/environmentsDelete.js";
+import { tool$environmentsGetTags } from "./tools/environmentsGetTags.js";
 import { tool$environmentsList } from "./tools/environmentsList.js";
 import { tool$environmentsUpdate } from "./tools/environmentsUpdate.js";
 import { tool$integrationsCreate } from "./tools/integrationsCreate.js";
@@ -29,6 +30,7 @@ import { tool$messagesDeleteByTransactionId } from "./tools/messagesDeleteByTran
 import { tool$messagesRetrieve } from "./tools/messagesRetrieve.js";
 import { tool$notificationsList } from "./tools/notificationsList.js";
 import { tool$notificationsRetrieve } from "./tools/notificationsRetrieve.js";
+import { tool$retrieve } from "./tools/retrieve.js";
 import { tool$subscribersCreate } from "./tools/subscribersCreate.js";
 import { tool$subscribersCreateBulk } from "./tools/subscribersCreateBulk.js";
 import { tool$subscribersCredentialsAppend } from "./tools/subscribersCredentialsAppend.js";
@@ -78,7 +80,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "1.4.0",
+    version: "1.5.0",
   });
 
   const client = new NovuCore({
@@ -112,6 +114,12 @@ export function createMCPServer(deps: {
   tool(tool$cancel);
   tool(tool$triggerBroadcast);
   tool(tool$triggerBulk);
+  tool(tool$retrieve);
+  tool(tool$environmentsGetTags);
+  tool(tool$environmentsCreate);
+  tool(tool$environmentsList);
+  tool(tool$environmentsUpdate);
+  tool(tool$environmentsDelete);
   tool(tool$subscribersSearch);
   tool(tool$subscribersCreate);
   tool(tool$subscribersRetrieve);
@@ -130,10 +138,6 @@ export function createMCPServer(deps: {
   tool(tool$workflowsDelete);
   tool(tool$workflowsPatch);
   tool(tool$workflowsSync);
-  tool(tool$environmentsCreate);
-  tool(tool$environmentsList);
-  tool(tool$environmentsUpdate);
-  tool(tool$environmentsDelete);
   tool(tool$integrationsList);
   tool(tool$integrationsCreate);
   tool(tool$integrationsUpdate);

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { environmentsGetTags } from "../../funcs/environmentsGetTags.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  environmentId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$environmentsGetTags: ToolDefinition<typeof args> = {
+  name: "environments-get-tags",
+  description: `Get environment tags
+
+Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await environmentsGetTags(
+      client,
+      args.environmentId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { retrieve } from "../../funcs/retrieve.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.LogsControllerGetLogsRequest$inboundSchema,
+};
+
+export const tool$retrieve: ToolDefinition<typeof args> = {
+  name: "retrieve",
+  description: ``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await retrieve(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -16,10 +16,10 @@ const args = {
 
 export const tool$subscribersCredentialsAppend: ToolDefinition<typeof args> = {
   name: "subscribers-credentials-append",
-  description: `Upsert provider credentials
+  description: `Create or Partially Update provider credentials
 
-Update credentials for a provider such as **slack** and **FCM**. 
-      **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.`,
+Create or Partially credentials for a provider such as **slack** and **FCM**. 
+      **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersCredentialsAppend(

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

@@ -16,10 +16,10 @@ const args = {
 
 export const tool$subscribersCredentialsUpdate: ToolDefinition<typeof args> = {
   name: "subscribers-credentials-update",
-  description: `Update provider credentials
+  description: `Upsert provider credentials
 
-Update credentials for a provider such as slack and push tokens. 
-      **providerId** is required field. This API appends the **deviceTokens** to the existing ones.`,
+Upsert credentials for a provider such as slack and push tokens. 
+      **providerId** is required field. This API creates **deviceTokens** or appends to the existing ones.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersCredentialsUpdate(