@novu/api 1.0.0 → 1.1.0

package/sdk/integrations.d.ts

@@ -1,41 +1,52 @@
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
-import { Webhooks } from "./webhooks.js";
 export declare class Integrations extends ClientSDK {
-    private _webhooks?;
-    get webhooks(): Webhooks;
     /**
-     * Get integrations
+     * List all integrations
      *
      * @remarks
-     * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+     * List all the channels integrations created in the organization
      */
     list(idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.IntegrationsControllerListIntegrationsResponse>;
     /**
-     * Create integration
+     * Create an integration
      *
      * @remarks
-     * Create an integration for the current environment the user is based on the API key provided
+     * Create an integration for the current environment the user is based on the API key provided.
+     *     Each provider supports different credentials, check the provider documentation for more details.
      */
     create(createIntegrationRequestDto: components.CreateIntegrationRequestDto, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.IntegrationsControllerCreateIntegrationResponse>;
     /**
-     * Update integration
+     * Update an integration
+     *
+     * @remarks
+     * Update an integration by its unique key identifier **integrationId**.
+     *     Each provider supports different credentials, check the provider documentation for more details.
      */
     update(updateIntegrationRequestDto: components.UpdateIntegrationRequestDto, integrationId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.IntegrationsControllerUpdateIntegrationByIdResponse>;
     /**
-     * Delete integration
+     * Delete an integration
+     *
+     * @remarks
+     * Delete an integration by its unique key identifier **integrationId**.
+     *     This action is irreversible.
      */
     delete(integrationId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.IntegrationsControllerRemoveIntegrationResponse>;
     /**
-     * Set integration as primary
+     * Update integration as primary
+     *
+     * @remarks
+     * Update an integration as **primary** by its unique key identifier **integrationId**.
+     *     This API will set the integration as primary for that channel in the current environment.
+     *     Primary integration is used to deliver notification for sms and email channels in the workflow.
      */
     setAsPrimary(integrationId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.IntegrationsControllerSetIntegrationAsPrimaryResponse>;
     /**
-     * Get active integrations
+     * List active integrations
      *
      * @remarks
-     * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+     * List all the active integrations created in the organization
      */
     listActive(idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.IntegrationsControllerGetActiveIntegrationsResponse>;
 }

package/sdk/integrations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"integrations.d.ts","sourceRoot":"","sources":["../src/sdk/integrations.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,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,qBAAa,YAAa,SAAQ,SAAS;IACzC,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;;;;OAKG;IACG,IAAI,CACR,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;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,+CAA+C,CAAC;IAStE;;OAEG;IACG,MAAM,CACV,2BAA2B,EAAE,UAAU,CAAC,2BAA2B,EACnE,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mDAAmD,CAAC;IAU1E;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;IAStE;;OAEG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qDAAqD,CAAC;IAS5E;;;;;OAKG;IACG,UAAU,CACd,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mDAAmD,CAAC;CAO3E"}
+{"version":3,"file":"integrations.d.ts","sourceRoot":"","sources":["../src/sdk/integrations.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;AAG5D,qBAAa,YAAa,SAAQ,SAAS;IACzC;;;;;OAKG;IACG,IAAI,CACR,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;IAQrE;;;;;;OAMG;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,+CAA+C,CAAC;IAStE;;;;;;OAMG;IACG,MAAM,CACV,2BAA2B,EAAE,UAAU,CAAC,2BAA2B,EACnE,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mDAAmD,CAAC;IAU1E;;;;;;OAMG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+CAA+C,CAAC;IAStE;;;;;;;OAOG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qDAAqD,CAAC;IAS5E;;;;;OAKG;IACG,UAAU,CACd,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mDAAmD,CAAC;CAO3E"}

package/sdk/integrations.js

@@ -12,52 +12,62 @@ const integrationsSetAsPrimary_js_1 = require("../funcs/integrationsSetAsPrimary
 const integrationsUpdate_js_1 = require("../funcs/integrationsUpdate.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
-const webhooks_js_1 = require("./webhooks.js");
 class Integrations extends sdks_js_1.ClientSDK {
-    get webhooks() {
-        return (this._webhooks ?? (this._webhooks = new webhooks_js_1.Webhooks(this._options)));
-    }
     /**
-     * Get integrations
+     * List all integrations
      *
      * @remarks
-     * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+     * List all the channels integrations created in the organization
      */
     async list(idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, integrationsList_js_1.integrationsList)(this, idempotencyKey, options));
     }
     /**
-     * Create integration
+     * Create an integration
      *
      * @remarks
-     * Create an integration for the current environment the user is based on the API key provided
+     * Create an integration for the current environment the user is based on the API key provided.
+     *     Each provider supports different credentials, check the provider documentation for more details.
      */
     async create(createIntegrationRequestDto, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, integrationsCreate_js_1.integrationsCreate)(this, createIntegrationRequestDto, idempotencyKey, options));
     }
     /**
-     * Update integration
+     * Update an integration
+     *
+     * @remarks
+     * Update an integration by its unique key identifier **integrationId**.
+     *     Each provider supports different credentials, check the provider documentation for more details.
      */
     async update(updateIntegrationRequestDto, integrationId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, integrationsUpdate_js_1.integrationsUpdate)(this, updateIntegrationRequestDto, integrationId, idempotencyKey, options));
     }
     /**
-     * Delete integration
+     * Delete an integration
+     *
+     * @remarks
+     * Delete an integration by its unique key identifier **integrationId**.
+     *     This action is irreversible.
      */
     async delete(integrationId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, integrationsDelete_js_1.integrationsDelete)(this, integrationId, idempotencyKey, options));
     }
     /**
-     * Set integration as primary
+     * Update integration as primary
+     *
+     * @remarks
+     * Update an integration as **primary** by its unique key identifier **integrationId**.
+     *     This API will set the integration as primary for that channel in the current environment.
+     *     Primary integration is used to deliver notification for sms and email channels in the workflow.
      */
     async setAsPrimary(integrationId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, integrationsSetAsPrimary_js_1.integrationsSetAsPrimary)(this, integrationId, idempotencyKey, options));
     }
     /**
-     * Get active integrations
+     * List active integrations
      *
      * @remarks
-     * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+     * List all the active integrations created in the organization
      */
     async listActive(idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, integrationsListActive_js_1.integrationsListActive)(this, idempotencyKey, options));

