@selfcommunity/api-services 0.4.1-alpha.3 → 0.4.1-alpha.5

package/lib/cjs/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/cjs/services/account/index.js

@@ -66,7 +66,7 @@ class AccountApiClient {
 exports.AccountApiClient = 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/cjs/services/category/index.d.ts

@@ -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/cjs/services/category/index.js

@@ -149,7 +149,7 @@ class CategoryApiClient {
 exports.CategoryApiClient = 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/cjs/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/cjs/services/comment/index.js

@@ -105,7 +105,7 @@ class CommentApiClient {
 exports.CommentApiClient = 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/cjs/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/cjs/services/custom_adv/index.js

@@ -39,7 +39,7 @@ class CustomAdvApiClient {
 exports.CustomAdvApiClient = 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/cjs/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/cjs/services/custom_menu/index.js

@@ -46,7 +46,7 @@ class CustomMenuApiClient {
 exports.CustomMenuApiClient = 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/cjs/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/cjs/services/custom_page/index.js

@@ -39,7 +39,7 @@ class CustomPageApiClient {
 exports.CustomPageApiClient = 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/cjs/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/cjs/services/data_portability/index.js

@@ -33,7 +33,7 @@ class DataPortabilityApiClient {
 exports.DataPortabilityApiClient = 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/cjs/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/cjs/services/embed/index.js

@@ -83,7 +83,7 @@ class EmbedApiClient {
 exports.EmbedApiClient = 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/cjs/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/cjs/services/feature/index.js

@@ -22,7 +22,7 @@ class FeatureApiClient {
 exports.FeatureApiClient = 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/cjs/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/cjs/services/feed/index.js

@@ -54,7 +54,7 @@ class FeedApiClient {
 exports.FeedApiClient = 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/cjs/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/cjs/services/feed_object/index.js

@@ -278,7 +278,7 @@ class FeedObjectApiClient {
 exports.FeedObjectApiClient = 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/cjs/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/cjs/services/incubator/index.js

@@ -71,7 +71,7 @@ class IncubatorApiClient {
 exports.IncubatorApiClient = 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/cjs/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/cjs/services/insight/index.js

@@ -65,7 +65,7 @@ class InsightApiClient {
 exports.InsightApiClient = 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/cjs/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/cjs/services/legal_page/index.js

@@ -85,7 +85,7 @@ class LegalPageApiClient {
 exports.LegalPageApiClient = 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/cjs/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/cjs/services/locality/index.js

@@ -31,7 +31,7 @@ class LocalityApiClient {
 exports.LocalityApiClient = 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/cjs/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/cjs/services/loyalty/index.js

@@ -87,7 +87,7 @@ class LoyaltyApiClient {
 exports.LoyaltyApiClient = 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/cjs/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/cjs/services/media/index.js

@@ -76,7 +76,7 @@ class MediaApiClient {
 exports.MediaApiClient = 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/cjs/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:

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

@@ -73,7 +73,7 @@ class ModerationApiClient {
 exports.ModerationApiClient = 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/cjs/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/cjs/services/notification/index.js

@@ -79,7 +79,7 @@ class NotificationApiClient {
 exports.NotificationApiClient = 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/cjs/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/cjs/services/preference/index.js

@@ -40,7 +40,7 @@ class PreferenceApiClient {
 exports.PreferenceApiClient = 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/cjs/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/cjs/services/private_message/index.js

@@ -102,7 +102,7 @@ class PrivateMessageApiClient {
 exports.PrivateMessageApiClient = 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/cjs/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/cjs/services/promo/index.js

@@ -20,7 +20,7 @@ class PromoApiClient {
 exports.PromoApiClient = 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/cjs/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/cjs/services/reactions/index.js

@@ -45,7 +45,7 @@ class ReactionApiClient {
 exports.ReactionApiClient = 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/cjs/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/cjs/services/score/index.js

@@ -39,7 +39,7 @@ class ScoreApiClient {
 exports.ScoreApiClient = 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/cjs/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/cjs/services/sso/index.js

@@ -28,7 +28,7 @@ class SSOApiClient {
 exports.SSOApiClient = 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/cjs/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/cjs/services/suggestion/index.js

@@ -55,7 +55,7 @@ class SuggestionApiClient {
 exports.SuggestionApiClient = 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/cjs/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/cjs/services/tag/index.js

@@ -77,7 +77,7 @@ class TagApiClient {
 exports.TagApiClient = 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/cjs/services/user/index.d.ts

@@ -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

@@ -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

@@ -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: