@selfcommunity/api-services 0.5.0-live.78 → 0.5.0-live.80

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

@@ -0,0 +1,154 @@
+import { __awaiter } from "tslib";
+import Endpoints from '../../constants/Endpoints';
+import { apiRequest } from '../../utils/apiRequest';
+import { urlParams } from '../../utils/url';
+/**
+ * Contains all the endpoints needed to manage LiveStreams.
+ */
+export class LiveStreamApiClient {
+    /**
+     * This endpoint performs LiveStreams search
+     * @param params
+     * @param config
+     */
+    static search(params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.SearchLiveStream.url({})}?${p.toString()}`, method: Endpoints.SearchEvents.method }));
+    }
+    /**
+     * This endpoint retrieves a specific LiveStream.
+     * @param id
+     * @param config
+     */
+    static getSpecificInfo(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetLiveStreamInfo.url({ id }), method: Endpoints.GetLiveStreamInfo.method }));
+    }
+    /**
+     * This endpoint creates an LiveStream.
+     * @param data
+     * @param config
+     */
+    static create(data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CreateLiveStream.url({}), method: Endpoints.CreateLiveStream.method, data: data }));
+    }
+    /**
+     * This endpoint updates an LiveStream.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static update(id, data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UpdateLiveStream.url({ id }), method: Endpoints.UpdateLiveStream.method, data: data }));
+    }
+    /**
+     * This endpoint patches an  LiveStream.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patch(id, data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.PatchLiveStream.url({ id }), method: Endpoints.PatchLiveStream.method, data: data }));
+    }
+    /**
+     * This endpoint deletes an LiveStream.
+     * @param id
+     * @param config
+     */
+    static delete(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.DeleteLiveStream.url({ id }), method: Endpoints.DeleteLiveStream.method }));
+    }
+    /**
+     * This endpoint changes the LiveStream avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeCover(id, data, config) {
+        return apiRequest(Object.assign({ url: Endpoints.PatchLiveStream.url({ id }), method: Endpoints.PatchLiveStream.method, data }, config));
+    }
+    /**
+     * This endpoint allows to attend an LiveStream
+     * @param id
+     * @param config
+     */
+    static join(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.JoinLiveStream.url({ id }), method: Endpoints.JoinLiveStream.method }));
+    }
+}
+/**
+ *
+ :::tip LiveStream service can be used in the following way:
+
+ ```jsx
+ 1. Import the service from our library:
+
+ import {LiveStreamService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `search` will return the LiveStreams matching the search query.
+
+ async searchLiveStreams() {
+     return await LiveStreamService.search();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async getSpecificInfo(liveStreamId) {
+     return await LiveStreamService.getSpecificInfo(liveStreamId);
+ }
+ ```
+ ```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 LiveStreamService {
+    static search(params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.search(params, config);
+        });
+    }
+    static getSpecificInfo(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.getSpecificInfo(id, config);
+        });
+    }
+    static create(data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.create(data, config);
+        });
+    }
+    static update(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.update(id, data, config);
+        });
+    }
+    static patch(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.patch(id, data, config);
+        });
+    }
+    static delete(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.delete(id, config);
+        });
+    }
+    static changeCover(id, data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.changeCover(id, data, config);
+        });
+    }
+    static join(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.join(id, config);
+        });
+    }
+}

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

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

package/lib/esm/types/liveStream.d.ts

@@ -0,0 +1,29 @@
+/**
+ * LiveStreamCreateParams interface
+ */
+export interface LiveStreamCreateParams {
+    /**
+     * A unique name for the live
+     */
+    name: string;
+    /**
+     * The livestream description
+     */
+    description?: string;
+    /**
+     * The users to invite to the group
+     */
+    invite_users?: number[];
+    /**
+     * The liveStream image
+     */
+    cover?: File;
+    /**
+     * The liveStream slug
+     */
+    slug?: string;
+    /**
+     * The livestream settings
+     */
+    settings?: Record<string, any>;
+}

package/lib/esm/types/liveStream.js

@@ -0,0 +1 @@
+export {};