package/sdk/integrations.js.map

@@ -1 +1 @@
-{"version":3,"file":"integrations.js","sourceRoot":"","sources":["../src/sdk/integrations.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0EAAoE;AACpE,0EAAoE;AACpE,sEAAgE;AAChE,kFAA4E;AAC5E,sFAAgF;AAChF,0EAAoE;AACpE,4CAA2D;AAG3D,0CAA6C;AAC7C,+CAAyC;AAEzC,MAAa,YAAa,SAAQ,mBAAS;IAEzC,IAAI,QAAQ;QACV,OAAO,CAAC,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,IAAI,sBAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,2BAA2B,EAC3B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,2BAAmE,EACnE,aAAqB,EACrB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,2BAA2B,EAC3B,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,aAAqB,EACrB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kDAAsB,EACvC,IAAI,EACJ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA5GD,oCA4GC"}
+{"version":3,"file":"integrations.js","sourceRoot":"","sources":["../src/sdk/integrations.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0EAAoE;AACpE,0EAAoE;AACpE,sEAAgE;AAChE,kFAA4E;AAC5E,sFAAgF;AAChF,0EAAoE;AACpE,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,YAAa,SAAQ,mBAAS;IACzC;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,2BAAmE,EACnE,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,2BAA2B,EAC3B,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,2BAAmE,EACnE,aAAqB,EACrB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,2BAA2B,EAC3B,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAChB,aAAqB,EACrB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kDAAsB,EACvC,IAAI,EACJ,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AArHD,oCAqHC"}

package/sdk/messages.d.ts

@@ -2,24 +2,28 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 export declare class Messages extends ClientSDK {
     /**
-     * Get messages
+     * List all messages
      *
      * @remarks
-     * Returns a list of messages, could paginate using the `page` query parameter
+     * List all messages for the current environment.
+     *     This API supports filtering by **channel**, **subscriberId**, and **transactionId**.
+     *     This API returns a paginated list of messages.
      */
     retrieve(request: operations.MessagesControllerGetMessagesRequest, options?: RequestOptions): Promise<operations.MessagesControllerGetMessagesResponse>;
     /**
-     * Delete message
+     * Delete a message
      *
      * @remarks
-     * Deletes a message entity from the Novu platform
+     * Delete a message entity from the Novu platform by **messageId**.
+     *     This action is irreversible. **messageId** is required and of mongodbId type.
      */
     delete(messageId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.MessagesControllerDeleteMessageResponse>;
     /**
      * Delete messages by transactionId
      *
      * @remarks
-     * Deletes messages entity from the Novu platform using TransactionId of message
+     * Delete multiple messages from the Novu platform using **transactionId** of triggered event.
+     *     This API supports filtering by **channel** and delete all messages associated with the **transactionId**.
      */
     deleteByTransactionId(transactionId: string, channel?: operations.Channel | undefined, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.MessagesControllerDeleteMessagesByTransactionIdResponse | undefined>;
 }

package/sdk/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/sdk/messages.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,QAAS,SAAQ,SAAS;IACrC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;OAKG;IACG,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uCAAuC,CAAC;IAS9D;;;;;OAKG;IACG,qBAAqB,CACzB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,SAAS,EACxC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACN,UAAU,CAAC,uDAAuD,GAClE,SAAS,CACZ;CASF"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/sdk/messages.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,QAAS,SAAQ,SAAS;IACrC;;;;;;;OAOG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;;OAMG;IACG,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uCAAuC,CAAC;IAS9D;;;;;;OAMG;IACG,qBAAqB,CACzB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,SAAS,EACxC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACN,UAAU,CAAC,uDAAuD,GAClE,SAAS,CACZ;CASF"}

package/sdk/messages.js

@@ -11,19 +11,22 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class Messages extends sdks_js_1.ClientSDK {
     /**
-     * Get messages
+     * List all messages
      *
      * @remarks
-     * Returns a list of messages, could paginate using the `page` query parameter
+     * List all messages for the current environment.
+     *     This API supports filtering by **channel**, **subscriberId**, and **transactionId**.
+     *     This API returns a paginated list of messages.
      */
     async retrieve(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, messagesRetrieve_js_1.messagesRetrieve)(this, request, options));
     }
     /**
-     * Delete message
+     * Delete a message
      *
      * @remarks
-     * Deletes a message entity from the Novu platform
+     * Delete a message entity from the Novu platform by **messageId**.
+     *     This action is irreversible. **messageId** is required and of mongodbId type.
      */
     async delete(messageId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, messagesDelete_js_1.messagesDelete)(this, messageId, idempotencyKey, options));
@@ -32,7 +35,8 @@ class Messages extends sdks_js_1.ClientSDK {
      * Delete messages by transactionId
      *
      * @remarks
-     * Deletes messages entity from the Novu platform using TransactionId of message
+     * Delete multiple messages from the Novu platform using **transactionId** of triggered event.
+     *     This API supports filtering by **channel** and delete all messages associated with the **transactionId**.
      */
     async deleteByTransactionId(transactionId, channel, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, messagesDeleteByTransactionId_js_1.messagesDeleteByTransactionId)(this, transactionId, channel, idempotencyKey, options));

package/sdk/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/sdk/messages.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,kEAA4D;AAC5D,gGAA0F;AAC1F,sEAAgE;AAChE,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,QAAS,SAAQ,mBAAS;IACrC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kCAAc,EAC/B,IAAI,EACJ,SAAS,EACT,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,aAAqB,EACrB,OAAwC,EACxC,cAAmC,EACnC,OAAwB;QAKxB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA6B,EAC9C,IAAI,EACJ,aAAa,EACb,OAAO,EACP,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA5DD,4BA4DC"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/sdk/messages.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,kEAA4D;AAC5D,gGAA0F;AAC1F,sEAAgE;AAChE,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,QAAS,SAAQ,mBAAS;IACrC;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kCAAc,EAC/B,IAAI,EACJ,SAAS,EACT,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,aAAqB,EACrB,OAAwC,EACxC,cAAmC,EACnC,OAAwB;QAKxB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA6B,EAC9C,IAAI,EACJ,aAAa,EACb,OAAO,EACP,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAhED,4BAgEC"}

