@novu/api 3.14.0 → 3.14.1

package/src/funcs/environmentsPublish.ts

@@ -0,0 +1,243 @@
+/*
+ * 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 * as components from "../models/components/index.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";
+
+/**
+ * Publish resources to target environment
+ *
+ * @remarks
+ * Publishes all workflows and resources from the source environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes.
+ */
+export function environmentsPublish(
+  client: NovuCore,
+  publishEnvironmentRequestDto: components.PublishEnvironmentRequestDto,
+  targetEnvironmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.EnvironmentsControllerPublishEnvironmentResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    publishEnvironmentRequestDto,
+    targetEnvironmentId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  publishEnvironmentRequestDto: components.PublishEnvironmentRequestDto,
+  targetEnvironmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.EnvironmentsControllerPublishEnvironmentResponse,
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.EnvironmentsControllerPublishEnvironmentRequest = {
+    publishEnvironmentRequestDto: publishEnvironmentRequestDto,
+    targetEnvironmentId: targetEnvironmentId,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.EnvironmentsControllerPublishEnvironmentRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PublishEnvironmentRequestDto, {
+    explode: true,
+  });
+
+  const pathParams = {
+    targetEnvironmentId: encodeSimple(
+      "targetEnvironmentId",
+      payload.targetEnvironmentId,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+
+  const path = pathToFunc("/v2/environments/{targetEnvironmentId}/publish")(
+    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: "EnvironmentsController_publishEnvironment",
+    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.EnvironmentsControllerPublishEnvironmentResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.EnvironmentsControllerPublishEnvironmentResponse$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/translationsMasterUpload.ts

@@ -117,6 +117,18 @@ async function $do(
       || "application/octet-stream";
     const blob = new Blob([buffer], { type: contentType });
     appendForm(body, "file", blob, payload.RequestBody.file.fileName);
+  } else if (payload.RequestBody.file.content instanceof Uint8Array) {
+    const contentType =
+      getContentTypeFromFileName(payload.RequestBody.file.fileName)
+      || "application/octet-stream";
+    appendForm(
+      body,
+      "file",
+      new Blob([new Uint8Array(payload.RequestBody.file.content).buffer], {
+        type: contentType,
+      }),
+      payload.RequestBody.file.fileName,
+    );
   } else {
     const contentType =
       getContentTypeFromFileName(payload.RequestBody.file.fileName)

package/src/funcs/translationsUpload.ts

@@ -105,7 +105,7 @@ async function $do(
   const payload = parsed.value;
   const body = new FormData();
 
-  for (const fileItem of payload.RequestBody.files) {
+  for (const fileItem of payload.RequestBody.files ?? []) {
     if (isBlobLike(fileItem)) {
       appendForm(body, "files[]", fileItem);
     } else if (isReadableStream(fileItem.content)) {
@@ -114,6 +114,17 @@ async function $do(
         || "application/octet-stream";
       const blob = new Blob([buffer], { type: contentType });
       appendForm(body, "files[]", blob, fileItem.fileName);
+    } else if (fileItem.content instanceof Uint8Array) {
+      const contentType = getContentTypeFromFileName(fileItem.fileName)
+        || "application/octet-stream";
+      appendForm(
+        body,
+        "files[]",
+        new Blob([new Uint8Array(fileItem.content).buffer], {
+          type: contentType,
+        }),
+        fileItem.fileName,
+      );
     } else {
       const contentType = getContentTypeFromFileName(fileItem.fileName)
         || "application/octet-stream";

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.1",
+  genVersion: "2.849.8",
+  userAgent: "speakeasy-sdk/typescript 3.14.1 2.849.8 3.14.0 @novu/api",
 } as const;

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/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));
     }
   });
 

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/customstepresponsedto.ts

@@ -80,6 +80,10 @@ export type CustomStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -125,6 +129,7 @@ export const CustomStepResponseDto$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/delaystepresponsedto.ts

@@ -129,6 +129,10 @@ export type DelayStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -187,6 +191,7 @@ export const DelayStepResponseDto$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/dependencyreasonenum.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Reason for the dependency
+ */
+export const DependencyReasonEnum = {
+  LayoutRequiredForWorkflow: "LAYOUT_REQUIRED_FOR_WORKFLOW",
+  LayoutExistsInTarget: "LAYOUT_EXISTS_IN_TARGET",
+} as const;
+/**
+ * Reason for the dependency
+ */
+export type DependencyReasonEnum = ClosedEnum<typeof DependencyReasonEnum>;
+
+/** @internal */
+export const DependencyReasonEnum$inboundSchema: z.ZodNativeEnum<
+  typeof DependencyReasonEnum
+> = z.nativeEnum(DependencyReasonEnum);

package/src/models/components/diffactionenum.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of change
+ */
+export const DiffActionEnum = {
+  Added: "added",
+  Modified: "modified",
+  Deleted: "deleted",
+  Unchanged: "unchanged",
+  Moved: "moved",
+} as const;
+/**
+ * Type of change
+ */
+export type DiffActionEnum = ClosedEnum<typeof DiffActionEnum>;
+
+/** @internal */
+export const DiffActionEnum$inboundSchema: z.ZodNativeEnum<
+  typeof DiffActionEnum
+> = z.nativeEnum(DiffActionEnum);

package/src/models/components/diffenvironmentrequestdto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DiffEnvironmentRequestDto = {
+  /**
+   * Source environment ID to compare from. Defaults to the Development environment if not provided.
+   */
+  sourceEnvironmentId?: string | undefined;
+};
+
+/** @internal */
+export type DiffEnvironmentRequestDto$Outbound = {
+  sourceEnvironmentId?: string | undefined;
+};
+
+/** @internal */
+export const DiffEnvironmentRequestDto$outboundSchema: z.ZodType<
+  DiffEnvironmentRequestDto$Outbound,
+  z.ZodTypeDef,
+  DiffEnvironmentRequestDto
+> = z.object({
+  sourceEnvironmentId: z.string().optional(),
+});
+
+export function diffEnvironmentRequestDtoToJSON(
+  diffEnvironmentRequestDto: DiffEnvironmentRequestDto,
+): string {
+  return JSON.stringify(
+    DiffEnvironmentRequestDto$outboundSchema.parse(diffEnvironmentRequestDto),
+  );
+}

package/src/models/components/diffenvironmentresponsedto.ts

@@ -0,0 +1,57 @@
+/*
+ * 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";
+import {
+  EnvironmentDiffSummaryDto,
+  EnvironmentDiffSummaryDto$inboundSchema,
+} from "./environmentdiffsummarydto.js";
+import {
+  ResourceDiffResultDto,
+  ResourceDiffResultDto$inboundSchema,
+} from "./resourcediffresultdto.js";
+
+export type DiffEnvironmentResponseDto = {
+  /**
+   * Source environment ID
+   */
+  sourceEnvironmentId: string;
+  /**
+   * Target environment ID
+   */
+  targetEnvironmentId: string;
+  /**
+   * Diff resources by resource type
+   */
+  resources: Array<ResourceDiffResultDto>;
+  /**
+   * Overall summary
+   */
+  summary: EnvironmentDiffSummaryDto;
+};
+
+/** @internal */
+export const DiffEnvironmentResponseDto$inboundSchema: z.ZodType<
+  DiffEnvironmentResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sourceEnvironmentId: z.string(),
+  targetEnvironmentId: z.string(),
+  resources: z.array(ResourceDiffResultDto$inboundSchema),
+  summary: EnvironmentDiffSummaryDto$inboundSchema,
+});
+
+export function diffEnvironmentResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DiffEnvironmentResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiffEnvironmentResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiffEnvironmentResponseDto' from JSON`,
+  );
+}

