@selfcommunity/api-services 0.4.50-events.70 → 0.4.50-events.76

package/lib/cjs/constants/Endpoints.js

@@ -61,6 +61,10 @@ const Endpoints = {
         url: (0, utils_1.urlReplacer)('/api/v2/dynamic_preference/$(id)/'),
         method: 'GET'
     },
+    UpdatePreferences: {
+        url: (0, utils_1.urlReplacer)('/api/v2/dynamic_preference/'),
+        method: 'PATCH'
+    },
     /**
      * SSO Endpoints
      */
@@ -1319,6 +1323,25 @@ const Endpoints = {
     HideEvent: {
         url: (0, utils_1.urlReplacer)('/api/v2/event/$(id)/hide/'),
         method: 'POST'
+    },
+    /**
+     * OnBoarding
+     */
+    GetAllSteps: {
+        url: (0, utils_1.urlReplacer)('/api/v2/onboarding/'),
+        method: 'GET'
+    },
+    GetAStep: {
+        url: (0, utils_1.urlReplacer)('/api/v2/onboarding/$(step)/'),
+        method: 'GET'
+    },
+    StartAStep: {
+        url: (0, utils_1.urlReplacer)('/api/v2/onboarding/$(step)/start/'),
+        method: 'POST'
+    },
+    CompleteAStep: {
+        url: (0, utils_1.urlReplacer)('/api/v2/onboarding/$(step)/complete/'),
+        method: 'POST'
     }
 };
 exports.default = Endpoints;

package/lib/cjs/index.d.ts

@@ -48,11 +48,12 @@ import WebhookService, { WebhookApiClient, WebhookApiClientInterface } from './s
 import ReactionService, { ReactionApiClient, ReactionApiClientInterface } from './services/reactions';
 import GroupService, { GroupApiClient, GroupApiClientInterface } from './services/group';
 import EventService, { EventApiClient, EventApiClientInterface } from './services/event';
+import OnBoardingService, { OnBoardingApiClient, OnBoardingApiClientInterface } from './services/onboarding';
 /**
  * Types
  */
-import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams } from './types';
+import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, StartStepParams, OnBoardingStep } from './types';
 /**
  * Export all
  */
-export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface };
+export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep };

package/lib/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ModerationService = exports.MediaApiClient = exports.MediaService = exports.LoyaltyApiClient = exports.LoyaltyService = exports.LocalityApiClient = exports.LocalityService = exports.LegalPageApiClient = exports.LegalPageService = exports.InviteApiClient = exports.InviteService = exports.InsightApiClient = exports.InsightService = exports.IncubatorApiClient = exports.IncubatorService = exports.FeedObjectApiClient = exports.FeedObjectService = exports.FeedApiClient = exports.FeedService = exports.EmbedApiClient = exports.EmbedService = exports.DataPortabilityApiClient = exports.DataPortabilityService = exports.CustomPageApiClient = exports.CustomPageService = exports.CustomMenuApiClient = exports.CustomMenuService = exports.CustomAdvApiClient = exports.CustomAdvService = exports.CommentApiClient = exports.CommentService = exports.CategoryApiClient = exports.CategoryService = exports.FeatureApiClient = exports.FeatureService = exports.UserApiClient = exports.UserService = exports.PreferenceApiClient = exports.PreferenceService = exports.AccountApiClient = exports.AccountService = exports.Endpoints = exports.urlParams = exports.parseJwt = exports.generateJWTToken = exports.getCancelTokenSourceRequest = exports.formatHttpErrorCode = exports.formatHttpError = exports.apiRequest = exports.http = void 0;
-exports.EventApiClient = exports.EventService = exports.GroupApiClient = exports.GroupService = exports.ReactionApiClient = exports.ReactionService = exports.MediaTypes = exports.WebhookApiClient = exports.WebhookService = exports.TagApiClient = exports.TagService = exports.SuggestionApiClient = exports.SuggestionService = exports.SSOApiClient = exports.SSOService = exports.ScoreApiClient = exports.ScoreService = exports.PromoApiClient = exports.PromoService = exports.PrivateMessageApiClient = exports.PrivateMessageService = exports.NotificationApiClient = exports.NotificationService = exports.ModerationApiClient = void 0;
+exports.OnBoardingStep = exports.OnBoardingApiClient = exports.OnBoardingService = exports.EventApiClient = exports.EventService = exports.GroupApiClient = exports.GroupService = exports.ReactionApiClient = exports.ReactionService = exports.MediaTypes = exports.WebhookApiClient = exports.WebhookService = exports.TagApiClient = exports.TagService = exports.SuggestionApiClient = exports.SuggestionService = exports.SSOApiClient = exports.SSOService = exports.ScoreApiClient = exports.ScoreService = exports.PromoApiClient = exports.PromoService = exports.PrivateMessageApiClient = exports.PrivateMessageService = exports.NotificationApiClient = exports.NotificationService = exports.ModerationApiClient = void 0;
 const tslib_1 = require("tslib");
 /**
  * Axios client wrapper
@@ -126,8 +126,12 @@ Object.defineProperty(exports, "GroupApiClient", { enumerable: true, get: functi
 const event_1 = tslib_1.__importStar(require("./services/event"));
 exports.EventService = event_1.default;
 Object.defineProperty(exports, "EventApiClient", { enumerable: true, get: function () { return event_1.EventApiClient; } });
+const onboarding_1 = tslib_1.__importStar(require("./services/onboarding"));
+exports.OnBoardingService = onboarding_1.default;
+Object.defineProperty(exports, "OnBoardingApiClient", { enumerable: true, get: function () { return onboarding_1.OnBoardingApiClient; } });
 /**
  * Types
  */
 const types_1 = require("./types");
 Object.defineProperty(exports, "MediaTypes", { enumerable: true, get: function () { return types_1.MediaTypes; } });
