@novu/api 1.0.0 → 1.2.0

package/sdk/novumessages.d.ts

@@ -3,15 +3,26 @@ import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 export declare 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**
      */
     updateAsSeen(request: operations.SubscribersV1ControllerMarkActionAsSeenRequest, options?: RequestOptions): Promise<operations.SubscribersV1ControllerMarkActionAsSeenResponse>;
     /**
-     * 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**.
      */
     markAll(markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersV1ControllerMarkAllUnreadAsReadResponse>;
     /**
-     * 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
      */
     markAllAs(messageMarkAsRequestDto: components.MessageMarkAsRequestDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersV1ControllerMarkMessagesAsResponse>;
 }

package/sdk/novumessages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"novumessages.d.ts","sourceRoot":"","sources":["../src/sdk/novumessages.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,YAAa,SAAQ,SAAS;IACzC;;OAEG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,8CAA8C,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;IAQtE;;OAEG;IACG,OAAO,CACX,0BAA0B,EAAE,UAAU,CAAC,0BAA0B,EACjE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kDAAkD,CAAC;IAUzE;;OAEG;IACG,SAAS,CACb,uBAAuB,EAAE,UAAU,CAAC,uBAAuB,EAC3D,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;CASrE"}
+{"version":3,"file":"novumessages.d.ts","sourceRoot":"","sources":["../src/sdk/novumessages.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,YAAa,SAAQ,SAAS;IACzC;;;;;;OAMG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,8CAA8C,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;IAQtE;;;;;OAKG;IACG,OAAO,CACX,0BAA0B,EAAE,UAAU,CAAC,0BAA0B,EACjE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kDAAkD,CAAC;IAUzE;;;;;;OAMG;IACG,SAAS,CACb,uBAAuB,EAAE,UAAU,CAAC,uBAAuB,EAC3D,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;CASrE"}

package/sdk/novumessages.js

@@ -11,19 +11,30 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class NovuMessages extends sdks_js_1.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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersMessagesUpdateAsSeen_js_1.subscribersMessagesUpdateAsSeen)(this, request, options));
     }
     /**
-     * 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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersMessagesMarkAll_js_1.subscribersMessagesMarkAll)(this, markAllMessageAsRequestDto, subscriberId, idempotencyKey, options));
     }
     /**
-     * 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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersMessagesMarkAllAs_js_1.subscribersMessagesMarkAllAs)(this, messageMarkAsRequestDto, subscriberId, idempotencyKey, options));

package/sdk/novumessages.js.map

@@ -1 +1 @@
-{"version":3,"file":"novumessages.js","sourceRoot":"","sources":["../src/sdk/novumessages.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,8FAAwF;AACxF,oGAA8F;AAC9F,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,YAAa,SAAQ,mBAAS;IACzC;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,OAAkE,EAClE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CACX,0BAAiE,EACjE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,0BAA0B,EAC1B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,uBAA2D,EAC3D,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,uBAAuB,EACvB,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAlDD,oCAkDC"}
+{"version":3,"file":"novumessages.js","sourceRoot":"","sources":["../src/sdk/novumessages.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,8FAAwF;AACxF,oGAA8F;AAC9F,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,YAAa,SAAQ,mBAAS;IACzC;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,OAAkE,EAClE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,0BAAiE,EACjE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,0BAA0B,EAC1B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACb,uBAA2D,EAC3D,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,uBAAuB,EACvB,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,oCA6DC"}

package/sdk/novunotifications.d.ts

@@ -2,11 +2,17 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 export declare 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**.
      */
     feed(request: operations.SubscribersV1ControllerGetNotificationsFeedRequest, options?: RequestOptions): Promise<operations.SubscribersV1ControllerGetNotificationsFeedResponse>;
     /**
-     * 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**.
      */
     unseenCount(request: operations.SubscribersV1ControllerGetUnseenCountRequest, options?: RequestOptions): Promise<operations.SubscribersV1ControllerGetUnseenCountResponse>;
 }

package/sdk/novunotifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"novunotifications.d.ts","sourceRoot":"","sources":["../src/sdk/novunotifications.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;OAEG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,kDAAkD,EACtE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mDAAmD,CAAC;IAQ1E;;OAEG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;CAOrE"}
+{"version":3,"file":"novunotifications.d.ts","sourceRoot":"","sources":["../src/sdk/novunotifications.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;;;;OAKG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,kDAAkD,EACtE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mDAAmD,CAAC;IAQ1E;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;CAOrE"}

package/sdk/novunotifications.js

@@ -10,13 +10,19 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class NovuNotifications extends sdks_js_1.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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsFeed_js_1.subscribersNotificationsFeed)(this, request, options));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsUnseenCount_js_1.subscribersNotificationsUnseenCount)(this, request, options));

package/sdk/novunotifications.js.map

@@ -1 +1 @@
-{"version":3,"file":"novunotifications.js","sourceRoot":"","sources":["../src/sdk/novunotifications.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8FAAwF;AACxF,4GAAsG;AACtG,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,iBAAkB,SAAQ,mBAAS;IAC9C;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,OAAsE,EACtE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,OAAgE,EAChE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4EAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,8CA4BC"}
+{"version":3,"file":"novunotifications.js","sourceRoot":"","sources":["../src/sdk/novunotifications.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8FAAwF;AACxF,4GAAsG;AACtG,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,iBAAkB,SAAQ,mBAAS;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,OAAsE,EACtE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAgE,EAChE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4EAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAlCD,8CAkCC"}

package/sdk/novutopics.d.ts

@@ -2,10 +2,11 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 export declare 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.
      */
     list(request: operations.SubscribersControllerListSubscriberTopicsRequest, options?: RequestOptions): Promise<operations.SubscribersControllerListSubscriberTopicsResponse>;
 }

package/sdk/novutopics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"novutopics.d.ts","sourceRoot":"","sources":["../src/sdk/novutopics.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;OAKG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,gDAAgD,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iDAAiD,CAAC;CAOzE"}
+{"version":3,"file":"novutopics.d.ts","sourceRoot":"","sources":["../src/sdk/novutopics.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;;OAMG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,gDAAgD,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iDAAiD,CAAC;CAOzE"}

package/sdk/novutopics.js

@@ -9,10 +9,11 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class NovuTopics extends sdks_js_1.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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersTopicsList_js_1.subscribersTopicsList)(this, request, options));

package/sdk/novutopics.js.map

@@ -1 +1 @@
-{"version":3,"file":"novutopics.js","sourceRoot":"","sources":["../src/sdk/novutopics.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gFAA0E;AAC1E,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,UAAW,SAAQ,mBAAS;IACvC;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,OAAoE,EACpE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAjBD,gCAiBC"}
+{"version":3,"file":"novutopics.js","sourceRoot":"","sources":["../src/sdk/novutopics.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gFAA0E;AAC1E,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,UAAW,SAAQ,mBAAS;IACvC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,OAAoE,EACpE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAlBD,gCAkBC"}

package/sdk/preferences.d.ts

@@ -3,17 +3,20 @@ import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 export declare 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.
      */
     list(subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse>;
     /**
-     * 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
      */
     update(patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerUpdateSubscriberPreferencesResponse>;
 }

package/sdk/preferences.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;OAKG;IACG,IAAI,CACR,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qDAAqD,CAAC;IAS5E;;;;;OAKG;IACG,MAAM,CACV,6BAA6B,EAAE,UAAU,CAAC,6BAA6B,EACvE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;CASF"}
+{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;;OAMG;IACG,IAAI,CACR,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qDAAqD,CAAC;IAS5E;;;;;;;OAOG;IACG,MAAM,CACV,6BAA6B,EAAE,UAAU,CAAC,6BAA6B,EACvE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;CASF"}

package/sdk/preferences.js

@@ -10,19 +10,22 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class Preferences extends sdks_js_1.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, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersPreferencesList_js_1.subscribersPreferencesList)(this, subscriberId, idempotencyKey, options));
     }
     /**
-     * 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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersPreferencesUpdate_js_1.subscribersPreferencesUpdate)(this, patchSubscriberPreferencesDto, subscriberId, idempotencyKey, options));

package/sdk/preferences.js.map

@@ -1 +1 @@
-{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,8FAAwF;AACxF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IACxC;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,6BAAuE,EACvE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,6BAA6B,EAC7B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA1CD,kCA0CC"}
+{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../src/sdk/preferences.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,8FAAwF;AACxF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IACxC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,6BAAuE,EACvE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,6BAA6B,EAC7B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA7CD,kCA6CC"}

package/sdk/properties.d.ts

@@ -6,7 +6,7 @@ export declare 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**
      */
     updateOnlineFlag(updateSubscriberOnlineFlagRequestDto: components.UpdateSubscriberOnlineFlagRequestDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersV1ControllerUpdateSubscriberOnlineFlagResponse>;
 }

package/sdk/properties.js

@@ -12,7 +12,7 @@ class Properties extends sdks_js_1.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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersPropertiesUpdateOnlineFlag_js_1.subscribersPropertiesUpdateOnlineFlag)(this, updateSubscriberOnlineFlagRequestDto, subscriberId, idempotencyKey, options));

