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

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

@@ -69,7 +69,7 @@ export class ModerationApiClient {
 }
 /**
  *
- :::tipModeration service can be used in the following way:
+ :::tip Moderation service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -68,7 +68,7 @@ export declare class NotificationApiClient {
 }
 /**
  *
- :::tipNotification service can be used in the following way:
+ :::tip Notification service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -75,7 +75,7 @@ export class NotificationApiClient {
 }
 /**
  *
- :::tipNotification service can be used in the following way:
+ :::tip Notification service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -33,7 +33,7 @@ export declare class PreferenceApiClient {
 }
 /**
  *
- :::tipPreference service can be used in the following way:
+ :::tip Preference service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -36,7 +36,7 @@ export class PreferenceApiClient {
 }
 /**
  *
- :::tipPreference service can be used in the following way:
+ :::tip Preference service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -86,7 +86,7 @@ export declare class PrivateMessageApiClient {
 }
 /**
  *
- :::tipPrivate Message service can be used in the following way:
+ :::tip Private Message service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -98,7 +98,7 @@ export class PrivateMessageApiClient {
 }
 /**
  *
- :::tipPrivate Message service can be used in the following way:
+ :::tip Private Message service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -16,7 +16,7 @@ export declare class PromoApiClient {
 }
 /**
  *
- :::tip Promo service can be used in the following way:
+ :::tip  Promo service can be used in the following way:
  ```jsx
  1. Import the service from our library:
 

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

@@ -16,7 +16,7 @@ export class PromoApiClient {
 }
 /**
  *
- :::tip Promo service can be used in the following way:
+ :::tip  Promo service can be used in the following way:
  ```jsx
  1. Import the service from our library:
 

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

@@ -30,7 +30,7 @@ export declare class ReactionApiClient {
 }
 /**
  *
- :::tipFeature service can be used in the following way:
+ :::tip Feature service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -41,7 +41,7 @@ export class ReactionApiClient {
 }
 /**
  *
- :::tipFeature service can be used in the following way:
+ :::tip Feature service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -31,7 +31,7 @@ export declare class ScoreApiClient {
 }
 /**
  *
- :::tipScore service can be used in the following way:
+ :::tip Score service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -35,7 +35,7 @@ export class ScoreApiClient {
 }
 /**
  *
- :::tipScore service can be used in the following way:
+ :::tip Score service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -24,7 +24,7 @@ export declare class SSOApiClient {
 }
 /**
  *
- :::tipSSO service can be used in the following way:
+ :::tip SSO service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -24,7 +24,7 @@ export class SSOApiClient {
 }
 /**
  *
- :::tipSSO service can be used in the following way:
+ :::tip SSO service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -46,7 +46,7 @@ export declare class SuggestionApiClient {
 }
 /**
  *
- :::tipSuggestion service can be used in the following way:
+ :::tip Suggestion service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -51,7 +51,7 @@ export class SuggestionApiClient {
 }
 /**
  *
- :::tipSuggestion service can be used in the following way:
+ :::tip Suggestion service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -65,7 +65,7 @@ export declare class TagApiClient {
 }
 /**
  *
- :::tipTag service can be used in the following way:
+ :::tip Tag service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -73,7 +73,7 @@ export class TagApiClient {
 }
 /**
  *
- :::tipTag service can be used in the following way:
+ :::tip Tag service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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
      */
@@ -385,7 +385,7 @@ export declare class UserApiClient {
 }
 /**
  *
- :::tipUser service can be used in the following way:
+ :::tip User service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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
      */
@@ -449,7 +449,7 @@ export class UserApiClient {
 }
 /**
  *
- :::tipUser service can be used in the following way:
+ :::tip User service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -97,7 +97,7 @@ export declare class WebhookApiClient {
 }
 /**
  *
- :::tipWebhook service can be used in the following way:
+ :::tip Webhook service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -106,7 +106,7 @@ export class WebhookApiClient {
 }
 /**
  *
- :::tipWebhook service can be used in the following way:
+ :::tip Webhook service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

package/lib/esm/utils/token.d.ts

@@ -1,6 +1,6 @@
 /**
  * Generate a JWT
- :::tipContext can be consumed as following:
+ :::tip Context can be consumed as following:
  ```jsx
  1. const token = await generateJWTToken(userId, secretKey, expirationTime);
  ```

package/lib/esm/utils/token.js

@@ -2,7 +2,7 @@ import { __awaiter } from "tslib";
 import * as jose from 'jose';
 /**
  * Generate a JWT
- :::tipContext can be consumed as following:
+ :::tip Context can be consumed as following:
  ```jsx
  1. const token = await generateJWTToken(userId, secretKey, expirationTime);
  ```

package/package.json

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