@selfcommunity/api-services 0.4.1-alpha.0 → 0.4.1-alpha.2

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

@@ -62,7 +62,7 @@ export declare class CategoryApiClient {
      */
     static patchASpecificCategory(id: number | string, data: SCCategoryType, config?: AxiosRequestConfig): Promise<SCCategoryType>;
     /**
-     * This endpoint deletes a specific category identified by {id}.
+     * This endpoint deletes a specific category identified by \{id}.
      * @param id
      * @param config
      */

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

@@ -62,7 +62,7 @@ class CategoryApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign({ url: Endpoints_1.default.PatchCategory.url({ id }), method: Endpoints_1.default.PatchCategory.method, data: data }, config));
     }
     /**
-     * This endpoint deletes a specific category identified by {id}.
+     * This endpoint deletes a specific category identified by \{id}.
      * @param id
      * @param config
      */

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

@@ -111,14 +111,14 @@ export declare class UserApiClient {
      */
     static userUpdate(id: number | string, data?: SCUserType, config?: AxiosRequestConfig): Promise<SCUserType>;
     /**
-     * This endpoint patches a specific user identified by {id}
+     * This endpoint patches a specific user identified by \{id}
      * @param id
      * @param data
      * @param config
      */
     static userPatch(id: number | string, data?: SCUserType, config?: AxiosRequestConfig): Promise<SCUserType>;
     /**
-     * This endpoint deletes a specific user identified by {id}
+     * This endpoint deletes a specific user identified by \{id}
      * @param id
      * @param hard
      * @param config
@@ -190,27 +190,27 @@ export declare class UserApiClient {
      */
     static getUserFollowedCategories(id: number | string, mutual?: number, config?: AxiosRequestConfig): Promise<SCCategoryType[]>;
     /**
-     * This endpoint retrieves the list of posts of the user identified by {id}
+     * This endpoint retrieves the list of posts of the user identified by \{id}
      * @param id
      * @param config
      */
     static getUserFeed(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedUnitType>>;
     /**
-     * This endpoint retrieves the list of followers of a specific user identified by {id}
+     * This endpoint retrieves the list of followers of a specific user identified by \{id}
      * @param id
      * @param mutual
      * @param config
      */
     static getUserFollowers(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
     /**
-     * This endpoint retrieves the list of following of a specific user identified by {id}.
+     * This endpoint retrieves the list of following of a specific user identified by \{id}.
      * @param id
      * @param mutual
      * @param config
      */
     static getUserFollowings(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
     /**
-     * This endpoint allows a user to follow another user identified by {id}
+     * This endpoint allows a user to follow another user identified by \{id}
      * @param id
      * @param config
      */
@@ -253,25 +253,25 @@ export declare class UserApiClient {
      */
     static getUserRequestConnectionsSent(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserConnectionRequestType>>;
     /**
-     * This endpoint accepts a request connection of the user identified by {id}
+     * This endpoint accepts a request connection of the user identified by \{id}
      * @param id
      * @param config
      */
     static userAcceptRequestConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint requests a connection to the user identified by {id}
+     * This endpoint requests a connection to the user identified by \{id}
      * @param id
      * @param config
      */
     static userRequestConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint removes connection with the user identified by {id}
+     * This endpoint removes connection with the user identified by \{id}
      * @param id
      * @param config
      */
     static userRemoveConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint cancels reject connection to a user identified by {id}
+     * This endpoint cancels reject connection to a user identified by \{id}
      * @param id
      * @param config
      */
@@ -283,19 +283,19 @@ export declare class UserApiClient {
      */
     static userCancelRequestConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint rejects a connection request sent from user identified by {id}
+     * This endpoint rejects a connection request sent from user identified by \{id}
      * @param id
      * @param config
      */
     static userRejectConnectionRequest(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint marks seen a connection request of user identified by {id} for the authenticated user.
+     * This endpoint marks seen a connection request of user identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */
     static userMarkSeenConnectionRequest(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint shows/hides a user (and its posts) identified by {id} for the authenticated user.
+     * This endpoint shows/hides a user (and its posts) identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */

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

@@ -82,7 +82,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserUpdate.url({ id }), method: Endpoints_1.default.UserUpdate.method, data: data }));
     }
     /**
-     * This endpoint patches a specific user identified by {id}
+     * This endpoint patches a specific user identified by \{id}
      * @param id
      * @param data
      * @param config
@@ -91,7 +91,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserPatch.url({ id }), method: Endpoints_1.default.UserPatch.method, data: data }));
     }
     /**
-     * This endpoint deletes a specific user identified by {id}
+     * This endpoint deletes a specific user identified by \{id}
      * @param id
      * @param hard
      * @param config
@@ -194,7 +194,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.FollowedCategories.url({ id })}?${p.toString()}`, method: Endpoints_1.default.FollowedCategories.method }));
     }
     /**
-     * This endpoint retrieves the list of posts of the user identified by {id}
+     * This endpoint retrieves the list of posts of the user identified by \{id}
      * @param id
      * @param config
      */
@@ -202,7 +202,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserFeed.url({ id }), method: Endpoints_1.default.UserFeed.method, params }));
     }
     /**
-     * This endpoint retrieves the list of followers of a specific user identified by {id}
+     * This endpoint retrieves the list of followers of a specific user identified by \{id}
      * @param id
      * @param mutual
      * @param config
@@ -211,7 +211,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserFollowers.url({ id }), method: Endpoints_1.default.UserFollowers.method, params }));
     }
     /**
-     * This endpoint retrieves the list of following of a specific user identified by {id}.
+     * This endpoint retrieves the list of following of a specific user identified by \{id}.
      * @param id
      * @param mutual
      * @param config
@@ -220,7 +220,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserFollowings.url({ id }), method: Endpoints_1.default.UserFollowings.method, params }));
     }
     /**
-     * This endpoint allows a user to follow another user identified by {id}
+     * This endpoint allows a user to follow another user identified by \{id}
      * @param id
      * @param config
      */
@@ -277,7 +277,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserRequestConnectionsSent.url(), method: Endpoints_1.default.UserRequestConnectionsSent.method, params }));
     }
     /**
-     * This endpoint accepts a request connection of the user identified by {id}
+     * This endpoint accepts a request connection of the user identified by \{id}
      * @param id
      * @param config
      */
