@selfcommunity/api-services 0.1.27 → 0.1.28-alpha.0

package/lib/cjs/services/loyalty/index.js

@@ -87,6 +87,31 @@ class LoyaltyApiClient {
 }
 exports.LoyaltyApiClient = LoyaltyApiClient;
 class LoyaltyService {
+    /**
+     *  :::tipLoyalty service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {LoyaltyService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllEmbeds` will return the paginated list of available prizes.
+     *
+     *     async getPrizes() {
+     *       return await LoyaltyService.getPrizes();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async getSpecificPrize(prizeId) {
+     *       return await LoyaltyService.getSpecificPrize(prizeId);
+     *     }
+     *  ```
+     *  :::
+     */
     static getPrizes() {
         return __awaiter(this, void 0, void 0, function* () {
             return LoyaltyApiClient.getPrizes();

package/lib/cjs/services/loyalty/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAelD;;GAEG;AAEH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAwB;QACzC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAU;QAChC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC7F,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,IAAwB;QACrD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,IAAyB;QACrD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,mBAAmB;QACxB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,KAAa;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAU;QACvC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU,EAAE,MAA8B;QACjE,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACjH,CAAC;CACF;AA1ED,4CA0EC;AAED,MAAqB,cAAc;IACjC,MAAM,CAAO,SAAS;;YACpB,OAAO,gBAAgB,CAAC,SAAS,EAAE,CAAC;QACtC,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAwB;;YAC/C,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU;;YACtC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,IAAwB;;YAC3D,OAAO,gBAAgB,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,IAAyB;;YAC3D,OAAO,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,mBAAmB;;YAC9B,OAAO,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAChD,CAAC;KAAA;IAED,MAAM,CAAO,kBAAkB,CAAC,KAAa;;YAC3C,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;KAAA;IAED,MAAM,CAAO,uBAAuB,CAAC,EAAU;;YAC7C,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU,EAAE,MAA8B;;YACvE,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;KAAA;CACF;AAnCD,iCAmCC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAelD;;GAEG;AAEH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAwB;QACzC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAU;QAChC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC7F,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,IAAwB;QACrD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,IAAyB;QACrD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,mBAAmB;QACxB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,KAAa;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAU;QACvC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU,EAAE,MAA8B;QACjE,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACjH,CAAC;CACF;AA1ED,4CA0EC;AAED,MAAqB,cAAc;IACjC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAO,SAAS;;YACpB,OAAO,gBAAgB,CAAC,SAAS,EAAE,CAAC;QACtC,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAwB;;YAC/C,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU;;YACtC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,IAAwB;;YAC3D,OAAO,gBAAgB,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,IAAyB;;YAC3D,OAAO,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,mBAAmB;;YAC9B,OAAO,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAChD,CAAC;KAAA;IAED,MAAM,CAAO,kBAAkB,CAAC,KAAa;;YAC3C,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;KAAA;IAED,MAAM,CAAO,uBAAuB,CAAC,EAAU;;YAC7C,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU,EAAE,MAA8B;;YACvE,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;KAAA;CACF;AA5DD,iCA4DC"}

package/lib/cjs/services/media/index.d.ts

@@ -54,6 +54,25 @@ export declare class MediaApiClient {
     static deleteMedia(id: number): Promise<any>;
 }
 export default class MediaService {
+    /**
+     *  :::tipMedia service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {MediaService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `createMedia` will return the created media obj. It takes a media obj as body param.
+     *
+     *     async createMedia() {
+     *     const body = {url: 'string', type: 'url'};
+     *       return await MediaService.createMedia(body);
+     *     }
+     *  ```
+     *  :::
+     */
     static chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
     static chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
     static createMedia(data: MediaCreateParams): Promise<SCMediaType>;

package/lib/cjs/services/media/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAE,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,yBAAyB,EAAE,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAE5F,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrE,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC;AACD;;GAEG;AACH,qBAAa,cAAc;IACzB;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC;IAItF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIjE;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzD;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG7C;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAIpE,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI/E,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI1D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAIlD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAI5D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGnD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAE,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,yBAAyB,EAAE,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAE5F,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrE,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC;AACD;;GAEG;AACH,qBAAa,cAAc;IACzB;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC;IAItF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIjE;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzD;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG7C;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;;;;;;;;;;;;;;;OAkBG;WACU,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAIpE,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI/E,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI1D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAIlD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAI5D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGnD"}

package/lib/cjs/services/media/index.js

@@ -76,6 +76,25 @@ class MediaApiClient {
 }
 exports.MediaApiClient = MediaApiClient;
 class MediaService {
+    /**
+     *  :::tipMedia service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {MediaService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `createMedia` will return the created media obj. It takes a media obj as body param.
+     *
+     *     async createMedia() {
+     *     const body = {url: 'string', type: 'url'};
+     *       return await MediaService.createMedia(body);
+     *     }
+     *  ```
+     *  :::
+     */
     static chunkUploadMedia(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return MediaApiClient.chunkUploadMedia(data);

package/lib/cjs/services/media/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAalD;;GAEG;AACH,MAAa,cAAc;IACzB;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAuB;QAC7C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA+B;QAC7D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAuB;QACxC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,EAAW;;QACvC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAA,EAAC,EAAE,EAAE,EAAE,EAAC,mCAAI,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAU;QAChC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,KAAa;QAC1C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU;QAC3B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnF,CAAC;CACF;AA5DD,wCA4DC;AAED,MAAqB,YAAY;IAC/B,MAAM,CAAO,gBAAgB,CAAC,IAAuB;;YACnD,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,wBAAwB,CAAC,IAA+B;;YACnE,OAAO,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAuB;;YAC9C,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,EAAW;;YAC7C,OAAO,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU;;YACtC,OAAO,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,KAAa;;YAChD,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU;;YACjC,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC;KAAA;CACF;AA5BD,+BA4BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAalD;;GAEG;AACH,MAAa,cAAc;IACzB;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAuB;QAC7C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA+B;QAC7D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAuB;QACxC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,EAAW;;QACvC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAA,EAAC,EAAE,EAAE,EAAE,EAAC,mCAAI,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAU;QAChC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,KAAa;QAC1C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU;QAC3B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnF,CAAC;CACF;AA5DD,wCA4DC;AAED,MAAqB,YAAY;IAC/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAO,gBAAgB,CAAC,IAAuB;;YACnD,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,wBAAwB,CAAC,IAA+B;;YACnE,OAAO,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAuB;;YAC9C,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,EAAW;;YAC7C,OAAO,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU;;YACtC,OAAO,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,KAAa;;YAChD,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU;;YACjC,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC;KAAA;CACF;AA/CD,+BA+CC"}

package/lib/cjs/services/moderation/index.d.ts

@@ -48,6 +48,31 @@ export declare class ModerationApiClient {
     static getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
 }
 export default class ModerationService {
+    /**
+     *  :::tipModeration service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {ModerationService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getUsersForModeration` will return the paginated list of users to moderate.
+     *
+     *     async getUsersForModeration() {
+     *       return await ModerationService.getUsersForModeration();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async moderateASpecificUser(userId, userStatus) {
+     *       return await ModerationService.moderateASpecificUser(userId, userStatus);
+     *     }
+     *  ```
+     *  :::
+     */
     static getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
     static moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
     static getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;

package/lib/cjs/services/moderation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,oBAAoB,EAAE,YAAY,EAAE,yBAAyB,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnJ,OAAO,EAAC,0BAA0B,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,MAAM,WAAW,4BAA4B;IAC3C,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC5E,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtE,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACtF,kCAAkC,CAChC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5C,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACnH;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAIlF;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5E;;OAEG;IACH,MAAM,CAAC,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;IAI5F;;;;;OAKG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAM3C;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxF;;;;OAIG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGzH;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAG3E,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;WAGrE,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;WAGrF,kCAAkC,CAC7C,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG9B,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;WAGjF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG/H"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,oBAAoB,EAAE,YAAY,EAAE,yBAAyB,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnJ,OAAO,EAAC,0BAA0B,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,MAAM,WAAW,4BAA4B;IAC3C,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC5E,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtE,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACtF,kCAAkC,CAChC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5C,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACnH;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAIlF;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5E;;OAEG;IACH,MAAM,CAAC,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;IAI5F;;;;;OAKG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAM3C;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxF;;;;OAIG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGzH;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAG3E,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;WAGrE,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;WAGrF,kCAAkC,CAC7C,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG9B,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;WAGjF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG/H"}

package/lib/cjs/services/moderation/index.js

@@ -69,6 +69,31 @@ class ModerationApiClient {
 }
 exports.ModerationApiClient = ModerationApiClient;
 class ModerationService {
+    /**
+     *  :::tipModeration service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {ModerationService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getUsersForModeration` will return the paginated list of users to moderate.
+     *
+     *     async getUsersForModeration() {
+     *       return await ModerationService.getUsersForModeration();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async moderateASpecificUser(userId, userStatus) {
+     *       return await ModerationService.moderateASpecificUser(userId, userStatus);
+     *     }
+     *  ```
+     *  :::
+     */
     static getUsersForModeration() {
         return __awaiter(this, void 0, void 0, function* () {
             return ModerationApiClient.getUsersForModeration();

package/lib/cjs/services/moderation/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAiBlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,MAAoB;QAC3D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,YAAY,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,YAAY,CAAC,MAAM,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B;QAC/B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAU,EACV,iBAAqC,EACrC,SAA0B;QAE1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,EAAE;YACpI,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,IAAgC;QACvE,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3G,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAU,EAAE,iBAAqC;QACtF,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EAAE,mBAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACpI,CAAC;CACF;AAzDD,kDAyDC;AAED,MAAqB,iBAAiB;IACpC,MAAM,CAAO,qBAAqB;;YAChC,OAAO,mBAAmB,CAAC,qBAAqB,EAAE,CAAC;QACrD,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,MAAoB;;YACjE,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;IACD,MAAM,CAAO,0BAA0B;;YACrC,OAAO,mBAAmB,CAAC,0BAA0B,EAAE,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,kCAAkC,CAC7C,EAAU,EACV,iBAAqC,EACrC,SAA0B;;YAE1B,OAAO,mBAAmB,CAAC,kCAAkC,CAAC,EAAE,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;QAClG,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,IAAgC;;YAC7E,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7D,CAAC;KAAA;IACD,MAAM,CAAO,+BAA+B,CAAC,EAAU,EAAE,iBAAqC;;YAC5F,OAAO,mBAAmB,CAAC,+BAA+B,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACpF,CAAC;KAAA;CACF;AAvBD,oCAuBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAiBlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,MAAoB;QAC3D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,YAAY,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,YAAY,CAAC,MAAM,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B;QAC/B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAU,EACV,iBAAqC,EACrC,SAA0B;QAE1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,EAAE;YACpI,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,IAAgC;QACvE,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3G,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAU,EAAE,iBAAqC;QACtF,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EAAE,mBAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACpI,CAAC;CACF;AAzDD,kDAyDC;AAED,MAAqB,iBAAiB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAO,qBAAqB;;YAChC,OAAO,mBAAmB,CAAC,qBAAqB,EAAE,CAAC;QACrD,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,MAAoB;;YACjE,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;IACD,MAAM,CAAO,0BAA0B;;YACrC,OAAO,mBAAmB,CAAC,0BAA0B,EAAE,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,kCAAkC,CAC7C,EAAU,EACV,iBAAqC,EACrC,SAA0B;;YAE1B,OAAO,mBAAmB,CAAC,kCAAkC,CAAC,EAAE,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;QAClG,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,IAAgC;;YAC7E,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7D,CAAC;KAAA;IACD,MAAM,CAAO,+BAA+B,CAAC,EAAU,EAAE,iBAAqC;;YAC5F,OAAO,mBAAmB,CAAC,+BAA+B,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACpF,CAAC;KAAA;CACF;AAhDD,oCAgDC"}

package/lib/cjs/services/notification/index.d.ts

@@ -57,6 +57,31 @@ export declare class NotificationApiClient {
     static disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
 }
 export default class NotificationService {
+    /**
+     *  :::tipEmbed service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {NotificationService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `listUserNotification` will return the paginated list of notifications.
+     *
+     *     async listUserNotification() {
+     *       return await NotificationService.listUserNotification();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async disposeBroadcastMessages(banner_ids) {
+     *       return await NotificationService.disposeBroadcastMessages(banner_ids);
+     *     }
+     *  ```
+     *  :::
+     */
     static listUserNotification(): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
     static markReadNotification(sids: string[]): Promise<any>;
     static getUnseenNotification(): Promise<SCNotificationUnseenCountType>;

package/lib/cjs/services/notification/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,sBAAsB,EAAE,4BAA4B,EAAE,6BAA6B,EAAC,MAAM,sBAAsB,CAAC;AACzH,OAAO,EAAC,wBAAwB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAE1E,MAAM,WAAW,8BAA8B;IAC7C,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC,CAAC;IACnF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAChE,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACvE,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC9E,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC3E,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/E,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9D,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC9D;AACD;;GAEG;AAEH,qBAAa,qBAAqB;IAChC;;OAEG;IACH,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzD;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAItE;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7E;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;IAIpF;;OAEG;IACH,MAAM,CAAC,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIjF;;OAEG;IACH,MAAM,CAAC,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIrF;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGpE;AAED,MAAM,CAAC,OAAO,OAAO,mBAAmB;WACzB,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;WAGlF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAGlD,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG/D,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGtE,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;WAG7E,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG1E,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG9E,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAG5D,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAG3E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,sBAAsB,EAAE,4BAA4B,EAAE,6BAA6B,EAAC,MAAM,sBAAsB,CAAC;AACzH,OAAO,EAAC,wBAAwB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAE1E,MAAM,WAAW,8BAA8B;IAC7C,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC,CAAC;IACnF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAChE,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACvE,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC9E,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC3E,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/E,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9D,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC9D;AACD;;GAEG;AAEH,qBAAa,qBAAqB;IAChC;;OAEG;IACH,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzD;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAItE;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7E;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;IAIpF;;OAEG;IACH,MAAM,CAAC,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIjF;;OAEG;IACH,MAAM,CAAC,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIrF;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGpE;AAED,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;WAGlF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAGlD,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG/D,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGtE,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;WAG7E,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG1E,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG9E,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAG5D,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAG3E"}

package/lib/cjs/services/notification/index.js

@@ -80,6 +80,31 @@ class NotificationApiClient {
 }
 exports.NotificationApiClient = NotificationApiClient;
 class NotificationService {
+    /**
+     *  :::tipEmbed service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {NotificationService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `listUserNotification` will return the paginated list of notifications.
+     *
+     *     async listUserNotification() {
+     *       return await NotificationService.listUserNotification();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async disposeBroadcastMessages(banner_ids) {
+     *       return await NotificationService.disposeBroadcastMessages(banner_ids);
+     *     }
+     *  ```
+     *  :::
+     */
     static listUserNotification() {
         return __awaiter(this, void 0, void 0, function* () {
             return NotificationApiClient.listUserNotification();

package/lib/cjs/services/notification/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAelD;;GAEG;AAEH,MAAa,qBAAqB;IAChC;;OAEG;IACH,MAAM,CAAC,oBAAoB;QACzB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAc;QACxC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;IACzH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA8B;QAC5D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gCAAgC;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oCAAoC;QACzC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC3H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAoB;QACnD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;IACvI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAoB;QAClD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;IACrI,CAAC;CACF;AAnED,sDAmEC;AAED,MAAqB,mBAAmB;IACtC,MAAM,CAAO,oBAAoB;;YAC/B,OAAO,qBAAqB,CAAC,oBAAoB,EAAE,CAAC;QACtD,CAAC;KAAA;IACD,MAAM,CAAO,oBAAoB,CAAC,IAAc;;YAC9C,OAAO,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB;;YAChC,OAAO,qBAAqB,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,IAA8B;;YAClE,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC9D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB;;YAChC,OAAO,qBAAqB,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,gCAAgC;;YAC3C,OAAO,qBAAqB,CAAC,gCAAgC,EAAE,CAAC;QAClE,CAAC;KAAA;IACD,MAAM,CAAO,oCAAoC;;YAC/C,OAAO,qBAAqB,CAAC,oCAAoC,EAAE,CAAC;QACtE,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,UAAoB;;YACxD,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACpE,CAAC;KAAA;IACD,MAAM,CAAO,yBAAyB,CAAC,UAAoB;;YACzD,OAAO,qBAAqB,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACrE,CAAC;KAAA;CACF;AA5BD,sCA4BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAelD;;GAEG;AAEH,MAAa,qBAAqB;IAChC;;OAEG;IACH,MAAM,CAAC,oBAAoB;QACzB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAc;QACxC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;IACzH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA8B;QAC5D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gCAAgC;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oCAAoC;QACzC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC3H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAoB;QACnD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;IACvI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAoB;QAClD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;IACrI,CAAC;CACF;AAnED,sDAmEC;AAED,MAAqB,mBAAmB;IACtC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAO,oBAAoB;;YAC/B,OAAO,qBAAqB,CAAC,oBAAoB,EAAE,CAAC;QACtD,CAAC;KAAA;IACD,MAAM,CAAO,oBAAoB,CAAC,IAAc;;YAC9C,OAAO,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB;;YAChC,OAAO,qBAAqB,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,IAA8B;;YAClE,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC9D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB;;YAChC,OAAO,qBAAqB,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,gCAAgC;;YAC3C,OAAO,qBAAqB,CAAC,gCAAgC,EAAE,CAAC;QAClE,CAAC;KAAA;IACD,MAAM,CAAO,oCAAoC;;YAC/C,OAAO,qBAAqB,CAAC,oCAAoC,EAAE,CAAC;QACtE,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,UAAoB;;YACxD,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACpE,CAAC;KAAA;IACD,MAAM,CAAO,yBAAyB,CAAC,UAAoB;;YACzD,OAAO,qBAAqB,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACrE,CAAC;KAAA;CACF;AArDD,sCAqDC"}

package/lib/cjs/services/preference/index.d.ts

@@ -28,6 +28,31 @@ export declare class PreferenceApiClient {
     static getSpecificPreference(id: number): Promise<SCPreferenceType>;
 }
 export default class PreferenceService {
+    /**
+     *  :::tipPreference service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {PreferenceService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllPreferences` will return the paginated list of preferences.
+     *
+     *     async getAllPreferences() {
+     *       return await PreferenceService.getAllPreferences();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async getSpecificPreference(preferenceId) {
+     *       return await PreferenceService.getSpecificPreference(preferenceId);
+     *     }
+     *  ```
+     *  :::
+     */
     static getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
     static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
     static getSpecificPreference(id: number): Promise<SCPreferenceType>;

package/lib/cjs/services/preference/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAC,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEhD,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACtE,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACzI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC9D;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAI5E;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAU/I;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGpE;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAIrE,iBAAiB,CAC5B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAItC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAG1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAC,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEhD,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACtE,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACzI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC9D;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAI5E;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAU/I;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGpE;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAIrE,iBAAiB,CAC5B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAItC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAG1E"}

package/lib/cjs/services/preference/index.js

@@ -46,6 +46,31 @@ class PreferenceApiClient {
 }
 exports.PreferenceApiClient = PreferenceApiClient;
 class PreferenceService {
+    /**
+     *  :::tipPreference service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {PreferenceService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllPreferences` will return the paginated list of preferences.
+     *
+     *     async getAllPreferences() {
+     *       return await PreferenceService.getAllPreferences();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async getSpecificPreference(preferenceId) {
+     *       return await PreferenceService.getSpecificPreference(preferenceId);
+     *     }
+     *  ```
+     *  :::
+     */
     static getAllPreferences() {
         return __awaiter(this, void 0, void 0, function* () {
             return PreferenceApiClient.getAllPreferences();

package/lib/cjs/services/preference/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AASlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,iBAAiB;QACtB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAe,EAAE,OAAgB,EAAE,IAAa,EAAE,QAAiB;QAC1F,MAAM,MAAM,GAAG,IAAI,eAAe,6DAC7B,CAAC,MAAM,IAAI,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,GAC5B,CAAC,OAAO,IAAI,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC,GAC/B,CAAC,IAAI,IAAI,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,GACtB,CAAC,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,EACrC,CAAC;QACH,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACrF,CAAC;CACF;AAhCD,kDAgCC;AAED,MAAqB,iBAAiB;IACpC,MAAM,CAAO,iBAAiB;;YAC5B,OAAO,mBAAmB,CAAC,iBAAiB,EAAE,CAAC;QACjD,CAAC;KAAA;IAED,MAAM,CAAO,iBAAiB,CAC5B,MAAe,EACf,OAAgB,EAChB,IAAa,EACb,QAAiB;;YAEjB,OAAO,mBAAmB,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChF,CAAC;KAAA;IAED,MAAM,CAAO,qBAAqB,CAAC,EAAU;;YAC3C,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;KAAA;CACF;AAjBD,oCAiBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AASlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,iBAAiB;QACtB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAe,EAAE,OAAgB,EAAE,IAAa,EAAE,QAAiB;QAC1F,MAAM,MAAM,GAAG,IAAI,eAAe,6DAC7B,CAAC,MAAM,IAAI,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,GAC5B,CAAC,OAAO,IAAI,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC,GAC/B,CAAC,IAAI,IAAI,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,GACtB,CAAC,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,EACrC,CAAC;QACH,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACrF,CAAC;CACF;AAhCD,kDAgCC;AAED,MAAqB,iBAAiB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAO,iBAAiB;;YAC5B,OAAO,mBAAmB,CAAC,iBAAiB,EAAE,CAAC;QACjD,CAAC;KAAA;IAED,MAAM,CAAO,iBAAiB,CAC5B,MAAe,EACf,OAAgB,EAChB,IAAa,EACb,QAAiB;;YAEjB,OAAO,mBAAmB,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChF,CAAC;KAAA;IAED,MAAM,CAAO,qBAAqB,CAAC,EAAU;;YAC3C,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;KAAA;CACF;AA1CD,oCA0CC"}

package/lib/cjs/services/private_message/index.d.ts

@@ -67,6 +67,31 @@ export declare class PrivateMessageApiClient {
     static chunkUploadDone(data: MessageChunkUploadDoneParams): Promise<SCPrivateMessageUploadMediaType>;
 }
 export default class PrivateMessageService {
+    /**
+     *  :::tipPrivateMessage service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {PrivateMessageService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllSnippets` will return the paginated list of snippets.
+     *
+     *     async getAllSnippets() {
+     *       return await PrivateMessageService.getAllSnippets();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async getASingleMessage(messageId) {
+     *       return await PrivateMessageService.getASingleMessage(messageId);
+     *     }
+     *  ```
+     *  :::
+     */
     static getAllSnippets(): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
     static getAThread(data: ThreadParams): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
     static getASingleMessage(id: number): Promise<SCPrivateMessageType>;

package/lib/cjs/services/private_message/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,4BAA4B,EAC5B,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,4BAA4B,EAC5B,mBAAmB,EACnB,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,oBAAoB,EACpB,oCAAoC,EACpC,+BAA+B,EAC/B,mCAAmC,EACpC,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,gCAAgC;IAC/C,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACrE,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACnF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7D,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACvE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACtF,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAClG,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACnG,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;CAC/F;AACD;;GAEG;AAEH,qBAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAI5F;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAIxG;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC;IAIzG;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAGrG;AAED,MAAM,CAAC,OAAO,OAAO,qBAAqB;WAC3B,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGpE,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGlF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAG5D,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAGtE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC;WAGrF,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC;WAGjG,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC;WAGlG,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAG3G"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,4BAA4B,EAC5B,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,4BAA4B,EAC5B,mBAAmB,EACnB,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,oBAAoB,EACpB,oCAAoC,EACpC,+BAA+B,EAC/B,mCAAmC,EACpC,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,gCAAgC;IAC/C,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACrE,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACnF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7D,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACvE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACtF,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAClG,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACnG,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;CAC/F;AACD;;GAEG;AAEH,qBAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAI5F;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAIxG;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC;IAIzG;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAGrG;AAED,MAAM,CAAC,OAAO,OAAO,qBAAqB;IACxC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGpE,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGlF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAG5D,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAGtE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC;WAGrF,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC;WAGjG,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC;WAGlG,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAG3G"}

package/lib/cjs/services/private_message/index.js

@@ -91,6 +91,31 @@ class PrivateMessageApiClient {
 }
 exports.PrivateMessageApiClient = PrivateMessageApiClient;
 class PrivateMessageService {
+    /**
+     *  :::tipPrivateMessage service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {PrivateMessageService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllSnippets` will return the paginated list of snippets.
+     *
+     *     async getAllSnippets() {
+     *       return await PrivateMessageService.getAllSnippets();
+     *     }
+     *  ```
+     *  ```jsx
+     *  - In case of required `params`, just add them inside the brackets.
+     *
+     *    async getASingleMessage(messageId) {
+     *       return await PrivateMessageService.getASingleMessage(messageId);
+     *     }
+     *  ```
+     *  :::
+     */
     static getAllSnippets() {
         return __awaiter(this, void 0, void 0, function* () {
             return PrivateMessageApiClient.getAllSnippets();

package/lib/cjs/services/private_message/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AA6BlD;;GAEG;AAEH,MAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,cAAc;QACnB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,IAAkB;QAClC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU;QACjC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAyB;QAC3C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAU;QAC9B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAU;QAC7B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAA8B;QAC/C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAA8B;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iCAAiC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,iCAAiC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3H,CAAC;CACF;AA/ED,0DA+EC;AAED,MAAqB,qBAAqB;IACxC,MAAM,CAAO,cAAc;;YACzB,OAAO,uBAAuB,CAAC,cAAc,EAAE,CAAC;QAClD,CAAC;KAAA;IACD,MAAM,CAAO,UAAU,CAAC,IAAkB;;YACxC,OAAO,uBAAuB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU;;YACvC,OAAO,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,YAAY,CAAC,IAAyB;;YACjD,OAAO,uBAAuB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,cAAc,CAAC,EAAU;;YACpC,OAAO,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,aAAa,CAAC,EAAU;;YACnC,OAAO,uBAAuB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,IAA8B;;YACrD,OAAO,uBAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC;;YAC7D,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,mBAAmB,CAAC,IAA8B;;YAC7D,OAAO,uBAAuB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC;;YAC7D,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;CACF;AA/BD,wCA+BC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AA6BlD;;GAEG;AAEH,MAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,cAAc;QACnB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,IAAkB;QAClC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU;QACjC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAyB;QAC3C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAU;QAC9B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAU;QAC7B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAA8B;QAC/C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAA8B;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iCAAiC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,iCAAiC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3H,CAAC;CACF;AA/ED,0DA+EC;AAED,MAAqB,qBAAqB;IACxC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAO,cAAc;;YACzB,OAAO,uBAAuB,CAAC,cAAc,EAAE,CAAC;QAClD,CAAC;KAAA;IACD,MAAM,CAAO,UAAU,CAAC,IAAkB;;YACxC,OAAO,uBAAuB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU;;YACvC,OAAO,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,YAAY,CAAC,IAAyB;;YACjD,OAAO,uBAAuB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,cAAc,CAAC,EAAU;;YACpC,OAAO,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,aAAa,CAAC,EAAU;;YACnC,OAAO,uBAAuB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,IAA8B;;YACrD,OAAO,uBAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC;;YAC7D,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,mBAAmB,CAAC,IAA8B;;YAC7D,OAAO,uBAAuB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC;;YAC7D,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;CACF;AAxDD,wCAwDC"}

package/lib/cjs/services/score/index.d.ts

@@ -26,6 +26,24 @@ export declare class ScoreApiClient {
     static addScore(data: UserScoreParams): Promise<SCUserScoreType>;
 }
 export default class ScoreService {
+    /**
+     *  :::tipScore service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {ScoreService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllScores` will return the paginated list of user scores.
+     *
+     *     async getAllScores() {
+     *       return await ScoreService.getAllScores();
+     *     }
+     *  ```
+     *  :::
+     */
     static getAllScores(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
     static searchScore(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
     static addScore(data: UserScoreParams): Promise<SCUserScoreType>;

package/lib/cjs/services/score/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAC,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAC,MAAM,aAAa,CAAC;AAE9E,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAClF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC3D;AACD;;GAEG;AAEH,qBAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKxF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKvF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGjE;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGjF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGhF,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGvE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAC,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAC,MAAM,aAAa,CAAC;AAE9E,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAClF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC3D;AACD;;GAEG;AAEH,qBAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKxF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKvF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGjE;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;;;;;;;;;;;;;;OAiBG;WACU,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGjF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGhF,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGvE"}

package/lib/cjs/services/score/index.js

@@ -45,6 +45,24 @@ class ScoreApiClient {
 }
 exports.ScoreApiClient = ScoreApiClient;
 class ScoreService {
+    /**
+     *  :::tipScore service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {ScoreService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `getAllScores` will return the paginated list of user scores.
+     *
+     *     async getAllScores() {
+     *       return await ScoreService.getAllScores();
+     *     }
+     *  ```
+     *  :::
+     */
     static getAllScores(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return ScoreApiClient.getAllScores(params);

package/lib/cjs/services/score/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AASlD;;GAEG;AAEH,MAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAoB;QACtC,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAoB;QACrC,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAqB;QACnC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;CACF;AA1BD,wCA0BC;AAED,MAAqB,YAAY;IAC/B,MAAM,CAAO,YAAY,CAAC,MAAoB;;YAC5C,OAAO,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,MAAoB;;YAC3C,OAAO,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;KAAA;IACD,MAAM,CAAO,QAAQ,CAAC,IAAqB;;YACzC,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;KAAA;CACF;AAVD,+BAUC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AASlD;;GAEG;AAEH,MAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAoB;QACtC,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAoB;QACrC,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAqB;QACnC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;CACF;AA1BD,wCA0BC;AAED,MAAqB,YAAY;IAC/B;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAO,YAAY,CAAC,MAAoB;;YAC5C,OAAO,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,MAAoB;;YAC3C,OAAO,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;KAAA;IACD,MAAM,CAAO,QAAQ,CAAC,IAAqB;;YACzC,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;KAAA;CACF;AA5BD,+BA4BC"}

package/lib/cjs/services/sso/index.d.ts

@@ -20,6 +20,25 @@ export declare class SSOApiClient {
     static SignUp(data: SSOSignUpParams): Promise<SSOSignUpType>;
 }
 export default class SSOService {
+    /**
+     *  :::tipSSO service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {SSOService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `SignUp` will return the user registration data. It takes the username and ext_id obj as body params.
+     *
+     *     async SignUp() {
+     *     const data = {username: 'string', ext_id: 'number'};
+     *       return await SSOService.SignUp(data);
+     *     }
+     *  ```
+     *  :::
+     */
     static SignIn(): Promise<SSOSignInType>;
     static SignUp(data: SSOSignUpParams): Promise<SSOSignUpType>;
 }

package/lib/cjs/services/sso/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/sso/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,aAAa,EAAE,aAAa,EAAC,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AAE5C,MAAM,WAAW,qBAAqB;IACpC,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CACvD;AACD;;GAEG;AAEH,qBAAa,YAAY;IACvB;;OAEG;IACH,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAIvC;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;CAG7D;AAED,MAAM,CAAC,OAAO,OAAO,UAAU;WAChB,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;WAGhC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;CAGnE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/sso/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,aAAa,EAAE,aAAa,EAAC,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAC;AAE5C,MAAM,WAAW,qBAAqB;IACpC,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CACvD;AACD;;GAEG;AAEH,qBAAa,YAAY;IACvB;;OAEG;IACH,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAIvC;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;CAG7D;AAED,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;;;;;;;;;;;;;;;;;OAkBG;WACU,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;WAGhC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;CAGnE"}

package/lib/cjs/services/sso/index.js

@@ -36,6 +36,25 @@ class SSOApiClient {
 }
 exports.SSOApiClient = SSOApiClient;
 class SSOService {
+    /**
+     *  :::tipSSO service can be used in the following ways:
+     *
+     *  ```jsx
+     *  1. Import the service from our library:
+     *
+     *  import {SSOService} from "@selfcommunity/api-services";
+     *  ```
+     *  ```jsx
+     *  2. Create a function and put the service inside it!
+     *  The async function `SignUp` will return the user registration data. It takes the username and ext_id obj as body params.
+     *
+     *     async SignUp() {
+     *     const data = {username: 'string', ext_id: 'number'};
+     *       return await SSOService.SignUp(data);
+     *     }
+     *  ```
+     *  :::
+     */
     static SignIn() {
         return __awaiter(this, void 0, void 0, function* () {
             return SSOApiClient.SignIn();