package/sdk/notifications.d.ts

@@ -1,15 +1,23 @@
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
-import { Stats } from "./stats.js";
 export declare class Notifications extends ClientSDK {
-    private _stats?;
-    get stats(): Stats;
     /**
-     * Get notifications
+     * List all events
+     *
+     * @remarks
+     * List all notification events (triggered events) for the current environment.
+     *     This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**.
+     *     Checkout all available filters in the query section.
+     *     This API returns event triggers, to list each channel notifications, check messages APIs.
      */
     list(request: operations.NotificationsControllerListNotificationsRequest, options?: RequestOptions): Promise<operations.NotificationsControllerListNotificationsResponse>;
     /**
-     * Get notification
+     * Retrieve an event
+     *
+     * @remarks
+     * Retrieve an event by its unique key identifier **notificationId**.
+     *     Here **notificationId** is of mongodbId type.
+     *     This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
      */
     retrieve(notificationId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.NotificationsControllerGetNotificationResponse>;
 }

package/sdk/notifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/sdk/notifications.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED;;OAEG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,+CAA+C,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAQvE;;OAEG;IACG,QAAQ,CACZ,cAAc,EAAE,MAAM,EACtB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;CAQtE"}
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/sdk/notifications.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;;;OAQG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,+CAA+C,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gDAAgD,CAAC;IAQvE;;;;;;;OAOG;IACG,QAAQ,CACZ,cAAc,EAAE,MAAM,EACtB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8CAA8C,CAAC;CAQtE"}

package/sdk/notifications.js

@@ -8,19 +8,26 @@ const notificationsList_js_1 = require("../funcs/notificationsList.js");
 const notificationsRetrieve_js_1 = require("../funcs/notificationsRetrieve.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
-const stats_js_1 = require("./stats.js");
 class Notifications extends sdks_js_1.ClientSDK {
-    get stats() {
-        return (this._stats ?? (this._stats = new stats_js_1.Stats(this._options)));
-    }
     /**
-     * Get notifications
+     * List all events
+     *
+     * @remarks
+     * List all notification events (triggered events) for the current environment.
+     *     This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**.
+     *     Checkout all available filters in the query section.
+     *     This API returns event triggers, to list each channel notifications, check messages APIs.
      */
     async list(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, notificationsList_js_1.notificationsList)(this, request, options));
     }
     /**
-     * Get notification
+     * Retrieve an event
+     *
+     * @remarks
+     * Retrieve an event by its unique key identifier **notificationId**.
+     *     Here **notificationId** is of mongodbId type.
+     *     This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
      */
     async retrieve(notificationId, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, notificationsRetrieve_js_1.notificationsRetrieve)(this, notificationId, idempotencyKey, options));

package/sdk/notifications.js.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../src/sdk/notifications.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wEAAkE;AAClE,gFAA0E;AAC1E,4CAA2D;AAE3D,0CAA6C;AAC7C,yCAAmC;AAEnC,MAAa,aAAc,SAAQ,mBAAS;IAE1C,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,gBAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,OAAmE,EACnE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,cAAsB,EACtB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,cAAc,EACd,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAnCD,sCAmCC"}
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../src/sdk/notifications.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,wEAAkE;AAClE,gFAA0E;AAC1E,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CACR,OAAmE,EACnE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,cAAsB,EACtB,cAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,cAAc,EACd,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAzCD,sCAyCC"}

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));