@selfcommunity/api-services 0.1.6 → 0.1.7

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

@@ -1,16 +1,33 @@
+import { SCCustomAdvType } from '@selfcommunity/types';
+import { CustomAdvParams, SCPaginatedResponse } from '../../types';
 export interface CustomAdvApiClientInterface {
-    getASpecificCustomAdv(id: number): Promise<any>;
-    getAllCustomAdv(): Promise<any>;
-    searchCustomAdv(): Promise<any>;
+    getASpecificCustomAdv(id: number): Promise<SCPaginatedResponse<SCCustomAdvType>>;
+    getAllCustomAdv(params?: CustomAdvParams): Promise<SCPaginatedResponse<SCCustomAdvType>>;
+    searchCustomAdv(params?: CustomAdvParams): Promise<SCPaginatedResponse<SCCustomAdvType>>;
 }
+/**
+ * Contains all the endpoints needed to manage custom advs.
+ */
 export declare class CustomAdvApiClient {
-    static getASpecificCustomAdv(id: number): Promise<any>;
-    static getAllCustomAdv(): Promise<any>;
-    static searchCustomAdv(): Promise<any>;
+    /**
+     * This endpoint retrieves a specific custom adv.
+     * @param id
+     */
+    static getASpecificCustomAdv(id: number): Promise<SCPaginatedResponse<SCCustomAdvType>>;
+    /**
+     * This endpoint retrieves all custom advs.
+     * @param params
+     */
+    static getAllCustomAdv(params?: CustomAdvParams): Promise<SCPaginatedResponse<SCCustomAdvType>>;
+    /**
+     * This endpoint performs search of a Custom Adv
+     * @param params
+     */
+    static searchCustomAdv(params?: CustomAdvParams): Promise<SCPaginatedResponse<SCCustomAdvType>>;
 }
 export default class CustomAdvService {
-    static getASpecificCustomAdv(id: number): Promise<any>;
-    static getAllCustomAdv(): Promise<any>;
-    static searchCustomAdv(): Promise<any>;
+    static getASpecificCustomAdv(id: number): Promise<SCPaginatedResponse<SCCustomAdvType>>;
+    static getAllCustomAdv(params?: CustomAdvParams): Promise<SCPaginatedResponse<SCCustomAdvType>>;
+    static searchCustomAdv(params?: CustomAdvParams): Promise<SCPaginatedResponse<SCCustomAdvType>>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/custom_adv/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,2BAA2B;IAC1C,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAChD,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAChC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CACjC;AAED,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBtD,MAAM,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;IAkBtC,MAAM,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;CAkBvC;AAED,MAAM,CAAC,OAAO,OAAO,gBAAgB;WACtB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAG/C,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;WAG/B,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;CAG7C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/custom_adv/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEjE,MAAM,WAAW,2BAA2B;IAC1C,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACjF,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACzF,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;CAC1F;AACD;;GAEG;AAEH,qBAAa,kBAAkB;IAC7B;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAIvF;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAK/F;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;CAIhG;AAED,MAAM,CAAC,OAAO,OAAO,gBAAgB;WACtB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGhF,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGxF,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;CAGtG"}

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

@@ -1,16 +1,33 @@
+import { CustomPageParams, CustomPageSearchParams, SCPaginatedResponse } from '../../types';
+import { SCCustomPageType } from '@selfcommunity/types';
 export interface CustomPageApiClientInterface {
-    getASpecificCustomPage(id: number): Promise<any>;
-    getAllCustomPages(): Promise<any>;
-    searchCustomPages(): Promise<any>;
+    getASpecificCustomPage(id: number): Promise<SCCustomPageType>;
+    getAllCustomPages(params?: CustomPageParams): Promise<SCPaginatedResponse<SCCustomPageType>>;
+    searchCustomPages(params?: CustomPageSearchParams): Promise<SCPaginatedResponse<SCCustomPageType>>;
 }
+/**
+ * Contains all the endpoints needed to manage custom pages.
+ */
 export declare class CustomPageApiClient {
-    static getASpecificCustomPage(id: number): Promise<any>;
-    static getAllCustomPages(): Promise<any>;
-    static searchCustomPages(): Promise<any>;
+    /**
+     * This endpoint retrieves a specific custom page.
+     * @param id
+     */
+    static getASpecificCustomPage(id: number): Promise<SCCustomPageType>;
+    /**
+     * This endpoint retrieves all custom pages.
+     * @param params
+     */
+    static getAllCustomPages(params?: CustomPageParams): Promise<SCPaginatedResponse<SCCustomPageType>>;
+    /**
+     * This endpoint performs search of a Custom Page
+     * @param params
+     */
+    static searchCustomPages(params?: CustomPageSearchParams): Promise<SCPaginatedResponse<SCCustomPageType>>;
 }
 export default class CustomPageService {
-    static getASpecificCustomPage(id: number): Promise<any>;
-    static getAllCustomPages(): Promise<any>;
-    static searchCustomPages(): Promise<any>;
+    static getASpecificCustomPage(id: number): Promise<SCCustomPageType>;
+    static getAllCustomPages(params?: CustomPageParams): Promise<SCPaginatedResponse<SCCustomPageType>>;
+    static searchCustomPages(params?: CustomPageSearchParams): Promise<SCPaginatedResponse<SCCustomPageType>>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/custom_page/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,4BAA4B;IAC3C,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CACnC;AAED,qBAAa,mBAAmB;IAC9B,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBvD,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;IAkBxC,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;CAkBzC;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGhD,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGjC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC;CAG/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/custom_page/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAE,sBAAsB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAC1F,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAGtD,MAAM,WAAW,4BAA4B;IAC3C,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC9D,iBAAiB,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7F,iBAAiB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;CACpG;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;;OAGG;IACH,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIpE;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAKnG;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;CAI1G;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAG7D,iBAAiB,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAG5F,iBAAiB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;CAGhH"}

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

@@ -1,16 +1,29 @@
+import { SCDataPortabilityType } from '@selfcommunity/types';
 export interface DataPortabilityApiClientInterface {
-    generateDataPortability(): Promise<any>;
+    generateDataPortability(): Promise<SCDataPortabilityType>;
     downloadDataPortability(): Promise<any>;
-    dataPortabilityStatus(): Promise<any>;
+    dataPortabilityStatus(): Promise<SCDataPortabilityType>;
 }
+/**
+ * Contains all the endpoints needed to manage data portability.
+ */
 export declare class DataPortabilityApiClient {
-    static generateDataPortability(): Promise<any>;
+    /**
+     * This endpoint generates data portability.
+     */
+    static generateDataPortability(): Promise<SCDataPortabilityType>;
+    /**
+     * This endpoint downloads data portability.
+     */
     static downloadDataPortability(): Promise<any>;
-    static dataPortabilityStatus(): Promise<any>;
+    /**
+     * This endpoint retrieves data portability status.
+     */
+    static dataPortabilityStatus(): Promise<SCDataPortabilityType>;
 }
 export default class DataPortabilityService {
-    static generateDataPortability(): Promise<any>;
+    static generateDataPortability(): Promise<SCDataPortabilityType>;
     static downloadDataPortability(): Promise<any>;
-    static dataPortabilityStatus(): Promise<any>;
+    static dataPortabilityStatus(): Promise<SCDataPortabilityType>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/data_portability/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,iCAAiC;IAChD,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC;AAED,qBAAa,wBAAwB;IACnC,MAAM,CAAC,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB9C,MAAM,CAAC,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB9C,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;CAkB7C;AAED,MAAM,CAAC,OAAO,OAAO,sBAAsB;WAC5B,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGvC,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGvC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;CAGnD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/data_portability/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,qBAAqB,EAAC,MAAM,sBAAsB,CAAC;AAE3D,MAAM,WAAW,iCAAiC;IAChD,uBAAuB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC1D,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,qBAAqB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACzD;AACD;;GAEG;AAEH,qBAAa,wBAAwB;IACnC;;OAEG;IACH,MAAM,CAAC,uBAAuB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAIhE;;OAEG;IACH,MAAM,CAAC,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;IAI9C;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAG/D;AAED,MAAM,CAAC,OAAO,OAAO,sBAAsB;WAC5B,uBAAuB,IAAI,OAAO,CAAC,qBAAqB,CAAC;WAGzD,uBAAuB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGvC,qBAAqB,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAGrE"}

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

@@ -1,31 +1,69 @@
+import { BaseGetParams, EmbedSearchParams, EmbedUpdateParams, SCPaginatedResponse } from '../../types';
+import { SCEmbedType, SCFeedUnitType } from '@selfcommunity/types';
 export interface EmbedApiClientInterface {
-    getAllEmbeds(): Promise<any>;
-    createEmbed(): Promise<any>;
-    searchEmbed(): Promise<any>;
-    getSpecificEmbed(id: number): Promise<any>;
-    updateASpecificEmbed(id: number): Promise<any>;
-    patchASpecificEmbed(id: number): Promise<any>;
-    getEmbedFeed(id: number): Promise<any>;
-    getSpecificEmbedFeed(id: number): Promise<any>;
+    getAllEmbeds(params?: BaseGetParams): Promise<SCPaginatedResponse<SCEmbedType>>;
+    createEmbed(data: SCEmbedType): Promise<SCEmbedType>;
+    searchEmbed(params?: EmbedSearchParams): Promise<SCPaginatedResponse<SCEmbedType>>;
+    getSpecificEmbed(id: number): Promise<SCEmbedType>;
+    updateASpecificEmbed(id: number, data?: EmbedUpdateParams): Promise<SCEmbedType>;
+    patchASpecificEmbed(id: number, data?: EmbedUpdateParams): Promise<SCEmbedType>;
+    getEmbedFeed(): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    getSpecificEmbedFeed(id: number): Promise<SCPaginatedResponse<SCFeedUnitType>>;
 }
+/**
+ * Contains all the endpoints needed to manage embeds.
+ */
 export declare class EmbedApiClient {
-    static getAllEmbeds(): Promise<any>;
-    static createEmbed(): Promise<any>;
-    static searchEmbed(): Promise<any>;
-    static getSpecificEmbed(id: number): Promise<any>;
-    static updateASpecificEmbed(id: number): Promise<any>;
-    static patchASpecificEmbed(id: number): Promise<any>;
-    static getEmbedFeed(id: number): Promise<any>;
-    static getSpecificEmbedFeed(id: number): Promise<any>;
+    /**
+     * This endpoint retrieves all embeds.
+     * @param params
+     */
+    static getAllEmbeds(params?: BaseGetParams): Promise<SCPaginatedResponse<SCEmbedType>>;
+    /**
+     * This endpoint creates an embed.
+     * @param data
+     */
+    static createEmbed(data: SCEmbedType): Promise<SCEmbedType>;
+    /**
+     * This endpoint performs embed search.
+     * @param params
+     */
+    static searchEmbed(params?: EmbedSearchParams): Promise<SCPaginatedResponse<SCEmbedType>>;
+    /**
+     * This endpoint retrieves a specific embed using ID.
+     * @param id
+     */
+    static getSpecificEmbed(id: number): Promise<SCEmbedType>;
+    /**
+     * This endpoint updates a specific embed.
+     * @param id
+     * @param data
+     */
+    static updateASpecificEmbed(id: number, data?: EmbedUpdateParams): Promise<SCEmbedType>;
+    /**
+     * This endpoint patches a specific embed.
+     * @param id
+     * @param data
+     */
+    static patchASpecificEmbed(id: number, data?: EmbedUpdateParams): Promise<SCEmbedType>;
+    /**
+     * This endpoint retrieves the embed's feed which contains Feed that has the Embed as associated media.
+     */
+    static getEmbedFeed(): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    /**
+     * This endpoint retrieves the embed's feed which contains Feed that has an Embed as associated media.
+     * @param id
+     */
+    static getSpecificEmbedFeed(id: number): Promise<SCPaginatedResponse<SCFeedUnitType>>;
 }
 export default class EmbedService {
-    static getAllEmbeds(): Promise<any>;
-    static searchEmbed(): Promise<any>;
-    static createEmbed(): Promise<any>;
-    static getSpecificEmbed(id: number): Promise<any>;
-    static updateASpecificEmbed(id: number): Promise<any>;
-    static patchASpecificEmbed(id: number): Promise<any>;
-    static getEmbedFeed(id: number): Promise<any>;
-    static getSpecificEmbedFeed(id: number): Promise<any>;
+    static getAllEmbeds(params?: BaseGetParams): Promise<SCPaginatedResponse<SCEmbedType>>;
+    static searchEmbed(params?: EmbedSearchParams): Promise<SCPaginatedResponse<SCEmbedType>>;
+    static createEmbed(data: SCEmbedType): Promise<SCEmbedType>;
+    static getSpecificEmbed(id: number): Promise<SCEmbedType>;
+    static updateASpecificEmbed(id: number, data?: EmbedUpdateParams): Promise<SCEmbedType>;
+    static patchASpecificEmbed(id: number, data?: EmbedUpdateParams): Promise<SCEmbedType>;
+    static getEmbedFeed(): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    static getSpecificEmbedFeed(id: number): Promise<SCPaginatedResponse<SCFeedUnitType>>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/embed/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,uBAAuB;IACtC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/C,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9C,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAChD;AAED,qBAAa,cAAc;IACzB,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBnC,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBlC,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBlC,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBjD,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBrD,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBpD,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB7C,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkBtD;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;WAI5B,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;WAI3B,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;WAI3B,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI1C,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI9C,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI7C,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAItC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG5D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/embed/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAGrG,OAAO,EAAC,WAAW,EAAE,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAEjE,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IAChF,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACrD,WAAW,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IACnF,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACjF,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,YAAY,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7D,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;CAChF;AACD;;GAEG;AAEH,qBAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAKtF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3D;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAKzF;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzD;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIvF;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAItF;;OAEG;IACH,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAGtF;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,YAAY,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;WAI/E,WAAW,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;WAIlF,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;WAIpD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAIlD,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIhF,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI/E,YAAY,IAAI,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAI5D,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAG5F"}

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

@@ -1,10 +1,18 @@
+import { SCPaginatedResponse } from '../../types';
+import { SCFeatureType } from '@selfcommunity/types';
 export interface FeatureApiClientInterface {
-    getAllFeatures(): Promise<any>;
+    getAllFeatures(): Promise<SCPaginatedResponse<SCFeatureType[]>>;
 }
+/**
+ * Contains all the endpoints needed to manage features.
+ */
 export declare class FeatureApiClient {
-    static getAllFeatures(): Promise<any>;
+    /**
+     * This endpoint retrieves all features.
+     */
+    static getAllFeatures(): Promise<SCPaginatedResponse<SCFeatureType[]>>;
 }
 export default class FeatureService {
-    static getAllFeatures(): Promise<any>;
+    static getAllFeatures(): Promise<SCPaginatedResponse<SCFeatureType[]>>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/feature/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,yBAAyB;IACxC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CAChC;AAED,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;CAmBtC;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;CAG5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/feature/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAGhD,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AAEnD,MAAM,WAAW,yBAAyB;IACxC,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;CACjE;AACD;;GAEG;AAEH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC,CAAC;CAGvE;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC,CAAC;CAG7E"}

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

@@ -1,22 +1,44 @@
+import { SCFeedUnitType, SCFeedUnseenCountType } from '@selfcommunity/types';
+import { FeedParams, SCPaginatedResponse } from '../../types';
 export interface FeedApiClientInterface {
-    getMainFeed(): Promise<any>;
-    getExploreFeed(): Promise<any>;
-    getMainFeedUnseenCount(): Promise<any>;
-    markReadASpecificFeedObj(): Promise<any>;
-    likeFeedObjs(): Promise<any>;
+    getMainFeed(params?: FeedParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    getExploreFeed(params?: FeedParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    getMainFeedUnseenCount(): Promise<SCFeedUnseenCountType>;
+    markReadASpecificFeedObj(object: number[]): Promise<any>;
+    likeFeedObjs(object: number[]): Promise<SCPaginatedResponse<SCFeedUnitType>>;
 }
+/**
+ * Contains all the endpoints needed to manage feed.
+ */
 export declare class FeedApiClient {
-    static getMainFeed(): Promise<any>;
-    static getExploreFeed(): Promise<any>;
-    static getMainFeedUnseenCount(): Promise<any>;
-    static markReadASpecificFeedObj(): Promise<any>;
-    static likeFeedObjs(): Promise<any>;
+    /**
+     * This endpoint retrieves the main (home) feed.
+     * @param params
+     */
+    static getMainFeed(params?: FeedParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    /**
+     * This endpoint retrieves the explore feed. This endpoint can be disabled by setting explore_stream_enabled community option to false.
+     * @param params
+     */
+    static getExploreFeed(params?: FeedParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    /**
+     * This endpoint retrieves Main Feed unseen count.
+     */
+    static getMainFeedUnseenCount(): Promise<SCFeedUnseenCountType>;
+    /**
+     * This endpoint marks as read a list of objects in the feed. Usually it is called when a Feed object enter the viewport of the user.
+     */
+    static markReadASpecificFeedObj(object: number[]): Promise<any>;
+    /**
+     * This endpoint retrieves a list of Feed objects similar to the id of passed objects
+     */
+    static likeFeedObjs(object: number[]): Promise<SCPaginatedResponse<SCFeedUnitType>>;
 }
 export default class FeedService {
-    static getMainFeed(): Promise<any>;
-    static getExploreFeed(): Promise<any>;
-    static getMainFeedUnseenCount(): Promise<any>;
-    static markReadASpecificFeedObj(): Promise<any>;
-    static likeFeedObjs(): Promise<any>;
+    static getMainFeed(params?: FeedParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    static getExploreFeed(params?: FeedParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
+    static getMainFeedUnseenCount(): Promise<SCFeedUnseenCountType>;
+    static markReadASpecificFeedObj(object: number[]): Promise<any>;
+    static likeFeedObjs(object: number[]): Promise<SCPaginatedResponse<SCFeedUnitType>>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/feed/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,sBAAsB;IACrC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,sBAAsB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CAC9B;AAED,qBAAa,aAAa;IACxB,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBlC,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;IAkBrC,MAAM,CAAC,sBAAsB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB7C,MAAM,CAAC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB/C,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;CAkBpC;AAED,MAAM,CAAC,OAAO,OAAO,WAAW;WACjB,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;WAG3B,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;WAI9B,sBAAsB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGtC,wBAAwB,IAAI,OAAO,CAAC,GAAG,CAAC;WAGxC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;CAG1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/feed/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,cAAc,EAAE,qBAAqB,EAAC,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAC,UAAU,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAE5D,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC/E,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,sBAAsB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACzD,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;CAC9E;AACD;;GAEG;AAEH,qBAAa,aAAa;IACxB;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAKrF;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAKxF;;OAEG;IACH,MAAM,CAAC,sBAAsB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAI/D;;OAEG;IACH,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/D;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAGpF;AAED,MAAM,CAAC,OAAO,OAAO,WAAW;WACjB,WAAW,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAG9E,cAAc,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAIjF,sBAAsB,IAAI,OAAO,CAAC,qBAAqB,CAAC;WAGxD,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxD,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAG1F"}