+Object.defineProperty(exports, "OnBoardingStep", { enumerable: true, get: function () { return types_1.OnBoardingStep; } });

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

@@ -0,0 +1,80 @@
+import { AxiosRequestConfig } from 'axios';
+import { BaseSearchParams, OnBoardingStep, SCPaginatedResponse } from '../../types';
+import { SCStepType } from '@selfcommunity/types';
+import { StartStepParams } from '../../types/onBoarding';
+export interface OnBoardingApiClientInterface {
+    getAllSteps(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    getAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+    startAStep(step: OnBoardingStep, params?: StartStepParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    completeAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+}
+/**
+ * Contains all the endpoints needed to manage OnBoarding content.
+ */
+export declare class OnBoardingApiClient {
+    /**
+     * This endpoint retrieves all onboarding steps.
+     * @param params
+     * @param config
+     */
+    static getAllSteps(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    /**
+     * This endpoint retrieves a specific step identified by the step id.
+     * @param step
+     * @param config
+     */
+    static getAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<SCStepType>;
+    /**
+     * This endpoint performs step content generation.
+     * @param step
+     * @param params
+     * @param config
+     */
+    static startAStep(step: OnBoardingStep, params?: StartStepParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    /**
+     * This endpoint marks a step complete.
+     * @param step
+     * @param config
+     */
+    static completeAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+}
+/**
+ *
+ :::tip  OnBoarding service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {OnBoardingService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `getAStep` will return the paginated list of categories.
+
+ async getAStep() {
+   return await OnBoardingService.getAStep();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await OnBoardingService.getAStep(step);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+export default class OnBoardingService {
+    static getAllSteps(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    static getAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<SCStepType>;
+    static startAStep(step: OnBoardingStep, params?: StartStepParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    static completeAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+}

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

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnBoardingApiClient = void 0;
+const tslib_1 = require("tslib");
+const Endpoints_1 = tslib_1.__importDefault(require("../../constants/Endpoints"));
+const apiRequest_1 = require("../../utils/apiRequest");
+/**
+ * Contains all the endpoints needed to manage OnBoarding content.
+ */
+class OnBoardingApiClient {
+    /**
+     * This endpoint retrieves all onboarding steps.
+     * @param params
+     * @param config
+     */
+    static getAllSteps(params, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { params, url: Endpoints_1.default.GetAllSteps.url({}), method: Endpoints_1.default.GetAllSteps.method }));
+    }
+    /**
+     * This endpoint retrieves a specific step identified by the step id.
+     * @param step
+     * @param config
+     */
+    static getAStep(step, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetAStep.url({ step }), method: Endpoints_1.default.GetAStep.method }));
+    }
+    /**
+     * This endpoint performs step content generation.
+     * @param step
+     * @param params
+     * @param config
+     */
+    static startAStep(step, params, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { params, url: Endpoints_1.default.StartAStep.url({ step }), method: Endpoints_1.default.StartAStep.method }));
+    }
+    /**
+     * This endpoint marks a step complete.
+     * @param step
+     * @param config
+     */
+    static completeAStep(step, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CompleteAStep.url({ step }), method: Endpoints_1.default.CompleteAStep.method }));
+    }
+}
+exports.OnBoardingApiClient = OnBoardingApiClient;
+/**
+ *
+ :::tip  OnBoarding service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {OnBoardingService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `getAStep` will return the paginated list of categories.
+
+ async getAStep() {
+   return await OnBoardingService.getAStep();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await OnBoardingService.getAStep(step);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+class OnBoardingService {
+    static getAllSteps(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.getAllSteps(params, config);
+        });
+    }
+    static getAStep(step, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.getAStep(step, config);
+        });
+    }
+    static startAStep(step, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.startAStep(step, params, config);
+        });
+    }
+    static completeAStep(step, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.completeAStep(step, config);
+        });
+    }
+}
+exports.default = OnBoardingService;

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

@@ -5,6 +5,7 @@ export interface PreferenceApiClientInterface {
     getAllPreferences(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType>>;
     searchPreferences(search?: string, section?: string, keys?: string, ordering?: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType>>;
     getSpecificPreference(id: number | string, config?: AxiosRequestConfig): Promise<SCPreferenceType>;
+    updatePreferences(data: any, config?: AxiosRequestConfig): Promise<SCPreferenceType | SCPreferenceType[]>;
 }
 /**
  * Contains all the endpoints needed to manage dynamic preferences.
@@ -30,6 +31,12 @@ export declare class PreferenceApiClient {
      * @param config
      */
     static getSpecificPreference(id: number | string, config?: AxiosRequestConfig): Promise<SCPreferenceType>;
