@novu/api 0.7.0 → 1.1.0

package/src/funcs/integrationsCreate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function integrationsCreate(
   client: NovuCore,

package/src/funcs/integrationsDelete.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete integration
+ * Delete an integration
+ *
+ * @remarks
+ * Delete an integration by its unique key identifier **integrationId**.
+ *     This action is irreversible.
  */
 export function integrationsDelete(
   client: NovuCore,

package/src/funcs/integrationsList.ts

@@ -25,10 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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
  */
 export function integrationsList(
   client: NovuCore,

package/src/funcs/integrationsListActive.ts

@@ -25,10 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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
  */
 export function integrationsListActive(
   client: NovuCore,

package/src/funcs/integrationsSetAsPrimary.ts

@@ -25,7 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function integrationsSetAsPrimary(
   client: NovuCore,

package/src/funcs/integrationsUpdate.ts

@@ -26,7 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function integrationsUpdate(
   client: NovuCore,

package/src/funcs/messagesDelete.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function messagesDelete(
   client: NovuCore,

package/src/funcs/messagesDeleteByTransactionId.ts

@@ -28,7 +28,8 @@ import { Result } from "../types/fp.js";
  * 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**.
  */
 export function messagesDeleteByTransactionId(
   client: NovuCore,

package/src/funcs/messagesRetrieve.ts

@@ -25,10 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function messagesRetrieve(
   client: NovuCore,

package/src/funcs/notificationsList.ts

@@ -25,7 +25,13 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function notificationsList(
   client: NovuCore,
@@ -102,6 +108,7 @@ async function $do(
     "search": payload.search,
     "subscriberIds": payload.subscriberIds,
     "templates": payload.templates,
+    "topicKey": payload.topicKey,
     "transactionId": payload.transactionId,
   });
 

package/src/funcs/notificationsRetrieve.ts

@@ -25,7 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function notificationsRetrieve(
   client: NovuCore,

package/src/funcs/subscribersCreate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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
  */
 export function subscribersCreate(
   client: NovuCore,

package/src/funcs/subscribersCreateBulk.ts

@@ -30,8 +30,7 @@ import { Result } from "../types/fp.js";
  *
  * @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.
  */
 export function subscribersCreateBulk(
   client: NovuCore,

package/src/funcs/subscribersCredentialsAppend.ts

@@ -26,11 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Modify subscriber credentials
+ * Upsert provider credentials
  *
  * @remarks
- * Subscriber credentials associated to the delivery methods such as slack and push tokens.
- *     This endpoint appends provided credentials and deviceTokens to the existing ones.
+ * Update credentials for a provider such as **slack** and **FCM**.
+ *       **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
  */
 export function subscribersCredentialsAppend(
   client: NovuCore,

package/src/funcs/subscribersCredentialsDelete.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete subscriber credentials by providerId
+ * Delete provider credentials
  *
  * @remarks
- * Delete subscriber credentials such as slack and expo tokens.
+ * Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**.
+ *     This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.
  */
 export function subscribersCredentialsDelete(
   client: NovuCore,

package/src/funcs/subscribersCredentialsUpdate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update subscriber credentials
+ * Update provider credentials
  *
  * @remarks
- * Subscriber credentials associated to the delivery methods such as slack and push tokens.
+ * Update credentials for a provider such as slack and push tokens.
+ *       **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
  */
 export function subscribersCredentialsUpdate(
   client: NovuCore,

package/src/funcs/subscribersDelete.ts

@@ -28,7 +28,7 @@ import { Result } from "../types/fp.js";
  * 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
  */
 export function subscribersDelete(
   client: NovuCore,

package/src/funcs/subscribersMessagesMarkAll.ts

@@ -26,7 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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**.
  */
 export function subscribersMessagesMarkAll(
   client: NovuCore,

package/src/funcs/subscribersMessagesMarkAllAs.ts

@@ -26,7 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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
  */
 export function subscribersMessagesMarkAllAs(
   client: NovuCore,

package/src/funcs/subscribersMessagesUpdateAsSeen.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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**
  */
 export function subscribersMessagesUpdateAsSeen(
   client: NovuCore,

package/src/funcs/subscribersNotificationsFeed.ts

@@ -25,7 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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**.
  */
 export function subscribersNotificationsFeed(
   client: NovuCore,

package/src/funcs/subscribersNotificationsUnseenCount.ts

@@ -25,7 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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**.
  */
 export function subscribersNotificationsUnseenCount(
   client: NovuCore,

package/src/funcs/subscribersPatch.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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
  */
 export function subscribersPatch(
   client: NovuCore,

package/src/funcs/subscribersPreferencesList.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function subscribersPreferencesList(
   client: NovuCore,

package/src/funcs/subscribersPreferencesUpdate.ts

@@ -26,10 +26,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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
  */
 export function subscribersPreferencesUpdate(
   client: NovuCore,

package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Update subscriber online status
  *
  * @remarks
- * Used to update the subscriber isOnline flag.
+ * Update the subscriber online status by its unique key identifier **subscriberId**
  */
 export function subscribersPropertiesUpdateOnlineFlag(
   client: NovuCore,

package/src/funcs/subscribersRetrieve.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function subscribersRetrieve(
   client: NovuCore,

package/src/funcs/subscribersSearch.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
  */
 export function subscribersSearch(
   client: NovuCore,

package/src/funcs/{notificationsStatsGraph.ts → subscribersTopicsList.ts}

@@ -25,16 +25,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get notification graph statistics
+ * Retrieve subscriber subscriptions
+ *
+ * @remarks
+ * Retrieve subscriber's topic subscriptions by its unique key identifier **subscriberId**.
+ *     Checkout all available filters in the query section.
  */
-export function notificationsStatsGraph(
+export function subscribersTopicsList(
   client: NovuCore,
-  days?: number | undefined,
-  idempotencyKey?: string | undefined,
+  request: operations.SubscribersControllerListSubscriberTopicsRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.NotificationsControllerGetActivityGraphStatsResponse,
+    operations.SubscribersControllerListSubscriberTopicsResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -50,21 +53,19 @@ export function notificationsStatsGraph(
 > {
   return new APIPromise($do(
     client,
-    days,
-    idempotencyKey,
+    request,
     options,
   ));
 }
 
 async function $do(
   client: NovuCore,
-  days?: number | undefined,
-  idempotencyKey?: string | undefined,
+  request: operations.SubscribersControllerListSubscriberTopicsRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.NotificationsControllerGetActivityGraphStatsResponse,
+      operations.SubscribersControllerListSubscriberTopicsResponse,
       | errors.ErrorDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
@@ -80,17 +81,10 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.NotificationsControllerGetActivityGraphStatsRequest =
-    {
-      days: days,
-      idempotencyKey: idempotencyKey,
-    };
-
   const parsed = safeParse(
-    input,
+    request,
     (value) =>
-      operations
-        .NotificationsControllerGetActivityGraphStatsRequest$outboundSchema
+      operations.SubscribersControllerListSubscriberTopicsRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -100,10 +94,25 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/v1/notifications/graph/stats")();
+  const pathParams = {
+    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/subscribers/{subscriberId}/subscriptions")(
+    pathParams,
+  );
 
   const query = encodeFormQuery({
-    "days": payload.days,
+    "after": payload.after,
+    "before": payload.before,
+    "includeCursor": payload.includeCursor,
+    "key": payload.key,
+    "limit": payload.limit,
+    "orderBy": payload.orderBy,
+    "orderDirection": payload.orderDirection,
   });
 
   const headers = new Headers(compactMap({
@@ -121,7 +130,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "NotificationsController_getActivityGraphStats",
+    operationID: "SubscribersController_listSubscriberTopics",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -190,7 +199,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.NotificationsControllerGetActivityGraphStatsResponse,
+    operations.SubscribersControllerListSubscriberTopicsResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -206,7 +215,7 @@ async function $do(
     M.json(
       200,
       operations
-        .NotificationsControllerGetActivityGraphStatsResponse$inboundSchema,
+        .SubscribersControllerListSubscriberTopicsResponse$inboundSchema,
       { hdrs: true, key: "Result" },
     ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),

package/src/funcs/topicsCreate.ts

@@ -26,19 +26,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Topic creation
+ * Create a topic
  *
  * @remarks
- * Create a topic
+ * Creates a new topic if it does not exist, or updates an existing topic if it already exists
  */
 export function topicsCreate(
   client: NovuCore,
-  createTopicRequestDto: components.CreateTopicRequestDto,
+  createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.TopicsControllerCreateTopicResponse,
+    operations.TopicsControllerUpsertTopicResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -54,7 +54,7 @@ export function topicsCreate(
 > {
   return new APIPromise($do(
     client,
-    createTopicRequestDto,
+    createUpdateTopicRequestDto,
     idempotencyKey,
     options,
   ));
@@ -62,13 +62,13 @@ export function topicsCreate(
 
 async function $do(
   client: NovuCore,
-  createTopicRequestDto: components.CreateTopicRequestDto,
+  createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.TopicsControllerCreateTopicResponse,
+      operations.TopicsControllerUpsertTopicResponse,
       | errors.ErrorDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
@@ -84,26 +84,26 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.TopicsControllerCreateTopicRequest = {
-    createTopicRequestDto: createTopicRequestDto,
+  const input: operations.TopicsControllerUpsertTopicRequest = {
+    createUpdateTopicRequestDto: createUpdateTopicRequestDto,
     idempotencyKey: idempotencyKey,
   };
 
   const parsed = safeParse(
     input,
     (value) =>
-      operations.TopicsControllerCreateTopicRequest$outboundSchema.parse(value),
+      operations.TopicsControllerUpsertTopicRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.CreateTopicRequestDto, {
+  const body = encodeJSON("body", payload.CreateUpdateTopicRequestDto, {
     explode: true,
   });
 
-  const path = pathToFunc("/v1/topics")();
+  const path = pathToFunc("/v2/topics")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -121,7 +121,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "TopicsController_createTopic",
+    operationID: "TopicsController_upsertTopic",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -189,7 +189,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.TopicsControllerCreateTopicResponse,
+    operations.TopicsControllerUpsertTopicResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -202,10 +202,11 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(201, operations.TopicsControllerCreateTopicResponse$inboundSchema, {
-      hdrs: true,
-      key: "Result",
-    }),
+    M.json(
+      [200, 201],
+      operations.TopicsControllerUpsertTopicResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
       [400, 401, 403, 404, 405, 409, 413, 415],