@novu/api 3.14.1 → 3.14.2-rc.1

package/src/sdk/novunotifications.ts

@@ -2,13 +2,353 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { subscribersNotificationsArchive } from "../funcs/subscribersNotificationsArchive.js";
+import { subscribersNotificationsArchiveAll } from "../funcs/subscribersNotificationsArchiveAll.js";
+import { subscribersNotificationsArchiveAllRead } from "../funcs/subscribersNotificationsArchiveAllRead.js";
+import { subscribersNotificationsCompleteAction } from "../funcs/subscribersNotificationsCompleteAction.js";
+import { subscribersNotificationsCount } from "../funcs/subscribersNotificationsCount.js";
+import { subscribersNotificationsDelete } from "../funcs/subscribersNotificationsDelete.js";
+import { subscribersNotificationsDeleteAll } from "../funcs/subscribersNotificationsDeleteAll.js";
 import { subscribersNotificationsFeed } from "../funcs/subscribersNotificationsFeed.js";
+import { subscribersNotificationsList } from "../funcs/subscribersNotificationsList.js";
+import { subscribersNotificationsMarkAllAsRead } from "../funcs/subscribersNotificationsMarkAllAsRead.js";
+import { subscribersNotificationsMarkAsRead } from "../funcs/subscribersNotificationsMarkAsRead.js";
+import { subscribersNotificationsMarkAsSeen } from "../funcs/subscribersNotificationsMarkAsSeen.js";
+import { subscribersNotificationsMarkAsUnread } from "../funcs/subscribersNotificationsMarkAsUnread.js";
+import { subscribersNotificationsRevertAction } from "../funcs/subscribersNotificationsRevertAction.js";
+import { subscribersNotificationsSnooze } from "../funcs/subscribersNotificationsSnooze.js";
+import { subscribersNotificationsUnarchive } from "../funcs/subscribersNotificationsUnarchive.js";
 import { subscribersNotificationsUnseenCount } from "../funcs/subscribersNotificationsUnseenCount.js";
