@novu/api 1.0.0 → 1.1.0

package/src/sdk/integrations.ts

@@ -12,19 +12,13 @@ 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 { Webhooks } from "./webhooks.js";
 
 export class Integrations extends ClientSDK {
-  private _webhooks?: Webhooks;
-  get webhooks(): Webhooks {
-    return (this._webhooks ??= new Webhooks(this._options));
-  }
-
   /**
-   * Get integrations
+   * List all integrations
    *
    * @remarks
-   * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+   * List all the channels integrations created in the organization
    */
   async list(
     idempotencyKey?: string | undefined,
@@ -38,10 +32,11 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Create integration
+   * Create an integration
    *
    * @remarks
-   * Create an integration for the current environment the user is based on the API key provided
+   * Create an integration for the current environment the user is based on the API key provided.
+   *     Each provider supports different credentials, check the provider documentation for more details.
    */
   async create(
     createIntegrationRequestDto: components.CreateIntegrationRequestDto,
@@ -57,7 +52,11 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Update integration
+   * Update an integration
+   *
+   * @remarks
+   * Update an integration by its unique key identifier **integrationId**.
+   *     Each provider supports different credentials, check the provider documentation for more details.
    */
   async update(
     updateIntegrationRequestDto: components.UpdateIntegrationRequestDto,
@@ -75,7 +74,11 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Delete integration
+   * Delete an integration
+   *
+   * @remarks
+   * Delete an integration by its unique key identifier **integrationId**.
+   *     This action is irreversible.
    */
   async delete(
     integrationId: string,
@@ -91,7 +94,12 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Set integration as primary
+   * Update integration as primary
+   *
+   * @remarks
+   * Update an integration as **primary** by its unique key identifier **integrationId**.
+   *     This API will set the integration as primary for that channel in the current environment.
+   *     Primary integration is used to deliver notification for sms and email channels in the workflow.
    */
   async setAsPrimary(
     integrationId: string,
@@ -107,10 +115,10 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Get active integrations
+   * List active integrations
    *
    * @remarks
-   * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+   * List all the active integrations created in the organization
    */
   async listActive(
     idempotencyKey?: string | undefined,

package/src/sdk/messages.ts

@@ -11,10 +11,12 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Messages extends ClientSDK {
   /**
-   * Get messages
+   * List all messages
    *
    * @remarks
-   * Returns a list of messages, could paginate using the `page` query parameter
+   * List all messages for the current environment.
+   *     This API supports filtering by **channel**, **subscriberId**, and **transactionId**.
+   *     This API returns a paginated list of messages.
    */
   async retrieve(
     request: operations.MessagesControllerGetMessagesRequest,
@@ -28,10 +30,11 @@ export class Messages extends ClientSDK {
   }
 
   /**
-   * Delete message
+   * Delete a message
    *
    * @remarks
-   * Deletes a message entity from the Novu platform
+   * Delete a message entity from the Novu platform by **messageId**.
+   *     This action is irreversible. **messageId** is required and of mongodbId type.
    */
   async delete(
     messageId: string,
@@ -50,7 +53,8 @@ export class Messages extends ClientSDK {
    * Delete messages by transactionId
    *
    * @remarks
-   * Deletes messages entity from the Novu platform using TransactionId of message
+   * Delete multiple messages from the Novu platform using **transactionId** of triggered event.
+   *     This API supports filtering by **channel** and delete all messages associated with the **transactionId**.
    */
   async deleteByTransactionId(
     transactionId: string,

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.
+   * 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/novutopics.ts

@@ -9,10 +9,11 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class NovuTopics extends ClientSDK {
   /**
-   * List topics a subscriber is subscribed to
+   * Retrieve subscriber subscriptions
    *
    * @remarks
-   * List topic subscriptions for a subscriber with pagination and filtering
+   * Retrieve subscriber's topic subscriptions by its unique key identifier **subscriberId**.
+   *     Checkout all available filters in the query section.
    */
   async list(
     request: operations.SubscribersControllerListSubscriberTopicsRequest,

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/subscribers.ts

@@ -5,17 +5,13 @@
 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";
@@ -39,11 +35,6 @@ export class Subscribers extends ClientSDK {
     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));
@@ -60,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,
@@ -74,10 +69,11 @@ export class Subscribers extends ClientSDK {
   }
 
   /**
-   * Create subscriber
+   * Create a subscriber
    *
    * @remarks
-   * Create subscriber with the given data, if the subscriber already exists, it will be updated
+   * 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,
@@ -93,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,
@@ -112,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,
@@ -136,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,
@@ -151,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

@@ -13,6 +13,10 @@ 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,
@@ -26,7 +30,11 @@ export class Subscriptions extends ClientSDK {
   }
 
   /**
-   * Create topic subscriptions, if the topic does not exist, it will be created.
+   * 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:
@@ -46,6 +54,9 @@ export class Subscriptions extends ClientSDK {
 
   /**
    * Delete topic subscriptions
+   *
+   * @remarks
+   * Delete subscriptions for subscriberIds for a topic.
    */
   async delete(
     deleteTopicSubscriptionsRequestDto:

package/src/sdk/topics.ts

@@ -26,7 +26,12 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Get topics list
+   * List all topics
+   *
+   * @remarks
+   * 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 list(
     request: operations.TopicsControllerListTopicsRequest,
@@ -40,7 +45,7 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Create or update a topic
+   * Create a topic
    *
    * @remarks
    * Creates a new topic if it does not exist, or updates an existing topic if it already exists
@@ -59,7 +64,10 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Get topic by key
+   * Retrieve a topic
+   *
+   * @remarks
+   * Retrieve a topic by its unique key identifier **topicKey**
    */
   async get(
     topicKey: string,
@@ -75,7 +83,10 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Update topic by key
+   * Update a topic
+   *
+   * @remarks
+   * Update a topic name by its unique key identifier **topicKey**
    */
   async update(
     updateTopicRequestDto: components.UpdateTopicRequestDto,
@@ -93,7 +104,11 @@ export class Topics extends ClientSDK {
   }
 
   /**
-   * Delete topic by key
+   * Delete a topic
+   *
+   * @remarks
+   * Delete a topic by its unique key identifier **topicKey**.
+   *     This action is irreversible and will remove all subscriptions to the topic.
    */
   async delete(
     topicKey: string,