@@ -285,7 +285,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserAcceptRequestConnection.url({ id }), method: Endpoints_1.default.UserAcceptRequestConnection.method }));
     }
     /**
-     * This endpoint requests a connection to the user identified by {id}
+     * This endpoint requests a connection to the user identified by \{id}
      * @param id
      * @param config
      */
@@ -293,7 +293,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserRequestConnection.url({ id }), method: Endpoints_1.default.UserRequestConnection.method }));
     }
     /**
-     * This endpoint removes connection with the user identified by {id}
+     * This endpoint removes connection with the user identified by \{id}
      * @param id
      * @param config
      */
@@ -301,7 +301,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserRemoveConnection.url({ id }), method: Endpoints_1.default.UserRemoveConnection.method }));
     }
     /**
-     * This endpoint cancels reject connection to a user identified by {id}
+     * This endpoint cancels reject connection to a user identified by \{id}
      * @param id
      * @param config
      */
@@ -317,7 +317,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserCancelRequestConnection.url({ id }), method: Endpoints_1.default.UserCancelRequestConnection.method }));
     }
     /**
-     * This endpoint rejects a connection request sent from user identified by {id}
+     * This endpoint rejects a connection request sent from user identified by \{id}
      * @param id
      * @param config
      */
@@ -325,7 +325,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserRejectConnectionRequest.url({ id }), method: Endpoints_1.default.UserRejectConnectionRequest.method }));
     }
     /**
-     * This endpoint marks seen a connection request of user identified by {id} for the authenticated user.
+     * This endpoint marks seen a connection request of user identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */
@@ -333,7 +333,7 @@ class UserApiClient {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserMarkSeenConnectionRequest.url({ id }), method: Endpoints_1.default.UserMarkSeenConnectionRequest.method }));
     }
     /**
-     * This endpoint shows/hides a user (and its posts) identified by {id} for the authenticated user.
+     * This endpoint shows/hides a user (and its posts) identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */

package/lib/cjs/types/insight.d.ts

@@ -51,7 +51,7 @@ export interface InsightEmbedParams extends InsightCommonParams {
      */
     grouped_by?: string;
     /**
-     * A json dict containing some TERM_KEYs (eg: \{"authors": ["Umberto Eco", "Neil Gaiman"], "type": "book"}). Usable only if group_by is set.
+     * A json dict containing some TERM_KEYs. Usable only if group_by is set.
      */
     metadata?: {};
 }

package/lib/esm/services/category/index.d.ts

