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

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

@@ -0,0 +1,462 @@
+import { __awaiter } from "tslib";
+import { apiRequest } from '../../utils/apiRequest';
+import Endpoints from '../../constants/Endpoints';
+import { urlParams } from '../../utils/url';
+/**
+ * Contains all the endpoints needed to manage events.
+ */
+export class EventApiClient {
+    /**
+     * This endpoint retrieves all the events of the logged-in user.
+     * @param params
+     * @param config
+     */
+    static getUserEvents(params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetUserEvents.url({})}?${p.toString()}`, method: Endpoints.GetUserEvents.method }));
+    }
+    /**
+     * This endpoint retrieves a specific user events.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUserSubscribedEvents(id, params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetUserSubscribedEvents.url({ id })}?${p.toString()}`, method: Endpoints.GetUserSubscribedEvents.method }));
+    }
+    /**
+     * This endpoint returns all events cretaed by a specific event.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUserCreatedEvents(params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetUserCreatedEvents.url({})}?${p.toString()}`, method: Endpoints.GetUserCreatedEvents.method }));
+    }
+    /**
+     * This endpoint performs events search
+     * @param params
+     * @param config
+     */
+    static searchEvents(params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.SearchEvents.url({})}?${p.toString()}`, method: Endpoints.SearchEvents.method }));
+    }
+    /**
+     * This endpoint retrieves a specific event.
+     * @param id
+     * @param config
+     */
+    static getSpecificEventInfo(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetEventInfo.url({ id }), method: Endpoints.GetEventInfo.method }));
+    }
+    /**
+     * This endpoint performs events search
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventFeed(id, params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetEventFeed.url({ id })}?${p.toString()}`, method: Endpoints.GetEventFeed.method }));
+    }
+    /**
+     * This endpoint creates an event.
+     * @param data
+     * @param config
+     */
+    static createEvent(data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CreateEvent.url({}), method: Endpoints.CreateEvent.method, data: data }));
+    }
+    /**
+     * This endpoint updates an event.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static updateEvent(id, data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UpdateEvent.url({ id }), method: Endpoints.UpdateEvent.method, data: data }));
+    }
+    /**
+     * This endpoint patches an  event.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patchEvent(id, data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.PatchEvent.url({ id }), method: Endpoints.PatchEvent.method, data: data }));
+    }
+    /**
+     * This endpoint deletes an  event.
+     * @param id
+     * @param config
+     */
+    static deleteEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.DeleteEvent.url({ id }), method: Endpoints.DeleteEvent.method }));
+    }
+    /**
+     * This endpoint changes the event avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeEventCover(id, data, config) {
+        return apiRequest(Object.assign({ url: Endpoints.PatchEvent.url({ id }), method: Endpoints.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 = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetEventSubscribers.url({ id })}?${p.toString()}`, method: Endpoints.GetEventSubscribers.method }));
+    }
+    /**
+     * This endpoint returns all waiting approval subscribers
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventWaitingApprovalSubscribers(id, params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetEventWaitingApprovalSubscribers.url({ id })}?${p.toString()}`, method: Endpoints.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 apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetEventSuggestedUsers.url({ id, search }), method: Endpoints.GetEventSuggestedUsers.method }));
+    }
+    /**
+     * This endpoint returns a list of suggested users to invite to the events.
+     * @param search
+     * @param config
+     */
+    static getEventsSuggestedUsers(search, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetEventsSuggestedUsers.url({ search }), method: Endpoints.GetEventsSuggestedUsers.method }));
+    }
+    /**
+     * This endpoint returns a list of invited users.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getEventInvitedUsers(id, params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetEventInvitedUsers.url({ id })}?${p.toString()}`, method: Endpoints.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 = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetUsersGoingToEvent.url({ id })}?${p.toString()}`, method: Endpoints.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 = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetUsersNotGoingToEvent.url({ id })}?${p.toString()}`, method: Endpoints.GetUsersNotGoingToEvent.method }));
+    }
+    /**
+     * This endpoint subscribes to an event.
+     * @param id
+     * @param config
+     */
+    static subscribeToEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.SubscribeToEvent.url({ id }), method: Endpoints.SubscribeToEvent.method }));
+    }
+    /**
+     * This endpoint unsubscribes from an event.
+     * @param id
+     * @param config
+     */
+    static unsubscribeFromEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UnsubscribeFromEvent.url({ id }), method: Endpoints.UnsubscribeFromEvent.method }));
+    }
+    /**
+     * This endpoint allows to invite or accept an event invite.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static inviteOrAcceptEventRequest(id, data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.InviteOrAcceptEventRequest.url({ id }), method: Endpoints.InviteOrAcceptEventRequest.method, data: data }));
+    }
+    /**
+     * This endpoint allows to remove invites.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static removeInviteEvent(id, data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.RemoveInviteEvent.url({ id }), method: Endpoints.RemoveInviteEvent.method, data: data }));
+    }
+    /**
+     * This endpoint retrieves the event subscription status.
+     * @param id
+     * @param config
+     */
+    static getEventSubscriptionStatus(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetEventSubscriptionStatus.url({ id }), method: Endpoints.GetEventSubscriptionStatus.method }));
+    }
+    /**
+     * This endpoint allows to attend an event
+     * @param id
+     * @param config
+     */
+    static goToEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GoToEvent.url({ id }), method: Endpoints.GoToEvent.method }));
+    }
+    /**
+     * This endpoint allows to remove an event participation
+     * @param id
+     * @param config
+     */
+    static removeGoingToEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.RemoveGoingToEvent.url({ id }), method: Endpoints.RemoveGoingToEvent.method }));
+    }
+    /**
+     * This endpoint allows to not attend an event
+     * @param id
+     * @param config
+     */
+    static notGoingToEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.NotGoingToEvent.url({ id }), method: Endpoints.NotGoingToEvent.method }));
+    }
+    /**
+     * This endpoint allows to remove the event not attending
+     * @param id
+     * @param config
+     */
+    static removeNotGoingToEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.RemoveNotGoingToEvent.url({ id }), method: Endpoints.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 = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetEventRelated.url({ id })}?${p.toString()}`, method: Endpoints.GetEventRelated.method }));
+    }
+    /**
+     * This endpoint show a specific event.
+     * @param id
+     * @param config
+     */
+    static showEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.ShowEvent.url({ id }), method: Endpoints.ShowEvent.method }));
+    }
+    /**
+     * This endpoint hide a specific event.
+     * @param id
+     * @param config
+     */
+    static hideEvent(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.hideEvent.url({ id }), method: Endpoints.hideEvent.method }));
+    }
+}
+/**
+ *
+ :::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!
+ ```
+ :::
+ */
+export default class EventService {
+    static getUserEvents(params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUserEvents(params, config);
+        });
+    }
+    static getUserSubscribedEvents(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUserSubscribedEvents(id, params, config);
+        });
+    }
+    static getUserCretaedEvents(params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUserCreatedEvents(params, config);
+        });
+    }
+    static searchEvents(params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.searchEvents(params, config);
+        });
+    }
+    static getSpecificEventInfo(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getSpecificEventInfo(id, config);
+        });
+    }
+    static getEventFeed(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventFeed(id, params, config);
+        });
+    }
+    static createEvent(data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.createEvent(data, config);
+        });
+    }
+    static updateEvent(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.updateEvent(id, data, config);
+        });
+    }
+    static patchEvent(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.patchEvent(id, data, config);
+        });
+    }
+    static deleteEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.deleteEvent(id, config);
+        });
+    }
+    static changeEventCover(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.changeEventCover(id, data, config);
+        });
+    }
+    static getEventMembers(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventMembers(id, params, config);
+        });
+    }
+    static getEventWaitingApprovalSubscribers(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventWaitingApprovalSubscribers(id, params, config);
+        });
+    }
+    static getEventSuggestedUsers(id, search, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventSuggestedUsers(id, search, config);
+        });
+    }
+    static getEventsSuggestedUsers(search, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventsSuggestedUsers(search, config);
+        });
+    }
+    static getEventInvitedUsers(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventInvitedUsers(id, params, config);
+        });
+    }
+    static getUsersGoingToEvent(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUsersGoingToEvent(id, params, config);
+        });
+    }
+    static getUsersNotGoingToEvent(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getUsersNotGoingToEvent(id, params, config);
+        });
+    }
+    static subscribeToEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.subscribeToEvent(id, config);
+        });
+    }
+    static unsubscribeFromEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.unsubscribeFromEvent(id, config);
+        });
+    }
+    static inviteOrAcceptEventRequest(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.inviteOrAcceptEventRequest(id, data, config);
+        });
+    }
+    static removeInviteEvent(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.removeInviteEvent(id, data, config);
+        });
+    }
+    static getEventSubscriptionStatus(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventSubscriptionStatus(id, config);
+        });
+    }
+    static goToEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.goToEvent(id, config);
+        });
+    }
+    static removeGoingToEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.removeGoingToEvent(id, config);
+        });
+    }
+    static notGoingToEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.notGoingToEvent(id, config);
+        });
+    }
+    static removeNotGoingToEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.removeNotGoingToEvent(id, config);
+        });
+    }
+    static getEventRelated(id, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.getEventRelated(id, params, config);
+        });
+    }
+    static showEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.showEvent(id, config);
+        });
+    }
+    static hideEvent(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return EventApiClient.hideEvent(id, config);
+        });
+    }
+}

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>;
+}

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

