@novu/api 1.6.0 → 1.7.0

package/src/funcs/translationsUpload.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { appendForm, 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 * as components from "../models/components/index.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";
+
+/**
+ * Upload translation files
+ *
+ * @remarks
+ * Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json
+ */
+export function translationsUpload(
+  client: NovuCore,
+  uploadTranslationsRequestDto: components.UploadTranslationsRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.UploadTranslationsResponseDto,
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    uploadTranslationsRequestDto,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  uploadTranslationsRequestDto: components.UploadTranslationsRequestDto,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.UploadTranslationsResponseDto,
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.TranslationControllerUploadTranslationFilesRequest = {
+    uploadTranslationsRequestDto: uploadTranslationsRequestDto,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations
+        .TranslationControllerUploadTranslationFilesRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = new FormData();
+
+  appendForm(
+    body,
+    "resourceId",
+    payload.UploadTranslationsRequestDto.resourceId,
+  );
+  appendForm(
+    body,
+    "resourceType",
+    payload.UploadTranslationsRequestDto.resourceType,
+  );
+
+  const path = pathToFunc("/v2/translations/upload")();
+
+  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: "TranslationController_uploadTranslationFiles",
+    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: "POST",
+    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: ["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<
+    components.UploadTranslationsResponseDto,
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.UploadTranslationsResponseDto$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/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.3.0",
-  sdkVersion: "1.6.0",
-  genVersion: "2.684.0",
-  userAgent: "speakeasy-sdk/typescript 1.6.0 2.684.0 2.3.0 @novu/api",
+  openapiDocVersion: "3.9.0",
+  sdkVersion: "1.7.0",
+  genVersion: "2.716.16",
+  userAgent: "speakeasy-sdk/typescript 1.7.0 2.716.16 3.9.0 @novu/api",
 } as const;

package/src/lib/url.ts

@@ -10,7 +10,7 @@ export function pathToFunc(
   pathPattern: string,
   options?: { charEncoding?: "percent" | "none" },
 ): (params?: Params) => string {
-  const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
     return pathPattern.replace(paramRE, function (_, placeholder) {

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

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

package/src/mcp-server/server.ts

@@ -19,12 +19,22 @@ 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$inboundWebhooksControllerHandleWebhook } from "./tools/inboundWebhooksControllerHandleWebhook.js";
 import { tool$integrationsCreate } from "./tools/integrationsCreate.js";
 import { tool$integrationsDelete } from "./tools/integrationsDelete.js";
+import { tool$integrationsIntegrationsControllerAutoConfigureIntegration } from "./tools/integrationsIntegrationsControllerAutoConfigureIntegration.js";
 import { tool$integrationsList } from "./tools/integrationsList.js";
 import { tool$integrationsListActive } from "./tools/integrationsListActive.js";
 import { tool$integrationsSetAsPrimary } from "./tools/integrationsSetAsPrimary.js";
 import { tool$integrationsUpdate } from "./tools/integrationsUpdate.js";
+import { tool$layoutsCreate } from "./tools/layoutsCreate.js";
+import { tool$layoutsDelete } from "./tools/layoutsDelete.js";
+import { tool$layoutsDuplicate } from "./tools/layoutsDuplicate.js";
+import { tool$layoutsGeneratePreview } from "./tools/layoutsGeneratePreview.js";
+import { tool$layoutsList } from "./tools/layoutsList.js";
+import { tool$layoutsRetrieve } from "./tools/layoutsRetrieve.js";
+import { tool$layoutsUpdate } from "./tools/layoutsUpdate.js";
+import { tool$layoutsUsage } from "./tools/layoutsUsage.js";
 import { tool$messagesDelete } from "./tools/messagesDelete.js";
 import { tool$messagesDeleteByTransactionId } from "./tools/messagesDeleteByTransactionId.js";
 import { tool$messagesRetrieve } from "./tools/messagesRetrieve.js";
@@ -58,6 +68,15 @@ import { tool$topicsSubscriptionsCreate } from "./tools/topicsSubscriptionsCreat
 import { tool$topicsSubscriptionsDelete } from "./tools/topicsSubscriptionsDelete.js";
 import { tool$topicsSubscriptionsList } from "./tools/topicsSubscriptionsList.js";
 import { tool$topicsUpdate } from "./tools/topicsUpdate.js";
+import { tool$translationsCreate } from "./tools/translationsCreate.js";
+import { tool$translationsDelete } from "./tools/translationsDelete.js";
+import { tool$translationsGroupsDelete } from "./tools/translationsGroupsDelete.js";
+import { tool$translationsGroupsRetrieve } from "./tools/translationsGroupsRetrieve.js";
+import { tool$translationsMasterImport } from "./tools/translationsMasterImport.js";
+import { tool$translationsMasterRetrieve } from "./tools/translationsMasterRetrieve.js";
+import { tool$translationsMasterUpload } from "./tools/translationsMasterUpload.js";
+import { tool$translationsRetrieve } from "./tools/translationsRetrieve.js";
+import { tool$translationsUpload } from "./tools/translationsUpload.js";
 import { tool$trigger } from "./tools/trigger.js";
 import { tool$triggerBroadcast } from "./tools/triggerBroadcast.js";
 import { tool$triggerBulk } from "./tools/triggerBulk.js";
@@ -80,7 +99,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "1.6.0",
+    version: "1.7.0",
   });
 
   const client = new NovuCore({
@@ -110,6 +129,7 @@ export function createMCPServer(deps: {
   const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
+  tool(tool$inboundWebhooksControllerHandleWebhook);
   tool(tool$trigger);
   tool(tool$cancel);
   tool(tool$triggerBroadcast);
@@ -119,6 +139,14 @@ export function createMCPServer(deps: {
   tool(tool$environmentsList);
   tool(tool$environmentsUpdate);
   tool(tool$environmentsDelete);
+  tool(tool$layoutsCreate);
+  tool(tool$layoutsList);
+  tool(tool$layoutsUpdate);
+  tool(tool$layoutsRetrieve);
+  tool(tool$layoutsDelete);
+  tool(tool$layoutsDuplicate);
+  tool(tool$layoutsGeneratePreview);
+  tool(tool$layoutsUsage);
   tool(tool$subscribersSearch);
   tool(tool$subscribersCreate);
   tool(tool$subscribersRetrieve);
@@ -130,6 +158,10 @@ export function createMCPServer(deps: {
   tool(tool$topicsGet);
   tool(tool$topicsUpdate);
   tool(tool$topicsDelete);
+  tool(tool$translationsCreate);
+  tool(tool$translationsRetrieve);
+  tool(tool$translationsDelete);
+  tool(tool$translationsUpload);
   tool(tool$workflowsCreate);
   tool(tool$workflowsList);
   tool(tool$workflowsUpdate);
@@ -141,6 +173,7 @@ export function createMCPServer(deps: {
   tool(tool$integrationsCreate);
   tool(tool$integrationsUpdate);
   tool(tool$integrationsDelete);
+  tool(tool$integrationsIntegrationsControllerAutoConfigureIntegration);
   tool(tool$integrationsSetAsPrimary);
   tool(tool$integrationsListActive);
   tool(tool$messagesRetrieve);
@@ -165,6 +198,11 @@ export function createMCPServer(deps: {
   tool(tool$topicsSubscriptionsCreate);
   tool(tool$topicsSubscriptionsDelete);
   tool(tool$topicsSubscribersRetrieve);
+  tool(tool$translationsGroupsDelete);
+  tool(tool$translationsGroupsRetrieve);
+  tool(tool$translationsMasterRetrieve);
+  tool(tool$translationsMasterImport);
+  tool(tool$translationsMasterUpload);
   tool(tool$workflowsStepsRetrieve);
 
   return server;

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { inboundWebhooksControllerHandleWebhook } from "../../funcs/inboundWebhooksControllerHandleWebhook.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  environmentId: z.string(),
+  integrationId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$inboundWebhooksControllerHandleWebhook: ToolDefinition<
+  typeof args
+> = {
+  name: "inbound-webhooks-controller-handle-webhook",
+  description: ``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await inboundWebhooksControllerHandleWebhook(
+      client,
+      args.environmentId,
+      args.integrationId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsIntegrationsControllerAutoConfigureIntegration } from "../../funcs/integrationsIntegrationsControllerAutoConfigureIntegration.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  integrationId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsIntegrationsControllerAutoConfigureIntegration:
+  ToolDefinition<typeof args> = {
+    name: "integrations-integrations-controller-auto-configure-integration",
+    description: `Auto-configure an integration for inbound webhooks
+
+Auto-configure an integration by its unique key identifier **integrationId** for inbound webhook support. 
+    This will automatically generate required webhook signing keys and configure webhook endpoints.`,
+    args,
+    tool: async (client, args, ctx) => {
+      const [result, apiCall] =
+        await integrationsIntegrationsControllerAutoConfigureIntegration(
+          client,
+          args.integrationId,
+          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/layoutsCreate.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsCreate } from "../../funcs/layoutsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  createLayoutDto: components.CreateLayoutDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsCreate: ToolDefinition<typeof args> = {
+  name: "layouts-create",
+  description: `Create a layout
+
+Creates a new layout in the Novu Cloud environment`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsCreate(
+      client,
+      args.createLayoutDto,
+      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/layoutsDelete.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsDelete } from "../../funcs/layoutsDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsDelete: ToolDefinition<typeof args> = {
+  name: "layouts-delete",
+  description: `Delete a layout
+
+Removes a specific layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsDelete(
+      client,
+      args.layoutId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsDuplicate } from "../../funcs/layoutsDuplicate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  duplicateLayoutDto: components.DuplicateLayoutDto$inboundSchema,
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsDuplicate: ToolDefinition<typeof args> = {
+  name: "layouts-duplicate",
+  description: `Duplicate a layout
+
+Duplicates a layout by its unique identifier **layoutId**. This will create a new layout with the content of the original layout.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsDuplicate(
+      client,
+      args.duplicateLayoutDto,
+      args.layoutId,
+      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/layoutsGeneratePreview.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsGeneratePreview } from "../../funcs/layoutsGeneratePreview.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutPreviewRequestDto: components.LayoutPreviewRequestDto$inboundSchema,
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsGeneratePreview: ToolDefinition<typeof args> = {
+  name: "layouts-generate-preview",
+  description: `Generate layout preview
+
+Generates a preview for a layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsGeneratePreview(
+      client,
+      args.layoutPreviewRequestDto,
+      args.layoutId,
+      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/layoutsList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { layoutsList } from "../../funcs/layoutsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.LayoutsControllerListRequest$inboundSchema,
+};
+
+export const tool$layoutsList: ToolDefinition<typeof args> = {
+  name: "layouts-list",
+  description: `List all layouts
+
+Retrieves a list of layouts with optional filtering and pagination`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsList(
+      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.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsRetrieve } from "../../funcs/layoutsRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsRetrieve: ToolDefinition<typeof args> = {
+  name: "layouts-retrieve",
+  description: `Retrieve a layout
+
+Fetches details of a specific layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsRetrieve(
+      client,
+      args.layoutId,
+      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);
+  },
+};