package/src/models/components/diffsummarydto.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 DiffSummaryDto = {
+  /**
+   * Number of added resources (workflows and steps)
+   */
+  added: number;
+  /**
+   * Number of modified resources (workflows and steps)
+   */
+  modified: number;
+  /**
+   * Number of deleted resources (workflows and steps)
+   */
+  deleted: number;
+  /**
+   * Number of unchanged resources (workflows and steps)
+   */
+  unchanged: number;
+};
+
+/** @internal */
+export const DiffSummaryDto$inboundSchema: z.ZodType<
+  DiffSummaryDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  added: z.number(),
+  modified: z.number(),
+  deleted: z.number(),
+  unchanged: z.number(),
+});
+
+export function diffSummaryDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DiffSummaryDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiffSummaryDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiffSummaryDto' from JSON`,
+  );
+}

package/src/models/components/digeststepresponsedto.ts

@@ -141,6 +141,10 @@ export type DigestStepResponseDto = {
    * Issues associated with the step
    */
   issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
 };
 
 /** @internal */
@@ -202,6 +206,7 @@ export const DigestStepResponseDto$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/emailcontroldto.ts

@@ -22,6 +22,18 @@ export type EmailControlDtoEditorType = ClosedEnum<
   typeof EmailControlDtoEditorType
 >;
 
+/**
+ * Type of renderer to use (raw HTML or React Email step resolver)
+ */
+export const RendererType = {
+  Html: "html",
+  ReactEmail: "react-email",
+} as const;
+/**
+ * Type of renderer to use (raw HTML or React Email step resolver)
+ */
+export type RendererType = ClosedEnum<typeof RendererType>;
+
 export type EmailControlDto = {
   /**
    * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
@@ -39,6 +51,10 @@ export type EmailControlDto = {
    * Type of editor to use for the body.
    */
   editorType?: EmailControlDtoEditorType | undefined;
+  /**
+   * Type of renderer to use (raw HTML or React Email step resolver)
+   */
+  rendererType?: RendererType | undefined;
   /**
    * Disable sanitization of the output.
    */
@@ -58,6 +74,13 @@ export const EmailControlDtoEditorType$outboundSchema: z.ZodNativeEnum<
   typeof EmailControlDtoEditorType
 > = EmailControlDtoEditorType$inboundSchema;
 
+/** @internal */
+export const RendererType$inboundSchema: z.ZodNativeEnum<typeof RendererType> =
+  z.nativeEnum(RendererType);
+/** @internal */
+export const RendererType$outboundSchema: z.ZodNativeEnum<typeof RendererType> =
+  RendererType$inboundSchema;
+
 /** @internal */
 export const EmailControlDto$inboundSchema: z.ZodType<
   EmailControlDto,
@@ -68,6 +91,7 @@ export const EmailControlDto$inboundSchema: z.ZodType<
   subject: z.string(),
   body: z.string().default(""),
   editorType: EmailControlDtoEditorType$inboundSchema.default("block"),
+  rendererType: RendererType$inboundSchema.default("html"),
   disableOutputSanitization: z.boolean().default(false),
   layoutId: z.nullable(z.string()).optional(),
 });
@@ -77,6 +101,7 @@ export type EmailControlDto$Outbound = {
   subject: string;
   body: string;
   editorType: string;
+  rendererType: string;
   disableOutputSanitization: boolean;
   layoutId?: string | null | undefined;
 };
@@ -91,6 +116,7 @@ export const EmailControlDto$outboundSchema: z.ZodType<
   subject: z.string(),
   body: z.string().default(""),
   editorType: EmailControlDtoEditorType$outboundSchema.default("block"),
+  rendererType: RendererType$outboundSchema.default("html"),
   disableOutputSanitization: z.boolean().default(false),
   layoutId: z.nullable(z.string()).optional(),
 });