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

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
      */
@@ -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/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
      */
@@ -453,7 +453,7 @@ class UserApiClient {
 exports.UserApiClient = 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/cjs/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/cjs/services/webhook/index.js

@@ -110,7 +110,7 @@ class WebhookApiClient {
 exports.WebhookApiClient = 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/cjs/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/cjs/utils/token.js

@@ -5,7 +5,7 @@ const tslib_1 = require("tslib");
 const jose = tslib_1.__importStar(require("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/lib/esm/services/account/index.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -27,7 +27,7 @@ export declare class DataPortabilityApiClient {
 }
 /**
  *
- :::tipData Portability service can be used in the following way:
+ :::tip Data Portability service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -29,7 +29,7 @@ export class DataPortabilityApiClient {
 }
 /**
  *
- :::tipData Portability service can be used in the following way:
+ :::tip Data Portability service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

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

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

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

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

@@ -17,7 +17,7 @@ export declare class FeatureApiClient {
 }
 /**
  *
- :::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/feature/index.js

@@ -18,7 +18,7 @@ export class FeatureApiClient {
 }
 /**
  *
- :::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/feed/index.d.ts

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

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

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

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

@@ -236,7 +236,7 @@ export declare class FeedObjectApiClient {
 }
 /**
  *
- :::tipFeed Object service can be used in the following way:
+ :::tip Feed Object service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

@@ -274,7 +274,7 @@ export class FeedObjectApiClient {
 }
 /**
  *
- :::tipFeed Object service can be used in the following way:
+ :::tip Feed Object service can be used in the following way:
 
  ```jsx
  1. Import the service from our library:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -60,7 +60,7 @@ export declare 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: