@novu/api 3.14.0 → 3.14.2-rc.1

package/src/funcs/workflowsGet.ts

@@ -111,7 +111,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v2/workflows/{workflowId}")(pathParams);
 
   const query = encodeFormQuery({

package/src/funcs/workflowsPatch.ts

@@ -112,7 +112,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v2/workflows/{workflowId}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/workflowsStepsGeneratePreview.ts

@@ -0,0 +1,233 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeJSON, 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";
+
+/**
+ * Generate step preview
+ *
+ * @remarks
+ * Generates a preview for a specific workflow step by its unique identifier **stepId**
+ */
+export function workflowsStepsGeneratePreview(
+  client: NovuCore,
+  request: operations.WorkflowControllerGeneratePreviewRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.WorkflowControllerGeneratePreviewResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  request: operations.WorkflowControllerGeneratePreviewRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.WorkflowControllerGeneratePreviewResponse,
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.WorkflowControllerGeneratePreviewRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.GeneratePreviewRequestDto, {
+    explode: true,
+  });
+
+  const pathParams = {
+    stepId: encodeSimple("stepId", payload.stepId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    workflowId: encodeSimple("workflowId", payload.workflowId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/workflows/{workflowId}/step/{stepId}/preview")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "WorkflowController_generatePreview",
+    oAuth2Scopes: null,
+
+    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: [
+      "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.WorkflowControllerGeneratePreviewResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      201,
+      operations.WorkflowControllerGeneratePreviewResponse$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/workflowsStepsRetrieve.ts

@@ -114,7 +114,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v2/workflows/{workflowId}/steps/{stepId}")(
     pathParams,
   );

package/src/funcs/workflowsSync.ts

@@ -110,7 +110,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v2/workflows/{workflowId}/sync")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/funcs/workflowsUpdate.ts

@@ -110,7 +110,6 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-
   const path = pathToFunc("/v2/workflows/{workflowId}")(pathParams);
 
   const headers = new Headers(compactMap({

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "3.13.0",
-  sdkVersion: "3.14.0",
-  genVersion: "2.836.5",
-  userAgent: "speakeasy-sdk/typescript 3.14.0 2.836.5 3.13.0 @novu/api",
+  openapiDocVersion: "3.14.0",
+  sdkVersion: "3.14.2-rc.1",
+  genVersion: "2.879.1",
+  userAgent: "speakeasy-sdk/typescript 3.14.2-rc.1 2.879.1 3.14.0 @novu/api",
 } as const;

package/src/lib/encodings.ts

@@ -479,6 +479,23 @@ export const encodeSpaceDelimitedQuery = queryEncoder(encodeSpaceDelimited);
 export const encodePipeDelimitedQuery = queryEncoder(encodePipeDelimited);
 export const encodeDeepObjectQuery = queryEncoder(encodeDeepObject);
 
+function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const tag = val[Symbol.toStringTag];
+  if (tag !== "Blob" && tag !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}
+
 export function appendForm(
   fd: FormData,
   key: string,
@@ -487,10 +504,12 @@ export function appendForm(
 ): void {
   if (value == null) {
     return;
-  } else if (value instanceof Blob && fileName) {
-    fd.append(key, value, fileName);
-  } else if (value instanceof Blob) {
-    fd.append(key, value);
+  } else if (isBlobLike(value)) {
+    if (fileName) {
+      fd.append(key, value as Blob, fileName);
+    } else {
+      fd.append(key, value as Blob);
+    }
   } else {
     fd.append(key, String(value));
   }

package/src/lib/files.ts

@@ -80,3 +80,25 @@ export function getContentTypeFromFileName(fileName: string): string | null {
 
   return mimeTypes[ext] || null;
 }
+
+/**
+ * Creates a Blob from file content with the given MIME type.
+ *
+ * Node.js Buffers are Uint8Array subclasses that may share a pooled
+ * ArrayBuffer (byteOffset > 0, byteLength < buffer.byteLength). Passing
+ * such a Buffer directly to `new Blob([buf])` can include the entire
+ * underlying pool on some runtimes, producing a Blob with extra bytes
+ * that corrupts multipart uploads.
+ *
+ * Copying into a standalone Uint8Array ensures the Blob receives only the
+ * intended bytes regardless of runtime behaviour.
+ */
+export function bytesToBlob(
+  content: Uint8Array<ArrayBufferLike> | ArrayBuffer | Blob | string,
+  contentType: string,
+): Blob {
+  if (content instanceof Uint8Array) {
+    return new Blob([new Uint8Array(content)], { type: contentType });
+  }
+  return new Blob([content as BlobPart], { type: contentType });
+}

package/src/lib/matchers.ts

@@ -248,8 +248,9 @@ export function match<T, E>(
         raw = body;
         break;
       default:
-        encoding satisfies never;
-        throw new Error(`Unsupported response type: ${encoding}`);
+        throw new Error(
+          `Unsupported response type: ${encoding satisfies never}`,
+        );
     }
 
     if (matcher.enc === "fail") {

package/src/lib/sdks.ts

@@ -124,13 +124,15 @@ export class ClientSDK {
     if (!base) {
       return ERR(new InvalidRequestError("No base URL provided for operation"));
     }
-    const reqURL = new URL(base);
-    const inputURL = new URL(path, reqURL);
-
+    const baseURL = new URL(base);
+    let reqURL: URL;
     if (path) {
-      reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/";
-      reqURL.pathname += inputURL.pathname.replace(/^\/+/, "");
+      baseURL.pathname = baseURL.pathname.replace(/\/+$/, "") + "/";
+      reqURL = new URL(path, baseURL);
+    } else {
+      reqURL = baseURL;
     }
+    reqURL.hash = "";
 
     let finalQuery = query || "";
 

package/src/lib/security.ts

@@ -197,8 +197,7 @@ export function resolveSecurity(
         applyBearer(state, spec);
         break;
       default:
-        spec satisfies never;
-        throw SecurityError.unrecognizedType(type);
+        throw SecurityError.unrecognizedType((spec satisfies never, type));
     }
   });
 
@@ -240,8 +239,9 @@ function applyBearer(
 
 export function resolveGlobalSecurity(
   security: Partial<components.Security> | null | undefined,
+  allowedFields?: number[],
 ): SecurityState | null {
-  return resolveSecurity(
+  let inputs: SecurityInput[][] = [
     [
       {
         fieldName: "Authorization",
@@ -249,7 +249,18 @@ export function resolveGlobalSecurity(
         value: security?.secretKey,
       },
     ],
-  );
+  ];
+
+  if (allowedFields) {
+    inputs = allowedFields.map((i) => {
+      if (i < 0 || i >= inputs.length) {
+        throw new RangeError(`invalid allowedFields index ${i}`);
+      }
+      return inputs[i]!;
+    });
+  }
+
+  return resolveSecurity(...inputs);
 }
 
 export async function extractSecurity<

package/src/lib/url.ts

@@ -13,21 +13,23 @@ export function pathToFunc(
   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) {
-      if (!hasOwn.call(params, placeholder)) {
-        throw new Error(`Parameter '${placeholder}' is required`);
-      }
+    return pathPattern
+      .replace(paramRE, function (_, placeholder) {
+        if (!hasOwn.call(params, placeholder)) {
+          throw new Error(`Parameter '${placeholder}' is required`);
+        }
 
-      const value = params[placeholder];
-      if (typeof value !== "string" && typeof value !== "number") {
-        throw new Error(
-          `Parameter '${placeholder}' must be a string or number`,
-        );
-      }
+        const value = params[placeholder];
+        if (typeof value !== "string" && typeof value !== "number") {
+          throw new Error(
+            `Parameter '${placeholder}' must be a string or number`,
+          );
+        }
 
-      return options?.charEncoding === "percent"
-        ? encodeURIComponent(`${value}`)
-        : `${value}`;
-    });
+        return options?.charEncoding === "percent"
+          ? encodeURIComponent(`${value}`)
+          : `${value}`;
+      })
+      .replace(/^\/+/, "");
   };
 }

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -39,6 +39,7 @@ export const ActivityNotificationJobResponseDtoType = {
   Delay: "delay",
   Throttle: "throttle",
   Custom: "custom",
+  HttpRequest: "http_request",
 } as const;
 /**
  * Type of the job

package/src/models/components/chatrenderoutput.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 ChatRenderOutput = {
+  /**
+   * Body of the chat message
+   */
+  body: string;
+};
+
+/** @internal */
+export const ChatRenderOutput$inboundSchema: z.ZodType<
+  ChatRenderOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.string(),
+});
+
+export function chatRenderOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatRenderOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatRenderOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatRenderOutput' from JSON`,
+  );
+}

package/src/models/components/chatstepresponsedto.ts

@@ -84,6 +84,10 @@ export type ChatStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -129,6 +133,7 @@ export const ChatStepResponseDto$inboundSchema: z.ZodType<
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
+  stepResolverHash: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",

package/src/models/components/contentissueenum.ts

@@ -11,6 +11,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const ContentIssueEnum = {
   IllegalVariableInControlValue: "ILLEGAL_VARIABLE_IN_CONTROL_VALUE",
   InvalidFilterArgInVariable: "INVALID_FILTER_ARG_IN_VARIABLE",
+  InvalidUrl: "INVALID_URL",
   MissingValue: "MISSING_VALUE",
   TierLimitExceeded: "TIER_LIMIT_EXCEEDED",
 } as const;

package/src/models/components/createenvironmentvariablerequestdto.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  EnvironmentVariableValueDto,
+  EnvironmentVariableValueDto$Outbound,
+  EnvironmentVariableValueDto$outboundSchema,
+} from "./environmentvariablevaluedto.js";
+
+/**
+ * The type of the variable
+ */
+export const CreateEnvironmentVariableRequestDtoType = {
+  String: "string",
+} as const;
+/**
+ * The type of the variable
+ */
+export type CreateEnvironmentVariableRequestDtoType = ClosedEnum<
+  typeof CreateEnvironmentVariableRequestDtoType
+>;
+
+export type CreateEnvironmentVariableRequestDto = {
+  /**
+   * Unique key for the variable. Must start with a letter and contain only letters, digits, and underscores.
+   */
+  key: string;
+  /**
+   * The type of the variable
+   */
+  type?: CreateEnvironmentVariableRequestDtoType | undefined;
+  /**
+   * Whether this variable is a secret (encrypted at rest, masked in responses)
+   */
+  isSecret?: boolean | undefined;
+  values?: Array<EnvironmentVariableValueDto> | undefined;
+};
+
+/** @internal */
+export const CreateEnvironmentVariableRequestDtoType$outboundSchema:
+  z.ZodNativeEnum<typeof CreateEnvironmentVariableRequestDtoType> = z
+    .nativeEnum(CreateEnvironmentVariableRequestDtoType);
+
+/** @internal */
+export type CreateEnvironmentVariableRequestDto$Outbound = {
+  key: string;
+  type?: string | undefined;
+  isSecret?: boolean | undefined;
+  values?: Array<EnvironmentVariableValueDto$Outbound> | undefined;
+};
+
+/** @internal */
+export const CreateEnvironmentVariableRequestDto$outboundSchema: z.ZodType<
+  CreateEnvironmentVariableRequestDto$Outbound,
+  z.ZodTypeDef,
+  CreateEnvironmentVariableRequestDto
+> = z.object({
+  key: z.string(),
+  type: CreateEnvironmentVariableRequestDtoType$outboundSchema.optional(),
+  isSecret: z.boolean().optional(),
+  values: z.array(EnvironmentVariableValueDto$outboundSchema).optional(),
+});
+
+export function createEnvironmentVariableRequestDtoToJSON(
+  createEnvironmentVariableRequestDto: CreateEnvironmentVariableRequestDto,
+): string {
+  return JSON.stringify(
+    CreateEnvironmentVariableRequestDto$outboundSchema.parse(
+      createEnvironmentVariableRequestDto,
+    ),
+  );
+}

package/src/models/components/createworkflowdto.ts

@@ -29,6 +29,11 @@ import {
   EmailStepUpsertDto$Outbound,
   EmailStepUpsertDto$outboundSchema,
 } from "./emailstepupsertdto.js";
+import {
+  HttpRequestStepUpsertDto,
+  HttpRequestStepUpsertDto$Outbound,
+  HttpRequestStepUpsertDto$outboundSchema,
+} from "./httprequeststepupsertdto.js";
 import {
   InAppStepUpsertDto,
   InAppStepUpsertDto$Outbound,
@@ -72,7 +77,8 @@ export type Steps =
   | DelayStepUpsertDto
   | DigestStepUpsertDto
   | ThrottleStepUpsertDto
-  | CustomStepUpsertDto;
+  | CustomStepUpsertDto
+  | HttpRequestStepUpsertDto;
 
 export type CreateWorkflowDto = {
   /**
@@ -120,6 +126,7 @@ export type CreateWorkflowDto = {
     | DigestStepUpsertDto
     | ThrottleStepUpsertDto
     | CustomStepUpsertDto
+    | HttpRequestStepUpsertDto
   >;
   /**
    * Source of workflow creation
@@ -145,7 +152,8 @@ export type Steps$Outbound =
   | DelayStepUpsertDto$Outbound
   | DigestStepUpsertDto$Outbound
   | ThrottleStepUpsertDto$Outbound
-  | CustomStepUpsertDto$Outbound;
+  | CustomStepUpsertDto$Outbound
+  | HttpRequestStepUpsertDto$Outbound;
 
 /** @internal */
 export const Steps$outboundSchema: z.ZodType<
@@ -162,6 +170,7 @@ export const Steps$outboundSchema: z.ZodType<
   DigestStepUpsertDto$outboundSchema,
   ThrottleStepUpsertDto$outboundSchema,
   CustomStepUpsertDto$outboundSchema,
+  HttpRequestStepUpsertDto$outboundSchema,
 ]);
 
 export function stepsToJSON(steps: Steps): string {
@@ -188,6 +197,7 @@ export type CreateWorkflowDto$Outbound = {
     | DigestStepUpsertDto$Outbound
     | ThrottleStepUpsertDto$Outbound
     | CustomStepUpsertDto$Outbound
+    | HttpRequestStepUpsertDto$Outbound
   >;
   __source: string;
   preferences?: PreferencesRequestDto$Outbound | undefined;
@@ -219,6 +229,7 @@ export const CreateWorkflowDto$outboundSchema: z.ZodType<
       DigestStepUpsertDto$outboundSchema,
       ThrottleStepUpsertDto$outboundSchema,
       CustomStepUpsertDto$outboundSchema,
+      HttpRequestStepUpsertDto$outboundSchema,
     ]),
   ),
   source: WorkflowCreationSourceEnum$outboundSchema.default("editor"),