@selfcommunity/api-services 0.4.9-alpha.0 → 0.4.9-alpha.10

package/lib/cjs/constants/Endpoints.js

@@ -1121,6 +1121,77 @@ const Endpoints = {
     GetSpecificReaction: {
         url: (0, utils_1.urlReplacer)('/api/v2/reaction/$(id)/'),
         method: 'GET'
+    },
+    /**
+     * Groups
+     */
+    GetUserGroups: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/'),
+        method: 'GET'
+    },
+    GetGroupInfo: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/'),
+        method: 'GET'
+    },
+    GetGroupFeed: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/feed/'),
+        method: 'GET'
+    },
+    SearchGroups: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/search/'),
+        method: 'GET'
+    },
+    CreateGroup: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/'),
+        method: 'POST'
+    },
+    UpdateGroup: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/'),
+        method: 'PUT'
+    },
+    PatchGroup: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/'),
+        method: 'PATCH'
+    },
+    GetGroupSuggestedUsers: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/user/?search=$(search)'),
+        method: 'GET'
+    },
+    GetGroupsSuggestedUsers: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/user/?search=$(search)'),
+        method: 'GET'
+    },
+    InviteOrAcceptGroupRequest: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/invite/'),
+        method: 'POST'
+    },
+    GetGroupInvitedUsers: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/invite/'),
+        method: 'GET'
+    },
+    GetGroupSubscriptionStatus: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/status/'),
+        method: 'GET'
+    },
+    SubscribeToGroup: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/subscribe/'),
+        method: 'POST'
+    },
+    GetGroupSubscribers: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/subscribe/'),
+        method: 'GET'
+    },
+    GetGroupWaitingApprovalSubscribers: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/request_subscribe/'),
+        method: 'GET'
+    },
+    UnsubscribeFromGroup: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/subscribe/'),
+        method: 'DELETE'
+    },
+    RemoveUserFromGroup: {
+        url: (0, utils_1.urlReplacer)('/api/v2/group/$(id)/subscribe/?user=$(user)'),
+        method: 'DELETE'
     }
 };
 exports.default = Endpoints;

package/lib/cjs/index.d.ts

@@ -46,11 +46,12 @@ import TagService, { TagApiClient, TagApiClientInterface } from './services/tag'
 import UserService, { UserApiClient, UserApiClientInterface } from './services/user';
 import WebhookService, { WebhookApiClient, WebhookApiClientInterface } from './services/webhook';
 import ReactionService, { ReactionApiClient, ReactionApiClientInterface } from './services/reactions';
+import GroupService, { GroupApiClient, GroupApiClientInterface } from './services/group';
 /**
  * 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 } 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 } 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 };
+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 };

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.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.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
@@ -120,6 +120,9 @@ Object.defineProperty(exports, "WebhookApiClient", { enumerable: true, get: func
 const reactions_1 = tslib_1.__importStar(require("./services/reactions"));
 exports.ReactionService = reactions_1.default;
 Object.defineProperty(exports, "ReactionApiClient", { enumerable: true, get: function () { return reactions_1.ReactionApiClient; } });
+const group_1 = tslib_1.__importStar(require("./services/group"));
+exports.GroupService = group_1.default;
+Object.defineProperty(exports, "GroupApiClient", { enumerable: true, get: function () { return group_1.GroupApiClient; } });
 /**
  * Types
  */

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

