@novu/api 3.14.3 → 3.15.0

package/src/models/operations/environmentvariablescontrollergetenvironmentvariable.ts

@@ -10,7 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EnvironmentVariablesControllerGetEnvironmentVariableRequest = {
-  variableId: string;
+  /**
+   * The unique key of the environment variable (e.g. BASE_URL)
+   */
+  variableKey: string;
   /**
    * A header for idempotency purposes
    */
@@ -25,7 +28,7 @@ export type EnvironmentVariablesControllerGetEnvironmentVariableResponse = {
 /** @internal */
 export type EnvironmentVariablesControllerGetEnvironmentVariableRequest$Outbound =
   {
-    variableId: string;
+    variableKey: string;
     "idempotency-key"?: string | undefined;
   };
 
@@ -36,7 +39,7 @@ export const EnvironmentVariablesControllerGetEnvironmentVariableRequest$outboun
     z.ZodTypeDef,
     EnvironmentVariablesControllerGetEnvironmentVariableRequest
   > = z.object({
-    variableId: z.string(),
+    variableKey: z.string(),
     idempotencyKey: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {

package/src/models/operations/environmentvariablescontrollergetenvironmentvariableusage.ts

@@ -10,7 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EnvironmentVariablesControllerGetEnvironmentVariableUsageRequest = {
-  variableId: string;
+  /**
+   * The unique key of the environment variable (e.g. BASE_URL)
+   */
+  variableKey: string;
   /**
    * A header for idempotency purposes
    */
@@ -26,7 +29,7 @@ export type EnvironmentVariablesControllerGetEnvironmentVariableUsageResponse =
 /** @internal */
 export type EnvironmentVariablesControllerGetEnvironmentVariableUsageRequest$Outbound =
   {
-    variableId: string;
+    variableKey: string;
     "idempotency-key"?: string | undefined;
   };
 
@@ -37,7 +40,7 @@ export const EnvironmentVariablesControllerGetEnvironmentVariableUsageRequest$ou
     z.ZodTypeDef,
     EnvironmentVariablesControllerGetEnvironmentVariableUsageRequest
   > = z.object({
-    variableId: z.string(),
+    variableKey: z.string(),
     idempotencyKey: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {

package/src/models/operations/environmentvariablescontrollerupdateenvironmentvariable.ts

@@ -10,7 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EnvironmentVariablesControllerUpdateEnvironmentVariableRequest = {
-  variableId: string;
+  /**
+   * The unique key of the environment variable (e.g. BASE_URL)
+   */
+  variableKey: string;
   /**
    * A header for idempotency purposes
    */
@@ -27,7 +30,7 @@ export type EnvironmentVariablesControllerUpdateEnvironmentVariableResponse = {
 /** @internal */
 export type EnvironmentVariablesControllerUpdateEnvironmentVariableRequest$Outbound =
   {
-    variableId: string;
+    variableKey: string;
     "idempotency-key"?: string | undefined;
     UpdateEnvironmentVariableRequestDto:
       components.UpdateEnvironmentVariableRequestDto$Outbound;
@@ -40,7 +43,7 @@ export const EnvironmentVariablesControllerUpdateEnvironmentVariableRequest$outb
     z.ZodTypeDef,
     EnvironmentVariablesControllerUpdateEnvironmentVariableRequest
   > = z.object({
-    variableId: z.string(),
+    variableKey: z.string(),
     idempotencyKey: z.string().optional(),
     updateEnvironmentVariableRequestDto:
       components.UpdateEnvironmentVariableRequestDto$outboundSchema,

package/src/models/operations/subscriberscontrollergetsubscribernotifications.ts

@@ -26,10 +26,6 @@ export type SubscribersControllerGetSubscriberNotificationsRequest = {
   limit?: number | undefined;
   after?: string | undefined;
   offset?: number | undefined;
-  /**
-   * Filter by workflow tags
-   */
-  tags?: Array<string> | undefined;
   /**
    * Filter by read/unread state
    */
@@ -87,7 +83,6 @@ export type SubscribersControllerGetSubscriberNotificationsRequest$Outbound = {
   limit: number;
   after?: string | undefined;
   offset?: number | undefined;
-  tags?: Array<string> | undefined;
   read?: boolean | undefined;
   archived?: boolean | undefined;
   snoozed?: boolean | undefined;
@@ -111,7 +106,6 @@ export const SubscribersControllerGetSubscriberNotificationsRequest$outboundSche
     limit: z.number().default(10),
     after: z.string().optional(),
     offset: z.number().optional(),
-    tags: z.array(z.string()).optional(),
     read: z.boolean().optional(),
     archived: z.boolean().optional(),
     snoozed: z.boolean().optional(),

package/src/sdk/activity.ts

@@ -10,7 +10,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Activity extends ClientSDK {
   /**
-   * Track activity and engagement events
+   * Track provider activity and engagement events
    *
    * @remarks
    * Track activity and engagement events for a specific delivery provider

package/src/sdk/environmentvariables.ts

@@ -15,7 +15,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class EnvironmentVariables extends ClientSDK {
   /**
-   * List environment variables
+   * List all variables
    *
    * @remarks
    * Returns all environment variables for the current organization. Secret values are masked.
@@ -36,7 +36,7 @@ export class EnvironmentVariables extends ClientSDK {
   }
 
   /**
-   * Create environment variable
+   * Create a variable
    *
    * @remarks
    * Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.
@@ -61,10 +61,10 @@ export class EnvironmentVariables extends ClientSDK {
    * 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.
    */
   async retrieve(
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -72,14 +72,14 @@ export class EnvironmentVariables extends ClientSDK {
   > {
     return unwrapAsync(environmentVariablesRetrieve(
       this,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));
   }
 
   /**
-   * Update environment variable
+   * Update a variable
    *
    * @remarks
    * Updates an existing environment variable. Providing values replaces all existing per-environment values.
@@ -87,7 +87,7 @@ export class EnvironmentVariables extends ClientSDK {
   async update(
     updateEnvironmentVariableRequestDto:
       components.UpdateEnvironmentVariableRequestDto,
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -96,7 +96,7 @@ export class EnvironmentVariables extends ClientSDK {
     return unwrapAsync(environmentVariablesUpdate(
       this,
       updateEnvironmentVariableRequestDto,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));
@@ -106,10 +106,10 @@ export class EnvironmentVariables extends ClientSDK {
    * Delete environment variable
    *
    * @remarks
-   * Deletes an environment variable by id.
+   * Deletes an environment variable by key.
    */
   async delete(
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -118,20 +118,20 @@ export class EnvironmentVariables extends ClientSDK {
   > {
     return unwrapAsync(environmentVariablesDelete(
       this,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));
   }
 
   /**
-   * 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.
    */
   async usage(
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -139,7 +139,7 @@ export class EnvironmentVariables extends ClientSDK {
   > {
     return unwrapAsync(environmentVariablesUsage(
       this,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));

package/src/sdk/novunotifications.ts

@@ -30,7 +30,7 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async list(
@@ -47,10 +47,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async delete(
     request: operations.SubscribersControllerDeleteNotificationRequest,
@@ -66,10 +66,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async completeAction(
     request: operations.SubscribersControllerCompleteNotificationActionRequest,
@@ -85,10 +85,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async revertAction(
     request: operations.SubscribersControllerRevertNotificationActionRequest,
@@ -102,10 +102,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async archive(
     request: operations.SubscribersControllerArchiveNotificationRequest,
@@ -119,10 +119,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async markAsRead(
     request: operations.SubscribersControllerMarkNotificationAsReadRequest,
@@ -136,10 +136,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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.
    */
   async snooze(
     request: operations.SubscribersControllerSnoozeNotificationRequest,
@@ -153,10 +153,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async unarchive(
     request: operations.SubscribersControllerUnarchiveNotificationRequest,
@@ -170,10 +170,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async markAsUnread(
     request: operations.SubscribersControllerMarkNotificationAsUnreadRequest,
@@ -187,10 +187,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * 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**.
    */
   async unsnooze(
     request: operations.SubscribersControllerUnsnoozeNotificationRequest,
@@ -207,7 +207,7 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async archiveAll(
     updateAllSubscriberNotificationsDto:
@@ -231,8 +231,8 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async count(
     subscriberId: string,
@@ -255,7 +255,7 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async deleteAll(
     updateAllSubscriberNotificationsDto:
@@ -279,7 +279,7 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async markAllAsRead(
     updateAllSubscriberNotificationsDto:
@@ -304,7 +304,7 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async archiveAllRead(
     updateAllSubscriberNotificationsDto:
@@ -329,7 +329,7 @@ export class NovuNotifications extends ClientSDK {
    * 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.
    */
   async markAsSeen(
     markSubscriberNotificationsAsSeenDto:

package/src/sdk/steps.ts

@@ -10,7 +10,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Steps extends ClientSDK {
   /**
-   * Generate step preview
+   * Generate a step preview
    *
    * @remarks
    * Generates a preview for a specific workflow step by its unique identifier **stepId**