@novu/api 1.0.0 → 1.2.0

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