@@ -0,0 +1,207 @@
+import { BaseGetParams, BaseSearchParams, GroupFeedParams, SCPaginatedResponse } from '../../types';
+import { SCGroupType, SCUserType } from '@selfcommunity/types';
+import { AxiosRequestConfig } from 'axios';
+import { GroupCreateParams } from '../../types';
+export interface GroupApiClientInterface {
+    getUserGroups(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCGroupType>>;
+    searchGroups(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCGroupType>>;
+    getSpecificGroupInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    getGroupFeed(id: number | string, params?: GroupFeedParams, config?: AxiosRequestConfig): Promise<any>;
+    createGroup(data: GroupCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    updateGroup(id: number | string, data: SCGroupType, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    patchGroup(id: number | string, data: SCGroupType, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    changeGroupAvatarOrCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    getGroupMembers(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    getGroupSuggestedUsers(id: number | string, search: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    getGroupsSuggestedUsers(search: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    removeUserFromGroup(id: number | string, user: number | string, config?: AxiosRequestConfig): Promise<any>;
+    getGroupInvitedUsers(id: number | string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    subscribeToGroup(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    unsubscribeFromGroup(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    inviteOrAcceptGroupRequest(id: number | string, data: {
+        users: number[];
+    }, config?: AxiosRequestConfig): Promise<any>;
+    getGroupSubscriptionStatus(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    getGroupWaitingApprovalSubscribers(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+}
+/**
+ * Contains all the endpoints needed to manage groups.
+ */
+export declare class GroupApiClient {
+    /**
+     * This endpoint retrieves all the groups of the logged-in user.
+     * @param params
+     * @param config
+     */
+    static getUserGroups(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCGroupType>>;
+    /**
+     * This endpoint performs groups search
+     * @param params
+     * @param config
+     */
+    static searchGroups(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCGroupType>>;
+    /**
+     * This endpoint retrieves a specific group.
+     * @param id
+     * @param config
+     */
+    static getSpecificGroupInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    /**
+     * This endpoint performs groups search
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getGroupFeed(id: number | string, params?: GroupFeedParams, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint creates a group.
+     * @param data
+     * @param config
+     */
+    static createGroup(data: GroupCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    /**
+     * This endpoint updates a group.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static updateGroup(id: number | string, data: SCGroupType, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    /**
+     * This endpoint patches a  group.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patchGroup(id: number | string, data: SCGroupType, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    /**
+     * This endpoint changes the group avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeGroupAvatarOrCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    /**
+     * This endpoint returns all subscribers of a specific group.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getGroupMembers(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    /**
+     * This endpoint returns a list of suggested users to invite to the group.
+     * @param id
+     * @param search
+     * @param config
+     */
+    static getGroupSuggestedUsers(id: number | string, search: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    /**
+     * This endpoint returns a list of suggested users to invite to the groups.
+     * @param search
+     * @param config
+     */
+    static getGroupsSuggestedUsers(search: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    /**
+     * This endpoint removes the user specified from the group.
+     * @param id
+     * @param user
+     * @param config
+     */
+    static removeUserFromGroup(id: number | string, user: number | string, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint returns a list of invited users.
+     * @param id
+     * @param config
+     */
+    static getGroupInvitedUsers(id: number | string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    /**
+     * This endpoint subscribes to a group.
+     * @param id
+     * @param config
+     */
+    static subscribeToGroup(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint unsubscribes from a group.
+     * @param id
+     * @param config
+     */
+    static unsubscribeFromGroup(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint allows to invite or accept a group invite.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static inviteOrAcceptGroupRequest(id: number | string, data: {
+        users: number[];
+    }, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint retrieves the group subscription status.
+     * @param id
+     * @param config
+     */
+    static getGroupSubscriptionStatus(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint returns a list of the users waiting to be added to the group.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getGroupWaitingApprovalSubscribers(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+}
+/**
+ *
+ :::tip Incubator service can be used in the following way:
+
+ ```jsx
+ 1. Import the service from our library:
+
+ import {GroupService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `searchGroups` will return the groups matching the search query.
+
+ async searchGroups() {
+         return await GroupService.searchGroups();
+        }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async getSpecificGroupInfo(groupId) {
+         return await GroupService.getSpecificGroupInfo(groupId);
+       }
+ ```
+ ```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 GroupService {
+    static getUserGroups(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCGroupType>>;
+    static searchGroups(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCGroupType>>;
+    static getSpecificGroupInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    static getGroupFeed(id: number | string, params?: GroupFeedParams, config?: AxiosRequestConfig): Promise<any>;
+    static createGroup(data: GroupCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    static updateGroup(id: number | string, data: SCGroupType, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    static patchGroup(id: number | string, data: SCGroupType, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    static changeGroupAvatarOrCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCGroupType>;
+    static getGroupMembers(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    static getGroupSuggestedUsers(id: number | string, search: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    static getGroupsSuggestedUsers(search: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    static removeUserFromGroup(id: number | string, user: number | string, config?: AxiosRequestConfig): Promise<any>;
+    static getGroupInvitedUsers(id: number | string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    static subscribeToGroup(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    static unsubscribeFromGroup(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    static inviteOrAcceptGroupRequest(id: number | string, data: {
+        users: number[];
+    }, config?: AxiosRequestConfig): Promise<any>;
+    static getGroupSubscriptionStatus(id: number | string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<any>>;
+    static getGroupWaitingApprovalSubscribers(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+}

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

@@ -0,0 +1,299 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupApiClient = 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 groups.
+ */
+class GroupApiClient {
+    /**
+     * This endpoint retrieves all the groups of the logged-in user.
+     * @param params
+     * @param config
+     */
+    static getUserGroups(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetUserGroups.url({})}?${p.toString()}`, method: Endpoints_1.default.GetUserGroups.method }));
+    }
+    /**
+     * This endpoint performs groups search
+     * @param params
+     * @param config
+     */
+    static searchGroups(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.SearchGroups.url({})}?${p.toString()}`, method: Endpoints_1.default.SearchGroups.method }));
+    }
+    /**
+     * This endpoint retrieves a specific group.
+     * @param id
+     * @param config
+     */
+    static getSpecificGroupInfo(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetGroupInfo.url({ id }), method: Endpoints_1.default.GetGroupInfo.method }));
+    }
+    /**
+     * This endpoint performs groups search
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getGroupFeed(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetGroupFeed.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetGroupFeed.method }));
+    }
+    /**
+     * This endpoint creates a group.
+     * @param data
+     * @param config
+     */
+    static createGroup(data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreateGroup.url({}), method: Endpoints_1.default.CreateGroup.method, data: data }));
+    }
+    /**
+     * This endpoint updates a group.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static updateGroup(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdateGroup.url({ id }), method: Endpoints_1.default.UpdateGroup.method, data: data }));
+    }
+    /**
+     * This endpoint patches a  group.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patchGroup(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PatchGroup.url({ id }), method: Endpoints_1.default.PatchGroup.method, data: data }));
+    }
+    /**
+     * This endpoint changes the group avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeGroupAvatarOrCover(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign({ url: Endpoints_1.default.PatchGroup.url({ id }), method: Endpoints_1.default.PatchGroup.method, data }, config));
+    }
+    /**
+     * This endpoint returns all subscribers of a specific group.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getGroupMembers(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetGroupSubscribers.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetGroupSubscribers.method }));
+    }
+    /**
+     * This endpoint returns a list of suggested users to invite to the group.
+     * @param id
+     * @param search
+     * @param config
+     */
+    static getGroupSuggestedUsers(id, search, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetGroupSuggestedUsers.url({ id, search }), method: Endpoints_1.default.GetGroupSuggestedUsers.method }));
+    }
+    /**
+     * This endpoint returns a list of suggested users to invite to the groups.
+     * @param search
+     * @param config
+     */
+    static getGroupsSuggestedUsers(search, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetGroupsSuggestedUsers.url({ search }), method: Endpoints_1.default.GetGroupsSuggestedUsers.method }));
+    }
+    /**
+     * This endpoint removes the user specified from the group.
+     * @param id
+     * @param user
+     * @param config
+     */
+    static removeUserFromGroup(id, user, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.RemoveUserFromGroup.url({ id, user }), method: Endpoints_1.default.RemoveUserFromGroup.method }));
+    }
+    /**
+     * This endpoint returns a list of invited users.
+     * @param id
+     * @param config
+     */
+    static getGroupInvitedUsers(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetGroupInvitedUsers.url({ id }), method: Endpoints_1.default.GetGroupInvitedUsers.method }));
+    }
+    /**
+     * This endpoint subscribes to a group.
+     * @param id
+     * @param config
+     */
+    static subscribeToGroup(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.SubscribeToGroup.url({ id }), method: Endpoints_1.default.SubscribeToGroup.method }));
+    }
+    /**
+     * This endpoint unsubscribes from a group.
+     * @param id
+     * @param config
+     */
+    static unsubscribeFromGroup(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UnsubscribeFromGroup.url({ id }), method: Endpoints_1.default.UnsubscribeFromGroup.method }));
+    }
+    /**
+     * This endpoint allows to invite or accept a group invite.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static inviteOrAcceptGroupRequest(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.InviteOrAcceptGroupRequest.url({ id }), method: Endpoints_1.default.InviteOrAcceptGroupRequest.method, data: data }));
+    }
+    /**
+     * This endpoint retrieves the group subscription status.
+     * @param id
+     * @param config
+     */
+    static getGroupSubscriptionStatus(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetGroupSubscriptionStatus.url({ id }), method: Endpoints_1.default.GetGroupSubscriptionStatus.method }));
+    }
+    /**
+     * This endpoint returns a list of the users waiting to be added to the group.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getGroupWaitingApprovalSubscribers(id, params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetGroupWaitingApprovalSubscribers.url({ id })}?${p.toString()}`, method: Endpoints_1.default.GetGroupWaitingApprovalSubscribers.method }));
+    }
+}
+exports.GroupApiClient = GroupApiClient;
+/**
+ *
+ :::tip Incubator service can be used in the following way:
+
+ ```jsx
+ 1. Import the service from our library:
+
+ import {GroupService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `searchGroups` will return the groups matching the search query.
+
+ async searchGroups() {
+         return await GroupService.searchGroups();
+        }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async getSpecificGroupInfo(groupId) {
+         return await GroupService.getSpecificGroupInfo(groupId);
+       }
+ ```
+ ```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 GroupService {
+    static getUserGroups(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getUserGroups(params, config);
+        });
+    }
+    static searchGroups(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.searchGroups(params, config);
+        });
+    }
+    static getSpecificGroupInfo(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getSpecificGroupInfo(id, config);
+        });
+    }
+    static getGroupFeed(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupFeed(id, params, config);
+        });
+    }
+    static createGroup(data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.createGroup(data, config);
+        });
+    }
+    static updateGroup(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.updateGroup(id, data, config);
+        });
+    }
+    static patchGroup(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.patchGroup(id, data, config);
+        });
+    }
+    static changeGroupAvatarOrCover(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.changeGroupAvatarOrCover(id, data, config);
+        });
+    }
+    static getGroupMembers(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupMembers(id, params, config);
+        });
+    }
+    static getGroupSuggestedUsers(id, search, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupSuggestedUsers(id, search, config);
+        });
+    }
+    static getGroupsSuggestedUsers(search, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupsSuggestedUsers(search, config);
+        });
+    }
+    static removeUserFromGroup(id, user, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.removeUserFromGroup(id, user, config);
+        });
+    }
+    static getGroupInvitedUsers(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupInvitedUsers(id, config);
+        });
+    }
+    static subscribeToGroup(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.subscribeToGroup(id, config);
+        });
+    }
+    static unsubscribeFromGroup(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.unsubscribeFromGroup(id, config);
+        });
+    }
+    static inviteOrAcceptGroupRequest(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.inviteOrAcceptGroupRequest(id, data, config);
+        });
+    }
+    static getGroupSubscriptionStatus(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupSubscriptionStatus(id, config);
+        });
+    }
+    static getGroupWaitingApprovalSubscribers(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return GroupApiClient.getGroupWaitingApprovalSubscribers(id, params, config);
+        });
+    }
+}
+exports.default = GroupService;

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

@@ -0,0 +1,36 @@
+/**
+ * GroupCreateParams interface
+ */
+import { SCGroupPrivacyType } from '@selfcommunity/types';
+import { BaseGetParams } from './baseParams';
+export interface GroupCreateParams {
+    /**
+     * A unique name for the group
+     */
+    name: string;
+    /**
+     * The group privacy
+     */
+    privacy: SCGroupPrivacyType;
+    /**
+     * The group visibility. It is required when privacy = private.
+     */
+    visible?: boolean;
+    /**
+     * The group description
+     */
+    description?: string;
+    /**
+     * The users to invite to the group
+     */
+    invite_users?: number[];
+}
+/**
+ * GroupFeedParams interface.
+ */
+export interface GroupFeedParams extends BaseGetParams {
+    /**
+     * Which field to use when ordering the results.
+     */
+    ordering?: string;
+}

package/lib/cjs/types/group.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });