@novu/api 1.0.0 → 1.1.0

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"}

package/sdk/topics.d.ts

@@ -9,26 +9,41 @@ export declare class Topics extends ClientSDK {
     private _subscribers?;
     get subscribers(): NovuSubscribers;
     /**
-     * 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.
      */
     list(request: operations.TopicsControllerListTopicsRequest, options?: RequestOptions): Promise<operations.TopicsControllerListTopicsResponse>;
     /**
-     * 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
      */
     create(createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerUpsertTopicResponse>;
     /**
-     * Get topic by key
+     * Retrieve a topic
+     *
+     * @remarks
+     * Retrieve a topic by its unique key identifier **topicKey**
      */
     get(topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerGetTopicResponse>;
     /**
-     * Update topic by key
+     * Update a topic
+     *
+     * @remarks
+     * Update a topic name by its unique key identifier **topicKey**
      */
     update(updateTopicRequestDto: components.UpdateTopicRequestDto, topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerUpdateTopicResponse>;
     /**
-     * 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.
      */
     delete(topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerDeleteTopicResponse>;
 }

package/sdk/topics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../src/sdk/topics.ts"],"names":[],"mappings":"AASA,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,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,qBAAa,MAAO,SAAQ,SAAS;IACnC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED,OAAO,CAAC,YAAY,CAAC,CAAkB;IACvC,IAAI,WAAW,IAAI,eAAe,CAEjC;IAED;;OAEG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQzD;;;;;OAKG;IACG,MAAM,CACV,2BAA2B,EAAE,UAAU,CAAC,2BAA2B,EACnE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAS1D;;OAEG;IACG,GAAG,CACP,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IASvD;;OAEG;IACG,MAAM,CACV,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,EACvD,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAU1D;;OAEG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;CAQ3D"}
+{"version":3,"file":"topics.d.ts","sourceRoot":"","sources":["../src/sdk/topics.ts"],"names":[],"mappings":"AASA,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,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,qBAAa,MAAO,SAAQ,SAAS;IACnC,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED,OAAO,CAAC,YAAY,CAAC,CAAkB;IACvC,IAAI,WAAW,IAAI,eAAe,CAEjC;IAED;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQzD;;;;;OAKG;IACG,MAAM,CACV,2BAA2B,EAAE,UAAU,CAAC,2BAA2B,EACnE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAS1D;;;;;OAKG;IACG,GAAG,CACP,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IASvD;;;;;OAKG;IACG,MAAM,CACV,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,EACvD,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAU1D;;;;;;OAMG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;CAQ3D"}

package/sdk/topics.js

@@ -21,13 +21,18 @@ class Topics extends sdks_js_1.ClientSDK {
         return (this._subscribers ?? (this._subscribers = new novusubscribers_js_1.NovuSubscribers(this._options)));
     }
     /**
-     * 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, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsList_js_1.topicsList)(this, request, options));
     }
     /**
-     * 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
@@ -36,19 +41,29 @@ class Topics extends sdks_js_1.ClientSDK {
         return (0, fp_js_1.unwrapAsync)((0, topicsCreate_js_1.topicsCreate)(this, createUpdateTopicRequestDto, idempotencyKey, options));
     }
     /**
-     * Get topic by key
+     * Retrieve a topic
+     *
+     * @remarks
+     * Retrieve a topic by its unique key identifier **topicKey**
      */
     async get(topicKey, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsGet_js_1.topicsGet)(this, topicKey, idempotencyKey, options));
     }
     /**
-     * Update topic by key
+     * Update a topic
+     *
+     * @remarks
+     * Update a topic name by its unique key identifier **topicKey**
      */
     async update(updateTopicRequestDto, topicKey, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsUpdate_js_1.topicsUpdate)(this, updateTopicRequestDto, topicKey, idempotencyKey, options));
     }
     /**
-     * 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, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsDelete_js_1.topicsDelete)(this, topicKey, idempotencyKey, options));

package/sdk/topics.js.map

@@ -1 +1 @@
-{"version":3,"file":"topics.js","sourceRoot":"","sources":["../src/sdk/topics.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8DAAwD;AACxD,8DAAwD;AACxD,wDAAkD;AAClD,0DAAoD;AACpD,8DAAwD;AACxD,4CAA2D;AAG3D,0CAA6C;AAC7C,6DAAuD;AACvD,yDAAmD;AAEnD,MAAa,MAAO,SAAQ,mBAAS;IAEnC,IAAI,aAAa;QACf,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,gCAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpE,CAAC;IAGD,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,oCAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,OAAqD,EACrD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0BAAU,EAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,2BAA2B,EAC3B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CACP,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wBAAS,EAC1B,IAAI,EACJ,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,qBAAuD,EACvD,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA7FD,wBA6FC"}
+{"version":3,"file":"topics.js","sourceRoot":"","sources":["../src/sdk/topics.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8DAAwD;AACxD,8DAAwD;AACxD,wDAAkD;AAClD,0DAAoD;AACpD,8DAAwD;AACxD,4CAA2D;AAG3D,0CAA6C;AAC7C,6DAAuD;AACvD,yDAAmD;AAEnD,MAAa,MAAO,SAAQ,mBAAS;IAEnC,IAAI,aAAa;QACf,OAAO,CAAC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,IAAI,gCAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpE,CAAC;IAGD,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,oCAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAqD,EACrD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0BAAU,EAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,2BAA2B,EAC3B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wBAAS,EAC1B,IAAI,EACJ,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,qBAAuD,EACvD,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8BAAY,EAC7B,IAAI,EACJ,QAAQ,EACR,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA5GD,wBA4GC"}