+    /**
+     * This endpoint patches one or more dynamic preferences.
+     * @param data
+     * @param config
+     */
+    static updatePreferences(data: any, config?: AxiosRequestConfig): Promise<SCPreferenceType | SCPreferenceType[]>;
 }
 /**
  *
@@ -70,4 +77,5 @@ export default class PreferenceService {
     static getAllPreferences(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType>>;
     static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType>>;
     static getSpecificPreference(id: number | string, config?: AxiosRequestConfig): Promise<SCPreferenceType>;
+    static updatePreferences(data: any, config?: AxiosRequestConfig): Promise<SCPreferenceType | SCPreferenceType[]>;
 }

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

@@ -36,6 +36,14 @@ class PreferenceApiClient {
     static getSpecificPreference(id, config) {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetPreference.url({ id }), method: Endpoints_1.default.Preferences.method }));
     }
+    /**
+     * This endpoint patches one or more dynamic preferences.
+     * @param data
+     * @param config
+     */
+    static updatePreferences(data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdatePreferences.url(), method: Endpoints_1.default.UpdatePreferences.method, data: data }));
+    }
 }
 exports.PreferenceApiClient = PreferenceApiClient;
 /**
@@ -89,5 +97,10 @@ class PreferenceService {
             return PreferenceApiClient.getSpecificPreference(id, config);
         });
     }
+    static updatePreferences(data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return PreferenceApiClient.updatePreferences(data, config);
+        });
+    }
 }
 exports.default = PreferenceService;

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

@@ -25,4 +25,5 @@ import { InsightCommonParams, InsightEmbedParams, InsightUserParams, InsightCont
 import { ReactionParams } from './reaction';
 import { GroupCreateParams, GroupFeedParams } from './group';
 import { EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams } from './event';
-export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams };
+import { StartStepParams, OnBoardingStep } from './onBoarding';
+export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, StartStepParams, OnBoardingStep };

package/lib/cjs/types/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MediaTypes = void 0;
+exports.OnBoardingStep = exports.MediaTypes = void 0;
 const media_1 = require("./media");
 Object.defineProperty(exports, "MediaTypes", { enumerable: true, get: function () { return media_1.MediaTypes; } });
+const onBoarding_1 = require("./onBoarding");
+Object.defineProperty(exports, "OnBoardingStep", { enumerable: true, get: function () { return onBoarding_1.OnBoardingStep; } });

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

@@ -0,0 +1,30 @@
+/**
+ * StartStepParams interface
+ */
+export interface StartStepParams {
+    /**
+     * The number of the post to generate.
+     * @default 10
+     */
+    num_posts?: number;
+    /**
+     * The number of the post images to generate
+     * @default 1
+     */
+    num_images?: number;
+    /**
+     * only for stage
+     */
+    force?: number;
+}
+/**
+ * OnBoardingStepType enum
+ */
+export declare enum OnBoardingStep {
+    CONTENTS = 1,
+    CATEGORIES = 2,
+    APPEARANCE = 3,
+    PROFILE = 4,
+    INVITE = 5,
+    APP = 6
+}