@@ -62,7 +62,7 @@ export declare class CategoryApiClient {
      */
     static patchASpecificCategory(id: number | string, data: SCCategoryType, config?: AxiosRequestConfig): Promise<SCCategoryType>;
     /**
-     * This endpoint deletes a specific category identified by {id}.
+     * This endpoint deletes a specific category identified by \{id}.
      * @param id
      * @param config
      */

package/lib/esm/services/category/index.js

@@ -59,7 +59,7 @@ export class CategoryApiClient {
         return apiRequest(Object.assign({ url: Endpoints.PatchCategory.url({ id }), method: Endpoints.PatchCategory.method, data: data }, config));
     }
     /**
-     * This endpoint deletes a specific category identified by {id}.
+     * This endpoint deletes a specific category identified by \{id}.
      * @param id
      * @param config
      */

package/lib/esm/services/user/index.d.ts

@@ -111,14 +111,14 @@ export declare class UserApiClient {
      */
     static userUpdate(id: number | string, data?: SCUserType, config?: AxiosRequestConfig): Promise<SCUserType>;
     /**
-     * This endpoint patches a specific user identified by {id}
+     * This endpoint patches a specific user identified by \{id}
      * @param id
      * @param data
      * @param config
      */
     static userPatch(id: number | string, data?: SCUserType, config?: AxiosRequestConfig): Promise<SCUserType>;
     /**
-     * This endpoint deletes a specific user identified by {id}
+     * This endpoint deletes a specific user identified by \{id}
      * @param id
      * @param hard
      * @param config
@@ -190,27 +190,27 @@ export declare class UserApiClient {
      */
     static getUserFollowedCategories(id: number | string, mutual?: number, config?: AxiosRequestConfig): Promise<SCCategoryType[]>;
     /**
-     * This endpoint retrieves the list of posts of the user identified by {id}
+     * This endpoint retrieves the list of posts of the user identified by \{id}
      * @param id
      * @param config
      */
     static getUserFeed(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedUnitType>>;
     /**
-     * This endpoint retrieves the list of followers of a specific user identified by {id}
+     * This endpoint retrieves the list of followers of a specific user identified by \{id}
      * @param id
      * @param mutual
      * @param config
      */
     static getUserFollowers(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
     /**
-     * This endpoint retrieves the list of following of a specific user identified by {id}.
+     * This endpoint retrieves the list of following of a specific user identified by \{id}.
      * @param id
      * @param mutual
      * @param config
      */
     static getUserFollowings(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
     /**
-     * This endpoint allows a user to follow another user identified by {id}
+     * This endpoint allows a user to follow another user identified by \{id}
      * @param id
      * @param config
      */
@@ -253,25 +253,25 @@ export declare class UserApiClient {
      */
     static getUserRequestConnectionsSent(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserConnectionRequestType>>;
     /**
-     * This endpoint accepts a request connection of the user identified by {id}
+     * This endpoint accepts a request connection of the user identified by \{id}
      * @param id
      * @param config
      */
     static userAcceptRequestConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint requests a connection to the user identified by {id}
+     * This endpoint requests a connection to the user identified by \{id}
      * @param id
      * @param config
      */
     static userRequestConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint removes connection with the user identified by {id}
+     * This endpoint removes connection with the user identified by \{id}
      * @param id
      * @param config
      */
     static userRemoveConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint cancels reject connection to a user identified by {id}
+     * This endpoint cancels reject connection to a user identified by \{id}
      * @param id
      * @param config
      */
@@ -283,19 +283,19 @@ export declare class UserApiClient {
      */
     static userCancelRequestConnection(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint rejects a connection request sent from user identified by {id}
+     * This endpoint rejects a connection request sent from user identified by \{id}
      * @param id
      * @param config
      */
     static userRejectConnectionRequest(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint marks seen a connection request of user identified by {id} for the authenticated user.
+     * This endpoint marks seen a connection request of user identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */
     static userMarkSeenConnectionRequest(id: number | string, config?: AxiosRequestConfig): Promise<any>;
     /**
-     * This endpoint shows/hides a user (and its posts) identified by {id} for the authenticated user.
+     * This endpoint shows/hides a user (and its posts) identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */

package/lib/esm/services/user/index.js

@@ -79,7 +79,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserUpdate.url({ id }), method: Endpoints.UserUpdate.method, data: data }));
     }
     /**
-     * This endpoint patches a specific user identified by {id}
+     * This endpoint patches a specific user identified by \{id}
      * @param id
      * @param data
      * @param config
@@ -88,7 +88,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserPatch.url({ id }), method: Endpoints.UserPatch.method, data: data }));
     }
     /**
-     * This endpoint deletes a specific user identified by {id}
+     * This endpoint deletes a specific user identified by \{id}
      * @param id
      * @param hard
      * @param config
@@ -191,7 +191,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.FollowedCategories.url({ id })}?${p.toString()}`, method: Endpoints.FollowedCategories.method }));
     }
     /**
-     * This endpoint retrieves the list of posts of the user identified by {id}
+     * This endpoint retrieves the list of posts of the user identified by \{id}
      * @param id
      * @param config
      */
@@ -199,7 +199,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserFeed.url({ id }), method: Endpoints.UserFeed.method, params }));
     }
     /**
-     * This endpoint retrieves the list of followers of a specific user identified by {id}
+     * This endpoint retrieves the list of followers of a specific user identified by \{id}
      * @param id
      * @param mutual
      * @param config
@@ -208,7 +208,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserFollowers.url({ id }), method: Endpoints.UserFollowers.method, params }));
     }
     /**
-     * This endpoint retrieves the list of following of a specific user identified by {id}.
+     * This endpoint retrieves the list of following of a specific user identified by \{id}.
      * @param id
      * @param mutual
      * @param config
@@ -217,7 +217,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserFollowings.url({ id }), method: Endpoints.UserFollowings.method, params }));
     }
     /**
-     * This endpoint allows a user to follow another user identified by {id}
+     * This endpoint allows a user to follow another user identified by \{id}
      * @param id
      * @param config
      */
@@ -274,7 +274,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserRequestConnectionsSent.url(), method: Endpoints.UserRequestConnectionsSent.method, params }));
     }
     /**
-     * This endpoint accepts a request connection of the user identified by {id}
+     * This endpoint accepts a request connection of the user identified by \{id}
      * @param id
      * @param config
      */
