@novu/api 3.14.3 → 3.14.4

package/sdk/novunotifications.js

@@ -29,89 +29,89 @@ class NovuNotifications extends sdks_js_1.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(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsList_js_1.subscribersNotificationsList)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsDelete_js_1.subscribersNotificationsDelete)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsCompleteAction_js_1.subscribersNotificationsCompleteAction)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsRevertAction_js_1.subscribersNotificationsRevertAction)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsArchive_js_1.subscribersNotificationsArchive)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAsRead_js_1.subscribersNotificationsMarkAsRead)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsSnooze_js_1.subscribersNotificationsSnooze)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsUnarchive_js_1.subscribersNotificationsUnarchive)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAsUnread_js_1.subscribersNotificationsMarkAsUnread)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsUnsnooze_js_1.subscribersNotificationsUnsnooze)(this, request, options));
@@ -120,7 +120,7 @@ class NovuNotifications extends sdks_js_1.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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsArchiveAll_js_1.subscribersNotificationsArchiveAll)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
@@ -129,8 +129,8 @@ class NovuNotifications extends sdks_js_1.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, filters, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsCount_js_1.subscribersNotificationsCount)(this, subscriberId, filters, idempotencyKey, options));
@@ -139,7 +139,7 @@ class NovuNotifications extends sdks_js_1.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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsDeleteAll_js_1.subscribersNotificationsDeleteAll)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
@@ -148,7 +148,7 @@ class NovuNotifications extends sdks_js_1.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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAllAsRead_js_1.subscribersNotificationsMarkAllAsRead)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
@@ -157,7 +157,7 @@ class NovuNotifications extends sdks_js_1.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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsArchiveAllRead_js_1.subscribersNotificationsArchiveAllRead)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
@@ -166,7 +166,7 @@ class NovuNotifications extends sdks_js_1.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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAsSeen_js_1.subscribersNotificationsMarkAsSeen)(this, markSubscriberNotificationsAsSeenDto, subscriberId, idempotencyKey, options));

package/sdk/steps.d.ts

@@ -2,7 +2,7 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 export declare 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**

package/sdk/steps.js

@@ -10,7 +10,7 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class Steps extends sdks_js_1.ClientSDK {
     /**
-     * Generate step preview
+     * Generate a step preview
      *
      * @remarks
      * Generates a preview for a specific workflow step by its unique identifier **stepId**

package/src/funcs/environmentVariablesCreate.ts

@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.

package/src/funcs/environmentVariablesDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete environment variable
+ * Delete a variable
  *
  * @remarks
  * Deletes an environment variable by id.

package/src/funcs/environmentVariablesList.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List environment variables
+ * List all variables
  *
  * @remarks
  * Returns all environment variables for the current organization. Secret values are masked.

package/src/funcs/environmentVariablesRetrieve.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get environment variable
+ * Retrieve a variable
  *
  * @remarks
  * Returns a single environment variable by id. Secret values are masked.

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.

package/src/funcs/environmentVariablesUsage.ts

@@ -26,10 +26,10 @@ 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,

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(

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/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

@@ -59,7 +59,7 @@ 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",
+  sdkVersion: "3.14.4",
+  genVersion: "2.879.6",
+  userAgent: "speakeasy-sdk/typescript 3.14.4 2.879.6 3.14.0 @novu/api",
 } as const;

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/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/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.
@@ -58,7 +58,7 @@ export class EnvironmentVariables extends ClientSDK {
   }
 
   /**
-   * Get environment variable
+   * Retrieve a variable
    *
    * @remarks
    * Returns a single environment variable by id. Secret values are masked.
@@ -79,7 +79,7 @@ export class EnvironmentVariables extends ClientSDK {
   }
 
   /**
-   * Update environment variable
+   * Update a variable
    *
    * @remarks
    * Updates an existing environment variable. Providing values replaces all existing per-environment values.
@@ -103,7 +103,7 @@ export class EnvironmentVariables extends ClientSDK {
   }
 
   /**
-   * Delete environment variable
+   * Delete a variable
    *
    * @remarks
    * Deletes an environment variable by id.
@@ -125,10 +125,10 @@ export class EnvironmentVariables extends ClientSDK {
   }
 
   /**
-   * 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,