package/lib/cjs/types/onBoarding.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * StartStepParams interface
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnBoardingStep = void 0;
+/**
+ * OnBoardingStepType enum
+ */
+var OnBoardingStep;
+(function (OnBoardingStep) {
+    OnBoardingStep[OnBoardingStep["CONTENTS"] = 1] = "CONTENTS";
+    OnBoardingStep[OnBoardingStep["CATEGORIES"] = 2] = "CATEGORIES";
+    OnBoardingStep[OnBoardingStep["APPEARANCE"] = 3] = "APPEARANCE";
+    OnBoardingStep[OnBoardingStep["PROFILE"] = 4] = "PROFILE";
+    OnBoardingStep[OnBoardingStep["INVITE"] = 5] = "INVITE";
+    OnBoardingStep[OnBoardingStep["APP"] = 6] = "APP";
+})(OnBoardingStep = exports.OnBoardingStep || (exports.OnBoardingStep = {}));

package/lib/esm/constants/Endpoints.js

@@ -59,6 +59,10 @@ const Endpoints = {
         url: urlReplacer('/api/v2/dynamic_preference/$(id)/'),
         method: 'GET'
     },
+    UpdatePreferences: {
+        url: urlReplacer('/api/v2/dynamic_preference/'),
+        method: 'PATCH'
+    },
     /**
      * SSO Endpoints
      */
@@ -1317,6 +1321,25 @@ const Endpoints = {
     HideEvent: {
         url: urlReplacer('/api/v2/event/$(id)/hide/'),
         method: 'POST'
+    },
+    /**
+     * OnBoarding
+     */
+    GetAllSteps: {
+        url: urlReplacer('/api/v2/onboarding/'),
+        method: 'GET'
+    },
+    GetAStep: {
+        url: urlReplacer('/api/v2/onboarding/$(step)/'),
+        method: 'GET'
+    },
+    StartAStep: {
+        url: urlReplacer('/api/v2/onboarding/$(step)/start/'),
+        method: 'POST'
+    },
+    CompleteAStep: {
+        url: urlReplacer('/api/v2/onboarding/$(step)/complete/'),
+        method: 'POST'
     }
 };
 export default Endpoints;

package/lib/esm/index.d.ts

@@ -48,11 +48,12 @@ import WebhookService, { WebhookApiClient, WebhookApiClientInterface } from './s
 import ReactionService, { ReactionApiClient, ReactionApiClientInterface } from './services/reactions';
 import GroupService, { GroupApiClient, GroupApiClientInterface } from './services/group';
 import EventService, { EventApiClient, EventApiClientInterface } from './services/event';
+import OnBoardingService, { OnBoardingApiClient, OnBoardingApiClientInterface } from './services/onboarding';
 /**
  * Types
  */
-import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams } from './types';
+import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, StartStepParams, OnBoardingStep } from './types';
 /**
  * Export all
  */
-export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface };
+export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep };

package/lib/esm/index.js

@@ -48,11 +48,12 @@ import WebhookService, { WebhookApiClient } from './services/webhook';
 import ReactionService, { ReactionApiClient } from './services/reactions';
 import GroupService, { GroupApiClient } from './services/group';
 import EventService, { EventApiClient } from './services/event';
+import OnBoardingService, { OnBoardingApiClient } from './services/onboarding';
 /**
  * Types
  */
-import { MediaTypes } from './types';
+import { MediaTypes, OnBoardingStep } from './types';
 /**
  * Export all
  */
