@selfcommunity/api-services 0.1.6 → 0.1.7

package/lib/types/services/legal_page/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/legal_page/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,2BAA2B;IAC1C,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/C,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7C,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CAC7B;AAED,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBpC,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBrD,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBvC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB7C,MAAM,CAAC,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBnD,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;CAkBnC;AAED,MAAM,CAAC,OAAO,OAAO,gBAAgB;WACtB,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;WAI7B,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI9C,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIhC,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAItC,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI5C,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;CAGzC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/legal_page/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAC,kBAAkB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAEzE,MAAM,WAAW,2BAA2B;IAC1C,aAAa,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7F,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3D,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAChG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACzF,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC5D,WAAW,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;CAC9C;AACD;;GAEG;AAEH,qBAAa,kBAAkB;IAC7B;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAInG;;OAEG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIjE;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKtG;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAI/F;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIlE;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAGpD;AAED,MAAM,CAAC,OAAO,OAAO,gBAAgB;WACtB,aAAa,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAI5F,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;WAI1D,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAI/F,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAIxF,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;WAI3D,WAAW,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAG1D"}

package/lib/types/services/locality/index.d.ts

@@ -1,13 +1,24 @@
+import { SCPaginatedResponse } from '../../types';
+import { SCLocalityType } from '@selfcommunity/types';
 export interface LocalityApiClientInterface {
-    getLocalities(): Promise<any>;
-    searchLocalities(): Promise<any>;
+    getLocalities(): Promise<SCPaginatedResponse<SCLocalityType>>;
+    searchLocalities(): Promise<SCPaginatedResponse<SCLocalityType>>;
 }
+/**
+ * Contains all the endpoints needed to manage localities.
+ */
 export declare class LocalityApiClient {
-    static getLocalities(): Promise<any>;
-    static searchLocalities(): Promise<any>;
+    /**
+     * This endpoint retrieves the list of available localities.
+     */
+    static getLocalities(): Promise<SCPaginatedResponse<SCLocalityType>>;
+    /**
+     * This endpoint searches localities
+     */
+    static searchLocalities(): Promise<SCPaginatedResponse<SCLocalityType>>;
 }
 export default class LocalityService {
-    static getLocalities(): Promise<any>;
-    static searchLocalities(): Promise<any>;
+    static getLocalities(): Promise<SCPaginatedResponse<SCLocalityType>>;
+    static searchLocalities(): Promise<SCPaginatedResponse<SCLocalityType>>;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/services/locality/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/locality/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,0BAA0B;IACzC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CAClC;AAED,qBAAa,iBAAiB;IAC5B,MAAM,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBpC,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;CAkBxC;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;WAG7B,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;CAG9C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/locality/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAEpD,MAAM,WAAW,0BAA0B;IACzC,aAAa,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9D,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;CAClE;AACD;;GAEG;AAEH,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,MAAM,CAAC,aAAa,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAIpE;;OAEG;IACH,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAGxE;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,aAAa,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAG7D,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAG9E"}

package/lib/types/services/loyalty/index.d.ts

@@ -1,34 +1,77 @@
+import { SCPrizeType, SCPrizeUserStatusType, SCPrizeUserType } from '@selfcommunity/types';
+import { SCPaginatedResponse, LoyaltyPrizeParams } from '../../types';
 export interface LoyaltyApiClientInterface {
-    getPrizes(): Promise<any>;
-    createPrize(): Promise<any>;
-    getSpecificPrize(id: number): Promise<any>;
-    updatePrize(id: number): Promise<any>;
-    patchPrize(id: number): Promise<any>;
-    getPrizeRequests(): Promise<any>;
-    createPrizeRequest(): Promise<any>;
-    getSpecificPrizeRequest(id: number): Promise<any>;
-    patchPrizeRequest(id: number): Promise<any>;
+    getPrizes(): Promise<SCPaginatedResponse<SCPrizeType>>;
+    createPrize(data: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    getSpecificPrize(id: number): Promise<SCPrizeType>;
+    updatePrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    patchPrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    getAllPrizeRequests(): Promise<SCPaginatedResponse<SCPrizeUserType>>;
+    createPrizeRequest(prize: number): Promise<SCPrizeUserType>;
+    getSpecificPrizeRequest(id: number): Promise<SCPrizeUserType>;
+    patchPrizeRequest(id: number, status?: SCPrizeUserStatusType): Promise<SCPrizeUserType>;
 }
+/**
+ * Contains all the endpoints needed to manage loyalty program.
+ */
 export declare class LoyaltyApiClient {
-    static getPrizes(): Promise<any>;
-    static createPrize(): Promise<any>;
-    static getSpecificPrize(id: number): Promise<any>;
-    static updatePrize(id: number): Promise<any>;
-    static patchPrize(id: number): Promise<any>;
-    static getPrizeRequests(): Promise<any>;
-    static createPrizeRequest(): Promise<any>;
-    static getSpecificPrizeRequest(id: number): Promise<any>;
-    static patchPrizeRequest(id: number): Promise<any>;
+    /**
+     * This endpoint retrieves all prizes.
+     */
+    static getPrizes(): Promise<SCPaginatedResponse<SCPrizeType>>;
+    /**
+     * This endpoint creates a prize.
+     * @param data
+     */
+    static createPrize(data: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    /**
+     * This endpoint retrieves a specific prize
+     * @param id
+     */
+    static getSpecificPrize(id: number): Promise<SCPrizeType>;
+    /**
+     * This endpoint updates a specific prize.
+     * @param id
+     * @param data
+     */
+    static updatePrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    /**
+     * This endpoint patches a specific prize.
+     * @param id
+     * @param data
+     */
+    static patchPrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    /**
+     * This endpoint retrieves all requests of loyalty prizes.
+     */
+    static getAllPrizeRequests(): Promise<SCPaginatedResponse<SCPrizeUserType>>;
+    /**
+     * This endpoint creates a request for a loyalty prize
+     * @param prize
+     */
+    static createPrizeRequest(prize: number): Promise<SCPrizeUserType>;
+    /**
+     * This endpoint retrieves a specific request for a loyalty prize.
+     * @param id
+     */
+    static getSpecificPrizeRequest(id: number): Promise<SCPrizeUserType>;
+    /**
+     * This endpoint patches a specific request for a loyalty prize.
+     * You can use this endpoint to to change status in an admin list/table interface.
+     * @param id
+     * @param status
+     */
+    static patchPrizeRequest(id: number, status?: SCPrizeUserStatusType): Promise<SCPrizeUserType>;
 }
 export default class LoyaltyService {
-    static getPrizes(): Promise<any>;
-    static createPrize(): Promise<any>;
-    static getSpecificPrize(id: number): Promise<any>;
-    static updatePrize(id: number): Promise<any>;
-    static patchPrize(id: number): Promise<any>;
-    static getPrizeRequests(): Promise<any>;
-    static createPrizeRequest(): Promise<any>;
-    static getSpecificPrizeRequest(id: number): Promise<any>;
-    static patchPrizeRequest(id: number): Promise<any>;
+    static getPrizes(): Promise<SCPaginatedResponse<SCPrizeType>>;
+    static createPrize(data: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    static getSpecificPrize(id: number): Promise<SCPrizeType>;
+    static updatePrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    static patchPrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
+    static getAllPrizeRequests(): Promise<SCPaginatedResponse<SCPrizeUserType>>;
+    static createPrizeRequest(prize: number): Promise<SCPrizeUserType>;
+    static getSpecificPrizeRequest(id: number): Promise<SCPrizeUserType>;
+    static patchPrizeRequest(id: number, status?: SCPrizeUserStatusType): Promise<SCPrizeUserType>;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/services/loyalty/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,yBAAyB;IACxC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1B,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC7C;AAED,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBhC,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBlC,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBjD,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB5C,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB3C,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBvC,MAAM,CAAC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBzC,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBxD,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkBnD;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;WAIzB,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;WAI3B,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI1C,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIrC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIpC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIhC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIlC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGjD,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGzD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,WAAW,EAAE,qBAAqB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACzF,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAC;AAEpE,MAAM,WAAW,yBAAyB;IACxC,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IACvD,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5D,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACzE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACxE,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACrE,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5D,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC9D,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CACzF;AACD;;GAEG;AAEH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAI7D;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIlE;;;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,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI/E;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9E;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlE;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIpE;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;CAG/F;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;WAItD,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI3D,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAIlD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIxE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIvE,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAIpE,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;WAI3D,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;WAG7D,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;CAGrG"}

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

@@ -1,28 +1,65 @@
+import { SCChunkMediaType, SCMediaType } from '@selfcommunity/types';
+import { ChunkUploadCompleteParams, ChunkUploadParams, MediaCreateParams } from '../../types';
 export interface MediaApiClientInterface {
-    chunkUploadMedia(): Promise<any>;
-    chunkUploadMediaComplete(): Promise<any>;
-    createMedia(): Promise<any>;
-    clickMedia(id: number): Promise<any>;
-    getSpecificMedia(id: number): Promise<any>;
-    updateMedia(id: number): Promise<any>;
+    chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
+    chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
+    createMedia(data: MediaCreateParams): Promise<SCMediaType>;
+    clickMedia(id: number, ip?: string): Promise<any>;
+    getSpecificMedia(id: number): Promise<SCMediaType>;
+    updateMedia(id: number, image: string): Promise<SCMediaType>;
     deleteMedia(id: number): Promise<any>;
 }
+/**
+ * Contains all the endpoints needed to manage medias.
+ */
 export declare class MediaApiClient {
-    static chunkUploadMedia(): Promise<any>;
-    static chunkUploadMediaComplete(): Promise<any>;
-    static createMedia(): Promise<any>;
-    static clickMedia(id: number): Promise<any>;
-    static getSpecificMedia(id: number): Promise<any>;
-    static updateMedia(id: number): Promise<any>;
+    /**
+     * This endpoint performs the chunk upload of a media with type image or document.
+     * The client must split the file into chunks and send to the server in series. After all the chunks have been uploaded the client must call the Chunk Upload Complete endpoint with the given upload_id parameter to finalize the upload and retrieve the Media.
+     *  To perform chunk upload the request must contain Content-Range header with the information about the chunk.
+     * @param data
+     */
+    static chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
+    /**
+     * This endpoint completes the chunk upload and create the media.
+     * @param data
+     */
+    static chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
+    /**
+     * This endpoint creates a media.
+     * @param data
+     */
+    static createMedia(data: MediaCreateParams): Promise<SCMediaType>;
+    /**
+     * This endpoint saves a click on a specific media using ID.
+     * @param id
+     * @param ip
+     */
+    static clickMedia(id: number, ip?: string): Promise<any>;
+    /**
+     * This endpoint retrieves a specific media using ID.
+     * @param id
+     */
+    static getSpecificMedia(id: number): Promise<SCMediaType>;
+    /**
+     * This endpoint updates a media.
+     * @param id
+     * @param image
+     */
+    static updateMedia(id: number, image: string): Promise<SCMediaType>;
+    /**
+     * This endpoint deletes a media.
+     * @param id
+     */
     static deleteMedia(id: number): Promise<any>;
 }
 export default class MediaService {
-    static chunkUploadMedia(): Promise<any>;
-    static chunkUploadMediaComplete(): Promise<any>;
-    static createMedia(): Promise<any>;
-    static clickMedia(id: number): Promise<any>;
-    static getSpecificMedia(id: number): Promise<any>;
-    static updateMedia(id: number): Promise<any>;
+    static chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
+    static chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
+    static createMedia(data: MediaCreateParams): Promise<SCMediaType>;
+    static clickMedia(id: number, ip?: string): Promise<any>;
+    static getSpecificMedia(id: number): Promise<SCMediaType>;
+    static updateMedia(id: number, image: string): Promise<SCMediaType>;
     static deleteMedia(id: number): Promise<any>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC;AAED,qBAAa,cAAc;IACzB,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBvC,MAAM,CAAC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB/C,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBlC,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB3C,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBjD,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB5C,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkB7C;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIhC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIxC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;WAI3B,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIpC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI1C,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIrC,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;IAS3E;;;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"}

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

@@ -1,25 +1,58 @@
+import { SCUserModerationType, SCUserStatus, SCFlaggedContributionType, SCFlagType, SCFlagTypeEnum, SCContributionType } from '@selfcommunity/types';
+import { ModerateContributionParams, SCPaginatedResponse } from '../../types';
+import { SCContributionStatus } from '@selfcommunity/types';
 export interface ModerationApiClientInterface {
-    getUsersForModeration(): Promise<any>;
-    moderateASpecificUser(id: number): Promise<any>;
-    getAllFlaggedContributions(): Promise<any>;
-    getSpecificContributionFlag(id: number, contribution_type: string): Promise<any>;
-    moderateAContribution(id: number): Promise<any>;
-    getContributionModerationStatus(id: number, contribution_type: string): Promise<any>;
+    getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
+    moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
+    getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
+    getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum): Promise<SCPaginatedResponse<SCFlagType>>;
+    moderateAContribution(id: number, data: ModerateContributionParams): Promise<any>;
+    getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
 }
+/**
+ * Contains all the endpoints needed to manage moderation.
+ */
 export declare class ModerationApiClient {
-    static getUsersForModeration(): Promise<any>;
-    static moderateASpecificUser(id: number): Promise<any>;
-    static getAllFlaggedContributions(): Promise<any>;
-    static getSpecificContributionFlag(id: number, contribution_type: string): Promise<any>;
-    static moderateAContribution(id: number): Promise<any>;
-    static getContributionModerationStatus(id: number, contribution_type: string): Promise<any>;
+    /**
+     * This endpoint retrieves all users for moderation purpose.
+     */
+    static getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
+    /**
+     * This endpoint performs users moderation.
+     * @param id
+     * @param status
+     */
+    static moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
+    /**
+     * This endpoint retrieves all flagged contributions.
+     */
+    static getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
+    /**
+     * This endpoint retrieves all flags for a specific contribution.
+     * @param id
+     * @param contribution_type
+     * @param flag_type
+     */
+    static getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum): Promise<SCPaginatedResponse<SCFlagType>>;
+    /**
+     * This endpoint provides actions for flagged contributions moderation.
+     * @param id
+     * @param data
+     */
+    static moderateAContribution(id: number, data: ModerateContributionParams): Promise<any>;
+    /**
+     * This endpoint retrieves moderation status for a specific contribution.
+     * @param id
+     * @param contribution_type
+     */
+    static getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
 }
 export default class ModerationService {
-    static getUsersForModeration(): Promise<any>;
-    static moderateASpecificUser(id: number): Promise<any>;
-    static getAllFlaggedContributions(): Promise<any>;
-    static getSpecificContributionFlag(id: number, contribution_type: string): Promise<any>;
-    static moderateAContribution(id: number): Promise<any>;
-    static getContributionModerationStatus(id: number, contribution_type: string): Promise<any>;
+    static getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
+    static moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
+    static getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
+    static getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum): Promise<SCPaginatedResponse<SCFlagType>>;
+    static moderateAContribution(id: number, data: ModerateContributionParams): Promise<any>;
+    static getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,4BAA4B;IAC3C,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAChD,0BAA0B,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,2BAA2B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACjF,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAChD,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACtF;AAED,qBAAa,mBAAmB;IAC9B,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;IAkB5C,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBtD,MAAM,CAAC,0BAA0B,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBjD,MAAM,CAAC,2BAA2B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBvF,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBtD,MAAM,CAAC,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkB5F;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGrC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAG/C,0BAA0B,IAAI,OAAO,CAAC,GAAG,CAAC;WAG1C,2BAA2B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGhF,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAG/C,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGlG"}
+{"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;IAO3C;;;;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;CAKzH;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"}

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

@@ -1,34 +1,70 @@
+import { SCBroadcastMessageType, SCNotificationAggregatedType, SCNotificationUnseenCountType } from '@selfcommunity/types';
+import { CustomNotificationParams, SCPaginatedResponse } from '../../types';
 export interface NotificationApiClientInterface {
-    listUserNotification(): Promise<any>;
-    markReadNotification(): Promise<any>;
-    getUnseenNotification(): Promise<any>;
-    createCustomNotification(): Promise<any>;
-    listBroadcastMessages(): Promise<any>;
-    listBroadcastMessagesUnseenCount(): Promise<any>;
-    listBroadcastMessagesUndisposedCount(): Promise<any>;
-    markReadBroadcastMessages(): Promise<any>;
-    disposeBroadcastMessages(): Promise<any>;
+    listUserNotification(): Promise<SCNotificationAggregatedType>;
+    markReadNotification(sids: string[]): Promise<any>;
+    getUnseenNotification(): Promise<SCNotificationUnseenCountType>;
+    createCustomNotification(data: CustomNotificationParams): Promise<any>;
+    listBroadcastMessages(): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
+    listBroadcastMessagesUnseenCount(): Promise<SCNotificationUnseenCountType>;
+    listBroadcastMessagesUndisposedCount(): Promise<SCNotificationUnseenCountType>;
+    markReadBroadcastMessages(banner_ids: number[]): Promise<any>;
+    disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
 }
+/**
+ * Contains all the endpoints needed to manage notifications.
+ */
 export declare class NotificationApiClient {
-    static listUserNotification(): Promise<any>;
-    static markReadNotification(): Promise<any>;
-    static getUnseenNotification(): Promise<any>;
-    static createCustomNotification(): Promise<any>;
-    static listBroadcastMessages(): Promise<any>;
-    static listBroadcastMessagesUnseenCount(): Promise<any>;
-    static listBroadcastMessagesUndisposedCount(): Promise<any>;
-    static markReadBroadcastMessages(): Promise<any>;
-    static disposeBroadcastMessages(): Promise<any>;
+    /**
+     * List all user notifications (in aggregate form) related to the community.
+     */
+    static listUserNotification(): Promise<SCNotificationAggregatedType>;
+    /**
+     * This endpoint marks as read a list of notifications identified by serialization_ids (sids).
+     * @param sids
+     */
+    static markReadNotification(sids: string[]): Promise<any>;
+    /**
+     * This endpoint retrieves the number of unseen/unread notifications.
+     */
+    static getUnseenNotification(): Promise<SCNotificationUnseenCountType>;
+    /**
+     * This endpoint generates a custom notification starting from the user. The recipients of the notification can be the user's friends/followers or the user himself (based on recipients_type value). Es. connections -> "user" added an item to the wishlist.
+     * @param data
+     */
+    static createCustomNotification(data: CustomNotificationParams): Promise<any>;
+    /**
+     * This endpoint lists all broadcast messages. Broadcast Message is a feature which allows a specific user to send messages and announcements to a larger group of users at once.
+     */
+    static listBroadcastMessages(): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
+    /**
+     * This endpoint retrieves the total number of broadcast messages not yet seen by the user.
+     */
+    static listBroadcastMessagesUnseenCount(): Promise<SCNotificationUnseenCountType>;
+    /**
+     * This endpoint retrieves the total number of broadcast messages not yet disposed by the user.
+     */
+    static listBroadcastMessagesUndisposedCount(): Promise<SCNotificationUnseenCountType>;
+    /**
+     * This endpoint marks as viewed/read a broadcast message for a user.
+     * @param banner_ids
+     */
+    static markReadBroadcastMessages(banner_ids: number[]): Promise<any>;
+    /**
+     * This endpoint disposes a broadcast message for a user.
+     * @param banner_ids
+     */
+    static disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
 }
 export default class NotificationService {
-    static listUserNotification(): Promise<any>;
-    static markReadNotification(): Promise<any>;
-    static getUnseenNotification(): Promise<any>;
-    static createCustomNotification(): Promise<any>;
-    static listBroadcastMessages(): Promise<any>;
-    static listBroadcastMessagesUnseenCount(): Promise<any>;
-    static listBroadcastMessagesUndisposedCount(): Promise<any>;
-    static disposeBroadcastMessages(): Promise<any>;
-    static markReadBroadcastMessages(): Promise<any>;
+    static listUserNotification(): Promise<SCNotificationAggregatedType>;
+    static markReadNotification(sids: string[]): Promise<any>;
+    static getUnseenNotification(): Promise<SCNotificationUnseenCountType>;
+    static createCustomNotification(data: CustomNotificationParams): Promise<any>;
+    static listBroadcastMessages(): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
+    static listBroadcastMessagesUnseenCount(): Promise<SCNotificationUnseenCountType>;
+    static listBroadcastMessagesUndisposedCount(): Promise<SCNotificationUnseenCountType>;
+    static disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
+    static markReadBroadcastMessages(banner_ids: number[]): Promise<any>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,8BAA8B;IAC7C,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,gCAAgC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,oCAAoC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACrD,yBAAyB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1C,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CAC1C;AAED,qBAAa,qBAAqB;IAChC,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;IAkB3C,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB3C,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB5C,MAAM,CAAC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB/C,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB5C,MAAM,CAAC,gCAAgC,IAAI,OAAO,CAAC,GAAG,CAAC;IAkBvD,MAAM,CAAC,oCAAoC,IAAI,OAAO,CAAC,GAAG,CAAC;IAkB3D,MAAM,CAAC,yBAAyB,IAAI,OAAO,CAAC,GAAG,CAAC;IAkBhD,MAAM,CAAC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;CAkBhD;AAED,MAAM,CAAC,OAAO,OAAO,mBAAmB;WACzB,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGpC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGpC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGrC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGxC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGrC,gCAAgC,IAAI,OAAO,CAAC,GAAG,CAAC;WAGhD,oCAAoC,IAAI,OAAO,CAAC,GAAG,CAAC;WAGpD,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGxC,yBAAyB,IAAI,OAAO,CAAC,GAAG,CAAC;CAGvD"}
+{"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,4BAA4B,CAAC,CAAC;IAC9D,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,4BAA4B,CAAC;IAIpE;;;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,4BAA4B,CAAC;WAG7D,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/types/services/preference/index.d.ts

@@ -1,16 +1,35 @@
+import { SCPreferenceType } from '@selfcommunity/types/src/types';
+import { SCPaginatedResponse } from '../../types';
 export interface PreferenceApiClientInterface {
-    getAllPreferences(): Promise<any>;
-    searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<any>;
-    getSpecificPreference(id: number): Promise<any>;
+    getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
+    searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
+    getSpecificPreference(id: number): Promise<SCPreferenceType>;
 }
+/**
+ * Contains all the endpoints needed to manage dynamic preferences.
+ */
 export declare class PreferenceApiClient {
-    static getAllPreferences(): Promise<any>;
-    static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<any>;
-    static getSpecificPreference(id: number): Promise<any>;
+    /**
+     * This endpoint retrieves all available dynamic preferences.
+     */
+    static getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
+    /**
+     * This endpoint searches dynamic preferences.
+     * @param search
+     * @param section
+     * @param keys
+     * @param ordering
+     */
+    static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
+    /**
+     * This endpoint retrieves a specific dynamic preference.
+     * @param id
+     */
+    static getSpecificPreference(id: number): Promise<SCPreferenceType>;
 }
 export default class PreferenceService {
-    static getAllPreferences(): Promise<any>;
-    static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<any>;
-    static getSpecificPreference(id: number): Promise<any>;
+    static getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
+    static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
+    static getSpecificPreference(id: number): Promise<SCPreferenceType>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrG,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACjD;AAED,qBAAa,mBAAmB;IAC9B,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;IAoBxC,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,GAAG,CAAC;IA0B3G,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkBvD;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIjC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIpG,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG7D"}
+{"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"}