@@ -0,0 +1,97 @@
+import { __awaiter } from "tslib";
+import Endpoints from '../../constants/Endpoints';
+import { apiRequest } from '../../utils/apiRequest';
+/**
+ * Contains all the endpoints needed to manage OnBoarding content.
+ */
+export class OnBoardingApiClient {
+    /**
+     * This endpoint retrieves all onboarding steps.
+     * @param params
+     * @param config
+     */
+    static getAllSteps(params, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { params, url: Endpoints.GetAllSteps.url({}), method: Endpoints.GetAllSteps.method }));
+    }
+    /**
+     * This endpoint retrieves a specific step identified by the step id.
+     * @param step
+     * @param config
+     */
+    static getAStep(step, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetAStep.url({ step }), method: Endpoints.GetAStep.method }));
+    }
+    /**
+     * This endpoint performs step content generation.
+     * @param step
+     * @param params
+     * @param config
+     */
+    static startAStep(step, params, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { params, url: Endpoints.StartAStep.url({ step }), method: Endpoints.StartAStep.method }));
+    }
+    /**
+     * This endpoint marks a step complete.
+     * @param step
+     * @param config
+     */
+    static completeAStep(step, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CompleteAStep.url({ step }), method: Endpoints.CompleteAStep.method }));
+    }
+}
+/**
+ *
+ :::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, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.getAllSteps(params, config);
+        });
+    }
+    static getAStep(step, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.getAStep(step, config);
+        });
+    }
+    static startAStep(step, params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.startAStep(step, params, config);
+        });
+    }
+    static completeAStep(step, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return OnBoardingApiClient.completeAStep(step, config);
+        });
+    }
+}

package/lib/esm/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/esm/services/preference/index.js

@@ -33,6 +33,14 @@ export class PreferenceApiClient {
     static getSpecificPreference(id, config) {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetPreference.url({ id }), method: Endpoints.Preferences.method }));
     }
+    /**
+     * This endpoint patches one or more dynamic preferences.
+     * @param data
+     * @param config
+     */
+    static updatePreferences(data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UpdatePreferences.url(), method: Endpoints.UpdatePreferences.method, data: data }));
+    }
 }
 /**
  *
@@ -85,4 +93,9 @@ export default class PreferenceService {
             return PreferenceApiClient.getSpecificPreference(id, config);
         });
     }
+    static updatePreferences(data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return PreferenceApiClient.updatePreferences(data, config);
+        });
+    }
 }