-export { http, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, AccountService, AccountApiClient, PreferenceService, PreferenceApiClient, UserService, UserApiClient, FeatureService, FeatureApiClient, CategoryService, CategoryApiClient, CommentService, CommentApiClient, CustomAdvService, CustomAdvApiClient, CustomMenuService, CustomMenuApiClient, CustomPageService, CustomPageApiClient, DataPortabilityService, DataPortabilityApiClient, EmbedService, EmbedApiClient, FeedService, FeedApiClient, FeedObjectService, FeedObjectApiClient, IncubatorService, IncubatorApiClient, InsightService, InsightApiClient, InviteService, InviteApiClient, LegalPageService, LegalPageApiClient, LocalityService, LocalityApiClient, LoyaltyService, LoyaltyApiClient, MediaService, MediaApiClient, ModerationService, ModerationApiClient, NotificationService, NotificationApiClient, PrivateMessageService, PrivateMessageApiClient, PromoService, PromoApiClient, ScoreService, ScoreApiClient, SSOService, SSOApiClient, SuggestionService, SuggestionApiClient, TagService, TagApiClient, WebhookService, WebhookApiClient, MediaTypes, ReactionService, ReactionApiClient, GroupService, GroupApiClient, EventService, EventApiClient };
+export { http, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, AccountService, AccountApiClient, PreferenceService, PreferenceApiClient, UserService, UserApiClient, FeatureService, FeatureApiClient, CategoryService, CategoryApiClient, CommentService, CommentApiClient, CustomAdvService, CustomAdvApiClient, CustomMenuService, CustomMenuApiClient, CustomPageService, CustomPageApiClient, DataPortabilityService, DataPortabilityApiClient, EmbedService, EmbedApiClient, FeedService, FeedApiClient, FeedObjectService, FeedObjectApiClient, IncubatorService, IncubatorApiClient, InsightService, InsightApiClient, InviteService, InviteApiClient, LegalPageService, LegalPageApiClient, LocalityService, LocalityApiClient, LoyaltyService, LoyaltyApiClient, MediaService, MediaApiClient, ModerationService, ModerationApiClient, NotificationService, NotificationApiClient, PrivateMessageService, PrivateMessageApiClient, PromoService, PromoApiClient, ScoreService, ScoreApiClient, SSOService, SSOApiClient, SuggestionService, SuggestionApiClient, TagService, TagApiClient, WebhookService, WebhookApiClient, MediaTypes, ReactionService, ReactionApiClient, GroupService, GroupApiClient, EventService, EventApiClient, OnBoardingService, OnBoardingApiClient, OnBoardingStep };

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

@@ -0,0 +1,80 @@
+import { AxiosRequestConfig } from 'axios';
+import { BaseSearchParams, OnBoardingStep, SCPaginatedResponse } from '../../types';
+import { SCStepType } from '@selfcommunity/types';
+import { StartStepParams } from '../../types/onBoarding';
+export interface OnBoardingApiClientInterface {
+    getAllSteps(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    getAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+    startAStep(step: OnBoardingStep, params?: StartStepParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    completeAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+}
+/**
+ * Contains all the endpoints needed to manage OnBoarding content.
+ */
+export declare class OnBoardingApiClient {
+    /**
+     * This endpoint retrieves all onboarding steps.
+     * @param params
+     * @param config
+     */
+    static getAllSteps(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    /**
+     * This endpoint retrieves a specific step identified by the step id.
+     * @param step
+     * @param config
+     */
+    static getAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<SCStepType>;
+    /**
+     * This endpoint performs step content generation.
+     * @param step
+     * @param params
+     * @param config
+     */
+    static startAStep(step: OnBoardingStep, params?: StartStepParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    /**
+     * This endpoint marks a step complete.
+     * @param step
+     * @param config
+     */
+    static completeAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+}
+/**
+ *
+ :::tip  OnBoarding service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {OnBoardingService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `getAStep` will return the paginated list of categories.
+
+ async getAStep() {
+   return await OnBoardingService.getAStep();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await OnBoardingService.getAStep(step);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+export default class OnBoardingService {
+    static getAllSteps(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    static getAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<SCStepType>;
+    static startAStep(step: OnBoardingStep, params?: StartStepParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCStepType>>;
+    static completeAStep(step: OnBoardingStep, config?: AxiosRequestConfig): Promise<any>;
+}