@selfcommunity/api-services 0.4.55 → 0.5.0-alpha.0

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

@@ -0,0 +1,467 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventApiClient = void 0;
+const tslib_1 = require("tslib");
+const apiRequest_1 = require("../../utils/apiRequest");
+const Endpoints_1 = tslib_1.__importDefault(require("../../constants/Endpoints"));
+const url_1 = require("../../utils/url");
+/**
+ * Contains all the endpoints needed to manage events.
+ */
+class EventApiClient {
+    /**
+     * This endpoint retrieves all the events of the logged-in user.
+     * @param params
+     * @param config
+     */
+    static getUserEvents(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetUserEvents.url({})}?${p.toString()}`, method: Endpoints_1.default.GetUserEvents.method }));
+    }
+    /**
+     * This endpoint retrieves a specific user events.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUserSubscribedEvents(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetUserSubscribedEvents.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetUserSubscribedEvents.method }));
+    }
+    /**
+     * This endpoint returns all events cretaed by a specific event.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUserCreatedEvents(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetUserCreatedEvents.url({})}?${p.toString()}`, method: Endpoints_1.default.GetUserCreatedEvents.method }));
+    }
+    /**
+     * This endpoint performs events search
+     * @param params
+     * @param config
+     */
+    static searchEvents(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.SearchEvents.url({})}?${p.toString()}`, method: Endpoints_1.default.SearchEvents.method }));
+    }
+    /**
+     * This endpoint retrieves a specific event.
+     * @param id
+     * @param config
+     */
+    static getSpecificEventInfo(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetEventInfo.url({ id }), method: Endpoints_1.default.GetEventInfo.method }));
+    }
+    /**
+     * This endpoint performs events search
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventFeed(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetEventFeed.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetEventFeed.method }));
+    }
+    /**
+     * This endpoint creates an event.
+     * @param data
+     * @param config
+     */
+    static createEvent(data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreateEvent.url({}), method: Endpoints_1.default.CreateEvent.method, data: data }));
+    }
+    /**
+     * This endpoint updates an event.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static updateEvent(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdateEvent.url({ id }), method: Endpoints_1.default.UpdateEvent.method, data: data }));
+    }
+    /**
+     * This endpoint patches an  event.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patchEvent(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PatchEvent.url({ id }), method: Endpoints_1.default.PatchEvent.method, data: data }));
+    }
+    /**
+     * This endpoint deletes an  event.
+     * @param id
+     * @param config
+     */
+    static deleteEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.DeleteEvent.url({ id }), method: Endpoints_1.default.DeleteEvent.method }));
+    }
+    /**
+     * This endpoint changes the event avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeEventCover(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign({ url: Endpoints_1.default.PatchEvent.url({ id }), method: Endpoints_1.default.PatchEvent.method, data }, config));
+    }
+    /**
+     * This endpoint returns all subscribers of a specific event.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventMembers(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetEventSubscribers.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetEventSubscribers.method }));
+    }
+    /**
+     * This endpoint returns all waiting approval subscribers
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventWaitingApprovalSubscribers(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetEventWaitingApprovalSubscribers.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetEventSubscribers.method }));
+    }
+    /**
+     * This endpoint returns a list of suggested users to invite to the event.
+     * @param id
+     * @param search
+     * @param config
+     */
+    static getEventSuggestedUsers(id, search, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetEventSuggestedUsers.url({ id, search }), method: Endpoints_1.default.GetEventSuggestedUsers.method }));
+    }
+    /**
+     * This endpoint returns a list of suggested users to invite to the events.
+     * @param search
+     * @param config
+     */
+    static getEventsSuggestedUsers(search, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetEventsSuggestedUsers.url({ search }), method: Endpoints_1.default.GetEventsSuggestedUsers.method }));
+    }
+    /**
+     * This endpoint returns a list of invited users.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventInvitedUsers(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetEventInvitedUsers.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetEventInvitedUsers.method }));
+    }
+    /**
+     * This endpoint returns a list of users attending the event.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUsersGoingToEvent(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetUsersGoingToEvent.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetUsersGoingToEvent.method }));
+    }
+    /**
+     * This endpoint returns a list of users not attending the event.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUsersNotGoingToEvent(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetUsersNotGoingToEvent.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetUsersNotGoingToEvent.method }));
+    }
+    /**
+     * This endpoint subscribes to an event.
+     * @param id
+     * @param config
+     */
+    static subscribeToEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.SubscribeToEvent.url({ id }), method: Endpoints_1.default.SubscribeToEvent.method }));
+    }
+    /**
+     * This endpoint unsubscribes from an event.
+     * @param id
+     * @param config
+     */
+    static unsubscribeFromEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UnsubscribeFromEvent.url({ id }), method: Endpoints_1.default.UnsubscribeFromEvent.method }));
+    }
+    /**
+     * This endpoint allows to invite or accept an event invite.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static inviteOrAcceptEventRequest(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.InviteOrAcceptEventRequest.url({ id }), method: Endpoints_1.default.InviteOrAcceptEventRequest.method, data: data }));
+    }
+    /**
+     * This endpoint allows to remove invites.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static removeInviteEvent(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.RemoveInviteEvent.url({ id }), method: Endpoints_1.default.RemoveInviteEvent.method, data: data }));
+    }
+    /**
+     * This endpoint retrieves the event subscription status.
+     * @param id
+     * @param config
+     */
+    static getEventSubscriptionStatus(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetEventSubscriptionStatus.url({ id }), method: Endpoints_1.default.GetEventSubscriptionStatus.method }));
+    }
+    /**
+     * This endpoint allows to attend an event
+     * @param id
+     * @param config
+     */
+    static goToEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GoToEvent.url({ id }), method: Endpoints_1.default.GoToEvent.method }));
+    }
+    /**
+     * This endpoint allows to remove an event participation
+     * @param id
+     * @param config
+     */
+    static removeGoingToEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.RemoveGoingToEvent.url({ id }), method: Endpoints_1.default.RemoveGoingToEvent.method }));
+    }
+    /**
+     * This endpoint allows to not attend an event
+     * @param id
+     * @param config
+     */
+    static notGoingToEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.NotGoingToEvent.url({ id }), method: Endpoints_1.default.NotGoingToEvent.method }));
+    }
+    /**
+     * This endpoint allows to remove the event not attending
+     * @param id
+     * @param config
+     */
+    static removeNotGoingToEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.RemoveNotGoingToEvent.url({ id }), method: Endpoints_1.default.RemoveNotGoingToEvent.method }));
+    }
+    /**
+     * This endpoint returns all events related of a specific event.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventRelated(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetEventRelated.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetEventRelated.method }));
+    }
+    /**
+     * This endpoint show a specific event.
+     * @param id
+     * @param config
+     */
+    static showEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ShowEvent.url({ id }), method: Endpoints_1.default.ShowEvent.method }));
+    }
+    /**
+     * This endpoint hide a specific event.
+     * @param id
+     * @param config
+     */
+    static hideEvent(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.hideEvent.url({ id }), method: Endpoints_1.default.hideEvent.method }));
+    }
+}
+exports.EventApiClient = EventApiClient;
+/**
+ *
+ :::tip Incubator service can be used in the following way:
+
+ ```jsx
+ 1. Import the service from our library:
+
+ import {EventService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `searchEvents` will return the events matching the search query.
+
+ async searchEvents() {
+         return await EventService.searchEvents();
+        }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async getSpecificEventInfo(eventId) {
+         return await EventService.getSpecificEventInfo(eventId);
+       }
+ ```
+ ```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 EventService {
+    static getUserEvents(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUserEvents(params, config);
+        });
+    }
+    static getUserSubscribedEvents(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUserSubscribedEvents(id, params, config);
+        });
+    }
+    static getUserCretaedEvents(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUserCreatedEvents(params, config);
+        });
+    }
+    static searchEvents(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.searchEvents(params, config);
+        });
+    }
+    static getSpecificEventInfo(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getSpecificEventInfo(id, config);
+        });
+    }
+    static getEventFeed(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventFeed(id, params, config);
+        });
+    }
+    static createEvent(data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.createEvent(data, config);
+        });
+    }
+    static updateEvent(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.updateEvent(id, data, config);
+        });
+    }
+    static patchEvent(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.patchEvent(id, data, config);
+        });
+    }
+    static deleteEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.deleteEvent(id, config);
+        });
+    }
+    static changeEventCover(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.changeEventCover(id, data, config);
+        });
+    }
+    static getEventMembers(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventMembers(id, params, config);
+        });
+    }
+    static getEventWaitingApprovalSubscribers(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventWaitingApprovalSubscribers(id, params, config);
+        });
+    }
+    static getEventSuggestedUsers(id, search, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventSuggestedUsers(id, search, config);
+        });
+    }
+    static getEventsSuggestedUsers(search, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventsSuggestedUsers(search, config);
+        });
+    }
+    static getEventInvitedUsers(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventInvitedUsers(id, params, config);
+        });
+    }
+    static getUsersGoingToEvent(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUsersGoingToEvent(id, params, config);
+        });
+    }
+    static getUsersNotGoingToEvent(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUsersNotGoingToEvent(id, params, config);
+        });
+    }
+    static subscribeToEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.subscribeToEvent(id, config);
+        });
+    }
+    static unsubscribeFromEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.unsubscribeFromEvent(id, config);
+        });
+    }
+    static inviteOrAcceptEventRequest(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.inviteOrAcceptEventRequest(id, data, config);
+        });
+    }
+    static removeInviteEvent(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.removeInviteEvent(id, data, config);
+        });
+    }
+    static getEventSubscriptionStatus(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventSubscriptionStatus(id, config);
+        });
+    }
+    static goToEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.goToEvent(id, config);
+        });
+    }
+    static removeGoingToEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.removeGoingToEvent(id, config);
+        });
+    }
+    static notGoingToEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.notGoingToEvent(id, config);
+        });
+    }
+    static removeNotGoingToEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.removeNotGoingToEvent(id, config);
+        });
+    }
+    static getEventRelated(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventRelated(id, params, config);
+        });
+    }
+    static showEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.showEvent(id, config);
+        });
+    }
+    static hideEvent(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.hideEvent(id, config);
+        });
+    }
+}
+exports.default = EventService;

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[]>;
 }