package/sdk/subscribers.d.ts

@@ -1,8 +1,6 @@
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
-import { PageIterator } from "../types/operations.js";
-import { Authentication } from "./authentication.js";
 import { Credentials } from "./credentials.js";
 import { NovuMessages } from "./novumessages.js";
 import { NovuNotifications } from "./novunotifications.js";
@@ -16,8 +14,6 @@ export declare class Subscribers extends ClientSDK {
     get topics(): NovuTopics;
     private _credentials?;
     get credentials(): Credentials;
-    private _authentication?;
-    get authentication(): Authentication;
     private _messages?;
     get messages(): NovuMessages;
     private _notifications?;
@@ -25,60 +21,50 @@ export declare class Subscribers extends ClientSDK {
     private _properties?;
     get properties(): Properties;
     /**
-     * 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.
      */
     search(request: operations.SubscribersControllerSearchSubscribersRequest, options?: RequestOptions): Promise<operations.SubscribersControllerSearchSubscribersResponse>;
     /**
-     * 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
      */
     create(createSubscriberRequestDto: components.CreateSubscriberRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerCreateSubscriberResponse>;
     /**
-     * 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.
      */
     retrieve(subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerGetSubscriberResponse>;
     /**
-     * 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
      */
     patch(patchSubscriberRequestDto: components.PatchSubscriberRequestDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerPatchSubscriberResponse>;
     /**
      * 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
      */
     delete(subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerRemoveSubscriberResponse>;
-    /**
-     * Get subscribers
-     *
-     * @remarks
-     * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
-     */
-    list(page?: number | undefined, limit?: number | undefined, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<PageIterator<operations.SubscribersV1ControllerListSubscribersResponse, {
-        page: number;
-    }>>;
-    /**
-     * Upsert subscriber
-     *
-     * @remarks
-     * Used to upsert the subscriber entity with new information
-     */
-    upsert(updateSubscriberRequestDto: components.UpdateSubscriberRequestDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersV1ControllerUpdateSubscriberResponse>;
     /**
      * 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.
      */
     createBulk(bulkSubscriberCreateDto: components.BulkSubscriberCreateDto, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersV1ControllerBulkCreateSubscribersResponse>;
 }

package/sdk/subscribers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../src/sdk/subscribers.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,qBAAa,WAAY,SAAQ,SAAS;IACxC,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,IAAI,MAAM,IAAI,UAAU,CAEvB;IAED,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,IAAI,cAAc,IAAI,cAAc,CAEnC;IAED,OAAO,CAAC,SAAS,CAAC,CAAe;IACjC,IAAI,QAAQ,IAAI,YAAY,CAE3B;IAED,OAAO,CAAC,cAAc,CAAC,CAAoB;IAC3C,IAAI,aAAa,IAAI,iBAAiB,CAErC;IAED,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;OAEG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;OAKG;IACG,MAAM,CACV,0BAA0B,EAAE,UAAU,CAAC,0BAA0B,EACjE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IASpE;;;;;OAKG;IACG,QAAQ,CACZ,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;IASjE;;;;;OAKG;IACG,KAAK,CACT,yBAAyB,EAAE,UAAU,CAAC,yBAAyB,EAC/D,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4CAA4C,CAAC;IAUnE;;;;;OAKG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IASpE;;;;;OAKG;IACG,IAAI,CACR,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,EACzB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,EAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,8CAA8C,EACzD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAUD;;;;;OAKG;IACG,MAAM,CACV,0BAA0B,EAAE,UAAU,CAAC,0BAA0B,EACjE,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;IAUtE;;;;;;;OAOG;IACG,UAAU,CACd,uBAAuB,EAAE,UAAU,CAAC,uBAAuB,EAC3D,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oDAAoD,CAAC;CAQ5E"}
+{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../src/sdk/subscribers.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,qBAAa,WAAY,SAAQ,SAAS;IACxC,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,IAAI,MAAM,IAAI,UAAU,CAEvB;IAED,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,SAAS,CAAC,CAAe;IACjC,IAAI,QAAQ,IAAI,YAAY,CAE3B;IAED,OAAO,CAAC,cAAc,CAAC,CAAoB;IAC3C,IAAI,aAAa,IAAI,iBAAiB,CAErC;IAED,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;;;;;OAMG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;;OAMG;IACG,MAAM,CACV,0BAA0B,EAAE,UAAU,CAAC,0BAA0B,EACjE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IASpE;;;;;;OAMG;IACG,QAAQ,CACZ,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;IASjE;;;;;;OAMG;IACG,KAAK,CACT,yBAAyB,EAAE,UAAU,CAAC,yBAAyB,EAC/D,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4CAA4C,CAAC;IAUnE;;;;;OAKG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IASpE;;;;;;OAMG;IACG,UAAU,CACd,uBAAuB,EAAE,UAAU,CAAC,uBAAuB,EAC3D,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oDAAoD,CAAC;CAQ5E"}

package/sdk/subscribers.js

@@ -7,15 +7,11 @@ exports.Subscribers = void 0;
 const subscribersCreate_js_1 = require("../funcs/subscribersCreate.js");
 const subscribersCreateBulk_js_1 = require("../funcs/subscribersCreateBulk.js");
 const subscribersDelete_js_1 = require("../funcs/subscribersDelete.js");
-const subscribersList_js_1 = require("../funcs/subscribersList.js");
 const subscribersPatch_js_1 = require("../funcs/subscribersPatch.js");
 const subscribersRetrieve_js_1 = require("../funcs/subscribersRetrieve.js");
 const subscribersSearch_js_1 = require("../funcs/subscribersSearch.js");
-const subscribersUpsert_js_1 = require("../funcs/subscribersUpsert.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
-const operations_js_1 = require("../types/operations.js");
-const authentication_js_1 = require("./authentication.js");
 const credentials_js_1 = require("./credentials.js");
 const novumessages_js_1 = require("./novumessages.js");
 const novunotifications_js_1 = require("./novunotifications.js");
@@ -32,9 +28,6 @@ class Subscribers extends sdks_js_1.ClientSDK {
     get credentials() {
         return (this._credentials ?? (this._credentials = new credentials_js_1.Credentials(this._options)));
     }
-    get authentication() {
-        return (this._authentication ?? (this._authentication = new authentication_js_1.Authentication(this._options)));
-    }
     get messages() {
         return (this._messages ?? (this._messages = new novumessages_js_1.NovuMessages(this._options)));
     }
@@ -45,34 +38,41 @@ class Subscribers extends sdks_js_1.ClientSDK {
         return (this._properties ?? (this._properties = new properties_js_1.Properties(this._options)));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersSearch_js_1.subscribersSearch)(this, request, options));
     }
     /**
-     * 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, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersCreate_js_1.subscribersCreate)(this, createSubscriberRequestDto, idempotencyKey, options));
     }
     /**
-     * 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, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersRetrieve_js_1.subscribersRetrieve)(this, subscriberId, idempotencyKey, options));
     }
     /**
-     * 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, subscriberId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersPatch_js_1.subscribersPatch)(this, patchSubscriberRequestDto, subscriberId, idempotencyKey, options));
@@ -81,36 +81,17 @@ class Subscribers extends sdks_js_1.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, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersDelete_js_1.subscribersDelete)(this, subscriberId, idempotencyKey, options));
     }
-    /**
-     * Get subscribers
-     *
-     * @remarks
-     * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
-     */
-    async list(page, limit, idempotencyKey, options) {
-        return (0, operations_js_1.unwrapResultIterator)((0, subscribersList_js_1.subscribersList)(this, page, limit, idempotencyKey, options));
-    }
-    /**
-     * Upsert subscriber
-     *
-     * @remarks
-     * Used to upsert the subscriber entity with new information
-     */
-    async upsert(updateSubscriberRequestDto, subscriberId, idempotencyKey, options) {
-        return (0, fp_js_1.unwrapAsync)((0, subscribersUpsert_js_1.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, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, subscribersCreateBulk_js_1.subscribersCreateBulk)(this, bulkSubscriberCreateDto, idempotencyKey, options));

package/sdk/subscribers.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscribers.js","sourceRoot":"","sources":["../src/sdk/subscribers.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wEAAkE;AAClE,gFAA0E;AAC1E,wEAAkE;AAClE,oEAA8D;AAC9D,sEAAgE;AAChE,4EAAsE;AACtE,wEAAkE;AAClE,wEAAkE;AAClE,4CAA2D;AAG3D,0CAA6C;AAC7C,0DAA4E;AAC5E,2DAAqD;AACrD,qDAA+C;AAC/C,uDAAiD;AACjD,iEAA2D;AAC3D,mDAA6C;AAC7C,qDAA+C;AAC/C,mDAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IAExC,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,4BAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChE,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,0BAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC1D,CAAC;IAGD,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,4BAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChE,CAAC;IAGD,IAAI,cAAc;QAChB,OAAO,CAAC,IAAI,CAAC,eAAe,KAApB,IAAI,CAAC,eAAe,GAAK,IAAI,kCAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtE,CAAC;IAGD,IAAI,QAAQ;QACV,OAAO,CAAC,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,IAAI,8BAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAGD,IAAI,aAAa;QACf,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,wCAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxE,CAAC;IAGD,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,WAAW,KAAhB,IAAI,CAAC,WAAW,GAAK,IAAI,0BAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,0BAAiE,EACjE,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,0BAA0B,EAC1B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,yBAA+D,EAC/D,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,yBAAyB,EACzB,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,IAAyB,EACzB,KAA0B,EAC1B,cAAmC,EACnC,OAAwB;QAOxB,OAAO,IAAA,oCAAoB,EAAC,IAAA,oCAAe,EACzC,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,0BAAiE,EACjE,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,0BAA0B,EAC1B,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CACd,uBAA2D,EAC3D,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,uBAAuB,EACvB,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAnMD,kCAmMC"}
+{"version":3,"file":"subscribers.js","sourceRoot":"","sources":["../src/sdk/subscribers.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wEAAkE;AAClE,gFAA0E;AAC1E,wEAAkE;AAClE,sEAAgE;AAChE,4EAAsE;AACtE,wEAAkE;AAClE,4CAA2D;AAG3D,0CAA6C;AAC7C,qDAA+C;AAC/C,uDAAiD;AACjD,iEAA2D;AAC3D,mDAA6C;AAC7C,qDAA+C;AAC/C,mDAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IAExC,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,4BAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChE,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,0BAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC1D,CAAC;IAGD,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,4BAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChE,CAAC;IAGD,IAAI,QAAQ;QACV,OAAO,CAAC,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,IAAI,8BAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAGD,IAAI,aAAa;QACf,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,wCAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxE,CAAC;IAGD,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,WAAW,KAAhB,IAAI,CAAC,WAAW,GAAK,IAAI,0BAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,0BAAiE,EACjE,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,0BAA0B,EAC1B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CACZ,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CACT,yBAA+D,EAC/D,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,yBAAyB,EACzB,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,uBAA2D,EAC3D,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,uBAAuB,EACvB,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AArJD,kCAqJC"}

package/sdk/subscriptions.d.ts

@@ -4,14 +4,25 @@ import * as operations from "../models/operations/index.js";
 export declare 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.
      */
     list(request: operations.TopicsControllerListTopicSubscriptionsRequest, options?: RequestOptions): Promise<operations.TopicsControllerListTopicSubscriptionsResponse>;
     /**
-     * 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.
      */
     create(createTopicSubscriptionsRequestDto: components.CreateTopicSubscriptionsRequestDto, topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerCreateTopicSubscriptionsResponse>;
     /**
      * Delete topic subscriptions
+     *
+     * @remarks
+     * Delete subscriptions for subscriberIds for a topic.
      */
     delete(deleteTopicSubscriptionsRequestDto: components.DeleteTopicSubscriptionsRequestDto, topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerDeleteTopicSubscriptionsResponse>;
 }

package/sdk/subscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;OAEG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;OAEG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAUvE;;OAEG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;CASxE"}
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;OAMG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;;OAMG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAUvE;;;;;OAKG;IACG,MAAM,CACV,kCAAkC,EAChC,UAAU,CAAC,kCAAkC,EAC/C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;CASxE"}

package/sdk/subscriptions.js

@@ -12,18 +12,29 @@ const fp_js_1 = require("../types/fp.js");
 class Subscriptions extends sdks_js_1.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, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsList_js_1.topicsSubscriptionsList)(this, request, options));
     }
     /**
-     * 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, topicKey, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsCreate_js_1.topicsSubscriptionsCreate)(this, createTopicSubscriptionsRequestDto, topicKey, idempotencyKey, options));
     }
     /**
      * Delete topic subscriptions
+     *
+     * @remarks
+     * Delete subscriptions for subscriberIds for a topic.
      */
     async delete(deleteTopicSubscriptionsRequestDto, topicKey, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsDelete_js_1.topicsSubscriptionsDelete)(this, deleteTopicSubscriptionsRequestDto, topicKey, idempotencyKey, options));

package/sdk/subscriptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wFAAkF;AAClF,wFAAkF;AAClF,oFAA8E;AAC9E,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AApDD,sCAoDC"}
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/sdk/subscriptions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wFAAkF;AAClF,wFAAkF;AAClF,oFAA8E;AAC9E,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,OAAiE,EACjE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,kCAC+C,EAC/C,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,kCAAkC,EAClC,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA/DD,sCA+DC"}