+import { subscribersNotificationsUnsnooze } from "../funcs/subscribersNotificationsUnsnooze.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class NovuNotifications extends ClientSDK {
+  /**
+   * Retrieve subscriber notifications
+   *
+   * @remarks
+   * Retrieve in-app 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: operations.SubscribersControllerGetSubscriberNotificationsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerGetSubscriberNotificationsResponse
+  > {
+    return unwrapAsync(subscribersNotificationsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete notification
+   *
+   * @remarks
+   * Delete a specific notification by its unique identifier **notificationId**.
+   */
+  async delete(
+    request: operations.SubscribersControllerDeleteNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerDeleteNotificationResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Complete notification action
+   *
+   * @remarks
+   * Mark a notification action (primary or secondary) as completed by its unique identifier **notificationId** and action type.
+   */
+  async completeAction(
+    request: operations.SubscribersControllerCompleteNotificationActionRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerCompleteNotificationActionResponse
+  > {
+    return unwrapAsync(subscribersNotificationsCompleteAction(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Revert notification action
+   *
+   * @remarks
+   * Revert a notification action (primary or secondary) to pending state by its unique identifier **notificationId** and action type.
+   */
+  async revertAction(
+    request: operations.SubscribersControllerRevertNotificationActionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerRevertNotificationActionResponse> {
+    return unwrapAsync(subscribersNotificationsRevertAction(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Archive notification
+   *
+   * @remarks
+   * Archive a specific notification by its unique identifier **notificationId**.
+   */
+  async archive(
+    request: operations.SubscribersControllerArchiveNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerArchiveNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsArchive(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Mark notification as read
+   *
+   * @remarks
+   * Mark a specific notification as read by its unique identifier **notificationId**.
+   */
+  async markAsRead(
+    request: operations.SubscribersControllerMarkNotificationAsReadRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerMarkNotificationAsReadResponse> {
+    return unwrapAsync(subscribersNotificationsMarkAsRead(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Snooze notification
+   *
+   * @remarks
+   * Snooze a specific notification by its unique identifier **notificationId** until a specified time.
+   */
+  async snooze(
+    request: operations.SubscribersControllerSnoozeNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerSnoozeNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsSnooze(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Unarchive notification
+   *
+   * @remarks
+   * Unarchive a specific notification by its unique identifier **notificationId**.
+   */
+  async unarchive(
+    request: operations.SubscribersControllerUnarchiveNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerUnarchiveNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsUnarchive(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Mark notification as unread
+   *
+   * @remarks
+   * Mark a specific notification as unread by its unique identifier **notificationId**.
+   */
+  async markAsUnread(
+    request: operations.SubscribersControllerMarkNotificationAsUnreadRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerMarkNotificationAsUnreadResponse> {
+    return unwrapAsync(subscribersNotificationsMarkAsUnread(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Unsnooze notification
+   *
+   * @remarks
+   * Unsnooze a specific notification by its unique identifier **notificationId**.
+   */
+  async unsnooze(
+    request: operations.SubscribersControllerUnsnoozeNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerUnsnoozeNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsUnsnooze(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Archive all notifications
+   *
+   * @remarks
+   * Archive all notifications matching the specified filters. Supports context-based filtering.
+   */
+  async archiveAll(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerArchiveAllNotificationsResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsArchiveAll(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async count(
+    subscriberId: string,
+    filters: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerGetSubscriberNotificationsCountResponse
+  > {
+    return unwrapAsync(subscribersNotificationsCount(
+      this,
+      subscriberId,
+      filters,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete all notifications
+   *
+   * @remarks
+   * Delete all notifications matching the specified filters. Supports context-based filtering.
+   */
+  async deleteAll(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerDeleteAllNotificationsResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsDeleteAll(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Mark all notifications as read
+   *
+   * @remarks
+   * Mark all notifications matching the specified filters as read. Supports context-based filtering.
+   */
+  async markAllAsRead(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.SubscribersControllerMarkAllNotificationsAsReadResponse
+    | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsMarkAllAsRead(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Archive all read notifications
+   *
+   * @remarks
+   * Archive all read notifications matching the specified filters. Supports context-based filtering.
+   */
+  async archiveAllRead(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.SubscribersControllerArchiveAllReadNotificationsResponse
+    | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsArchiveAllRead(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Mark notifications as seen
+   *
+   * @remarks
+   * Mark specific notifications or notifications matching filters as seen. Supports context-based filtering.
+   */
+  async markAsSeen(
+    markSubscriberNotificationsAsSeenDto:
+      components.MarkSubscriberNotificationsAsSeenDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerMarkNotificationsAsSeenResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsMarkAsSeen(
+      this,
+      markSubscriberNotificationsAsSeenDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Retrieve subscriber notifications
    *

package/src/sdk/sdk.ts

@@ -15,6 +15,7 @@ import { ChannelConnections } from "./channelconnections.js";
 import { ChannelEndpoints } from "./channelendpoints.js";
 import { Contexts } from "./contexts.js";
 import { Environments } from "./environments.js";
+import { EnvironmentVariables } from "./environmentvariables.js";
 import { Integrations } from "./integrations.js";
 import { Layouts } from "./layouts.js";
 import { Messages } from "./messages.js";
@@ -75,6 +76,13 @@ export class Novu extends ClientSDK {
     return (this._channelEndpoints ??= new ChannelEndpoints(this._options));
   }
 
+  private _environmentVariables?: EnvironmentVariables;
+  get environmentVariables(): EnvironmentVariables {
+    return (this._environmentVariables ??= new EnvironmentVariables(
+      this._options,
+    ));
+  }
+
   private _integrations?: Integrations;
   get integrations(): Integrations {
     return (this._integrations ??= new Integrations(this._options));

package/src/sdk/steps.ts

@@ -2,12 +2,30 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { workflowsStepsGeneratePreview } from "../funcs/workflowsStepsGeneratePreview.js";
 import { workflowsStepsRetrieve } from "../funcs/workflowsStepsRetrieve.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Steps extends ClientSDK {
+  /**
+   * Generate step preview
+   *
+   * @remarks
+   * Generates a preview for a specific workflow step by its unique identifier **stepId**
+   */
+  async generatePreview(
+    request: operations.WorkflowControllerGeneratePreviewRequest,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerGeneratePreviewResponse> {
+    return unwrapAsync(workflowsStepsGeneratePreview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve workflow step
    *

package/src/sdk/subscribers.ts

@@ -20,6 +20,11 @@ import { Preferences } from "./preferences.js";
 import { Properties } from "./properties.js";
 
 export class Subscribers extends ClientSDK {
+  private _notifications?: NovuNotifications;
+  get notifications(): NovuNotifications {
+    return (this._notifications ??= new NovuNotifications(this._options));
+  }
+
   private _preferences?: Preferences;
   get preferences(): Preferences {
     return (this._preferences ??= new Preferences(this._options));
@@ -40,11 +45,6 @@ export class Subscribers extends ClientSDK {
     return (this._messages ??= new NovuMessages(this._options));
   }
 
-  private _notifications?: NovuNotifications;
-  get notifications(): NovuNotifications {
-    return (this._notifications ??= new NovuNotifications(this._options));
-  }
-
   private _properties?: Properties;
   get properties(): Properties {
     return (this._properties ??= new Properties(this._options));