@novu/api 3.14.3 → 3.14.4

package/README.md

@@ -297,12 +297,12 @@ run();
 
 ### [EnvironmentVariables](docs/sdks/environmentvariables/README.md)
 
-* [list](docs/sdks/environmentvariables/README.md#list) - List environment variables
-* [create](docs/sdks/environmentvariables/README.md#create) - Create environment variable
-* [retrieve](docs/sdks/environmentvariables/README.md#retrieve) - Get environment variable
-* [update](docs/sdks/environmentvariables/README.md#update) - Update environment variable
-* [delete](docs/sdks/environmentvariables/README.md#delete) - Delete environment variable
-* [usage](docs/sdks/environmentvariables/README.md#usage) - Get environment variable usage
+* [list](docs/sdks/environmentvariables/README.md#list) - List all variables
+* [create](docs/sdks/environmentvariables/README.md#create) - Create a variable
+* [retrieve](docs/sdks/environmentvariables/README.md#retrieve) - Retrieve a variable
+* [update](docs/sdks/environmentvariables/README.md#update) - Update a variable
+* [delete](docs/sdks/environmentvariables/README.md#delete) - Delete a variable
+* [usage](docs/sdks/environmentvariables/README.md#usage) - Retrieve a variable usage
 
 ### [Environments](docs/sdks/environments/README.md)
 
@@ -371,15 +371,15 @@ run();
 #### [Subscribers.Notifications](docs/sdks/novunotifications/README.md)
 
 * [list](docs/sdks/novunotifications/README.md#list) - Retrieve subscriber notifications
-* [delete](docs/sdks/novunotifications/README.md#delete) - Delete notification
-* [completeAction](docs/sdks/novunotifications/README.md#completeaction) - Complete notification action
-* [revertAction](docs/sdks/novunotifications/README.md#revertaction) - Revert notification action
-* [archive](docs/sdks/novunotifications/README.md#archive) - Archive notification
-* [markAsRead](docs/sdks/novunotifications/README.md#markasread) - Mark notification as read
-* [snooze](docs/sdks/novunotifications/README.md#snooze) - Snooze notification
-* [unarchive](docs/sdks/novunotifications/README.md#unarchive) - Unarchive notification
-* [markAsUnread](docs/sdks/novunotifications/README.md#markasunread) - Mark notification as unread
-* [unsnooze](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze notification
+* [delete](docs/sdks/novunotifications/README.md#delete) - Delete a notification
+* [completeAction](docs/sdks/novunotifications/README.md#completeaction) - Complete a notification action
+* [revertAction](docs/sdks/novunotifications/README.md#revertaction) - Revert a notification action
+* [archive](docs/sdks/novunotifications/README.md#archive) - Archive a notification
+* [markAsRead](docs/sdks/novunotifications/README.md#markasread) - Mark a notification as read
+* [snooze](docs/sdks/novunotifications/README.md#snooze) - Snooze a notification
+* [unarchive](docs/sdks/novunotifications/README.md#unarchive) - Unarchive a notification
+* [markAsUnread](docs/sdks/novunotifications/README.md#markasunread) - Mark a notification as unread
+* [unsnooze](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze a notification
 * [archiveAll](docs/sdks/novunotifications/README.md#archiveall) - Archive all notifications
 * [count](docs/sdks/novunotifications/README.md#count) - Retrieve subscriber notifications count
 * [deleteAll](docs/sdks/novunotifications/README.md#deleteall) - Delete all notifications
@@ -453,7 +453,7 @@ run();
 
 #### [Workflows.Steps](docs/sdks/steps/README.md)
 
-* [generatePreview](docs/sdks/steps/README.md#generatepreview) - Generate step preview
+* [generatePreview](docs/sdks/steps/README.md#generatepreview) - Generate a step preview
 * [retrieve](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
 
 </details>
@@ -498,12 +498,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`environmentsList`](docs/sdks/environments/README.md#list) - List all environments
 - [`environmentsPublish`](docs/sdks/environments/README.md#publish) - Publish resources to target environment
 - [`environmentsUpdate`](docs/sdks/environments/README.md#update) - Update an environment
-- [`environmentVariablesCreate`](docs/sdks/environmentvariables/README.md#create) - Create environment variable
-- [`environmentVariablesDelete`](docs/sdks/environmentvariables/README.md#delete) - Delete environment variable
-- [`environmentVariablesList`](docs/sdks/environmentvariables/README.md#list) - List environment variables
-- [`environmentVariablesRetrieve`](docs/sdks/environmentvariables/README.md#retrieve) - Get environment variable
-- [`environmentVariablesUpdate`](docs/sdks/environmentvariables/README.md#update) - Update environment variable
-- [`environmentVariablesUsage`](docs/sdks/environmentvariables/README.md#usage) - Get environment variable usage
+- [`environmentVariablesCreate`](docs/sdks/environmentvariables/README.md#create) - Create a variable
+- [`environmentVariablesDelete`](docs/sdks/environmentvariables/README.md#delete) - Delete a variable
+- [`environmentVariablesList`](docs/sdks/environmentvariables/README.md#list) - List all variables
+- [`environmentVariablesRetrieve`](docs/sdks/environmentvariables/README.md#retrieve) - Retrieve a variable
+- [`environmentVariablesUpdate`](docs/sdks/environmentvariables/README.md#update) - Update a variable
+- [`environmentVariablesUsage`](docs/sdks/environmentvariables/README.md#usage) - Retrieve a variable usage
 - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create an integration
 - [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete an integration
 - [`integrationsGenerateChatOAuthUrl`](docs/sdks/integrations/README.md#generatechatoauthurl) - Generate chat OAuth URL
@@ -534,24 +534,24 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`subscribersMessagesMarkAll`](docs/sdks/novumessages/README.md#markall) - Update all notifications state
 - [`subscribersMessagesMarkAllAs`](docs/sdks/novumessages/README.md#markallas) - Update notifications state
 - [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status
-- [`subscribersNotificationsArchive`](docs/sdks/novunotifications/README.md#archive) - Archive notification
+- [`subscribersNotificationsArchive`](docs/sdks/novunotifications/README.md#archive) - Archive a notification
 - [`subscribersNotificationsArchiveAll`](docs/sdks/novunotifications/README.md#archiveall) - Archive all notifications
 - [`subscribersNotificationsArchiveAllRead`](docs/sdks/novunotifications/README.md#archiveallread) - Archive all read notifications
-- [`subscribersNotificationsCompleteAction`](docs/sdks/novunotifications/README.md#completeaction) - Complete notification action
+- [`subscribersNotificationsCompleteAction`](docs/sdks/novunotifications/README.md#completeaction) - Complete a notification action
 - [`subscribersNotificationsCount`](docs/sdks/novunotifications/README.md#count) - Retrieve subscriber notifications count
-- [`subscribersNotificationsDelete`](docs/sdks/novunotifications/README.md#delete) - Delete notification
+- [`subscribersNotificationsDelete`](docs/sdks/novunotifications/README.md#delete) - Delete a notification
 - [`subscribersNotificationsDeleteAll`](docs/sdks/novunotifications/README.md#deleteall) - Delete all notifications
 - [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Retrieve subscriber notifications
 - [`subscribersNotificationsList`](docs/sdks/novunotifications/README.md#list) - Retrieve subscriber notifications
 - [`subscribersNotificationsMarkAllAsRead`](docs/sdks/novunotifications/README.md#markallasread) - Mark all notifications as read
-- [`subscribersNotificationsMarkAsRead`](docs/sdks/novunotifications/README.md#markasread) - Mark notification as read
+- [`subscribersNotificationsMarkAsRead`](docs/sdks/novunotifications/README.md#markasread) - Mark a notification as read
 - [`subscribersNotificationsMarkAsSeen`](docs/sdks/novunotifications/README.md#markasseen) - Mark notifications as seen
-- [`subscribersNotificationsMarkAsUnread`](docs/sdks/novunotifications/README.md#markasunread) - Mark notification as unread
-- [`subscribersNotificationsRevertAction`](docs/sdks/novunotifications/README.md#revertaction) - Revert notification action
-- [`subscribersNotificationsSnooze`](docs/sdks/novunotifications/README.md#snooze) - Snooze notification
-- [`subscribersNotificationsUnarchive`](docs/sdks/novunotifications/README.md#unarchive) - Unarchive notification
+- [`subscribersNotificationsMarkAsUnread`](docs/sdks/novunotifications/README.md#markasunread) - Mark a notification as unread
+- [`subscribersNotificationsRevertAction`](docs/sdks/novunotifications/README.md#revertaction) - Revert a notification action
+- [`subscribersNotificationsSnooze`](docs/sdks/novunotifications/README.md#snooze) - Snooze a notification
+- [`subscribersNotificationsUnarchive`](docs/sdks/novunotifications/README.md#unarchive) - Unarchive a notification
 - [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Retrieve unseen notifications count
-- [`subscribersNotificationsUnsnooze`](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze notification
+- [`subscribersNotificationsUnsnooze`](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze a notification
 - [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Update a subscriber
 - [`subscribersPreferencesBulkUpdate`](docs/sdks/preferences/README.md#bulkupdate) - Bulk update subscriber preferences
 - [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Retrieve subscriber preferences
@@ -588,7 +588,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`workflowsGet`](docs/sdks/workflows/README.md#get) - Retrieve a workflow
 - [`workflowsList`](docs/sdks/workflows/README.md#list) - List all workflows
 - [`workflowsPatch`](docs/sdks/workflows/README.md#patch) - Update a workflow
-- [`workflowsStepsGeneratePreview`](docs/sdks/steps/README.md#generatepreview) - Generate step preview
+- [`workflowsStepsGeneratePreview`](docs/sdks/steps/README.md#generatepreview) - Generate a step preview
 - [`workflowsStepsRetrieve`](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
 - [`workflowsSync`](docs/sdks/workflows/README.md#sync) - Sync a workflow
 - [`workflowsUpdate`](docs/sdks/workflows/README.md#update) - Update a workflow

package/funcs/environmentVariablesCreate.d.ts

@@ -10,7 +10,7 @@ import * as operations from "../models/operations/index.js";
 import { 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/funcs/environmentVariablesCreate.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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/funcs/environmentVariablesDelete.d.ts

@@ -9,7 +9,7 @@ import * as operations from "../models/operations/index.js";
 import { 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/funcs/environmentVariablesDelete.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Delete environment variable
+ * Delete a variable
  *
  * @remarks
  * Deletes an environment variable by id.

package/funcs/environmentVariablesList.d.ts

@@ -9,7 +9,7 @@ import * as operations from "../models/operations/index.js";
 import { 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/funcs/environmentVariablesList.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * List environment variables
+ * List all variables
  *
  * @remarks
  * Returns all environment variables for the current organization. Secret values are masked.

package/funcs/environmentVariablesRetrieve.d.ts

@@ -9,7 +9,7 @@ import * as operations from "../models/operations/index.js";
 import { 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/funcs/environmentVariablesRetrieve.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get environment variable
+ * Retrieve a variable
  *
  * @remarks
  * Returns a single environment variable by id. Secret values are masked.

package/funcs/environmentVariablesUpdate.d.ts

@@ -10,7 +10,7 @@ import * as operations from "../models/operations/index.js";
 import { 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/funcs/environmentVariablesUpdate.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Update environment variable
+ * Update a variable
  *
  * @remarks
  * Updates an existing environment variable. Providing values replaces all existing per-environment values.

package/funcs/environmentVariablesUsage.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function environmentVariablesUsage(client: NovuCore, variableId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.EnvironmentVariablesControllerGetEnvironmentVariableUsageResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=environmentVariablesUsage.d.ts.map

package/funcs/environmentVariablesUsage.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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.
  */
 function environmentVariablesUsage(client, variableId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, variableId, idempotencyKey, options));

package/funcs/subscribersNotificationsArchive.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsArchive(client: NovuCore, request: operations.SubscribersControllerArchiveNotificationRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerArchiveNotificationResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsArchive.d.ts.map

package/funcs/subscribersNotificationsArchive.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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**.
  */
 function subscribersNotificationsArchive(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/subscribersNotificationsArchiveAll.d.ts

@@ -13,7 +13,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 declare function subscribersNotificationsArchiveAll(client: NovuCore, updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerArchiveAllNotificationsResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsArchiveAll.d.ts.map

package/funcs/subscribersNotificationsArchiveAll.js

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsArchiveAll(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));

package/funcs/subscribersNotificationsArchiveAllRead.d.ts

@@ -13,7 +13,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 declare function subscribersNotificationsArchiveAllRead(client: NovuCore, updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerArchiveAllReadNotificationsResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsArchiveAllRead.d.ts.map

package/funcs/subscribersNotificationsArchiveAllRead.js

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsArchiveAllRead(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));

package/funcs/subscribersNotificationsCompleteAction.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsCompleteAction(client: NovuCore, request: operations.SubscribersControllerCompleteNotificationActionRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerCompleteNotificationActionResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsCompleteAction.d.ts.map

package/funcs/subscribersNotificationsCompleteAction.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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**.
  */
 function subscribersNotificationsCompleteAction(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/subscribersNotificationsCount.d.ts

@@ -12,8 +12,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 declare function subscribersNotificationsCount(client: NovuCore, subscriberId: string, filters: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerGetSubscriberNotificationsCountResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsCount.d.ts.map

package/funcs/subscribersNotificationsCount.js

@@ -50,8 +50,8 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsCount(client, subscriberId, filters, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, subscriberId, filters, idempotencyKey, options));

package/funcs/subscribersNotificationsDelete.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsDelete(client: NovuCore, request: operations.SubscribersControllerDeleteNotificationRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerDeleteNotificationResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsDelete.d.ts.map

package/funcs/subscribersNotificationsDelete.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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**.
  */
 function subscribersNotificationsDelete(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/subscribersNotificationsDeleteAll.d.ts

@@ -13,7 +13,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 declare function subscribersNotificationsDeleteAll(client: NovuCore, updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerDeleteAllNotificationsResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsDeleteAll.d.ts.map

package/funcs/subscribersNotificationsDeleteAll.js

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsDeleteAll(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));

package/funcs/subscribersNotificationsList.d.ts

@@ -12,7 +12,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 declare function subscribersNotificationsList(client: NovuCore, request: operations.SubscribersControllerGetSubscriberNotificationsRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerGetSubscriberNotificationsResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;

package/funcs/subscribersNotificationsList.js

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsList(client, request, options) {

package/funcs/subscribersNotificationsMarkAllAsRead.d.ts

@@ -13,7 +13,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 declare function subscribersNotificationsMarkAllAsRead(client: NovuCore, updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerMarkAllNotificationsAsReadResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsMarkAllAsRead.d.ts.map

package/funcs/subscribersNotificationsMarkAllAsRead.js

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsMarkAllAsRead(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));

package/funcs/subscribersNotificationsMarkAsRead.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsMarkAsRead(client: NovuCore, request: operations.SubscribersControllerMarkNotificationAsReadRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerMarkNotificationAsReadResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsMarkAsRead.d.ts.map

package/funcs/subscribersNotificationsMarkAsRead.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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**.
  */
 function subscribersNotificationsMarkAsRead(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/subscribersNotificationsMarkAsSeen.d.ts

@@ -13,7 +13,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 declare function subscribersNotificationsMarkAsSeen(client: NovuCore, markSubscriberNotificationsAsSeenDto: components.MarkSubscriberNotificationsAsSeenDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerMarkNotificationsAsSeenResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsMarkAsSeen.d.ts.map

package/funcs/subscribersNotificationsMarkAsSeen.js

@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsMarkAsSeen(client, markSubscriberNotificationsAsSeenDto, subscriberId, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, markSubscriberNotificationsAsSeenDto, subscriberId, idempotencyKey, options));

package/funcs/subscribersNotificationsMarkAsUnread.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsMarkAsUnread(client: NovuCore, request: operations.SubscribersControllerMarkNotificationAsUnreadRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerMarkNotificationAsUnreadResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsMarkAsUnread.d.ts.map

package/funcs/subscribersNotificationsMarkAsUnread.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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**.
  */
 function subscribersNotificationsMarkAsUnread(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/subscribersNotificationsRevertAction.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsRevertAction(client: NovuCore, request: operations.SubscribersControllerRevertNotificationActionRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerRevertNotificationActionResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsRevertAction.d.ts.map

package/funcs/subscribersNotificationsRevertAction.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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**.
  */
 function subscribersNotificationsRevertAction(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/funcs/subscribersNotificationsSnooze.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { 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 declare function subscribersNotificationsSnooze(client: NovuCore, request: operations.SubscribersControllerSnoozeNotificationRequest, options?: RequestOptions): APIPromise<Result<operations.SubscribersControllerSnoozeNotificationResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=subscribersNotificationsSnooze.d.ts.map

package/funcs/subscribersNotificationsSnooze.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.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.
  */
 function subscribersNotificationsSnooze(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));