@@ -282,7 +282,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserAcceptRequestConnection.url({ id }), method: Endpoints.UserAcceptRequestConnection.method }));
     }
     /**
-     * This endpoint requests a connection to the user identified by {id}
+     * This endpoint requests a connection to the user identified by \{id}
      * @param id
      * @param config
      */
@@ -290,7 +290,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserRequestConnection.url({ id }), method: Endpoints.UserRequestConnection.method }));
     }
     /**
-     * This endpoint removes connection with the user identified by {id}
+     * This endpoint removes connection with the user identified by \{id}
      * @param id
      * @param config
      */
@@ -298,7 +298,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserRemoveConnection.url({ id }), method: Endpoints.UserRemoveConnection.method }));
     }
     /**
-     * This endpoint cancels reject connection to a user identified by {id}
+     * This endpoint cancels reject connection to a user identified by \{id}
      * @param id
      * @param config
      */
@@ -314,7 +314,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserCancelRequestConnection.url({ id }), method: Endpoints.UserCancelRequestConnection.method }));
     }
     /**
-     * This endpoint rejects a connection request sent from user identified by {id}
+     * This endpoint rejects a connection request sent from user identified by \{id}
      * @param id
      * @param config
      */
@@ -322,7 +322,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserRejectConnectionRequest.url({ id }), method: Endpoints.UserRejectConnectionRequest.method }));
     }
     /**
-     * This endpoint marks seen a connection request of user identified by {id} for the authenticated user.
+     * This endpoint marks seen a connection request of user identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */
@@ -330,7 +330,7 @@ export class UserApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserMarkSeenConnectionRequest.url({ id }), method: Endpoints.UserMarkSeenConnectionRequest.method }));
     }
     /**
-     * This endpoint shows/hides a user (and its posts) identified by {id} for the authenticated user.
+     * This endpoint shows/hides a user (and its posts) identified by \{id} for the authenticated user.
      * @param id
      * @param config
      */

package/lib/esm/types/insight.d.ts

@@ -51,7 +51,7 @@ export interface InsightEmbedParams extends InsightCommonParams {
      */
     grouped_by?: string;
     /**
-     * A json dict containing some TERM_KEYs (eg: \{"authors": ["Umberto Eco", "Neil Gaiman"], "type": "book"}). Usable only if group_by is set.
+     * A json dict containing some TERM_KEYs. Usable only if group_by is set.
      */
     metadata?: {};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@selfcommunity/api-services",
-  "version": "0.4.1-alpha.0",
+  "version": "0.4.1-alpha.2",
   "license": "MIT",
   "private": false,
   "main": "./lib/cjs/index.js",
@@ -110,5 +110,5 @@
   "bugs": {
     "url": "https://github.com/selfcommunity/community-js/issues"
   },
-  "gitHead": "6c7ca8799f91ab35fb6f72422792d478c61146fc"
+  "gitHead": "e41e3390cbc028a59266ad02eef3687f7130a198"
 }