@novu/api 0.7.0 → 1.1.0

package/src/sdk/notifications.ts

@@ -7,16 +7,16 @@ import { notificationsRetrieve } from "../funcs/notificationsRetrieve.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
-import { Stats } from "./stats.js";
 
 export class Notifications extends ClientSDK {
-  private _stats?: Stats;
-  get stats(): Stats {
-    return (this._stats ??= new Stats(this._options));
-  }
-
   /**
-   * Get notifications
+   * List all events
+   *
+   * @remarks
+   * List all notification events (triggered events) for the current environment.
+   *     This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**.
+   *     Checkout all available filters in the query section.
+   *     This API returns event triggers, to list each channel notifications, check messages APIs.
    */
   async list(
     request: operations.NotificationsControllerListNotificationsRequest,
@@ -30,7 +30,12 @@ export class Notifications extends ClientSDK {
   }
 
   /**
-   * Get notification
+   * Retrieve an event
+   *
+   * @remarks
+   * Retrieve an event by its unique key identifier **notificationId**.
+   *     Here **notificationId** is of mongodbId type.
+   *     This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
    */
   async retrieve(
     notificationId: string,

package/src/sdk/novumessages.ts

@@ -12,7 +12,11 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class NovuMessages extends ClientSDK {
   /**
-   * Mark message action as seen
+   * Update notification action status
+   *
+   * @remarks
+   * Update in-app (inbox) notification's action status by its unique key identifier **messageId** and type field **type**.
+   *       **type** field can be **primary** or **secondary**
    */
   async updateAsSeen(
     request: operations.SubscribersV1ControllerMarkActionAsSeenRequest,
@@ -26,7 +30,10 @@ export class NovuMessages extends ClientSDK {
   }
 
   /**
-   * Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
+   * Update all notifications state
+   *
+   * @remarks
+   * Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by **subscriberId**.
    */
   async markAll(
     markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto,
@@ -44,7 +51,11 @@ export class NovuMessages extends ClientSDK {
   }
 
   /**
-   * Mark a subscriber messages as seen, read, unseen or unread
+   * Update notifications state
+   *
+   * @remarks
+   * Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by **subscriberId**.
+   *       **messageId** is of type mongodbId of notifications
    */
   async markAllAs(
     messageMarkAsRequestDto: components.MessageMarkAsRequestDto,

package/src/sdk/novunotifications.ts

@@ -10,7 +10,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class NovuNotifications extends ClientSDK {
   /**
-   * Get in-app notification feed for a particular subscriber
+   * Retrieve subscriber notifications
+   *
+   * @remarks
+   * Retrieve subscriber in-app (inbox) notifications by its unique key identifier **subscriberId**.
    */
   async feed(
     request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
@@ -24,7 +27,10 @@ export class NovuNotifications extends ClientSDK {
   }
 
   /**
-   * Get the unseen in-app notifications count for subscribers feed
+   * Retrieve unseen notifications count
+   *
+   * @remarks
+   * Retrieve unseen in-app (inbox) notifications count for a subscriber by its unique key identifier **subscriberId**.
    */
   async unseenCount(
     request: operations.SubscribersV1ControllerGetUnseenCountRequest,

package/src/sdk/novusubscribers.ts

@@ -2,36 +2,12 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { topicsSubscribersAssign } from "../funcs/topicsSubscribersAssign.js";
-import { topicsSubscribersRemove } from "../funcs/topicsSubscribersRemove.js";
 import { topicsSubscribersRetrieve } from "../funcs/topicsSubscribersRetrieve.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 NovuSubscribers extends ClientSDK {
-  /**
-   * Subscribers addition
-   *
-   * @remarks
-   * Add subscribers to a topic by key
-   */
-  async assign(
-    addSubscribersRequestDto: components.AddSubscribersRequestDto,
-    topicKey: string,
-    idempotencyKey?: string | undefined,
-    options?: RequestOptions,
-  ): Promise<operations.TopicsControllerAssignResponse> {
-    return unwrapAsync(topicsSubscribersAssign(
-      this,
-      addSubscribersRequestDto,
-      topicKey,
-      idempotencyKey,
-      options,
-    ));
-  }
-
   /**
    * Check topic subscriber
    *
@@ -43,7 +19,7 @@ export class NovuSubscribers extends ClientSDK {
     topicKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TopicsControllerGetTopicSubscriberResponse> {
+  ): Promise<operations.TopicsV1ControllerGetTopicSubscriberResponse> {
     return unwrapAsync(topicsSubscribersRetrieve(
       this,
       externalSubscriberId,
@@ -52,25 +28,4 @@ export class NovuSubscribers extends ClientSDK {
       options,
     ));
   }
-
-  /**
-   * Subscribers removal
-   *
-   * @remarks
-   * Remove subscribers from a topic
-   */
-  async remove(
-    removeSubscribersRequestDto: components.RemoveSubscribersRequestDto,
-    topicKey: string,
-    idempotencyKey?: string | undefined,
-    options?: RequestOptions,
-  ): Promise<operations.TopicsControllerRemoveSubscribersResponse | undefined> {
-    return unwrapAsync(topicsSubscribersRemove(
-      this,
-      removeSubscribersRequestDto,
-      topicKey,
-      idempotencyKey,
-      options,
-    ));
-  }
 }

package/src/sdk/novutopics.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscribersTopicsList } from "../funcs/subscribersTopicsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class NovuTopics extends ClientSDK {
+  /**
+   * Retrieve subscriber subscriptions
+   *
+   * @remarks
+   * Retrieve subscriber's topic subscriptions by its unique key identifier **subscriberId**.
+   *     Checkout all available filters in the query section.
+   */
+  async list(
+    request: operations.SubscribersControllerListSubscriberTopicsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerListSubscriberTopicsResponse> {
+    return unwrapAsync(subscribersTopicsList(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/preferences.ts

@@ -11,10 +11,11 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Preferences extends ClientSDK {
   /**
-   * Get subscriber preferences
+   * Retrieve subscriber preferences
    *
    * @remarks
-   * Get subscriber global and workflow specific preferences
+   * Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
+   *     This API returns all five channels preferences for all workflows and global preferences.
    */
   async list(
     subscriberId: string,
@@ -30,10 +31,12 @@ export class Preferences extends ClientSDK {
   }
 
   /**
-   * Update subscriber global or workflow specific preferences
+   * Update subscriber preferences
    *
    * @remarks
-   * Update subscriber global or workflow specific preferences
+   * Update subscriber preferences by its unique key identifier **subscriberId**.
+   *     **workflowId** is optional field, if provided, this API will update that workflow preference,
+   *     otherwise it will update global preferences
    */
   async update(
     patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto,

package/src/sdk/properties.ts

@@ -13,7 +13,7 @@ export class Properties extends ClientSDK {
    * Update subscriber online status
    *
    * @remarks
-   * Used to update the subscriber isOnline flag.
+   * Update the subscriber online status by its unique key identifier **subscriberId**
    */
   async updateOnlineFlag(
     updateSubscriberOnlineFlagRequestDto:

package/src/sdk/sdk.ts

@@ -22,6 +22,11 @@ export class Novu extends ClientSDK {
     return (this._subscribers ??= new Subscribers(this._options));
   }
 
+  private _topics?: Topics;
+  get topics(): Topics {
+    return (this._topics ??= new Topics(this._options));
+  }
+
   private _integrations?: Integrations;
   get integrations(): Integrations {
     return (this._integrations ??= new Integrations(this._options));
@@ -37,11 +42,6 @@ export class Novu extends ClientSDK {
     return (this._notifications ??= new Notifications(this._options));
   }
 
-  private _topics?: Topics;
-  get topics(): Topics {
-    return (this._topics ??= new Topics(this._options));
-  }
-
   /**
    * Trigger event
    *

package/src/sdk/subscribers.ts

@@ -5,20 +5,17 @@
 import { subscribersCreate } from "../funcs/subscribersCreate.js";
 import { subscribersCreateBulk } from "../funcs/subscribersCreateBulk.js";
 import { subscribersDelete } from "../funcs/subscribersDelete.js";
-import { subscribersList } from "../funcs/subscribersList.js";
 import { subscribersPatch } from "../funcs/subscribersPatch.js";
 import { subscribersRetrieve } from "../funcs/subscribersRetrieve.js";
 import { subscribersSearch } from "../funcs/subscribersSearch.js";
-import { subscribersUpsert } from "../funcs/subscribersUpsert.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";
-import { PageIterator, unwrapResultIterator } from "../types/operations.js";
-import { Authentication } from "./authentication.js";
 import { Credentials } from "./credentials.js";
 import { NovuMessages } from "./novumessages.js";
 import { NovuNotifications } from "./novunotifications.js";
+import { NovuTopics } from "./novutopics.js";
 import { Preferences } from "./preferences.js";
 import { Properties } from "./properties.js";
 
@@ -28,16 +25,16 @@ export class Subscribers extends ClientSDK {
     return (this._preferences ??= new Preferences(this._options));
   }
 
+  private _topics?: NovuTopics;
+  get topics(): NovuTopics {
+    return (this._topics ??= new NovuTopics(this._options));
+  }
+
   private _credentials?: Credentials;
   get credentials(): Credentials {
     return (this._credentials ??= new Credentials(this._options));
   }
 
-  private _authentication?: Authentication;
-  get authentication(): Authentication {
-    return (this._authentication ??= new Authentication(this._options));
-  }
-
   private _messages?: NovuMessages;
   get messages(): NovuMessages {
     return (this._messages ??= new NovuMessages(this._options));
@@ -54,7 +51,11 @@ export class Subscribers extends ClientSDK {
   }
 
   /**
-   * Search for subscribers
+   * Search subscribers
+   *
+   * @remarks
+   * Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
+   *     The search is case sensitive and supports pagination.Checkout all available filters in the query section.
    */
   async search(
     request: operations.SubscribersControllerSearchSubscribersRequest,
@@ -68,10 +69,11 @@ export class Subscribers extends ClientSDK {
   }
 
   /**
-   * Create subscriber
+   * Create a subscriber
    *
    * @remarks
-   * Create subscriber with the given data
+   * Create a subscriber with the subscriber attributes.
+   *       **subscriberId** is a required field, rest other fields are optional, if the subscriber already exists, it will be updated
    */
   async create(
     createSubscriberRequestDto: components.CreateSubscriberRequestDto,
@@ -87,10 +89,11 @@ export class Subscribers extends ClientSDK {
   }
 
   /**
-   * Get subscriber
+   * Retrieve a subscriber
    *
    * @remarks
-   * Get subscriber by your internal id used to identify the subscriber
+   * Retrive a subscriber by its unique key identifier **subscriberId**.
+   *     **subscriberId** field is required.
    */
   async retrieve(
     subscriberId: string,
@@ -106,10 +109,11 @@ export class Subscribers extends ClientSDK {
   }
 
   /**
-   * Patch subscriber
+   * Update a subscriber
    *
    * @remarks
-   * Patch subscriber by your internal id used to identify the subscriber
+   * Update a subscriber by its unique key identifier **subscriberId**.
+   *     **subscriberId** is a required field, rest other fields are optional
    */
   async patch(
     patchSubscriberRequestDto: components.PatchSubscriberRequestDto,
@@ -130,7 +134,7 @@ export class Subscribers extends ClientSDK {
    * Delete subscriber
    *
    * @remarks
-   * Deletes a subscriber entity from the Novu platform
+   * Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions
    */
   async delete(
     subscriberId: string,
@@ -145,60 +149,12 @@ export class Subscribers extends ClientSDK {
     ));
   }
 
-  /**
-   * Get subscribers
-   *
-   * @remarks
-   * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
-   */
-  async list(
-    page?: number | undefined,
-    limit?: number | undefined,
-    idempotencyKey?: string | undefined,
-    options?: RequestOptions,
-  ): Promise<
-    PageIterator<
-      operations.SubscribersV1ControllerListSubscribersResponse,
-      { page: number }
-    >
-  > {
-    return unwrapResultIterator(subscribersList(
-      this,
-      page,
-      limit,
-      idempotencyKey,
-      options,
-    ));
-  }
-
-  /**
-   * Upsert subscriber
-   *
-   * @remarks
-   * Used to upsert the subscriber entity with new information
-   */
-  async upsert(
-    updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
-    subscriberId: string,
-    idempotencyKey?: string | undefined,
-    options?: RequestOptions,
-  ): Promise<operations.SubscribersV1ControllerUpdateSubscriberResponse> {
-    return unwrapAsync(subscribersUpsert(
-      this,
-      updateSubscriberRequestDto,
-      subscriberId,
-      idempotencyKey,
-      options,
-    ));
-  }
-
   /**
    * Bulk create subscribers
    *
    * @remarks
    *
-   *       Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
-   *       The bulk API is limited to 500 subscribers per request.
+   *       Using this endpoint multiple subscribers can be created at once. The bulk API is limited to 500 subscribers per request.
    */
   async createBulk(
     bulkSubscriberCreateDto: components.BulkSubscriberCreateDto,

package/src/sdk/subscriptions.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { topicsSubscriptionsCreate } from "../funcs/topicsSubscriptionsCreate.js";
+import { topicsSubscriptionsDelete } from "../funcs/topicsSubscriptionsDelete.js";
+import { topicsSubscriptionsList } from "../funcs/topicsSubscriptionsList.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 Subscriptions extends ClientSDK {
+  /**
+   * List topic subscriptions
+   *
+   * @remarks
+   * List all topics that a subscriber is subscribed to.
+   *     Checkout all available filters in the query section.
+   */
+  async list(
+    request: operations.TopicsControllerListTopicSubscriptionsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerListTopicSubscriptionsResponse> {
+    return unwrapAsync(topicsSubscriptionsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create topic subscriptions
+   *
+   * @remarks
+   * This api will create subscription for subscriberIds for a topic.
+   *       Its like subscribing to a common interest group. if topic does not exist, it will be created.
+   */
+  async create(
+    createTopicSubscriptionsRequestDto:
+      components.CreateTopicSubscriptionsRequestDto,
+    topicKey: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerCreateTopicSubscriptionsResponse> {
+    return unwrapAsync(topicsSubscriptionsCreate(
+      this,
+      createTopicSubscriptionsRequestDto,
+      topicKey,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete topic subscriptions
+   *
+   * @remarks
+   * Delete subscriptions for subscriberIds for a topic.
+   */
+  async delete(
+    deleteTopicSubscriptionsRequestDto:
+      components.DeleteTopicSubscriptionsRequestDto,
+    topicKey: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerDeleteTopicSubscriptionsResponse> {
+    return unwrapAsync(topicsSubscriptionsDelete(
+      this,
+      deleteTopicSubscriptionsRequestDto,
+      topicKey,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/topics.ts

@@ -4,69 +4,77 @@
 
 import { topicsCreate } from "../funcs/topicsCreate.js";
 import { topicsDelete } from "../funcs/topicsDelete.js";
+import { topicsGet } from "../funcs/topicsGet.js";
 import { topicsList } from "../funcs/topicsList.js";
-import { topicsRename } from "../funcs/topicsRename.js";
-import { topicsRetrieve } from "../funcs/topicsRetrieve.js";
+import { topicsUpdate } from "../funcs/topicsUpdate.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";
 import { NovuSubscribers } from "./novusubscribers.js";
+import { Subscriptions } from "./subscriptions.js";
 
 export class Topics extends ClientSDK {
+  private _subscriptions?: Subscriptions;
+  get subscriptions(): Subscriptions {
+    return (this._subscriptions ??= new Subscriptions(this._options));
+  }
+
   private _subscribers?: NovuSubscribers;
   get subscribers(): NovuSubscribers {
     return (this._subscribers ??= new NovuSubscribers(this._options));
   }
 
   /**
-   * Topic creation
+   * List all topics
    *
    * @remarks
-   * Create a topic
+   * This api returns a paginated list of topics.
+   *     Topics can be filtered by **key**, **name**, or **includeCursor** to paginate through the list.
+   *     Checkout all available filters in the query section.
    */
-  async create(
-    createTopicRequestDto: components.CreateTopicRequestDto,
-    idempotencyKey?: string | undefined,
+  async list(
+    request: operations.TopicsControllerListTopicsRequest,
     options?: RequestOptions,
-  ): Promise<operations.TopicsControllerCreateTopicResponse> {
-    return unwrapAsync(topicsCreate(
+  ): Promise<operations.TopicsControllerListTopicsResponse> {
+    return unwrapAsync(topicsList(
       this,
-      createTopicRequestDto,
-      idempotencyKey,
+      request,
       options,
     ));
   }
 
   /**
-   * Get topic list filtered
+   * Create a topic
    *
    * @remarks
-   * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter
+   * Creates a new topic if it does not exist, or updates an existing topic if it already exists
    */
-  async list(
-    request: operations.TopicsControllerListTopicsRequest,
+  async create(
+    createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TopicsControllerListTopicsResponse> {
-    return unwrapAsync(topicsList(
+  ): Promise<operations.TopicsControllerUpsertTopicResponse> {
+    return unwrapAsync(topicsCreate(
       this,
-      request,
+      createUpdateTopicRequestDto,
+      idempotencyKey,
       options,
     ));
   }
 
   /**
-   * Delete topic
+   * Retrieve a topic
    *
    * @remarks
-   * Delete a topic by its topic key if it has no subscribers
+   * Retrieve a topic by its unique key identifier **topicKey**
    */
-  async delete(
+  async get(
     topicKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TopicsControllerDeleteTopicResponse | undefined> {
-    return unwrapAsync(topicsDelete(
+  ): Promise<operations.TopicsControllerGetTopicResponse> {
+    return unwrapAsync(topicsGet(
       this,
       topicKey,
       idempotencyKey,
@@ -75,18 +83,20 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Get topic
+   * Update a topic
    *
    * @remarks
-   * Get a topic by its topic key
+   * Update a topic name by its unique key identifier **topicKey**
    */
-  async retrieve(
+  async update(
+    updateTopicRequestDto: components.UpdateTopicRequestDto,
     topicKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TopicsControllerGetTopicResponse> {
-    return unwrapAsync(topicsRetrieve(
+  ): Promise<operations.TopicsControllerUpdateTopicResponse> {
+    return unwrapAsync(topicsUpdate(
       this,
+      updateTopicRequestDto,
       topicKey,
       idempotencyKey,
       options,
@@ -94,20 +104,19 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Rename a topic
+   * Delete a topic
    *
    * @remarks
-   * Rename a topic by providing a new name
+   * Delete a topic by its unique key identifier **topicKey**.
+   *     This action is irreversible and will remove all subscriptions to the topic.
    */
-  async rename(
-    renameTopicRequestDto: components.RenameTopicRequestDto,
+  async delete(
     topicKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TopicsControllerRenameTopicResponse> {
-    return unwrapAsync(topicsRename(
+  ): Promise<operations.TopicsControllerDeleteTopicResponse> {
+    return unwrapAsync(topicsDelete(
       this,
-      renameTopicRequestDto,
       topicKey,
       idempotencyKey,
       options,