@novu/api 3.14.3 → 3.15.0

package/src/funcs/environmentVariablesRetrieve.ts

@@ -29,11 +29,11 @@ import { Result } from "../types/fp.js";
  * Get environment variable
  *
  * @remarks
- * Returns a single environment variable by id. Secret values are masked.
+ * Returns a single environment variable by key. Secret values are masked.
  */
 export function environmentVariablesRetrieve(
   client: NovuCore,
-  variableId: string,
+  variableKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
@@ -53,7 +53,7 @@ export function environmentVariablesRetrieve(
 > {
   return new APIPromise($do(
     client,
-    variableId,
+    variableKey,
     idempotencyKey,
     options,
   ));
@@ -61,7 +61,7 @@ export function environmentVariablesRetrieve(
 
 async function $do(
   client: NovuCore,
-  variableId: string,
+  variableKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
@@ -84,7 +84,7 @@ async function $do(
 > {
   const input:
     operations.EnvironmentVariablesControllerGetEnvironmentVariableRequest = {
-      variableId: variableId,
+      variableKey: variableKey,
       idempotencyKey: idempotencyKey,
     };
 
@@ -103,12 +103,14 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    variableId: encodeSimple("variableId", payload.variableId, {
+    variableKey: encodeSimple("variableKey", payload.variableKey, {
       explode: false,
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/v1/environment-variables/{variableId}")(pathParams);
+  const path = pathToFunc("/v1/environment-variables/{variableKey}")(
+    pathParams,
+  );
 
   const headers = new Headers(compactMap({
     Accept: "application/json",

package/src/funcs/environmentVariablesUpdate.ts

@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update environment variable
+ * Update a variable
  *
  * @remarks
  * Updates an existing environment variable. Providing values replaces all existing per-environment values.
@@ -36,7 +36,7 @@ export function environmentVariablesUpdate(
   client: NovuCore,
   updateEnvironmentVariableRequestDto:
     components.UpdateEnvironmentVariableRequestDto,
-  variableId: string,
+  variableKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
@@ -57,7 +57,7 @@ export function environmentVariablesUpdate(
   return new APIPromise($do(
     client,
     updateEnvironmentVariableRequestDto,
-    variableId,
+    variableKey,
     idempotencyKey,
     options,
   ));
@@ -67,7 +67,7 @@ async function $do(
   client: NovuCore,
   updateEnvironmentVariableRequestDto:
     components.UpdateEnvironmentVariableRequestDto,
-  variableId: string,
+  variableKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
@@ -93,7 +93,7 @@ async function $do(
       {
         updateEnvironmentVariableRequestDto:
           updateEnvironmentVariableRequestDto,
-        variableId: variableId,
+        variableKey: variableKey,
         idempotencyKey: idempotencyKey,
       };
 
@@ -114,12 +114,14 @@ async function $do(
   });
 
   const pathParams = {
-    variableId: encodeSimple("variableId", payload.variableId, {
+    variableKey: encodeSimple("variableKey", payload.variableKey, {
       explode: false,
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/v1/environment-variables/{variableId}")(pathParams);
+  const path = pathToFunc("/v1/environment-variables/{variableKey}")(
+    pathParams,
+  );
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",

package/src/funcs/environmentVariablesUsage.ts

@@ -26,14 +26,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get environment variable usage
+ * Retrieve a variable usage
  *
  * @remarks
- * Returns the workflows that reference this environment variable via {{env.KEY}} in their step controls.
+ * Returns the workflows that reference this environment variable via `{{env.KEY}}` in their step controls. **variableId** is required.
  */
 export function environmentVariablesUsage(
   client: NovuCore,
-  variableId: string,
+  variableKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
@@ -53,7 +53,7 @@ export function environmentVariablesUsage(
 > {
   return new APIPromise($do(
     client,
-    variableId,
+    variableKey,
     idempotencyKey,
     options,
   ));
@@ -61,7 +61,7 @@ export function environmentVariablesUsage(
 
 async function $do(
   client: NovuCore,
-  variableId: string,
+  variableKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
@@ -85,7 +85,7 @@ async function $do(
   const input:
     operations.EnvironmentVariablesControllerGetEnvironmentVariableUsageRequest =
       {
-        variableId: variableId,
+        variableKey: variableKey,
         idempotencyKey: idempotencyKey,
       };
 
@@ -104,12 +104,12 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    variableId: encodeSimple("variableId", payload.variableId, {
+    variableKey: encodeSimple("variableKey", payload.variableKey, {
       explode: false,
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/v1/environment-variables/{variableId}/usage")(
+  const path = pathToFunc("/v1/environment-variables/{variableKey}/usage")(
     pathParams,
   );
 

package/src/funcs/subscribersNotificationsArchive.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Archive notification
+ * Archive a notification
  *
  * @remarks
- * Archive a specific notification by its unique identifier **notificationId**.
+ * Archive a specific in-app (inbox) notification by its unique identifier **notificationId**.
  */
 export function subscribersNotificationsArchive(
   client: NovuCore,

package/src/funcs/subscribersNotificationsArchiveAll.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Archive all notifications
  *
  * @remarks
- * Archive all notifications matching the specified filters. Supports context-based filtering.
+ * Archive all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
  */
 export function subscribersNotificationsArchiveAll(
   client: NovuCore,

package/src/funcs/subscribersNotificationsArchiveAllRead.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Archive all read notifications
  *
  * @remarks
- * Archive all read notifications matching the specified filters. Supports context-based filtering.
+ * Archive all read in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
  */
 export function subscribersNotificationsArchiveAllRead(
   client: NovuCore,

package/src/funcs/subscribersNotificationsCompleteAction.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Complete notification action
+ * Complete a notification action
  *
  * @remarks
- * Mark a notification action (primary or secondary) as completed by its unique identifier **notificationId** and action type.
+ * Mark a single in-app (inbox) notification's action (primary or secondary) as completed by its unique identifier **notificationId** and action type **actionType**.
  */
 export function subscribersNotificationsCompleteAction(
   client: NovuCore,

package/src/funcs/subscribersNotificationsCount.ts

@@ -29,8 +29,8 @@ import { Result } from "../types/fp.js";
  * Retrieve subscriber notifications count
  *
  * @remarks
- * Retrieve count of notifications for a subscriber by its unique key identifier **subscriberId**.
- *     Supports multiple filters to count notifications by different criteria, including context keys.
+ * Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**.
+ *     Supports multiple filters to count in-app (inbox) notifications by different criteria, including context keys.
  */
 export function subscribersNotificationsCount(
   client: NovuCore,

package/src/funcs/subscribersNotificationsDelete.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete notification
+ * Delete a notification
  *
  * @remarks
- * Delete a specific notification by its unique identifier **notificationId**.
+ * Delete a specific in-app (inbox) notification permanently by its unique identifier **notificationId**.
  */
 export function subscribersNotificationsDelete(
   client: NovuCore,

package/src/funcs/subscribersNotificationsDeleteAll.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Delete all notifications
  *
  * @remarks
- * Delete all notifications matching the specified filters. Supports context-based filtering.
+ * Permanently delete all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
  */
 export function subscribersNotificationsDeleteAll(
   client: NovuCore,

package/src/funcs/subscribersNotificationsList.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Retrieve subscriber notifications
  *
  * @remarks
- * Retrieve in-app notifications for a subscriber by its unique key identifier **subscriberId**.
+ * Retrieve in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**.
  *     Supports filtering by tags, read/archived/snoozed/seen state, data attributes, severity, date range, and context keys.
  */
 export function subscribersNotificationsList(
@@ -117,7 +117,6 @@ async function $do(
     "seen": payload.seen,
     "severity": payload.severity,
     "snoozed": payload.snoozed,
-    "tags": payload.tags,
   });
 
   const headers = new Headers(compactMap({

package/src/funcs/subscribersNotificationsMarkAllAsRead.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Mark all notifications as read
  *
  * @remarks
- * Mark all notifications matching the specified filters as read. Supports context-based filtering.
+ * Mark all in-app (inbox) notifications matching the specified filters as read. Supports context-based filtering.
  */
 export function subscribersNotificationsMarkAllAsRead(
   client: NovuCore,

package/src/funcs/subscribersNotificationsMarkAsRead.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Mark notification as read
+ * Mark a notification as read
  *
  * @remarks
- * Mark a specific notification as read by its unique identifier **notificationId**.
+ * Mark a specific in-app (inbox) notification as read by its unique identifier **notificationId**.
  */
 export function subscribersNotificationsMarkAsRead(
   client: NovuCore,

package/src/funcs/subscribersNotificationsMarkAsSeen.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Mark notifications as seen
  *
  * @remarks
- * Mark specific notifications or notifications matching filters as seen. Supports context-based filtering.
+ * Mark specific and multiple in-app (inbox) notifications as seen. Supports context-based filtering.
  */
 export function subscribersNotificationsMarkAsSeen(
   client: NovuCore,

package/src/funcs/subscribersNotificationsMarkAsUnread.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Mark notification as unread
+ * Mark a notification as unread
  *
  * @remarks
- * Mark a specific notification as unread by its unique identifier **notificationId**.
+ * Mark a specific in-app (inbox) notification as unread by its unique identifier **notificationId**.
  */
 export function subscribersNotificationsMarkAsUnread(
   client: NovuCore,

package/src/funcs/subscribersNotificationsRevertAction.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Revert notification action
+ * Revert a notification action
  *
  * @remarks
- * Revert a notification action (primary or secondary) to pending state by its unique identifier **notificationId** and action type.
+ * Revert a single in-app (inbox) notification's action (primary or secondary) to pending state by its unique identifier **notificationId** and action type **actionType**.
  */
 export function subscribersNotificationsRevertAction(
   client: NovuCore,

package/src/funcs/subscribersNotificationsSnooze.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Snooze notification
+ * Snooze a notification
  *
  * @remarks
- * Snooze a specific notification by its unique identifier **notificationId** until a specified time.
+ * Snooze a specific in-app (inbox) notification by its unique identifier **notificationId** until a specified time.
  */
 export function subscribersNotificationsSnooze(
   client: NovuCore,

package/src/funcs/subscribersNotificationsUnarchive.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Unarchive notification
+ * Unarchive a notification
  *
  * @remarks
- * Unarchive a specific notification by its unique identifier **notificationId**.
+ * Unarchive a specific in-app (inbox) notification by its unique identifier **notificationId**.
  */
 export function subscribersNotificationsUnarchive(
   client: NovuCore,

package/src/funcs/subscribersNotificationsUnsnooze.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Unsnooze notification
+ * Unsnooze a notification
  *
  * @remarks
- * Unsnooze a specific notification by its unique identifier **notificationId**.
+ * Unsnooze a specific in-app (inbox) notification by its unique identifier **notificationId**.
  */
 export function subscribersNotificationsUnsnooze(
   client: NovuCore,

package/src/funcs/translationsMasterUpload.ts

@@ -3,7 +3,7 @@
  */
 
 import { NovuCore } from "../core.js";
-import { appendForm, encodeSimple } from "../lib/encodings.js";
+import { appendForm, encodeSimple, normalizeBlob } from "../lib/encodings.js";
 import {
   bytesToBlob,
   getContentTypeFromFileName,
@@ -110,8 +110,9 @@ async function $do(
   const body = new FormData();
 
   if (isBlobLike(payload.RequestBody.file)) {
-    const blob = payload.RequestBody.file;
-    const name = "name" in blob ? (blob.name as string) : undefined;
+    const file = payload.RequestBody.file;
+    const blob = await normalizeBlob(file);
+    const name = "name" in file ? (file.name as string) : undefined;
     appendForm(body, "file", blob, name);
   } else if (isReadableStream(payload.RequestBody.file.content)) {
     const buffer = await readableStreamToArrayBuffer(

package/src/funcs/translationsUpload.ts

@@ -3,7 +3,7 @@
  */
 
 import { NovuCore } from "../core.js";
-import { appendForm, encodeSimple } from "../lib/encodings.js";
+import { appendForm, encodeSimple, normalizeBlob } from "../lib/encodings.js";
 import {
   bytesToBlob,
   getContentTypeFromFileName,
@@ -110,8 +110,9 @@ async function $do(
 
   for (const fileItem of payload.RequestBody.files ?? []) {
     if (isBlobLike(fileItem)) {
-      const blob = fileItem;
-      const name = "name" in blob ? (blob.name as string) : undefined;
+      const file = fileItem;
+      const blob = await normalizeBlob(file);
+      const name = "name" in file ? (file.name as string) : undefined;
       appendForm(body, "files[]", blob, name);
     } else if (isReadableStream(fileItem.content)) {
       const buffer = await readableStreamToArrayBuffer(fileItem.content);

package/src/funcs/workflowsStepsGeneratePreview.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Generate step preview
+ * Generate a step preview
  *
  * @remarks
  * Generates a preview for a specific workflow step by its unique identifier **stepId**

package/src/lib/config.ts

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

package/src/lib/encodings.ts

@@ -514,3 +514,12 @@ export function appendForm(
     fd.append(key, String(value));
   }
 }
+
+export async function normalizeBlob(
+  value: Pick<Blob, "arrayBuffer" | "type">,
+): Promise<Blob> {
+  if (value instanceof Blob) {
+    return value;
+  }
+  return new Blob([await value.arrayBuffer()], { type: value.type });
+}

package/src/models/components/getchannelconnectionresponsedto.ts

@@ -86,6 +86,7 @@ export const ProviderId = {
   Imedia: "imedia",
   Sinch: "sinch",
   IsendproSms: "isendpro-sms",
+  CmTelecom: "cm-telecom",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/getchannelendpointresponsedto.ts

@@ -102,6 +102,7 @@ export const GetChannelEndpointResponseDtoProviderId = {
   Imedia: "imedia",
   Sinch: "sinch",
   IsendproSms: "isendpro-sms",
+  CmTelecom: "cm-telecom",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/marksubscribernotificationsasseendto.ts

@@ -4,15 +4,20 @@
 
 import * as z from "zod/v3";
 
+/**
+ * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
+ */
+export type MarkSubscriberNotificationsAsSeenDtoTags = {};
+
 export type MarkSubscriberNotificationsAsSeenDto = {
   /**
    * Specific notification IDs to mark as seen
    */
   notificationIds?: Array<string> | undefined;
   /**
-   * Filter notifications by workflow tags
+   * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
    */
-  tags?: Array<string> | undefined;
+  tags?: MarkSubscriberNotificationsAsSeenDtoTags | undefined;
   /**
    * Filter notifications by data attributes (JSON string)
    */
@@ -23,10 +28,31 @@ export type MarkSubscriberNotificationsAsSeenDto = {
   contextKeys?: Array<string> | undefined;
 };
 
+/** @internal */
+export type MarkSubscriberNotificationsAsSeenDtoTags$Outbound = {};
+
+/** @internal */
+export const MarkSubscriberNotificationsAsSeenDtoTags$outboundSchema: z.ZodType<
+  MarkSubscriberNotificationsAsSeenDtoTags$Outbound,
+  z.ZodTypeDef,
+  MarkSubscriberNotificationsAsSeenDtoTags
+> = z.object({});
+
+export function markSubscriberNotificationsAsSeenDtoTagsToJSON(
+  markSubscriberNotificationsAsSeenDtoTags:
+    MarkSubscriberNotificationsAsSeenDtoTags,
+): string {
+  return JSON.stringify(
+    MarkSubscriberNotificationsAsSeenDtoTags$outboundSchema.parse(
+      markSubscriberNotificationsAsSeenDtoTags,
+    ),
+  );
+}
+
 /** @internal */
 export type MarkSubscriberNotificationsAsSeenDto$Outbound = {
   notificationIds?: Array<string> | undefined;
-  tags?: Array<string> | undefined;
+  tags?: MarkSubscriberNotificationsAsSeenDtoTags$Outbound | undefined;
   data?: string | undefined;
   contextKeys?: Array<string> | undefined;
 };
@@ -38,7 +64,8 @@ export const MarkSubscriberNotificationsAsSeenDto$outboundSchema: z.ZodType<
   MarkSubscriberNotificationsAsSeenDto
 > = z.object({
   notificationIds: z.array(z.string()).optional(),
-  tags: z.array(z.string()).optional(),
+  tags: z.lazy(() => MarkSubscriberNotificationsAsSeenDtoTags$outboundSchema)
+    .optional(),
   data: z.string().optional(),
   contextKeys: z.array(z.string()).optional(),
 });

package/src/models/components/providersidenum.ts

@@ -66,6 +66,7 @@ export const ProvidersIdEnum = {
   Imedia: "imedia",
   Sinch: "sinch",
   IsendproSms: "isendpro-sms",
+  CmTelecom: "cm-telecom",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/updateallsubscribernotificationsdto.ts

@@ -4,11 +4,16 @@
 
 import * as z from "zod/v3";
 
+/**
+ * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
+ */
+export type Tags = {};
+
 export type UpdateAllSubscriberNotificationsDto = {
   /**
-   * Filter notifications by workflow tags
+   * Filter notifications by workflow tags (OR for string[], or { and: [{ or: string[] }, ...] } for AND of OR-groups).
    */
-  tags?: Array<string> | undefined;
+  tags?: Tags | undefined;
   /**
    * Filter notifications by data attributes (JSON string)
    */
@@ -19,9 +24,20 @@ export type UpdateAllSubscriberNotificationsDto = {
   contextKeys?: Array<string> | undefined;
 };
 
+/** @internal */
+export type Tags$Outbound = {};
+
+/** @internal */
+export const Tags$outboundSchema: z.ZodType<Tags$Outbound, z.ZodTypeDef, Tags> =
+  z.object({});
+
+export function tagsToJSON(tags: Tags): string {
+  return JSON.stringify(Tags$outboundSchema.parse(tags));
+}
+
 /** @internal */
 export type UpdateAllSubscriberNotificationsDto$Outbound = {
-  tags?: Array<string> | undefined;
+  tags?: Tags$Outbound | undefined;
   data?: string | undefined;
   contextKeys?: Array<string> | undefined;
 };
@@ -32,7 +48,7 @@ export const UpdateAllSubscriberNotificationsDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateAllSubscriberNotificationsDto
 > = z.object({
-  tags: z.array(z.string()).optional(),
+  tags: z.lazy(() => Tags$outboundSchema).optional(),
   data: z.string().optional(),
   contextKeys: z.array(z.string()).optional(),
 });

package/src/models/operations/environmentvariablescontrollerdeleteenvironmentvariable.ts

@@ -9,7 +9,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EnvironmentVariablesControllerDeleteEnvironmentVariableRequest = {
-  variableId: string;
+  /**
+   * The unique key of the environment variable (e.g. BASE_URL)
+   */
+  variableKey: string;
   /**
    * A header for idempotency purposes
    */
@@ -23,7 +26,7 @@ export type EnvironmentVariablesControllerDeleteEnvironmentVariableResponse = {
 /** @internal */
 export type EnvironmentVariablesControllerDeleteEnvironmentVariableRequest$Outbound =
   {
-    variableId: string;
+    variableKey: string;
     "idempotency-key"?: string | undefined;
   };
 
@@ -34,7 +37,7 @@ export const EnvironmentVariablesControllerDeleteEnvironmentVariableRequest$outb
     z.ZodTypeDef,
     EnvironmentVariablesControllerDeleteEnvironmentVariableRequest
   > = z.object({
-    variableId: z.string(),
+    variableKey: z.string(),
     idempotencyKey: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {